src/main/java/net/pterodactylus/sone/core/Core.java

   1 /*
   2  * Sone - 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.HashMap;
  24 import java.util.HashSet;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.Set;
  28 import java.util.logging.Level;
  29 import java.util.logging.Logger;
  30
  31 import net.pterodactylus.sone.core.Options.DefaultOption;
  32 import net.pterodactylus.sone.core.Options.Option;
  33 import net.pterodactylus.sone.core.Options.OptionWatcher;
  34 import net.pterodactylus.sone.data.Client;
  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.sone.freenet.wot.Identity;
  40 import net.pterodactylus.sone.freenet.wot.IdentityListener;
  41 import net.pterodactylus.sone.freenet.wot.IdentityManager;
  42 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
  43 import net.pterodactylus.sone.main.SonePlugin;
  44 import net.pterodactylus.util.config.Configuration;
  45 import net.pterodactylus.util.config.ConfigurationException;
  46 import net.pterodactylus.util.logging.Logging;
  47 import net.pterodactylus.util.number.Numbers;
  48 import freenet.keys.FreenetURI;
  49
  50 /**
  51  * The Sone core.
  52  *
  53  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  54  */
  55 public class Core implements IdentityListener {
  56
  57         /**
  58          * Enumeration for the possible states of a {@link Sone}.
  59          *
  60          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  61          */
  62         public enum SoneStatus {
  63
  64                 /** The Sone is unknown, i.e. not yet downloaded. */
  65                 unknown,
  66
  67                 /** The Sone is idle, i.e. not being downloaded or inserted. */
  68                 idle,
  69
  70                 /** The Sone is currently being inserted. */
  71                 inserting,
  72
  73                 /** The Sone is currently being downloaded. */
  74                 downloading,
  75         }
  76
  77         /** The logger. */
  78         private static final Logger logger = Logging.getLogger(Core.class);
  79
  80         /** The options. */
  81         private final Options options = new Options();
  82
  83         /** The core listener manager. */
  84         private final CoreListenerManager coreListenerManager = new CoreListenerManager(this);
  85
  86         /** The configuration. */
  87         private final Configuration configuration;
  88
  89         /** The identity manager. */
  90         private final IdentityManager identityManager;
  91
  92         /** Interface to freenet. */
  93         private final FreenetInterface freenetInterface;
  94
  95         /** The Sone downloader. */
  96         private final SoneDownloader soneDownloader;
  97
  98         /** The Sones’ statuses. */
  99         /* synchronize access on itself. */
 100         private final Map<Sone, SoneStatus> soneStatuses = new HashMap<Sone, SoneStatus>();
 101
 102         /** Sone inserters. */
 103         /* synchronize access on this on localSones. */
 104         private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
 105
 106         /** All local Sones. */
 107         /* synchronize access on this on itself. */
 108         private Map<String, Sone> localSones = new HashMap<String, Sone>();
 109
 110         /** All remote Sones. */
 111         /* synchronize access on this on itself. */
 112         private Map<String, Sone> remoteSones = new HashMap<String, Sone>();
 113
 114         /** All new Sones. */
 115         private Set<String> newSones = new HashSet<String>();
 116
 117         /** All known Sones. */
 118         /* synchronize access on {@link #newSones}. */
 119         private Set<String> knownSones = new HashSet<String>();
 120
 121         /** All posts. */
 122         private Map<String, Post> posts = new HashMap<String, Post>();
 123
 124         /** All new posts. */
 125         private Set<String> newPosts = new HashSet<String>();
 126
 127         /** All known posts. */
 128         /* synchronize access on {@link #newPosts}. */
 129         private Set<String> knownPosts = new HashSet<String>();
 130
 131         /** All replies. */
 132         private Map<String, Reply> replies = new HashMap<String, Reply>();
 133
 134         /** All new replies. */
 135         private Set<String> newReplies = new HashSet<String>();
 136
 137         /** All known replies. */
 138         private Set<String> knownReplies = new HashSet<String>();
 139
 140         /**
 141          * Creates a new core.
 142          *
 143          * @param configuration
 144          *            The configuration of the core
 145          * @param freenetInterface
 146          *            The freenet interface
 147          * @param identityManager
 148          *            The identity manager
 149          */
 150         public Core(Configuration configuration, FreenetInterface freenetInterface, IdentityManager identityManager) {
 151                 this.configuration = configuration;
 152                 this.freenetInterface = freenetInterface;
 153                 this.identityManager = identityManager;
 154                 this.soneDownloader = new SoneDownloader(this, freenetInterface);
 155         }
 156
 157         //
 158         // LISTENER MANAGEMENT
 159         //
 160
 161         /**
 162          * Adds a new core listener.
 163          *
 164          * @param coreListener
 165          *            The listener to add
 166          */
 167         public void addCoreListener(CoreListener coreListener) {
 168                 coreListenerManager.addListener(coreListener);
 169         }
 170
 171         /**
 172          * Removes a core listener.
 173          *
 174          * @param coreListener
 175          *            The listener to remove
 176          */
 177         public void removeCoreListener(CoreListener coreListener) {
 178                 coreListenerManager.removeListener(coreListener);
 179         }
 180
 181         //
 182         // ACCESSORS
 183         //
 184
 185         /**
 186          * Returns the options used by the core.
 187          *
 188          * @return The options of the core
 189          */
 190         public Options getOptions() {
 191                 return options;
 192         }
 193
 194         /**
 195          * Returns the identity manager used by the core.
 196          *
 197          * @return The identity manager
 198          */
 199         public IdentityManager getIdentityManager() {
 200                 return identityManager;
 201         }
 202
 203         /**
 204          * Returns the status of the given Sone.
 205          *
 206          * @param sone
 207          *            The Sone to get the status for
 208          * @return The status of the Sone
 209          */
 210         public SoneStatus getSoneStatus(Sone sone) {
 211                 synchronized (soneStatuses) {
 212                         return soneStatuses.get(sone);
 213                 }
 214         }
 215
 216         /**
 217          * Sets the status of the given Sone.
 218          *
 219          * @param sone
 220          *            The Sone to set the status of
 221          * @param soneStatus
 222          *            The status to set
 223          */
 224         public void setSoneStatus(Sone sone, SoneStatus soneStatus) {
 225                 synchronized (soneStatuses) {
 226                         soneStatuses.put(sone, soneStatus);
 227                 }
 228         }
 229
 230         /**
 231          * Returns all Sones, remote and local.
 232          *
 233          * @return All Sones
 234          */
 235         public Set<Sone> getSones() {
 236                 Set<Sone> allSones = new HashSet<Sone>();
 237                 allSones.addAll(getLocalSones());
 238                 allSones.addAll(getRemoteSones());
 239                 return allSones;
 240         }
 241
 242         /**
 243          * Returns the Sone with the given ID, regardless whether it’s local or
 244          * remote.
 245          *
 246          * @param id
 247          *            The ID of the Sone to get
 248          * @return The Sone with the given ID, or {@code null} if there is no such
 249          *         Sone
 250          */
 251         public Sone getSone(String id) {
 252                 return getSone(id, true);
 253         }
 254
 255         /**
 256          * Returns the Sone with the given ID, regardless whether it’s local or
 257          * remote.
 258          *
 259          * @param id
 260          *            The ID of the Sone to get
 261          * @param create
 262          *            {@code true} to create a new Sone if none exists,
 263          *            {@code false} to return {@code null} if a Sone with the given
 264          *            ID does not exist
 265          * @return The Sone with the given ID, or {@code null} if there is no such
 266          *         Sone
 267          */
 268         public Sone getSone(String id, boolean create) {
 269                 if (isLocalSone(id)) {
 270                         return getLocalSone(id);
 271                 }
 272                 return getRemoteSone(id, create);
 273         }
 274
 275         /**
 276          * Checks whether the core knows a Sone with the given ID.
 277          *
 278          * @param id
 279          *            The ID of the Sone
 280          * @return {@code true} if there is a Sone with the given ID, {@code false}
 281          *         otherwise
 282          */
 283         public boolean hasSone(String id) {
 284                 return isLocalSone(id) || isRemoteSone(id);
 285         }
 286
 287         /**
 288          * Returns whether the given Sone is a local Sone.
 289          *
 290          * @param sone
 291          *            The Sone to check for its locality
 292          * @return {@code true} if the given Sone is local, {@code false} otherwise
 293          */
 294         public boolean isLocalSone(Sone sone) {
 295                 synchronized (localSones) {
 296                         return localSones.containsKey(sone.getId());
 297                 }
 298         }
 299
 300         /**
 301          * Returns whether the given ID is the ID of a local Sone.
 302          *
 303          * @param id
 304          *            The Sone ID to check for its locality
 305          * @return {@code true} if the given ID is a local Sone, {@code false}
 306          *         otherwise
 307          */
 308         public boolean isLocalSone(String id) {
 309                 synchronized (localSones) {
 310                         return localSones.containsKey(id);
 311                 }
 312         }
 313
 314         /**
 315          * Returns all local Sones.
 316          *
 317          * @return All local Sones
 318          */
 319         public Set<Sone> getLocalSones() {
 320                 synchronized (localSones) {
 321                         return new HashSet<Sone>(localSones.values());
 322                 }
 323         }
 324
 325         /**
 326          * Returns the local Sone with the given ID.
 327          *
 328          * @param id
 329          *            The ID of the Sone to get
 330          * @return The Sone with the given ID
 331          */
 332         public Sone getLocalSone(String id) {
 333                 return getLocalSone(id, true);
 334         }
 335
 336         /**
 337          * Returns the local Sone with the given ID, optionally creating a new Sone.
 338          *
 339          * @param id
 340          *            The ID of the Sone
 341          * @param create
 342          *            {@code true} to create a new Sone if none exists,
 343          *            {@code false} to return null if none exists
 344          * @return The Sone with the given ID, or {@code null}
 345          */
 346         public Sone getLocalSone(String id, boolean create) {
 347                 synchronized (localSones) {
 348                         Sone sone = localSones.get(id);
 349                         if ((sone == null) && create) {
 350                                 sone = new Sone(id);
 351                                 localSones.put(id, sone);
 352                         }
 353                         return sone;
 354                 }
 355         }
 356
 357         /**
 358          * Returns all remote Sones.
 359          *
 360          * @return All remote Sones
 361          */
 362         public Set<Sone> getRemoteSones() {
 363                 synchronized (remoteSones) {
 364                         return new HashSet<Sone>(remoteSones.values());
 365                 }
 366         }
 367
 368         /**
 369          * Returns the remote Sone with the given ID.
 370          *
 371          * @param id
 372          *            The ID of the remote Sone to get
 373          * @return The Sone with the given ID
 374          */
 375         public Sone getRemoteSone(String id) {
 376                 return getRemoteSone(id, true);
 377         }
 378
 379         /**
 380          * Returns the remote Sone with the given ID.
 381          *
 382          * @param id
 383          *            The ID of the remote Sone to get
 384          * @param create
 385          *            {@code true} to always create a Sone, {@code false} to return
 386          *            {@code null} if no Sone with the given ID exists
 387          * @return The Sone with the given ID
 388          */
 389         public Sone getRemoteSone(String id, boolean create) {
 390                 synchronized (remoteSones) {
 391                         Sone sone = remoteSones.get(id);
 392                         if ((sone == null) && create) {
 393                                 sone = new Sone(id);
 394                                 remoteSones.put(id, sone);
 395                         }
 396                         return sone;
 397                 }
 398         }
 399
 400         /**
 401          * Returns whether the given Sone is a remote Sone.
 402          *
 403          * @param sone
 404          *            The Sone to check
 405          * @return {@code true} if the given Sone is a remote Sone, {@code false}
 406          *         otherwise
 407          */
 408         public boolean isRemoteSone(Sone sone) {
 409                 synchronized (remoteSones) {
 410                         return remoteSones.containsKey(sone.getId());
 411                 }
 412         }
 413
 414         /**
 415          * Returns whether the Sone with the given ID is a remote Sone.
 416          *
 417          * @param id
 418          *            The ID of the Sone to check
 419          * @return {@code true} if the Sone with the given ID is a remote Sone,
 420          *         {@code false} otherwise
 421          */
 422         public boolean isRemoteSone(String id) {
 423                 synchronized (remoteSones) {
 424                         return remoteSones.containsKey(id);
 425                 }
 426         }
 427
 428         /**
 429          * Returns whether the given Sone is a new Sone. After this check, the Sone
 430          * is marked as known, i.e. a second call with the same parameters will
 431          * always yield {@code false}.
 432          *
 433          * @param sone
 434          *            The sone to check for
 435          * @return {@code true} if the given Sone is new, false otherwise
 436          */
 437         public boolean isNewSone(Sone sone) {
 438                 synchronized (newSones) {
 439                         boolean isNew = !knownSones.contains(sone.getId()) && newSones.remove(sone.getId());
 440                         knownSones.add(sone.getId());
 441                         if (isNew) {
 442                                 coreListenerManager.fireMarkSoneKnown(sone);
 443                         }
 444                         return isNew;
 445                 }
 446         }
 447
 448         /**
 449          * Returns whether the given Sone has been modified.
 450          *
 451          * @param sone
 452          *            The Sone to check for modifications
 453          * @return {@code true} if a modification has been detected in the Sone,
 454          *         {@code false} otherwise
 455          */
 456         public boolean isModifiedSone(Sone sone) {
 457                 return (soneInserters.containsKey(sone)) ? soneInserters.get(sone).isModified() : false;
 458         }
 459
 460         /**
 461          * Returns the post with the given ID.
 462          *
 463          * @param postId
 464          *            The ID of the post to get
 465          * @return The post, or {@code null} if there is no such post
 466          */
 467         public Post getPost(String postId) {
 468                 synchronized (posts) {
 469                         Post post = posts.get(postId);
 470                         if (post == null) {
 471                                 post = new Post(postId);
 472                                 posts.put(postId, post);
 473                         }
 474                         return post;
 475                 }
 476         }
 477
 478         /**
 479          * Returns whether the given post ID is new. After this method returns it is
 480          * marked a known post ID.
 481          *
 482          * @param postId
 483          *            The post ID
 484          * @return {@code true} if the post is considered to be new, {@code false}
 485          *         otherwise
 486          */
 487         public boolean isNewPost(String postId) {
 488                 synchronized (newPosts) {
 489                         boolean isNew = !knownPosts.contains(postId) && newPosts.remove(postId);
 490                         knownPosts.add(postId);
 491                         if (isNew) {
 492                                 coreListenerManager.fireMarkPostKnown(getPost(postId));
 493                         }
 494                         return isNew;
 495                 }
 496         }
 497
 498         /**
 499          * Returns the reply with the given ID.
 500          *
 501          * @param replyId
 502          *            The ID of the reply to get
 503          * @return The reply, or {@code null} if there is no such reply
 504          */
 505         public Reply getReply(String replyId) {
 506                 synchronized (replies) {
 507                         Reply reply = replies.get(replyId);
 508                         if (reply == null) {
 509                                 reply = new Reply(replyId);
 510                                 replies.put(replyId, reply);
 511                         }
 512                         return reply;
 513                 }
 514         }
 515
 516         /**
 517          * Returns all replies for the given post, order ascending by time.
 518          *
 519          * @param post
 520          *            The post to get all replies for
 521          * @return All replies for the given post
 522          */
 523         public List<Reply> getReplies(Post post) {
 524                 Set<Sone> sones = getSones();
 525                 List<Reply> replies = new ArrayList<Reply>();
 526                 for (Sone sone : sones) {
 527                         for (Reply reply : sone.getReplies()) {
 528                                 if (reply.getPost().equals(post)) {
 529                                         replies.add(reply);
 530                                 }
 531                         }
 532                 }
 533                 Collections.sort(replies, Reply.TIME_COMPARATOR);
 534                 return replies;
 535         }
 536
 537         /**
 538          * Returns whether the reply with the given ID is new.
 539          *
 540          * @param replyId
 541          *            The ID of the reply to check
 542          * @return {@code true} if the reply is considered to be new, {@code false}
 543          *         otherwise
 544          */
 545         public boolean isNewReply(String replyId) {
 546                 synchronized (newReplies) {
 547                         boolean isNew = !knownReplies.contains(replyId) && newReplies.remove(replyId);
 548                         knownReplies.add(replyId);
 549                         if (isNew) {
 550                                 coreListenerManager.fireMarkReplyKnown(getReply(replyId));
 551                         }
 552                         return isNew;
 553                 }
 554         }
 555
 556         /**
 557          * Returns all Sones that have liked the given post.
 558          *
 559          * @param post
 560          *            The post to get the liking Sones for
 561          * @return The Sones that like the given post
 562          */
 563         public Set<Sone> getLikes(Post post) {
 564                 Set<Sone> sones = new HashSet<Sone>();
 565                 for (Sone sone : getSones()) {
 566                         if (sone.getLikedPostIds().contains(post.getId())) {
 567                                 sones.add(sone);
 568                         }
 569                 }
 570                 return sones;
 571         }
 572
 573         /**
 574          * Returns all Sones that have liked the given reply.
 575          *
 576          * @param reply
 577          *            The reply to get the liking Sones for
 578          * @return The Sones that like the given reply
 579          */
 580         public Set<Sone> getLikes(Reply reply) {
 581                 Set<Sone> sones = new HashSet<Sone>();
 582                 for (Sone sone : getSones()) {
 583                         if (sone.getLikedReplyIds().contains(reply.getId())) {
 584                                 sones.add(sone);
 585                         }
 586                 }
 587                 return sones;
 588         }
 589
 590         //
 591         // ACTIONS
 592         //
 593
 594         /**
 595          * Adds a local Sone from the given ID which has to be the ID of an own
 596          * identity.
 597          *
 598          * @param id
 599          *            The ID of an own identity to add a Sone for
 600          * @return The added (or already existing) Sone
 601          */
 602         public Sone addLocalSone(String id) {
 603                 synchronized (localSones) {
 604                         if (localSones.containsKey(id)) {
 605                                 logger.log(Level.FINE, "Tried to add known local Sone: %s", id);
 606                                 return localSones.get(id);
 607                         }
 608                         OwnIdentity ownIdentity = identityManager.getOwnIdentity(id);
 609                         if (ownIdentity == null) {
 610                                 logger.log(Level.INFO, "Invalid Sone ID: %s", id);
 611                                 return null;
 612                         }
 613                         return addLocalSone(ownIdentity);
 614                 }
 615         }
 616
 617         /**
 618          * Adds a local Sone from the given own identity.
 619          *
 620          * @param ownIdentity
 621          *            The own identity to create a Sone from
 622          * @return The added (or already existing) Sone
 623          */
 624         public Sone addLocalSone(OwnIdentity ownIdentity) {
 625                 if (ownIdentity == null) {
 626                         logger.log(Level.WARNING, "Given OwnIdentity is null!");
 627                         return null;
 628                 }
 629                 synchronized (localSones) {
 630                         final Sone sone;
 631                         try {
 632                                 sone = getLocalSone(ownIdentity.getId()).setIdentity(ownIdentity).setInsertUri(new FreenetURI(ownIdentity.getInsertUri())).setRequestUri(new FreenetURI(ownIdentity.getRequestUri()));
 633                         } catch (MalformedURLException mue1) {
 634                                 logger.log(Level.SEVERE, "Could not convert the Identity’s URIs to Freenet URIs: " + ownIdentity.getInsertUri() + ", " + ownIdentity.getRequestUri(), mue1);
 635                                 return null;
 636                         }
 637                         sone.setLatestEdition(Numbers.safeParseLong(ownIdentity.getProperty("Sone.LatestEdition"), (long) 0));
 638                         sone.setClient(new Client("Sone", SonePlugin.VERSION.toString()));
 639                         /* TODO - load posts ’n stuff */
 640                         localSones.put(ownIdentity.getId(), sone);
 641                         SoneInserter soneInserter = new SoneInserter(this, freenetInterface, sone);
 642                         soneInserters.put(sone, soneInserter);
 643                         setSoneStatus(sone, SoneStatus.idle);
 644                         loadSone(sone);
 645                         soneInserter.start();
 646                         new Thread(new Runnable() {
 647
 648                                 @Override
 649                                 @SuppressWarnings("synthetic-access")
 650                                 public void run() {
 651                                         soneDownloader.fetchSone(sone);
 652                                 }
 653
 654                         }, "Sone Downloader").start();
 655                         return sone;
 656                 }
 657         }
 658
 659         /**
 660          * Creates a new Sone for the given own identity.
 661          *
 662          * @param ownIdentity
 663          *            The own identity to create a Sone for
 664          * @return The created Sone
 665          */
 666         public Sone createSone(OwnIdentity ownIdentity) {
 667                 identityManager.addContext(ownIdentity, "Sone");
 668                 Sone sone = addLocalSone(ownIdentity);
 669                 return sone;
 670         }
 671
 672         /**
 673          * Adds the Sone of the given identity.
 674          *
 675          * @param identity
 676          *            The identity whose Sone to add
 677          * @return The added or already existing Sone
 678          */
 679         public Sone addRemoteSone(Identity identity) {
 680                 if (identity == null) {
 681                         logger.log(Level.WARNING, "Given Identity is null!");
 682                         return null;
 683                 }
 684                 synchronized (remoteSones) {
 685                         final Sone sone = getRemoteSone(identity.getId()).setIdentity(identity);
 686                         boolean newSone = sone.getRequestUri() == null;
 687                         sone.setRequestUri(getSoneUri(identity.getRequestUri()));
 688                         sone.setLatestEdition(Numbers.safeParseLong(identity.getProperty("Sone.LatestEdition"), (long) 0));
 689                         if (newSone) {
 690                                 synchronized (newSones) {
 691                                         newSone = !knownSones.contains(sone.getId());
 692                                         if (newSone) {
 693                                                 newSones.add(sone.getId());
 694                                         }
 695                                 }
 696                                 if (newSone) {
 697                                         coreListenerManager.fireNewSoneFound(sone);
 698                                 }
 699                         }
 700                         remoteSones.put(identity.getId(), sone);
 701                         soneDownloader.addSone(sone);
 702                         setSoneStatus(sone, SoneStatus.unknown);
 703                         new Thread(new Runnable() {
 704
 705                                 @Override
 706                                 @SuppressWarnings("synthetic-access")
 707                                 public void run() {
 708                                         soneDownloader.fetchSone(sone);
 709                                 }
 710
 711                         }, "Sone Downloader").start();
 712                         return sone;
 713                 }
 714         }
 715
 716         /**
 717          * Updates the stores Sone with the given Sone.
 718          *
 719          * @param sone
 720          *            The updated Sone
 721          */
 722         public void updateSone(Sone sone) {
 723                 if (hasSone(sone.getId())) {
 724                         Sone storedSone = getSone(sone.getId());
 725                         if (!(sone.getTime() > storedSone.getTime())) {
 726                                 logger.log(Level.FINE, "Downloaded Sone %s is not newer than stored Sone %s.", new Object[] { sone, storedSone });
 727                                 return;
 728                         }
 729                         synchronized (posts) {
 730                                 for (Post post : storedSone.getPosts()) {
 731                                         posts.remove(post.getId());
 732                                 }
 733                                 synchronized (newPosts) {
 734                                         for (Post post : sone.getPosts()) {
 735                                                 if (!storedSone.getPosts().contains(post) && !knownPosts.contains(post.getId())) {
 736                                                         newPosts.add(post.getId());
 737                                                 }
 738                                                 posts.put(post.getId(), post);
 739                                         }
 740                                 }
 741                         }
 742                         synchronized (replies) {
 743                                 for (Reply reply : storedSone.getReplies()) {
 744                                         replies.remove(reply.getId());
 745                                 }
 746                                 synchronized (newReplies) {
 747                                         for (Reply reply : sone.getReplies()) {
 748                                                 if (!storedSone.getReplies().contains(reply) && !knownReplies.contains(reply.getId())) {
 749                                                         newReplies.add(reply.getId());
 750                                                 }
 751                                                 replies.put(reply.getId(), reply);
 752                                         }
 753                                 }
 754                         }
 755                         synchronized (storedSone) {
 756                                 storedSone.setTime(sone.getTime());
 757                                 storedSone.setClient(sone.getClient());
 758                                 storedSone.setProfile(sone.getProfile());
 759                                 storedSone.setPosts(sone.getPosts());
 760                                 storedSone.setReplies(sone.getReplies());
 761                                 storedSone.setLikePostIds(sone.getLikedPostIds());
 762                                 storedSone.setLikeReplyIds(sone.getLikedReplyIds());
 763                                 storedSone.setLatestEdition(sone.getRequestUri().getEdition());
 764                         }
 765                 }
 766         }
 767
 768         /**
 769          * Deletes the given Sone. This will remove the Sone from the
 770          * {@link #getLocalSone(String) local Sones}, stops its {@link SoneInserter}
 771          * and remove the context from its identity.
 772          *
 773          * @param sone
 774          *            The Sone to delete
 775          */
 776         public void deleteSone(Sone sone) {
 777                 if (!(sone.getIdentity() instanceof OwnIdentity)) {
 778                         logger.log(Level.WARNING, "Tried to delete Sone of non-own identity: %s", sone);
 779                         return;
 780                 }
 781                 synchronized (localSones) {
 782                         if (!localSones.containsKey(sone.getId())) {
 783                                 logger.log(Level.WARNING, "Tried to delete non-local Sone: %s", sone);
 784                                 return;
 785                         }
 786                         localSones.remove(sone.getId());
 787                         soneInserters.remove(sone).stop();
 788                 }
 789                 identityManager.removeContext((OwnIdentity) sone.getIdentity(), "Sone");
 790                 identityManager.removeProperty((OwnIdentity) sone.getIdentity(), "Sone.LatestEdition");
 791                 try {
 792                         configuration.getLongValue("Sone/" + sone.getId() + "/Time").setValue(null);
 793                 } catch (ConfigurationException ce1) {
 794                         logger.log(Level.WARNING, "Could not remove Sone from configuration!", ce1);
 795                 }
 796         }
 797
 798         /**
 799          * Loads and updates the given Sone from the configuration. If any error is
 800          * encountered, loading is aborted and the given Sone is not changed.
 801          *
 802          * @param sone
 803          *            The Sone to load and update
 804          */
 805         public void loadSone(Sone sone) {
 806                 if (!isLocalSone(sone)) {
 807                         logger.log(Level.FINE, "Tried to load non-local Sone: %s", sone);
 808                         return;
 809                 }
 810
 811                 /* load Sone. */
 812                 String sonePrefix = "Sone/" + sone.getId();
 813                 Long soneTime = configuration.getLongValue(sonePrefix + "/Time").getValue(null);
 814                 if (soneTime == null) {
 815                         logger.log(Level.INFO, "Could not load Sone because no Sone has been saved.");
 816                         return;
 817                 }
 818                 String lastInsertFingerprint = configuration.getStringValue(sonePrefix + "/LastInsertFingerprint").getValue("");
 819
 820                 /* load profile. */
 821                 Profile profile = new Profile();
 822                 profile.setFirstName(configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null));
 823                 profile.setMiddleName(configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null));
 824                 profile.setLastName(configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null));
 825                 profile.setBirthDay(configuration.getIntValue(sonePrefix + "/Profile/BirthDay").getValue(null));
 826                 profile.setBirthMonth(configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").getValue(null));
 827                 profile.setBirthYear(configuration.getIntValue(sonePrefix + "/Profile/BirthYear").getValue(null));
 828
 829                 /* load posts. */
 830                 Set<Post> posts = new HashSet<Post>();
 831                 while (true) {
 832                         String postPrefix = sonePrefix + "/Posts/" + posts.size();
 833                         String postId = configuration.getStringValue(postPrefix + "/ID").getValue(null);
 834                         if (postId == null) {
 835                                 break;
 836                         }
 837                         long postTime = configuration.getLongValue(postPrefix + "/Time").getValue((long) 0);
 838                         String postText = configuration.getStringValue(postPrefix + "/Text").getValue(null);
 839                         if ((postTime == 0) || (postText == null)) {
 840                                 logger.log(Level.WARNING, "Invalid post found, aborting load!");
 841                                 return;
 842                         }
 843                         posts.add(getPost(postId).setSone(sone).setTime(postTime).setText(postText));
 844                 }
 845
 846                 /* load replies. */
 847                 Set<Reply> replies = new HashSet<Reply>();
 848                 while (true) {
 849                         String replyPrefix = sonePrefix + "/Replies/" + replies.size();
 850                         String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
 851                         if (replyId == null) {
 852                                 break;
 853                         }
 854                         String postId = configuration.getStringValue(replyPrefix + "/Post/ID").getValue(null);
 855                         long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue((long) 0);
 856                         String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
 857                         if ((postId == null) || (replyTime == 0) || (replyText == null)) {
 858                                 logger.log(Level.WARNING, "Invalid reply found, aborting load!");
 859                                 return;
 860                         }
 861                         replies.add(getReply(replyId).setSone(sone).setPost(getPost(postId)).setTime(replyTime).setText(replyText));
 862                 }
 863
 864                 /* load post likes. */
 865                 Set<String> likedPostIds = new HashSet<String>();
 866                 while (true) {
 867                         String likedPostId = configuration.getStringValue(sonePrefix + "/Likes/Post/" + likedPostIds.size() + "/ID").getValue(null);
 868                         if (likedPostId == null) {
 869                                 break;
 870                         }
 871                         likedPostIds.add(likedPostId);
 872                 }
 873
 874                 /* load reply likes. */
 875                 Set<String> likedReplyIds = new HashSet<String>();
 876                 while (true) {
 877                         String likedReplyId = configuration.getStringValue(sonePrefix + "/Likes/Reply/" + likedReplyIds.size() + "/ID").getValue(null);
 878                         if (likedReplyId == null) {
 879                                 break;
 880                         }
 881                         likedReplyIds.add(likedReplyId);
 882                 }
 883
 884                 /* load friends. */
 885                 Set<String> friends = new HashSet<String>();
 886                 while (true) {
 887                         String friendId = configuration.getStringValue(sonePrefix + "/Friends/" + friends.size() + "/ID").getValue(null);
 888                         if (friendId == null) {
 889                                 break;
 890                         }
 891                         friends.add(friendId);
 892                 }
 893
 894                 /* if we’re still here, Sone was loaded successfully. */
 895                 synchronized (sone) {
 896                         sone.setTime(soneTime);
 897                         sone.setProfile(profile);
 898                         sone.setPosts(posts);
 899                         sone.setReplies(replies);
 900                         sone.setLikePostIds(likedPostIds);
 901                         sone.setLikeReplyIds(likedReplyIds);
 902                         sone.setFriends(friends);
 903                         soneInserters.get(sone).setLastInsertFingerprint(lastInsertFingerprint);
 904                 }
 905                 synchronized (newSones) {
 906                         for (String friend : friends) {
 907                                 knownSones.add(friend);
 908                         }
 909                 }
 910                 synchronized (newPosts) {
 911                         for (Post post : posts) {
 912                                 knownPosts.add(post.getId());
 913                         }
 914                 }
 915                 synchronized (newReplies) {
 916                         for (Reply reply : replies) {
 917                                 knownReplies.add(reply.getId());
 918                         }
 919                 }
 920         }
 921
 922         /**
 923          * Saves the given Sone. This will persist all local settings for the given
 924          * Sone, such as the friends list and similar, private options.
 925          *
 926          * @param sone
 927          *            The Sone to save
 928          */
 929         public void saveSone(Sone sone) {
 930                 if (!isLocalSone(sone)) {
 931                         logger.log(Level.FINE, "Tried to save non-local Sone: %s", sone);
 932                         return;
 933                 }
 934                 if (!(sone.getIdentity() instanceof OwnIdentity)) {
 935                         logger.log(Level.WARNING, "Local Sone without OwnIdentity found, refusing to save: %s", sone);
 936                         return;
 937                 }
 938
 939                 logger.log(Level.INFO, "Saving Sone: %s", sone);
 940                 identityManager.setProperty((OwnIdentity) sone.getIdentity(), "Sone.LatestEdition", String.valueOf(sone.getLatestEdition()));
 941                 try {
 942                         /* save Sone into configuration. */
 943                         String sonePrefix = "Sone/" + sone.getId();
 944                         configuration.getLongValue(sonePrefix + "/Time").setValue(sone.getTime());
 945                         configuration.getStringValue(sonePrefix + "/LastInsertFingerprint").setValue(soneInserters.get(sone).getLastInsertFingerprint());
 946
 947                         /* save profile. */
 948                         Profile profile = sone.getProfile();
 949                         configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
 950                         configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
 951                         configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
 952                         configuration.getIntValue(sonePrefix + "/Profile/BirthDay").setValue(profile.getBirthDay());
 953                         configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").setValue(profile.getBirthMonth());
 954                         configuration.getIntValue(sonePrefix + "/Profile/BirthYear").setValue(profile.getBirthYear());
 955
 956                         /* save posts. */
 957                         int postCounter = 0;
 958                         for (Post post : sone.getPosts()) {
 959                                 String postPrefix = sonePrefix + "/Posts/" + postCounter++;
 960                                 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
 961                                 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
 962                                 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
 963                         }
 964                         configuration.getStringValue(sonePrefix + "/Posts/" + postCounter + "/ID").setValue(null);
 965
 966                         /* save replies. */
 967                         int replyCounter = 0;
 968                         for (Reply reply : sone.getReplies()) {
 969                                 String replyPrefix = sonePrefix + "/Replies/" + replyCounter++;
 970                                 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
 971                                 configuration.getStringValue(replyPrefix + "/Post/ID").setValue(reply.getPost().getId());
 972                                 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
 973                                 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
 974                         }
 975                         configuration.getStringValue(sonePrefix + "/Replies/" + replyCounter + "/ID").setValue(null);
 976
 977                         /* save post likes. */
 978                         int postLikeCounter = 0;
 979                         for (String postId : sone.getLikedPostIds()) {
 980                                 configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter++ + "/ID").setValue(postId);
 981                         }
 982                         configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter + "/ID").setValue(null);
 983
 984                         /* save reply likes. */
 985                         int replyLikeCounter = 0;
 986                         for (String replyId : sone.getLikedReplyIds()) {
 987                                 configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter++ + "/ID").setValue(replyId);
 988                         }
 989                         configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter + "/ID").setValue(null);
 990
 991                         /* save friends. */
 992                         int friendCounter = 0;
 993                         for (String friendId : sone.getFriends()) {
 994                                 configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter++ + "/ID").setValue(friendId);
 995                         }
 996                         configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter + "/ID").setValue(null);
 997
 998                         logger.log(Level.INFO, "Sone %s saved.", sone);
 999                 } catch (ConfigurationException ce1) {
1000                         logger.log(Level.WARNING, "Could not save Sone: " + sone, ce1);
1001                 }
1002         }
1003
1004         /**
1005          * Creates a new post.
1006          *
1007          * @param sone
1008          *            The Sone that creates the post
1009          * @param text
1010          *            The text of the post
1011          */
1012         public void createPost(Sone sone, String text) {
1013                 createPost(sone, System.currentTimeMillis(), text);
1014         }
1015
1016         /**
1017          * Creates a new post.
1018          *
1019          * @param sone
1020          *            The Sone that creates the post
1021          * @param time
1022          *            The time of the post
1023          * @param text
1024          *            The text of the post
1025          */
1026         public void createPost(Sone sone, long time, String text) {
1027                 if (!isLocalSone(sone)) {
1028                         logger.log(Level.FINE, "Tried to create post for non-local Sone: %s", sone);
1029                         return;
1030                 }
1031                 Post post = new Post(sone, time, text);
1032                 synchronized (posts) {
1033                         posts.put(post.getId(), post);
1034                 }
1035                 synchronized (newPosts) {
1036                         knownPosts.add(post.getId());
1037                 }
1038                 sone.addPost(post);
1039                 saveSone(sone);
1040         }
1041
1042         /**
1043          * Deletes the given post.
1044          *
1045          * @param post
1046          *            The post to delete
1047          */
1048         public void deletePost(Post post) {
1049                 if (!isLocalSone(post.getSone())) {
1050                         logger.log(Level.WARNING, "Tried to delete post of non-local Sone: %s", post.getSone());
1051                         return;
1052                 }
1053                 post.getSone().removePost(post);
1054                 synchronized (posts) {
1055                         posts.remove(post.getId());
1056                 }
1057                 saveSone(post.getSone());
1058         }
1059
1060         /**
1061          * Creates a new reply.
1062          *
1063          * @param sone
1064          *            The Sone that creates the reply
1065          * @param post
1066          *            The post that this reply refers to
1067          * @param text
1068          *            The text of the reply
1069          * @return The created reply
1070          */
1071         public Reply createReply(Sone sone, Post post, String text) {
1072                 return createReply(sone, post, System.currentTimeMillis(), text);
1073         }
1074
1075         /**
1076          * Creates a new reply.
1077          *
1078          * @param sone
1079          *            The Sone that creates the reply
1080          * @param post
1081          *            The post that this reply refers to
1082          * @param time
1083          *            The time of the reply
1084          * @param text
1085          *            The text of the reply
1086          * @return The created reply
1087          */
1088         public Reply createReply(Sone sone, Post post, long time, String text) {
1089                 if (!isLocalSone(sone)) {
1090                         logger.log(Level.FINE, "Tried to create reply for non-local Sone: %s", sone);
1091                         return null;
1092                 }
1093                 Reply reply = new Reply(sone, post, System.currentTimeMillis(), text);
1094                 synchronized (replies) {
1095                         replies.put(reply.getId(), reply);
1096                 }
1097                 synchronized (newReplies) {
1098                         knownReplies.add(reply.getId());
1099                 }
1100                 sone.addReply(reply);
1101                 saveSone(sone);
1102                 return reply;
1103         }
1104
1105         /**
1106          * Deletes the given reply.
1107          *
1108          * @param reply
1109          *            The reply to delete
1110          */
1111         public void deleteReply(Reply reply) {
1112                 Sone sone = reply.getSone();
1113                 if (!isLocalSone(sone)) {
1114                         logger.log(Level.FINE, "Tried to delete non-local reply: %s", reply);
1115                         return;
1116                 }
1117                 synchronized (replies) {
1118                         replies.remove(reply.getId());
1119                 }
1120                 sone.removeReply(reply);
1121                 saveSone(sone);
1122         }
1123
1124         /**
1125          * Starts the core.
1126          */
1127         public void start() {
1128                 loadConfiguration();
1129         }
1130
1131         /**
1132          * Stops the core.
1133          */
1134         public void stop() {
1135                 synchronized (localSones) {
1136                         for (SoneInserter soneInserter : soneInserters.values()) {
1137                                 soneInserter.stop();
1138                         }
1139                 }
1140                 saveConfiguration();
1141         }
1142
1143         //
1144         // PRIVATE METHODS
1145         //
1146
1147         /**
1148          * Loads the configuration.
1149          */
1150         @SuppressWarnings("unchecked")
1151         private void loadConfiguration() {
1152                 /* create options. */
1153                 options.addIntegerOption("InsertionDelay", new DefaultOption<Integer>(60, new OptionWatcher<Integer>() {
1154
1155                         @Override
1156                         public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
1157                                 SoneInserter.setInsertionDelay(newValue);
1158                         }
1159
1160                 }));
1161                 options.addBooleanOption("ClearOnNextRestart", new DefaultOption<Boolean>(false));
1162                 options.addBooleanOption("ReallyClearOnNextRestart", new DefaultOption<Boolean>(false));
1163
1164                 /* read options from configuration. */
1165                 options.getBooleanOption("ClearOnNextRestart").set(configuration.getBooleanValue("Option/ClearOnNextRestart").getValue(null));
1166                 options.getBooleanOption("ReallyClearOnNextRestart").set(configuration.getBooleanValue("Option/ReallyClearOnNextRestart").getValue(null));
1167                 boolean clearConfiguration = options.getBooleanOption("ClearOnNextRestart").get() && options.getBooleanOption("ReallyClearOnNextRestart").get();
1168                 options.getBooleanOption("ClearOnNextRestart").set(null);
1169                 options.getBooleanOption("ReallyClearOnNextRestart").set(null);
1170                 if (clearConfiguration) {
1171                         /* stop loading the configuration. */
1172                         return;
1173                 }
1174
1175                 options.getIntegerOption("InsertionDelay").set(configuration.getIntValue("Option/InsertionDelay").getValue(null));
1176
1177                 /* load known Sones. */
1178                 int soneCounter = 0;
1179                 while (true) {
1180                         String knownSoneId = configuration.getStringValue("KnownSone/" + soneCounter++ + "/ID").getValue(null);
1181                         if (knownSoneId == null) {
1182                                 break;
1183                         }
1184                         synchronized (newSones) {
1185                                 knownSones.add(knownSoneId);
1186                         }
1187                 }
1188
1189                 /* load known posts. */
1190                 int postCounter = 0;
1191                 while (true) {
1192                         String knownPostId = configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").getValue(null);
1193                         if (knownPostId == null) {
1194                                 break;
1195                         }
1196                         synchronized (newPosts) {
1197                                 knownPosts.add(knownPostId);
1198                         }
1199                 }
1200
1201                 /* load known replies. */
1202                 int replyCounter = 0;
1203                 while (true) {
1204                         String knownReplyId = configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").getValue(null);
1205                         if (knownReplyId == null) {
1206                                 break;
1207                         }
1208                         synchronized (newReplies) {
1209                                 knownReplies.add(knownReplyId);
1210                         }
1211                 }
1212
1213         }
1214
1215         /**
1216          * Saves the current options.
1217          */
1218         private void saveConfiguration() {
1219                 /* store the options first. */
1220                 try {
1221                         configuration.getIntValue("Option/InsertionDelay").setValue(options.getIntegerOption("InsertionDelay").getReal());
1222                         configuration.getBooleanValue("Option/ClearOnNextRestart").setValue(options.getBooleanOption("ClearOnNextRestart").getReal());
1223                         configuration.getBooleanValue("Option/ReallyClearOnNextRestart").setValue(options.getBooleanOption("ReallyClearOnNextRestart").getReal());
1224
1225                         /* save known Sones. */
1226                         int soneCounter = 0;
1227                         synchronized (newSones) {
1228                                 for (String knownSoneId : knownSones) {
1229                                         configuration.getStringValue("KnownSone/" + soneCounter++ + "/ID").setValue(knownSoneId);
1230                                 }
1231                                 configuration.getStringValue("KnownSone/" + soneCounter + "/ID").setValue(null);
1232                         }
1233
1234                         /* save known posts. */
1235                         int postCounter = 0;
1236                         synchronized (newPosts) {
1237                                 for (String knownPostId : knownPosts) {
1238                                         configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").setValue(knownPostId);
1239                                 }
1240                                 configuration.getStringValue("KnownPosts/" + postCounter + "/ID").setValue(null);
1241                         }
1242
1243                         /* save known replies. */
1244                         int replyCounter = 0;
1245                         synchronized (newReplies) {
1246                                 for (String knownReplyId : knownReplies) {
1247                                         configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").setValue(knownReplyId);
1248                                 }
1249                                 configuration.getStringValue("KnownReplies/" + replyCounter + "/ID").setValue(null);
1250                         }
1251
1252                 } catch (ConfigurationException ce1) {
1253                         logger.log(Level.SEVERE, "Could not store configuration!", ce1);
1254                 }
1255         }
1256
1257         /**
1258          * Generate a Sone URI from the given URI and latest edition.
1259          *
1260          * @param uriString
1261          *            The URI to derive the Sone URI from
1262          * @return The derived URI
1263          */
1264         private FreenetURI getSoneUri(String uriString) {
1265                 try {
1266                         FreenetURI uri = new FreenetURI(uriString).setDocName("Sone").setMetaString(new String[0]);
1267                         return uri;
1268                 } catch (MalformedURLException mue1) {
1269                         logger.log(Level.WARNING, "Could not create Sone URI from URI: " + uriString, mue1);
1270                         return null;
1271                 }
1272         }
1273
1274         //
1275         // INTERFACE IdentityListener
1276         //
1277
1278         /**
1279          * {@inheritDoc}
1280          */
1281         @Override
1282         public void ownIdentityAdded(OwnIdentity ownIdentity) {
1283                 logger.log(Level.FINEST, "Adding OwnIdentity: " + ownIdentity);
1284                 if (ownIdentity.hasContext("Sone")) {
1285                         addLocalSone(ownIdentity);
1286                 }
1287         }
1288
1289         /**
1290          * {@inheritDoc}
1291          */
1292         @Override
1293         public void ownIdentityRemoved(OwnIdentity ownIdentity) {
1294                 logger.log(Level.FINEST, "Removing OwnIdentity: " + ownIdentity);
1295         }
1296
1297         /**
1298          * {@inheritDoc}
1299          */
1300         @Override
1301         public void identityAdded(Identity identity) {
1302                 logger.log(Level.FINEST, "Adding Identity: " + identity);
1303                 addRemoteSone(identity);
1304         }
1305
1306         /**
1307          * {@inheritDoc}
1308          */
1309         @Override
1310         public void identityUpdated(final Identity identity) {
1311                 new Thread(new Runnable() {
1312
1313                         @Override
1314                         @SuppressWarnings("synthetic-access")
1315                         public void run() {
1316                                 Sone sone = getRemoteSone(identity.getId());
1317                                 soneDownloader.fetchSone(sone);
1318                         }
1319                 }).start();
1320         }
1321
1322         /**
1323          * {@inheritDoc}
1324          */
1325         @Override
1326         public void identityRemoved(Identity identity) {
1327                 /* TODO */
1328         }
1329
1330 }