DossierEntities.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2017 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.entitites;
 
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.turro.string.Strings;
import org.turro.action.IEntityCtrl;
import org.turro.annotation.ElephantEntity;
import org.turro.attach.entity.Attachment;
import org.turro.attach.www.AttachCtrl;
import org.turro.collections.KeyValueMap;
import org.turro.command.LabelControl;
import org.turro.contacts.VoteIt;
import org.turro.dossier.db.DossierPU;
import org.turro.dossier.entity.Category;
import org.turro.dossier.entity.Dossier;
import org.turro.dossier.entity.DossierType;
import org.turro.dossier.entity.DossierVersion;
import org.turro.dossier.entity.Issue;
import org.turro.dossier.entity.IssueComment;
import org.turro.dossier.entity.IssueParticipant;
import org.turro.dossier.entity.Participant;
import org.turro.dossier.entity.Project;
import org.turro.dossier.entity.ProjectGrant;
import org.turro.dossier.zul.menu.DossierMenu;
import org.turro.elephant.db.WhereClause;
import org.turro.entities.DefaultElephantEntity;
import org.turro.entities.Entities;
import org.turro.entities.EntityListAdapter;
import org.turro.entities.EntityRole;
import org.turro.entities.IElephantEntity;
import org.turro.file.util.FileAttach;
import org.turro.i18n.I_;
import org.turro.jpa.Dao;
import org.turro.path.Path;
import org.turro.plugin.contacts.ContactList;
import org.turro.plugin.contacts.IContact;
import org.turro.polls.PollsCtrl;
import org.turro.script.Script;
import org.turro.security.ConceptPermission;
import org.turro.util.Chars;
import org.turro.www.commentit.CommentItCtrl;
import org.turro.www.describeit.DescribeItCtrl;
import org.turro.www.starit.StarItCtrl;
import org.turro.www.voteit.VoteItCtrl;
 
@ElephantEntity
public class DossierEntities extends DefaultElephantEntity {
 
  public DossierEntities() {
  }
 
  public DossierEntities(String entityPath) {
    super(entityPath);
  }
 
  public DossierEntities(Object entity) {
    super(entity);
  }
 
  @Override
  public Object getEntity() {
    if(entity == null) {
      if(getPath() != null) {
        if(isValidLongEntity()) {
          if(null != path.getRoot()) switch (path.getRoot()) {
            case "dossier":
              entity = getDao().find(Dossier.class, path.getNodeAs(1, Long.class));
              break;
            case "issue":
              entity = getDao().find(Issue.class, path.getNodeAs(1, Long.class));
              break;
            case "dossier-category":
              entity = getDao().find(Category.class, path.getNodeAs(1, Long.class));
              break;
            case "project-grant":
              entity = getDao().find(ProjectGrant.class, path.getNodeAs(1, Long.class));
              break;
            default:
              break;
          }
        }
      }
    }
    return entity;
  }
 
  @Override
  public String getName() {
    if(getEntity() != null) {
      if(entity instanceof Dossier) {
        return ((Dossier) entity).getId() + Chars.forward().spaced().toString() + ((Dossier) entity).getDescription() + 
                    " [" + I_.byKey(((Dossier) entity).getStatus().toString()) + "]";
      } else if(entity instanceof Issue) {
        DossierVersion dv = ((Issue) entity).getVersion();
        return ((Issue) entity).getId() + Chars.forward().spaced().toString() + ((Issue) entity).getDescription() + 
                    (dv == null ? "" : (" " + dv.getVersionString())) +
                    " [" + I_.byKey(((Issue) entity).getType().toString()) + 
                    ", " + I_.byKey(((Issue) entity).getStatus().toString()) + "]";
      } else if(entity instanceof Category) {
        return ((Category) entity).getFullDescription();
      } else if(entity instanceof ProjectGrant) {
        return ((ProjectGrant) entity).getName();
      }
    }
    return null;
  }
 
  @Override
  public String getLabel() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "dossier":
          return I_.get("Dossier");
        case "issue":
          return I_.get("Issue");
        case "dossier-category":
          return I_.get("Category");
        case "project-grant":
          return I_.get("Project grant");
        case "myissues":
          return I_.get("My issues");
        case "mydossiers":
          return I_.get("My dossiers");
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getDescription() {
    if(getEntity() != null) {
      if(entity instanceof Dossier) {
        return ((Dossier) entity).getLabeledPublishableDescription();
      } else if(entity instanceof Issue) {
        return ((Issue) entity).getDossier().getFullDescription(false);
      } else if(entity instanceof ProjectGrant) {
        return ((ProjectGrant) entity).getDescription();
      }
    }
    return null;
  }
 
  @Override
  public Object getLabelCtrl() {
    if(getEntity() != null) {
      return new LabelControl(getEntity());
    }
    return null;
  }
 
  @Override
  public String getImage() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "dossier":
          return "/_zul/images/dossier.png";
        case "issue":
          return "/_zul/images/issue.png";
        case "dossier-category":
          return "/_zul/images/group.png";
        case "project-grant":
          return "/_zul/images/handshelp.png";
        case "myissues":
          return "/_zul/images/issue.png";
        case "mydossiers":
          return "/_zul/images/dossier.png";
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getHierarchicalPath() {
    if(getEntity() != null) {
      if(entity instanceof Issue) {
        Dossier dossier = ((Issue) entity).getDossier();
        return DossierPU.getObjectPath(dossier.getCategory()) +
                PATH_SEPARATOR + DossierPU.getObjectPath(dossier) +
                PATH_SEPARATOR + getPath();
      } else if(entity instanceof Dossier) {
        Dossier dossier = ((Dossier) entity);
        return DossierPU.getObjectPath(dossier.getCategory()) +
                PATH_SEPARATOR + getPath();
      }
    }
    return getPath();
  }
 
  @Override
  public IElephantEntity getParent() {
    if(getEntity() != null) {
      if(entity instanceof Issue) {
        return Entities.getController(((Issue) entity).getDossier());
      } else if(entity instanceof Dossier) {
        return Entities.getController(((Dossier) entity).getCategory());
      }
    }
    return null;
  }
 
  @Override
  public List<IElephantEntity> getChildren() {
    if(getEntity() != null) {
      if(entity instanceof Category) {
        EntityListAdapter ela = new EntityListAdapter(((Category) entity).getChildren());
        ela.addAll(((Category) entity).getDossiers());
        return ela;
      } else if(entity instanceof Dossier) {
        return new EntityListAdapter(((Dossier) entity).getAllIssues());
      }
    }
    return Collections.EMPTY_LIST;
  }
 
  @Override
  public String getExtendedPath() {
    return DossierPU.getObjectExtendedPath(getEntity());
  }
 
  @Override
  public File getFile() {
    return null;
  }
 
  @Override
  public boolean showPath() {
    if(getPath() != null) {
      String root = path.getRoot();
      if("myissues".equals(root)) {
        DossierMenu.showMyIssues();
        return true;
      } else if("mydossiers".equals(root)) {
        DossierMenu.showMyDossiers();
        return true;
      }
    }
    return false;
  }
 
  @Override
  public boolean showEntity() {
    if(getEntity() != null) {
      if(entity instanceof Dossier) {
        DossierMenu.showDossier(((Dossier) entity).getId());
        return true;
      } else if(entity instanceof Issue) {
        DossierMenu.showIssue(((Issue) entity).getId());
        return true;
      } else if(entity instanceof ProjectGrant) {
        DossierMenu.showProjectGrant(((ProjectGrant) entity).getId());
        return true;
      }
    }
    return false;
  }
 
  @Override
  public boolean canEdit(IContact contact) {
    if(getEntity() != null) {
      if(entity instanceof Dossier) {
        return contact.getPermissions().isInRole("dossier:edit") ||
                ((Dossier) entity).getFullParticipants().isParticipant(contact);
      } else if(entity instanceof Issue) {
        return contact.getPermissions().isInRole("issue:edit") ||
                ((Issue) entity).getFullParticipants().isParticipant(contact);
      } else if(entity instanceof ProjectGrant) {
        return contact.getPermissions().isInRole("dossier:edit");
      }
    }
    return false;
  }
 
  @Override
  public boolean canPublish(IContact contact) {
    if(getEntity() != null) {
      if(entity instanceof Dossier) {
        return ((Dossier) entity).getFullParticipants().isParticipant(contact);
      } else if(entity instanceof Issue) {
        return ((Issue) entity).getFullParticipants().canShowIssue(contact);
      } else if(entity instanceof Category) {
        return ((Category) entity).getFullParticipants().isParticipant(contact);
      }
    }
    return false;
  }
 
  @Override
  public Collection getEntitites(String search, int maxResults, KeyValueMap kvm) {
    ArrayList<Object> list = new ArrayList<>();
    list.addAll(searchCategories(search, maxResults, kvm));
    list.addAll(searchDossiers(search, maxResults, kvm));
    list.addAll(searchIssues(search, maxResults, kvm));
    return list;
  }
 
  @Override
  public Collection getEntitites(String root, String search, int maxResults, KeyValueMap kvm) {
    ArrayList<Object> list = new ArrayList<>();
    if(null != root) switch (root) {
      case "dossier":
        list.addAll(searchDossiers(search, maxResults, kvm));
        break;
      case "issue":
        list.addAll(searchIssues(search, maxResults, kvm));
        break;  
      case "dossier-category":
        list.addAll(searchCategories(search, maxResults, kvm));
        break;
      default:
        break;
    }
    return list;
  }
 
  @Override
  public Object configureCtrl(Object ctrl, IContact contact) {
    if(ctrl instanceof VoteItCtrl) {
      VoteItCtrl ictrl = (VoteItCtrl) ctrl;
      if(getEntity() instanceof Issue) {
        Issue e = (Issue) getEntity();
        if(e.getDossier().getType().isVotes()) {
          ictrl.setEntityPath(getPath());
          ictrl.setForbiden(e.getStatus().isFinished());
          if(e.getDossier().getType().isSecret()) {
            ictrl.setForbid(true);
            ictrl.setAllowed((ContactList) e.getDossier().getFullParticipants().getVoteIParticipants());
          }
          return ictrl;
        }
      } else if(getEntity() instanceof Dossier) {
        Dossier e = (Dossier) getEntity();
        if(e.getType().isVotes()) {
          ictrl.setEntityPath(getPath());
          ictrl.setForbiden(!e.getStatus().isOpen());
          if(e.getType().isSecret()) {
            ictrl.setForbid(true);
            ictrl.setAllowed((ContactList) e.getFullParticipants().getVoteIParticipants());
          }
          return ictrl;
        }
      }
    } else if(ctrl instanceof StarItCtrl) {
      StarItCtrl ictrl = (StarItCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    } else if(ctrl instanceof CommentItCtrl) {
      CommentItCtrl ictrl = (CommentItCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    } else if(ctrl instanceof AttachCtrl) {
      AttachCtrl ictrl = (AttachCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      if(getEntity() instanceof Issue) {
        Issue e = (Issue) getEntity();
        ictrl.setPublicOnly(true);
        if(e.getFullParticipants().canShowAllAttachments(contact)) {
          ictrl.setPublicOnly(false);
        }
        return ictrl;
      } else if(getEntity() instanceof Dossier) {
        Dossier e = (Dossier) getEntity();
        ictrl.setPublicOnly(true);
        ictrl.addRestrictedFolders(e.getFullParticipants().getParticipationStrings(contact));
        return ictrl;
      } else if(getEntity() instanceof Category) {
        Category c = (Category) getEntity();
        ictrl.setPublicOnly(true);
        ictrl.addRestrictedFolders(c.getFullParticipants().getParticipationStrings(contact));
        return ictrl;
      }
    } else if(ctrl instanceof FileAttach) {
      FileAttach ictrl = (FileAttach) ctrl;
      return ictrl;
    } else if(ctrl instanceof DescribeItCtrl) {
      DescribeItCtrl ictrl = (DescribeItCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    } else if(ctrl instanceof PollsCtrl) {
      PollsCtrl ictrl = (PollsCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    } else if(ctrl instanceof IEntityCtrl) {
      IEntityCtrl ictrl = (IEntityCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    }
    return ctrl;
  }
 
  @Override
  public boolean canShowInContext(IContact contact, Object relatedEntity) {
    if(relatedEntity instanceof VoteIt) {
      VoteIt irelated = (VoteIt) relatedEntity;
      if(getEntity() instanceof Issue) {
        Issue e = (Issue) getEntity();
        return e.getDossier().getType().isVotes();
      } else if(getEntity() instanceof Dossier) {
        Dossier e = (Dossier) getEntity();
        return e.getType().isVotes();
      }
    } else if(relatedEntity instanceof Attachment) {
      Attachment irelated = (Attachment) relatedEntity;
      IElephantEntity iee = Entities.getController(irelated);
      if(getEntity() instanceof Issue) {
        Issue e = (Issue) getEntity();
        return iee.canPublish(contact) || e.getFullParticipants().canShowAllAttachments(contact);
      } else if(getEntity() instanceof Dossier) {
        Dossier e = (Dossier) getEntity();
        boolean canPublish = iee.canPublish(contact);
        if(contact.isValid()) {
          return canPublish && e.getFullParticipants().canShowAllAttachments(contact) && 
                  irelated.canShowTo(contact, e.getFullParticipants().getParticipationStrings(contact));
        }
      } else if(getEntity() instanceof Category) {
        Category e = (Category) getEntity();
        boolean canPublish = iee.canPublish(contact);
        if(contact.isValid()) {
          return canPublish && e.getFullParticipants().canShowAllAttachments(contact) && 
                  irelated.canShowTo(contact, e.getFullParticipants().getParticipationStrings(contact));
        }
      }
    }
    return true;
  }
 
  @Override
  public boolean hasRelatedRole(EntityRole role, IContact contact) {
    switch(role) {
      case CHALLENGER:
        if(getEntity() instanceof Dossier) {
          Dossier dossier = (Dossier) getEntity();
          return dossier.isBranchAdmin(contact) ||
                 dossier.getFullParticipants().isDriver(contact) ||
                 dossier.getFullParticipants().isBeneficiary(contact) ||
                 dossier.getFullParticipants().isOfferer(contact);
        }
        break;
      case DOCUMENTATION:
        if(getEntity() instanceof Dossier) {
          Dossier dossier = (Dossier) getEntity();
          return dossier.getFullParticipants().isSupport(contact);
        }
        break;
    }
    return super.hasRelatedRole(role, contact);
  }
 
  @Override
  public String getExtendedWebPath() {
    if(getEntity() != null) {
      if(entity instanceof Dossier) {
        Dossier dossier = (Dossier) entity;
        return Strings.unpunctuateKeepPath(dossier.getCategory().getPath()).toLowerCase() +
                "/" + dossier.getId() + 
                "/" + Strings.unpunctuate(dossier.getDescription()).toLowerCase();
      } else if(entity instanceof Issue) {
        Issue issue = (Issue) entity;
        return "/" + issue.getId() + 
                "/" + Strings.unpunctuate(issue.getDescription()).toLowerCase();
      }
    }
    return null;
  }
 
  @Override
  public String getLinkRoot() {
    getPath();
    String root = path.getRoot();
    if("dossier".equals(root)) {
      if(getEntity() instanceof Dossier) {
        Dossier dossier = (Dossier) entity;
        if(DossierType.TYPE_PROJECT.equals(dossier.getType())) {
          return "project";
        } else {
          return "dossier";
        }
      }
    }
    return super.getLinkRoot();
  }
 
  @Override
  public String getUserContext() {
    getPath();
    if(path.getRoot().equals("project-grant")) {
      return "/user/projectgrants";
    } else {
      return "/user/my" + getLinkRoot() + "s";
    }
  }
 
  @Override
  protected Dao createDao() {
    return new DossierPU();
  }
 
  @Override
  protected boolean itsMine(String rootPath) {
    return super.itsMine(rootPath) ||
           "myissues".equals(rootPath) || "mydossiers".equals(rootPath);
  }
 
  @Override
  protected boolean itsMine(Object entity) {
    return (entity instanceof Dossier) || (entity instanceof Issue) || 
           (entity instanceof Category) || (entity instanceof ProjectGrant);
  }
 
  @Override
  public Collection<String> getAllowedRoots() {
    return Arrays.asList("dossier", "issue", "dossier-category", "project-grant");
  }
 
  @Override
  protected IElephantEntity createInstance(String entityPath) {
    return new DossierEntities(entityPath);
  }
 
  @Override
  protected IElephantEntity createInstance(Object entity) {
    return new DossierEntities(entity);
  }
 
  @Override
  protected Path createPath() {
    return new Path(DossierPU.getObjectPath(entity));
  }
 
  @Override
  public Script getActorScript() {
    Script script = super.getActorScript();
    if(getEntity() != null) {
      if(entity instanceof Category) {
        script.addVariable("category", entity);
        script.addVariable("dpl", ((Category) entity).getFullParticipants());
      } else if(entity instanceof Dossier) {
        script.addVariable("dossier", entity);
        script.addVariable("dpl", ((Dossier) entity).getFullParticipants());
      } else if(entity instanceof Issue) {
        script.addVariable("issue", entity);
        script.addVariable("dpl", ((Issue) entity).getFullParticipants());
      }
    }
    return script;
  }
  
  @Override
  public ConceptPermission getConceptPermission(String name) {
    if(getEntity() != null) {
      if(entity instanceof Dossier) {
        Dossier dossier = (Dossier) entity;
        if(dossier.getProject() != null) {
          return dossier.getProject().getPhaseDefinition().getPermission(name, this);
        }          
      }
    }
    return super.getConceptPermission(name);
  }
 
  @Override
  public Object getObject(Path entityPath) {
    if("issue-comment".equals(entityPath.getRoot())) {
      return getDao().find(IssueComment.class, entityPath.getNodeAs(1, Long.class));
    } else if("issue-participant".equals(entityPath.getRoot())) {
      return getDao().find(IssueParticipant.class, entityPath.getNodeAs(1, Long.class));
    } else if("dossier-participant".equals(entityPath.getRoot())) {
      return getDao().find(Participant.class, entityPath.getNodeAs(1, Long.class));
    } else if("project".equals(entityPath.getRoot())) {
      return getDao().find(Project.class, entityPath.getNodeAs(1, Long.class));
    }
    return null;
  }
 
  @Override
  public IElephantEntity getMain(Object entity) {
    if(entity instanceof IssueComment) {
      return getController(((IssueComment) entity).getIssue());
    } else if(entity instanceof Project) {
      return getController(((Project) entity).getDossier());
    } else if(entity instanceof Participant) {
      return getController(((Participant) entity).getDossier());
    } else if(entity instanceof IssueParticipant) {
      return getController(((IssueParticipant) entity).getIssue());
    } else if(entity instanceof Issue) {
      return getController(((Issue) entity).getDossier());
    }
    return null;
  }
 
  private List<Object> searchCategories(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from Category c");
    wc.addClause("where c.fullDescription like :search");
    wc.addNamedValue("search", "%" + search + "%");
    if(kvm != null) { 
      if(kvm.containsKey("dossier-categories")) {
        String sep = "";
        wc.addClause("and (");
        for(String cat : convertToCategories(kvm.get(String.class, "dossier-categories"), true)) {
          String parName = cat.replaceAll("\\/", "p");
          wc.addClause(sep + " c.uniquePath like :" + parName);
          wc.addNamedValue(parName, "%" + cat + "%");
          sep = "or";
        }
        for(String cat : convertToCategories(kvm.get(String.class, "dossier-categories"), false)) {
          String parName = cat.replaceAll("\\/", "e");
          wc.addClause(sep + " c.uniquePath like :" + parName);
          wc.addNamedValue(parName, "%" + cat);
          sep = "or";
        }
        wc.addClause(")");
      }
    }
    wc.addClause("order by c.fullDescription");
    return getDao().getResultList(wc, maxResults);
  }
 
  private List<Object> searchDossiers(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select d from Dossier d");
    wc.addClause("where d.description like :search");
    wc.addNamedValue("search", "%" + search + "%");
    if(kvm != null) { 
      if(kvm.containsKey("dossier-categories")) {
        String sep = "";
        wc.addClause("and (");
        for(String cat : convertToCategories(kvm.get(String.class, "dossier-categories"), true)) {
          String parName = cat.replaceAll("\\/", "p");
          wc.addClause(sep + " d.uniquePath like :" + parName);
          wc.addNamedValue(parName, "%" + cat + "%");
          sep = "or";
        }
        wc.addClause(")");
      }
      if(kvm.get(Boolean.class, "only-projects", Boolean.FALSE)) {
        wc.addClause("and d.project is not null");
      }
    }
    wc.addClause("order by d.description");
    return getDao().getResultList(wc, maxResults);
  }
 
  private List<Object> searchIssues(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select i from Issue i");
    wc.addClause("where i.description like :search");
    wc.addClause("order by i.description");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
  private List<String> convertToCategories(String categoryIds, boolean addSlash) {
    String cids[] = categoryIds.split("\\s*,\\s*");
    ArrayList<String> cats = new ArrayList<>();
    for(String id : cids) {
      cats.add("/c" + id + (addSlash ? "/" : ""));
    }
    return cats;
  }
 
}