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