AttachEntities.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.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.amic.util.file.FileUtil;
import org.turro.string.Strings;
import org.turro.action.AcceptanceSingleStatus;
import org.turro.annotation.ElephantEntity;
import org.turro.attach.db.AttachPU;
import org.turro.attach.entity.Attachment;
import org.turro.attach.zul.AttachmentUtil;
import org.turro.collections.KeyValueMap;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.db.WhereClause;
import org.turro.file.FileWrapper;
import org.turro.i18n.I_;
import org.turro.jpa.Dao;
import org.turro.path.Path;
import org.turro.plugin.contacts.IContact;
import org.turro.wd.entities.AttachWd;
 
@ElephantEntity
public class AttachEntities extends DefaultElephantEntity {
 
  public AttachEntities() {
  }
 
  public AttachEntities(String entityPath) {
    super(entityPath);
  }
 
  public AttachEntities(Object entity) {
    super(entity);
  }
 
  @Override
  public Object getEntity() {
    if(entity == null) {
      if(getPath() != null) {
        if(path.getSize() == 2) {
          if(null != path.getRoot()) switch (path.getRoot()) {
            case "attachment":
              if(isValidLongEntity()) {
                entity = getDao().find(Attachment.class, path.getNodeAs(1, Long.class));
              }
              break;                
            case "file":
              entity = new File(ElephantContext.getRealPath(path.getFrom(1)));
              break;
            default:
              break;
          }
        }
      }
    }
    return entity;
  }
 
  @Override
  public String getName() {
    if(getEntity() != null) {
      if(entity instanceof Attachment) {
        return ((Attachment) entity).getFileName();
      } else if(entity instanceof File) {
        return ((File) entity).getName();
      }
    }
    return null;
  }
 
  @Override
  public String getLabel() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "attachment":
          return I_.get("Attachment");
        case "file":
          return I_.get("File");
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getDescription() {
    return null;
  }
 
  @Override
  public Object getLabelCtrl() {
    return null;
  }
 
  @Override
  public String getImage() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "attachment":
          return "/_zul/images/clip.png";
        case "file":
          return "/_zul/images/clip.png";
        default:
          break;
      }
    }
    return null;
  }
 
  public String getMimeImage() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "attachment":
          return getMimeImage(entity);
        case "file":
          return getMimeImage(entity);
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getHierarchicalPath() {
    if(getEntity() != null) {
      if(entity instanceof Attachment) {
        IElephantEntity iee = ((Attachment) entity).getOwnerEntity();
        String hp = iee.getHierarchicalPath();
        return (Strings.isBlank(hp) ? "" : hp + PATH_SEPARATOR) + getPath();
      }
    }
    return getPath();
  }
 
  @Override
  public IElephantEntity getParent() {
    if(getEntity() != null) {
      if(entity instanceof Attachment) {
        return ((Attachment) entity).getOwnerEntity();
      }
    }
    return null;
  }
 
  @Override
  public List<IElephantEntity> getChildren() {
    return Collections.EMPTY_LIST;
  }
 
  @Override
  public String getExtendedPath() {
    return AttachPU.getObjectExtendedPath(entity);
  }
 
  @Override
  public File getFile() {
    if(getEntity() != null) {
      if(entity instanceof Attachment) {
        try {
          File file = File.createTempFile("attach_", "_mail");
          AttachWd.writeToFile((Attachment) getEntity(), file);
          return file;
        } catch (IOException ex) {
          Logger.getLogger(AttachEntities.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
        }
      } else if(entity instanceof File) {
        return (File) entity;
      }
    }
    return null;
  }
 
  @Override
  public boolean showPath() {
    return false;
  }
 
  @Override
  public boolean showEntity() {
    if(getEntity() != null) {
      if(entity instanceof Attachment) {
        AttachmentUtil.download((Attachment) entity);
        return true;
      } else if(entity instanceof File) {
        new FileWrapper((File) entity).download();
        return true;
      }
    }
    return false;
  }
 
  @Override
  public boolean canEdit(IContact contact) {
    if(getEntity() != null) {
      if(entity instanceof Attachment) {
        return contact.getPermissions().isInRole("attach:list");
      } else if(entity instanceof File) {
        return contact.getPermissions().isInRole("file-attach:list");
      }
    }
    return false;
  }
 
  @Override
  public boolean canPublish(IContact contact) {
    if(getEntity() != null) {
      if(entity instanceof Attachment) {
        Attachment attachment = (Attachment) entity;
        return contact.getPermissions().isInRole("attach-show:all") ||
                (
                  attachment.isPublishable() &&
                  ((
                    attachment.isRequiresAcceptance() && 
                    attachment.getSingleStatus(contact).equals(AcceptanceSingleStatus.SINGLE_ACCEPTED)
                  ) || !attachment.isRequiresAcceptance())
                );
      } else if(entity instanceof File) {
        return true; // Controlled by owner entity
      }
    }
    return false;
  }
 
  @Override
  public Collection getEntitites(String search, int maxResults, KeyValueMap kvm) {
    ArrayList<Object> list = new ArrayList<>();
    list.addAll(searchAttachments(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 "attachment":
        list.addAll(searchAttachments(search, maxResults, kvm));
        break;
      default:
        break;
    }
    return list;
  }
 
  @Override
  public Object configureCtrl(Object ctrl, IContact contact) {
    return ctrl;
  }
 
  @Override
  public boolean canShowInContext(IContact contact, Object relatedEntity) {
    return true;
  }
 
  @Override
  public String getExtendedWebPath() {
    return null;
  }
 
  @Override
  public String getUserContext() {
    return null;
  }
 
  @Override
  protected Dao createDao() {
    return new AttachPU();
  }
 
  @Override
  protected boolean itsMine(String rootPath) {
    return super.itsMine(rootPath) || "file".equals(rootPath);
  }
 
  @Override
  protected boolean itsMine(Object entity) {
    return (entity instanceof Attachment) || (entity instanceof File);
  }
 
  @Override
  public Collection<String> getAllowedRoots() {
    return Arrays.asList("attachment", "file");
  }
 
  @Override
  protected IElephantEntity createInstance(String entityPath) {
    return new AttachEntities(entityPath);
  }
 
  @Override
  protected IElephantEntity createInstance(Object entity) {
    return new AttachEntities(entity);
  }
 
  @Override
  protected Path createPath() {
    return new Path(AttachPU.getObjectPath(entity));
  }
 
  private List<Object> searchAttachments(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from Attachment c");
    wc.addClause("where c.fileName like :search");
    wc.addClause("order by c.fileName");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
  private String getMimeImage(Object object) {
    if(object instanceof Attachment) {
      Attachment attachment = (Attachment) object;
      if(new File(ElephantContext.getRealPath("/_internal/system/mime/" + attachment.getFileExtension() + ".png")).exists()) {
        return "/_internal/system/mime/" + attachment.getFileExtension() + ".png";
      }
    } else if(object instanceof File) {
      File file = (File) object;
      if(file.exists()) {
        return "/_internal/system/mime/" + FileUtil.getExtension(file) + ".png";
      }
    }
    return "/_internal/system/mime/empty.png";
  }
 
}