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