WorkloadQuery.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2015 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.workload;
 
import java.util.Arrays;
import java.util.Collections;
import java.util.EnumSet;
import java.util.Set;
import org.turro.string.Strings;
import org.turro.action.Contacts;
import org.turro.auth.Authentication;
import org.turro.dossier.db.DossierPU;
import org.turro.dossier.entity.Category;
import org.turro.dossier.entity.Dossier;
import org.turro.dossier.entity.DossierStatus;
import org.turro.dossier.entity.IssueParticipantRole;
import org.turro.dossier.entity.IssueResolution;
import org.turro.dossier.entity.IssueStatus;
import org.turro.dossier.entity.IssueType;
import org.turro.dossier.entity.ParticipantRole;
import org.turro.dossier.entity.Worksheet;
import org.turro.dossier.issue.IssueSet;
import org.turro.dossier.issue.IssueWrapper;
import org.turro.dossier.util.WorksheetUtil;
import org.turro.elephant.context.Application;
import org.turro.elephant.db.WhereClause;
import org.turro.jpa.Dao;
import org.turro.plugin.contacts.IContact;
import org.turro.util.Chars;
 
public class WorkloadQuery {
 
  private Application app = Application.getApplication();
 
  private String searchValue = "*";
  private IContact realParticipant, byParticipant;
  private Long dossierId;
  private Dossier dossier;
  private EnumSet<IssueParticipantRole> roles = EnumSet.noneOf(IssueParticipantRole.class);
  private EnumSet<IssueStatus> status = EnumSet.noneOf(IssueStatus.class);
  private EnumSet<IssueResolution> resolutions = EnumSet.noneOf(IssueResolution.class);
  private EnumSet<IssueType> types = EnumSet.noneOf(IssueType.class);
  private Category category;
  private IContact subject;
 
  public WorkloadQuery() {
    resetToDefault();
  }
 
  // Used by headless mail notifications
  public WorkloadQuery(IContact contact) {
    realParticipant = contact;
    app = null;
    resetToDefault();
  }
 
  private void resetToDefault() {
    if(realParticipant == null) {
      realParticipant = Authentication.getIContact();
    }
    if(byParticipant == null) {
      byParticipant = realParticipant;
    }
    roles.addAll(Arrays.asList(IssueParticipantRole.values()));
    types.addAll(Arrays.asList(IssueType.values()));
    status.addAll(Arrays.asList(IssueStatus.values()));
    status.remove(IssueStatus.STATUS_CLOSED);
    resolutions.addAll(Arrays.asList(IssueResolution.values()));
  }
 
  public void setApplication(Application app) {
    this.app = app;
  }
 
  public void markSelf() {
    resetToDefault();
  }
  
  public WorkloadSet getResults() {
    if(byParticipant == null) {
      byParticipant = realParticipant;
    }
    WorkloadSet results = new WorkloadSet();
    if((Strings.isEmpty(searchValue) || "*".equals(searchValue)) &&
        category == null && dossier == null && (dossierId == null || dossierId == 0)) {
      for(Worksheet worksheet : WorksheetUtil.getWorksheet(byParticipant.getId())) {
        if(!WorksheetUtil.cleared(worksheet, byParticipant)) {
          results.add(new WorkloadItem(worksheet));
        }
      }
    }
    for(IssueWrapper iw : getResultSet()) {
      WorkloadItem wi = new WorkloadItem(iw);
      if(!results.inWorksheet(wi.getIssue().getId())) {
        results.add(wi);
      }
    }
    return results;
  }
  
  public Set<IssueWrapper> getResultSet() {
    Dao dao = new DossierPU();
    WhereClause wc = createCriteria();
    if(wc != null) {
      return new IssueSet(dao.getResultList(wc), false, byParticipant);
    } else {
      return Collections.EMPTY_SET;
    }
  }
  
  public Category getCategory() {
    return category;
  }
 
  public void setCategory(Category category) {
    this.category = category;
  }
 
  public Set<IssueResolution> getResolutions() {
    return resolutions;
  }
 
  public void setResolutions(Set<IssueResolution> resolutions) {
    this.resolutions = EnumSet.copyOf(resolutions);
  }
 
  public Set<IssueParticipantRole> getRoles() {
    return roles;
  }
 
  public void setRoles(Set<IssueParticipantRole> roles) {
    this.roles = EnumSet.copyOf(roles);
  }
 
  public Set<IssueStatus> getStatus() {
    return status;
  }
 
  public void setStatus(Set<IssueStatus> status) {
    this.status = EnumSet.copyOf(status);
  }
 
  public IContact getSubject() {
    return subject;
  }
 
  public void setSubject(IContact subject) {
    this.subject = subject;
  }
 
  public Set<IssueType> getTypes() {
    return types;
  }
 
  public void setTypes(Set<IssueType> types) {
    this.types = EnumSet.copyOf(types);
  }
 
  public void setType(IssueType type) {
    this.types = EnumSet.of(type);
  }
 
  public WhereClause createCriteria() {
    boolean canSeeAll = app != null && app.isInRole("issue:all");
 
    WhereClause wc = new WhereClause();
    wc.addClause("select distinct issue from Issue as issue");
    wc.addClause("left outer join issue.participants participant");
    wc.addClause("left outer join issue.sources source");
    if(!"*".equals(searchValue)) {
      wc.addClause("left outer join issue.comments comment");
    }
    wc.addClause("where 1=1");
    
    boolean asParticipant = 
            roles.contains(IssueParticipantRole.ISSUE_REPORTER) ||
            roles.contains(IssueParticipantRole.ISSUE_RESPONSIBLE) ||
            roles.contains(IssueParticipantRole.ISSUE_QA) ||
            roles.contains(IssueParticipantRole.ISSUE_ASSISTANT);
 
    if(Strings.isEmpty(searchValue) || (!asParticipant && !canSeeAll)) {
      return null;
    }
 
    if(byParticipant == null) {
      byParticipant = realParticipant;
    }
 
    long id = 0;
    
    try {
      if(searchValue.startsWith("#") && canSeeAll) {
        id = Long.valueOf(searchValue.substring(1));
        if(id > 0) {
          wc.addClause("and issue.id = :id");
          wc.addNamedValue("id", id);
          return wc;
        }
      }
      id = Long.valueOf(searchValue);
      if(id > 0) {
        wc.addClause("and ((issue.id = :id)");
        wc.addNamedValue("id", id);
        wc.setPrefix("or");
      }
    } catch(Exception ex) {}
 
    if(searchValue.startsWith("#") && searchValue.length() > 2 && canSeeAll) {
      wc.addLikeFields(new String[] {
                "issue.description",
                "comment.comment"
                }, searchValue.substring(1).replaceAll("\\*", "%"));
      return wc;
    }
    
    if(!"*".equals(searchValue)) {
      wc.addLikeFields(new String[] {
                "issue.description",
                "comment.comment"
                }, (searchValue == null ? "" : searchValue.replaceAll("\\*", "%")));
    }
 
    if(id > 0) {
      wc.addClause(")");
      wc.setPrefix(null);
    }
 
    if(asParticipant) {
      wc.addClause("and participant.idContact = :idContact");
      wc.addNamedValue("idContact", byParticipant.getId());
      if(!roles.containsAll(EnumSet.allOf(IssueParticipantRole.class))) {
        wc.addClause("and participant.role in (:roles)");
        wc.addNamedValue("roles", roles);
      }
    }
    
    if(!status.containsAll(EnumSet.allOf(IssueStatus.class))) {
      wc.addClause("and issue.status in (:status)");
      wc.addNamedValue("status", status);
    }
    
    if(!resolutions.containsAll(EnumSet.allOf(IssueResolution.class))) {
      wc.addClause("and issue.resolution in (:resolutions)");
      wc.addNamedValue("resolutions", resolutions);
    }
 
    if(!types.containsAll(EnumSet.allOf(IssueType.class))) {
      wc.addClause("and issue.type in (:types)");
      wc.addNamedValue("types", types);
    }
 
    if(subject != null) {
      wc.addClause("and exists ( select subject from Participant as subject");
      wc.addClause("where subject.dossier = issue.dossier");
      wc.addClause("and subject.idContact = :idSubject");
      wc.addNamedValue("idSubject", subject.getId());
      wc.addClause("and subject.role = :roleSubject )");
      wc.addNamedValue("roleSubject", ParticipantRole.PARTICIPANT_SUBJECT);
    }
 
    if(dossier != null) {
      wc.addClause("and issue.dossier = :dossier");
      wc.addNamedValue("dossier", dossier);
    } else if(dossierId != null && dossierId > 0) {
      wc.addClause("and issue.dossier.id = :dossierId");
      wc.addNamedValue("dossierId", dossierId);
    } else {
      wc.addClause("and issue.dossier.status = :dstatus");
      wc.addNamedValue("dstatus", DossierStatus.DOSSIER_OPENED);
    }
    
    if(category != null) {
      wc.addClause("and (");
      wc.addClause("issue.dossier.category.fullDescription = :fullCatDesc");
      wc.addClause("or issue.dossier.category.fullDescription like concat(:fullCatDesc, '" + Chars.backward().spaced() + "%')");
      wc.addNamedValue("fullCatDesc", category.getFullDescription());
      wc.addClause(")");
    }
    
    if(!realParticipant.getId().equals(byParticipant.getId()) && !canSeeAll) {
      wc.addClause("and (");
      // dossier
      wc.addClause("exists (");
      wc.addClause("select p from Participant as p");
      wc.addClause("where p.dossier = issue.dossier");
      wc.addClause("and p.idContact = :idObserver");
      wc.addClause("and p.showAllIssues = TRUE");
      wc.addClause(")");
      // categories
      wc.addClause("or exists (");
      wc.addClause("select cp from CategoryParticipant as cp");
      wc.addClause("where cp.idContact = :idObserver");
      wc.addClause("and cp.showAllIssues = TRUE");
      wc.addClause("and (");
      wc.addClause("cp.category.fullDescription = issue.dossier.category.fullDescription");
      wc.addClause("or issue.dossier.category.fullDescription like concat(cp.category.fullDescription, '" + Chars.backward().spaced() + "%')");
      wc.addClause("))");
      //
      wc.addClause(")");
      // parameter
      wc.addNamedValue("idObserver", realParticipant.getId());
    }
 
    return wc;
  }
 
  public Dossier getDossier() {
    return dossier;
  }
 
  public void setDossier(Dossier dossier) {
    this.dossier = dossier;
  }
 
  public Long getDossierId() {
    return dossierId;
  }
 
  public void setDossierId(Long dossierId) {
    this.dossierId = dossierId;
  }
 
  public String getSearchValue() {
    return searchValue;
  }
 
  public void setSearchValue(String searchValue) {
    this.searchValue = searchValue;
  }
 
  public IContact getByParticipant() {
    return byParticipant;
  }
 
  public void setByParticipant(IContact byParticipant) {
    this.byParticipant = byParticipant;
  }
 
  public void setByParticipantId(String id) {
    this.byParticipant = Contacts.getContactById(id);
  }
 
}