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.ArrayList;
  22 import java.util.Collections;
  23 import java.util.Comparator;
  24 import java.util.HashMap;
  25 import java.util.HashSet;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.Set;
  29 import java.util.UUID;
  30 import java.util.logging.Level;
  31 import java.util.logging.Logger;
  32
  33 import net.pterodactylus.sone.core.SoneException.Type;
  34 import net.pterodactylus.sone.data.Post;
  35 import net.pterodactylus.sone.data.Profile;
  36 import net.pterodactylus.sone.data.Reply;
  37 import net.pterodactylus.sone.data.Sone;
  38 import net.pterodactylus.util.config.Configuration;
  39 import net.pterodactylus.util.config.ConfigurationException;
  40 import net.pterodactylus.util.logging.Logging;
  41 import net.pterodactylus.util.service.AbstractService;
  42 import freenet.keys.FreenetURI;
  43
  44 /**
  45  * The Sone core.
  46  *
  47  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  48  */
  49 public class Core extends AbstractService {
  50
  51         /** The logger. */
  52         private static final Logger logger = Logging.getLogger(Core.class);
  53
  54         /** The configuration. */
  55         private Configuration configuration;
  56
  57         /** Interface to freenet. */
  58         private FreenetInterface freenetInterface;
  59
  60         /** The Sone downloader. */
  61         private SoneDownloader soneDownloader;
  62
  63         /** The local Sones. */
  64         private final Set<Sone> localSones = new HashSet<Sone>();
  65
  66         /** Sone inserters. */
  67         private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
  68
  69         /* various caches follow here. */
  70
  71         /** Cache for all known Sones. */
  72         private final Map<String, Sone> soneCache = new HashMap<String, Sone>();
  73
  74         /** Cache for all known posts. */
  75         private final Map<String, Post> postCache = new HashMap<String, Post>();
  76
  77         /** Cache for all known replies. */
  78         private final Map<String, Reply> replyCache = new HashMap<String, Reply>();
  79
  80         /**
  81          * Creates a new core.
  82          */
  83         public Core() {
  84                 super("Sone Core");
  85         }
  86
  87         //
  88         // ACCESSORS
  89         //
  90
  91         /**
  92          * Sets the configuration of the core.
  93          *
  94          * @param configuration
  95          *            The configuration of the core
  96          * @return This core (for method chaining)
  97          */
  98         public Core configuration(Configuration configuration) {
  99                 this.configuration = configuration;
 100                 return this;
 101         }
 102
 103         /**
 104          * Sets the Freenet interface to use.
 105          *
 106          * @param freenetInterface
 107          *            The Freenet interface to use
 108          * @return This core (for method chaining)
 109          */
 110         public Core freenetInterface(FreenetInterface freenetInterface) {
 111                 this.freenetInterface = freenetInterface;
 112                 soneDownloader = new SoneDownloader(this, freenetInterface);
 113                 soneDownloader.start();
 114                 return this;
 115         }
 116
 117         /**
 118          * Returns the local Sones.
 119          *
 120          * @return The local Sones
 121          */
 122         public Set<Sone> getSones() {
 123                 return Collections.unmodifiableSet(localSones);
 124         }
 125
 126         /**
 127          * Returns the Sone with the given ID, or an empty Sone that has been
 128          * initialized with the given ID.
 129          *
 130          * @param soneId
 131          *            The ID of the Sone
 132          * @return The Sone
 133          */
 134         public Sone getSone(String soneId) {
 135                 if (!soneCache.containsKey(soneId)) {
 136                         Sone sone = new Sone(soneId);
 137                         soneCache.put(soneId, sone);
 138                 }
 139                 return soneCache.get(soneId);
 140         }
 141
 142         /**
 143          * Creates a new post.
 144          *
 145          * @param sone
 146          *            The sone that creates the post
 147          * @param text
 148          *            The text of the post
 149          * @return The created post
 150          */
 151         public Post createPost(Sone sone, String text) {
 152                 return createPost(sone, System.currentTimeMillis(), text);
 153         }
 154
 155         /**
 156          * Creates a new post.
 157          *
 158          * @param sone
 159          *            The Sone that creates the post
 160          * @param time
 161          *            The time of the post
 162          * @param text
 163          *            The text of the post
 164          * @return The created post
 165          */
 166         public Post createPost(Sone sone, long time, String text) {
 167                 Post post = getPost(UUID.randomUUID().toString()).setSone(sone).setTime(time).setText(text);
 168                 sone.addPost(post);
 169                 return post;
 170         }
 171
 172         //
 173         // ACTIONS
 174         //
 175
 176         /**
 177          * Adds the given Sone.
 178          *
 179          * @param sone
 180          *            The Sone to add
 181          */
 182         public void addLocalSone(Sone sone) {
 183                 if (localSones.add(sone)) {
 184                         SoneInserter soneInserter = new SoneInserter(freenetInterface, sone);
 185                         soneInserter.start();
 186                         soneDownloader.addSone(sone);
 187                         soneInserters.put(sone, soneInserter);
 188                 }
 189         }
 190
 191         /**
 192          * Creates a new Sone at a random location.
 193          *
 194          * @param name
 195          *            The name of the Sone
 196          * @return The created Sone
 197          * @throws SoneException
 198          *             if a Sone error occurs
 199          */
 200         public Sone createSone(String name) throws SoneException {
 201                 return createSone(name, null, null);
 202         }
 203
 204         /**
 205          * Creates a new Sone at the given location. If one of {@code requestUri} or
 206          * {@code insertUrI} is {@code null}, the Sone is created at a random
 207          * location.
 208          *
 209          * @param name
 210          *            The name of the Sone
 211          * @param requestUri
 212          *            The request URI of the Sone, or {@link NullPointerException}
 213          *            to create a Sone at a random location
 214          * @param insertUri
 215          *            The insert URI of the Sone, or {@code null} to create a Sone
 216          *            at a random location
 217          * @return The created Sone
 218          * @throws SoneException
 219          *             if a Sone error occurs
 220          */
 221         public Sone createSone(String name, String requestUri, String insertUri) throws SoneException {
 222                 if ((name == null) || (name.trim().length() == 0)) {
 223                         throw new SoneException(Type.INVALID_SONE_NAME);
 224                 }
 225                 String finalRequestUri;
 226                 String finalInsertUri;
 227                 if ((requestUri == null) || (insertUri == null)) {
 228                         String[] keyPair = freenetInterface.generateKeyPair();
 229                         finalRequestUri = keyPair[0];
 230                         finalInsertUri = keyPair[1];
 231                 } else {
 232                         finalRequestUri = requestUri;
 233                         finalInsertUri = insertUri;
 234                 }
 235                 Sone sone;
 236                 try {
 237                         logger.log(Level.FINEST, "Creating new Sone “%s” at %s (%s)…", new Object[] { name, finalRequestUri, finalInsertUri });
 238                         sone = getSone(UUID.randomUUID().toString()).setName(name).setRequestUri(new FreenetURI(finalRequestUri).setKeyType("USK").setDocName("Sone-" + name)).setInsertUri(new FreenetURI(finalInsertUri).setKeyType("USK").setDocName("Sone-" + name));
 239                         sone.setProfile(new Profile());
 240                         /* set modification counter to 1 so it is inserted immediately. */
 241                         sone.setModificationCounter(1);
 242                         addLocalSone(sone);
 243                 } catch (MalformedURLException mue1) {
 244                         throw new SoneException(Type.INVALID_URI);
 245                 }
 246                 return sone;
 247         }
 248
 249         /**
 250          * Deletes the given Sone from this plugin instance.
 251          *
 252          * @param sone
 253          *            The sone to delete
 254          */
 255         public void deleteSone(Sone sone) {
 256                 SoneInserter soneInserter = soneInserters.remove(sone);
 257                 soneInserter.stop();
 258                 localSones.remove(sone);
 259         }
 260
 261         /**
 262          * Returns the post with the given ID. If no post exists yet with the given
 263          * ID, a new post is returned.
 264          *
 265          * @param postId
 266          *            The ID of the post
 267          * @return The post
 268          */
 269         public Post getPost(String postId) {
 270                 if (!postCache.containsKey(postId)) {
 271                         postCache.put(postId, new Post(postId));
 272                 }
 273                 return postCache.get(postId);
 274         }
 275
 276         /**
 277          * Returns the reply with the given ID. If no reply exists yet with the
 278          * given ID, a new reply is returned.
 279          *
 280          * @param replyId
 281          *            The ID of the reply
 282          * @return The reply
 283          */
 284         public Reply getReply(String replyId) {
 285                 if (!replyCache.containsKey(replyId)) {
 286                         replyCache.put(replyId, new Reply(replyId));
 287                 }
 288                 return replyCache.get(replyId);
 289         }
 290
 291         /**
 292          * Gets all replies to the given post, sorted by date, oldest first.
 293          *
 294          * @param post
 295          *            The post the replies refer to
 296          * @return The sorted list of replies for the post
 297          */
 298         public List<Reply> getReplies(Post post) {
 299                 List<Reply> replies = new ArrayList<Reply>();
 300                 for (Reply reply : replyCache.values()) {
 301                         if (reply.getPost().equals(post)) {
 302                                 replies.add(reply);
 303                         }
 304                 }
 305                 Collections.sort(replies, new Comparator<Reply>() {
 306
 307                         /**
 308                          * {@inheritDoc}
 309                          */
 310                         @Override
 311                         public int compare(Reply leftReply, Reply rightReply) {
 312                                 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, leftReply.getTime() - rightReply.getTime()));
 313                         }
 314                 });
 315                 return replies;
 316         }
 317
 318         //
 319         // SERVICE METHODS
 320         //
 321
 322         /**
 323          * {@inheritDoc}
 324          */
 325         @Override
 326         protected void serviceStart() {
 327                 loadConfiguration();
 328         }
 329
 330         /**
 331          * {@inheritDoc}
 332          */
 333         @Override
 334         protected void serviceStop() {
 335                 soneDownloader.stop();
 336                 /* stop all Sone inserters. */
 337                 for (SoneInserter soneInserter : soneInserters.values()) {
 338                         soneInserter.stop();
 339                 }
 340                 saveConfiguration();
 341         }
 342
 343         //
 344         // PRIVATE METHODS
 345         //
 346
 347         /**
 348          * Loads the configuration.
 349          */
 350         private void loadConfiguration() {
 351                 logger.entering(Core.class.getName(), "loadConfiguration()");
 352
 353                 /* parse local Sones. */
 354                 logger.log(Level.INFO, "Loading Sones…");
 355                 int soneId = 0;
 356                 do {
 357                         String sonePrefix = "Sone/Sone." + soneId++;
 358                         String id = configuration.getStringValue(sonePrefix + "/ID").getValue(null);
 359                         if (id == null) {
 360                                 break;
 361                         }
 362                         String name = configuration.getStringValue(sonePrefix + "/Name").getValue(null);
 363                         String insertUri = configuration.getStringValue(sonePrefix + "/InsertURI").getValue(null);
 364                         String requestUri = configuration.getStringValue(sonePrefix + "/RequestURI").getValue(null);
 365                         long modificationCounter = configuration.getLongValue(sonePrefix + "/ModificationCounter").getValue((long) 0);
 366                         String firstName = configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null);
 367                         String middleName = configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null);
 368                         String lastName = configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null);
 369                         try {
 370                                 Profile profile = new Profile();
 371                                 profile.setFirstName(firstName);
 372                                 profile.setMiddleName(middleName);
 373                                 profile.setLastName(lastName);
 374                                 Sone sone = getSone(id).setName(name).setRequestUri(new FreenetURI(requestUri)).setInsertUri(new FreenetURI(insertUri));
 375                                 sone.setProfile(profile);
 376                                 int postId = 0;
 377                                 do {
 378                                         String postPrefix = sonePrefix + "/Post." + postId++;
 379                                         id = configuration.getStringValue(postPrefix + "/ID").getValue(null);
 380                                         if (id == null) {
 381                                                 break;
 382                                         }
 383                                         long time = configuration.getLongValue(postPrefix + "/Time").getValue(null);
 384                                         String text = configuration.getStringValue(postPrefix + "/Text").getValue(null);
 385                                         Post post = getPost(id).setSone(sone).setTime(time).setText(text);
 386                                         sone.addPost(post);
 387                                 } while (true);
 388                                 int replyCounter = 0;
 389                                 do {
 390                                         String replyPrefix = sonePrefix + "/Reply." + replyCounter++;
 391                                         String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
 392                                         if (replyId == null) {
 393                                                 break;
 394                                         }
 395                                         Post replyPost = getPost(configuration.getStringValue(replyPrefix + "/Post").getValue(null));
 396                                         long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue(null);
 397                                         String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
 398                                         Reply reply = getReply(replyId).setSone(sone).setPost(replyPost).setTime(replyTime).setText(replyText);
 399                                         sone.addReply(reply);
 400                                 } while (true);
 401
 402                                 /* load friends. */
 403                                 int friendCounter = 0;
 404                                 while (true) {
 405                                         String friendPrefix = sonePrefix + "/Friend." + friendCounter++;
 406                                         String friendId = configuration.getStringValue(friendPrefix + "/ID").getValue(null);
 407                                         if (friendId == null) {
 408                                                 break;
 409                                         }
 410                                         Sone friendSone = getSone(friendId);
 411                                         String friendKey = configuration.getStringValue(friendPrefix + "/Key").getValue(null);
 412                                         String friendName = configuration.getStringValue(friendPrefix + "/Name").getValue(null);
 413                                         friendSone.setRequestUri(new FreenetURI(friendKey)).setName(friendName);
 414                                         soneDownloader.addSone(friendSone);
 415                                         sone.addFriend(friendSone);
 416                                 }
 417
 418                                 sone.setModificationCounter(modificationCounter);
 419                                 addLocalSone(sone);
 420                         } catch (MalformedURLException mue1) {
 421                                 logger.log(Level.WARNING, "Could not create Sone from requestUri (“" + requestUri + "”) and insertUri (“" + insertUri + "”)!", mue1);
 422                         }
 423                 } while (true);
 424                 logger.log(Level.INFO, "Loaded %d Sones.", getSones().size());
 425
 426                 logger.exiting(Core.class.getName(), "loadConfiguration()");
 427         }
 428
 429         /**
 430          * Saves the configuraiton.
 431          */
 432         private void saveConfiguration() {
 433                 Set<Sone> sones = getSones();
 434                 logger.log(Level.INFO, "Storing %d Sones…", sones.size());
 435                 try {
 436                         /* store all Sones. */
 437                         int soneId = 0;
 438                         for (Sone sone : localSones) {
 439                                 String sonePrefix = "Sone/Sone." + soneId++;
 440                                 configuration.getStringValue(sonePrefix + "/ID").setValue(sone.getId());
 441                                 configuration.getStringValue(sonePrefix + "/Name").setValue(sone.getName());
 442                                 configuration.getStringValue(sonePrefix + "/RequestURI").setValue(sone.getRequestUri().toString());
 443                                 configuration.getStringValue(sonePrefix + "/InsertURI").setValue(sone.getInsertUri().toString());
 444                                 configuration.getLongValue(sonePrefix + "/ModificationCounter").setValue(sone.getModificationCounter());
 445                                 Profile profile = sone.getProfile();
 446                                 configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
 447                                 configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
 448                                 configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
 449                                 int postId = 0;
 450                                 for (Post post : sone.getPosts()) {
 451                                         String postPrefix = sonePrefix + "/Post." + postId++;
 452                                         configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
 453                                         configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
 454                                         configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
 455                                 }
 456                                 /* write null ID as terminator. */
 457                                 configuration.getStringValue(sonePrefix + "/Post." + postId + "/ID").setValue(null);
 458
 459                                 int replyId = 0;
 460                                 for (Reply reply : sone.getReplies()) {
 461                                         String replyPrefix = sonePrefix + "/Reply." + replyId++;
 462                                         configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
 463                                         configuration.getStringValue(replyPrefix + "/Post").setValue(reply.getPost().getId());
 464                                         configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
 465                                         configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
 466                                 }
 467                                 /* write null ID as terminator. */
 468                                 configuration.getStringValue(sonePrefix + "/Reply." + replyId + "/ID").setValue(null);
 469
 470                                 int friendId = 0;
 471                                 for (Sone friend : sone.getFriends()) {
 472                                         String friendPrefix = sonePrefix + "/Friend." + friendId++;
 473                                         configuration.getStringValue(friendPrefix + "/ID").setValue(friend.getId());
 474                                         configuration.getStringValue(friendPrefix + "/Key").setValue(friend.getRequestUri().toString());
 475                                         configuration.getStringValue(friendPrefix + "/Name").setValue(friend.getName());
 476                                 }
 477                                 /* write null ID as terminator. */
 478                                 configuration.getStringValue(sonePrefix + "/Friend." + friendId + "/ID").setValue(null);
 479
 480                         }
 481                         /* write null ID as terminator. */
 482                         configuration.getStringValue("Sone/Sone." + soneId + "/ID").setValue(null);
 483
 484                 } catch (ConfigurationException ce1) {
 485                         logger.log(Level.WARNING, "Could not store configuration!", ce1);
 486                 }
 487         }
 488
 489 }