PendingRevisionDashboard.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2016 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 java.util.List;
import javax.servlet.ServletException;
import org.turro.string.Strings;
import org.turro.dossier.db.DossierPU;
import org.turro.dossier.entity.Dossier;
import org.turro.dossier.entity.Issue;
import org.turro.dossier.entity.IssueParticipant;
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.kb.PendingRevisionQuery;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IElement;
import org.turro.elephant.impl.abstracts.AbstractElement;
import org.turro.elephant.impl.context.AttributeItem;
import org.turro.elephant.layout.IManageable;
import org.turro.elephant.layout.IRenderable;
import org.turro.elephant.security.IDefendable;
import org.turro.file.util.FileAttach;
import org.turro.marker.ElephantMarker;
import org.turro.plugin.contacts.ContactList;
import org.turro.www.describeit.DescribeItCtrl;
import org.turro.www.starit.StarItCtrl;
import org.turro.www.voteit.VoteItCtrl;
 
public class PendingRevisionDashboard extends AbstractElement implements IElement, IRenderable, IManageable, IDefendable {
 
  protected String sclass, fullTemplate, summaryTemplate, issuePath;
  protected boolean allowInterest, allowComments, allowVotes, showDescriptions;
  protected PendingRevisionQuery prq;
 
  @Override
  public void loadData() throws ServletException, IOException {
    sclass = getAttributes().getAttributeValue("attrib:sclass", "");
    allowInterest = getAttributes().getAttributeBooleanValue("attrib:allowInterest", true);
    allowComments = getAttributes().getAttributeBooleanValue("attrib:allowComments", true);
    allowVotes = getAttributes().getAttributeBooleanValue("attrib:allowVotes", true);
    showDescriptions = getAttributes().getAttributeBooleanValue("attrib:showDescriptions", true);
    fullTemplate = getAttributes().getAttributeValue("attrib:fullTemplate", "");
    summaryTemplate = getAttributes().getAttributeValue("attrib:summaryTemplate", "");
    issuePath = getAttributes().getAttributeValue("attrib:issuePath", "");
 
    prq = new PendingRevisionQuery();
 
    long archive = AttributeItem.getFromParameter(getConstructor(), "archive", "").getLongValue(0L);
    
    if(archive > 0) {
      prq.archive(archive);
    }
  }
 
  @Override
  public void startConstruction() throws ServletException, IOException {
    PrintWriter out = getConstructor().getOut();
    out.print(getStart());
    out.print(getStartBody());
 
    List<IssueParticipant> list = prq.getResultList();
    
    ElephantMarker marker = new ElephantMarker(getConstructor());
    if(list.isEmpty()) {
      marker.put("divider", false);
      marker.put("header", true);
      marker.put("footer", true);
      marker.put("empty", true);
      marker.process("issue", getSummaryTemplate());
    } else {
      int index = 0;
      marker.put("empty", false);
      for(IssueParticipant ip : list) {
        marker.put("divider", index > 0);
        marker.put("header", index == 0);
        marker.put("footer", index == list.size() - 1);
        prepareValues(marker, ip, 0);
        marker.put("ip", ip);
        marker.process("issue", getSummaryTemplate());
        index++;
      }
    }
    
    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, IssueParticipant ip, int page) {
    
    Issue issue = ip.getIssue();
    
    marker.put("issue", issue);
    marker.put("wrapper", new IssueWrapper(issue, prq.getByParticipant()));
    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);
    }
 
    marker.put("files", new FileAttach(DossierPU.getObjectPath(issue)));
  }
 
  private String getItemLink(Issue issue, int page) {
    return ElephantContext.getRootWebPath() + KnowledgeBaseDashboard.createLink(issue);
  }
 
  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) ? "prSummary" : summaryTemplate;
  }
  
  private String getFullTemplate() {
    return Strings.isBlank(fullTemplate) ? "prFull" : fullTemplate;
  }
 
}