CreateIssueCtrl.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2015 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.dossier.www;
 
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Date;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.turro.string.Strings;
import org.apache.commons.fileupload.FileItemIterator;
import org.apache.commons.fileupload.FileItemStream;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
import org.apache.commons.fileupload.util.Streams;
import org.apache.commons.lang3.math.NumberUtils;
import org.turro.attach.db.AttachPU;
import org.turro.attach.entity.AttachContent;
import org.turro.attach.entity.Attachment;
import org.turro.auth.Authentication;
import org.turro.contacts.Contact;
import org.turro.describeit.DescribeItUtil;
import org.turro.dossier.db.DossierPU;
import org.turro.dossier.dossier.ProjectContext;
import org.turro.dossier.dw.DossierDWReport;
import org.turro.dossier.entity.Dossier;
import org.turro.dossier.entity.Issue;
import org.turro.dossier.entity.IssueComment;
import org.turro.dossier.entity.IssueParticipant;
import org.turro.dossier.entity.IssuePriority;
import org.turro.dossier.entity.IssueResolution;
import org.turro.dossier.entity.IssueType;
import org.turro.dossier.issue.IssueMail;
import org.turro.dossier.issue.IssueWrapper;
import org.turro.dossier.project.AbstractDossierNotification;
import org.turro.dossier.search.DossierResults;
import org.turro.elephant.context.Application;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.direct.DirectContent;
import org.turro.elephant.direct.DirectContents;
import org.turro.elephant.direct.IDirectContent;
import org.turro.html.HTMLEntities;
import org.turro.i18n.I_;
import org.turro.jpa.Dao;
import org.turro.log.SystemLogType;
import org.turro.log.SystemLogger;
import org.turro.marker.ElephantMarker;
import org.turro.plugin.contacts.IContact;
import org.turro.registry.ChangeCategory;
import org.turro.registry.Changes;
import org.turro.registry.EnumChange;
import org.turro.registry.StringChange;
import org.turro.registry.UniqueString;
 
@DirectContent(identifier="issue-create")
public class CreateIssueCtrl implements IDirectContent {
 
  //TODO: process all parameters
  public static String linkToCreateIssue(String link, String dossierId, String template) {
    return "/user/newissue?dossierId=" + dossierId;
  }
  
  public static String createIssue(String link, String dossierId, String template) {
    IConstructor constructor = Application.getApplication().getConstructor();
    if(constructor.isInRole("issue:edit")) {
      ElephantMarker marker = new ElephantMarker(constructor);
      marker.put("projectContext", new ProjectContext());
      marker.put("action", DirectContents.createRelativeURL(getIdentifier()));
      marker.put("redirect", link);
      if(Long.valueOf(dossierId) > 0) {
        marker.put("dossierId", dossierId);
        DossierDWReport dr = new DossierDWReport();
        dr.setReportValues(null, null, Long.valueOf(dossierId));
        marker.put("dossierData", dr.getData());
      } else {
        marker.put("dossiers", new DossierResults().getDossierList());
      }
      return marker.parse("issue", Strings.isBlank(template) ? "create" : template);
    }
    return "";
  }
 
  public static String getIdentifier() {
    return CreateIssueCtrl.class.getAnnotation(DirectContent.class).identifier();
  }
 
  @Override
  public boolean itsMe(String id) {
    return getIdentifier().equals(id);
  }
 
  @Override
  public boolean myTurn(HttpServletRequest request) {
    return DirectContents.isYourTurn(request, getIdentifier());
  }
 
  @Override
  public void execute(ServletContext context, HttpServletRequest request, HttpServletResponse response) {
    if(ServletFileUpload.isMultipartContent(request)) {
      try {
        processInformation(request, response);
      } catch (FileUploadException | IOException ex) {
        Logger.getLogger(CreateIssueCtrl.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
      }
    }
  }
 
  private void processInformation(HttpServletRequest request, HttpServletResponse response) throws FileUploadException, IOException {
    IConstructor constructor = Application.getApplication().getConstructor();
    Dao dao = new DossierPU();
    IContact contact = Authentication.getIContact();
    Issue issue = null;
    if(contact == null || !contact.isValid()) {
      return;
    }
    Changes changes = new Changes();
    ChangeCategory issueCat = new ChangeCategory(2, I_.get("Changes"));
    ChangeCategory attachCat = new ChangeCategory(3, I_.get("Attachments"));
    ChangeCategory commentCat = new ChangeCategory(5, I_.get("Comment"));
    Long dossierId = null;
    String redirect = null, comment = null, description = null, webDefault = null, grouping = null;
    Double hours = 0.0d, expenses = 0.0d, price = 0.0d;
    IssuePriority priority = null;
    IssueType type = null;
    Boolean cancelEmails = false, responsibleIsReporter = false;
    ServletFileUpload upload = new ServletFileUpload();
    upload.setHeaderEncoding(ElephantContext.getEncoding());
    FileItemIterator iter = upload.getItemIterator(request);
    while(iter.hasNext()) {
      FileItemStream item = iter.next();
      String name = item.getFieldName();
      InputStream stream = item.openStream();
      if(item.isFormField()) {
        switch(name) {
          case "dossierId":
            dossierId = Long.valueOf(Streams.asString(stream));
            if(dossierId > 0) {
              Dossier dossier = dao.find(Dossier.class, dossierId);
              issue = Issue.getDefaultIssue();
              issue.setDossier(dossier);
              issue.setModification(new Date());
            }
            break;
          case "redirect":
            redirect = Streams.asString(stream, ElephantContext.getEncoding());
            break;
          case "description":
            description = Streams.asString(stream, ElephantContext.getEncoding());
            if(!Strings.isBlank(description)) {
              description = HTMLEntities.plainWhenPossible(description);
              changes.addChange(new StringChange(issueCat, I_.get("Description"), 
                          "", description));
              issue.setDescription(description);
            }
            break;
          case "comment":
            comment = Streams.asString(stream, ElephantContext.getEncoding());
            if(!Strings.isBlank(comment)) {
              comment = HTMLEntities.plainWhenPossible(comment);
              changes.addComment(commentCat, comment);
            }
            break;
          case "priority":
            String p = Streams.asString(stream, ElephantContext.getEncoding());
            if("p1".equals(p)) {
              priority = IssuePriority.PRIORITY_CANT_CONTINUE;
            } else if("p2".equals(p)) {
              priority = IssuePriority.PRIORITY_WORKAROUND_IMPRACTICAL;
            } else if("p3".equals(p)) {
              priority = IssuePriority.PRIORITY_HAS_WORKAROUND;
            } else if("p4".equals(p)) {
              priority = IssuePriority.PRIORITY_WRONG_BEHAVIOR;
            } else if("p5".equals(p)) {
              priority = IssuePriority.PRIORITY_CAUSE_UNEASE;
            }
            if(priority != null) {
              changes.addChange(new EnumChange(issueCat, I_.get("Priority"), 
                      IssuePriority.PRIORITY_HAS_WORKAROUND, priority));
              issue.setPriority(priority);
            }
            break;
          case "type":
            String t = Streams.asString(stream, ElephantContext.getEncoding());
            if("task".equals(t)) {
              type = IssueType.TYPE_TASK;
            } else if("defect".equals(t)) {
              type = IssueType.TYPE_DEFECT;
            } else if("enhancement".equals(t)) {
              type = IssueType.TYPE_ENHANCEMENT;
            } else if("prevention".equals(t)) {
              type = IssueType.TYPE_PREVENTION;
            } else if("feature".equals(t)) {
              type = IssueType.TYPE_FEATURE;
            } else if("document".equals(t)) {
              type = IssueType.TYPE_DOCUMENT;
            } else if("patch".equals(t)) {
              type = IssueType.TYPE_PATCH;
            } else if("question".equals(t)) {
              type = IssueType.TYPE_QUESTION;
            } else if("nonconformity".equals(t)) {
              type = IssueType.TYPE_NONCONFORMITY;
            } else if("bestpractice".equals(t)) {
              type = IssueType.TYPE_BESTPRACTICE;
            } else if("process".equals(t)) {
              type = IssueType.TYPE_PROCESS;
            } else if("proposition".equals(t)) {
              type = IssueType.TYPE_PROPOSITION;
            }
            if(type != null) {
              changes.addChange(new EnumChange(issueCat, I_.get("Type"), 
                      IssueType.TYPE_TASK, type));
              issue.setType(type);
            }
            break;
          case "grouping":
            grouping = Streams.asString(stream, ElephantContext.getEncoding());
            if(!Strings.isBlank(grouping)) {
              changes.addChange(new StringChange(issueCat, I_.get("Grouping"), 
                          "", grouping));
              issue.setGrouping(grouping);
            }
            break;
          case "expenses":
            expenses = NumberUtils.toDouble(Streams.asString(stream), 0);
            break;
          case "hours":
            hours = NumberUtils.toDouble(Streams.asString(stream), 0);
            break;
          case "price":
            price = NumberUtils.toDouble(Streams.asString(stream), 0);
            break;
          case "webDefault":
            webDefault = Streams.asString(stream, ElephantContext.getEncoding());
            break;
          case "cancelEmails":
            cancelEmails = Boolean.parseBoolean(Streams.asString(stream, ElephantContext.getEncoding()));
            break;
          case "responsibleIsReporter":
            responsibleIsReporter = Boolean.parseBoolean(Streams.asString(stream, ElephantContext.getEncoding()));
            break;
        }
      } else if(issue != null && !Strings.isBlank(issue.getDescription())) {
        issue.setExpenses(expenses);
        issue.setHours(hours);
        issue.setPrice(price);
        issue = checkSave(constructor, dao, changes, issue, issueCat, responsibleIsReporter);
        Attachment attachment = new Attachment();
        attachment.setModification(issue.getModification());
        attachment.setPath("/issue/" + issue.getId());
        attachment.setOwner(contact.getId());
        attachment.setOnlyOwner(false);
        attachment.setComment("");
        attachment.setShowKey(null);
        attachment.setPublishable(true);
        AttachContent ac = new AttachContent();
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        Streams.copy(item.openStream(), baos, true);
        ac.setFileContent(baos.toByteArray());
        attachment.setAttachContent(ac);
        attachment.setFileName(convertToFileName(item.getName()));
        attachment.setFileContentType(item.getContentType());
        attachment.setFileSize(ac.getFileContent().length);
        attachment.setValidated(Application.getApplication().isInRole("attach:self-validate"));
        if(attachment.getFileSize() > 0) {
          attachment = new AttachPU().saveObject(attachment);
          SystemLogger.getInstance().doLog(SystemLogType.LOG_INFO, attachment, "uploaded", null);
          changes.addChange(new StringChange(attachCat, I_.get("Upload"), attachment.getFileName(), null, true));
        }
      }
    }
    changes.clearEquals();
    if(changes.stringSize() > 0) {
      if(issue != null && !Strings.isBlank(issue.getDescription())) {
        IssueComment ic = new IssueComment();
        ic.setIssue(issue);
        ic.setModification(issue.getModification());
        ic.setIContact(Authentication.getIContact());
        ic.setComment(changes.getChangesString());
        issue.getComments().add(ic);
        issue = checkSave(constructor, dao, changes, issue, issueCat, responsibleIsReporter);
        SystemLogger.getInstance().doLog(SystemLogType.LOG_INFO, issue, "saved",
                issue.getId() + " - " + issue.getDescription());
        if(!cancelEmails) {
          AbstractDossierNotification notif = AbstractDossierNotification.getByGrouping(issue);
          if(notif == null) {
            new IssueMail(changes, issue, 0, 0, 0).sendMail();
          } else {
            notif.sendNotification();
          }
        }
        if(!Strings.isBlank(webDefault)) {
          DescribeItUtil.addDescription(issue, DescribeItUtil.DEFAULT_ID, webDefault, (Contact) contact.getContact(), null);
        }
      }
    }
    if(!Strings.isBlank(redirect)) {
      constructor.redirect(redirect.replaceAll("\\#ID", issue.getId() + ""));
    }
  }
  
  private String convertToFileName(String fileName) {
    if(fileName.contains("/")) {
      fileName = fileName.substring(fileName.lastIndexOf("/") + 1);
    }
    return fileName;
  }
  
  private Issue checkSave(IConstructor constructor, Dao dao, Changes changes, Issue issue, ChangeCategory issueCat,
          Boolean responsibleIsReporter) {
    if(issue.getId() == null) {
      changes.addChange(new StringChange(issueCat, I_.get("Dossier"),
              "", issue.getDossier() != null ? issue.getDossier().getDescription() : ""));
      ChangeCategory cc = new ChangeCategory(4, I_.get("Participants"));
      IContact responsible = issue.getDossier().getDefaultResponsible();
      IContact reporter = Authentication.getIContact();
      if(responsible == null || !responsible.isWebUser()) {
        responsible = reporter;
      }
      IssueParticipant ip = issue.addReporter(responsibleIsReporter ? responsible : reporter);
      changes.addChange(new UniqueString(cc, I_.byKey(ip.getRole().toString()), ip.getName(), true));
      ip = issue.addResponsible(responsible);
      changes.addChange(new UniqueString(cc, I_.byKey(ip.getRole().toString()), ip.getName(), true));
      issue.setResolution(IssueResolution.RESOLUTION_NONE);
      if(Strings.isBlank(issue.getDescription())) {
        issue.setDescription("********");
      }
    }
    IssueWrapper iw = new IssueWrapper(issue);
    iw.clearEmpties();
    issue = dao.saveObject(issue);
    return issue;
  }
 
}