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.FileInputStream;
  26 import java.io.FileOutputStream;
  27 import java.io.IOException;
  28 import java.io.InputStream;
  29 import java.io.OutputStream;
  30 import java.util.ArrayList;
  31 import java.util.Collections;
  32 import java.util.List;
  33 import java.util.Properties;
  34 import java.util.Map.Entry;
  35 import java.util.logging.Level;
  36 import java.util.logging.Logger;
  37
  38 import net.pterodactylus.jsite.util.IdGenerator;
  39 import net.pterodactylus.util.io.Closer;
  40 import net.pterodactylus.util.logging.Logging;
  41 import net.pterodactylus.util.number.Hex;
  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                 Properties projectProperties = new Properties();
 123                 InputStream projectInputStream = null;
 124                 try {
 125                         projectInputStream = new FileInputStream(projectFile);
 126                         projectProperties.load(projectInputStream);
 127                 } finally {
 128                         Closer.close(projectInputStream);
 129                 }
 130                 int projectIndex = 0;
 131                 while (projectProperties.containsKey("projects." + projectIndex + ".name")) {
 132                         String projectPrefix = "projects." + projectIndex;
 133                         String projectId = projectProperties.getProperty(projectPrefix + ".id");
 134                         String projectName = projectProperties.getProperty(projectPrefix + ".name");
 135                         String projectDescription = projectProperties.getProperty(projectPrefix + ".description");
 136                         String projectPrivateKey = projectProperties.getProperty(projectPrefix + ".privateKey");
 137                         String projectPublicKey = projectProperties.getProperty(projectPrefix + ".publicKey");
 138                         String projectBasePath = projectProperties.getProperty(projectPrefix + ".basePath");
 139                         String projectDefaultFile = projectProperties.getProperty(projectPrefix + ".defaultFile");
 140                         Project project = new Project();
 141                         project.setId(projectId);
 142                         project.setName(projectName);
 143                         project.setDescription(projectDescription);
 144                         project.setPrivateKey(projectPrivateKey);
 145                         project.setPublicKey(projectPublicKey);
 146                         project.setBasePath(projectBasePath);
 147                         project.setDefaultFile(projectDefaultFile);
 148                         int overrideIndex = 0;
 149                         while (projectProperties.containsKey(projectPrefix + ".overrides." + overrideIndex + ".override")) {
 150                                 String filePath = projectProperties.getProperty(projectPrefix + ".overrides." + overrideIndex + ".filePath");
 151                                 FileOverride override = FileOverride.valueOf(projectProperties.getProperty(projectPrefix + ".overrides." + overrideIndex + ".override"));
 152                                 project.addFileOverride(filePath, override);
 153                                 logger.log(Level.FINEST, "read override: " + filePath + ", " + override);
 154                                 overrideIndex++;
 155                         }
 156                         projects.add(project);
 157                         logger.fine("loaded project “" + project.getName() + "”.");
 158                         projectIndex++;
 159                 }
 160         }
 161
 162         /**
 163          * Saves projects and statistics.
 164          *
 165          * @throws IOException
 166          *             if an I/O error occurs
 167          */
 168         public void save() throws IOException {
 169                 File directoryFile = new File(directory);
 170                 if (!directoryFile.exists()) {
 171                         if (!directoryFile.mkdirs()) {
 172                                 throw new IOException("could not create directory: " + directory);
 173                         }
 174                 }
 175                 Properties projectProperties = new Properties();
 176                 int projectIndex = 0;
 177                 for (Project project : projects) {
 178                         String projectPrefix = "projects." + projectIndex;
 179                         projectProperties.setProperty(projectPrefix + ".id", project.getId());
 180                         projectProperties.setProperty(projectPrefix + ".name", project.getName());
 181                         projectProperties.setProperty(projectPrefix + ".description", project.getDescription());
 182                         projectProperties.setProperty(projectPrefix + ".privateKey", project.getPrivateKey());
 183                         projectProperties.setProperty(projectPrefix + ".publicKey", project.getPublicKey());
 184                         projectProperties.setProperty(projectPrefix + ".basePath", project.getBasePath());
 185                         projectProperties.setProperty(projectPrefix + ".defaultFile", project.getDefaultFile());
 186                         int overrideIndex = 0;
 187                         for (Entry<String, FileOverride> overrideEntry : project.getFileOverrides().entrySet()) {
 188                                 projectProperties.setProperty(projectPrefix + ".overrides." + overrideIndex + ".filePath", overrideEntry.getKey());
 189                                 projectProperties.setProperty(projectPrefix + ".overrides." + overrideIndex + ".override", overrideEntry.getValue().toString());
 190                                 overrideIndex++;
 191                         }
 192                         projectIndex++;
 193                 }
 194                 File projectFile = new File(directoryFile, "projects.properties");
 195                 OutputStream projectOutputStream = null;
 196                 try {
 197                         projectOutputStream = new FileOutputStream(projectFile);
 198                         projectProperties.store(projectOutputStream, "jSite projects");
 199                 } finally {
 200                         Closer.close(projectOutputStream);
 201                 }
 202         }
 203
 204         /**
 205          * Creates a new project. The returned {@link Project} will contain a newly
 206          * generated key pair.
 207          *
 208          * @return A newly created project
 209          * @throws IOException
 210          *             if an I/O error occured communicating with the node
 211          * @throws JSiteException
 212          *             if there is a problem with the node
 213          */
 214         public Project createProject() throws IOException, JSiteException {
 215                 Project project = new Project();
 216                 String[] keyPair = nodeManager.generateKeyPair();
 217                 project.setId(Hex.toHex(IdGenerator.generateId()));
 218                 project.setName("");
 219                 project.setDescription("");
 220                 project.setPrivateKey(keyPair[0]);
 221                 project.setPublicKey(keyPair[1]);
 222                 project.setBasePath("");
 223                 project.setDefaultFile("");
 224                 projects.add(project);
 225                 project.addPropertyChangeListener(this);
 226                 try {
 227                         save();
 228                 } catch (IOException ioe1) {
 229                         /* ignore. */
 230                 }
 231                 return project;
 232         }
 233
 234         /**
 235          * Clones the given project and returns the clone. The clone will be
 236          * identical in all user-exposed fields, except for the project’s
 237          * {@link Project#getId ID}.
 238          *
 239          * @param project
 240          *            The project to clone
 241          * @return The cloned project
 242          */
 243         public Project cloneProject(Project project) {
 244                 Project projectClone = new Project(project);
 245                 projects.add(projectClone);
 246                 projectClone.setId(Hex.toHex(IdGenerator.generateId()));
 247                 projectClone.addPropertyChangeListener(this);
 248                 try {
 249                         save();
 250                 } catch (IOException ioe1) {
 251                         /* ignore. */
 252                 }
 253                 return projectClone;
 254         }
 255
 256         /**
 257          * Removes the given project.
 258          *
 259          * @param project
 260          *            The project to remove
 261          */
 262         public void removeProject(Project project) {
 263                 projects.remove(project);
 264                 try {
 265                         save();
 266                 } catch (IOException ioe1) {
 267                         /* ignore. */
 268                 }
 269         }
 270
 271         //
 272         // INTERFACE PropertyChangeListener
 273         //
 274
 275         /**
 276          * {@inheritDoc}
 277          */
 278         public void propertyChange(PropertyChangeEvent propertyChangeEvent) {
 279                 try {
 280                         save();
 281                 } catch (IOException ioe1) {
 282                         /* ignore. */
 283                 }
 284         }
 285
 286 }