ConceptPermission.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2022 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.security;
 
import java.util.Collection;
import org.turro.string.Strings;
import org.turro.action.Contacts;
import org.turro.actor.Actors;
import org.turro.entities.IElephantEntity;
import org.turro.plugin.contacts.IContact;
import org.turro.script.Scripting;
import org.turro.util.Cached;
 
public class ConceptPermission {
 
  public static final String 
          DRIVER = "driver", 
          COORDINATOR = "coordinator", 
          BENEFICIARY = "beneficiary", 
          OFFERER = "offerer", 
          RESEARCH = "research", 
          FUNDING = "funding", 
          SUPPORT = "support", 
          CONSORTIUM = "consortium", 
          ADMIN = "admin",
          TAGS = "tags", 
          PROPOSALS = "proposals", 
          MILESTONES = "milestones", 
          DEBATES = "debates", 
          CALLS = "calls", 
          VOTES = "votes",
          DELIVERABLES = "deliverables";
 
  private final transient String name;
  private final boolean allow;
 
  private boolean show = true;
  private String showRole, actionRole;
  private String showScript, actionScript;
  private String showActor, actionActor;
  private Integer max, order;
  
  private final ConceptPermissionMap permissions = new ConceptPermissionMap();
 
  public ConceptPermission show() {
    this.show = true;
    return this;
  }
  
  public ConceptPermission hide() {
    this.show = false;
    return this;
  }
  
  public ConceptPermission max(Integer max) {
    this.max = max;
    return this;
  }
  
  public ConceptPermission order(Integer order) {
    this.order = order;
    return this;
  }
  
  public ConceptPermission showRole(String role) {
    this.showRole = role;
    return this;
  }
  
  public ConceptPermission actionRole(String role) {
    this.actionRole = role;
    return this;
  }
  
  public ConceptPermission showScript(String script) {
    this.showScript = script;
    return this;
  }
  
  public ConceptPermission actionScript(String script) {
    this.actionScript = script;
    return this;
  }
  
  public ConceptPermission showActor(String actor) {
    this.showActor = actor;
    return this;
  }
  
  public ConceptPermission actionActor(String actor) {
    this.actionActor = actor;
    return this;
  }
  
  public ConceptPermission addPermission(ConceptPermission permission) {
    this.permissions.put(permission);
    return this;
  }
  
  public String getName() {
    return name;
  }
  
  public boolean isAllow() {
    return allow;
  }
 
  public boolean isShow() {
    return show;
  }
 
  public Integer getMax() {
    return max;
  }
 
  public Integer getOrder() {
    return order;
  }
  
  public ConceptPermission getPermission(String name) {
    return permissions.get(name, iee);
  }
 
  public Collection<String> getConcepts() {
    return permissions.concepts();
  }
  
  /* Checks */
  
  public boolean canShow() {
    return canShow(contact.get());
  }
  
  public boolean canShow(IContact contact) {
    return isShow() && Contacts.isValid(contact) && 
            (Strings.isBlank(showRole) || contact.isInRole(showRole)) &&
            (Strings.isBlank(showScript) || processScript(showScript, iee)) &&
            (Strings.isBlank(showActor) || processActor(showActor, iee));
  }
  
  public boolean canAct() {
    return canAct(contact.get());
  }
  
  public boolean canAct(IContact contact) {
    return isAllow() && Contacts.isValid(contact) && 
            (Strings.isBlank(actionRole) || contact.isInRole(actionRole)) &&
            (Strings.isBlank(actionScript) || processScript(actionScript, iee)) &&
            (Strings.isBlank(actionActor) || processActor(actionActor, iee));
  }
   
  /* Scripting */
  
  private boolean processScript(String value, IElephantEntity entity) {
    return Scripting.evalFor(contact.get(), entity, value);
  }
 
  private boolean processActor(String actor, IElephantEntity entity) {
    return Actors.isActorFor(contact.get(), entity, actor);
  }
 
  /* Initializer */
  
  private transient Cached<IContact> contact;
  private transient IElephantEntity iee;
  
  public void init(IElephantEntity iee, Cached<IContact> contact) {
    this.iee = iee;
    this.contact = contact;
  }
  
  /* Factory */
  
  public static ConceptPermission allow(String name) {
    return new ConceptPermission(name, true);
  }
  
  public static ConceptPermission forbid(String name) {
    return new ConceptPermission(name, false).hide();
  }
  
  private ConceptPermission(String name, boolean allow) {
    this.name = name;
    this.allow = allow;
    this.order = -1;
  }
 
}