FileControl.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2015 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.file.zul.control;
 
import java.io.File;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.turro.string.Strings;
import org.apache.commons.io.FileUtils;
import org.turro.action.IEntityHolder;
import org.turro.elephant.context.Application;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.util.Messages;
import org.turro.entities.Entities;
import org.turro.entities.IElephantEntity;
import org.turro.file.util.FileAttach;
import org.turro.file.zul.FileClipboard;
import org.turro.file.zul.navigator.FileFolder;
import org.turro.file.zul.navigator.FileNavigatorGrid;
import org.turro.file.zul.navigator.FileTree;
import org.turro.i18n.I_;
import org.turro.util.Chars;
import org.turro.mail.recipients.SendAttachments;
import org.turro.zip.Compress;
import org.zkoss.zk.ui.Executions;
import org.zkoss.zk.ui.IdSpace;
import org.zkoss.zk.ui.event.UploadEvent;
import org.zkoss.zk.ui.ext.AfterCompose;
import org.zkoss.zk.ui.select.Selectors;
import org.zkoss.zk.ui.select.annotation.Listen;
import org.zkoss.zk.ui.select.annotation.Wire;
import org.zkoss.zul.Filedownload;
import org.zkoss.zul.Menuitem;
import org.zkoss.zul.Panel;
import org.zkoss.zul.Textbox;
import org.zkoss.zul.Toolbarbutton;
import org.zkoss.zul.West;
 
public class FileControl extends Panel implements IEntityHolder, IdSpace, AfterCompose {
 
  private static final String SECURED = "/#secure#/#forbidden#";
  
  private boolean publicOnly, readOnly, treeCollapsed, entity;
  private FileFolder currentFolder;
  private String label, path;
  private FileResults results;
  
  @Wire("#panelFolder")
  private West panelFolder;
 
  @Wire("#searchValue")
  private Textbox searchValue;
  
  @Wire("#regexp")
  private Menuitem regexp;
  
  @Wire("#fullpath")
  private Menuitem fullpath;
  
  @Wire("#partial")
  private Menuitem partial;
  
  @Wire("#levelUp")
  private Toolbarbutton levelUp;
  
  @Wire("#newFolder")
  private Toolbarbutton newFolder;
  
  @Wire("#upload")
  private Toolbarbutton upload;
  
  @Wire("#send")
  private Toolbarbutton send;
 
  @Wire("#download")
  private Toolbarbutton download;
 
  @Wire("#copy")
  private Toolbarbutton copy;
 
  @Wire("#cut")
  private Toolbarbutton cut;
 
  @Wire("#paste")
  private Toolbarbutton paste;
  
  @Wire("#delete")
  private Toolbarbutton delete;
  
  @Wire("#treeFolder")
  private FileTree treeFolder;
  
  @Wire("#fileGrid")
  private FileNavigatorGrid fileGrid;
  
  @Listen("onChange = #treeFolder")
  public void onChangeFolder() {
    currentFolder = (FileFolder) treeFolder.getSelectedFolder().getParentFolder();
    if(currentFolder == null) {
      treeFolder.reloadContents();
      treeFolder.selectFirst();
      currentFolder = treeFolder.getSelectedFolder();
    } else {
      currentFolder.reloadContents();
      fileGrid.setCurrentFolder(currentFolder);
    }
    updateButtons();
  }
  
  @Listen("onSelect = #treeFolder")
  public void onSelectFolder() {
    currentFolder = treeFolder.getSelectedFolder();
    updateButtons();
    fileGrid.setCurrentFolder(currentFolder);
  }
  
  @Listen("onChange = #searchValue")
  public void onSearchValue() {
    results.setSearchValue(searchValue.getValue());
  }
  
  @Listen("onCheck = #regexp")
  public void onRegexp() {
    results.setRegexp(regexp.isChecked());
  }
  
  @Listen("onCheck = #fullpath")
  public void onFullpath() {
    results.setPath(fullpath.isChecked());
  }
  
  @Listen("onCheck = #partial")
  public void onPartial() {
    results.setPartial(partial.isChecked());
  }
  
  @Listen("onClick = #search; onOK = #searchValue")
  public void onSearch() {
    treeFolder.reloadContents();
    selectFirst();
  }
  
  @Listen("onClick = #levelUp")
  public void onLevelUp() throws Exception {
    if(currentFolder != null && currentFolder.getParentItem() != null) {
      currentFolder = (FileFolder) currentFolder.getParentItem();
      treeFolder.setSelectedItem(currentFolder);
      fileGrid.setCurrentFolder(currentFolder);
      updateButtons();
    }
  }
 
  @Listen("onClick = #newFolder")
  public void onNewFolder() throws Exception {
    if(currentFolder != null) {
      currentFolder.doAddFolder();
      currentFolder.reloadContents();
      fileGrid.setCurrentFolder(currentFolder);      
    }
  }
 
  @Listen("onUpload = #upload")
  public void onUpload(UploadEvent event) throws Exception {
    if(currentFolder != null) {
      currentFolder.addMedias(event.getMedias());
      fileGrid.setCurrentFolder(currentFolder);
    }
  }
    
  @Listen("onClick = #send")
  public void onSend() throws Exception {
    SendAttachments sa = new SendAttachments(I_.get("Attachment")) {
      @Override
      protected void fillAttachment(File attachment, Object entity) {
        try {
          FileUtils.copyFile((File) entity, attachment);
        } catch (IOException ex) {
          Logger.getLogger(FileControl.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
        }
      }
    };
    FileFolder af = fileGrid.getCurrentFolder();
    if(af != null) {
      for(File file : af.getFiles()) {
        sa.addAttachment(file, file.getName(), file.getName());
      }
    }
    sa.sendAttachments(null);
  }
  
  @Listen("onClick = #download")
  public void onDownload() throws Exception {
    FileFolder af = fileGrid.getCurrentFolder();
    if(af != null) {
      File targetZip  = File.createTempFile("attach_", "_folder.zip");
      Compress.zip(af.getRealFolder().toPath(), targetZip.toPath());
      Filedownload.save(targetZip, "application/zip");
    }
  }
  
  @Listen("onClick = #copy")
  public void onCopy() throws Exception {
    FileClipboard.copyFolder(currentFolder.getRealFolder());
  }
    
  @Listen("onClick = #cut")
  public void onCut() throws Exception {
    FileClipboard.cutFolder(currentFolder.getLabel(), currentFolder.getRealFolder());
  }
 
  @Listen("onClick = #paste")
  public void onPaste() throws Exception {
    FileClipboard.paste(currentFolder.getRealFolder());
    treeFolder.setSelectedItem(currentFolder);
    currentFolder.reloadContents();
    fileGrid.setCurrentFolder(currentFolder);
    paste.setDisabled(true);
  }
 
  @Listen("onClick = #delete")
  public void onDelete() throws Exception {
    if(Application.getApplication().isInRole("file-attach:delete")) {
      Messages.confirmDeletion().show(() -> {
        for(File f : currentFolder.getFiles()) {
          f.delete();
          if(treeFolder.getFileListener() != null) {
            treeFolder.getFileListener().deleteDone(f);
          }
        }
        treeFolder.setSelectedItem(currentFolder);
        fileGrid.setCurrentFolder(currentFolder);
      });
    }
  }
 
  @Listen("onUpload = #dropUpload")
  public void onEvent(UploadEvent event) throws Exception {
    if(currentFolder != null) {
      currentFolder.addMedias(event.getMedias());
      fileGrid.setCurrentFolder(currentFolder);
    }
  }
 
  public FileControl() {
    Executions.createComponents("/WEB-INF/_zul/bs/comps/attachment/fileControl.zul", this, null);
    Selectors.wireComponents(this, this, false);
    Selectors.wireEventListeners(this, this);
    path = SECURED;
  }
 
  public Boolean getPublicOnly() {
    return publicOnly;
  }
 
  public void setPublicOnly(Boolean publicOnly) {
    this.publicOnly = publicOnly;
  }
 
  public boolean isReadOnly() {
    return readOnly;
  }
 
  public void setReadOnly(boolean readOnly) {
    this.readOnly = readOnly;
  }
 
  public boolean isTreeCollapsed() {
    return treeCollapsed;
  }
 
  public void setTreeCollapsed(boolean treeCollapsed) {
    this.treeCollapsed = treeCollapsed;
  }
 
  public String getLabel() {
    return label;
  }
 
  public void setLabel(String label) {
    this.label = label;
  }
 
  public String getPath() {
    return path;
  }
 
  public void setPath(String path) {
    this.path = path;
    treeFolder.resetTree();
  }
 
  @Override
  public void setEntity(Object entity) {
    IElephantEntity iee = Entities.getController(entity);
    path = iee.getPath();
    this.entity = true;
    if(Strings.isBlank(path)) {
      path = SECURED;
    } else {
      label = iee.getName();
    }
    treeFolder.setDoProcessors(false);
    treeFolder.resetTree();
    fileGrid.setCurrentFolder(null);
  }
 
  @Override
  public void refreshControls() {
    afterCompose();
  }
 
  public FileTree getTreeFolder() {
    return treeFolder;
  }
  
  @Override
  public void afterCompose() {
    initResults();
    initComponents();
    panelFolder.setOpen(!treeCollapsed);
    if(!SECURED.equals(path)) {
      if(entity) {
        FileFolder publicFolder = treeFolder.addFolder(I_.get("Publishable") + 
                Chars.forward().spaced().toString() + label, new FileAttach(path).getPublishable(), true);
        panelFolder.setTitle(label);
        publicFolder.showContents();
        if(Application.getApplication().isInRole("file-attach:private")) {
          FileFolder privateFolder = treeFolder.addFolder(label, new FileAttach(path).getPrivate(), true);
          panelFolder.setTitle(label);
          privateFolder.showContents();
        }
      } else {
        if(!Strings.isBlank(path)) {
          String[] paths = path.split("\\|");
          String[] labels = label.split("\\|");
          for(int i = 0; i < paths.length; i++) {
            FileFolder rootFolder = treeFolder.addFolder(labels[i], paths[i], true);
            panelFolder.setTitle(labels[i]);
            rootFolder.showContents();
          }
        }
      }
      selectFirst();
      delete.setDisabled(!Application.getApplication().isInRole("file-attach:delete") || readOnly);
    } else {
      panelFolder.setTitle("");
      treeFolder.resetTree();
      fileGrid.setCurrentFolder(null);
      newFolder.setDisabled(true);
      upload.setDisabled(true);
      send.setDisabled(true);
      levelUp.setDisabled(true);
      copy.setDisabled(true);
      cut.setDisabled(true);
      paste.setDisabled(true);
      delete.setDisabled(true);
    }
  }
 
  private void initResults() {
    results = new FileResults();
  }
 
  private void initComponents() {
    treeFolder.setResults(results);
    searchValue.setValue(results.getSearchValue());
    regexp.setChecked(results.isRegexp());
    fullpath.setChecked(results.isPath());
    partial.setChecked(results.isPartial());
    fileGrid.setReadOnly(readOnly);
    updateButtons();
  }
 
  public void selectFirst() {
    currentFolder = treeFolder.selectFirst();
    updateButtons();
    fileGrid.setCurrentFolder(currentFolder);
  }
 
  private void updateButtons() {
    newFolder.setDisabled(currentFolder == null || readOnly);
    upload.setDisabled(currentFolder == null || readOnly);
    send.setDisabled(currentFolder == null || !Application.getApplication().isInRole("attach:validate"));
    download.setDisabled(currentFolder == null || !Application.getApplication().isInRole("attach:validate"));
    levelUp.setDisabled(currentFolder == null || currentFolder.getParentItem() == null);
    copy.setDisabled(currentFolder == null);
    cut.setDisabled(currentFolder == null || readOnly);
    paste.setDisabled(!FileClipboard.hasClipboard() || readOnly);
    if(delete != null && Application.getApplication().isInRole("file-attach:delete")) {
      delete.setDisabled(currentFolder == null || currentFolder.getParentFolder() == null || readOnly);
    }
  }
}