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

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