MyIssuesDashboard.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.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletException;
import org.turro.string.ObjectString;
import org.turro.string.Strings;
import org.turro.auth.Authentication;
import org.turro.collections.KeyValueMap;
import org.turro.dossier.db.DossierPU;
import org.turro.dossier.entity.Dossier;
import org.turro.dossier.entity.Issue;
import org.turro.dossier.entity.IssueResolution;
import org.turro.dossier.entity.IssueStatus;
import org.turro.dossier.entity.IssueType;
import org.turro.dossier.issue.IssueWrapper;
import org.turro.dossier.workload.WorkloadItem;
import org.turro.dossier.workload.WorkloadQuery;
import org.turro.dossier.workload.WorkloadSet;
import org.turro.dossier.zul.issue.IssueStage;
import org.turro.elephant.context.Application;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IElement;
import org.turro.elephant.impl.abstracts.AbstractElement;
import org.turro.elephant.layout.IManageable;
import org.turro.elephant.layout.IRenderable;
import org.turro.elephant.security.IDefendable;
import org.turro.entities.Entities;
import org.turro.file.util.FileAttach;
import org.turro.i18n.I_;
import org.turro.jpa.search.DaoHtmlSearch;
import org.turro.jpa.search.DaoSearchKey;
import org.turro.marker.ElephantMarker;
import org.turro.marker.MarkerHelper;
import org.turro.plugin.contacts.ContactList;
import org.turro.plugin.contacts.IContact;
import org.turro.www.describeit.DescribeItCtrl;
import org.turro.www.starit.StarItCtrl;
import org.turro.www.voteit.VoteItCtrl;
 
public class MyIssuesDashboard extends AbstractElement implements IElement, IRenderable, IManageable, IDefendable {
 
  protected String sclass, fullTemplate, summaryTemplate, dossierPath;
  protected int count;
  protected boolean allowInterest, allowComments, allowVotes, showDescriptions, showSubject, showAttachments, showFiles;
  protected Long item;
  protected Issue issue;
  protected IContact contact;
 
  @Override
  public void loadData() throws ServletException, IOException {
    sclass = getAttributes().getAttributeValue("attrib:sclass", "");
    count = getAttributes().getAttributeIntegerValue("attrib:count", 10);
    allowInterest = getAttributes().getAttributeBooleanValue("attrib:allowInterest", true);
    allowVotes = getAttributes().getAttributeBooleanValue("attrib:allowVotes", true);
    showDescriptions = getAttributes().getAttributeBooleanValue("attrib:showDescriptions", true);
    showFiles = getAttributes().getAttributeBooleanValue("attrib:showFiles", true);
    showSubject = getAttributes().getAttributeBooleanValue("attrib:showSubject", true);
    fullTemplate = getAttributes().getAttributeValue("attrib:fullTemplate", "");
    summaryTemplate = getAttributes().getAttributeValue("attrib:summaryTemplate", "");
    dossierPath = getAttributes().getAttributeValue("attrib:dossierPath", null);
 
    KeyValueMap kvm = MarkerHelper.getObfuscatedParameters();
    if(kvm != null && !kvm.isEmpty() && kvm.containsKey("item")) {
      item = kvm.get(Long.class, "item");
    } else {
      item = (Long) ObjectString.parseString(getConstructor().getParameter("item"), Long.class, true);
    }
    
    if(item > 0) {
      issue = new DossierPU().find(Issue.class, item);
    }
    
    if(issue != null) {
      setTitle(issue.getDescription());
    } else {
      item = 0L;
    }    
    
    contact = Authentication.getIContact();
  }
 
  @Override
  public void startConstruction() throws ServletException, IOException {
    PrintWriter out = getConstructor().getOut();
    out.print(getStart());
    out.print(getStartBody());
 
    ElephantMarker marker = new ElephantMarker(getConstructor());
    if(!Strings.isBlank(dossierPath)) {
      marker.put("dossierPath", ElephantContext.getRootWebPath() + dossierPath);
    }
    if(item > 0) {
      prepareValues(marker, issue, 0);
      IssueWrapper iw = new IssueWrapper(issue);
      if(Application.getApplication().isInRole("issue:edit") || iw.isFullParticipant()) {
        IssueStage stage = getStage(iw);
        marker.put("stage", I_.byKey(stage.toString()));
        marker.put("wrapper", iw);
        marker.put("issue", issue);
        marker.put("addInfo", AddInformationCtrl.addInformation(iw, getItemLink(issue, 0)));
        marker.process("issue", getFullTemplate());
      }
    } else {
      /*
      List<IssueWrapper> iws = null;
      */
      
      DaoHtmlSearch dhs = DaoHtmlSearch.getInstance(getConstructor(), ElephantContext.getContextVariable(getConstructor()));
      String searchValue = null;
      if(dhs != null) {
        out.print(dhs.render(getConstructor()));
        DaoSearchKey dsk = dhs.get("search-value");
        if(dsk != null) {
          searchValue = dsk.getValue();
        }
      }
      WorkloadQuery wq = new WorkloadQuery(contact);
      wq.setSearchValue(Strings.isBlank(searchValue) ? "*" : searchValue);
      WorkloadSet ws = wq.getResults();
      IssueStage stage = null;
      int index = 0;
      for(WorkloadItem wi : ws) {
        IssueWrapper iw = wi.getWrapper();
        marker.put("divider", index > 0);
        marker.put("header", index == 0);
        marker.put("footer", index == ws.size() - 1);
        IssueStage current = WorkloadSet.getStage(wi);
        if(!(current.equals(stage))) {
          stage = current;
          marker.put("newStage", true);
        } else {
          marker.put("newStage", false);
        }
        prepareValues(marker, iw.getIssue(), 0);
        marker.put("stage", I_.byKey(current.toString()));
        marker.put("wrapper", iw);
        marker.put("issue", iw.getIssue());
        marker.process("issue", getSummaryTemplate());
        index++;
      }
      /*
      if(iws == null || iws.isEmpty()) {
        IssueResults ir = new IssueResults();
        ir.setByParticipant(contact);
        ir.setApplication(Application.getApplication());
        if(!Strings.isBlank(searchValue)) {
          ir.setIssueValue(searchValue);
        }
        iws = ir.getIssueList();
      } else {
        iws.addAll(WorksheetUtil.getNotIn(contact, iws));
      }
      IssueStage stage = null;
      for(int i = 0; i < iws.size(); i++) {
        IssueWrapper iw = iws.get(i);
        marker.put("divider", i > 0);
        marker.put("header", i == 0);
        marker.put("footer", i == iws.size() - 1);
        IssueStage current = getStage(iw);
        if(!(current.equals(stage))) {
          stage = current;
          marker.put("newStage", true);
        } else {
          marker.put("newStage", false);
        }
        prepareValues(marker, iw.getIssue(), 0);
        marker.put("stage", getConstructor().getString(current.toString()));
        marker.put("wrapper", iw);
        marker.put("issue", iw.getIssue());
        marker.process("issue", getSummaryTemplate());
      }
      if(iws.isEmpty()) {
        out.write("<h3>" + I_.get("Empty list") + "</h3>");
      }
      */
      if(ws.isEmpty()) {
        out.write("<h3>" + I_.get("Empty list") + "</h3>");
      }
    }
    
    out.print(getEndBody());
    out.print(getEnd());
  }
 
  @Override
  public String getStart() {
    return "<div class='" + sclass + "dossier-web'>";
  }
 
  @Override
  public String getEnd() {
    return "</div>";
  }
 
  private void prepareValues(ElephantMarker marker, Issue issue, int page) {
    marker.put("iee", Entities.getController(issue));
    
    marker.put("name", issue.getDescription());
 
    String link = getItemLink(issue, page);
    if(link != null) {
      marker.put("path", link);
      marker.put("all", getPageLink(page));
    }
    marker.put("readall", getItemLink(issue, page));
    marker.put("issueClass", getIssueClass(issue));
    
    if(allowVotes) {
      Dossier dossier = issue.getDossier();
      if(dossier.getType().isVotes()) {
        VoteItCtrl vic = new VoteItCtrl(getConstructor());
        vic.setEntityPath(DossierPU.getObjectPath(issue));
        vic.setForbiden(issue.getStatus().isFinished());
        if(dossier.getType().isSecret()) {
          vic.setForbid(true);
          vic.setAllowed((ContactList) dossier.getFullParticipants().getVoteIParticipants());
        }
        marker.put("vic", vic);
      }
    }
    if(allowInterest) {
      StarItCtrl sic = new StarItCtrl(getConstructor());
      sic.setEntityPath(DossierPU.getObjectPath(issue));
      marker.put("sic", sic);
    }
    if(showDescriptions) {
      DescribeItCtrl dic = new DescribeItCtrl(getConstructor());
      dic.setEntityPath(DossierPU.getObjectPath(issue));
      marker.put("dic", dic);
    }
    
    if(showFiles) {
      marker.put("files", new FileAttach(DossierPU.getObjectPath(issue)));
    }    
  }
 
  private String getItemLink(Issue issue, int page) {
    return getContext().getFullPath() + "?" + MarkerHelper.setObfuscatedPars("item=" + issue.getId() + ";page=" + page);
  }
 
  private String getPageLink(int page) {
    return getContext().getFullPath() + "?page=" + page;
  }
 
  private String getIssueClass(Issue issue) {
    return"issue" +
            (issue.getStatus().equals(IssueStatus.STATUS_NEW) ? " new" : "") +
            (issue.getStatus().equals(IssueStatus.STATUS_STARTED) ? " started" : "") +
            (issue.getStatus().equals(IssueStatus.STATUS_INCOMPLETE) ? " incomplete" : "") +
            (issue.getStatus().equals(IssueStatus.STATUS_REOPENED) ? " reopened" : "") +
            (issue.getStatus().equals(IssueStatus.STATUS_REUNION) ? " reunion" : "") +
            (issue.getStatus().equals(IssueStatus.STATUS_FROZEN) ? " frozen" : "") +
            (issue.getStatus().equals(IssueStatus.STATUS_RESOLVED) ? " resolved" : "") +
            (issue.getStatus().equals(IssueStatus.STATUS_VERIFIED) ? " verified" : "") +
            (issue.getStatus().equals(IssueStatus.STATUS_CLOSED) ? " closed" : "") +
 
            (issue.getType().equals(IssueType.TYPE_DEFECT) ? " defect" : "") +
            (issue.getType().equals(IssueType.TYPE_ENHANCEMENT) ? " enhancement" : "") +
            (issue.getType().equals(IssueType.TYPE_FEATURE) ? " feature" : "") +
            (issue.getType().equals(IssueType.TYPE_NONCONFORMITY) ? " nonconformity" : "") +
            (issue.getType().equals(IssueType.TYPE_PATCH) ? " patch" : "") +
            (issue.getType().equals(IssueType.TYPE_PREVENTION) ? " prevention" : "") +
            (issue.getType().equals(IssueType.TYPE_QUESTION) ? " question" : "") +
            (issue.getType().equals(IssueType.TYPE_TASK) ? " task" : "") +
            (issue.getType().equals(IssueType.TYPE_DOCUMENT) ? " document" : "") +
            (issue.getType().equals(IssueType.TYPE_BESTPRACTICE) ? " bestpractice" : "") +
            (issue.getType().equals(IssueType.TYPE_PROCESS) ? " process" : "") +
            (issue.getType().equals(IssueType.TYPE_PROPOSITION) ? " proposition" : "") +
 
            (issue.getResolution().equals(IssueResolution.RESOLUTION_DUPLICATED) ? " duplicated" : "") +
            (issue.getResolution().equals(IssueResolution.RESOLUTION_FIXED) ? " fixed" : "") +
            (issue.getResolution().equals(IssueResolution.RESOLUTION_INVALID) ? " invalid" : "") +
            (issue.getResolution().equals(IssueResolution.RESOLUTION_MOVED) ? " moved" : "") +
            (issue.getResolution().equals(IssueResolution.RESOLUTION_NONE) ? " none" : "") +
            (issue.getResolution().equals(IssueResolution.RESOLUTION_WONTFIX) ? " wontfix" : "") +
            (issue.getResolution().equals(IssueResolution.RESOLUTION_WORKSFORME) ? " worksforme" : "");
  }
 
  private String getSummaryTemplate() {
    return Strings.isBlank(summaryTemplate) ? "mySummary" : summaryTemplate;
  }
  
  private String getFullTemplate() {
    return Strings.isBlank(fullTemplate) ? "myFull" : fullTemplate;
  }
  
  private IssueStage getStage(IssueWrapper wissue) {
 
    if(wissue.isUnrelated()) {
      return IssueStage.ISSUE_STAGE_UNRELATED;
    }
 
    if(wissue.hasPassedNow()) {
      return IssueStage.ISSUE_STAGE_DATE_SURPASSED;
    }
 
    if(!wissue.hasPassedStartDate() || !wissue.canStartBySources()) {
      return IssueStage.ISSUE_STAGE_TO_COME;
    }
 
    int stage = wissue.getRelevanceOrderByContact();
 
    switch(stage) {
      case 1: return IssueStage.ISSUE_STAGE_TO_DO;
      case 2: return IssueStage.ISSUE_STAGE_REUNION;
      case 5: return IssueStage.ISSUE_STAGE_FROZEN;
    }
 
    return IssueStage.ISSUE_STAGE_TO_MONITOR;
  }
 
}