src/main/java/net/pterodactylus/sone/core/Core.java

   1 /*
   2  * FreenetSone - Core.java - Copyright © 2010 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.core;
  19
  20 import java.net.MalformedURLException;
  21 import java.util.Collections;
  22 import java.util.HashMap;
  23 import java.util.HashSet;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.Set;
  27 import java.util.UUID;
  28 import java.util.logging.Level;
  29 import java.util.logging.Logger;
  30
  31 import net.pterodactylus.sone.core.SoneException.Type;
  32 import net.pterodactylus.sone.data.Sone;
  33 import net.pterodactylus.util.config.Configuration;
  34 import net.pterodactylus.util.config.ConfigurationException;
  35 import net.pterodactylus.util.logging.Logging;
  36 import net.pterodactylus.util.service.AbstractService;
  37 import net.pterodactylus.util.text.StringEscaper;
  38 import net.pterodactylus.util.text.TextException;
  39 import freenet.keys.FreenetURI;
  40
  41 /**
  42  * The Sone core.
  43  *
  44  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  45  */
  46 public class Core extends AbstractService {
  47
  48         /** The logger. */
  49         private static final Logger logger = Logging.getLogger(Core.class);
  50
  51         /** The configuration. */
  52         private Configuration configuration;
  53
  54         /** Interface to freenet. */
  55         private FreenetInterface freenetInterface;
  56
  57         /** The local Sones. */
  58         private final Set<Sone> localSones = new HashSet<Sone>();
  59
  60         /** Sone inserters. */
  61         private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
  62
  63         /**
  64          * Creates a new core.
  65          */
  66         public Core() {
  67                 super("Sone Core");
  68         }
  69
  70         //
  71         // ACCESSORS
  72         //
  73
  74         /**
  75          * Sets the configuration of the core.
  76          *
  77          * @param configuration
  78          *            The configuration of the core
  79          * @return This core (for method chaining)
  80          */
  81         public Core configuration(Configuration configuration) {
  82                 this.configuration = configuration;
  83                 return this;
  84         }
  85
  86         /**
  87          * Sets the Freenet interface to use.
  88          *
  89          * @param freenetInterface
  90          *            The Freenet interface to use
  91          * @return This core (for method chaining)
  92          */
  93         public Core freenetInterface(FreenetInterface freenetInterface) {
  94                 this.freenetInterface = freenetInterface;
  95                 return this;
  96         }
  97
  98         /**
  99          * Returns the local Sones.
 100          *
 101          * @return The local Sones
 102          */
 103         public Set<Sone> getSones() {
 104                 return Collections.unmodifiableSet(localSones);
 105         }
 106
 107         //
 108         // ACTIONS
 109         //
 110
 111         /**
 112          * Adds the given Sone.
 113          *
 114          * @param sone
 115          *            The Sone to add
 116          */
 117         public void addSone(Sone sone) {
 118                 if (localSones.add(sone)) {
 119                         SoneInserter soneInserter = new SoneInserter(sone);
 120                         soneInserter.start();
 121                         soneInserters.put(sone, soneInserter);
 122                 }
 123         }
 124
 125         /**
 126          * Creates a new Sone at a random location.
 127          *
 128          * @param name
 129          *            The name of the Sone
 130          * @return The created Sone
 131          * @throws SoneException
 132          *             if a Sone error occurs
 133          */
 134         public Sone createSone(String name) throws SoneException {
 135                 return createSone(name, null, null);
 136         }
 137
 138         /**
 139          * Creates a new Sone at the given location. If one of {@code requestUri} or
 140          * {@code insertUrI} is {@code null}, the Sone is created at a random
 141          * location.
 142          *
 143          * @param name
 144          *            The name of the Sone
 145          * @param requestUri
 146          *            The request URI of the Sone, or {@link NullPointerException}
 147          *            to create a Sone at a random location
 148          * @param insertUri
 149          *            The insert URI of the Sone, or {@code null} to create a Sone
 150          *            at a random location
 151          * @return The created Sone
 152          * @throws SoneException
 153          *             if a Sone error occurs
 154          */
 155         public Sone createSone(String name, String requestUri, String insertUri) throws SoneException {
 156                 if ((name == null) || (name.trim().length() == 0)) {
 157                         throw new SoneException(Type.INVALID_SONE_NAME);
 158                 }
 159                 String finalRequestUri;
 160                 String finalInsertUri;
 161                 if ((requestUri == null) || (insertUri == null)) {
 162                         String[] keyPair = freenetInterface.generateKeyPair();
 163                         finalRequestUri = keyPair[0];
 164                         finalInsertUri = keyPair[1];
 165                 } else {
 166                         finalRequestUri = requestUri;
 167                         finalInsertUri = insertUri;
 168                 }
 169                 Sone sone;
 170                 try {
 171                         logger.log(Level.FINEST, "Creating new Sone “%s” at %s (%s)…", new Object[] { name, finalRequestUri, finalInsertUri });
 172                         sone = new Sone(UUID.randomUUID(), name, new FreenetURI(finalRequestUri), new FreenetURI(finalInsertUri));
 173                         addSone(sone);
 174                 } catch (MalformedURLException mue1) {
 175                         throw new SoneException(Type.INVALID_URI);
 176                 }
 177                 localSones.add(sone);
 178                 return sone;
 179         }
 180
 181         /**
 182          * Deletes the given Sone from this plugin instance.
 183          *
 184          * @param sone
 185          *            The sone to delete
 186          */
 187         public void deleteSone(Sone sone) {
 188                 SoneInserter soneInserter = soneInserters.remove(sone);
 189                 soneInserter.stop();
 190                 localSones.remove(sone);
 191         }
 192
 193         //
 194         // SERVICE METHODS
 195         //
 196
 197         /**
 198          * {@inheritDoc}
 199          */
 200         @Override
 201         protected void serviceStart() {
 202                 loadConfiguration();
 203         }
 204
 205         /**
 206          * {@inheritDoc}
 207          */
 208         @Override
 209         protected void serviceStop() {
 210                 /* stop all Sone inserters. */
 211                 for (SoneInserter soneInserter : soneInserters.values()) {
 212                         soneInserter.stop();
 213                 }
 214                 saveConfiguration();
 215         }
 216
 217         //
 218         // PRIVATE METHODS
 219         //
 220
 221         /**
 222          * Loads the configuration.
 223          */
 224         private void loadConfiguration() {
 225                 logger.entering(Core.class.getName(), "loadConfiguration()");
 226
 227                 /* get names of all local Sones. */
 228                 String allSoneNamesString = configuration.getStringValue("Sone/Names").getValue(null);
 229                 if (allSoneNamesString == null) {
 230                         allSoneNamesString = "";
 231                 }
 232                 List<String> allSoneNames;
 233                 try {
 234                         allSoneNames = StringEscaper.parseLine(allSoneNamesString);
 235                 } catch (TextException te1) {
 236                         logger.log(Level.WARNING, "Could not parse Sone names: “" + allSoneNamesString + "”", te1);
 237                         allSoneNames = Collections.emptyList();
 238                 }
 239
 240                 /* parse local Sones. */
 241                 logger.log(Level.INFO, "Loading %d Sones…", allSoneNames.size());
 242                 for (String soneName : allSoneNames) {
 243                         String id = configuration.getStringValue("Sone/Name." + soneName + "/ID").getValue(null);
 244                         String insertUri = configuration.getStringValue("Sone/Name." + soneName + "/InsertURI").getValue(null);
 245                         String requestUri = configuration.getStringValue("Sone/Name." + soneName + "/RequestURI").getValue(null);
 246                         long modificationCounter = configuration.getLongValue("Sone/Name." + soneName + "/ModificationCounter").getValue((long) 0);
 247                         try {
 248                                 Sone sone = new Sone(UUID.fromString(id), soneName, new FreenetURI(requestUri), new FreenetURI(insertUri));
 249                                 sone.setModificationCounter(modificationCounter);
 250                                 addSone(sone);
 251                         } catch (MalformedURLException mue1) {
 252                                 logger.log(Level.WARNING, "Could not create Sone from requestUri (“" + requestUri + "”) and insertUri (“" + insertUri + "”)!", mue1);
 253                         }
 254                 }
 255
 256                 logger.exiting(Core.class.getName(), "loadConfiguration()");
 257         }
 258
 259         /**
 260          * Saves the configuraiton.
 261          */
 262         private void saveConfiguration() {
 263
 264                 /* get the names of all Sones. */
 265                 Set<String> soneNames = new HashSet<String>();
 266                 for (Sone sone : localSones) {
 267                         soneNames.add(sone.getName());
 268                 }
 269                 String soneNamesString = StringEscaper.escapeWords(soneNames);
 270
 271                 logger.log(Level.INFO, "Storing %d Sones…", soneNames.size());
 272                 try {
 273                         /* store names of all Sones. */
 274                         configuration.getStringValue("Sone/Names").setValue(soneNamesString);
 275
 276                         /* store all Sones. */
 277                         for (Sone sone : localSones) {
 278                                 configuration.getStringValue("Sone/Name." + sone.getName() + "/ID").setValue(sone.getId());
 279                                 configuration.getStringValue("Sone/Name." + sone.getName() + "/RequestURI").setValue(sone.getRequestUri().toString());
 280                                 configuration.getStringValue("Sone/Name." + sone.getName() + "/InsertURI").setValue(sone.getInsertUri().toString());
 281                                 configuration.getLongValue("Sone/Name." + sone.getName() + "/ModificationCounter").setValue(sone.getModificationCounter());
 282                         }
 283                 } catch (ConfigurationException ce1) {
 284                         logger.log(Level.WARNING, "Could not store configuration!", ce1);
 285                 }
 286         }
 287
 288 }