DossierDashboard.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2011 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.auth.Authentication;
import org.turro.dashboard.AbstractDaoDashboard;
import org.turro.dossier.dossier.DossierCounter;
import org.turro.dossier.entity.Category;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.web.ElContext;
import org.turro.indicator.Indicators;
import org.turro.jpa.iterator.DaoHtmlIterator;
import org.turro.jpa.search.DaoHtmlSearch;
import org.turro.jpa.search.DaoSearchKey;
import org.turro.phase.PhaseDefinitions;
 
public class DossierDashboard extends AbstractDaoDashboard {
 
  protected String categoryTemplate, orderBy, allowedCategories, issuePath, phaseTemplate;
  protected List<String> issueTypes, issueStatus, dossierTypes, dossierStatus, projectPhases;
  protected long categoryId, dossierId;
  protected Category lastCategory = null;
  protected boolean showSubject, onlyDossiers;
  protected DossierIterator di;
  protected IssueIterator ii;
  protected CategoriesTree pi;
 
  @Override
  protected DaoHtmlIterator initIterator() {
    categoryId = getAttributes().getAttributeIntegerValue("attrib:categoryId", 0);
    dossierId = getAttributes().getAttributeIntegerValue("attrib:dossierId", 0);
    // TYPE_DOSSIER,TYPE_PROPOSAL,TYPE_SECRET_PROPOSAL,TYPE_ELECTION,TYPE_SECRET_ELECTION,TYPE_PROJECT
    dossierTypes = getAttributes().getAttributeListValue("attrib:dossierTypes", null);
    // DOSSIER_OPENED,DOSSIER_CLOSED,DOSSIER_FROZEN
    dossierStatus = getAttributes().getAttributeListValue("attrib:dossierStatus", null);
    // PROJECT_IDEA,PROJECT_INCUBATOR,PROJECT_VOTING,PROJECT_DECIDING,PROJECT_OPPOSITING,PROJECT_VALIDATED,PROJECT_RESOLUTION;
    projectPhases = getAttributes().getAttributeListValue("attrib:projectPhases", null);
    // TYPE_DEFECT,TYPE_ENHANCEMENT,TYPE_FEATURE,TYPE_NONCONFORMITY,TYPE_PREVENTION,TYPE_TASK,TYPE_PATCH,TYPE_QUESTION,TYPE_DOCUMENT,TYPE_BESTPRACTICE
    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", "");
    allowedCategories = getAttributes().getAttributeValue("attrib:allowedCategories", "");
    showSubject = getAttributes().getAttributeBooleanValue("attrib:showSubject", true);
    onlyDossiers = getAttributes().getAttributeBooleanValue("attrib:onlyDossiers", false);
    categoryTemplate = getAttributes().getAttributeValue("attrib:categoryTemplate", "");
    phaseTemplate = getAttributes().getAttributeValue("attrib:phaseTemplate", "");
    orderBy = getAttributes().getAttributeValue("attrib:orderBy", "ORDER_BY_CATEGORY_DOSSIER_ISSUE");
    issuePath = getAttributes().getAttributeValue("attrib:issuePath", "");
    
    if(onlyDossiers) {
      if(!Strings.isBlank(allowedCategories)) {
        pi = new CategoriesTree(getConstructor(), getContext().getPath(), Authentication.getIContact(),
                allowedCategories, 
                dossierTypes == null ? null : dossierTypes.toArray(new String[0]),
                dossierStatus == null ? null : dossierStatus.toArray(new String[0]));
        if(!Strings.isBlank(categoryTemplate)) {
          pi.setFullTemplate(categoryTemplate);
        }
        pi.setRestricted(isRestricted());
        pi.setAllowForum(true);
        pi.fillTree("");
      }
      di = new DossierIterator(getConstructor(), getContext().getFullPath(), getId());
      di.setCategoryId(categoryId);
      di.setDossierId(dossierId);
      di.setDossierTypes(dossierTypes);
      di.setDossierStatus(dossierStatus);
      di.setProjectPhases(projectPhases);
      di.setAllowedCategories(allowedCategories);
      di.setIssuePath(issuePath);
      return di;
    } else {
      ii = new IssueIterator(getConstructor(), getContext().getFullPath(), getId());
      ii.setCategoryId(categoryId);
      ii.setDossierId(dossierId);
      ii.setDossierStatus(dossierStatus);
      ii.setIssueStatus(issueStatus);
      ii.setIssueTypes(issueTypes);
      ii.setOrderBy(IssueOrdering.valueOf(orderBy));
      return ii;
    }
  }
 
  @Override
  protected void initSearchEngine() {
    if(onlyDossiers) {
      DaoHtmlSearch dhs = getSearchEngine();
      if(dhs != null) {
        dhs.setTagRoot("dossier");
        dhs.setAttribute(getConstructor(), "phases", PhaseDefinitions.instance());
        dhs.setAttribute(getConstructor(), "dossierCounter", new DossierCounter(allowedCategories, dossierTypes, dossierStatus, isRestricted()));
        DaoSearchKey dsk = dhs.get("point-of-view");
        if(dsk != null && Strings.isBlank(dsk.getValue())) {
          dsk = new DaoSearchKey("point-of-view", "text");
          dsk.setValue(isDoMatching() ? "1" : "0");
          dhs.put("point-of-view", dsk);
        }
        if(dsk != null) {
          if("1".equals(dsk.getValue())) {
            dhs.setAttribute(getConstructor(), "variables", Indicators.getMatchingVariablesFinal("dossier"));
          } else {
            dhs.setAttribute(getConstructor(), "variables", Indicators.getRankingVariablesFinal("dossier"));
          }
        }
      }
    }
  }
 
  @Override
  public void startConstruction() throws ServletException, IOException {
    PrintWriter out = getConstructor().getOut();
    out.print(getStart());
    out.print(getStartBody());
 
    if(onlyDossiers) {
      if(pi != null) {
        if(!di.isItem()) {
          pi.setAllowComments(isAllowComments());
          pi.setAllowInterest(isAllowInterest());
          pi.setAllowVotes(isAllowVotes());
          pi.setAllowAttachments(isAllowAttachments());
          pi.setAllowDescriptions(isAllowDescriptions());
          pi.setFullTemplate(categoryTemplate);
        }
        di.setNavigationTree(pi);
      }
      if(!di.isItem()) {
        DaoHtmlSearch dhs = getSearchEngine();
        if(dhs != null) {
          di.setSearchEngine(dhs);
        }
        if(!Strings.isBlank(phaseTemplate)) {
          PhaseHtmlFilter phf = PhaseHtmlFilter.getInstance(getConstructor(), ElephantContext.getContextVariable(getConstructor()));
          phf.setTemplate(phaseTemplate);
          phf.setAllowedCategories(allowedCategories);
          phf.setTypes(dossierTypes == null ? null : dossierTypes.toArray(new String[0]));
          phf.setStatus(dossierStatus == null ? null : dossierStatus.toArray(new String[0]));
          di.setPhaseFilter(phf);
        }
      }
      di.render();
    } else {
      DaoHtmlSearch dhs = getSearchEngine();
      if(dhs != null) {
        ii.setSearchEngine(dhs);
      }
      ii.render();
    }
 
    out.print(getEndBody());
    out.print(getEnd());
  }
 
  @Override
  public void setRootCategories(ElContext root) {
    // TYPE_DOSSIER,TYPE_PROPOSAL,TYPE_SECRET_PROPOSAL,TYPE_ELECTION,TYPE_SECRET_ELECTION,TYPE_PROJECT
    dossierTypes = getAttributes().getAttributeListValue("attrib:dossierTypes", null);
    // DOSSIER_OPENED,DOSSIER_CLOSED,DOSSIER_FROZEN
    dossierStatus = getAttributes().getAttributeListValue("attrib:dossierStatus", null);
    allowedCategories = getAttributes().getAttributeValue("attrib:allowedCategories", "");
    onlyDossiers = getAttributes().getAttributeBooleanValue("attrib:onlyDossiers", false);
    if(onlyDossiers) {
      if(!Strings.isBlank(allowedCategories)) {
        CategoriesTree catTree = new CategoriesTree(getConstructor(), root.getPath(), null, 
                allowedCategories, 
                dossierTypes == null ? null : dossierTypes.toArray(new String[0]),
                dossierStatus == null ? null : dossierStatus.toArray(new String[0]));
        catTree.setRestricted(isRestricted());
        catTree.fillTree("");
        root.generateCategoriesChildren(catTree, (t) -> {
          return "?" + CategoriesTree.getSelectionLink(t.getPath()); 
        });
      }
    }
  }
 
}