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