reformat
[jSite2.git] / src / net / pterodactylus / jsite / project / Project.java
index 36a27f9..22e66d8 100644 (file)
@@ -22,10 +22,12 @@ package net.pterodactylus.jsite.project;
 import java.beans.PropertyChangeListener;
 import java.io.File;
 import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 import net.pterodactylus.util.beans.AbstractBean;
-import net.pterodactylus.util.io.MimeTypes;
 
 /**
  * Container for project information. A Project is capable of notifying
@@ -50,8 +52,8 @@ public class Project extends AbstractBean {
        /** Name of the “base path” property. */
        public static final String PROPERTY_BASE_PATH = "basePath";
 
-       /** Name of the “base path entries” property. */
-       public static final String PROPERTY_BASE_PATH_ENTRIES = "basePathEntries";
+       /** Name of the “default file” property. */
+       public static final String PROPERTY_DEFAULT_FILE = "defaultFile";
 
        /** Internal ID. */
        private String id;
@@ -71,11 +73,14 @@ public class Project extends AbstractBean {
        /** The base path of the project. */
        private String basePath;
 
-       /** The list of files from the base path. */
-       private List<Entry> basePathEntries = new ArrayList<Entry>();
+       /** The default file. */
+       private String defaultFile;
 
-       /** The list of virtual files. */
-       private List<Entry> virtualEntries = new ArrayList<Entry>();
+       /** The overrides. */
+       private final Map<String, FileOverride> fileOverrides = new HashMap<String, FileOverride>();
+
+       /** The current root project file. */
+       private ProjectFileImpl rootProjectFile;
 
        /**
         * Creates a new project.
@@ -95,8 +100,6 @@ public class Project extends AbstractBean {
                this.publicKey = project.publicKey;
                this.privateKey = project.privateKey;
                this.basePath = project.basePath;
-               this.basePathEntries.addAll(project.basePathEntries);
-               this.virtualEntries.addAll(project.virtualEntries);
        }
 
        /**
@@ -224,51 +227,146 @@ public class Project extends AbstractBean {
        }
 
        /**
-        * Rescans the base path for new or changed files.
+        * Returns the default file.
+        * 
+        * @return The default file
         */
-       public void rescanBasePath() {
-               List<Entry> entries = new ArrayList<Entry>();
-               scanPath("", entries);
-               basePathEntries.clear();
-               basePathEntries.addAll(entries);
-               firePropertyChange(PROPERTY_BASE_PATH_ENTRIES, null, null);
+       public String getDefaultFile() {
+               return defaultFile;
        }
 
        /**
-        * Returns the list of files from the base path.
+        * Sets the default file.
         * 
-        * @return The list of files from the base path
+        * @param defaultFile
+        *            The default file
         */
-       public List<Entry> getBasePathEntries() {
-               return basePathEntries;
+       public void setDefaultFile(String defaultFile) {
+               String oldDefaultFile = this.defaultFile;
+               this.defaultFile = defaultFile;
+               fireIfPropertyChanged(PROPERTY_DEFAULT_FILE, oldDefaultFile, defaultFile);
        }
 
        /**
-        * Returns the list of visual entries.
+        * Adds a file override for the given file.
         * 
-        * @return The visual entries
+        * @param projectFile
+        *            The file
+        * @param override
+        *            The override for the file
         */
-       public List<Entry> getVirtualEntries() {
-               return virtualEntries;
+       public void addFileOverride(ProjectFile projectFile, FileOverride override) {
+               addFileOverride(projectFile.getCompletePath(), override);
        }
 
        /**
-        * Adds a virtual entry that redirects to the given target.
+        * Adds a file override for the given file.
         * 
-        * @param name
-        *            The name of the entry
-        * @param contentType
-        *            The content type of the entry, or <code>null</code> for
-        *            auto-detection
-        * @param target
-        *            The target URI of the redirect
+        * @param filePath
+        *            The file path
+        * @param override
+        *            The override for the file
+        */
+       public void addFileOverride(String filePath, FileOverride override) {
+               fileOverrides.put(filePath, override);
+       }
+
+       /**
+        * Removes the file override for the given file.
+        * 
+        * @param projectFile
+        *            The file for which to remove the override
+        */
+       public void removeFileOverride(ProjectFile projectFile) {
+               removeFileOverride(projectFile.getCompletePath());
+       }
+
+       /**
+        * Removes the file override for the given file.
+        * 
+        * @param filePath
+        *            The file path for which to remove the override
+        */
+       public void removeFileOverride(String filePath) {
+               fileOverrides.remove(filePath);
+       }
+
+       /**
+        * Returns the file override for the given file.
+        * 
+        * @param projectFile
+        *            The file for which to get the override
+        * @return The file override, or <code>null</code> if the given file does
+        *         not have an override
+        */
+       public FileOverride getFileOverride(ProjectFile projectFile) {
+               return getFileOverride(projectFile.getCompletePath());
+       }
+
+       /**
+        * Returns the file override for the given file.
+        * 
+        * @param filePath
+        *            The file path for which to get the override
+        * @return The file override, or <code>null</code> if the given file does
+        *         not have an override
+        */
+       public FileOverride getFileOverride(String filePath) {
+               return fileOverrides.get(filePath);
+       }
+
+       /**
+        * Returns the list of {@link FileOverride}s.
+        * 
+        * @return All file overrides
+        */
+       public Map<String, FileOverride> getFileOverrides() {
+               return fileOverrides;
+       }
+
+       /**
+        * Scans the base path for files and returns the {@link ProjectFile} for the
+        * base path. From this file it is possible to reach all files in the base
+        * path. This method is disk-intensive and may take some time on larger
+        * directories!
+        * 
+        * @return The file for the base path, or <code>null</code> if the base
+        *         path does not denote an existing directory
+        */
+       public ProjectFile getBaseFile() {
+               File basePathFile = new File(basePath);
+               if (!basePathFile.exists() || !basePathFile.isDirectory()) {
+                       return null;
+               }
+               rootProjectFile = new ProjectFileImpl(null, "", 0, true, false);
+               scanDirectory(basePathFile, rootProjectFile);
+               return rootProjectFile;
+       }
+
+       /**
+        * Returns the file that is specified by its complete path.
+        * 
+        * @param completePath
+        *            The complete path of the file
+        * @return The project file at the given path, or <code>null</code> if
+        *         there is no such file
         */
-       public void addVirtualEntry(String name, String contentType, String target) {
-               RedirectEntry redirectEntry = new RedirectEntry();
-               redirectEntry.setName(name);
-               redirectEntry.setContentType(contentType);
-               redirectEntry.setTarget(target);
-               redirectEntry.setInsert(true);
+       public ProjectFile getFile(String completePath) {
+               if (rootProjectFile == null) {
+                       getBaseFile();
+               }
+               if ((rootProjectFile == null) || (completePath.length() == 0)) {
+                       return rootProjectFile;
+               }
+               String[] pathParts = completePath.split("\\" + File.separator);
+               ProjectFileImpl currentProjectFile = rootProjectFile;
+               for (String pathPart : pathParts) {
+                       currentProjectFile = currentProjectFile.getFile(pathPart);
+                       if (currentProjectFile == null) {
+                               return null;
+                       }
+               }
+               return currentProjectFile;
        }
 
        //
@@ -276,38 +374,222 @@ public class Project extends AbstractBean {
        //
 
        /**
-        * Scans the given path relative to {@link #basePath} for files and adds
-        * them to the given list of entries.
+        * Scans the given directory and recreates the file and directory structure
+        * in the given project file.
         * 
-        * @param currentPath
-        *            The current path, relative to the base path
-        * @param entries
-        *            The list of entries
+        * @param directory
+        *            The directory to scan
+        * @param projectFile
+        *            The project file in which to recreate the directory and file
+        *            structure
         */
-       private void scanPath(String currentPath, List<Entry> entries) {
-               File currentDirectory = new File(basePath + File.separatorChar + currentPath);
-               if (!currentDirectory.isDirectory()) {
+       private void scanDirectory(File directory, ProjectFileImpl projectFile) {
+               if (!directory.isDirectory()) {
                        return;
                }
-               for (File file: currentDirectory.listFiles()) {
-                       String fileName = currentPath + file.getName();
+               for (File file : directory.listFiles()) {
+                       ProjectFileImpl projectFileChild = projectFile.addFile(file.getName(), file.length(), file.isDirectory(), file.isHidden());
                        if (file.isDirectory()) {
-                               scanPath(fileName + File.separatorChar, entries);
-                               continue;
+                               scanDirectory(file, projectFileChild);
+                       }
+               }
+               projectFile.sort();
+       }
+
+       /**
+        * Implementation of a {@link ProjectFile}.
+        * 
+        * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
+        */
+       private static class ProjectFileImpl implements ProjectFile, Comparable<ProjectFileImpl> {
+
+               /** The parent of this project file. */
+               private final ProjectFileImpl parentProjectFile;
+
+               /** The name of this project file. */
+               private final String name;
+
+               /** The size of the file. */
+               private final long size;
+
+               /** Whether this project file is a directory. */
+               private final boolean directory;
+
+               /** Whether this file is hidden. */
+               private final boolean hidden;
+
+               /** This project file’s children. */
+               private List<ProjectFileImpl> childProjectFiles = new ArrayList<ProjectFileImpl>();
+
+               /**
+                * Creates a new project fie.
+                * 
+                * @param parentProjectFile
+                *            The parent of the project file, or <code>null</code> if
+                *            the new project file does not have a parent
+                * @param name
+                *            The name of the project file
+                * @param size
+                *            The size of the file
+                * @param isDirectory
+                *            <code>true</code> if this project file is a directory,
+                *            <code>false</code> otherwise
+                * @param isHidden
+                *            <code>true</code> if this project file is hidden,
+                *            <code>false</code> otherwise
+                */
+               ProjectFileImpl(ProjectFileImpl parentProjectFile, String name, long size, boolean isDirectory, boolean isHidden) {
+                       this.parentProjectFile = parentProjectFile;
+                       this.name = name;
+                       this.size = size;
+                       this.directory = isDirectory;
+                       this.hidden = isHidden;
+               }
+
+               //
+               // INTERFACE ProjectFile
+               //
+
+               /**
+                * @see net.pterodactylus.jsite.project.ProjectFile#getName()
+                */
+               public String getName() {
+                       return name;
+               }
+
+               /**
+                * @see net.pterodactylus.jsite.project.ProjectFile#getParent()
+                */
+               public ProjectFile getParent() {
+                       return parentProjectFile;
+               }
+
+               /**
+                * {@inheritDoc}
+                */
+               public long getSize() {
+                       return size;
+               }
+
+               /**
+                * @see net.pterodactylus.jsite.project.ProjectFile#getParents()
+                */
+               public List<ProjectFile> getParents() {
+                       List<ProjectFile> parentProjectFiles = new ArrayList<ProjectFile>();
+                       ProjectFileImpl currentProjectFile = this;
+                       do {
+                               parentProjectFiles.add(0, currentProjectFile);
+                       } while ((currentProjectFile = currentProjectFile.parentProjectFile) != null);
+                       return parentProjectFiles;
+               }
+
+               /**
+                * {@inheritDoc}
+                */
+               /* TODO - caching? */
+               public String getCompletePath() {
+                       StringBuilder completePath = new StringBuilder();
+                       ProjectFileImpl currentProjectFile = this;
+                       while ((currentProjectFile != null) && (currentProjectFile.parentProjectFile != null)) {
+                               completePath.insert(0, currentProjectFile.getName()).insert(0, File.separatorChar);
+                               currentProjectFile = currentProjectFile.parentProjectFile;
+                       }
+                       return (completePath.length() > 0) ? completePath.substring(1) : "";
+               }
+
+               /**
+                * @see net.pterodactylus.jsite.project.ProjectFile#isFile()
+                */
+               public boolean isFile() {
+                       return !directory;
+               }
+
+               /**
+                * @see net.pterodactylus.jsite.project.ProjectFile#isDirectory()
+                */
+               public boolean isDirectory() {
+                       return directory;
+               }
+
+               /**
+                * @see net.pterodactylus.jsite.project.ProjectFile#isHidden()
+                */
+               public boolean isHidden() {
+                       return hidden;
+               }
+
+               /**
+                * Returns the project file with the given name. The project file has to
+                * be a direct child of this project file.
+                * 
+                * @param name
+                *            The name of the file to get
+                * @return The project file, or <code>null</code> if there is no
+                *         project file by that name
+                */
+               public ProjectFileImpl getFile(String name) {
+                       if (!isDirectory()) {
+                               return null;
                        }
-                       PhysicalEntry entry = new PhysicalEntry();
-                       entry.setName(fileName);
-                       entry.setPath(file.getPath());
-                       entry.setDefaultInsert(!file.isHidden());
-                       entry.setInsert(!file.isHidden());
-                       String extension = fileName.substring(fileName.lastIndexOf('.') + 1);
-                       List<String> mimeTypes = MimeTypes.getMimeTypes(extension);
-                       if (!mimeTypes.isEmpty()) {
-                               entry.setDefaultContentType(mimeTypes.get(0));
-                               entry.setContentType(mimeTypes.get(0));
+                       for (ProjectFileImpl projectFile : childProjectFiles) {
+                               if (projectFile.getName().equals(name)) {
+                                       return projectFile;
+                               }
                        }
-                       entries.add(entry);
+                       return null;
                }
+
+               /**
+                * @see net.pterodactylus.jsite.project.ProjectFile#getFiles()
+                */
+               public List<ProjectFile> getFiles() {
+                       List<ProjectFile> projectFiles = new ArrayList<ProjectFile>(childProjectFiles);
+                       return projectFiles;
+               }
+
+               //
+               // ACTIONS
+               //
+
+               /**
+                * Adds a new project file as child to this project file.
+                * 
+                * @param name
+                *            The name of the file
+                * @param size
+                *            The size of the file
+                * @param isDirectory
+                *            <code>true</code> if the new file is a directory,
+                *            <code>false</code> otherwise
+                * @param isHidden
+                *            <code>true</code> if the new file is hidden,
+                *            <code>false</code> otherwise
+                * @return The created project file
+                */
+               public ProjectFileImpl addFile(String name, long size, boolean isDirectory, boolean isHidden) {
+                       ProjectFileImpl newProjectFile = new ProjectFileImpl(this, name, size, isDirectory, isHidden);
+                       childProjectFiles.add(newProjectFile);
+                       return newProjectFile;
+               }
+
+               /**
+                * Sorts the children of this file.
+                */
+               public void sort() {
+                       Collections.sort(childProjectFiles);
+               }
+
+               //
+               // INTERFACE Comparable
+               //
+
+               /**
+                * {@inheritDoc}
+                */
+               public int compareTo(ProjectFileImpl otherProjectFileImpl) {
+                       return name.compareTo(otherProjectFileImpl.name);
+               }
+
        }
 
 }