VisualElement.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2020 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.visual;
 
import java.util.HashSet;
import java.util.Objects;
import org.turro.string.Strings;
import org.turro.i18n.I_;
import org.turro.plugin.contacts.IContact;
import org.turro.script.Script;
import org.turro.script.Scripting;
import org.turro.util.CompareUtil;
 
public abstract class VisualElement<F extends VisualElements, V extends VisualElement, E> implements Comparable<VisualElement> {
  
  private String name, label, role, eval;
  private int order;
  private HashSet<String> syndications, groupings, 
          businessSyndications, businessGroupings;
  private Boolean visitor, admin, worker, student, hhrr;
  private F subElements;
  
  private final transient F factory;
  private transient V parent;
          
  private transient Script script;
  
  public VisualElement(String name, F factory) {
    this.name = name;
    this.factory = factory;
  }
 
  public V getParent() {
    return parent;
  }
 
  public void setParent(V parent) {
    this.parent = parent;
  }
  
  public boolean check(E entity, IContact contact) {
    if(emptyConstraints() && emptyEntityConstraints()) {
      return isNullOrFalse(visitor) ? true : checkContact(contact); // No constraint
    }
    return checkConstraints(entity, contact);
  }
 
  public String getName() {
    return name;
  }
 
  public String getLabel() {
    return I_.get(label);
  }
 
  public int getOrder() {
    return order;
  }
  
  public boolean allows(String name, E entity, IContact contact) {
    VisualElement dve = getElement(name);
    return dve == null || dve.check(entity, contact);
  }
 
  public VisualElement getElement(String name) {
    return getSubElements() == null ? null : getSubElements().getElement(name);
  }
 
  public VisualElement getElement(String name, E entity, IContact contact) {
    return getSubElements() == null ? null : getSubElements().getElement(name, entity, contact);
  }
 
  public F getSubElements() {
    return subElements;
  }
 
  public V setName(String name) {
    this.name = name;
    return (V) this;
  }
 
  public V setLabel(String label) {
    this.label = label;
    return (V) this;
  }
 
  public V setOrder(int order) {
    this.order = order;
    return (V) this;
  }
 
  public V setRole(String role) {
    this.role = role;
    return (V) this;
  }
 
  public V setAdmin(Boolean admin) {
    this.admin = admin;
    return (V) this;
  }
  
  public V setWorker(Boolean worker) {
    this.worker = worker;
    return (V) this;
  }
  
  public V setStudent(Boolean student) {
    this.student = student;
    return (V) this;
  }
  
  public V setHHRR(Boolean hhrr) {
    this.hhrr = hhrr;
    return (V) this;
  }
  
  public V setVisitor(Boolean visitor) {
    this.visitor = visitor;
    return (V) this;
  }
 
  public V addSyndication(String syndication) {
    if(syndications == null) {
      syndications = new HashSet<>();
    }
    syndications.add(syndication);
    return (V) this;
  }
  
  public V addGrouping(String grouping) {
    if(groupings == null) {
      groupings = new HashSet<>();
    }
    groupings.add(grouping);
    return (V) this;
  }
  
  public V addBusinessSyndication(String syndication) {
    if(businessSyndications == null) {
      businessSyndications = new HashSet<>();
    }
    businessSyndications.add(syndication);
    return (V) this;
  }
  
  public V addBusinessGrouping(String grouping) {
    if(businessGroupings == null) {
      businessGroupings = new HashSet<>();
    }
    businessGroupings.add(grouping);
    return (V) this;
  }
  
  protected V addSubElement(String name) {
    if(subElements == null) {
      subElements = (F) factory.createSubElements();
    }
    V v = (V) factory.createElement(name);
    v.setParent(this);
    return subElements.add(v) ? v : null;
  }
 
  protected boolean checkConstraints(E entity, IContact contact) {
    if(checkContact(contact)) {
      if(!Strings.isBlank(role) && !contact.getPermissions().isInRole(role)) {
        return false;
      }
      IContact business = contact.getBusiness();
      business = (business != null && business.isValid()) ? business : null;
      return checkAllMatch(entity, contact) &&
             (checkEval(entity, contact) ||
             checkSyndications(contact) ||
             checkGroupings(contact) ||
             checkBusinessSyndications(business) ||
             checkBusinessGroupings(business) ||
             checkRoles(contact) ||
             checkAnyMatch(entity, contact));
    }
    return false;
  }
  
  protected boolean emptyConstraints() {
    return eval == null && role == null && syndications == null && groupings == null && 
           businessSyndications == null && businessGroupings == null &&
           admin == null && worker == null && student == null && hhrr == null;
  }
  
  protected boolean checkEval(E entity, IContact contact) {
    if(hasScript()) {
      getScript().addVariable("user", contact);
      return getScript().evalToBoolean(Scripting.realScript(eval));
    }
    return false;
  }
  
  private boolean checkSyndications(IContact contact) {
    if(syndications != null) {
      for(String syndication : contact.getSyndications()) {
        if(syndications.contains(syndication)) {
          return true;
        }
      }
    }
    return false;
  }
 
  private boolean checkGroupings(IContact contact) {
    if(groupings != null) {
      if(groupings.contains(contact.getGrouping())) {
        return true;
      }
    }
    return false;
  }
 
  private boolean checkBusinessSyndications(IContact business) {
    if(business != null && businessSyndications != null) {
      for(String syndication : business.getSyndications()) {
        if(businessSyndications.contains(syndication)) {
          return true;
        }
      }
    }
    return false;
  }
 
  private boolean checkBusinessGroupings(IContact business) {
    if(business != null && businessGroupings != null) {
      if(businessGroupings.contains(business.getGrouping())) {
        return true;
      }
    }
    return false;
  }
 
  private boolean checkRoles(IContact contact) {
    return (isNullOrFalse(admin) ? false : contact.isAdmin()) ||
           (isNullOrFalse(worker) ? false : contact.isWorker()) ||
           (isNullOrFalse(student) ? false : contact.isStudent()) ||
           (isNullOrFalse(hhrr) ? false : contact.isHHRR());
  }
  
  public boolean isVisitor(E entity, IContact contact) {
    return !checkContact(contact) || !checkConstraints(entity, contact);
  }
  
  protected boolean checkContact(IContact contact) {
    return contact != null && contact.isValid();
  }
  
  protected boolean isNullOrFalse(Boolean value) {
    return value == null || value.equals(Boolean.FALSE);
  }
  
  protected abstract boolean emptyEntityConstraints();
  protected abstract boolean checkAllMatch(E entity, IContact contact);  
  protected abstract boolean checkAnyMatch(E entity, IContact contact);
  
  /* Scripting */
  
  protected boolean hasScript() {
    return !Strings.isBlank(eval);
  }
  
  protected Script getScript() {
    if(script == null) {
      script = Scripting.instance();
    }
    return script;
  }
  
  /* Comparable */
  
  @Override
  public int compareTo(VisualElement o) {
    if(o == null) return 0;
    int result = CompareUtil.compare(this.order, o.order);
    if(result == 0) {
      result = CompareUtil.compare(this.name, o.name);
    }
    return result;
  }
 
  @Override
  public int hashCode() {
    int hash = 7;
    hash = 97 * hash + Objects.hashCode(this.name);
    hash = 97 * hash + this.order;
    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 VisualElement<?, ?, ?> other = (VisualElement<?, ?, ?>) obj;
    if (this.order != other.order) {
      return false;
    }
    if (!Objects.equals(this.name, other.name)) {
      return false;
    }
    return true;
  }
 
}