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(final String requestUri) {
 312                 new Thread(new Runnable() {
 313
 314                         @Override
 315                         @SuppressWarnings("synthetic-access")
 316                         public void run() {
 317                                 try {
 318                                         FreenetURI realRequestUri = new FreenetURI(requestUri).setMetaString(new String[] { "sone.xml" });
 319                                         FetchResult fetchResult = freenetInterface.fetchUri(realRequestUri);
 320                                         Sone parsedSone = soneDownloader.parseSone(null, fetchResult, realRequestUri);
 321                                         if (parsedSone != null) {
 322                                                 addSone(parsedSone);
 323                                         }
 324                                 } catch (MalformedURLException mue1) {
 325                                         logger.log(Level.INFO, "Could not create URI from “" + requestUri + "”.", mue1);
 326                                 }
 327                         }
 328                 }, "Sone Downloader").start();
 329         }
 330
 331         /**
 332          * Deletes the given Sone from this plugin instance.
 333          *
 334          * @param sone
 335          *            The sone to delete
 336          */
 337         public void deleteSone(Sone sone) {
 338                 SoneInserter soneInserter = soneInserters.remove(sone);
 339                 soneInserter.stop();
 340                 localSones.remove(sone);
 341         }
 342
 343         /**
 344          * Returns the post with the given ID. If no post exists yet with the given
 345          * ID, a new post is returned.
 346          *
 347          * @param postId
 348          *            The ID of the post
 349          * @return The post
 350          */
 351         public Post getPost(String postId) {
 352                 if (!postCache.containsKey(postId)) {
 353                         postCache.put(postId, new Post(postId));
 354                 }
 355                 return postCache.get(postId);
 356         }
 357
 358         /**
 359          * Returns the reply with the given ID. If no reply exists yet with the
 360          * given ID, a new reply is returned.
 361          *
 362          * @param replyId
 363          *            The ID of the reply
 364          * @return The reply
 365          */
 366         public Reply getReply(String replyId) {
 367                 if (!replyCache.containsKey(replyId)) {
 368                         replyCache.put(replyId, new Reply(replyId));
 369                 }
 370                 return replyCache.get(replyId);
 371         }
 372
 373         /**
 374          * Gets all replies to the given post, sorted by date, oldest first.
 375          *
 376          * @param post
 377          *            The post the replies refer to
 378          * @return The sorted list of replies for the post
 379          */
 380         public List<Reply> getReplies(Post post) {
 381                 List<Reply> replies = new ArrayList<Reply>();
 382                 for (Reply reply : replyCache.values()) {
 383                         if (reply.getPost().equals(post)) {
 384                                 replies.add(reply);
 385                         }
 386                 }
 387                 Collections.sort(replies, new Comparator<Reply>() {
 388
 389                         /**
 390                          * {@inheritDoc}
 391                          */
 392                         @Override
 393                         public int compare(Reply leftReply, Reply rightReply) {
 394                                 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, leftReply.getTime() - rightReply.getTime()));
 395                         }
 396                 });
 397                 return replies;
 398         }
 399
 400         //
 401         // SERVICE METHODS
 402         //
 403
 404         /**
 405          * {@inheritDoc}
 406          */
 407         @Override
 408         protected void serviceStart() {
 409                 loadConfiguration();
 410         }
 411
 412         /**
 413          * {@inheritDoc}
 414          */
 415         @Override
 416         protected void serviceStop() {
 417                 soneDownloader.stop();
 418                 /* stop all Sone inserters. */
 419                 for (SoneInserter soneInserter : soneInserters.values()) {
 420                         soneInserter.stop();
 421                 }
 422                 saveConfiguration();
 423         }
 424
 425         //
 426         // PRIVATE METHODS
 427         //
 428
 429         /**
 430          * Loads the configuration.
 431          */
 432         private void loadConfiguration() {
 433                 logger.entering(Core.class.getName(), "loadConfiguration()");
 434
 435                 /* parse local Sones. */
 436                 logger.log(Level.INFO, "Loading Sones…");
 437                 int soneId = 0;
 438                 do {
 439                         String sonePrefix = "Sone/Sone." + soneId++;
 440                         String id = configuration.getStringValue(sonePrefix + "/ID").getValue(null);
 441                         if (id == null) {
 442                                 break;
 443                         }
 444                         String name = configuration.getStringValue(sonePrefix + "/Name").getValue(null);
 445                         String insertUri = configuration.getStringValue(sonePrefix + "/InsertURI").getValue(null);
 446                         String requestUri = configuration.getStringValue(sonePrefix + "/RequestURI").getValue(null);
 447                         long modificationCounter = configuration.getLongValue(sonePrefix + "/ModificationCounter").getValue((long) 0);
 448                         String firstName = configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null);
 449                         String middleName = configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null);
 450                         String lastName = configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null);
 451                         try {
 452                                 Profile profile = new Profile();
 453                                 profile.setFirstName(firstName);
 454                                 profile.setMiddleName(middleName);
 455                                 profile.setLastName(lastName);
 456                                 Sone sone = getSone(id).setName(name).setRequestUri(new FreenetURI(requestUri)).setInsertUri(new FreenetURI(insertUri));
 457                                 sone.setProfile(profile);
 458                                 int postId = 0;
 459                                 do {
 460                                         String postPrefix = sonePrefix + "/Post." + postId++;
 461                                         id = configuration.getStringValue(postPrefix + "/ID").getValue(null);
 462                                         if (id == null) {
 463                                                 break;
 464                                         }
 465                                         long time = configuration.getLongValue(postPrefix + "/Time").getValue(null);
 466                                         String text = configuration.getStringValue(postPrefix + "/Text").getValue(null);
 467                                         Post post = getPost(id).setSone(sone).setTime(time).setText(text);
 468                                         sone.addPost(post);
 469                                 } while (true);
 470                                 int replyCounter = 0;
 471                                 do {
 472                                         String replyPrefix = sonePrefix + "/Reply." + replyCounter++;
 473                                         String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
 474                                         if (replyId == null) {
 475                                                 break;
 476                                         }
 477                                         Post replyPost = getPost(configuration.getStringValue(replyPrefix + "/Post").getValue(null));
 478                                         long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue(null);
 479                                         String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
 480                                         Reply reply = getReply(replyId).setSone(sone).setPost(replyPost).setTime(replyTime).setText(replyText);
 481                                         sone.addReply(reply);
 482                                 } while (true);
 483
 484                                 /* load friends. */
 485                                 int friendCounter = 0;
 486                                 while (true) {
 487                                         String friendPrefix = sonePrefix + "/Friend." + friendCounter++;
 488                                         String friendId = configuration.getStringValue(friendPrefix + "/ID").getValue(null);
 489                                         if (friendId == null) {
 490                                                 break;
 491                                         }
 492                                         Sone friendSone = getSone(friendId);
 493                                         String friendKey = configuration.getStringValue(friendPrefix + "/Key").getValue(null);
 494                                         String friendName = configuration.getStringValue(friendPrefix + "/Name").getValue(null);
 495                                         friendSone.setRequestUri(new FreenetURI(friendKey)).setName(friendName);
 496                                         soneDownloader.addSone(friendSone);
 497                                         sone.addFriend(friendSone);
 498                                 }
 499
 500                                 sone.setModificationCounter(modificationCounter);
 501                                 addLocalSone(sone);
 502                         } catch (MalformedURLException mue1) {
 503                                 logger.log(Level.WARNING, "Could not create Sone from requestUri (“" + requestUri + "”) and insertUri (“" + insertUri + "”)!", mue1);
 504                         }
 505                 } while (true);
 506                 logger.log(Level.INFO, "Loaded %d Sones.", getSones().size());
 507
 508                 logger.exiting(Core.class.getName(), "loadConfiguration()");
 509         }
 510
 511         /**
 512          * Saves the configuraiton.
 513          */
 514         private void saveConfiguration() {
 515                 Set<Sone> sones = getSones();
 516                 logger.log(Level.INFO, "Storing %d Sones…", sones.size());
 517                 try {
 518                         /* store all Sones. */
 519                         int soneId = 0;
 520                         for (Sone sone : localSones) {
 521                                 String sonePrefix = "Sone/Sone." + soneId++;
 522                                 configuration.getStringValue(sonePrefix + "/ID").setValue(sone.getId());
 523                                 configuration.getStringValue(sonePrefix + "/Name").setValue(sone.getName());
 524                                 configuration.getStringValue(sonePrefix + "/RequestURI").setValue(sone.getRequestUri().toString());
 525                                 configuration.getStringValue(sonePrefix + "/InsertURI").setValue(sone.getInsertUri().toString());
 526                                 configuration.getLongValue(sonePrefix + "/ModificationCounter").setValue(sone.getModificationCounter());
 527                                 Profile profile = sone.getProfile();
 528                                 configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
 529                                 configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
 530                                 configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
 531                                 int postId = 0;
 532                                 for (Post post : sone.getPosts()) {
 533                                         String postPrefix = sonePrefix + "/Post." + postId++;
 534                                         configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
 535                                         configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
 536                                         configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
 537                                 }
 538                                 /* write null ID as terminator. */
 539                                 configuration.getStringValue(sonePrefix + "/Post." + postId + "/ID").setValue(null);
 540
 541                                 int replyId = 0;
 542                                 for (Reply reply : sone.getReplies()) {
 543                                         String replyPrefix = sonePrefix + "/Reply." + replyId++;
 544                                         configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
 545                                         configuration.getStringValue(replyPrefix + "/Post").setValue(reply.getPost().getId());
 546                                         configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
 547                                         configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
 548                                 }
 549                                 /* write null ID as terminator. */
 550                                 configuration.getStringValue(sonePrefix + "/Reply." + replyId + "/ID").setValue(null);
 551
 552                                 int friendId = 0;
 553                                 for (Sone friend : sone.getFriends()) {
 554                                         String friendPrefix = sonePrefix + "/Friend." + friendId++;
 555                                         configuration.getStringValue(friendPrefix + "/ID").setValue(friend.getId());
 556                                         configuration.getStringValue(friendPrefix + "/Key").setValue(friend.getRequestUri().toString());
 557                                         configuration.getStringValue(friendPrefix + "/Name").setValue(friend.getName());
 558                                 }
 559                                 /* write null ID as terminator. */
 560                                 configuration.getStringValue(sonePrefix + "/Friend." + friendId + "/ID").setValue(null);
 561
 562                         }
 563                         /* write null ID as terminator. */
 564                         configuration.getStringValue("Sone/Sone." + soneId + "/ID").setValue(null);
 565
 566                 } catch (ConfigurationException ce1) {
 567                         logger.log(Level.WARNING, "Could not store configuration!", ce1);
 568                 }
 569         }
 570
 571 }