EntityDocumentation.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.attach.entity;
 
import java.io.IOException;
import java.io.Serializable;
import java.util.Collections;
import java.util.Date;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.persistence.ElementCollection;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.Id;
import javax.persistence.IdClass;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import org.turro.action.Contacts;
import org.turro.auth.Authentication;
import org.turro.documentation.DocumentDefinition;
import org.turro.documentation.DocumentDefinitions;
import org.turro.elephant.context.ElephantContext;
import org.turro.entities.Entities;
import org.turro.entities.IElephantEntity;
import org.turro.file.Document;
import org.turro.file.Folder;
import org.turro.plugin.contacts.IContact;
 
@Entity
@IdClass(EntityDocumentationPK.class)
public class EntityDocumentation implements Serializable {
 
  @Id private String entityPath;
  @Id private String contactId;
  @Id private String documentation;
 
  private String requesterId;
  private EntityDocumentationStatus status;
  private String comment;
  
  @Temporal(TemporalType.TIMESTAMP)
  private Date deadline;
 
  @ElementCollection(fetch = FetchType.EAGER)
  private Set<String> assistantIds = new HashSet<>();
  
  public String getEntityPath() {
    return entityPath;
  }
 
  public void setEntityPath(String entityPath) {
    this.entityPath = entityPath;
  }
 
  public String getContactId() {
    return contactId;
  }
 
  public void setContactId(String contactId) {
    this.contactId = contactId;
  }
 
  public String getDocumentation() {
    return documentation;
  }
 
  public void setDocumentation(String documentation) {
    this.documentation = documentation;
  }
 
  public String getRequesterId() {
    return requesterId;
  }
 
  public void setRequesterId(String requesterId) {
    this.requesterId = requesterId;
  }
 
  public EntityDocumentationStatus getStatus() {
    return status;
  }
 
  public void setStatus(EntityDocumentationStatus status) {
    this.status = status;
  }
 
  public String getComment() {
    return comment;
  }
 
  public void setComment(String comment) {
    this.comment = comment;
  }
 
  public Date getDeadline() {
    return deadline;
  }
 
  public void setDeadline(Date deadline) {
    this.deadline = deadline;
  }
 
  public Set<String> getAssistantIds() {
    return assistantIds;
  }
 
  public void setAssistantIds(Set<String> assistantIds) {
    this.assistantIds = assistantIds;
  }
 
  /* Utils */
  
  public boolean isValid(List<EntityDocumentation> invalids) {
    if(getDefinition() == null) {
      invalids.add(this);
      return false;
    }
    return true;
  }
  
  public void reviewStatus() {
    if(getFolder().count() < getDefinition().getMin()) {
      status = EntityDocumentationStatus.PENDING_UPLOAD;
    } else if(!EntityDocumentationStatus.validationStatus().contains(status)) {
      status = EntityDocumentationStatus.PENDING_VALIDATION;
    }
  }
  
  public boolean allowsUpload() throws IOException {
    return (!EntityDocumentationStatus.VALIDATED.equals(status) &&
            (getDefinition().isUploadControl() || getFolder().count() < getDefinition().getMax())) ||
            Authentication.isAdministrator();
  }
  
  public boolean allowsValidation() {
    return EntityDocumentationStatus.PENDING_VALIDATION.equals(status);
  }
  
  public boolean allowsDeny() {
    return allowsValidation() || (Authentication.isAdministrator() && 
            EntityDocumentationStatus.VALIDATED.equals(status));
  }
  
  public boolean allowsDelete() throws IOException {
    return !(getDefinition().isUploadControl() || EntityDocumentationStatus.VALIDATED.equals(status)) ||
           Authentication.isAdministrator();
  }
  
  public boolean allowsDeleteDef() throws IOException {
    return getFolder().isEmpty() || Authentication.isAdministrator();
  }
  
  public List<Document> getDocuments() {
    Folder folder = getFolder();
    if(folder.exists()) try {
      return folder.documents();
    } catch (IOException ex) {
      Logger.getLogger(EntityDocumentation.class.getName()).log(Level.SEVERE, null, ex);
    }
    return Collections.EMPTY_LIST;
  }
  
  public Folder getFolder() {
    return Folder.from(ElephantContext.getRealPath(getFolderString()));
  }
  
  public String getFolderString() {
    DocumentDefinition dd = getDefinition();
    return "/WEB-INF/files/" + entityPath + "/documentation/" + 
            dd.getFolderName() + "/" + contactId;
  }
  
  public DocumentDefinition getDefinition() {
    return DocumentDefinitions.instance().get(documentation);
  }
  
  public IElephantEntity getEntity() {
    return Entities.getController(entityPath);
  }
  
  public IContact getContact() {
    return Contacts.getContactById(contactId);
  }
  
  public IContact getRequester() {
    return Contacts.getContactById(requesterId);
  }
  
  public List<IContact> getAssistants() {
    return assistantIds.stream().map(id -> Contacts.getContactById(id)).toList();
  }
  
}