ContactEntities.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.entities;
 
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.List;
import org.turro.string.Strings;
import org.turro.action.IElephantSendable;
import org.turro.annotation.ElephantEntity;
import org.turro.collections.KeyValueMap;
import org.turro.contacts.CommentIt;
import org.turro.contacts.Contact;
import org.turro.contacts.ContactService;
import org.turro.contacts.ContactType;
import org.turro.contacts.Convocation;
import org.turro.contacts.GroupIt;
import org.turro.contacts.StarIt;
import org.turro.contacts.VoteIt;
import org.turro.contacts.db.ContactsPU;
import org.turro.contacts.relation.FuzzyRelationTypes;
import org.turro.contacts.service.ServiceSendable;
import org.turro.contacts.zul.label.ContactInfo;
import org.turro.contacts.zul.menu.ContactMenu;
import org.turro.elephant.db.WhereClause;
import static org.turro.entities.EntityRole.CHALLENGER;
import static org.turro.entities.EntityRole.DOCUMENTATION;
import org.turro.i18n.I_;
import org.turro.jpa.Dao;
import org.turro.path.Path;
import org.turro.plugin.contacts.IContact;
import org.turro.security.Permissions;
import org.turro.zul.convocation.ConvocationSendable;
 
@ElephantEntity
public class ContactEntities extends DefaultElephantEntity {
 
  public ContactEntities() {
  }
 
  public ContactEntities(String entityPath) {
    super(entityPath);
  }
 
  public ContactEntities(Object entity) {
    super(entity);
  }
 
  @Override
  public Object getEntity() {
    if(entity == null) {
      if(getPath() != null) {
        if(path.getSize() == 2) {
          if(null != path.getRoot()) switch (path.getRoot()) {
            case "contact":
              entity = getDao().find(Contact.class, path.getNode(1));
              break;
            case "convocation":
              entity = getDao().find(Convocation.class, path.getNode(1));
              break;
            case "groupit":
              entity = getDao().find(GroupIt.class, path.getNode(1));
              break;
            case "service":
              entity = getDao().find(ContactService.class, path.getNode(1));
              break;
            default:
              break;
          }
        }
      }
    }
    return entity;
  }
 
  @Override
  public String getName() {
    if(getEntity() != null) {
      if(entity instanceof Contact) {
        return ((Contact) entity).getFullName();
      } else if(entity instanceof Convocation) {
        return ((Convocation) entity).getName();
      } else if(entity instanceof GroupIt) {
        return ((GroupIt) entity).getName();
      } else if(entity instanceof ContactService) {
        return ((ContactService) entity).getTitle();
      }
    }
    return null;
  }
 
  @Override
  public String getLabel() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "contact":
          return I_.get("Contact");
        case "groupit":
          return I_.get("Group");
        case "convocation":
          return I_.get("Convocation");
        case "service":
          return I_.get("Service");
        case "log":
          if(path.getSize() > 1) switch(path.getNode(1)) {
            case "in":
              return I_.get("Login");
            case "out":
              return I_.get("Logout");
            case "failed":
              return I_.get("Login failed");
            case "profile":
              return I_.get("Profile");
            case "webadmin":
              return I_.get("Web site administration");
            case "impersonate":
              return I_.get("Impersonate");
            case "backtoself":
              return I_.get("Back to self");
          }
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getDescription() {
    if(getEntity() != null) {
      if(entity instanceof Contact) {
        return ((Contact) entity).getGrouping();
      } else if(entity instanceof ContactService) {
        return ((ContactService) entity).getText();
      }
    }
    return null;
  }
 
  @Override
  public Object getLabelCtrl() {
    if(getEntity() != null) {
      if(entity instanceof Contact) {
        return new ContactInfo((Contact) entity);
      }
    }
    return null;
  }
 
  @Override
  public String getImage() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "contact":
          return "/_zul/images/contact.png";
        case "convocation":
          return "/_zul/images/contacts.png";
        case "groupit":
          return "/_zul/images/group.png";
        case "service":
          return "/_zul/images/service.png";
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getHierarchicalPath() {
    if(getEntity() != null) {
      if(entity instanceof VoteIt) {
        IElephantEntity iee = ((VoteIt) entity).getOwnerEntity();
        String hp = iee.getHierarchicalPath();
        return (Strings.isBlank(hp) ? "" : hp + PATH_SEPARATOR) + getPath();
      } else if(entity instanceof StarIt) {
        IElephantEntity iee = ((StarIt) entity).getOwnerEntity();
        String hp = iee.getHierarchicalPath();
        return (Strings.isBlank(hp) ? "" : hp + PATH_SEPARATOR) + getPath();
      } else if(entity instanceof CommentIt) {
        IElephantEntity iee = ((CommentIt) entity).getOwnerEntity();
        String hp = iee.getHierarchicalPath();
        return (Strings.isBlank(hp) ? "" : hp + PATH_SEPARATOR) + getPath();
      }
    }
    return getPath();
  }
 
  @Override
  public IElephantEntity getParent() {
    if(getEntity() != null) {
      if(entity instanceof Contact) {
        return Entities.getController(((Contact) entity).getBusiness());
      } else if(entity instanceof ContactService) {
        return Entities.getController(((ContactService) entity).getContact());
      }
    }
    return null;
  }
 
  @Override
  public List<IElephantEntity> getChildren() {
    if(getEntity() != null) {
      if(entity instanceof Contact) {
        return new EntityListAdapter(((Contact) entity).getWorkers());
      }
    }
    return Collections.EMPTY_LIST;
  }
 
  @Override
  public String getExtendedPath() {
    return "";
  }
 
  @Override
  public File getFile() {
    return null;
  }
 
  @Override
  public boolean showPath() {
    return false;
  }
 
  @Override
  public boolean showEntity() {
    if(getEntity() != null) {
      if(entity instanceof Contact) {
        ContactMenu.showContact(((Contact) entity).getId());
        return true;
      } else if(entity instanceof Convocation) {
        ContactMenu.showConvocation(((Convocation) entity).getId());
        return true;
      } else if(entity instanceof ContactService) {
        ContactMenu.showService(((ContactService) entity).getId());
        return true;
      }
    }
    return false;
  }
 
  @Override
  public boolean canEdit(IContact contact) {
    if(getEntity() != null) {
      if(contact.getSyndications().contains("contacts_admin")) {
        return true;
      } else if(entity instanceof Contact) {
        return contact.getPermissions().isInRole("contact:edit");
      } else if(entity instanceof Convocation) {
        return contact.getPermissions().isInRole("convocation:edit");
      } else if(entity instanceof ContactService) {
        return ((ContactService) entity).getContact().isInBusiness(contact);
      }
    }
    return false;
  }
 
  @Override
  public boolean canPublish(IContact contact) {
    if(getEntity() != null) {
      if(contact.getSyndications().contains("contacts_admin")) {
        return true;
      } else if(entity instanceof Contact) {
        Contact con = (Contact) getEntity();
        return !con.getSyndications().isEmpty();
      } else if(entity instanceof Convocation) {
        Convocation con = (Convocation) getEntity();
        return con.isAssistant(contact);
      }
    }
    return false;
  }
 
  @Override
  public Collection getEntitites(String search, int maxResults, KeyValueMap kvm) {
    ArrayList<Object> list = new ArrayList<>();
    list.addAll(searchContacts(search, maxResults, kvm));
    list.addAll(searchConvocations(search, maxResults, kvm));
    list.addAll(searchGroups(search, maxResults, kvm));
    list.addAll(searchServices(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 "contact":
        list.addAll(searchContacts(search, maxResults, kvm));
        break;
      case "convocation":
        list.addAll(searchConvocations(search, maxResults, kvm));
        break;  
      case "groupit":
        list.addAll(searchGroups(search, maxResults, kvm));
        break;
      case "service":
        list.addAll(searchServices(search, maxResults, kvm));
        break;
      default:
        break;
    }
    return list;
  }
 
  @Override
  public IElephantSendable getSendable() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "convocation":
          return new ConvocationSendable(getPath());
        case "service":
          return new ServiceSendable(getPath());
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public Object configureCtrl(Object ctrl, IContact contact) {
    return ctrl;
  }
 
  @Override
  public boolean canShowInContext(IContact contact, Object relatedEntity) {
    return true;
  }
 
  @Override
  public String getExtendedWebPath() {
    return null;
  }
 
  @Override
  public String getUserContext() {
    return "/user/" + getLinkRoot() + "s";
  }
 
  @Override
  protected Dao createDao() {
    return new ContactsPU();
  }
 
  @Override
  protected boolean itsMine(String rootPath) {
    return super.itsMine(rootPath) || "log".equals(rootPath);
  }
 
  @Override
  protected boolean itsMine(Object entity) {
    return (entity instanceof Contact) || (entity instanceof Convocation) || 
           (entity instanceof GroupIt) || (entity instanceof ContactService);
  }
 
  @Override
  public Collection<String> getAllowedRoots() {
    return Arrays.asList("contact", "convocation", "groupit", "service");
  }
 
  @Override
  protected IElephantEntity createInstance(String entityPath) {
    return new ContactEntities(entityPath);
  }
 
  @Override
  protected IElephantEntity createInstance(Object entity) {
    return new ContactEntities(entity);
  }
 
  @Override
  protected Path createPath() {
    return new Path(ContactsPU.getObjectPath(entity));
  }
 
  @Override
  public Object getObject(Path entityPath) {
    if("comment-it".equals(entityPath.getRoot())) {
      return getDao().find(CommentIt.class, entityPath.getNode(1));
    } else if("star-it".equals(entityPath.getRoot())) {
      return getDao().find(StarIt.class, entityPath.getNode(1));
    } else if("vote-it".equals(entityPath.getRoot())) {
      return getDao().find(VoteIt.class, entityPath.getNode(1));
    }
    return null;
  }
 
  @Override
  public IElephantEntity getMain(Object entity) {
    if(entity instanceof CommentIt) {
      return ((CommentIt) entity).getOwnerEntity();
    } else if(entity instanceof StarIt) {
      return ((StarIt) entity).getOwnerEntity();
    } else if(entity instanceof VoteIt) {
      return ((VoteIt) entity).getOwnerEntity();
    }
    return null;
  }
 
  private List<Object> searchContacts(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from Contact c");
    wc.addClause("where (c.name like :search");
    
    // Trade and fiscal names
    wc.addClause("or exists (");
    wc.addClause("select cn from Connector as cn");
    wc.addClause("where (cn.description = 'TradeName' or cn.description = 'FiscalName')");
    wc.addClause("and cn.value like :search");
    wc.addClause("and cn.contact = c");
    wc.addClause("))");
 
    if(kvm != null) { 
      if(kvm.containsKey("role")) {
        List<String> syndicationNames = List.copyOf(Permissions.getSecurityGroupIdsBy(kvm.get("role")));
        if(syndicationNames != null && !syndicationNames.isEmpty()) {
          wc.addClause("and exists (");
          wc.addClause("select syndication from Syndication as syndication");
          wc.addClause("where syndication.name in (:syndicationNames)");
          wc.addNamedValue("syndicationNames", syndicationNames);
          wc.addClause("and syndication.contact = c");
          wc.addClause(")");
        }
      }
      if(kvm.containsKey("syndication")) {
        wc.addClause("and exists (");
        wc.addClause("select syndication from Syndication as syndication");
        wc.addClause("where syndication.name in (:syndicationNames)");
        wc.addNamedValue("syndicationNames", kvm.get("syndication"));
        wc.addClause("and syndication.contact = c");
        wc.addClause(")");
      }
      if(kvm.containsKey("type")) {
        if(ContactType.getStudent().equals(kvm.get("type"))) {
          wc.addClause("and type = :type");
          wc.addNamedValue("type", ContactType.CONTACT_USER);
          wc.addClause("and exists (");
          wc.addClause("select relation from BusinessRelation as relation");
          FuzzyRelationTypes.isStudent(wc, "where", "relation");
          wc.addInRange("and", "relation.startDate", "relation.endDate", "rdate", new Date());
          wc.addClause("and relation.contact = c");
          wc.addClause(")");
        } else if(ContactType.getWorker().equals(kvm.get("type"))) {
          wc.addClause("and type = :type");
          wc.addNamedValue("type", ContactType.CONTACT_USER);
          wc.addClause("and exists (");
          wc.addClause("select relation from BusinessRelation as relation");
          FuzzyRelationTypes.isWorker(wc, "where", "relation");
          wc.addInRange("and", "relation.startDate", "relation.endDate", "rdate", new Date());
          wc.addClause("and relation.contact = c");
          wc.addClause(")");
        } else if(ContactType.getProfessional().equals(kvm.get("type"))) {
          wc.addClause("and type = :type");
          wc.addNamedValue("type", ContactType.CONTACT_USER);
          wc.addClause("and exists (");
          wc.addClause("select relation from BusinessRelation as relation");
          FuzzyRelationTypes.isProfessional(wc, "where", "relation");
          wc.addInRange("and", "relation.startDate", "relation.endDate", "rdate", new Date());
          wc.addClause("and relation.contact = c");
          wc.addClause(")");
        } else if(ContactType.getEducator().equals(kvm.get("type"))) {
          wc.addClause("and type = :type");
          wc.addNamedValue("type", ContactType.CONTACT_USER);
          wc.addClause("and exists (");
          wc.addClause("select relation from BusinessRelation as relation");
          FuzzyRelationTypes.isEducator(wc, "where", "relation");
          wc.addInRange("and", "relation.startDate", "relation.endDate", "rdate", new Date());
          wc.addClause("and relation.contact = c");
          wc.addClause(")");
        } else if(ContactType.getJuridical().equals(kvm.get("type"))) {
          wc.addClause("and (type = :type1 or type = :type2)");
          wc.addNamedValue("type1", ContactType.CONTACT_COMPANY);
          wc.addNamedValue("type2", ContactType.CONTACT_LEARNINGCENTER);
        } else if(ContactType.getCompany().equals(kvm.get("type"))) {
          wc.addClause("and type = :type");
          wc.addNamedValue("type", ContactType.CONTACT_COMPANY);
        } else if(ContactType.getCenter().equals(kvm.get("type"))) {
          wc.addClause("and type = :type");
          wc.addNamedValue("type", ContactType.CONTACT_LEARNINGCENTER);
        } else {
          wc.addClause("and type = :type");
          wc.addNamedValue("type", ContactType.valueOf(kvm.get("type")));
        }
      }
    }
    wc.addClause("order by c.name");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
  private List<Object> searchConvocations(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from Convocation c");
    wc.addClause("where c.name like :search");
    wc.addClause("order by c.name");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
  private List<Object> searchGroups(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select g from GroupIt g");
    wc.addClause("where g.name like :search");
    wc.addClause("order by g.name");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
  private List<Object> searchServices(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select s from ContactService s");
    wc.addClause("where s.title like :search");
    wc.addClause("order by s.title");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
}