FinancialsEntities.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.List;
import org.turro.string.Strings;
import org.turro.action.IEntityCtrl;
import org.turro.annotation.ElephantEntity;
import org.turro.attach.www.AttachCtrl;
import org.turro.collections.KeyValueMap;
import org.turro.command.LabelControl;
import org.turro.elephant.db.WhereClause;
import org.turro.elephant.util.DateFormats;
import org.turro.file.util.FileAttach;
import org.turro.financials.command.DocumentLabel;
import org.turro.financials.db.FinancialsPU;
import org.turro.financials.entity.Account;
import org.turro.financials.entity.BatchOf;
import org.turro.financials.entity.Company;
import org.turro.financials.entity.Contract;
import org.turro.financials.entity.ContractInterventionType;
import org.turro.financials.entity.ContractParticipant;
import org.turro.financials.entity.Department;
import org.turro.financials.entity.Document;
import org.turro.financials.entity.FixedAsset;
import org.turro.financials.entity.Headquarters;
import org.turro.financials.entity.MajorAccount;
import org.turro.financials.entity.Product;
import org.turro.financials.entity.Register;
import org.turro.financials.entity.Service;
import org.turro.financials.menu.FinancialsMenu;
import org.turro.i18n.I_;
import org.turro.jpa.Dao;
import org.turro.path.Path;
import org.turro.plugin.contacts.IContact;
import org.turro.www.commentit.CommentItCtrl;
import org.turro.www.describeit.DescribeItCtrl;
 
@ElephantEntity
public class FinancialsEntities extends DefaultElephantEntity {
 
  public FinancialsEntities() {
  }
 
  public FinancialsEntities(String entityPath) {
    super(entityPath);
  }
 
  public FinancialsEntities(Object entity) {
    super(entity);
  }
 
  @Override
  public Object getEntity() {
    if(entity == null) {
      if(getPath() != null) {
        if(isValidLongEntity()) {
          if(null != path.getRoot()) switch (path.getRoot()) {
            case "contract":
              entity = getDao().find(Contract.class, path.getNodeAs(1, Long.class));
              break;
            case "document":
              entity = getDao().find(Document.class, path.getNodeAs(1, Long.class));
              break;
            case "bacthof":
              entity = getDao().find(BatchOf.class, path.getNodeAs(1, Long.class));
              break;
            case "product":
              entity = getDao().find(Product.class, path.getNodeAs(1, Long.class));
              break;
            case "fixed-asset":
              entity = getDao().find(FixedAsset.class, path.getNodeAs(1, Long.class));
              break;
            case "company":
              entity = getDao().find(Company.class, path.getNodeAs(1, Long.class));
              break;
            case "headquarters":
              entity = getDao().find(Headquarters.class, path.getNodeAs(1, Long.class));
              break;
            case "department":
              entity = getDao().find(Department.class, path.getNodeAs(1, Long.class));
              break;
            case "service":
              entity = getDao().find(Service.class, path.getNodeAs(1, Long.class));
              break;
            case "register":
              entity = getDao().find(Register.class, path.getNodeAs(1, Long.class));
              break;
            case "account":
              entity = getDao().find(Account.class, path.getNode(1));
              break;
            case "major-account":
              entity = getDao().find(MajorAccount.class, path.getNodeAs(1, Long.class));
              break;
            default:
              break;
          }
        }
      }
    }
    return entity;
  }
 
  @Override
  public String getName() {
    if(getEntity() != null) {
      if(entity instanceof Contract) {
        return ((Contract) entity).getId() + " - " +((Contract) entity).getFullDescription();
      } else if(entity instanceof Document) {
        return ((Document) entity).getDocDescription();
      } else if(entity instanceof BatchOf) {
        return ((BatchOf) entity).getBatch().getDocDescription();
      } else if(entity instanceof Product) {
        return ((Product) entity).getProductString();
      } else if(entity instanceof FixedAsset) {
        return ((FixedAsset) entity).getId() + " - " + ((FixedAsset) entity).getName();
      } else if(entity instanceof Company) {
        return ((Company) entity).getName();
      } else if(entity instanceof Headquarters) {
        return ((Headquarters) entity).getName();
      } else if(entity instanceof Department) {
        return ((Department) entity).getFullName();
      } else if(entity instanceof Service) {
        return ((Service) entity).getFullName();
      } else if(entity instanceof Register) {
        return ((Register) entity).getIdRegister() + " " + DateFormats.format(((Register) entity).getRegisterDate(), true);
      } else if(entity instanceof Account) {
        return ((Account) entity).getId() + " - " + ((Account) entity).getDescription();
      } else if(entity instanceof MajorAccount) {
        return ((MajorAccount) entity).getAccount()+ " - " + ((MajorAccount) entity).getDescription();
      }
    }
    return null;
  }
 
  @Override
  public String getLabel() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "contract":
          return I_.get("Contract");
        case "document":
          return I_.get("Document");
        case "batchof":
          return I_.get("Batch of");
        case "product":
          return I_.get("Product");
        case "fixed-asset":
          return I_.get("Fixed asset");
        case "company":
          return I_.get("Company");
        case "headquarters":
          return I_.get("Headquarters");
        case "department":
          return I_.get("Department");
        case "service":
          return I_.get("Service");
        case "register":
          return I_.get("Register");
        case "account":
          return I_.get("Account");
        case "major-account":
          return I_.get("Major account");
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getDescription() {
    if(getEntity() != null) {
      if(entity instanceof Contract) {
        return ((Contract) entity).getContractDefinition().getDescription();
      }
    }
    return null;
  }
 
  @Override
  public Object getLabelCtrl() {
    if(getEntity() != null) {
      if(entity instanceof Document) {
        return new DocumentLabel(entity);
      } else if(entity instanceof BatchOf) {
        return new DocumentLabel(entity);
      } else {
        return new LabelControl(entity);
      }
    }
    return null;
  }
 
  @Override
  public String getImage() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "contract":
          return "/_zul/images/contract.png";
        case "document":
          return "/_zul/images/document.png";
        case "batchof":
          return "/_zul/images/batchof.png";
        case "product":
          return "/_zul/images/product.png";
        case "fixed-asset":
          return "/_zul/images/asset.png";
        case "company":
          return "/_zul/images/b_company.png";
        case "headquarters":
          return "/_zul/images/b_headquarters.png";
        case "department":
          return "/_zul/images/b_department.png";
        case "service":
          return "/_zul/images/b_service.png";
        case "register":
          return "/_zul/images/register.png";
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getHierarchicalPath() {
    if(getEntity() != null) {
      if(entity instanceof Document) {
        Contract contract = ((Document) entity).getContract();
        return FinancialsPU.getObjectPath(contract) +
                PATH_SEPARATOR + getPath();
      }
    }
    return getPath();
  }
 
  @Override
  public IElephantEntity getParent() {
    if(getEntity() != null) {
      if(entity instanceof Contract) {
        return Entities.getController("/contact/" + ((Contract) entity).getContractor());
      } else if(entity instanceof Document) {
        return Entities.getController(((Document) entity).getContract());
      }
    }
    return null;
  }
 
  @Override
  public List<IElephantEntity> getChildren() {
    if(getEntity() != null) {
      if(entity instanceof Contract) {
        Contract contract = (Contract) entity;
        return new EntityListAdapter(contract.getDocuments());
      }
    }
    return Collections.EMPTY_LIST;
  }
 
  @Override
  public String getExtendedPath() {
    return FinancialsPU.getObjectExtendedPath(entity);
  }
 
  @Override
  public File getFile() {
    return null;
  }
 
  @Override
  public boolean showPath() {
    return false;
  }
 
  @Override
  public boolean showEntity() {
    if(getEntity() != null) {
      if(entity instanceof Contract) {
        FinancialsMenu.showContract(((Contract) entity).getId());
        return true;
      } else if(entity instanceof Document) {
        FinancialsMenu.showDocument(((Document) entity).getId());
        return true;
      } else if(entity instanceof BatchOf) {
        FinancialsMenu.showBatchOf(((BatchOf) entity).getId());
        return true;
      } else if(entity instanceof Product) {
        FinancialsMenu.showProduct(((Product) entity).getId());
        return true;
      } else if(entity instanceof FixedAsset) {
        FinancialsMenu.showFixedAsset(((FixedAsset) entity).getId());
        return true;
      } else if(entity instanceof Register) {
        FinancialsMenu.showRegister(((Register) entity).getId());
        return true;
      } else if(entity instanceof Company) {
        FinancialsMenu.showCompanies();
        return true;
      }
    }
    return false;
  }
 
  @Override
  public boolean canEdit(IContact contact) {
    if(getEntity() != null) {
      if(entity instanceof Contract) {
        return contact.getPermissions().isInRole("finan-contract:edit");
      } else if(entity instanceof Document) {
        return contact.getPermissions().isInRole("finan-document:edit");
      } else if(entity instanceof BatchOf) {
        return contact.getPermissions().isInRole("finan-document:edit");
      } else if(entity instanceof Product) {
        return contact.getPermissions().isInRole("finan-product:edit");
      } else if(entity instanceof FixedAsset) {
        return contact.getPermissions().isInRole("finan-fixed-asset:edit");
      } else if(entity instanceof Register) {
        return contact.getPermissions().isInRole("finan-register:edit");
      } else if(entity instanceof Company) {
        return contact.getPermissions().isInRole("finan-model:edit");
      }
    }
    return false;
  }
 
  @Override
  public boolean canPublish(IContact contact) {
    if(getEntity() != null) {
      if(entity instanceof Contract) {
        Contract ctc = (Contract) getEntity();
        return ctc.getIParticipants().contains(contact);
      } else if(entity instanceof Document) {
        Document doc = (Document) getEntity();
        return doc.getContract().getIParticipants().contains(contact);
      } else if(entity instanceof BatchOf) {
        BatchOf doc = (BatchOf) getEntity();
        return doc.getBatch().getContract().getIParticipants().contains(contact);
      } else if(entity instanceof Product) {
        Product prod = (Product) getEntity();
        return prod.isPublishable();
      }
    }
    return false;
  }
 
  @Override
  public Collection getEntitites(String search, int maxResults, KeyValueMap kvm) {
    ArrayList<Object> list = new ArrayList<>();
    list.addAll(searchContracts(search, maxResults, kvm));
    list.addAll(searchProducts(search, maxResults, kvm));
    list.addAll(searchFixedAssets(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 "contract":
        list.addAll(searchContracts(search, maxResults, kvm));
        break;
      case "product":
        list.addAll(searchProducts(search, maxResults, kvm));
        break;
      case "fixed-asset":
        list.addAll(searchFixedAssets(search, maxResults, kvm));
        break;
      default:
        break;
    }
    return list;
  }
 
  @Override
  public Object configureCtrl(Object ctrl, IContact contact) {
    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 Contract) {
        Contract ctc = (Contract) getEntity();
        ictrl.setPublicOnly(true);
        if(ctc.getIParticipants().contains(contact)) {
          ictrl.setPublicOnly(false);
        }
      }
      if(getEntity() instanceof Document) {
        Contract ctc = (Contract) ((Document) getEntity()).getContract();
        ictrl.setPublicOnly(true);
        if(ctc.getIParticipants().contains(contact)) {
          ictrl.setPublicOnly(false);
        }
      }
      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 IEntityCtrl) {
      IEntityCtrl ictrl = (IEntityCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    }
    return ctrl;
  }
 
  @Override
  public boolean canShowInContext(IContact contact, Object relatedEntity) {
    return true;
  }
 
  @Override
  public Collection<Object> getRelatedByRole(EntityRole role, IContact contact) {
    switch(role) {
      case SELF_AS_COMPANY_OWNER:
        return getRelatedEntities(role, contact);
    }
    return Collections.EMPTY_LIST;
  }
 
  @Override
  public boolean hasRelatedRole(EntityRole role, IContact contact) {
    switch(role) {
      case SELF_AS_COMPANY_OWNER:
        if(getEntity() instanceof Contract) {
          if(((Contract) getEntity()).getContractor().equals(contact.getId())) {
            return true;
          }
          for(ContractParticipant cp : ((Contract) getEntity()).getParticipants()) {
            if(cp.isSignature() && cp.getIdContact().equals(contact.getId())) {
              return true;
            }
          }
        }
        break;
    }
    return false;
  }
 
  @Override
  public String getExtendedWebPath() {
    if(getEntity() != null) {
      if(entity instanceof Contract) {
        Contract contract = (Contract) entity;
        return "/" + contract.getId() + 
                "/" + Strings.unpunctuate(contract.getName()).toLowerCase();
      }
    }
    return null;
  }
 
  @Override
  public String getUserContext() {
    return "/user/" + getLinkRoot() + "s";
  }
 
  @Override
  protected Dao createDao() {
    return new FinancialsPU();
  }
 
  @Override
  protected boolean itsMine(String rootPath) {
    return super.itsMine(rootPath) || 
           // Only for label purposes
           "account".equals(rootPath) || "major-account".equals(rootPath);
  }
 
  @Override
  protected boolean itsMine(Object entity) {
    return (entity instanceof Contract) || (entity instanceof Document) || (entity instanceof BatchOf) ||
           (entity instanceof Product) || (entity instanceof FixedAsset) || (entity instanceof Company) ||
           (entity instanceof Headquarters) || (entity instanceof Department) || (entity instanceof Service) ||
           (entity instanceof Register) || 
           // Only for label purposes
           (entity instanceof Account) || (entity instanceof MajorAccount);
  }
 
  @Override
  public Collection<String> getAllowedRoots() {
    return Arrays.asList("contract", "document", "batchof", "product", "fixed-asset", 
            "company", "headquarters", "department", "service", "register");
  }
 
  @Override
  protected IElephantEntity createInstance(String entityPath) {
    return new FinancialsEntities(entityPath);
  }
 
  @Override
  protected IElephantEntity createInstance(Object entity) {
    return new FinancialsEntities(entity);
  }
 
  @Override
  protected Path createPath() {
    return new Path(FinancialsPU.getObjectPath(entity));
  }
 
  private List<Object> searchContracts(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from Contract 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> searchProducts(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from Product c");
    wc.addClause("where c.description like :search");
    wc.addClause("order by c.description");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
  private List<Object> searchFixedAssets(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from FixedAsset c");
    wc.addClause("where c.name like :search");
    wc.addClause("order by c.name");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
  private Collection<Object> getRelatedEntities(EntityRole role, IContact contact) {
    switch(role) {
      case SELF_AS_COMPANY_OWNER: // contract related
        String idContact = contact.getId();
        WhereClause wc = new WhereClause();
        wc.addClause("select distinct ctc from Contract ctc");
        wc.addClause("left join ctc.participants par");
        wc.addClause("where 1=1");
        wc.addClause("and (ctc.contractor = :contractor");
        wc.addNamedValue("contractor", idContact);
        for(ContractInterventionType cit : ContractInterventionType.values()) {
          if(cit.isSignature()) {
            wc.addClause("or (par.interventionType = :cit" + cit.toString());
            wc.addNamedValue("cit" + cit.toString(), cit);
            wc.addClause("and par.idContact = :con" + cit.toString() + ")");
            wc.addNamedValue("con" + cit.toString(), idContact);
          }
        }
        wc.addClause(")");
        return getDao().getResultList(wc);
    }
    return Collections.EMPTY_LIST;
  }
  
}