FileDocument.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2011 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.elephant.documents;
 
import java.io.File;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.Properties;
import java.util.Set;
import java.util.TreeSet;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.amic.util.string.Cipher;
import org.turro.elephant.context.ElephantContext;
 
public class FileDocument extends File {
  private DocumentsRoot docsRoot = null;
  private FileDocument parentDoc;
  private FileDocument[] children = null;
  private int level = 0;
  
  public FileDocument(DocumentsRoot docsRoot, FileDocument parentDoc, String pathName) {
    super(pathName);
    this.docsRoot = docsRoot;
    this.parentDoc = parentDoc;
    this.level = (parentDoc != null ? parentDoc.getLevel() + 1 : 0);
  }
 
  public DocumentsRoot getDocumentsRoot() {
    return docsRoot;
  }
 
  public FileDocument getParentDoc() {
    return parentDoc;
  }
 
  public int getLevel() {
    return level;
  }
  
  public boolean getCanNew() {
    return docsRoot.getCanNew();
  }
  
  public boolean getCanDelete() {
    return docsRoot.getCanDelete();
  }
  
  public boolean getCanNewFolder() {
    return docsRoot.getCanNewFolder();
  }
  
  public boolean getCanDelFolder() {
    return docsRoot.getCanDelFolder();
  }
  
  public FileDocument[] getListDocuments() {
    FileDocument tmp;
    if(children == null) {
      Set s = new TreeSet(new FileComparator());
      if(exists()) {
        File[] fs = listFiles();
        for(int i = 0; i < fs.length; i++) {
          if(!fs[i].getName().startsWith(".")) {
            tmp = new FileDocument(docsRoot, this, fs[i].getPath());
            String role = tmp.readConfig("root.role", false);
            if((role == null || docsRoot.getDocumentsBean().getConstructor().isInRole(role)) && tmp.getSomethingToShow()) {
              s.add(tmp);
            }
          }
        }
      }
      children = (FileDocument[]) s.toArray(new FileDocument[0]);
    }
    return children;
  }
  
  public FileDocument[] getListFolders() {
    FileDocument tmp;
    Set s = new TreeSet(new FileComparator());
    if(exists()) {
      File[] fs = listFiles();
      for(int i = 0; i < fs.length; i++) {
        if(!fs[i].getName().startsWith(".") && fs[i].isDirectory()) {
          tmp = new FileDocument(docsRoot, this, fs[i].getPath());
          String role = tmp.readConfig("root.role", false);
          if(role == null || docsRoot.getDocumentsBean().getConstructor().isInRole(role)) {
            s.add(tmp);
          }
        }
      }
    }
    return (FileDocument[]) s.toArray(new FileDocument[0]);
  }
  
  public FileDocument[] getNotValidated() {
    FileDocument tmp;
    Set s = new TreeSet(new FileComparator());
    if(exists()) {
      File[] fs = listFiles();
      for(int i = 0; i < fs.length; i++) {
        if(fs[i].isDirectory() || (fs[i].isHidden() && !".docs.properties".equals(fs[i].getName()))) {
          tmp = new FileDocument(docsRoot, this, fs[i].getPath());
          String role = tmp.readConfig("root.role", false);
          if(role == null || docsRoot.getDocumentsBean().getConstructor().isInRole(role)) {
            s.add(tmp);
          }
        }
      }
    }
    return (FileDocument[]) s.toArray(new FileDocument[0]);
  }
  
  public String getFormattedName() {
    String result = isFile() ? null : readConfig("root.name", false);
    if(result == null) {
      result = "";
      String tmp = getName();
      if(tmp.startsWith(".")) tmp = tmp.substring(1);
      int p = tmp.lastIndexOf(".");
      if(p > -1) tmp = tmp.substring(0, p);
      String s[] = tmp.split("\\_");
      for(int i = 0; i < s.length; i++) {
      // append an space if there is already content
        if(result.length() > 0) result += " - ";
        // this part could be the period phase
        if(s[i].matches("[0-9]*")) {
          switch(s[i].length()) {
            case 12:  
              result += docsRoot.getDocumentsBean().getLocalizer().parseString("date", "yyyyMMddHHmm", "date_time", s[i]);
              break;
            case 8:  
              result += docsRoot.getDocumentsBean().getLocalizer().parseString("date", "yyyyMMdd", "full", s[i]);
              break;
            case 6:  
              result += docsRoot.getDocumentsBean().getLocalizer().parseString("date", "yyyyMM", "month_year", s[i]);
              break;
            case 4:  
              result += docsRoot.getDocumentsBean().getLocalizer().parseString("date", "yyyy", "year", s[i]);
              break;
            case 2:
              result += docsRoot.getDocumentsBean().getLocalizer().parseString("date", "yy", "year", s[i]);
              break;
          }
        }
        // otherwise name phase
        else {
          tmp = readConfig("name." + s[i]);
          result += (tmp == null ? s[i] : tmp);
        }          
      }
    }
    if(result == null) result = getName();
    if(isFile() && "true".equals(readConfig("file.size"))) {
      result += " [" + docsRoot.getDocumentsBean().getLocalizer().parseValue("bytes", null, new Long(length())) + "]";
    }
    return result;
  }
  
  public String getFormattedPath() {
    String result = "";
    FileDocument p = isFile() ? getParentDoc() : this;
    while(p != null) {
      result = p.getFormattedName() + " / " + result;
      p = p.getParentDoc();
    }
    return result;
  }
  
  public String getRelativeURL() {
    try {
      return docsRoot.getDownloadURL() + "&down_file=" + URLEncoder.encode(docsRoot.getRelativePath(getPath()), "UTF-8");
    } catch (UnsupportedEncodingException ex) {
      Logger.getLogger(FileDocument.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
    return null;
  }
  
  public String getUniqueId() {
    return Cipher.digest(getPath(), 40);    
  }
  
  public String getExtension() {
    String name = getName();
    int p = name.lastIndexOf(".");
    if(p > -1) return name.substring(p + 1).toLowerCase();
    return "bin";
  }
  
  public boolean getSomethingToShow() {
    return isFile() || getListDocuments().length > 0;
  }
  
  public String readConfig(String property) {
    return readConfig(property, true);
  }
 
  public String readConfig(String property, boolean moveUp) {
    String result = null;
    File startPoint = this;
    if(isFile()) {
      startPoint = getParentDoc();
    }
    Properties props = docsRoot.getDocumentsBean().getPropertiesFile(startPoint.getAbsolutePath() + "/.docs.properties");
    if(props != null) {
      result = props.getProperty(property);
    }
    if(moveUp && result == null) {
      if(getParentDoc() != null) {
        result = getParentDoc().readConfig(property);
      }
      else {
        result = docsRoot.readRootConfig(property);
      }
    }
    return result;
  }
 
}