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

   1 /*
   2  * Sone - Core.java - Copyright © 2010–2013 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 static com.google.common.base.Optional.fromNullable;
  21 import static com.google.common.base.Preconditions.checkArgument;
  22 import static com.google.common.base.Preconditions.checkNotNull;
  23 import static com.google.common.primitives.Longs.tryParse;
  24 import static java.lang.String.format;
  25 import static java.util.logging.Level.WARNING;
  26 import static java.util.logging.Logger.getLogger;
  27
  28 import java.util.ArrayList;
  29 import java.util.Collection;
  30 import java.util.HashMap;
  31 import java.util.HashSet;
  32 import java.util.List;
  33 import java.util.Map;
  34 import java.util.Map.Entry;
  35 import java.util.Set;
  36 import java.util.concurrent.ExecutorService;
  37 import java.util.concurrent.Executors;
  38 import java.util.concurrent.ScheduledExecutorService;
  39 import java.util.concurrent.TimeUnit;
  40 import java.util.logging.Level;
  41 import java.util.logging.Logger;
  42
  43 import net.pterodactylus.sone.core.ConfigurationSoneParser.InvalidAlbumFound;
  44 import net.pterodactylus.sone.core.ConfigurationSoneParser.InvalidImageFound;
  45 import net.pterodactylus.sone.core.ConfigurationSoneParser.InvalidParentAlbumFound;
  46 import net.pterodactylus.sone.core.ConfigurationSoneParser.InvalidPostFound;
  47 import net.pterodactylus.sone.core.ConfigurationSoneParser.InvalidPostReplyFound;
  48 import net.pterodactylus.sone.core.SoneChangeDetector.PostProcessor;
  49 import net.pterodactylus.sone.core.SoneChangeDetector.PostReplyProcessor;
  50 import net.pterodactylus.sone.core.event.ImageInsertFinishedEvent;
  51 import net.pterodactylus.sone.core.event.MarkPostKnownEvent;
  52 import net.pterodactylus.sone.core.event.MarkPostReplyKnownEvent;
  53 import net.pterodactylus.sone.core.event.MarkSoneKnownEvent;
  54 import net.pterodactylus.sone.core.event.NewPostFoundEvent;
  55 import net.pterodactylus.sone.core.event.NewPostReplyFoundEvent;
  56 import net.pterodactylus.sone.core.event.NewSoneFoundEvent;
  57 import net.pterodactylus.sone.core.event.PostRemovedEvent;
  58 import net.pterodactylus.sone.core.event.PostReplyRemovedEvent;
  59 import net.pterodactylus.sone.core.event.SoneLockedEvent;
  60 import net.pterodactylus.sone.core.event.SoneRemovedEvent;
  61 import net.pterodactylus.sone.core.event.SoneUnlockedEvent;
  62 import net.pterodactylus.sone.data.Album;
  63 import net.pterodactylus.sone.data.Client;
  64 import net.pterodactylus.sone.data.Image;
  65 import net.pterodactylus.sone.data.Post;
  66 import net.pterodactylus.sone.data.PostReply;
  67 import net.pterodactylus.sone.data.Profile;
  68 import net.pterodactylus.sone.data.Profile.Field;
  69 import net.pterodactylus.sone.data.Reply;
  70 import net.pterodactylus.sone.data.Sone;
  71 import net.pterodactylus.sone.data.Sone.ShowCustomAvatars;
  72 import net.pterodactylus.sone.data.Sone.SoneStatus;
  73 import net.pterodactylus.sone.data.TemporaryImage;
  74 import net.pterodactylus.sone.database.AlbumBuilder;
  75 import net.pterodactylus.sone.database.Database;
  76 import net.pterodactylus.sone.database.DatabaseException;
  77 import net.pterodactylus.sone.database.ImageBuilder;
  78 import net.pterodactylus.sone.database.PostBuilder;
  79 import net.pterodactylus.sone.database.PostProvider;
  80 import net.pterodactylus.sone.database.PostReplyBuilder;
  81 import net.pterodactylus.sone.database.PostReplyProvider;
  82 import net.pterodactylus.sone.database.SoneBuilder;
  83 import net.pterodactylus.sone.database.SoneProvider;
  84 import net.pterodactylus.sone.freenet.wot.Identity;
  85 import net.pterodactylus.sone.freenet.wot.IdentityManager;
  86 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
  87 import net.pterodactylus.sone.freenet.wot.event.IdentityAddedEvent;
  88 import net.pterodactylus.sone.freenet.wot.event.IdentityRemovedEvent;
  89 import net.pterodactylus.sone.freenet.wot.event.IdentityUpdatedEvent;
  90 import net.pterodactylus.sone.freenet.wot.event.OwnIdentityAddedEvent;
  91 import net.pterodactylus.sone.freenet.wot.event.OwnIdentityRemovedEvent;
  92 import net.pterodactylus.sone.main.SonePlugin;
  93 import net.pterodactylus.util.config.Configuration;
  94 import net.pterodactylus.util.config.ConfigurationException;
  95 import net.pterodactylus.util.service.AbstractService;
  96 import net.pterodactylus.util.thread.NamedThreadFactory;
  97
  98 import com.google.common.annotations.VisibleForTesting;
  99 import com.google.common.base.Optional;
 100 import com.google.common.collect.FluentIterable;
 101 import com.google.common.collect.HashMultimap;
 102 import com.google.common.collect.Multimap;
 103 import com.google.common.collect.Multimaps;
 104 import com.google.common.eventbus.EventBus;
 105 import com.google.common.eventbus.Subscribe;
 106 import com.google.inject.Inject;
 107 import com.google.inject.Singleton;
 108
 109 /**
 110  * The Sone core.
 111  *
 112  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 113  */
 114 @Singleton
 115 public class Core extends AbstractService implements SoneProvider, PostProvider, PostReplyProvider {
 116
 117         /** The logger. */
 118         private static final Logger logger = getLogger("Sone.Core");
 119
 120         /** The start time. */
 121         private final long startupTime = System.currentTimeMillis();
 122
 123         /** The preferences. */
 124         private final Preferences preferences;
 125
 126         /** The event bus. */
 127         private final EventBus eventBus;
 128
 129         /** The configuration. */
 130         private final Configuration configuration;
 131
 132         /** Whether we’re currently saving the configuration. */
 133         private boolean storingConfiguration = false;
 134
 135         /** The identity manager. */
 136         private final IdentityManager identityManager;
 137
 138         /** Interface to freenet. */
 139         private final FreenetInterface freenetInterface;
 140
 141         /** The Sone downloader. */
 142         private final SoneDownloader soneDownloader;
 143
 144         /** The image inserter. */
 145         private final ImageInserter imageInserter;
 146
 147         /** Sone downloader thread-pool. */
 148         private final ExecutorService soneDownloaders = Executors.newFixedThreadPool(10, new NamedThreadFactory("Sone Downloader %2$d"));
 149
 150         /** The update checker. */
 151         private final UpdateChecker updateChecker;
 152
 153         /** The trust updater. */
 154         private final WebOfTrustUpdater webOfTrustUpdater;
 155
 156         /** The times Sones were followed. */
 157         private final Map<String, Long> soneFollowingTimes = new HashMap<String, Long>();
 158
 159         /** Locked local Sones. */
 160         /* synchronize on itself. */
 161         private final Set<Sone> lockedSones = new HashSet<Sone>();
 162
 163         /** Sone inserters. */
 164         /* synchronize access on this on sones. */
 165         private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
 166
 167         /** Sone rescuers. */
 168         /* synchronize access on this on sones. */
 169         private final Map<Sone, SoneRescuer> soneRescuers = new HashMap<Sone, SoneRescuer>();
 170
 171         /** All known Sones. */
 172         private final Set<String> knownSones = new HashSet<String>();
 173
 174         /** The post database. */
 175         private final Database database;
 176
 177         /** Trusted identities, sorted by own identities. */
 178         private final Multimap<OwnIdentity, Identity> trustedIdentities = Multimaps.synchronizedSetMultimap(HashMultimap.<OwnIdentity, Identity>create());
 179
 180         /** All temporary images. */
 181         private final Map<String, TemporaryImage> temporaryImages = new HashMap<String, TemporaryImage>();
 182
 183         /** Ticker for threads that mark own elements as known. */
 184         private final ScheduledExecutorService localElementTicker = Executors.newScheduledThreadPool(1);
 185
 186         /** The time the configuration was last touched. */
 187         private volatile long lastConfigurationUpdate;
 188
 189         /**
 190          * Creates a new core.
 191          *
 192          * @param configuration
 193          *            The configuration of the core
 194          * @param freenetInterface
 195          *            The freenet interface
 196          * @param identityManager
 197          *            The identity manager
 198          * @param webOfTrustUpdater
 199          *            The WebOfTrust updater
 200          * @param eventBus
 201          *            The event bus
 202          * @param database
 203          *            The database
 204          */
 205         @Inject
 206         public Core(Configuration configuration, FreenetInterface freenetInterface, IdentityManager identityManager, WebOfTrustUpdater webOfTrustUpdater, EventBus eventBus, Database database) {
 207                 super("Sone Core");
 208                 this.configuration = configuration;
 209                 this.freenetInterface = freenetInterface;
 210                 this.identityManager = identityManager;
 211                 this.soneDownloader = new SoneDownloaderImpl(this, freenetInterface);
 212                 this.imageInserter = new ImageInserter(freenetInterface, freenetInterface.new InsertTokenSupplier());
 213                 this.updateChecker = new UpdateChecker(eventBus, freenetInterface);
 214                 this.webOfTrustUpdater = webOfTrustUpdater;
 215                 this.eventBus = eventBus;
 216                 this.database = database;
 217                 preferences = new Preferences(eventBus);
 218         }
 219
 220         @VisibleForTesting
 221         protected Core(Configuration configuration, FreenetInterface freenetInterface, IdentityManager identityManager, SoneDownloader soneDownloader, ImageInserter imageInserter, UpdateChecker updateChecker, WebOfTrustUpdater webOfTrustUpdater, EventBus eventBus, Database database) {
 222                 super("Sone Core");
 223                 this.configuration = configuration;
 224                 this.freenetInterface = freenetInterface;
 225                 this.identityManager = identityManager;
 226                 this.soneDownloader = soneDownloader;
 227                 this.imageInserter = imageInserter;
 228                 this.updateChecker = updateChecker;
 229                 this.webOfTrustUpdater = webOfTrustUpdater;
 230                 this.eventBus = eventBus;
 231                 this.database = database;
 232                 preferences = new Preferences(eventBus);
 233         }
 234
 235         //
 236         // ACCESSORS
 237         //
 238
 239         /**
 240          * Returns the time Sone was started.
 241          *
 242          * @return The startup time (in milliseconds since Jan 1, 1970 UTC)
 243          */
 244         public long getStartupTime() {
 245                 return startupTime;
 246         }
 247
 248         /**
 249          * Returns the options used by the core.
 250          *
 251          * @return The options of the core
 252          */
 253         public Preferences getPreferences() {
 254                 return preferences;
 255         }
 256
 257         /**
 258          * Returns the identity manager used by the core.
 259          *
 260          * @return The identity manager
 261          */
 262         public IdentityManager getIdentityManager() {
 263                 return identityManager;
 264         }
 265
 266         /**
 267          * Returns the update checker.
 268          *
 269          * @return The update checker
 270          */
 271         public UpdateChecker getUpdateChecker() {
 272                 return updateChecker;
 273         }
 274
 275         /**
 276          * Returns the Sone rescuer for the given local Sone.
 277          *
 278          * @param sone
 279          *            The local Sone to get the rescuer for
 280          * @return The Sone rescuer for the given Sone
 281          */
 282         public SoneRescuer getSoneRescuer(Sone sone) {
 283                 checkNotNull(sone, "sone must not be null");
 284                 checkArgument(sone.isLocal(), "sone must be local");
 285                 synchronized (soneRescuers) {
 286                         SoneRescuer soneRescuer = soneRescuers.get(sone);
 287                         if (soneRescuer == null) {
 288                                 soneRescuer = new SoneRescuer(this, soneDownloader, sone);
 289                                 soneRescuers.put(sone, soneRescuer);
 290                                 soneRescuer.start();
 291                         }
 292                         return soneRescuer;
 293                 }
 294         }
 295
 296         /**
 297          * Returns whether the given Sone is currently locked.
 298          *
 299          * @param sone
 300          *            The sone to check
 301          * @return {@code true} if the Sone is locked, {@code false} if it is not
 302          */
 303         public boolean isLocked(Sone sone) {
 304                 synchronized (lockedSones) {
 305                         return lockedSones.contains(sone);
 306                 }
 307         }
 308
 309         public SoneBuilder soneBuilder() {
 310                 return database.newSoneBuilder();
 311         }
 312
 313         /**
 314          * {@inheritDocs}
 315          */
 316         @Override
 317         public Collection<Sone> getSones() {
 318                 return database.getSones();
 319         }
 320
 321         /**
 322          * Returns the Sone with the given ID, regardless whether it’s local or
 323          * remote.
 324          *
 325          * @param id
 326          *            The ID of the Sone to get
 327          * @return The Sone with the given ID, or {@code null} if there is no such
 328          *         Sone
 329          */
 330         @Override
 331         public Optional<Sone> getSone(String id) {
 332                 return database.getSone(id);
 333         }
 334
 335         /**
 336          * {@inheritDocs}
 337          */
 338         @Override
 339         public Collection<Sone> getLocalSones() {
 340                 return database.getLocalSones();
 341         }
 342
 343         /**
 344          * Returns the local Sone with the given ID, optionally creating a new Sone.
 345          *
 346          * @param id
 347          *            The ID of the Sone
 348          * @return The Sone with the given ID, or {@code null}
 349          */
 350         public Sone getLocalSone(String id) {
 351                 Optional<Sone> sone = database.getSone(id);
 352                 if (sone.isPresent() && sone.get().isLocal()) {
 353                         return sone.get();
 354                 }
 355                 return null;
 356         }
 357
 358         /**
 359          * {@inheritDocs}
 360          */
 361         @Override
 362         public Collection<Sone> getRemoteSones() {
 363                 return database.getRemoteSones();
 364         }
 365
 366         /**
 367          * Returns the remote Sone with the given ID.
 368          *
 369          *
 370          * @param id
 371          *            The ID of the remote Sone to get
 372          * @return The Sone with the given ID
 373          */
 374         public Sone getRemoteSone(String id) {
 375                 return database.getSone(id).orNull();
 376         }
 377
 378         /**
 379          * Returns whether the given Sone has been modified.
 380          *
 381          * @param sone
 382          *            The Sone to check for modifications
 383          * @return {@code true} if a modification has been detected in the Sone,
 384          *         {@code false} otherwise
 385          */
 386         public boolean isModifiedSone(Sone sone) {
 387                 return soneInserters.containsKey(sone) && soneInserters.get(sone).isModified();
 388         }
 389
 390         /**
 391          * Returns the time when the given was first followed by any local Sone.
 392          *
 393          * @param sone
 394          *            The Sone to get the time for
 395          * @return The time (in milliseconds since Jan 1, 1970) the Sone has first
 396          *         been followed, or {@link Long#MAX_VALUE}
 397          */
 398         public long getSoneFollowingTime(Sone sone) {
 399                 synchronized (soneFollowingTimes) {
 400                         return Optional.fromNullable(soneFollowingTimes.get(sone.getId())).or(Long.MAX_VALUE);
 401                 }
 402         }
 403
 404         /**
 405          * Returns a post builder.
 406          *
 407          * @return A new post builder
 408          */
 409         public PostBuilder postBuilder() {
 410                 return database.newPostBuilder();
 411         }
 412
 413         /**
 414          * {@inheritDoc}
 415          */
 416         @Override
 417         public Optional<Post> getPost(String postId) {
 418                 return database.getPost(postId);
 419         }
 420
 421         /**
 422          * {@inheritDocs}
 423          */
 424         @Override
 425         public Collection<Post> getPosts(String soneId) {
 426                 return database.getPosts(soneId);
 427         }
 428
 429         /**
 430          * {@inheritDoc}
 431          */
 432         @Override
 433         public Collection<Post> getDirectedPosts(final String recipientId) {
 434                 checkNotNull(recipientId, "recipient must not be null");
 435                 return database.getDirectedPosts(recipientId);
 436         }
 437
 438         /**
 439          * Returns a post reply builder.
 440          *
 441          * @return A new post reply builder
 442          */
 443         public PostReplyBuilder postReplyBuilder() {
 444                 return database.newPostReplyBuilder();
 445         }
 446
 447         /**
 448          * {@inheritDoc}
 449          */
 450         @Override
 451         public Optional<PostReply> getPostReply(String replyId) {
 452                 return database.getPostReply(replyId);
 453         }
 454
 455         /**
 456          * {@inheritDoc}
 457          */
 458         @Override
 459         public List<PostReply> getReplies(final String postId) {
 460                 return database.getReplies(postId);
 461         }
 462
 463         /**
 464          * Returns all Sones that have liked the given post.
 465          *
 466          * @param post
 467          *            The post to get the liking Sones for
 468          * @return The Sones that like the given post
 469          */
 470         public Set<Sone> getLikes(Post post) {
 471                 Set<Sone> sones = new HashSet<Sone>();
 472                 for (Sone sone : getSones()) {
 473                         if (sone.getLikedPostIds().contains(post.getId())) {
 474                                 sones.add(sone);
 475                         }
 476                 }
 477                 return sones;
 478         }
 479
 480         /**
 481          * Returns all Sones that have liked the given reply.
 482          *
 483          * @param reply
 484          *            The reply to get the liking Sones for
 485          * @return The Sones that like the given reply
 486          */
 487         public Set<Sone> getLikes(PostReply reply) {
 488                 Set<Sone> sones = new HashSet<Sone>();
 489                 for (Sone sone : getSones()) {
 490                         if (sone.getLikedReplyIds().contains(reply.getId())) {
 491                                 sones.add(sone);
 492                         }
 493                 }
 494                 return sones;
 495         }
 496
 497         /**
 498          * Returns whether the given post is bookmarked.
 499          *
 500          * @param post
 501          *            The post to check
 502          * @return {@code true} if the given post is bookmarked, {@code false}
 503          *         otherwise
 504          */
 505         public boolean isBookmarked(Post post) {
 506                 return database.isPostBookmarked(post);
 507         }
 508
 509         /**
 510          * Returns all currently known bookmarked posts.
 511          *
 512          * @return All bookmarked posts
 513          */
 514         public Set<Post> getBookmarkedPosts() {
 515                 return database.getBookmarkedPosts();
 516         }
 517
 518         public AlbumBuilder albumBuilder() {
 519                 return database.newAlbumBuilder();
 520         }
 521
 522         /**
 523          * Returns the album with the given ID, optionally creating a new album if
 524          * an album with the given ID can not be found.
 525          *
 526          * @param albumId
 527          *            The ID of the album
 528          * @return The album with the given ID, or {@code null} if no album with the
 529          *         given ID exists
 530          */
 531         public Album getAlbum(String albumId) {
 532                 return database.getAlbum(albumId).orNull();
 533         }
 534
 535         public ImageBuilder imageBuilder() {
 536                 return database.newImageBuilder();
 537         }
 538
 539         /**
 540          * Returns the image with the given ID, creating it if necessary.
 541          *
 542          * @param imageId
 543          *            The ID of the image
 544          * @return The image with the given ID
 545          */
 546         public Image getImage(String imageId) {
 547                 return getImage(imageId, true);
 548         }
 549
 550         /**
 551          * Returns the image with the given ID, optionally creating it if it does
 552          * not exist.
 553          *
 554          * @param imageId
 555          *            The ID of the image
 556          * @param create
 557          *            {@code true} to create an image if none exists with the given
 558          *            ID
 559          * @return The image with the given ID, or {@code null} if none exists and
 560          *         none was created
 561          */
 562         public Image getImage(String imageId, boolean create) {
 563                 Optional<Image> image = database.getImage(imageId);
 564                 if (image.isPresent()) {
 565                         return image.get();
 566                 }
 567                 if (!create) {
 568                         return null;
 569                 }
 570                 Image newImage = database.newImageBuilder().withId(imageId).build();
 571                 database.storeImage(newImage);
 572                 return newImage;
 573         }
 574
 575         /**
 576          * Returns the temporary image with the given ID.
 577          *
 578          * @param imageId
 579          *            The ID of the temporary image
 580          * @return The temporary image, or {@code null} if there is no temporary
 581          *         image with the given ID
 582          */
 583         public TemporaryImage getTemporaryImage(String imageId) {
 584                 synchronized (temporaryImages) {
 585                         return temporaryImages.get(imageId);
 586                 }
 587         }
 588
 589         //
 590         // ACTIONS
 591         //
 592
 593         /**
 594          * Locks the given Sone. A locked Sone will not be inserted by
 595          * {@link SoneInserter} until it is {@link #unlockSone(Sone) unlocked}
 596          * again.
 597          *
 598          * @param sone
 599          *            The sone to lock
 600          */
 601         public void lockSone(Sone sone) {
 602                 synchronized (lockedSones) {
 603                         if (lockedSones.add(sone)) {
 604                                 eventBus.post(new SoneLockedEvent(sone));
 605                         }
 606                 }
 607         }
 608
 609         /**
 610          * Unlocks the given Sone.
 611          *
 612          * @see #lockSone(Sone)
 613          * @param sone
 614          *            The sone to unlock
 615          */
 616         public void unlockSone(Sone sone) {
 617                 synchronized (lockedSones) {
 618                         if (lockedSones.remove(sone)) {
 619                                 eventBus.post(new SoneUnlockedEvent(sone));
 620                         }
 621                 }
 622         }
 623
 624         /**
 625          * Adds a local Sone from the given own identity.
 626          *
 627          * @param ownIdentity
 628          *            The own identity to create a Sone from
 629          * @return The added (or already existing) Sone
 630          */
 631         public Sone addLocalSone(OwnIdentity ownIdentity) {
 632                 if (ownIdentity == null) {
 633                         logger.log(Level.WARNING, "Given OwnIdentity is null!");
 634                         return null;
 635                 }
 636                 logger.info(String.format("Adding Sone from OwnIdentity: %s", ownIdentity));
 637                 Sone sone = database.newSoneBuilder().local().from(ownIdentity).build();
 638                 sone.setLatestEdition(fromNullable(tryParse(ownIdentity.getProperty("Sone.LatestEdition"))).or(0L));
 639                 sone.setClient(new Client("Sone", SonePlugin.VERSION.toString()));
 640                 sone.setKnown(true);
 641                 SoneInserter soneInserter = new SoneInserter(this, eventBus, freenetInterface, ownIdentity.getId());
 642                 eventBus.register(soneInserter);
 643                 synchronized (soneInserters) {
 644                         soneInserters.put(sone, soneInserter);
 645                 }
 646                 loadSone(sone);
 647                 sone.setStatus(SoneStatus.idle);
 648                 soneInserter.start();
 649                 return sone;
 650         }
 651
 652         /**
 653          * Creates a new Sone for the given own identity.
 654          *
 655          * @param ownIdentity
 656          *            The own identity to create a Sone for
 657          * @return The created Sone
 658          */
 659         public Sone createSone(OwnIdentity ownIdentity) {
 660                 if (!webOfTrustUpdater.addContextWait(ownIdentity, "Sone")) {
 661                         logger.log(Level.SEVERE, String.format("Could not add “Sone” context to own identity: %s", ownIdentity));
 662                         return null;
 663                 }
 664                 Sone sone = addLocalSone(ownIdentity);
 665
 666                 followSone(sone, "nwa8lHa271k2QvJ8aa0Ov7IHAV-DFOCFgmDt3X6BpCI");
 667                 touchConfiguration();
 668                 return sone;
 669         }
 670
 671         /**
 672          * Adds the Sone of the given identity.
 673          *
 674          * @param identity
 675          *            The identity whose Sone to add
 676          * @return The added or already existing Sone
 677          */
 678         public Sone addRemoteSone(Identity identity) {
 679                 if (identity == null) {
 680                         logger.log(Level.WARNING, "Given Identity is null!");
 681                         return null;
 682                 }
 683                 final Long latestEdition = tryParse(fromNullable(
 684                                 identity.getProperty("Sone.LatestEdition")).or("0"));
 685                 Optional<Sone> existingSone = getSone(identity.getId());
 686                 if (existingSone.isPresent() && existingSone.get().isLocal()) {
 687                         return existingSone.get();
 688                 }
 689                 boolean newSone = !existingSone.isPresent();
 690                 Sone sone = !newSone ? existingSone.get() : database.newSoneBuilder().from(identity).build();
 691                 sone.setLatestEdition(latestEdition);
 692                 if (newSone) {
 693                         synchronized (knownSones) {
 694                                 newSone = !knownSones.contains(sone.getId());
 695                         }
 696                         sone.setKnown(!newSone);
 697                         if (newSone) {
 698                                 eventBus.post(new NewSoneFoundEvent(sone));
 699                                 for (Sone localSone : getLocalSones()) {
 700                                         if (localSone.getOptions().isAutoFollow()) {
 701                                                 followSone(localSone, sone.getId());
 702                                         }
 703                                 }
 704                         }
 705                 }
 706                 database.storeSone(sone);
 707                 soneDownloader.addSone(sone);
 708                 soneDownloaders.execute(soneDownloader.fetchSoneWithUriAction(sone));
 709                 return sone;
 710         }
 711
 712         /**
 713          * Lets the given local Sone follow the Sone with the given ID.
 714          *
 715          * @param sone
 716          *            The local Sone that should follow another Sone
 717          * @param soneId
 718          *            The ID of the Sone to follow
 719          */
 720         public void followSone(Sone sone, String soneId) {
 721                 checkNotNull(sone, "sone must not be null");
 722                 checkNotNull(soneId, "soneId must not be null");
 723                 sone.addFriend(soneId);
 724                 synchronized (soneFollowingTimes) {
 725                         if (!soneFollowingTimes.containsKey(soneId)) {
 726                                 long now = System.currentTimeMillis();
 727                                 soneFollowingTimes.put(soneId, now);
 728                                 Optional<Sone> followedSone = getSone(soneId);
 729                                 if (!followedSone.isPresent()) {
 730                                         return;
 731                                 }
 732                                 for (Post post : followedSone.get().getPosts()) {
 733                                         if (post.getTime() < now) {
 734                                                 markPostKnown(post);
 735                                         }
 736                                 }
 737                                 for (PostReply reply : followedSone.get().getReplies()) {
 738                                         if (reply.getTime() < now) {
 739                                                 markReplyKnown(reply);
 740                                         }
 741                                 }
 742                         }
 743                 }
 744                 touchConfiguration();
 745         }
 746
 747         /**
 748          * Lets the given local Sone unfollow the Sone with the given ID.
 749          *
 750          * @param sone
 751          *            The local Sone that should unfollow another Sone
 752          * @param soneId
 753          *            The ID of the Sone being unfollowed
 754          */
 755         public void unfollowSone(Sone sone, String soneId) {
 756                 checkNotNull(sone, "sone must not be null");
 757                 checkNotNull(soneId, "soneId must not be null");
 758                 sone.removeFriend(soneId);
 759                 boolean unfollowedSoneStillFollowed = false;
 760                 for (Sone localSone : getLocalSones()) {
 761                         unfollowedSoneStillFollowed |= localSone.hasFriend(soneId);
 762                 }
 763                 if (!unfollowedSoneStillFollowed) {
 764                         synchronized (soneFollowingTimes) {
 765                                 soneFollowingTimes.remove(soneId);
 766                         }
 767                 }
 768                 touchConfiguration();
 769         }
 770
 771         /**
 772          * Sets the trust value of the given origin Sone for the target Sone.
 773          *
 774          * @param origin
 775          *            The origin Sone
 776          * @param target
 777          *            The target Sone
 778          * @param trustValue
 779          *            The trust value (from {@code -100} to {@code 100})
 780          */
 781         public void setTrust(Sone origin, Sone target, int trustValue) {
 782                 checkNotNull(origin, "origin must not be null");
 783                 checkArgument(origin.getIdentity() instanceof OwnIdentity, "origin must be a local Sone");
 784                 checkNotNull(target, "target must not be null");
 785                 checkArgument((trustValue >= -100) && (trustValue <= 100), "trustValue must be within [-100, 100]");
 786                 webOfTrustUpdater.setTrust((OwnIdentity) origin.getIdentity(), target.getIdentity(), trustValue, preferences.getTrustComment());
 787         }
 788
 789         /**
 790          * Removes any trust assignment for the given target Sone.
 791          *
 792          * @param origin
 793          *            The trust origin
 794          * @param target
 795          *            The trust target
 796          */
 797         public void removeTrust(Sone origin, Sone target) {
 798                 checkNotNull(origin, "origin must not be null");
 799                 checkNotNull(target, "target must not be null");
 800                 checkArgument(origin.getIdentity() instanceof OwnIdentity, "origin must be a local Sone");
 801                 webOfTrustUpdater.setTrust((OwnIdentity) origin.getIdentity(), target.getIdentity(), null, null);
 802         }
 803
 804         /**
 805          * Assigns the configured positive trust value for the given target.
 806          *
 807          * @param origin
 808          *            The trust origin
 809          * @param target
 810          *            The trust target
 811          */
 812         public void trustSone(Sone origin, Sone target) {
 813                 setTrust(origin, target, preferences.getPositiveTrust());
 814         }
 815
 816         /**
 817          * Assigns the configured negative trust value for the given target.
 818          *
 819          * @param origin
 820          *            The trust origin
 821          * @param target
 822          *            The trust target
 823          */
 824         public void distrustSone(Sone origin, Sone target) {
 825                 setTrust(origin, target, preferences.getNegativeTrust());
 826         }
 827
 828         /**
 829          * Removes the trust assignment for the given target.
 830          *
 831          * @param origin
 832          *            The trust origin
 833          * @param target
 834          *            The trust target
 835          */
 836         public void untrustSone(Sone origin, Sone target) {
 837                 removeTrust(origin, target);
 838         }
 839
 840         /**
 841          * Updates the stored Sone with the given Sone.
 842          *
 843          * @param sone
 844          *            The updated Sone
 845          */
 846         public void updateSone(Sone sone) {
 847                 updateSone(sone, false);
 848         }
 849
 850         /**
 851          * Updates the stored Sone with the given Sone. If {@code soneRescueMode} is
 852          * {@code true}, an older Sone than the current Sone can be given to restore
 853          * an old state.
 854          *
 855          * @param sone
 856          *            The Sone to update
 857          * @param soneRescueMode
 858          *            {@code true} if the stored Sone should be updated regardless
 859          *            of the age of the given Sone
 860          */
 861         public void updateSone(final Sone sone, boolean soneRescueMode) {
 862                 Optional<Sone> storedSone = getSone(sone.getId());
 863                 if (storedSone.isPresent()) {
 864                         if (!soneRescueMode && !(sone.getTime() > storedSone.get().getTime())) {
 865                                 logger.log(Level.FINE, String.format("Downloaded Sone %s is not newer than stored Sone %s.", sone, storedSone));
 866                                 return;
 867                         }
 868                         List<Object> events =
 869                                         collectEventsForChangesInSone(storedSone.get(), sone);
 870                         database.storeSone(sone);
 871                         for (Object event : events) {
 872                                 eventBus.post(event);
 873                         }
 874                         sone.setOptions(storedSone.get().getOptions());
 875                         sone.setKnown(storedSone.get().isKnown());
 876                         sone.setStatus((sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
 877                         if (sone.isLocal()) {
 878                                 touchConfiguration();
 879                         }
 880                 }
 881         }
 882
 883         private List<Object> collectEventsForChangesInSone(Sone oldSone,
 884                         final Sone newSone) {
 885                 final List<Object> events = new ArrayList<Object>();
 886                 SoneChangeDetector soneChangeDetector = new SoneChangeDetector(
 887                                 oldSone);
 888                 soneChangeDetector.onNewPosts(new PostProcessor() {
 889                         @Override
 890                         public void processPost(Post post) {
 891                                 if (post.getTime() < getSoneFollowingTime(newSone)) {
 892                                         post.setKnown(true);
 893                                 } else if (!post.isKnown()) {
 894                                         events.add(new NewPostFoundEvent(post));
 895                                 }
 896                         }
 897                 });
 898                 soneChangeDetector.onRemovedPosts(new PostProcessor() {
 899                         @Override
 900                         public void processPost(Post post) {
 901                                 events.add(new PostRemovedEvent(post));
 902                         }
 903                 });
 904                 soneChangeDetector.onNewPostReplies(new PostReplyProcessor() {
 905                         @Override
 906                         public void processPostReply(PostReply postReply) {
 907                                 if (postReply.getTime() < getSoneFollowingTime(newSone)) {
 908                                         postReply.setKnown(true);
 909                                 } else if (!postReply.isKnown()) {
 910                                         events.add(new NewPostReplyFoundEvent(postReply));
 911                                 }
 912                         }
 913                 });
 914                 soneChangeDetector.onRemovedPostReplies(new PostReplyProcessor() {
 915                         @Override
 916                         public void processPostReply(PostReply postReply) {
 917                                 events.add(new PostReplyRemovedEvent(postReply));
 918                         }
 919                 });
 920                 soneChangeDetector.detectChanges(newSone);
 921                 return events;
 922         }
 923
 924         /**
 925          * Deletes the given Sone. This will remove the Sone from the
 926          * {@link #getLocalSones() local Sones}, stop its {@link SoneInserter} and
 927          * remove the context from its identity.
 928          *
 929          * @param sone
 930          *            The Sone to delete
 931          */
 932         public void deleteSone(Sone sone) {
 933                 if (!(sone.getIdentity() instanceof OwnIdentity)) {
 934                         logger.log(Level.WARNING, String.format("Tried to delete Sone of non-own identity: %s", sone));
 935                         return;
 936                 }
 937                 if (!getLocalSones().contains(sone)) {
 938                         logger.log(Level.WARNING, String.format("Tried to delete non-local Sone: %s", sone));
 939                         return;
 940                 }
 941                 SoneInserter soneInserter = soneInserters.remove(sone);
 942                 soneInserter.stop();
 943                 database.removeSone(sone);
 944                 webOfTrustUpdater.removeContext((OwnIdentity) sone.getIdentity(), "Sone");
 945                 webOfTrustUpdater.removeProperty((OwnIdentity) sone.getIdentity(), "Sone.LatestEdition");
 946                 try {
 947                         configuration.getLongValue("Sone/" + sone.getId() + "/Time").setValue(null);
 948                 } catch (ConfigurationException ce1) {
 949                         logger.log(Level.WARNING, "Could not remove Sone from configuration!", ce1);
 950                 }
 951         }
 952
 953         /**
 954          * Marks the given Sone as known. If the Sone was not {@link Post#isKnown()
 955          * known} before, a {@link MarkSoneKnownEvent} is fired.
 956          *
 957          * @param sone
 958          *            The Sone to mark as known
 959          */
 960         public void markSoneKnown(Sone sone) {
 961                 if (!sone.isKnown()) {
 962                         sone.setKnown(true);
 963                         synchronized (knownSones) {
 964                                 knownSones.add(sone.getId());
 965                         }
 966                         eventBus.post(new MarkSoneKnownEvent(sone));
 967                         touchConfiguration();
 968                 }
 969         }
 970
 971         /**
 972          * Loads and updates the given Sone from the configuration. If any error is
 973          * encountered, loading is aborted and the given Sone is not changed.
 974          *
 975          * @param sone
 976          *            The Sone to load and update
 977          */
 978         public void loadSone(Sone sone) {
 979                 if (!sone.isLocal()) {
 980                         logger.log(Level.FINE, String.format("Tried to load non-local Sone: %s", sone));
 981                         return;
 982                 }
 983                 logger.info(String.format("Loading local Sone: %s", sone));
 984
 985                 /* load Sone. */
 986                 String sonePrefix = "Sone/" + sone.getId();
 987                 Long soneTime = configuration.getLongValue(sonePrefix + "/Time").getValue(null);
 988                 if (soneTime == null) {
 989                         logger.log(Level.INFO, "Could not load Sone because no Sone has been saved.");
 990                         return;
 991                 }
 992                 String lastInsertFingerprint = configuration.getStringValue(sonePrefix + "/LastInsertFingerprint").getValue("");
 993
 994                 /* load profile. */
 995                 ConfigurationSoneParser configurationSoneParser = new ConfigurationSoneParser(configuration, sone);
 996                 Profile profile = configurationSoneParser.parseProfile();
 997
 998                 /* load posts. */
 999                 Collection<Post> posts;
1000                 try {
1001                         posts = configurationSoneParser.parsePosts(database);
1002                 } catch (InvalidPostFound ipf) {
1003                         logger.log(Level.WARNING, "Invalid post found, aborting load!");
1004                         return;
1005                 }
1006
1007                 /* load replies. */
1008                 Collection<PostReply> replies;
1009                 try {
1010                         replies = configurationSoneParser.parsePostReplies(database);
1011                 } catch (InvalidPostReplyFound iprf) {
1012                         logger.log(Level.WARNING, "Invalid reply found, aborting load!");
1013                         return;
1014                 }
1015
1016                 /* load post likes. */
1017                 Set<String> likedPostIds =
1018                                 configurationSoneParser.parseLikedPostIds();
1019
1020                 /* load reply likes. */
1021                 Set<String> likedReplyIds =
1022                                 configurationSoneParser.parseLikedPostReplyIds();
1023
1024                 /* load friends. */
1025                 Set<String> friends = configurationSoneParser.parseFriends();
1026
1027                 /* load albums. */
1028                 List<Album> topLevelAlbums;
1029                 try {
1030                         topLevelAlbums =
1031                                         configurationSoneParser.parseTopLevelAlbums(database);
1032                 } catch (InvalidAlbumFound iaf) {
1033                         logger.log(Level.WARNING, "Invalid album found, aborting load!");
1034                         return;
1035                 } catch (InvalidParentAlbumFound ipaf) {
1036                         logger.log(Level.WARNING, format("Invalid parent album ID: %s",
1037                                         ipaf.getAlbumParentId()));
1038                         return;
1039                 }
1040
1041                 /* load images. */
1042                 try {
1043                         configurationSoneParser.parseImages(database);
1044                 } catch (InvalidImageFound iif) {
1045                         logger.log(WARNING, "Invalid image found, aborting load!");
1046                         return;
1047                 } catch (InvalidParentAlbumFound ipaf) {
1048                         logger.log(Level.WARNING,
1049                                         format("Invalid album image (%s) encountered, aborting load!",
1050                                                         ipaf.getAlbumParentId()));
1051                         return;
1052                 }
1053
1054                 /* load avatar. */
1055                 String avatarId = configuration.getStringValue(sonePrefix + "/Profile/Avatar").getValue(null);
1056                 if (avatarId != null) {
1057                         final Map<String, Image> images =
1058                                         configurationSoneParser.getImages();
1059                         profile.setAvatar(images.get(avatarId));
1060                 }
1061
1062                 /* load options. */
1063                 sone.getOptions().setAutoFollow(configuration.getBooleanValue(sonePrefix + "/Options/AutoFollow").getValue(null));
1064                 sone.getOptions().setSoneInsertNotificationEnabled(configuration.getBooleanValue(sonePrefix + "/Options/EnableSoneInsertNotifications").getValue(null));
1065                 sone.getOptions().setShowNewSoneNotifications(configuration.getBooleanValue(sonePrefix + "/Options/ShowNotification/NewSones").getValue(null));
1066                 sone.getOptions().setShowNewPostNotifications(configuration.getBooleanValue(sonePrefix + "/Options/ShowNotification/NewPosts").getValue(null));
1067                 sone.getOptions().setShowNewReplyNotifications(configuration.getBooleanValue(sonePrefix + "/Options/ShowNotification/NewReplies").getValue(null));
1068                 sone.getOptions().setShowCustomAvatars(ShowCustomAvatars.valueOf(configuration.getStringValue(sonePrefix + "/Options/ShowCustomAvatars").getValue(ShowCustomAvatars.NEVER.name())));
1069
1070                 /* if we’re still here, Sone was loaded successfully. */
1071                 synchronized (sone) {
1072                         sone.setTime(soneTime);
1073                         sone.setProfile(profile);
1074                         sone.setPosts(posts);
1075                         sone.setReplies(replies);
1076                         sone.setLikePostIds(likedPostIds);
1077                         sone.setLikeReplyIds(likedReplyIds);
1078                         for (String friendId : friends) {
1079                                 followSone(sone, friendId);
1080                         }
1081                         for (Album album : sone.getRootAlbum().getAlbums()) {
1082                                 sone.getRootAlbum().removeAlbum(album);
1083                         }
1084                         for (Album album : topLevelAlbums) {
1085                                 sone.getRootAlbum().addAlbum(album);
1086                         }
1087                         database.storeSone(sone);
1088                         synchronized (soneInserters) {
1089                                 soneInserters.get(sone).setLastInsertFingerprint(lastInsertFingerprint);
1090                         }
1091                 }
1092                 synchronized (knownSones) {
1093                         for (String friend : friends) {
1094                                 knownSones.add(friend);
1095                         }
1096                 }
1097                 for (Post post : posts) {
1098                         post.setKnown(true);
1099                 }
1100                 for (PostReply reply : replies) {
1101                         reply.setKnown(true);
1102                 }
1103
1104                 logger.info(String.format("Sone loaded successfully: %s", sone));
1105         }
1106
1107         /**
1108          * Creates a new post.
1109          *
1110          * @param sone
1111          *            The Sone that creates the post
1112          * @param recipient
1113          *            The recipient Sone, or {@code null} if this post does not have
1114          *            a recipient
1115          * @param text
1116          *            The text of the post
1117          * @return The created post
1118          */
1119         public Post createPost(Sone sone, Optional<Sone> recipient, String text) {
1120                 checkNotNull(text, "text must not be null");
1121                 checkArgument(text.trim().length() > 0, "text must not be empty");
1122                 if (!sone.isLocal()) {
1123                         logger.log(Level.FINE, String.format("Tried to create post for non-local Sone: %s", sone));
1124                         return null;
1125                 }
1126                 PostBuilder postBuilder = database.newPostBuilder();
1127                 postBuilder.from(sone.getId()).randomId().currentTime().withText(text.trim());
1128                 if (recipient.isPresent()) {
1129                         postBuilder.to(recipient.get().getId());
1130                 }
1131                 final Post post = postBuilder.build();
1132                 database.storePost(post);
1133                 eventBus.post(new NewPostFoundEvent(post));
1134                 sone.addPost(post);
1135                 touchConfiguration();
1136                 localElementTicker.schedule(new MarkPostKnown(post), 10, TimeUnit.SECONDS);
1137                 return post;
1138         }
1139
1140         /**
1141          * Deletes the given post.
1142          *
1143          * @param post
1144          *            The post to delete
1145          */
1146         public void deletePost(Post post) {
1147                 if (!post.getSone().isLocal()) {
1148                         logger.log(Level.WARNING, String.format("Tried to delete post of non-local Sone: %s", post.getSone()));
1149                         return;
1150                 }
1151                 database.removePost(post);
1152                 eventBus.post(new PostRemovedEvent(post));
1153                 markPostKnown(post);
1154                 touchConfiguration();
1155         }
1156
1157         /**
1158          * Marks the given post as known, if it is currently not a known post
1159          * (according to {@link Post#isKnown()}).
1160          *
1161          * @param post
1162          *            The post to mark as known
1163          */
1164         public void markPostKnown(Post post) {
1165                 post.setKnown(true);
1166                 eventBus.post(new MarkPostKnownEvent(post));
1167                 touchConfiguration();
1168                 for (PostReply reply : getReplies(post.getId())) {
1169                         markReplyKnown(reply);
1170                 }
1171         }
1172
1173         public void bookmarkPost(Post post) {
1174                 database.bookmarkPost(post);
1175         }
1176
1177         /**
1178          * Removes the given post from the bookmarks.
1179          *
1180          * @param post
1181          *            The post to unbookmark
1182          */
1183         public void unbookmarkPost(Post post) {
1184                 database.unbookmarkPost(post);
1185         }
1186
1187         /**
1188          * Creates a new reply.
1189          *
1190          * @param sone
1191          *            The Sone that creates the reply
1192          * @param post
1193          *            The post that this reply refers to
1194          * @param text
1195          *            The text of the reply
1196          * @return The created reply
1197          */
1198         public PostReply createReply(Sone sone, Post post, String text) {
1199                 checkNotNull(text, "text must not be null");
1200                 checkArgument(text.trim().length() > 0, "text must not be empty");
1201                 if (!sone.isLocal()) {
1202                         logger.log(Level.FINE, String.format("Tried to create reply for non-local Sone: %s", sone));
1203                         return null;
1204                 }
1205                 PostReplyBuilder postReplyBuilder = postReplyBuilder();
1206                 postReplyBuilder.randomId().from(sone.getId()).to(post.getId()).currentTime().withText(text.trim());
1207                 final PostReply reply = postReplyBuilder.build();
1208                 database.storePostReply(reply);
1209                 eventBus.post(new NewPostReplyFoundEvent(reply));
1210                 sone.addReply(reply);
1211                 touchConfiguration();
1212                 localElementTicker.schedule(new MarkReplyKnown(reply), 10, TimeUnit.SECONDS);
1213                 return reply;
1214         }
1215
1216         /**
1217          * Deletes the given reply.
1218          *
1219          * @param reply
1220          *            The reply to delete
1221          */
1222         public void deleteReply(PostReply reply) {
1223                 Sone sone = reply.getSone();
1224                 if (!sone.isLocal()) {
1225                         logger.log(Level.FINE, String.format("Tried to delete non-local reply: %s", reply));
1226                         return;
1227                 }
1228                 database.removePostReply(reply);
1229                 markReplyKnown(reply);
1230                 sone.removeReply(reply);
1231                 touchConfiguration();
1232         }
1233
1234         /**
1235          * Marks the given reply as known, if it is currently not a known reply
1236          * (according to {@link Reply#isKnown()}).
1237          *
1238          * @param reply
1239          *            The reply to mark as known
1240          */
1241         public void markReplyKnown(PostReply reply) {
1242                 boolean previouslyKnown = reply.isKnown();
1243                 reply.setKnown(true);
1244                 eventBus.post(new MarkPostReplyKnownEvent(reply));
1245                 if (!previouslyKnown) {
1246                         touchConfiguration();
1247                 }
1248         }
1249
1250         /**
1251          * Creates a new album for the given Sone.
1252          *
1253          * @param sone
1254          *            The Sone to create the album for
1255          * @param parent
1256          *            The parent of the album (may be {@code null} to create a
1257          *            top-level album)
1258          * @return The new album
1259          */
1260         public Album createAlbum(Sone sone, Album parent) {
1261                 Album album = database.newAlbumBuilder().randomId().by(sone).build();
1262                 database.storeAlbum(album);
1263                 parent.addAlbum(album);
1264                 return album;
1265         }
1266
1267         /**
1268          * Deletes the given album. The owner of the album has to be a local Sone,
1269          * and the album has to be {@link Album#isEmpty() empty} to be deleted.
1270          *
1271          * @param album
1272          *            The album to remove
1273          */
1274         public void deleteAlbum(Album album) {
1275                 checkNotNull(album, "album must not be null");
1276                 checkArgument(album.getSone().isLocal(), "album’s Sone must be a local Sone");
1277                 if (!album.isEmpty()) {
1278                         return;
1279                 }
1280                 album.getParent().removeAlbum(album);
1281                 database.removeAlbum(album);
1282                 touchConfiguration();
1283         }
1284
1285         /**
1286          * Creates a new image.
1287          *
1288          * @param sone
1289          *            The Sone creating the image
1290          * @param album
1291          *            The album the image will be inserted into
1292          * @param temporaryImage
1293          *            The temporary image to create the image from
1294          * @return The newly created image
1295          */
1296         public Image createImage(Sone sone, Album album, TemporaryImage temporaryImage) {
1297                 checkNotNull(sone, "sone must not be null");
1298                 checkNotNull(album, "album must not be null");
1299                 checkNotNull(temporaryImage, "temporaryImage must not be null");
1300                 checkArgument(sone.isLocal(), "sone must be a local Sone");
1301                 checkArgument(sone.equals(album.getSone()), "album must belong to the given Sone");
1302                 Image image = database.newImageBuilder().withId(temporaryImage.getId()).build().modify().setSone(sone).setCreationTime(System.currentTimeMillis()).update();
1303                 album.addImage(image);
1304                 database.storeImage(image);
1305                 imageInserter.insertImage(temporaryImage, image);
1306                 return image;
1307         }
1308
1309         /**
1310          * Deletes the given image. This method will also delete a matching
1311          * temporary image.
1312          *
1313          * @see #deleteTemporaryImage(String)
1314          * @param image
1315          *            The image to delete
1316          */
1317         public void deleteImage(Image image) {
1318                 checkNotNull(image, "image must not be null");
1319                 checkArgument(image.getSone().isLocal(), "image must belong to a local Sone");
1320                 deleteTemporaryImage(image.getId());
1321                 image.getAlbum().removeImage(image);
1322                 database.removeImage(image);
1323                 touchConfiguration();
1324         }
1325
1326         /**
1327          * Creates a new temporary image.
1328          *
1329          * @param mimeType
1330          *            The MIME type of the temporary image
1331          * @param imageData
1332          *            The encoded data of the image
1333          * @return The temporary image
1334          */
1335         public TemporaryImage createTemporaryImage(String mimeType, byte[] imageData) {
1336                 TemporaryImage temporaryImage = new TemporaryImage();
1337                 temporaryImage.setMimeType(mimeType).setImageData(imageData);
1338                 synchronized (temporaryImages) {
1339                         temporaryImages.put(temporaryImage.getId(), temporaryImage);
1340                 }
1341                 return temporaryImage;
1342         }
1343
1344         /**
1345          * Deletes the temporary image with the given ID.
1346          *
1347          * @param imageId
1348          *            The ID of the temporary image to delete
1349          */
1350         public void deleteTemporaryImage(String imageId) {
1351                 checkNotNull(imageId, "imageId must not be null");
1352                 synchronized (temporaryImages) {
1353                         temporaryImages.remove(imageId);
1354                 }
1355                 Image image = getImage(imageId, false);
1356                 if (image != null) {
1357                         imageInserter.cancelImageInsert(image);
1358                 }
1359         }
1360
1361         /**
1362          * Notifies the core that the configuration, either of the core or of a
1363          * single local Sone, has changed, and that the configuration should be
1364          * saved.
1365          */
1366         public void touchConfiguration() {
1367                 lastConfigurationUpdate = System.currentTimeMillis();
1368         }
1369
1370         //
1371         // SERVICE METHODS
1372         //
1373
1374         /**
1375          * Starts the core.
1376          */
1377         @Override
1378         public void serviceStart() {
1379                 loadConfiguration();
1380                 updateChecker.start();
1381                 identityManager.start();
1382                 webOfTrustUpdater.init();
1383                 webOfTrustUpdater.start();
1384                 database.start();
1385         }
1386
1387         /**
1388          * {@inheritDoc}
1389          */
1390         @Override
1391         public void serviceRun() {
1392                 long lastSaved = System.currentTimeMillis();
1393                 while (!shouldStop()) {
1394                         sleep(1000);
1395                         long now = System.currentTimeMillis();
1396                         if (shouldStop() || ((lastConfigurationUpdate > lastSaved) && ((now - lastConfigurationUpdate) > 5000))) {
1397                                 for (Sone localSone : getLocalSones()) {
1398                                         saveSone(localSone);
1399                                 }
1400                                 saveConfiguration();
1401                                 lastSaved = now;
1402                         }
1403                 }
1404         }
1405
1406         /**
1407          * Stops the core.
1408          */
1409         @Override
1410         public void serviceStop() {
1411                 localElementTicker.shutdownNow();
1412                 synchronized (soneInserters) {
1413                         for (Entry<Sone, SoneInserter> soneInserter : soneInserters.entrySet()) {
1414                                 soneInserter.getValue().stop();
1415                                 saveSone(soneInserter.getKey());
1416                         }
1417                 }
1418                 saveConfiguration();
1419                 database.stop();
1420                 webOfTrustUpdater.stop();
1421                 updateChecker.stop();
1422                 soneDownloader.stop();
1423                 soneDownloaders.shutdown();
1424                 identityManager.stop();
1425         }
1426
1427         //
1428         // PRIVATE METHODS
1429         //
1430
1431         /**
1432          * Saves the given Sone. This will persist all local settings for the given
1433          * Sone, such as the friends list and similar, private options.
1434          *
1435          * @param sone
1436          *            The Sone to save
1437          */
1438         private synchronized void saveSone(Sone sone) {
1439                 if (!sone.isLocal()) {
1440                         logger.log(Level.FINE, String.format("Tried to save non-local Sone: %s", sone));
1441                         return;
1442                 }
1443                 if (!(sone.getIdentity() instanceof OwnIdentity)) {
1444                         logger.log(Level.WARNING, String.format("Local Sone without OwnIdentity found, refusing to save: %s", sone));
1445                         return;
1446                 }
1447
1448                 logger.log(Level.INFO, String.format("Saving Sone: %s", sone));
1449                 try {
1450                         /* save Sone into configuration. */
1451                         String sonePrefix = "Sone/" + sone.getId();
1452                         configuration.getLongValue(sonePrefix + "/Time").setValue(sone.getTime());
1453                         configuration.getStringValue(sonePrefix + "/LastInsertFingerprint").setValue(soneInserters.get(sone).getLastInsertFingerprint());
1454
1455                         /* save profile. */
1456                         Profile profile = sone.getProfile();
1457                         configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
1458                         configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
1459                         configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
1460                         configuration.getIntValue(sonePrefix + "/Profile/BirthDay").setValue(profile.getBirthDay());
1461                         configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").setValue(profile.getBirthMonth());
1462                         configuration.getIntValue(sonePrefix + "/Profile/BirthYear").setValue(profile.getBirthYear());
1463                         configuration.getStringValue(sonePrefix + "/Profile/Avatar").setValue(profile.getAvatar());
1464
1465                         /* save profile fields. */
1466                         int fieldCounter = 0;
1467                         for (Field profileField : profile.getFields()) {
1468                                 String fieldPrefix = sonePrefix + "/Profile/Fields/" + fieldCounter++;
1469                                 configuration.getStringValue(fieldPrefix + "/Name").setValue(profileField.getName());
1470                                 configuration.getStringValue(fieldPrefix + "/Value").setValue(profileField.getValue());
1471                         }
1472                         configuration.getStringValue(sonePrefix + "/Profile/Fields/" + fieldCounter + "/Name").setValue(null);
1473
1474                         /* save posts. */
1475                         int postCounter = 0;
1476                         for (Post post : sone.getPosts()) {
1477                                 String postPrefix = sonePrefix + "/Posts/" + postCounter++;
1478                                 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
1479                                 configuration.getStringValue(postPrefix + "/Recipient").setValue(post.getRecipientId().orNull());
1480                                 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
1481                                 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
1482                         }
1483                         configuration.getStringValue(sonePrefix + "/Posts/" + postCounter + "/ID").setValue(null);
1484
1485                         /* save replies. */
1486                         int replyCounter = 0;
1487                         for (PostReply reply : sone.getReplies()) {
1488                                 String replyPrefix = sonePrefix + "/Replies/" + replyCounter++;
1489                                 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
1490                                 configuration.getStringValue(replyPrefix + "/Post/ID").setValue(reply.getPostId());
1491                                 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
1492                                 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
1493                         }
1494                         configuration.getStringValue(sonePrefix + "/Replies/" + replyCounter + "/ID").setValue(null);
1495
1496                         /* save post likes. */
1497                         int postLikeCounter = 0;
1498                         for (String postId : sone.getLikedPostIds()) {
1499                                 configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter++ + "/ID").setValue(postId);
1500                         }
1501                         configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter + "/ID").setValue(null);
1502
1503                         /* save reply likes. */
1504                         int replyLikeCounter = 0;
1505                         for (String replyId : sone.getLikedReplyIds()) {
1506                                 configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter++ + "/ID").setValue(replyId);
1507                         }
1508                         configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter + "/ID").setValue(null);
1509
1510                         /* save friends. */
1511                         int friendCounter = 0;
1512                         for (String friendId : sone.getFriends()) {
1513                                 configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter++ + "/ID").setValue(friendId);
1514                         }
1515                         configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter + "/ID").setValue(null);
1516
1517                         /* save albums. first, collect in a flat structure, top-level first. */
1518                         List<Album> albums = FluentIterable.from(sone.getRootAlbum().getAlbums()).transformAndConcat(Album.FLATTENER).toList();
1519
1520                         int albumCounter = 0;
1521                         for (Album album : albums) {
1522                                 String albumPrefix = sonePrefix + "/Albums/" + albumCounter++;
1523                                 configuration.getStringValue(albumPrefix + "/ID").setValue(album.getId());
1524                                 configuration.getStringValue(albumPrefix + "/Title").setValue(album.getTitle());
1525                                 configuration.getStringValue(albumPrefix + "/Description").setValue(album.getDescription());
1526                                 configuration.getStringValue(albumPrefix + "/Parent").setValue(album.getParent().equals(sone.getRootAlbum()) ? null : album.getParent().getId());
1527                                 configuration.getStringValue(albumPrefix + "/AlbumImage").setValue(album.getAlbumImage() == null ? null : album.getAlbumImage().getId());
1528                         }
1529                         configuration.getStringValue(sonePrefix + "/Albums/" + albumCounter + "/ID").setValue(null);
1530
1531                         /* save images. */
1532                         int imageCounter = 0;
1533                         for (Album album : albums) {
1534                                 for (Image image : album.getImages()) {
1535                                         if (!image.isInserted()) {
1536                                                 continue;
1537                                         }
1538                                         String imagePrefix = sonePrefix + "/Images/" + imageCounter++;
1539                                         configuration.getStringValue(imagePrefix + "/ID").setValue(image.getId());
1540                                         configuration.getStringValue(imagePrefix + "/Album").setValue(album.getId());
1541                                         configuration.getStringValue(imagePrefix + "/Key").setValue(image.getKey());
1542                                         configuration.getStringValue(imagePrefix + "/Title").setValue(image.getTitle());
1543                                         configuration.getStringValue(imagePrefix + "/Description").setValue(image.getDescription());
1544                                         configuration.getLongValue(imagePrefix + "/CreationTime").setValue(image.getCreationTime());
1545                                         configuration.getIntValue(imagePrefix + "/Width").setValue(image.getWidth());
1546                                         configuration.getIntValue(imagePrefix + "/Height").setValue(image.getHeight());
1547                                 }
1548                         }
1549                         configuration.getStringValue(sonePrefix + "/Images/" + imageCounter + "/ID").setValue(null);
1550
1551                         /* save options. */
1552                         configuration.getBooleanValue(sonePrefix + "/Options/AutoFollow").setValue(sone.getOptions().isAutoFollow());
1553                         configuration.getBooleanValue(sonePrefix + "/Options/EnableSoneInsertNotifications").setValue(sone.getOptions().isSoneInsertNotificationEnabled());
1554                         configuration.getBooleanValue(sonePrefix + "/Options/ShowNotification/NewSones").setValue(sone.getOptions().isShowNewSoneNotifications());
1555                         configuration.getBooleanValue(sonePrefix + "/Options/ShowNotification/NewPosts").setValue(sone.getOptions().isShowNewPostNotifications());
1556                         configuration.getBooleanValue(sonePrefix + "/Options/ShowNotification/NewReplies").setValue(sone.getOptions().isShowNewReplyNotifications());
1557                         configuration.getStringValue(sonePrefix + "/Options/ShowCustomAvatars").setValue(sone.getOptions().getShowCustomAvatars().name());
1558
1559                         configuration.save();
1560
1561                         webOfTrustUpdater.setProperty((OwnIdentity) sone.getIdentity(), "Sone.LatestEdition", String.valueOf(sone.getLatestEdition()));
1562
1563                         logger.log(Level.INFO, String.format("Sone %s saved.", sone));
1564                 } catch (ConfigurationException ce1) {
1565                         logger.log(Level.WARNING, String.format("Could not save Sone: %s", sone), ce1);
1566                 }
1567         }
1568
1569         /**
1570          * Saves the current options.
1571          */
1572         private void saveConfiguration() {
1573                 synchronized (configuration) {
1574                         if (storingConfiguration) {
1575                                 logger.log(Level.FINE, "Already storing configuration…");
1576                                 return;
1577                         }
1578                         storingConfiguration = true;
1579                 }
1580
1581                 /* store the options first. */
1582                 try {
1583                         preferences.saveTo(configuration);
1584
1585                         /* save known Sones. */
1586                         int soneCounter = 0;
1587                         synchronized (knownSones) {
1588                                 for (String knownSoneId : knownSones) {
1589                                         configuration.getStringValue("KnownSone/" + soneCounter++ + "/ID").setValue(knownSoneId);
1590                                 }
1591                                 configuration.getStringValue("KnownSone/" + soneCounter + "/ID").setValue(null);
1592                         }
1593
1594                         /* save Sone following times. */
1595                         soneCounter = 0;
1596                         synchronized (soneFollowingTimes) {
1597                                 for (Entry<String, Long> soneFollowingTime : soneFollowingTimes.entrySet()) {
1598                                         configuration.getStringValue("SoneFollowingTimes/" + soneCounter + "/Sone").setValue(soneFollowingTime.getKey());
1599                                         configuration.getLongValue("SoneFollowingTimes/" + soneCounter + "/Time").setValue(soneFollowingTime.getValue());
1600                                         ++soneCounter;
1601                                 }
1602                                 configuration.getStringValue("SoneFollowingTimes/" + soneCounter + "/Sone").setValue(null);
1603                         }
1604
1605                         /* save known posts. */
1606                         database.save();
1607
1608                         /* now save it. */
1609                         configuration.save();
1610
1611                 } catch (ConfigurationException ce1) {
1612                         logger.log(Level.SEVERE, "Could not store configuration!", ce1);
1613                 } catch (DatabaseException de1) {
1614                         logger.log(Level.SEVERE, "Could not save database!", de1);
1615                 } finally {
1616                         synchronized (configuration) {
1617                                 storingConfiguration = false;
1618                         }
1619                 }
1620         }
1621
1622         /**
1623          * Loads the configuration.
1624          */
1625         private void loadConfiguration() {
1626                 new PreferencesLoader(preferences).loadFrom(configuration);
1627
1628                 /* load known Sones. */
1629                 int soneCounter = 0;
1630                 while (true) {
1631                         String knownSoneId = configuration.getStringValue("KnownSone/" + soneCounter++ + "/ID").getValue(null);
1632                         if (knownSoneId == null) {
1633                                 break;
1634                         }
1635                         synchronized (knownSones) {
1636                                 knownSones.add(knownSoneId);
1637                         }
1638                 }
1639
1640                 /* load Sone following times. */
1641                 soneCounter = 0;
1642                 while (true) {
1643                         String soneId = configuration.getStringValue("SoneFollowingTimes/" + soneCounter + "/Sone").getValue(null);
1644                         if (soneId == null) {
1645                                 break;
1646                         }
1647                         long time = configuration.getLongValue("SoneFollowingTimes/" + soneCounter + "/Time").getValue(Long.MAX_VALUE);
1648                         synchronized (soneFollowingTimes) {
1649                                 soneFollowingTimes.put(soneId, time);
1650                         }
1651                         ++soneCounter;
1652                 }
1653         }
1654
1655         /**
1656          * Notifies the core that a new {@link OwnIdentity} was added.
1657          *
1658          * @param ownIdentityAddedEvent
1659          *            The event
1660          */
1661         @Subscribe
1662         public void ownIdentityAdded(OwnIdentityAddedEvent ownIdentityAddedEvent) {
1663                 OwnIdentity ownIdentity = ownIdentityAddedEvent.ownIdentity();
1664                 logger.log(Level.FINEST, String.format("Adding OwnIdentity: %s", ownIdentity));
1665                 if (ownIdentity.hasContext("Sone")) {
1666                         addLocalSone(ownIdentity);
1667                 }
1668         }
1669
1670         /**
1671          * Notifies the core that an {@link OwnIdentity} was removed.
1672          *
1673          * @param ownIdentityRemovedEvent
1674          *            The event
1675          */
1676         @Subscribe
1677         public void ownIdentityRemoved(OwnIdentityRemovedEvent ownIdentityRemovedEvent) {
1678                 OwnIdentity ownIdentity = ownIdentityRemovedEvent.ownIdentity();
1679                 logger.log(Level.FINEST, String.format("Removing OwnIdentity: %s", ownIdentity));
1680                 trustedIdentities.removeAll(ownIdentity);
1681         }
1682
1683         /**
1684          * Notifies the core that a new {@link Identity} was added.
1685          *
1686          * @param identityAddedEvent
1687          *            The event
1688          */
1689         @Subscribe
1690         public void identityAdded(IdentityAddedEvent identityAddedEvent) {
1691                 Identity identity = identityAddedEvent.identity();
1692                 logger.log(Level.FINEST, String.format("Adding Identity: %s", identity));
1693                 trustedIdentities.put(identityAddedEvent.ownIdentity(), identity);
1694                 addRemoteSone(identity);
1695         }
1696
1697         /**
1698          * Notifies the core that an {@link Identity} was updated.
1699          *
1700          * @param identityUpdatedEvent
1701          *            The event
1702          */
1703         @Subscribe
1704         public void identityUpdated(IdentityUpdatedEvent identityUpdatedEvent) {
1705                 Identity identity = identityUpdatedEvent.identity();
1706                 final Sone sone = getRemoteSone(identity.getId());
1707                 if (sone.isLocal()) {
1708                         return;
1709                 }
1710                 sone.setLatestEdition(fromNullable(tryParse(identity.getProperty("Sone.LatestEdition"))).or(sone.getLatestEdition()));
1711                 soneDownloader.addSone(sone);
1712                 soneDownloaders.execute(soneDownloader.fetchSoneAction(sone));
1713         }
1714
1715         /**
1716          * Notifies the core that an {@link Identity} was removed.
1717          *
1718          * @param identityRemovedEvent
1719          *            The event
1720          */
1721         @Subscribe
1722         public void identityRemoved(IdentityRemovedEvent identityRemovedEvent) {
1723                 OwnIdentity ownIdentity = identityRemovedEvent.ownIdentity();
1724                 Identity identity = identityRemovedEvent.identity();
1725                 trustedIdentities.remove(ownIdentity, identity);
1726                 for (Entry<OwnIdentity, Collection<Identity>> trustedIdentity : trustedIdentities.asMap().entrySet()) {
1727                         if (trustedIdentity.getKey().equals(ownIdentity)) {
1728                                 continue;
1729                         }
1730                         if (trustedIdentity.getValue().contains(identity)) {
1731                                 return;
1732                         }
1733                 }
1734                 Optional<Sone> sone = getSone(identity.getId());
1735                 if (!sone.isPresent()) {
1736                         /* TODO - we don’t have the Sone anymore. should this happen? */
1737                         return;
1738                 }
1739                 database.removeSone(sone.get());
1740                 eventBus.post(new SoneRemovedEvent(sone.get()));
1741         }
1742
1743         /**
1744          * Deletes the temporary image.
1745          *
1746          * @param imageInsertFinishedEvent
1747          *            The event
1748          */
1749         @Subscribe
1750         public void imageInsertFinished(ImageInsertFinishedEvent imageInsertFinishedEvent) {
1751                 logger.log(Level.WARNING, String.format("Image insert finished for %s: %s", imageInsertFinishedEvent.image(), imageInsertFinishedEvent.resultingUri()));
1752                 imageInsertFinishedEvent.image().modify().setKey(imageInsertFinishedEvent.resultingUri().toString()).update();
1753                 deleteTemporaryImage(imageInsertFinishedEvent.image().getId());
1754                 touchConfiguration();
1755         }
1756
1757         @VisibleForTesting
1758         class MarkPostKnown implements Runnable {
1759
1760                 private final Post post;
1761
1762                 public MarkPostKnown(Post post) {
1763                         this.post = post;
1764                 }
1765
1766                 @Override
1767                 public void run() {
1768                         markPostKnown(post);
1769                 }
1770
1771         }
1772
1773         @VisibleForTesting
1774         class MarkReplyKnown implements Runnable {
1775
1776                 private final PostReply postReply;
1777
1778                 public MarkReplyKnown(PostReply postReply) {
1779                         this.postReply = postReply;
1780                 }
1781
1782                 @Override
1783                 public void run() {
1784                         markReplyKnown(postReply);
1785                 }
1786
1787         }
1788
1789 }