Contact.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.contacts;
 
import java.io.Serializable;
import java.util.*;
import java.util.stream.Collectors;
import javax.persistence.*;
import org.turro.string.Strings;
import org.turro.action.Contacts;
import org.turro.contacts.db.ContactsPU;
import org.turro.contacts.mydata.MyDataList;
import org.turro.contacts.profile.Profile;
import org.turro.contacts.relation.Business;
import org.turro.contacts.relation.Workers;
import org.turro.contacts.util.ContactList;
import org.turro.contacts.util.DefaultContact;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.security.IUser;
import org.turro.i18n.I_;
import org.turro.jpa.Dao;
import org.turro.jpa.embeddables.ComplexName;
import org.turro.jpa.entity.EntityCollections;
import org.turro.jpa.entity.IDaoEntity;
import org.turro.plugin.contacts.IContact;
import org.turro.reflection.MappingSet;
import org.turro.security.Permissions;
import org.turro.security.SecurityGroups;
import org.turro.tags.Tags;
 
@Entity
@org.hibernate.annotations.GenericGenerator(name = "hibernate-uuid", strategy = "uuid")
@NamedQueries({
  @NamedQuery(name="contactByLogin", query="select c from Contact c where c.login = :login")
})
public class Contact implements java.io.Serializable, IDaoEntity {
 
  @Id
  @GeneratedValue(generator = "hibernate-uuid")
  @Column(name="IDENTIFIER")
  private String id;
 
  private String owner;
 
  private boolean onlyOwner;
  private boolean webapp;
  private boolean userMenu;
  private boolean deactivated;
  private boolean inactive;
 
  private ContactType type = ContactType.CONTACT_USER;
  
  @Embedded
  private ComplexName complexName;
 
  private String name;
  private String login;
  private String pass1;
  private String pass2;
  private TimeZone timeZone;
  private Locale locale;
  private Currency currency;
  private String grouping;
  private String idActivity;
  private double billing;
  private double staff;
  
  private double latitude, longitude;
 
  //@Column(unique=true,nullable=true)
  private String globalIdentifier;
  
  private String langTranslator;
  private boolean cloudAdmin;
  
  @Column(unique=true,nullable=true)
  private String emailAccount;
  
  @OneToOne(cascade = CascadeType.ALL, orphanRemoval=true)
  private JobBoard jobBoard;
 
  @OneToMany(mappedBy = "contact", fetch = FetchType.LAZY, cascade=CascadeType.ALL, orphanRemoval=true)
  @OrderBy(value="description")
  private Set<Address> addresses = new HashSet<Address>();
 
  @OneToMany(mappedBy = "contact", fetch = FetchType.LAZY, cascade=CascadeType.ALL, orphanRemoval=true)
  @OrderBy(value="description")
  private Set<Connector> connectors = new HashSet<Connector>();
 
  @OneToMany(mappedBy = "contact", fetch = FetchType.LAZY, cascade=CascadeType.ALL, orphanRemoval=true)
  @OrderBy(value="description")
  private Set<BusinessRelation> businessRelations = new HashSet<BusinessRelation>();
 
  @OneToMany(mappedBy = "business", fetch = FetchType.LAZY, cascade=CascadeType.ALL, orphanRemoval=true)
  @OrderBy(value="description")
  private Set<BusinessRelation> workerRelations = new HashSet<BusinessRelation>();
 
  @OneToMany(mappedBy = "contact", fetch = FetchType.LAZY, cascade=CascadeType.ALL, orphanRemoval=true)
  @OrderBy(value="name")
  private Set<Syndication> syndications = new HashSet<Syndication>();
 
  @OneToMany(mappedBy = "contact", fetch = FetchType.LAZY, cascade=CascadeType.ALL, orphanRemoval=true)
  @OrderBy(value="modification")
  private Set<Comment> comments = new HashSet<Comment>();
 
  @OneToMany(mappedBy = "contact", fetch = FetchType.LAZY, cascade=CascadeType.ALL, orphanRemoval=true)
  private Set<FieldValue> fieldValues = new HashSet<FieldValue>();
 
  @OneToMany(mappedBy = "contact", fetch = FetchType.LAZY, cascade=CascadeType.ALL, orphanRemoval=true)
  private Set<ContactService> services = new HashSet<ContactService>();
 
  public String getId() {
    return id;
  }
 
  protected void setId(String id) {
    this.id = id;
  }
 
  public String getEmailAccount() {
    return emailAccount;
  }
 
  public void setEmailAccount(String emailAccount) {
    this.emailAccount = emailAccount;
  }
 
  public ContactType getType() {
    return type;
  }
 
  public void setType(ContactType type) {
    this.type = type;
  }
 
  public ComplexName getComplexName() {
    if(complexName == null) complexName = new ComplexName();
    return complexName;
  }
 
  public void setComplexName(ComplexName complexName) {
    this.complexName = complexName;
  }
 
  @Deprecated
  public String getOwner() {
    return owner;
  }
 
  @Deprecated
  public void setOwner(String owner) {
    this.owner = owner;
  }
 
  @Deprecated
  public boolean isOnlyOwner() {
    return onlyOwner;
  }
 
  @Deprecated
  public void setOnlyOwner(boolean onlyOwner) {
    this.onlyOwner = onlyOwner;
  }
 
  public boolean isWebapp() {
    return webapp;
  }
 
  public void setWebapp(boolean webapp) {
    this.webapp = webapp;
  }
 
  public boolean isUserMenu() {
    return userMenu;
  }
 
  public void setUserMenu(boolean userMenu) {
    this.userMenu = userMenu;
  }
 
  public boolean isDeactivated() {
    return deactivated;
  }
 
  public void setDeactivated(boolean deactivated) {
    this.deactivated = deactivated;
  }
 
  public boolean isInactive() {
    return inactive;
  }
 
  public void setInactive(boolean inactive) {
    this.inactive = inactive;
  }
 
  public String getName() {
    return name;
  }
 
  public void setName(String name) {
    this.name = name;
  }
 
  public Currency getCurrency() {
    if(currency == null) {
      currency = ElephantContext.getContactCurrency();
    }
    return currency;
  }
 
  public void setCurrency(Currency currency) {
    this.currency = currency;
  }
 
  public Locale getLocale() {
    if(locale == null) {
      locale = ElephantContext.getContactLocale();
    }
    return locale;
  }
 
  public void setLocale(Locale locale) {
    this.locale = locale;
  }
 
  public String getLogin() {
    return login;
  }
 
  public void setLogin(String login) {
    this.login = login;
  }
 
  public String getPass1() {
    return pass1;
  }
 
  public void setPass1(String pass1) {
    this.pass1 = pass1;
  }
 
  public String getPass2() {
    return pass2;
  }
 
  public void setPass2(String pass2) {
    this.pass2 = pass2;
  }
 
  public String getGlobalIdentifier() {
    return globalIdentifier;
  }
 
  public void setGlobalIdentifier(String globalIdentifier) {
    this.globalIdentifier = globalIdentifier;
  }
 
  public TimeZone getTimeZone() {
    return timeZone;
  }
 
  public void setTimeZone(TimeZone timeZone) {
    this.timeZone = timeZone;
  }
 
  public String getGrouping() {
    return grouping;
  }
 
  public void setGrouping(String grouping) {
    this.grouping = grouping;
  }
 
  public String getIdActivity() {
    return idActivity;
  }
 
  public void setIdActivity(String idActivity) {
    this.idActivity = idActivity;
  }
 
  public double getBilling() {
    return billing;
  }
 
  public void setBilling(double billing) {
    this.billing = billing;
  }
 
  public double getStaff() {
    return staff;
  }
 
  public void setStaff(double staff) {
    this.staff = staff;
  }
 
  public double getLatitude() {
    return latitude;
  }
 
  public void setLatitude(double latitude) {
    this.latitude = latitude;
  }
 
  public double getLongitude() {
    return longitude;
  }
 
  public void setLongitude(double longitude) {
    this.longitude = longitude;
  }
 
  public String getLangTranslator() {
    return langTranslator;
  }
 
  public void setLangTranslator(String langTranslator) {
    this.langTranslator = langTranslator;
  }
 
  public boolean isCloudAdmin() {
    return cloudAdmin;
  }
 
  public void setCloudAdmin(boolean cloudAdmin) {
    this.cloudAdmin = cloudAdmin;
  }
 
  public JobBoard getJobBoard() {
    return jobBoard;
  }
 
  public void setJobBoard(JobBoard jobBoard) {
    this.jobBoard = jobBoard;
  }
 
  public Set<Address> getAddresses() {
    Dao dao = new ContactsPU();
    if(!Strings.isBlank(id) && dao.isNotLoaded(addresses)) {
      addresses = dao.lazyLoader(Contact.class, this, "addresses").addresses;
    }
    return addresses;
  }
 
  public void setAddresses(Set<Address> addresses) {
    this.addresses = addresses;
  }
 
  public Set<Connector> getConnectors() {
    Dao dao = new ContactsPU();
    if(!Strings.isBlank(id) && dao.isNotLoaded(connectors)) {
      connectors = dao.lazyLoader(Contact.class, this, "connectors").connectors;
    }
    return connectors;
  }
 
  public void setConnectors(Set<Connector> connectors) {
    this.connectors = connectors;
  }
 
  public Set<BusinessRelation> getBusinessRelations() {
    Dao dao = new ContactsPU();
    if(!Strings.isBlank(id) && dao.isNotLoaded(businessRelations)) {
      businessRelations = dao.lazyLoader(Contact.class, this, "businessRelations").businessRelations;
    }
    return businessRelations;
  }
 
  public void setBusinessRelations(Set<BusinessRelation> businessRelations) {
    this.businessRelations = businessRelations;
  }
 
  public Set<BusinessRelation> getWorkerRelations() {
    Dao dao = new ContactsPU();
    if(!Strings.isBlank(id) && dao.isNotLoaded(workerRelations)) {
      workerRelations = dao.lazyLoader(Contact.class, this, "workerRelations").workerRelations;
    }
    return workerRelations;
  }
 
  public void setWorkerRelations(Set<BusinessRelation> workerRelations) {
    this.workerRelations = workerRelations;
  }
 
  public Set<Syndication> getSyndications() {
    Dao dao = new ContactsPU();
    if(!Strings.isBlank(id) && dao.isNotLoaded(syndications)) {
      syndications = dao.lazyLoader(Contact.class, this, "syndications").syndications;
    }
    return syndications;
  }
 
  public void setSyndications(Set<Syndication> syndications) {
    this.syndications = syndications;
  }
 
  public Set<Comment> getComments() {
    Dao dao = new ContactsPU();
    if(!Strings.isBlank(id) && dao.isNotLoaded(comments)) {
      comments = dao.lazyLoader(Contact.class, this, "comments").comments;
    }
    return comments;
  }
 
  public void setComments(Set<Comment> comments) {
    this.comments = comments;
  }
 
  public Set<FieldValue> getFieldValues() {
    Dao dao = new ContactsPU();
    if(!Strings.isBlank(id) && dao.isNotLoaded(fieldValues)) {
      fieldValues = dao.lazyLoader(Contact.class, this, "fieldValues").fieldValues;
    }
    return fieldValues;
  }
 
  public void setFieldValues(Set<FieldValue> fieldValues) {
    this.fieldValues = fieldValues;
  }
 
  public Set<ContactService> getServices() {
    Dao dao = new ContactsPU();
    if(!Strings.isBlank(id) && dao.isNotLoaded(services)) {
      services = dao.lazyLoader(Contact.class, this, "services").services;
    }
    return services;
  }
 
  public void setServices(Set<ContactService> services) {
    this.services = services;
  }
 
  /* IDaoEntity */
  
  @Override
  public Object entityId() {
    return id;
  }
 
  @Override
  public boolean isEmpty() {
    return Strings.isBlank(name);
  }
 
  /* ComplexName */
  
  public String getFriendly() {
    return getComplexName().getFriendly();
  }
  
  public String getFormal() {
    return getComplexName().getSerious();
  }
  
  /* Helpers */
  
  public void setPlainPass(String text) {
    setPass1(ElephantContext.encrypt(text));
  }
  
  public IContact getIContact() {
    return new DefaultContact(this);
  }
  
  public boolean hasLocation() {
    return latitude != 0.0 && longitude != 0.0;
  }
  
  /* Read only Maps */
  
  public boolean isWebUser() {
    Connector email = getConnectorMap().get(IUser.CONNECTOR_EMAIL);
    return email != null && Contacts.isValidEmail(email.getValue());
  }
 
  public String getTradeName() {
    Connector trade = getConnectorMap().get(IUser.CONNECTOR_TRADE);
    return Strings.isBlank(trade != null ? trade.getValue() : null, getName());
  }
  
  public Map<String, Connector> getConnectorMap() {
    return new ConnectorMap(this);
  }
 
  public Map<String, Address> getAddressMap() {
    return new AddressMap(this);
  }
 
  public Map<String, FieldValue> getFieldMap() {
    return new FieldMap(this);
  }
 
  public Map<String, Comment> getCommentMap() {
    return new CommentMap(this);
  }
 
  public Map<String, Syndication> getSyndicationMap() {
    return new SyndicationMap(this);
  }
 
  public String getComment(IConstructor constructor, String key) {
    String comment = null, lang = key + I_.api().used();
    for(Comment c : getComments()) {
      if(!Strings.isBlank(c.getComment()) && c.getComment().startsWith(lang)) {
        comment = c.getComment().substring(lang.length());
        break;
      }
    }
    if(org.turro.string.Strings.isBlank(comment)) {
      lang = key + "#";
      for(Comment c : getComments()) {
        if(!Strings.isBlank(c.getComment()) && c.getComment().startsWith(lang)) {
          comment = c.getComment().substring(lang.length());
          break;
        }
      }
    }
    return comment;
  }
 
  /* Helpers */
  
  private transient HashMap<String, Object> attributes = new HashMap<>();
  private transient MyDataList _myData;
  
  public String getFullName() {
    Contact business = getBusiness();
    return getName() + (business != null ? " (" + business.getName() + ")" : "");
  }
  
  public void setAttribute(String key, Object value) {
    attributes.put(key, value);
  }
  
  public Object getAttribute(String key) {
    return attributes.get(key);
  }
  
  public MyDataList getMyData() {
    if(_myData == null) {
      _myData = new MyDataList(new DefaultContact(this));
    }
    return _myData;
  }
  
  public void checkEmptyness() {
    EntityCollections.entities(getAddresses()).removeEmpties();
    EntityCollections.entities(getConnectors()).removeEmpties();
    EntityCollections.entities(getSyndications()).removeEmpties();
    EntityCollections.entities(getBusinessRelations()).removeEmpties();
    EntityCollections.entities(getComments()).removeEmpties();
    EntityCollections.entities(getServices()).removeEmpties();
  }
 
  public String getTagsString() {
    return Tags.getTags(this).stream().map(tag -> tag.getTagName())
            .collect(Collectors.joining(", ", "[", "]"));
  }
 
  public String getRolesString() {
    return Permissions.getRoleNames(getSyndications().stream()
            .map(synd -> synd.getName()).collect(Collectors.toSet())).stream()
            .collect(Collectors.joining(", ", "[", "]"));
  }
 
  public String getSocialGroupsString() {
    return getSyndications().stream()
            .map(synd -> I_.get(SecurityGroups.get(synd.getName()).getName()))
            .collect(Collectors.joining(", ", "[", "]"));
  }
 
  public String getLocaleString(Locale currLocale) {
    String result = null;
 
    result = locale != null ? locale.getDisplayName(currLocale) : "";
    result = !Strings.isBlank(result) ? result + " " : "";
    result += currency != null ? currency.toString() : "";
 
    return result;
  }
 
  @Deprecated
  public boolean isValidLogin() {
    return login != null && login.length() > 0;
  }
 
  public boolean getCanShow(String userId) {
    return true; 
  }
  
  /* Contact relation helpers */
  
  private transient Business _business;
  private transient Workers _workers;
  
  public Business getBusinessSet() {
    if(_business == null) {
      _business = new Business(this);
    }
    return _business;
  }
  
  public Workers getWorkerSet() {
    if(_workers == null) {
      _workers = new Workers(this);
    }
    return _workers;
  }
  
  public Contact getBusiness() {
    return getBusinessSet().getBusiness();
  }  
  
  public List<Contact> getBusinessList() {
    return getBusinessSet().getBusinessList();
  }  
  
  public List<Contact> getCoworkers() {
    return getBusinessSet().getCoworkers();
  }  
  
  public List<Contact> getCoworkers(Contact business) {
    return business != null ? business.getWorkers() : new ContactList();
  }  
  
  public List<Contact> getWorkers() {
    return getWorkerSet().getWorkers();
  }  
  
  public boolean isInBusiness(Contact worker) {
    return worker != null && (equals(worker) || getWorkers().contains(worker));
  }
 
  public boolean isInBusiness(IContact worker) {
    return worker != null && worker.isValid() && isInBusiness((Contact) worker.getContact());
  }
 
  /* Associated objects */
 
  public Object getObject(String key) {
    Dao dao = new ContactsPU();
    AssociatedObject ao = getAssociatedObject(dao, key);
    return ao != null ? ao.getObject() : null;
  }
 
  public void setObject(String key, Serializable value) {
    Dao dao = new ContactsPU();
    AssociatedObject ao = getAssociatedObject(dao, key);
    if(ao == null) {
      ao = new AssociatedObject();
      ao.setContact(this);
      ao.setKey(key);
    }
    ao.setObject(value);
    dao.saveObject(ao);
  }
 
  private AssociatedObject getAssociatedObject(Dao dao, String key) {
    return (AssociatedObject) dao.getSingleResult(
            "select ao from AssociatedObject as ao " +
            "where contact = ? and key = ?",
            new Object[] {
              this, key
            });
  }
  
  /* Cached profile */
  
  private transient Profile profile;
  
  public Profile getProfile() {
    if(profile == null) {
      profile = new Profile(this);
    }
    return profile;
  }
 
  public Profile getEditProfile() {
    if(profile == null) {
      profile = new Profile(this, true);
    }
    return profile;
  }
 
  /* XML Serializer */
 
  public MappingSet getSerializerMappings() {
    MappingSet set = new MappingSet();
    set.addMapping(Contact.class, 1, 
            new String[] { "id", "type", "name", "login", "pass1", "pass2",  
              "globalIdentifier", "emailAccount", "webapp", "userMenu", "deactivated" }, 
            new String[] { "addresses", "connectors", "businessRelations", "jobBoard",
              "locale", "timeZone", "currency", "syndications", "comments", 
              "fieldValues", "services", "grouping", "idActivity", "billing", "staff" });
    set.addMapping(Address.class, 2,
            new String[] { "id", "description" }, 
            new String[] { "street", "zipCode", "province", "state", "latitude", "longitude" });
    set.addMapping(Connector.class, 2,
            new String[] { "id", "description" }, 
            new String[] { "value" });
    set.addMapping(BusinessRelation.class, 2,
            new String[] { "id", "description", "preferential", "strong", "validated",
              "startDate", "endDate" }, 
            new String[] { "business", "relationType" });
    set.addMapping(Syndication.class, 2,
            new String[] { "id", "name" }, 
            null);
    set.addMapping(Comment.class, 2,
            new String[] { "id", "modification" }, 
            new String[] { "comment" });
    set.addMapping(FieldValue.class, 2,
            new String[] { "value", }, 
            new String[] { "fieldDef" });
    set.addMapping(FieldDef.class, 3,
            new String[] { "id", "tabKey", "labeyKey", "tagDiscriminator" }, 
            null);
    set.addMapping(ContactService.class, 2,
            new String[] { "title", }, 
            new String[] { "text", "contact", "responsible" });
    set.addMapping(Contact.class, 3, 
            new String[] { "id", "name" }, 
            null);
    set.addMapping(Currency.class, 2,
            new String[] { "currencyCode" }, 
            null);
    set.addMapping(TimeZone.class, 2,
            new String[] { "displayName" }, 
            null);
    set.addMapping(JobBoard.class, 2,
            new String[] { "zipCode", "commuting", "available", "updateDate" }, 
            null);
    return set;
  }
 
  @Override
  public int hashCode() {
    int hash = 7;
    hash = 31 * hash + Objects.hashCode(this.id);
    return hash;
  }
 
  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    final Contact other = (Contact) obj;
    if (!Objects.equals(this.id, other.id)) {
      return false;
    }
    return true;
  }
 
}