2 * jSite2 - Project.java -
3 * Copyright © 2008 David Roden
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 package net.pterodactylus.jsite.project;
22 import java.beans.PropertyChangeListener;
24 import java.util.ArrayList;
25 import java.util.Collections;
26 import java.util.HashMap;
27 import java.util.List;
30 import net.pterodactylus.util.beans.AbstractBean;
33 * Container for project information. A Project is capable of notifying
34 * {@link PropertyChangeListener}s if any of the contained properties change.
36 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
38 public class Project extends AbstractBean {
40 /** Name of the “name” property. */
41 public static final String PROPERTY_NAME = "name";
43 /** Name of the “description” property. */
44 public static final String PROPERTY_DESCRIPTION = "description";
46 /** Name of the “public key” property. */
47 public static final String PROPERTY_PUBLIC_KEY = "publicKey";
49 /** Name of the “private key” property. */
50 public static final String PROPERTY_PRIVATE_KEY = "privateKey";
52 /** Name of the “base path” property. */
53 public static final String PROPERTY_BASE_PATH = "basePath";
55 /** Name of the “default file” property. */
56 public static final String PROPERTY_DEFAULT_FILE = "defaultFile";
61 /** The name of the project. */
64 /** The description of the project. */
65 private String description;
67 /** The public key. */
68 private String publicKey;
70 /** The private key. */
71 private String privateKey;
73 /** The base path of the project. */
74 private String basePath;
76 /** The default file. */
77 private String defaultFile;
80 private final Map<String, FileOverride> fileOverrides = new HashMap<String, FileOverride>();
82 /** The current root project file. */
83 private ProjectFileImpl rootProjectFile;
86 * Creates a new project.
93 * Clones the given project.
97 Project(Project project) {
98 this.name = project.name;
99 this.description = project.description;
100 this.publicKey = project.publicKey;
101 this.privateKey = project.privateKey;
102 this.basePath = project.basePath;
106 * Returns the internal ID.
108 * @return The internal ID
115 * Sets the internal ID.
120 void setId(String id) {
125 * Returns the name of the project.
127 * @return The name of the project
129 public String getName() {
134 * Sets the name of the project.
137 * The name of the project
139 public void setName(String name) {
140 String oldName = this.name;
142 fireIfPropertyChanged(PROPERTY_NAME, oldName, name);
146 * Returns the description of the project.
148 * @return The description of the project
150 public String getDescription() {
155 * Sets the description of the project
158 * The description of the project
160 public void setDescription(String description) {
161 String oldDescription = this.description;
162 this.description = description;
163 fireIfPropertyChanged(PROPERTY_DESCRIPTION, oldDescription, description);
167 * Returns the public key of the project.
169 * @return The public key of the project
171 public String getPublicKey() {
176 * Sets the public key of the project.
179 * The public key of the project
181 void setPublicKey(String publicKey) {
182 String oldPublicKey = this.publicKey;
183 this.publicKey = publicKey;
184 fireIfPropertyChanged(PROPERTY_PUBLIC_KEY, oldPublicKey, publicKey);
188 * Returns the private key of the project.
190 * @return The private key of the project
192 public String getPrivateKey() {
197 * Sets the private key of the project.
200 * The private key of the project
202 void setPrivateKey(String privateKey) {
203 String oldPrivateKey = this.privateKey;
204 this.privateKey = privateKey;
205 fireIfPropertyChanged(PROPERTY_PRIVATE_KEY, oldPrivateKey, privateKey);
209 * Returns the base path of the project.
211 * @return The base path of the project
213 public String getBasePath() {
218 * Sets the base path of the project.
221 * The base path of the project
223 public void setBasePath(String basePath) {
224 String oldBasePath = this.basePath;
225 this.basePath = basePath;
226 fireIfPropertyChanged(PROPERTY_BASE_PATH, oldBasePath, basePath);
230 * Returns the default file.
232 * @return The default file
234 public String getDefaultFile() {
239 * Sets the default file.
244 public void setDefaultFile(String defaultFile) {
245 String oldDefaultFile = this.defaultFile;
246 this.defaultFile = defaultFile;
247 fireIfPropertyChanged(PROPERTY_DEFAULT_FILE, oldDefaultFile, defaultFile);
251 * Adds a file override for the given file.
256 * The override for the file
258 public void addFileOverride(ProjectFile projectFile, FileOverride override) {
259 addFileOverride(projectFile.getCompletePath(), override);
263 * Adds a file override for the given file.
268 * The override for the file
270 public void addFileOverride(String filePath, FileOverride override) {
271 fileOverrides.put(filePath, override);
275 * Removes the file override for the given file.
278 * The file for which to remove the override
280 public void removeFileOverride(ProjectFile projectFile) {
281 removeFileOverride(projectFile.getCompletePath());
285 * Removes the file override for the given file.
288 * The file path for which to remove the override
290 public void removeFileOverride(String filePath) {
291 fileOverrides.remove(filePath);
295 * Returns the file override for the given file.
298 * The file for which to get the override
299 * @return The file override, or <code>null</code> if the given file does
300 * not have an override
302 public FileOverride getFileOverride(ProjectFile projectFile) {
303 return getFileOverride(projectFile.getCompletePath());
307 * Returns the file override for the given file.
310 * The file path for which to get the override
311 * @return The file override, or <code>null</code> if the given file does
312 * not have an override
314 public FileOverride getFileOverride(String filePath) {
315 return fileOverrides.get(filePath);
319 * Returns the list of {@link FileOverride}s.
321 * @return All file overrides
323 public Map<String, FileOverride> getFileOverrides() {
324 return fileOverrides;
328 * Scans the base path for files and returns the {@link ProjectFile} for the
329 * base path. From this file it is possible to reach all files in the base
330 * path. This method is disk-intensive and may take some time on larger
333 * @return The file for the base path, or <code>null</code> if the base
334 * path does not denote an existing directory
336 public ProjectFile getBaseFile() {
337 File basePathFile = new File(basePath);
338 if (!basePathFile.exists() || !basePathFile.isDirectory()) {
341 rootProjectFile = new ProjectFileImpl(null, "", 0, true, false);
342 scanDirectory(basePathFile, rootProjectFile);
343 return rootProjectFile;
347 * Returns the file that is specified by its complete path.
349 * @param completePath
350 * The complete path of the file
351 * @return The project file at the given path, or <code>null</code> if
352 * there is no such file
354 public ProjectFile getFile(String completePath) {
355 if (rootProjectFile == null) {
358 if ((rootProjectFile == null) || (completePath.length() == 0)) {
359 return rootProjectFile;
361 String[] pathParts = completePath.split("\\" + File.separator);
362 ProjectFileImpl currentProjectFile = rootProjectFile;
363 for (String pathPart: pathParts) {
364 currentProjectFile = currentProjectFile.getFile(pathPart);
365 if (currentProjectFile == null) {
369 return currentProjectFile;
377 * Scans the given directory and recreates the file and directory structure
378 * in the given project file.
381 * The directory to scan
383 * The project file in which to recreate the directory and file
386 private void scanDirectory(File directory, ProjectFileImpl projectFile) {
387 if (!directory.isDirectory()) {
390 for (File file: directory.listFiles()) {
391 ProjectFileImpl projectFileChild = projectFile.addFile(file.getName(), file.length(), file.isDirectory(), file.isHidden());
392 if (file.isDirectory()) {
393 scanDirectory(file, projectFileChild);
400 * Implementation of a {@link ProjectFile}.
402 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
404 private static class ProjectFileImpl implements ProjectFile, Comparable<ProjectFileImpl> {
406 /** The parent of this project file. */
407 private final ProjectFileImpl parentProjectFile;
409 /** The name of this project file. */
410 private final String name;
412 /** The size of the file. */
413 private final long size;
415 /** Whether this project file is a directory. */
416 private final boolean directory;
418 /** Whether this file is hidden. */
419 private final boolean hidden;
421 /** This project file’s children. */
422 private List<ProjectFileImpl> childProjectFiles = new ArrayList<ProjectFileImpl>();
425 * Creates a new project fie.
427 * @param parentProjectFile
428 * The parent of the project file, or <code>null</code> if
429 * the new project file does not have a parent
431 * The name of the project file
433 * The size of the file
435 * <code>true</code> if this project file is a directory,
436 * <code>false</code> otherwise
438 * <code>true</code> if this project file is hidden,
439 * <code>false</code> otherwise
441 ProjectFileImpl(ProjectFileImpl parentProjectFile, String name, long size, boolean isDirectory, boolean isHidden) {
442 this.parentProjectFile = parentProjectFile;
445 this.directory = isDirectory;
446 this.hidden = isHidden;
450 // INTERFACE ProjectFile
454 * @see net.pterodactylus.jsite.project.ProjectFile#getName()
456 public String getName() {
461 * @see net.pterodactylus.jsite.project.ProjectFile#getParent()
463 public ProjectFile getParent() {
464 return parentProjectFile;
470 public long getSize() {
475 * @see net.pterodactylus.jsite.project.ProjectFile#getParents()
477 public List<ProjectFile> getParents() {
478 List<ProjectFile> parentProjectFiles = new ArrayList<ProjectFile>();
479 ProjectFileImpl currentProjectFile = this;
481 parentProjectFiles.add(0, currentProjectFile);
482 } while ((currentProjectFile = currentProjectFile.parentProjectFile) != null);
483 return parentProjectFiles;
489 /* TODO - caching? */
490 public String getCompletePath() {
491 StringBuilder completePath = new StringBuilder();
492 ProjectFileImpl currentProjectFile = this;
493 while ((currentProjectFile != null) && (currentProjectFile.parentProjectFile != null)) {
494 completePath.insert(0, currentProjectFile.getName()).insert(0, File.separatorChar);
495 currentProjectFile = currentProjectFile.parentProjectFile;
497 return (completePath.length() > 0) ? completePath.substring(1) : "";
501 * @see net.pterodactylus.jsite.project.ProjectFile#isFile()
503 public boolean isFile() {
508 * @see net.pterodactylus.jsite.project.ProjectFile#isDirectory()
510 public boolean isDirectory() {
515 * @see net.pterodactylus.jsite.project.ProjectFile#isHidden()
517 public boolean isHidden() {
522 * Returns the project file with the given name. The project file has to
523 * be a direct child of this project file.
526 * The name of the file to get
527 * @return The project file, or <code>null</code> if there is no
528 * project file by that name
530 public ProjectFileImpl getFile(String name) {
531 if (!isDirectory()) {
534 for (ProjectFileImpl projectFile: childProjectFiles) {
535 if (projectFile.getName().equals(name)) {
543 * @see net.pterodactylus.jsite.project.ProjectFile#getFiles()
545 public List<ProjectFile> getFiles() {
546 List<ProjectFile> projectFiles = new ArrayList<ProjectFile>(childProjectFiles);
555 * Adds a new project file as child to this project file.
558 * The name of the file
560 * The size of the file
562 * <code>true</code> if the new file is a directory,
563 * <code>false</code> otherwise
565 * <code>true</code> if the new file is hidden,
566 * <code>false</code> otherwise
567 * @return The created project file
569 public ProjectFileImpl addFile(String name, long size, boolean isDirectory, boolean isHidden) {
570 ProjectFileImpl newProjectFile = new ProjectFileImpl(this, name, size, isDirectory, isHidden);
571 childProjectFiles.add(newProjectFile);
572 return newProjectFile;
576 * Sorts the children of this file.
579 Collections.sort(childProjectFiles);
583 // INTERFACE Comparable
589 public int compareTo(ProjectFileImpl otherProjectFileImpl) {
590 return name.compareTo(otherProjectFileImpl.name);