IssueIterator.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2013 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.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.turro.string.ObjectString;
import org.turro.string.Strings;
import org.turro.action.LinkType;
import org.turro.attach.www.AttachCtrl;
import org.turro.auth.Authentication;
import org.turro.dossier.db.DossierPU;
import org.turro.dossier.dossier.DossierWrapper;
import org.turro.dossier.entity.Category;
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.elephant.context.Application;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.db.WhereClause;
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.iterator.DaoHtmlIterator;
import org.turro.jpa.search.DaoHtmlSearch;
import org.turro.jpa.search.DaoSearchKey;
import org.turro.mail.recipients.MailContact;
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.commentit.CommentItCtrl;
import org.turro.www.describeit.DescribeItCtrl;
import org.turro.www.starit.StarItCtrl;
import org.turro.www.voteit.VoteItCtrl;
 
public class IssueIterator extends DaoHtmlIterator<Issue, Long>  {
 
  private String pubPath, actualParameters, uniqueId;
  private long categoryId, dossierId, lastDosierId = -1, lastCategoryId = -1;
  private List<String> issueTypes, issueStatus, dossierStatus;
  private boolean showSubject;
  private boolean all, onlyAssists;
  private IssueOrdering orderBy = IssueOrdering.ORDER_BY_CATEGORY_DOSSIER_ISSUE;
 
  public IssueIterator(IConstructor constructor, String pubPath, String uniqueId) {
    this(constructor, false, pubPath, uniqueId);
  }
  
  public IssueIterator(IConstructor constructor, boolean mail, String pubPath, String uniqueId) {
    super(new DossierPU(), new ElephantMarker(constructor, mail));
    this.pubPath = pubPath;
    this.uniqueId = uniqueId;
    this.all = Application.getApplication().isInRole("issue:all");
  }
 
  public void setCategoryId(long categoryId) {
    this.categoryId = categoryId;
  }
 
  public void setDossierId(long dossierId) {
    this.dossierId = dossierId;
  }
 
  public void setDossierStatus(List<String> dossierStatus) {
    this.dossierStatus = dossierStatus;
  }
 
  public void setIssueTypes(List<String> issueTypes) {
    this.issueTypes = issueTypes;
  }
 
  public void setIssueStatus(List<String> issueStatus) {
    this.issueStatus = issueStatus;
  }
 
  public boolean isShowSubject() {
    return showSubject;
  }
 
  public void setShowSubject(boolean showSubject) {
    this.showSubject = showSubject;
  }
 
  public IssueOrdering getOrderBy() {
    return orderBy;
  }
 
  public void setOrderBy(IssueOrdering orderBy) {
    this.orderBy = orderBy;
  }
 
  public boolean isOnlyAssists() {
    return onlyAssists;
  }
 
  public void setOnlyAssists(boolean onlyAssists) {
    this.onlyAssists = onlyAssists;
  }
 
  @Override
  protected WhereClause getWhereClause() {
    WhereClause wc = new WhereClause();
    wc.addClause("select distinct i from Issue as i");
    wc.addClause("join i.participants as p");
    addCriteria(wc);
    wc.addClause(IssueOrdering.ORDER_BY_ACTIVITY.getOrderBy());
    return wc;
  }
 
  @Override
  protected WhereClause getCountClause() {
    WhereClause wc = new WhereClause();
    wc.addClause("select count(distinct i) from Issue as i");
    wc.addClause("join i.participants as p");
    addCriteria(wc);
    return wc;
  }
 
  public String getActualParameters() {
    return Strings.isBlank(actualParameters) ? "?a=b" : actualParameters;
  }
 
  @Override
  protected void renderSummary(ElephantMarker marker, Issue e, int page) {
    if(e != null) {
      marker.put("issue", e);
      marker.put("newCategory", e.getDossier().getCategory().getId() != lastCategoryId);
      marker.put("newDossier", e.getDossier().getId() != lastDosierId);
      lastCategoryId = e.getDossier().getCategory().getId();
      lastDosierId = e.getDossier().getId();
      prepareValues(e, page, false);
      marker.put("restricted", isRestricted());
    }
    marker.process("issue", getSummaryTemplate());
    actualParameters = getPageLink(page);
  }
 
  @Override
  protected void renderItem(ElephantMarker marker, Issue e, int page) {
    Long dossId = (Long) ObjectString.parseString(constructor.getParameter("dossierId"), Long.class, false);
    if(dossId != null) {
      if(e.getDossier().getId().equals(dossId)) {
        Dossier dossier = dao.find(Dossier.class, dossId);
        marker.put("dossier", dossier);
        if(!Strings.isBlank(dossier.getFullDescription(showSubject))) {
          constructor.addOnLoadedJavaScript(
            "jQuery('title').html('" + dossier.getFullDescription(showSubject).replace("'", "\\'") + "');"
          );
        }
        prepareValues(dossier, page, false);
        marker.put("restricted", isRestricted());
        marker.process("dossier", getFullTemplate());
      }
    } else {
      marker.put("issue", e);
//      if(!Strings.isBlank(e.getFullDescription(showSubject))) {
//        constructor.addOnLoadedJavaScript(
//          "jQuery('title').html('" + e.getFullDescription(showSubject).replace("'", "\\'") + "');"
//        );
//      }
      prepareValues(e, page, false);
      marker.put("restricted", isRestricted());
      marker.process("issue", getFullTemplate());
    }
    actualParameters = getPageLink(page);
  }
 
  @Override
  protected String entityRoot() {
    return "issue";
  }
 
  @Override
  protected Issue entity(Long value) {
    WhereClause wc = new WhereClause();
    wc.addClause("select distinct i from Issue as i");
    wc.addClause("join i.participants as p");
    addCriteria(wc);
    wc.addClause("and i.id = :id");
    wc.addNamedValue("id", value);
    return (Issue) dao.getSingleResultOrNull(wc);
  }
 
  private void addCriteria(WhereClause wc) {
    wc.addClause("where i.publishable = TRUE");
    if(!Strings.isBlank(pubPath) && isSearchOption()) {
      DaoHtmlSearch dhs = DaoHtmlSearch.getInstance(constructor, ElephantContext.getContextVariable(constructor));
      if(dhs != null) {
        DaoSearchKey dsk = dhs.get("search-value");
        if(dsk != null) {
          String searchValue = dsk.getValue();
          if(!Strings.isBlank(searchValue)) {
            wc.addClause("and i.description like :search01");
            wc.addNamedValue("search01", "%" + searchValue + "%");
          }
        }
      }
    }
    if(categoryId > 0) {
      wc.addClause("and i.dossier.category.id in (" + getCategories(categoryId) + ")");
    } else if(dossierId > 0) {
      wc.addClause("and i.dossier.id = " + dossierId);
    }
    if(dossierStatus != null && dossierStatus.size() > 0) {
      wc.addClause("and (");
      String sep = "";
      for(String s : dossierStatus) {
        DossierStatus ds = DossierStatus.valueOf(s);
        if(ds != null) {
          String par = "status" + wc.getUniqueSuffix();
          wc.addClause(sep + "i.dossier.status = :" + par);
          wc.addNamedValue(par, ds);
          sep = " or ";
        }
      }
      wc.addClause(")");
    }
    if(issueStatus != null && issueStatus.size() > 0) {
      wc.addClause("and (");
      String sep = "";
      for(String s : issueStatus) {
        IssueStatus is = IssueStatus.valueOf(s);
        if(is != null) {
          String par = "status" + wc.getUniqueSuffix();
          wc.addClause(sep + "i.status = :" + par);
          wc.addNamedValue(par, is);
          sep = " or ";
        }
      }
      wc.addClause(")");
    }
    if(issueTypes != null && issueTypes.size() > 0) {
      wc.addClause("and (");
      String sep = "";
      for(String s : issueTypes) {
        IssueType it = IssueType.valueOf(s);
        if(it != null) {
          String par = "type" + wc.getUniqueSuffix();
          wc.addClause(sep + "i.type = :" + par);
          wc.addNamedValue(par, it);
          sep = " or ";
        }
      }
      wc.addClause(")");
    }
  }
 
  @Override
  protected boolean isValid(Issue e) {
    if(isRestricted() && e != null) {
      return participates(e);
    } else {
      return super.isValid(e);
    }    
  }
 
  private boolean participates(Issue e) {
    if(onlyAssists) {
      return new IssueWrapper(e).isAssistant();
    } else {
      return all || new IssueWrapper(e).isFullParticipant();
    }
  }
  
  private String getCategories(long categoryId) {
    String result = null;
    Category category = dao.find(Category.class, Long.valueOf(categoryId));
    return addCategory(category, result);
  }
 
  private String addCategory(Category category, String result) {
    if(category != null) {
      result = (String) (((result == null) ? "" : result + ",") + category.getId());
      for(Category c : category.getChildren()) {
        result = addCategory(c, result);
      }      
    }
    return result;
  }
 
  private void prepareValues(Issue issue, int page, boolean asMail) {  
    marker.put("wrapper", new IssueWrapper(issue));
    if(asMail && pubPath != null) {
      marker.put("name", MailContact.createLink(issue.getDescription(), getItemLink(issue, page), false));
    } else {
      marker.put("name", issue.getDescription());
    }
    String link = getItemLink(issue, page);
    if(link != null) {
      marker.put("path", link);
      marker.put("all", getPageLink(page));
    }
    marker.put("issueClass", getIssueClass(issue));
    if(!Strings.isBlank(pubPath)) {
      marker.put("readall", getItemLink(issue, page));
    }
    Dossier dossier = issue.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" : ""));
    
    if(isAllowVotes()) {
      if(dossier.getType().isVotes()) {
        VoteItCtrl vic = new VoteItCtrl(constructor);
        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(isAllowInterest()) {
      StarItCtrl sic = new StarItCtrl(constructor);
      sic.setEntityPath(DossierPU.getObjectPath(issue));
      marker.put("sic", sic);
    }
    if(isAllowComments()) {
      CommentItCtrl cic = new CommentItCtrl(constructor);
      cic.setEntityPath(DossierPU.getObjectPath(issue));
      marker.put("cic", cic);
    }
    if(isAllowAttachments()) {
      AttachCtrl ac = new AttachCtrl(constructor);
      ac.setEntityPath(DossierPU.getObjectPath(issue));
      ac.setPublicOnly(true);
      if(issue.getFullParticipants().canShowAllAttachments(Authentication.getIContact())) {
        ac.setPublicOnly(false);
      }
      marker.put("ac", ac);
    }
    if(isAllowDescriptions()) {
      DescribeItCtrl dic = new DescribeItCtrl(constructor);
      dic.setEntityPath(DossierPU.getObjectPath(issue));
      marker.put("dic", dic);
    }
    marker.put("files", new FileAttach(DossierPU.getObjectPath(issue)));
    
    IContact contact = Authentication.getIContact();
    if(contact.isWebapp()) {
      marker.put("linkWebapp", Entities.getController(issue).getAppUrl());
    }
    if(issue.getFullParticipants().isParticipant(contact)) {
      marker.put("linkWebint", Entities.getController(issue).getEntityUrl(LinkType.WEB_INTERNAL, null));
    }
//    if(contact.isWebapp()) {
//      marker.put("linkWebapp", DossierEntityInfo.linkForPath(
//              new Path(DossierPU.getObjectPath(issue)), contact, LinkType.INTERNAL));
//    }
//    if(issue.getFullParticipants().isParticipant(contact)) {
//      marker.put("linkWebint", DossierEntityInfo.linkForPath(
//              new Path(DossierPU.getObjectPath(issue)), contact, LinkType.WEB_INTERNAL));
//    }
  }
  
  private void prepareValues(Dossier dossier, int page, boolean asMail) {
    marker.put("wrapper", new DossierWrapper(dossier));
    if(isAllowVotes()) {
      if(dossier.getType().isVotes()) {
        VoteItCtrl vic = new VoteItCtrl(constructor);
        vic.setEntityPath(DossierPU.getObjectPath(dossier));
        vic.setForbiden(!dossier.getStatus().isOpen());
        if(dossier.getType().isSecret()) {
          vic.setForbid(true);
          vic.setAllowed((ContactList) dossier.getFullParticipants().getVoteIParticipants());
        }
        marker.put("vic", vic);
      }
    }
    if(isAllowInterest()) {
      StarItCtrl sic = new StarItCtrl(constructor);
      sic.setEntityPath(DossierPU.getObjectPath(dossier));
      marker.put("sic", sic);
    }
    if(isAllowComments()) {
      CommentItCtrl cic = new CommentItCtrl(constructor);
      cic.setEntityPath(DossierPU.getObjectPath(dossier));
      marker.put("cic", cic);
    }
    if(isAllowAttachments()) {
      AttachCtrl ac = new AttachCtrl(constructor);
      ac.setEntityPath(DossierPU.getObjectPath(dossier));
      if(isRestricted() && new DossierWrapper(dossier).getCanShowAllAttachments()) {
        ac.setPublicOnly(false);
      } else {
        ac.setPublicOnly(true);
      }
      marker.put("ac", ac);
    }
    if(isAllowDescriptions()) {
      DescribeItCtrl dic = new DescribeItCtrl(constructor);
      dic.setEntityPath(DossierPU.getObjectPath(dossier));
      marker.put("dic", dic);
    }
    marker.put("files", new FileAttach(DossierPU.getObjectPath(dossier)));
  }
  
  private String getItemLink(Issue issue, int page) {
    if(pubPath == null) {
      String link = issue.getIssueURL();
      if(link == null) {
        return null;
      } else {
        return ElephantContext.getRootWebPath() + link;
      }
    } else {
      return pubPath + "?" + MarkerHelper.setObfuscatedPars("item=" + issue.getId() + ";page=" + page);
    }    
  }
 
  private String getPageLink(int page) {
    return pubPath + "?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" : "");
  }
 
  @Override
  protected String title(Issue e) {
    if(!Strings.isBlank(e.getFullDescription(showSubject))) {
      return e.getFullDescription(showSubject);
    }
    return null;
  }
 
  @Override
  protected Collection<String> metas(Issue e) {
    ArrayList<RepositoryFile> files = new ArrayList<>();
    String path = getItemLink(e, 0);
    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.getDescription(), e.getFullDescription(), files);
    return sn.getMetas();
  }
  
}