src/net/pterodactylus/jsite/core/ProjectManager.java

   1 /*
   2  * jSite2 - ProjectManager.java -
   3  * Copyright © 2008 David Roden
   4  *
   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.
   9  *
  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.
  14  *
  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.
  18  */
  19
  20 package net.pterodactylus.jsite.core;
  21
  22 import java.beans.PropertyChangeEvent;
  23 import java.beans.PropertyChangeListener;
  24 import java.io.File;
  25 import java.io.FileReader;
  26 import java.io.FileWriter;
  27 import java.io.IOException;
  28 import java.io.Reader;
  29 import java.io.Writer;
  30 import java.util.ArrayList;
  31 import java.util.Collections;
  32 import java.util.HashMap;
  33 import java.util.List;
  34 import java.util.Map;
  35 import java.util.Map.Entry;
  36 import java.util.logging.Level;
  37 import java.util.logging.Logger;
  38
  39 import net.pterodactylus.util.collection.MapWriter;
  40 import net.pterodactylus.util.io.Closer;
  41 import net.pterodactylus.util.logging.Logging;
  42
  43 /**
  44  * Manages projects, taking care of persistence, lifetime statistics, and other
  45  * things.
  46  *
  47  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  48  */
  49 public class ProjectManager implements PropertyChangeListener {
  50
  51         /** Logger. */
  52         private static final Logger logger = Logging.getLogger(ProjectManager.class.getName());
  53
  54         /** The directory the projects are stored in. */
  55         private final String directory;
  56
  57         /** The node manager. */
  58         private NodeManager nodeManager;
  59
  60         /** All projects. */
  61         private final List<Project> projects = Collections.synchronizedList(new ArrayList<Project>());
  62
  63         /**
  64          * Creates a new project manager that saves and restores its state to/from
  65          * the given directory.
  66          *
  67          * @param directory
  68          *            The directory to save and restore states to/from
  69          */
  70         public ProjectManager(String directory) {
  71                 this.directory = directory;
  72         }
  73
  74         //
  75         // ACCESSORS
  76         //
  77
  78         /**
  79          * Returns the directory the projects are loaded from and saved to.
  80          *
  81          * @return The directory for storing the projects
  82          */
  83         public String getDirectory() {
  84                 return directory;
  85         }
  86
  87         /**
  88          * Returns a list of all projects.
  89          *
  90          * @return A list of all projects
  91          */
  92         public List<Project> getProjects() {
  93                 return Collections.unmodifiableList(new ArrayList<Project>(projects));
  94         }
  95
  96         /**
  97          * Sets the node manager to use.
  98          *
  99          * @param nodeManager
 100          *            The node manager to use
 101          */
 102         public void setNodeManager(NodeManager nodeManager) {
 103                 this.nodeManager = nodeManager;
 104         }
 105
 106         //
 107         // ACTIONS
 108         //
 109
 110         /**
 111          * Loads projects and statistics.
 112          *
 113          * @throws IOException
 114          *             if an I/O error occurs
 115          */
 116         public void load() throws IOException {
 117                 File directoryFile = new File(directory);
 118                 File projectFile = new File(directoryFile, "projects.properties");
 119                 if (!projectFile.exists() || !projectFile.isFile() || !projectFile.canRead()) {
 120                         return;
 121                 }
 122                 logger.log(Level.INFO, "Loading projects from “" + projectFile + "”...");
 123                 Map<String, String> projectProperties;
 124                 Reader reader = null;
 125                 try {
 126                         reader = new FileReader(projectFile);
 127                         projectProperties = MapWriter.read(reader);
 128                 } finally {
 129                         Closer.close(reader);
 130                 }
 131                 int projectIndex = 0;
 132                 while (projectProperties.containsKey("projects." + projectIndex + ".name")) {
 133                         String projectPrefix = "projects." + projectIndex;
 134                         String projectId = projectProperties.get(projectPrefix + ".id");
 135                         String projectName = projectProperties.get(projectPrefix + ".name");
 136                         String projectDescription = projectProperties.get(projectPrefix + ".description");
 137                         String projectPrivateKey = projectProperties.get(projectPrefix + ".privateKey");
 138                         String projectPublicKey = projectProperties.get(projectPrefix + ".publicKey");
 139                         String projectBasePath = projectProperties.get(projectPrefix + ".basePath");
 140                         String projectDefaultFile = projectProperties.get(projectPrefix + ".defaultFile");
 141                         String projectNode = projectProperties.get(projectPrefix + ".node");
 142                         Project project = new Project();
 143                         project.setId(projectId);
 144                         project.setName(projectName);
 145                         project.setDescription(projectDescription);
 146                         project.setPrivateKey(projectPrivateKey);
 147                         project.setPublicKey(projectPublicKey);
 148                         project.setBasePath(projectBasePath);
 149                         project.setDefaultFile(projectDefaultFile);
 150                         if (projectNode != null) {
 151                                 Node node = nodeManager.getNode(projectNode);
 152                                 project.setNode(node);
 153                         }
 154                         int overrideIndex = 0;
 155                         while (projectProperties.containsKey(projectPrefix + ".overrides." + overrideIndex + ".override")) {
 156                                 String filePath = projectProperties.get(projectPrefix + ".overrides." + overrideIndex + ".filePath");
 157                                 FileOverride override = FileOverride.valueOf(projectProperties.get(projectPrefix + ".overrides." + overrideIndex + ".override"));
 158                                 project.addFileOverride(filePath, override);
 159                                 logger.log(Level.FINEST, "read override: " + filePath + ", " + override);
 160                                 overrideIndex++;
 161                         }
 162                         projects.add(project);
 163                         logger.fine("loaded project “" + project.getName() + "”.");
 164                         projectIndex++;
 165                 }
 166         }
 167
 168         /**
 169          * Saves projects and statistics.
 170          *
 171          * @throws IOException
 172          *             if an I/O error occurs
 173          */
 174         public void save() throws IOException {
 175                 File directoryFile = new File(directory);
 176                 if (!directoryFile.exists()) {
 177                         if (!directoryFile.mkdirs()) {
 178                                 throw new IOException("could not create directory: " + directory);
 179                         }
 180                 }
 181                 Map<String, String> projectProperties = new HashMap<String, String>();
 182                 int projectIndex = 0;
 183                 for (Project project : projects) {
 184                         String projectPrefix = "projects." + projectIndex;
 185                         projectProperties.put(projectPrefix + ".id", project.getId());
 186                         projectProperties.put(projectPrefix + ".name", project.getName());
 187                         projectProperties.put(projectPrefix + ".description", project.getDescription());
 188                         projectProperties.put(projectPrefix + ".privateKey", project.getPrivateKey());
 189                         projectProperties.put(projectPrefix + ".publicKey", project.getPublicKey());
 190                         projectProperties.put(projectPrefix + ".basePath", project.getBasePath());
 191                         projectProperties.put(projectPrefix + ".defaultFile", project.getDefaultFile());
 192                         if (project.getNode() != null) {
 193                                 projectProperties.put(projectPrefix + ".node", project.getNode().getId());
 194                         }
 195                         int overrideIndex = 0;
 196                         for (Entry<String, FileOverride> overrideEntry : project.getFileOverrides().entrySet()) {
 197                                 projectProperties.put(projectPrefix + ".overrides." + overrideIndex + ".filePath", overrideEntry.getKey());
 198                                 projectProperties.put(projectPrefix + ".overrides." + overrideIndex + ".override", overrideEntry.getValue().toString());
 199                                 overrideIndex++;
 200                         }
 201                         projectIndex++;
 202                 }
 203                 File projectFile = new File(directoryFile, "projects.properties");
 204                 Writer writer = null;
 205                 try {
 206                         writer = new FileWriter(projectFile);
 207                         MapWriter.write(writer, projectProperties);
 208                 } finally {
 209                         Closer.close(writer);
 210                 }
 211         }
 212
 213         /**
 214          * Creates a new project. The returned {@link Project} will contain a newly
 215          * generated key pair.
 216          *
 217          * @return A newly created project
 218          * @throws IOException
 219          *             if an I/O error occured communicating with the node
 220          * @throws JSiteException
 221          *             if there is a problem with the node
 222          */
 223         public Project createProject() throws IOException, JSiteException {
 224                 Project project = new Project();
 225                 String[] keyPair = nodeManager.generateKeyPair();
 226                 project.setName("");
 227                 project.setDescription("");
 228                 project.setPrivateKey(keyPair[0]);
 229                 project.setPublicKey(keyPair[1]);
 230                 project.setBasePath("");
 231                 project.setDefaultFile("");
 232                 projects.add(project);
 233                 project.addPropertyChangeListener(this);
 234                 try {
 235                         save();
 236                 } catch (IOException ioe1) {
 237                         /* ignore. */
 238                 }
 239                 return project;
 240         }
 241
 242         /**
 243          * Clones the given project and returns the clone. The clone will be
 244          * identical in all user-exposed fields, except for the project’s
 245          * {@link Project#getId ID}.
 246          *
 247          * @param project
 248          *            The project to clone
 249          * @return The cloned project
 250          */
 251         public Project cloneProject(Project project) {
 252                 Project projectClone = new Project(project);
 253                 projects.add(projectClone);
 254                 projectClone.addPropertyChangeListener(this);
 255                 try {
 256                         save();
 257                 } catch (IOException ioe1) {
 258                         /* ignore. */
 259                 }
 260                 return projectClone;
 261         }
 262
 263         /**
 264          * Removes the given project.
 265          *
 266          * @param project
 267          *            The project to remove
 268          */
 269         public void removeProject(Project project) {
 270                 projects.remove(project);
 271                 try {
 272                         save();
 273                 } catch (IOException ioe1) {
 274                         /* ignore. */
 275                 }
 276         }
 277
 278         //
 279         // INTERFACE PropertyChangeListener
 280         //
 281
 282         /**
 283          * {@inheritDoc}
 284          */
 285         public void propertyChange(PropertyChangeEvent propertyChangeEvent) {
 286                 try {
 287                         save();
 288                 } catch (IOException ioe1) {
 289                         /* ignore. */
 290                 }
 291         }
 292
 293 }