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