KnowledgeBaseDashboard.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.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.EnumSet;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.servlet.ServletException;
import org.turro.string.ObjectString;
import org.turro.string.Strings;
import org.turro.auth.Authentication;
import org.turro.collections.CollectionUtil;
import org.turro.collections.KeyValueMap;
import org.turro.dossier.db.DossierPU;
import org.turro.dossier.entity.Category;
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.kb.KnowledgeBaseList;
import org.turro.dossier.kb.KnowledgeBaseQuery;
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.impl.context.AttributeItem;
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.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 KnowledgeBaseDashboard extends AbstractElement implements IElement, IRenderable, IManageable, IDefendable {
 
  protected String sclass, fullTemplate, summaryTemplate, issuePath;
  protected List<String> issueTypes, issueStatus;
  protected long categoryId, dossierId;
  protected int count;
  protected boolean allowInterest, allowComments, allowVotes, showDescriptions, showFiles;
  protected KnowledgeBaseQuery kbq;
  protected KnowledgeBaseList kbl;
  protected IContact contact;
  protected Long item;
  protected Issue issue;
 
  @Override
  public void loadData() throws ServletException, IOException {
    sclass = getAttributes().getAttributeValue("attrib:sclass", "");
    categoryId = getAttributes().getAttributeIntegerValue("attrib:categoryId", 0);
    dossierId = getAttributes().getAttributeIntegerValue("attrib:dossierId", 0);
    // TYPE_DEFECT,TYPE_ENHANCEMENT,TYPE_FEATURE,TYPE_NONCONFORMITY,TYPE_PREVENTION,TYPE_TASK,TYPE_PATCH,TYPE_QUESTION,TYPE_DOCUMENT,TYPE_BESTPRACTICE,TYPE_PROCES,TYPE_PROPOSITION
    issueTypes = getAttributes().getAttributeListValue("attrib:issueTypes", "");
    // STATUS_NEW,STATUS_STARTED,STATUS_INCOMPLETE,STATUS_REOPENED,STATUS_REUNION,STATUS_FROZEN,STATUS_RESOLVED,STATUS_VERIFIED,STATUS_CLOSED
    issueStatus = getAttributes().getAttributeListValue("attrib:issueStatus", "");
    count = getAttributes().getAttributeIntegerValue("attrib:count", 10);
    allowInterest = getAttributes().getAttributeBooleanValue("attrib:allowInterest", true);
    allowComments = getAttributes().getAttributeBooleanValue("attrib:allowComments", true);
    allowVotes = getAttributes().getAttributeBooleanValue("attrib:allowVotes", true);
    showDescriptions = getAttributes().getAttributeBooleanValue("attrib:showDescriptions", true);
    showFiles = getAttributes().getAttributeBooleanValue("attrib:showFiles", true);
    fullTemplate = getAttributes().getAttributeValue("attrib:fullTemplate", "");
    summaryTemplate = getAttributes().getAttributeValue("attrib:summaryTemplate", "");
    issuePath = getAttributes().getAttributeValue("attrib:issuePath", "");
 
    contact = Authentication.getIContact();
    kbq = new KnowledgeBaseQuery();
    kbq.setSearchValue(AttributeItem.getFromParameter(getConstructor(), "search-value", "").getValue());
    kbq.setOnlyTitle(AttributeItem.getFromParameter(getConstructor(), "only-title", null).getBooleanValue(false));
    kbq.setMaxResults(AttributeItem.getFromParameter(getConstructor(), "max-results", null).getIntegerValue(300));
    kbq.setTypes(AttributeItem.getFromParameter(getConstructor(), "type", null).getEnumSet(IssueType.class));
    kbq.setStatus(AttributeItem.getFromParameter(getConstructor(), "status", null).getEnumSet(IssueStatus.class));
    kbq.setResolutions(AttributeItem.getFromParameter(getConstructor(), "resolution", null).getEnumSet(IssueResolution.class));
    kbq.setDossierId(AttributeItem.getFromParameter(getConstructor(), "dossier-id", null).getLongValue(0));
    
    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(!canLink(new IssueWrapper(issue, contact))) {
        issue = null;
      }
    }
    
    if(issue != null) {
      setTitle(issue.getDescription());
    } else {
      item = 0L;
      if(categoryId > 0) {
        Category category = new DossierPU().find(Category.class, categoryId);
        kbq.setCategory(category);
      }
      if(dossierId > 0) {
        Dossier dossier = new DossierPU().find(Dossier.class, dossierId);
        kbq.setDossier(dossier);
      }
      kbq.setByParticipant(null);
      kbl = kbq.getResultList();
    }    
 
  }
 
  @Override
  public void startConstruction() throws ServletException, IOException {
    PrintWriter out = getConstructor().getOut();
    out.print(getStart());
    out.print(getStartBody());
 
    ElephantMarker marker = new ElephantMarker(getConstructor());
    marker.put("searchValue", kbq.getSearchValue());
    marker.put("onlyTitle", kbq.isOnlyTitle());
    marker.put("maxResults", kbq.getMaxResults());
    marker.put("types", kbq.getTypes());
    marker.put("status", kbq.getStatus());
    marker.put("resolutions", kbq.getResolutions());
    marker.put("ntypes", EnumSet.complementOf(EnumSet.copyOf(kbq.getTypes())));
    marker.put("nstatus", EnumSet.complementOf(EnumSet.copyOf(kbq.getStatus())));
    marker.put("nresolutions", EnumSet.complementOf(EnumSet.copyOf(kbq.getResolutions())));
    marker.put("dossierId", kbq.getDossierId());
    if(item > 0) {
      IssueWrapper wrapper = new IssueWrapper(issue, contact);
      prepareValues(marker, wrapper.getIssue(), 0);
      marker.put("wrapper", wrapper);
      marker.put("issue", wrapper.getIssue());
      if(contact.isWebUser() && (Application.getApplication().isInRole("issue:edit") || wrapper.isFullParticipant())) {
        marker.put("addInfo", AddInformationCtrl.addInformation(wrapper, getItemLink(wrapper.getIssue(), 0)));
      }
      marker.process("issue", getFullTemplate());
    } else if(kbl.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(IssueWrapper wrapper : kbl) {
        marker.put("divider", index > 0);
        marker.put("header", index == 0);
        marker.put("footer", index == kbl.size() - 1);
        prepareValues(marker, wrapper.getIssue(), 0);
        marker.put("wrapper", wrapper);
        marker.put("issue", wrapper.getIssue());
        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, 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) ? "kbSummary" : summaryTemplate;
  }
  
  private String getFullTemplate() {
    return Strings.isBlank(fullTemplate) ? "kbFull" : fullTemplate;
  }
 
  private boolean canLink(IssueWrapper iw) {
    Application app = Application.getApplication();
    boolean show = app.isInRole("issue:show"), 
            all = app.isInRole("issue:all");
    return (iw.getIssue().isKnowledgeBase() || (show && (all || iw.isFullParticipant())));
  }
  
  public static String createLink(String searchValue, boolean onlyTitle, 
          Set<IssueType> type, Set<IssueStatus> status, Set<IssueResolution> resolution,
          Long dossierId) {
    StringBuilder sb = new StringBuilder();
    String sep = "?";
    sb.append("/user/kbase");
    if(!Strings.isBlank(searchValue)) {
      sb.append(sep); sep = "&";
      try {
        sb.append("search-value=").append(URLEncoder.encode(searchValue, "UTF-8"));
      } catch (UnsupportedEncodingException ex) {
        Logger.getLogger(KnowledgeBaseDashboard.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
      }
    }
    if(onlyTitle) {
      sb.append(sep); sep = "&";
      sb.append("only-title=true");
    }
    if(dossierId != null && dossierId > 0) {
      sb.append(sep); sep = "&";
      sb.append("dossier-id=" + dossierId);
    }
    if(type != null && !type.isEmpty()) {
      sb.append(sep); sep = "&";
      sb.append("type=");
      sb.append(CollectionUtil.from(type).getCSV(t -> t.toString()));
    }
    if(status != null && !status.isEmpty()) {
      sb.append(sep); sep = "&";
      sb.append("status=");
      sb.append(CollectionUtil.from(status).getCSV(t -> t.toString()));
    }
    if(resolution != null && !resolution.isEmpty()) {
      sb.append(sep); sep = "&";
      sb.append("resolution=");
      sb.append(CollectionUtil.from(resolution).getCSV(t -> t.toString()));
    }
    return sb.toString();
  }
  
  public static String createLink(Issue issue) {
    StringBuilder sb = new StringBuilder();
    String sep = "?";
    sb.append("/user/kbase");
    if(issue != null) {
      sb.append(sep); sep = "&";
      sb.append(MarkerHelper.setObfuscatedPars("item=" + issue.getId()));
    }
    return sb.toString();
  }
}