KnowledgeBaseContentIterator.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2018 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.content;
 
import java.io.Writer;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import org.turro.string.Strings;
import org.turro.attach.www.AttachCtrl;
import org.turro.dossier.db.DossierPU;
import org.turro.dossier.entity.Dossier;
import org.turro.dossier.entity.DossierStatus;
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.KnowledgeBaseQuery;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.impl.repository.Repository;
import org.turro.elephant.impl.repository.RepositoryFile;
import org.turro.elephant.web.SocialImageMap;
import org.turro.elephant.web.SocialNet;
import org.turro.entities.Entities;
import org.turro.file.util.FileAttach;
import org.turro.jpa.content.EntityItemContentIterator;
import org.turro.marker.ElephantMarker;
import org.turro.plugin.contacts.IContact;
import org.turro.www.commentit.CommentItCtrl;
import org.turro.www.describeit.DescribeItCtrl;
import org.turro.www.starit.StarItCtrl;
import org.turro.www.voteit.VoteItCtrl;
 
public class KnowledgeBaseContentIterator extends EntityItemContentIterator<IssueWrapper, Long>  {
 
  private boolean showSubject;
  private final boolean all;
 
  public KnowledgeBaseContentIterator(IConstructor constructor, Writer writer, IContact contact, boolean mail, String pubPath) {
    super(getKnowledgeBase(contact), constructor, writer, contact, mail, pubPath);
    this.all = contact.getPermissions().isInRole("issue:all");
  }
 
  public boolean isShowSubject() {
    return showSubject;
  }
 
  public void setShowSubject(boolean showSubject) {
    this.showSubject = showSubject;
  }
 
  @Override
  protected void renderSummary(ElephantMarker marker, IssueWrapper e, int page) {
    if(e != null) {
      marker.put("issue", e.getIssue());
      marker.put("wrapper", e);
      prepareValues(e, page);
    }
    marker.process(getTemplateRoot(), getSummaryTemplate(), getWriter());
  }
 
  @Override
  protected void renderItem(ElephantMarker marker, IssueWrapper e, int page) {
    marker.put("issue", e.getIssue());
    marker.put("wrapper", e);
    prepareValues(e, page);
    marker.process(getTemplateRoot(), getFullTemplate(), getWriter());
  }
 
  @Override
  protected IssueWrapper entity(Long value) {
    for(IssueWrapper wrapper : collection) {
      if(wrapper.getIssue().getId().equals(value)) {
        return wrapper;
      }
    }
    return null;
  }
 
  @Override
  protected boolean isValid(IssueWrapper e) {
    if(e != null) {
      return all || e.getIssue().isKnowledgeBase() || e.isFullParticipant();
    } else {
      return super.isValid(e);
    }    
  }
 
  private void prepareValues(IssueWrapper wrapper, int page) {
    prepareControls(wrapper, page);
    marker.put("issueClass", getIssueClass(wrapper.getIssue()));
    Dossier dossier = wrapper.getIssue().getDossier();
    marker.put("dossierClass", "dossier" +
            (dossier.getStatus().equals(DossierStatus.DOSSIER_OPENED) ? " openned" : "") +
            (dossier.getStatus().equals(DossierStatus.DOSSIER_CLOSED) ? " closed" : "") +
            (dossier.getStatus().equals(DossierStatus.DOSSIER_FROZEN) ? " frozen" : ""));
  }
  
  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" : "");
  }
 
  @Override
  protected String title(IssueWrapper e) {
    if(!Strings.isBlank(e.getIssue().getFullDescription(showSubject))) {
      return e.getIssue().getFullDescription(showSubject);
    }
    return null;
  }
 
  @Override
  protected Collection<String> metas(IssueWrapper e) {
    ArrayList<RepositoryFile> files = new ArrayList<>();
    String path = getItemLink(e);
    if(!SocialImageMap.hasImage(path)) {
      FileAttach fa = new FileAttach(DossierPU.getObjectPath(e));
      Repository repository = fa.getPublishableRepository(constructor);
      files.addAll(repository.getRepositoryFiles("*_social.png,*_social.jpg"));
      files.addAll(repository.getRepositoryFiles("*.png,*.jpg"));
    }
    SocialNet sn = new SocialNet(path, e.getIssue().getDescription(), e.getIssue().getFullDescription(), files);
    return sn.getMetas();
  }
  
  private static List<IssueWrapper> getKnowledgeBase(IContact contact) {
    KnowledgeBaseQuery kbq = new KnowledgeBaseQuery(contact);
    kbq.setSearchValue("*");
    kbq.setOnlyTitle(true);
    kbq.setMaxResults(300);
    kbq.setTypes(new HashSet<>(Arrays.asList(IssueType.values())));
    kbq.setStatus(new HashSet<>(Arrays.asList(IssueStatus.values())));
    kbq.setResolutions(new HashSet<>(Arrays.asList(IssueResolution.values())));
    kbq.setDossierId(null);
    return kbq.getResultList();
  }
 
  @Override
  protected String getTemplateRoot() {
    return isMail() ? "content/newsletter/sections/knowledgeBase" : "issue";
  }
 
  @Override
  protected Object doVotesCtrl(IssueWrapper e) {
    return Entities.getController(e.getIssue()).configureCtrl(
            new VoteItCtrl(constructor), getContact());
  }
 
  @Override
  protected Object doInterestCtrl(IssueWrapper e) {
    return Entities.getController(e.getIssue()).configureCtrl(
            new StarItCtrl(constructor), getContact());
  }
 
  @Override
  protected Object doCommentsCtrl(IssueWrapper e) {
    return Entities.getController(e.getIssue()).configureCtrl(
            new CommentItCtrl(constructor), getContact());
  }
 
  @Override
  protected Object doAttachmentsCtrl(IssueWrapper e) {
    return Entities.getController(e.getIssue()).configureCtrl(
            new AttachCtrl(constructor), getContact());
  }
 
  @Override
  protected Object doFilesCtrl(IssueWrapper e) {
    return Entities.getController(e.getIssue()).configureCtrl(
            new FileAttach(DossierPU.getObjectPath(e.getIssue())), getContact());
  }
 
  @Override
  protected Object doDescriptionsCtrl(IssueWrapper e) {
    return Entities.getController(e.getIssue()).configureCtrl(
            new DescribeItCtrl(constructor), getContact());
  }
 
  @Override
  protected Object doPollsCtrl(IssueWrapper e) {
    throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
  }
 
  @Override
  protected String getItemLink(IssueWrapper e) {
    return getReadAllLink() + "?item=" + e.getIssue().getId();
  }
 
  @Override
  protected String getReadAllLink() {
    if(Strings.isBlank(getContextPath())) {
      return getRestrictedLink();
    }
    return getContextPath();
  }
 
  @Override
  protected String getRestrictedLink() {
    return "/user/kbase";
  }
  
}