src/net/pterodactylus/jsite/project/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.project;
  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.Random;
  35 import java.util.logging.Logger;
  36
  37 import net.pterodactylus.jsite.core.JSiteException;
  38 import net.pterodactylus.jsite.core.NodeManager;
  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 RNG used to create project IDs. */
  55         private static final Random random = new Random();
  56
  57         /** The directory the projects are stored in. */
  58         private final String directory;
  59
  60         /** The node manager. */
  61         private NodeManager nodeManager;
  62
  63         /** All projects. */
  64         private final List<Project> projects = Collections.synchronizedList(new ArrayList<Project>());
  65
  66         /**
  67          * Creates a new project manager that saves and restores its state to/from
  68          * the given directory.
  69          *
  70          * @param directory
  71          *            The directory to save and restore states to/from
  72          */
  73         public ProjectManager(String directory) {
  74                 this.directory = directory;
  75         }
  76
  77         //
  78         // ACCESSORS
  79         //
  80
  81         /**
  82          * Returns the directory the projects are loaded from and saved to.
  83          *
  84          * @return The directory for storing the projects
  85          */
  86         public String getDirectory() {
  87                 return directory;
  88         }
  89
  90         /**
  91          * Returns a list of all projects.
  92          *
  93          * @return A list of all projects
  94          */
  95         public List<Project> getProjects() {
  96                 return Collections.unmodifiableList(new ArrayList<Project>(projects));
  97         }
  98
  99         /**
 100          * Sets the node manager to use.
 101          *
 102          * @param nodeManager
 103          *            The node manager to use
 104          */
 105         public void setNodeManager(NodeManager nodeManager) {
 106                 this.nodeManager = nodeManager;
 107         }
 108
 109         //
 110         // ACTIONS
 111         //
 112
 113         /**
 114          * Loads projects and statistics.
 115          *
 116          * @throws IOException
 117          *             if an I/O error occurs
 118          */
 119         public void load() throws IOException {
 120                 File directoryFile = new File(directory);
 121                 File projectFile = new File(directoryFile, "projects.properties");
 122                 if (!projectFile.exists() || !projectFile.isFile() || !projectFile.canRead()) {
 123                         return;
 124                 }
 125                 Properties projectProperties = new Properties();
 126                 InputStream projectInputStream = null;
 127                 try {
 128                         projectInputStream = new FileInputStream(projectFile);
 129                         projectProperties.load(projectInputStream);
 130                 } finally {
 131                         Closer.close(projectInputStream);
 132                 }
 133                 int projectIndex = 0;
 134                 while (projectProperties.containsKey("projects." + projectIndex + ".name")) {
 135                         String projectPrefix = "projects." + projectIndex;
 136                         String projectId = projectProperties.getProperty(projectPrefix + ".id");
 137                         String projectName = projectProperties.getProperty(projectPrefix + ".name");
 138                         String projectDescription = projectProperties.getProperty(projectPrefix + ".description");
 139                         String projectPrivateKey = projectProperties.getProperty(projectPrefix + ".privateKey");
 140                         String projectPublicKey = projectProperties.getProperty(projectPrefix + ".publicKey");
 141                         String projectBasePath = projectProperties.getProperty(projectPrefix + ".basePath");
 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                         projects.add(project);
 150                         logger.fine("loaded project “" + project.getName() + "”.");
 151                         projectIndex++;
 152                 }
 153         }
 154
 155         /**
 156          * Saves projects and statistics.
 157          *
 158          * @throws IOException
 159          *             if an I/O error occurs
 160          */
 161         public void save() throws IOException {
 162                 File directoryFile = new File(directory);
 163                 if (!directoryFile.exists()) {
 164                         if (!directoryFile.mkdirs()) {
 165                                 throw new IOException("could not create directory: " + directory);
 166                         }
 167                 }
 168                 Properties projectProperties = new Properties();
 169                 int projectIndex = 0;
 170                 for (Project project: projects) {
 171                         String projectPrefix = "projects." + projectIndex;
 172                         projectProperties.setProperty(projectPrefix + ".id", project.getId());
 173                         projectProperties.setProperty(projectPrefix + ".name", project.getName());
 174                         projectProperties.setProperty(projectPrefix + ".description", project.getDescription());
 175                         projectProperties.setProperty(projectPrefix + ".privateKey", project.getPrivateKey());
 176                         projectProperties.setProperty(projectPrefix + ".publicKey", project.getPublicKey());
 177                         projectProperties.setProperty(projectPrefix + ".basePath", project.getBasePath());
 178                         projectIndex++;
 179                 }
 180                 File projectFile = new File(directoryFile, "projects.properties");
 181                 OutputStream projectOutputStream = null;
 182                 try {
 183                         projectOutputStream = new FileOutputStream(projectFile);
 184                         projectProperties.store(projectOutputStream, "jSite projects");
 185                 } finally {
 186                         Closer.close(projectOutputStream);
 187                 }
 188         }
 189
 190         /**
 191          * Creates a new project. The returned {@link Project} will contain a newly
 192          * generated key pair.
 193          *
 194          * @return A newly created project
 195          * @throws IOException
 196          *             if an I/O error occured communicating with the node
 197          * @throws JSiteException
 198          *             if there is a problem with the node
 199          */
 200         public Project createProject() throws IOException, JSiteException {
 201                 Project project = new Project();
 202                 String[] keyPair = nodeManager.generateKeyPair();
 203                 project.setId(generateId());
 204                 project.setName("");
 205                 project.setDescription("");
 206                 project.setPrivateKey(keyPair[0]);
 207                 project.setPublicKey(keyPair[1]);
 208                 project.setBasePath("");
 209                 projects.add(project);
 210                 project.addPropertyChangeListener(this);
 211                 try {
 212                         save();
 213                 } catch (IOException ioe1) {
 214                         /* ignore. */
 215                 }
 216                 return project;
 217         }
 218
 219         /**
 220          * Clones the given project and returns the clone. The clone will be
 221          * identical in all user-exposed fields, except for the project’s
 222          * {@link Project#getId ID}.
 223          *
 224          * @param project
 225          *            The project to clone
 226          * @return The cloned project
 227          */
 228         public Project cloneProject(Project project) {
 229                 Project projectClone = new Project(project);
 230                 projects.add(projectClone);
 231                 projectClone.setId(generateId());
 232                 projectClone.addPropertyChangeListener(this);
 233                 try {
 234                         save();
 235                 } catch (IOException ioe1) {
 236                         /* ignore. */
 237                 }
 238                 return projectClone;
 239         }
 240
 241         /**
 242          * Removes the given project.
 243          *
 244          * @param project
 245          *            The project to remove
 246          */
 247         public void removeProject(Project project) {
 248                 projects.remove(project);
 249                 try {
 250                         save();
 251                 } catch (IOException ioe1) {
 252                         /* ignore. */
 253                 }
 254         }
 255
 256         //
 257         // PRIVATE METHODS
 258         //
 259
 260         /**
 261          * Generates a new random ID, consisting of 16 random bytes converted to a
 262          * hexadecimal number.
 263          *
 264          * @return The new ID
 265          */
 266         private static String generateId() {
 267                 byte[] idBytes = new byte[16];
 268                 random.nextBytes(idBytes);
 269                 return Hex.toHex(idBytes);
 270         }
 271
 272         //
 273         // INTERFACE PropertyChangeListener
 274         //
 275
 276         /**
 277          * {@inheritDoc}
 278          */
 279         public void propertyChange(PropertyChangeEvent propertyChangeEvent) {
 280                 try {
 281                         save();
 282                 } catch (IOException ioe1) {
 283                         /* ignore. */
 284                 }
 285         }
 286
 287 }