DossierWrapper.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.dossier;
 
import java.util.ArrayList;
import java.util.Date;
import java.util.EnumSet;
import java.util.List;
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.dw.DossierDWReport;
import org.turro.dossier.entity.DescriptorDefinition;
import org.turro.dossier.entity.DescriptorValue;
import org.turro.dossier.entity.Dossier;
import org.turro.dossier.entity.DossierType;
import org.turro.dossier.entity.IDossierParticipant;
import org.turro.dossier.entity.IssueParticipantRole;
import org.turro.dossier.entity.Participant;
import org.turro.dossier.entity.ParticipantRole;
import org.turro.dossier.entity.Project;
import org.turro.dossier.issue.IssueWrapper;
import org.turro.dossier.search.CategoryResults;
import org.turro.dossier.search.IssueResults;
import org.turro.elephant.context.Application;
import org.turro.elephant.db.WhereClause;
import org.turro.i18n.I_;
import org.turro.jpa.Dao;
import org.turro.jpa.entity.DaoEntity;
import org.turro.jpa.entity.EntityCollections;
import org.turro.jpa.entity.EntityWebUrls;
import org.turro.plugin.contacts.IContact;
import org.turro.related.RelatedItem;
import org.turro.related.Relateds;
import org.turro.util.CompareUtil;
import org.turro.util.PhraseBuilder;
 
public class DossierWrapper extends DaoEntity<Dossier, Long> {
 
  private IContact contact = Authentication.getIContact();
  private List<ParticipantRole> role;
  private List<IssueWrapper> issueAlarms;
  private String issueParticipant;
  private DossierDWReport report;
  
  public DossierWrapper(Dossier entity) {
    super(entity);
  }
 
  @Override
  protected Dao createDao() {
    return new DossierPU();
  }
 
  @Override
  public Dossier save() {
    RelatedItem rpi = entity.getRelated();
    if(entity.getCreation() == null) {
      entity.setCreation(new Date());
    }
    if(entity.getType() == null) {
      entity.setType(DossierType.TYPE_DOSSIER);
    }
    EntityCollections.entities(entity.getParticipants()).removeEmpties();
    for(Participant p : entity.getParticipants()) {
      p.setRole(p.getRole()); //ensure properties for owner
    }
    EntityCollections.entities(entity.getVersions()).removeEmpties();
    EntityCollections.entities(entity.getDescriptors()).removeEmpties();
    if(DossierType.TYPE_PROJECT.equals(entity.getType())) {
      Project project = entity.getProject();
      if(project == null) {
        project = new Project();
        project.setPhase(0);
        project.setProjectTitle(entity.getDescription());
        entity.setProject(project);
        project.setDossier(entity);
      }
      PhraseBuilder pb = new PhraseBuilder();
      pb.addWord(project.getProjectCode());
      pb.addPendingSeparator(" - ");
      pb.addWord(project.getProjectTitle());
      if(!pb.isBlank()) {
        entity.setDescription(pb.toString());
      }
    } else {
      entity.setProject(null);
    }
    entity = super.save();
    CategoryResults.normalizeUniquePaths(entity);
    if(!Strings.isBlank(rpi.getRelatedPath())) {
      Relateds.from(rpi.getRelatedPath()).addDestination(
              DossierPU.getObjectPath(entity), 
              rpi.getDescription());
    }
    if(entity.getId() != null) {
      String url = Strings.unpunctuateKeepPath(entity.getCategory().getPath()).toLowerCase() +
              "/" + entity.getId() + 
              "/" + Strings.unpunctuate(entity.getDescription()).toLowerCase();
      EntityWebUrls.addWebUrl("/dossier/" + entity.getId(), url);
    }
    return entity;
  }
  
  @Override
  public boolean delete() {
    EntityCollections.entities(entity.getParticipants()).removeEmpties();
    Relateds.empty().removeAny(DossierPU.getObjectPath(entity));
    return super.delete();
  }
  
  @Override
  protected boolean shouldLog() {
    return true;
  }
  
  public String getTabLabel() {
    return getSelfLabel() + " #" + (entity.getId() == null ? "" : entity.getId());
  }
  
  public String getSelfLabel() {
    if(DossierType.TYPE_PROJECT.equals(entity.getType())) {
      return I_.get("Project");
    } else {
      return I_.get("Dossier");
    }
  }
  
  public String getTooltiptext() {
    try {
      return entity.getFullDescription();
    } catch(Exception ex) {
      return null;
    }
  }
 
  public void setContact(IContact contact) {
    this.contact = contact;
  }
 
  public boolean isParticipant() {
    if(entity == null) return false;
    return getRole() != null && !getRole().isEmpty();
  }
  
  public boolean isOwner() {
    if(entity == null) return false;
    return getRole().contains(ParticipantRole.PARTICIPANT_OWNER);
  }
  
  public boolean isSubject() {
    if(entity == null) return false;
    return getRole().contains(ParticipantRole.PARTICIPANT_SUBJECT);
  }
  
  public boolean isAssistant() {
    if(entity == null) return false;
    return getRole().contains(ParticipantRole.PARTICIPANT_ASSISTANT);
  }
  
  public boolean getCanShowParticipants() {
    if(entity == null) return false;
    if(Application.getApplication().isInRole("dossier:participants")) {
      return true;
    } else if(isOwner()) {
      return true;
    } else if(isParticipant()) {
      for(IDossierParticipant p : getEntity().getFullParticipants()) {
        if(p.getIdContact().equals(contact.getId()) && p.isShowParticipants()) {
          return true;
        }
      }
    }
    return false;
  }
  
  public boolean getCanShowAllAttachments() {
    if(entity == null) return false;
    if(isOwner()) {
      return true;
    } else if(isParticipant()) {
      for(IDossierParticipant p : getEntity().getFullParticipants()) {
        if(p.getIdContact().equals(contact.getId()) && p.isShowAllAttachments()) {
          return true;
        }
      }
    }
    return false;
  }
  
  public boolean getCanShowAllIssues() {
    if(entity == null) return false;
    if(isOwner() || Application.getApplication().isInRole("issue:all")) {
      return true;
    } else if(isParticipant()) {
      for(IDossierParticipant p : getEntity().getFullParticipants()) {
        if(p.getIdContact().equals(contact.getId()) && p.isShowAllIssues()) {
          return true;
        }
      }
    }
    return false;
  }
 
  public boolean getReceiveAllEmails() {
    if(entity == null || !getCanShowAllIssues()) return false;
    if(isParticipant()) {
      for(IDossierParticipant p : getEntity().getFullParticipants()) {
        if(p.getIdContact().equals(contact.getId()) && p.isReceiveAllEmails()) {
          return true;
        }
      }
    }
    return false;
  }
 
  public String getIssueParticipantName() {
    IContact c = Contacts.getContactById(issueParticipant);
    if(c.isValid()) {
      return c.getName();
    }
    return null;
  }
  
  public String getIssueParticipant() {
    return issueParticipant;
  }
 
  public void setIssueParticipant(String issueParticipant) {
    this.issueParticipant = issueParticipant;
  }
 
  public List getIssueAlarms() {
    if(issueAlarms == null) createIssueAlarms();
    return issueAlarms;
  }
 
  public IssueResults getIssueSearch() {
    IssueResults ir = new IssueResults();
    
    ir.setDossierId(entity.getId());
    ir.setIssueValue("*");
    ir.markAll();
    if(issueParticipant != null) {
      ir.setByParticipantId(issueParticipant);
      ir.setRoles(EnumSet.of(IssueParticipantRole.ISSUE_RESPONSIBLE));
      ir.setCkOthers(false);
    }
    
    return ir;
  }
 
  public DossierDWReport getReport() {
    if(report == null) {
      report = new DossierDWReport();
      report.setReportValues(issueParticipant, IssueParticipantRole.ISSUE_RESPONSIBLE, entity.getId());
    }
    return report;
  }
  
  public List<DossierWrapper> getResponsibles() {
    Dao dao = new DossierPU();
    WhereClause wc = new WhereClause();
    wc.addClause("select distinct participant.idContact");
    wc.addClause("from IssueParticipant as participant");
    wc.addClause("where participant.issue.dossier = :dossier");
    wc.addClause("and participant.role = :role");
    wc.addClause("order by participant.name");
    wc.addNamedValue("dossier", entity);
    wc.addNamedValue("role", IssueParticipantRole.ISSUE_RESPONSIBLE);
    List<DossierWrapper> l = new ArrayList<>();
    for(String s : (List<String>) dao.getResultList(wc)) {
      DossierWrapper dw = new DossierWrapper(entity);
      dw.setIssueParticipant(s);
      l.add(dw);
    }
    return l;
  } 
  
  public long getIssueCount() {
    Dao dao = new DossierPU();
    WhereClause wc = new WhereClause();
    wc.addClause("select count(issue) from Issue as issue");
    wc.addClause("where dossier = :dossier");
    wc.addNamedValue("dossier", entity);
    return (Long) dao.getSingleResult(wc);
  } 
 
  public Date getIssueLastModification() {
    Dao dao = new DossierPU();
    WhereClause wc = new WhereClause();
    wc.addClause("select max(issue.modification)");
    wc.addClause("from Issue as issue");
    wc.addClause("where dossier = :dossier");
    wc.addNamedValue("dossier", entity);
    return (Date) dao.getSingleResult(wc);
  }
  
  private void createIssueAlarms() {
    issueAlarms = new ArrayList<>();
    for(IssueWrapper wissue : getIssueSearch().getIssueList()) {
      if(wissue.getIssue().getStatus().isFinished()) continue;
      if(wissue.hasAlarm()) {
        issueAlarms.add(wissue);
      }
    }
  }
 
  private List<ParticipantRole> getRole() {
    if(role == null && getEntity() != null) {
      role = new ArrayList<>();
      for(IDossierParticipant p : getEntity().getFullParticipants()) {
        if(p.getIdContact() != null && p.getIdContact().equals(contact.getId())) {
          role.add(p.getRole());
        }
      }
    }
    return role;
  }
 
  public boolean isEmptyDescriptors(String grouping, boolean required) {
    for(DescriptorDefinition dd : entity.getDescriptorSet()) {
      if("all".equals(grouping) || CompareUtil.compare(grouping, dd.getGrouping()) == 0) {
        DescriptorValue dv = dd.getValue();
        if(required && dd.isRequired() && (dv == null || dv.isEmpty())) {
          return true;
        }
      }
    }
    return false;
  }
 
}