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

   1 /*
   2  * Sone - Core.java - Copyright © 2010 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.core;
  19
  20 import java.net.MalformedURLException;
  21 import java.util.ArrayList;
  22 import java.util.Collections;
  23 import java.util.HashMap;
  24 import java.util.HashSet;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.Set;
  28 import java.util.Map.Entry;
  29 import java.util.concurrent.ExecutorService;
  30 import java.util.concurrent.Executors;
  31 import java.util.logging.Level;
  32 import java.util.logging.Logger;
  33
  34 import net.pterodactylus.sone.core.Options.DefaultOption;
  35 import net.pterodactylus.sone.core.Options.Option;
  36 import net.pterodactylus.sone.core.Options.OptionWatcher;
  37 import net.pterodactylus.sone.data.Album;
  38 import net.pterodactylus.sone.data.Client;
  39 import net.pterodactylus.sone.data.Image;
  40 import net.pterodactylus.sone.data.Post;
  41 import net.pterodactylus.sone.data.PostReply;
  42 import net.pterodactylus.sone.data.Profile;
  43 import net.pterodactylus.sone.data.Reply;
  44 import net.pterodactylus.sone.data.Sone;
  45 import net.pterodactylus.sone.data.TemporaryImage;
  46 import net.pterodactylus.sone.data.Profile.Field;
  47 import net.pterodactylus.sone.fcp.FcpInterface;
  48 import net.pterodactylus.sone.fcp.FcpInterface.FullAccessRequired;
  49 import net.pterodactylus.sone.freenet.wot.Identity;
  50 import net.pterodactylus.sone.freenet.wot.IdentityListener;
  51 import net.pterodactylus.sone.freenet.wot.IdentityManager;
  52 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
  53 import net.pterodactylus.sone.freenet.wot.Trust;
  54 import net.pterodactylus.sone.freenet.wot.WebOfTrustException;
  55 import net.pterodactylus.sone.main.SonePlugin;
  56 import net.pterodactylus.util.config.Configuration;
  57 import net.pterodactylus.util.config.ConfigurationException;
  58 import net.pterodactylus.util.logging.Logging;
  59 import net.pterodactylus.util.number.Numbers;
  60 import net.pterodactylus.util.service.AbstractService;
  61 import net.pterodactylus.util.thread.Ticker;
  62 import net.pterodactylus.util.validation.EqualityValidator;
  63 import net.pterodactylus.util.validation.IntegerRangeValidator;
  64 import net.pterodactylus.util.validation.OrValidator;
  65 import net.pterodactylus.util.validation.Validation;
  66 import net.pterodactylus.util.version.Version;
  67 import freenet.keys.FreenetURI;
  68
  69 /**
  70  * The Sone core.
  71  *
  72  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  73  */
  74 public class Core extends AbstractService implements IdentityListener, UpdateListener, SoneProvider, PostProvider, SoneInsertListener, ImageInsertListener {
  75
  76         /**
  77          * Enumeration for the possible states of a {@link Sone}.
  78          *
  79          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  80          */
  81         public enum SoneStatus {
  82
  83                 /** The Sone is unknown, i.e. not yet downloaded. */
  84                 unknown,
  85
  86                 /** The Sone is idle, i.e. not being downloaded or inserted. */
  87                 idle,
  88
  89                 /** The Sone is currently being inserted. */
  90                 inserting,
  91
  92                 /** The Sone is currently being downloaded. */
  93                 downloading,
  94         }
  95
  96         /** The logger. */
  97         private static final Logger logger = Logging.getLogger(Core.class);
  98
  99         /** The options. */
 100         private final Options options = new Options();
 101
 102         /** The preferences. */
 103         private final Preferences preferences = new Preferences(options);
 104
 105         /** The core listener manager. */
 106         private final CoreListenerManager coreListenerManager = new CoreListenerManager(this);
 107
 108         /** The configuration. */
 109         private Configuration configuration;
 110
 111         /** Whether we’re currently saving the configuration. */
 112         private boolean storingConfiguration = false;
 113
 114         /** The identity manager. */
 115         private final IdentityManager identityManager;
 116
 117         /** Interface to freenet. */
 118         private final FreenetInterface freenetInterface;
 119
 120         /** The Sone downloader. */
 121         private final SoneDownloader soneDownloader;
 122
 123         /** The image inserter. */
 124         private final ImageInserter imageInserter;
 125
 126         /** Sone downloader thread-pool. */
 127         private final ExecutorService soneDownloaders = Executors.newFixedThreadPool(10);
 128
 129         /** The update checker. */
 130         private final UpdateChecker updateChecker;
 131
 132         /** The FCP interface. */
 133         private volatile FcpInterface fcpInterface;
 134
 135         /** The Sones’ statuses. */
 136         /* synchronize access on itself. */
 137         private final Map<Sone, SoneStatus> soneStatuses = new HashMap<Sone, SoneStatus>();
 138
 139         /** The times Sones were followed. */
 140         private final Map<Sone, Long> soneFollowingTimes = new HashMap<Sone, Long>();
 141
 142         /** Locked local Sones. */
 143         /* synchronize on itself. */
 144         private final Set<Sone> lockedSones = new HashSet<Sone>();
 145
 146         /** Sone inserters. */
 147         /* synchronize access on this on localSones. */
 148         private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
 149
 150         /** Sone rescuers. */
 151         /* synchronize access on this on localSones. */
 152         private final Map<Sone, SoneRescuer> soneRescuers = new HashMap<Sone, SoneRescuer>();
 153
 154         /** All local Sones. */
 155         /* synchronize access on this on itself. */
 156         private Map<String, Sone> localSones = new HashMap<String, Sone>();
 157
 158         /** All remote Sones. */
 159         /* synchronize access on this on itself. */
 160         private Map<String, Sone> remoteSones = new HashMap<String, Sone>();
 161
 162         /** All new Sones. */
 163         private Set<String> newSones = new HashSet<String>();
 164
 165         /** All known Sones. */
 166         /* synchronize access on {@link #newSones}. */
 167         private Set<String> knownSones = new HashSet<String>();
 168
 169         /** All posts. */
 170         private Map<String, Post> posts = new HashMap<String, Post>();
 171
 172         /** All new posts. */
 173         private Set<String> newPosts = new HashSet<String>();
 174
 175         /** All known posts. */
 176         /* synchronize access on {@link #newPosts}. */
 177         private Set<String> knownPosts = new HashSet<String>();
 178
 179         /** All replies. */
 180         private Map<String, PostReply> replies = new HashMap<String, PostReply>();
 181
 182         /** All new replies. */
 183         private Set<String> newReplies = new HashSet<String>();
 184
 185         /** All known replies. */
 186         private Set<String> knownReplies = new HashSet<String>();
 187
 188         /** All bookmarked posts. */
 189         /* synchronize access on itself. */
 190         private Set<String> bookmarkedPosts = new HashSet<String>();
 191
 192         /** Trusted identities, sorted by own identities. */
 193         private Map<OwnIdentity, Set<Identity>> trustedIdentities = Collections.synchronizedMap(new HashMap<OwnIdentity, Set<Identity>>());
 194
 195         /** All known albums. */
 196         private Map<String, Album> albums = new HashMap<String, Album>();
 197
 198         /** All known images. */
 199         private Map<String, Image> images = new HashMap<String, Image>();
 200
 201         /** All temporary images. */
 202         private Map<String, TemporaryImage> temporaryImages = new HashMap<String, TemporaryImage>();
 203
 204         /** Ticker for threads that mark own elements as known. */
 205         private Ticker localElementTicker = new Ticker();
 206
 207         /** The time the configuration was last touched. */
 208         private volatile long lastConfigurationUpdate;
 209
 210         /**
 211          * Creates a new core.
 212          *
 213          * @param configuration
 214          *            The configuration of the core
 215          * @param freenetInterface
 216          *            The freenet interface
 217          * @param identityManager
 218          *            The identity manager
 219          */
 220         public Core(Configuration configuration, FreenetInterface freenetInterface, IdentityManager identityManager) {
 221                 super("Sone Core");
 222                 this.configuration = configuration;
 223                 this.freenetInterface = freenetInterface;
 224                 this.identityManager = identityManager;
 225                 this.soneDownloader = new SoneDownloader(this, freenetInterface);
 226                 this.imageInserter = new ImageInserter(this, freenetInterface);
 227                 this.updateChecker = new UpdateChecker(freenetInterface);
 228         }
 229
 230         //
 231         // LISTENER MANAGEMENT
 232         //
 233
 234         /**
 235          * Adds a new core listener.
 236          *
 237          * @param coreListener
 238          *            The listener to add
 239          */
 240         public void addCoreListener(CoreListener coreListener) {
 241                 coreListenerManager.addListener(coreListener);
 242         }
 243
 244         /**
 245          * Removes a core listener.
 246          *
 247          * @param coreListener
 248          *            The listener to remove
 249          */
 250         public void removeCoreListener(CoreListener coreListener) {
 251                 coreListenerManager.removeListener(coreListener);
 252         }
 253
 254         //
 255         // ACCESSORS
 256         //
 257
 258         /**
 259          * Sets the configuration to use. This will automatically save the current
 260          * configuration to the given configuration.
 261          *
 262          * @param configuration
 263          *            The new configuration to use
 264          */
 265         public void setConfiguration(Configuration configuration) {
 266                 this.configuration = configuration;
 267                 touchConfiguration();
 268         }
 269
 270         /**
 271          * Returns the options used by the core.
 272          *
 273          * @return The options of the core
 274          */
 275         public Preferences getPreferences() {
 276                 return preferences;
 277         }
 278
 279         /**
 280          * Returns the identity manager used by the core.
 281          *
 282          * @return The identity manager
 283          */
 284         public IdentityManager getIdentityManager() {
 285                 return identityManager;
 286         }
 287
 288         /**
 289          * Returns the update checker.
 290          *
 291          * @return The update checker
 292          */
 293         public UpdateChecker getUpdateChecker() {
 294                 return updateChecker;
 295         }
 296
 297         /**
 298          * Sets the FCP interface to use.
 299          *
 300          * @param fcpInterface
 301          *            The FCP interface to use
 302          */
 303         public void setFcpInterface(FcpInterface fcpInterface) {
 304                 this.fcpInterface = fcpInterface;
 305         }
 306
 307         /**
 308          * Returns the status of the given Sone.
 309          *
 310          * @param sone
 311          *            The Sone to get the status for
 312          * @return The status of the Sone
 313          */
 314         public SoneStatus getSoneStatus(Sone sone) {
 315                 synchronized (soneStatuses) {
 316                         return soneStatuses.get(sone);
 317                 }
 318         }
 319
 320         /**
 321          * Sets the status of the given Sone.
 322          *
 323          * @param sone
 324          *            The Sone to set the status of
 325          * @param soneStatus
 326          *            The status to set
 327          */
 328         public void setSoneStatus(Sone sone, SoneStatus soneStatus) {
 329                 synchronized (soneStatuses) {
 330                         soneStatuses.put(sone, soneStatus);
 331                 }
 332         }
 333
 334         /**
 335          * Returns the Sone rescuer for the given local Sone.
 336          *
 337          * @param sone
 338          *            The local Sone to get the rescuer for
 339          * @return The Sone rescuer for the given Sone
 340          */
 341         public SoneRescuer getSoneRescuer(Sone sone) {
 342                 Validation.begin().isNotNull("Sone", sone).check().is("Local Sone", isLocalSone(sone)).check();
 343                 synchronized (localSones) {
 344                         SoneRescuer soneRescuer = soneRescuers.get(sone);
 345                         if (soneRescuer == null) {
 346                                 soneRescuer = new SoneRescuer(this, soneDownloader, sone);
 347                                 soneRescuers.put(sone, soneRescuer);
 348                                 soneRescuer.start();
 349                         }
 350                         return soneRescuer;
 351                 }
 352         }
 353
 354         /**
 355          * Returns whether the given Sone is currently locked.
 356          *
 357          * @param sone
 358          *            The sone to check
 359          * @return {@code true} if the Sone is locked, {@code false} if it is not
 360          */
 361         public boolean isLocked(Sone sone) {
 362                 synchronized (lockedSones) {
 363                         return lockedSones.contains(sone);
 364                 }
 365         }
 366
 367         /**
 368          * Returns all Sones, remote and local.
 369          *
 370          * @return All Sones
 371          */
 372         public Set<Sone> getSones() {
 373                 Set<Sone> allSones = new HashSet<Sone>();
 374                 allSones.addAll(getLocalSones());
 375                 allSones.addAll(getRemoteSones());
 376                 return allSones;
 377         }
 378
 379         /**
 380          * Returns the Sone with the given ID, regardless whether it’s local or
 381          * remote.
 382          *
 383          * @param id
 384          *            The ID of the Sone to get
 385          * @return The Sone with the given ID, or {@code null} if there is no such
 386          *         Sone
 387          */
 388         public Sone getSone(String id) {
 389                 return getSone(id, true);
 390         }
 391
 392         /**
 393          * Returns the Sone with the given ID, regardless whether it’s local or
 394          * remote.
 395          *
 396          * @param id
 397          *            The ID of the Sone to get
 398          * @param create
 399          *            {@code true} to create a new Sone if none exists,
 400          *            {@code false} to return {@code null} if a Sone with the given
 401          *            ID does not exist
 402          * @return The Sone with the given ID, or {@code null} if there is no such
 403          *         Sone
 404          */
 405         @Override
 406         public Sone getSone(String id, boolean create) {
 407                 if (isLocalSone(id)) {
 408                         return getLocalSone(id);
 409                 }
 410                 return getRemoteSone(id, create);
 411         }
 412
 413         /**
 414          * Checks whether the core knows a Sone with the given ID.
 415          *
 416          * @param id
 417          *            The ID of the Sone
 418          * @return {@code true} if there is a Sone with the given ID, {@code false}
 419          *         otherwise
 420          */
 421         public boolean hasSone(String id) {
 422                 return isLocalSone(id) || isRemoteSone(id);
 423         }
 424
 425         /**
 426          * Returns whether the given Sone is a local Sone.
 427          *
 428          * @param sone
 429          *            The Sone to check for its locality
 430          * @return {@code true} if the given Sone is local, {@code false} otherwise
 431          */
 432         public boolean isLocalSone(Sone sone) {
 433                 synchronized (localSones) {
 434                         return localSones.containsKey(sone.getId());
 435                 }
 436         }
 437
 438         /**
 439          * Returns whether the given ID is the ID of a local Sone.
 440          *
 441          * @param id
 442          *            The Sone ID to check for its locality
 443          * @return {@code true} if the given ID is a local Sone, {@code false}
 444          *         otherwise
 445          */
 446         public boolean isLocalSone(String id) {
 447                 synchronized (localSones) {
 448                         return localSones.containsKey(id);
 449                 }
 450         }
 451
 452         /**
 453          * Returns all local Sones.
 454          *
 455          * @return All local Sones
 456          */
 457         public Set<Sone> getLocalSones() {
 458                 synchronized (localSones) {
 459                         return new HashSet<Sone>(localSones.values());
 460                 }
 461         }
 462
 463         /**
 464          * Returns the local Sone with the given ID.
 465          *
 466          * @param id
 467          *            The ID of the Sone to get
 468          * @return The Sone with the given ID
 469          */
 470         public Sone getLocalSone(String id) {
 471                 return getLocalSone(id, true);
 472         }
 473
 474         /**
 475          * Returns the local Sone with the given ID, optionally creating a new Sone.
 476          *
 477          * @param id
 478          *            The ID of the Sone
 479          * @param create
 480          *            {@code true} to create a new Sone if none exists,
 481          *            {@code false} to return null if none exists
 482          * @return The Sone with the given ID, or {@code null}
 483          */
 484         public Sone getLocalSone(String id, boolean create) {
 485                 synchronized (localSones) {
 486                         Sone sone = localSones.get(id);
 487                         if ((sone == null) && create) {
 488                                 sone = new Sone(id);
 489                                 localSones.put(id, sone);
 490                                 setSoneStatus(sone, SoneStatus.unknown);
 491                         }
 492                         return sone;
 493                 }
 494         }
 495
 496         /**
 497          * Returns all remote Sones.
 498          *
 499          * @return All remote Sones
 500          */
 501         public Set<Sone> getRemoteSones() {
 502                 synchronized (remoteSones) {
 503                         return new HashSet<Sone>(remoteSones.values());
 504                 }
 505         }
 506
 507         /**
 508          * Returns the remote Sone with the given ID.
 509          *
 510          * @param id
 511          *            The ID of the remote Sone to get
 512          * @return The Sone with the given ID
 513          */
 514         public Sone getRemoteSone(String id) {
 515                 return getRemoteSone(id, true);
 516         }
 517
 518         /**
 519          * Returns the remote Sone with the given ID.
 520          *
 521          * @param id
 522          *            The ID of the remote Sone to get
 523          * @param create
 524          *            {@code true} to always create a Sone, {@code false} to return
 525          *            {@code null} if no Sone with the given ID exists
 526          * @return The Sone with the given ID
 527          */
 528         public Sone getRemoteSone(String id, boolean create) {
 529                 synchronized (remoteSones) {
 530                         Sone sone = remoteSones.get(id);
 531                         if ((sone == null) && create) {
 532                                 sone = new Sone(id);
 533                                 remoteSones.put(id, sone);
 534                                 setSoneStatus(sone, SoneStatus.unknown);
 535                         }
 536                         return sone;
 537                 }
 538         }
 539
 540         /**
 541          * Returns whether the given Sone is a remote Sone.
 542          *
 543          * @param sone
 544          *            The Sone to check
 545          * @return {@code true} if the given Sone is a remote Sone, {@code false}
 546          *         otherwise
 547          */
 548         public boolean isRemoteSone(Sone sone) {
 549                 synchronized (remoteSones) {
 550                         return remoteSones.containsKey(sone.getId());
 551                 }
 552         }
 553
 554         /**
 555          * Returns whether the Sone with the given ID is a remote Sone.
 556          *
 557          * @param id
 558          *            The ID of the Sone to check
 559          * @return {@code true} if the Sone with the given ID is a remote Sone,
 560          *         {@code false} otherwise
 561          */
 562         public boolean isRemoteSone(String id) {
 563                 synchronized (remoteSones) {
 564                         return remoteSones.containsKey(id);
 565                 }
 566         }
 567
 568         /**
 569          * Returns whether the Sone with the given ID is a new Sone.
 570          *
 571          * @param soneId
 572          *            The ID of the sone to check for
 573          * @return {@code true} if the given Sone is new, false otherwise
 574          */
 575         public boolean isNewSone(String soneId) {
 576                 synchronized (newSones) {
 577                         return !knownSones.contains(soneId) && newSones.contains(soneId);
 578                 }
 579         }
 580
 581         /**
 582          * Returns whether the given Sone has been modified.
 583          *
 584          * @param sone
 585          *            The Sone to check for modifications
 586          * @return {@code true} if a modification has been detected in the Sone,
 587          *         {@code false} otherwise
 588          */
 589         public boolean isModifiedSone(Sone sone) {
 590                 return (soneInserters.containsKey(sone)) ? soneInserters.get(sone).isModified() : false;
 591         }
 592
 593         /**
 594          * Returns the time when the given was first followed by any local Sone.
 595          *
 596          * @param sone
 597          *            The Sone to get the time for
 598          * @return The time (in milliseconds since Jan 1, 1970) the Sone has first
 599          *         been followed, or {@link Long#MAX_VALUE}
 600          */
 601         public long getSoneFollowingTime(Sone sone) {
 602                 synchronized (soneFollowingTimes) {
 603                         if (soneFollowingTimes.containsKey(sone)) {
 604                                 return soneFollowingTimes.get(sone);
 605                         }
 606                         return Long.MAX_VALUE;
 607                 }
 608         }
 609
 610         /**
 611          * Returns whether the target Sone is trusted by the origin Sone.
 612          *
 613          * @param origin
 614          *            The origin Sone
 615          * @param target
 616          *            The target Sone
 617          * @return {@code true} if the target Sone is trusted by the origin Sone
 618          */
 619         public boolean isSoneTrusted(Sone origin, Sone target) {
 620                 Validation.begin().isNotNull("Origin", origin).isNotNull("Target", target).check().isInstanceOf("Origin’s OwnIdentity", origin.getIdentity(), OwnIdentity.class).check();
 621                 return trustedIdentities.containsKey(origin.getIdentity()) && trustedIdentities.get(origin.getIdentity()).contains(target.getIdentity());
 622         }
 623
 624         /**
 625          * Returns the post with the given ID.
 626          *
 627          * @param postId
 628          *            The ID of the post to get
 629          * @return The post with the given ID, or a new post with the given ID
 630          */
 631         public Post getPost(String postId) {
 632                 return getPost(postId, true);
 633         }
 634
 635         /**
 636          * Returns the post with the given ID, optionally creating a new post.
 637          *
 638          * @param postId
 639          *            The ID of the post to get
 640          * @param create
 641          *            {@code true} it create a new post if no post with the given ID
 642          *            exists, {@code false} to return {@code null}
 643          * @return The post, or {@code null} if there is no such post
 644          */
 645         @Override
 646         public Post getPost(String postId, boolean create) {
 647                 synchronized (posts) {
 648                         Post post = posts.get(postId);
 649                         if ((post == null) && create) {
 650                                 post = new Post(postId);
 651                                 posts.put(postId, post);
 652                         }
 653                         return post;
 654                 }
 655         }
 656
 657         /**
 658          * Returns whether the given post ID is new.
 659          *
 660          * @param postId
 661          *            The post ID
 662          * @return {@code true} if the post is considered to be new, {@code false}
 663          *         otherwise
 664          */
 665         public boolean isNewPost(String postId) {
 666                 synchronized (newPosts) {
 667                         return !knownPosts.contains(postId) && newPosts.contains(postId);
 668                 }
 669         }
 670
 671         /**
 672          * Returns all posts that have the given Sone as recipient.
 673          *
 674          * @see Post#getRecipient()
 675          * @param recipient
 676          *            The recipient of the posts
 677          * @return All posts that have the given Sone as recipient
 678          */
 679         public Set<Post> getDirectedPosts(Sone recipient) {
 680                 Validation.begin().isNotNull("Recipient", recipient).check();
 681                 Set<Post> directedPosts = new HashSet<Post>();
 682                 synchronized (posts) {
 683                         for (Post post : posts.values()) {
 684                                 if (recipient.equals(post.getRecipient())) {
 685                                         directedPosts.add(post);
 686                                 }
 687                         }
 688                 }
 689                 return directedPosts;
 690         }
 691
 692         /**
 693          * Returns the reply with the given ID. If there is no reply with the given
 694          * ID yet, a new one is created.
 695          *
 696          * @param replyId
 697          *            The ID of the reply to get
 698          * @return The reply
 699          */
 700         public PostReply getReply(String replyId) {
 701                 return getReply(replyId, true);
 702         }
 703
 704         /**
 705          * Returns the reply with the given ID. If there is no reply with the given
 706          * ID yet, a new one is created, unless {@code create} is false in which
 707          * case {@code null} is returned.
 708          *
 709          * @param replyId
 710          *            The ID of the reply to get
 711          * @param create
 712          *            {@code true} to always return a {@link Reply}, {@code false}
 713          *            to return {@code null} if no reply can be found
 714          * @return The reply, or {@code null} if there is no such reply
 715          */
 716         public PostReply getReply(String replyId, boolean create) {
 717                 synchronized (replies) {
 718                         PostReply reply = replies.get(replyId);
 719                         if (create && (reply == null)) {
 720                                 reply = new PostReply(replyId);
 721                                 replies.put(replyId, reply);
 722                         }
 723                         return reply;
 724                 }
 725         }
 726
 727         /**
 728          * Returns all replies for the given post, order ascending by time.
 729          *
 730          * @param post
 731          *            The post to get all replies for
 732          * @return All replies for the given post
 733          */
 734         public List<PostReply> getReplies(Post post) {
 735                 Set<Sone> sones = getSones();
 736                 List<PostReply> replies = new ArrayList<PostReply>();
 737                 for (Sone sone : sones) {
 738                         for (PostReply reply : sone.getReplies()) {
 739                                 if (reply.getPost().equals(post)) {
 740                                         replies.add(reply);
 741                                 }
 742                         }
 743                 }
 744                 Collections.sort(replies, Reply.TIME_COMPARATOR);
 745                 return replies;
 746         }
 747
 748         /**
 749          * Returns whether the reply with the given ID is new.
 750          *
 751          * @param replyId
 752          *            The ID of the reply to check
 753          * @return {@code true} if the reply is considered to be new, {@code false}
 754          *         otherwise
 755          */
 756         public boolean isNewReply(String replyId) {
 757                 synchronized (newReplies) {
 758                         return !knownReplies.contains(replyId) && newReplies.contains(replyId);
 759                 }
 760         }
 761
 762         /**
 763          * Returns all Sones that have liked the given post.
 764          *
 765          * @param post
 766          *            The post to get the liking Sones for
 767          * @return The Sones that like the given post
 768          */
 769         public Set<Sone> getLikes(Post post) {
 770                 Set<Sone> sones = new HashSet<Sone>();
 771                 for (Sone sone : getSones()) {
 772                         if (sone.getLikedPostIds().contains(post.getId())) {
 773                                 sones.add(sone);
 774                         }
 775                 }
 776                 return sones;
 777         }
 778
 779         /**
 780          * Returns all Sones that have liked the given reply.
 781          *
 782          * @param reply
 783          *            The reply to get the liking Sones for
 784          * @return The Sones that like the given reply
 785          */
 786         public Set<Sone> getLikes(PostReply reply) {
 787                 Set<Sone> sones = new HashSet<Sone>();
 788                 for (Sone sone : getSones()) {
 789                         if (sone.getLikedReplyIds().contains(reply.getId())) {
 790                                 sones.add(sone);
 791                         }
 792                 }
 793                 return sones;
 794         }
 795
 796         /**
 797          * Returns whether the given post is bookmarked.
 798          *
 799          * @param post
 800          *            The post to check
 801          * @return {@code true} if the given post is bookmarked, {@code false}
 802          *         otherwise
 803          */
 804         public boolean isBookmarked(Post post) {
 805                 return isPostBookmarked(post.getId());
 806         }
 807
 808         /**
 809          * Returns whether the post with the given ID is bookmarked.
 810          *
 811          * @param id
 812          *            The ID of the post to check
 813          * @return {@code true} if the post with the given ID is bookmarked,
 814          *         {@code false} otherwise
 815          */
 816         public boolean isPostBookmarked(String id) {
 817                 synchronized (bookmarkedPosts) {
 818                         return bookmarkedPosts.contains(id);
 819                 }
 820         }
 821
 822         /**
 823          * Returns all currently known bookmarked posts.
 824          *
 825          * @return All bookmarked posts
 826          */
 827         public Set<Post> getBookmarkedPosts() {
 828                 Set<Post> posts = new HashSet<Post>();
 829                 synchronized (bookmarkedPosts) {
 830                         for (String bookmarkedPostId : bookmarkedPosts) {
 831                                 Post post = getPost(bookmarkedPostId, false);
 832                                 if (post != null) {
 833                                         posts.add(post);
 834                                 }
 835                         }
 836                 }
 837                 return posts;
 838         }
 839
 840         /**
 841          * Returns the album with the given ID, creating a new album if no album
 842          * with the given ID can be found.
 843          *
 844          * @param albumId
 845          *            The ID of the album
 846          * @return The album with the given ID
 847          */
 848         public Album getAlbum(String albumId) {
 849                 return getAlbum(albumId, true);
 850         }
 851
 852         /**
 853          * Returns the album with the given ID, optionally creating a new album if
 854          * an album with the given ID can not be found.
 855          *
 856          * @param albumId
 857          *            The ID of the album
 858          * @param create
 859          *            {@code true} to create a new album if none exists for the
 860          *            given ID
 861          * @return The album with the given ID, or {@code null} if no album with the
 862          *         given ID exists and {@code create} is {@code false}
 863          */
 864         public Album getAlbum(String albumId, boolean create) {
 865                 synchronized (albums) {
 866                         Album album = albums.get(albumId);
 867                         if (create && (album == null)) {
 868                                 album = new Album(albumId);
 869                                 albums.put(albumId, album);
 870                         }
 871                         return album;
 872                 }
 873         }
 874
 875         /**
 876          * Returns the image with the given ID, creating it if necessary.
 877          *
 878          * @param imageId
 879          *            The ID of the image
 880          * @return The image with the given ID
 881          */
 882         public Image getImage(String imageId) {
 883                 return getImage(imageId, true);
 884         }
 885
 886         /**
 887          * Returns the image with the given ID, optionally creating it if it does
 888          * not exist.
 889          *
 890          * @param imageId
 891          *            The ID of the image
 892          * @param create
 893          *            {@code true} to create an image if none exists with the given
 894          *            ID
 895          * @return The image with the given ID, or {@code null} if none exists and
 896          *         none was created
 897          */
 898         public Image getImage(String imageId, boolean create) {
 899                 synchronized (images) {
 900                         Image image = images.get(imageId);
 901                         if (create && (image == null)) {
 902                                 image = new Image(imageId);
 903                                 images.put(imageId, image);
 904                         }
 905                         return image;
 906                 }
 907         }
 908
 909         /**
 910          * Returns the temporary image with the given ID.
 911          *
 912          * @param imageId
 913          *            The ID of the temporary image
 914          * @return The temporary image, or {@code null} if there is no temporary
 915          *         image with the given ID
 916          */
 917         public TemporaryImage getTemporaryImage(String imageId) {
 918                 synchronized (temporaryImages) {
 919                         return temporaryImages.get(imageId);
 920                 }
 921         }
 922
 923         //
 924         // ACTIONS
 925         //
 926
 927         /**
 928          * Locks the given Sone. A locked Sone will not be inserted by
 929          * {@link SoneInserter} until it is {@link #unlockSone(Sone) unlocked}
 930          * again.
 931          *
 932          * @param sone
 933          *            The sone to lock
 934          */
 935         public void lockSone(Sone sone) {
 936                 synchronized (lockedSones) {
 937                         if (lockedSones.add(sone)) {
 938                                 coreListenerManager.fireSoneLocked(sone);
 939                         }
 940                 }
 941         }
 942
 943         /**
 944          * Unlocks the given Sone.
 945          *
 946          * @see #lockSone(Sone)
 947          * @param sone
 948          *            The sone to unlock
 949          */
 950         public void unlockSone(Sone sone) {
 951                 synchronized (lockedSones) {
 952                         if (lockedSones.remove(sone)) {
 953                                 coreListenerManager.fireSoneUnlocked(sone);
 954                         }
 955                 }
 956         }
 957
 958         /**
 959          * Adds a local Sone from the given ID which has to be the ID of an own
 960          * identity.
 961          *
 962          * @param id
 963          *            The ID of an own identity to add a Sone for
 964          * @return The added (or already existing) Sone
 965          */
 966         public Sone addLocalSone(String id) {
 967                 synchronized (localSones) {
 968                         if (localSones.containsKey(id)) {
 969                                 logger.log(Level.FINE, "Tried to add known local Sone: %s", id);
 970                                 return localSones.get(id);
 971                         }
 972                         OwnIdentity ownIdentity = identityManager.getOwnIdentity(id);
 973                         if (ownIdentity == null) {
 974                                 logger.log(Level.INFO, "Invalid Sone ID: %s", id);
 975                                 return null;
 976                         }
 977                         return addLocalSone(ownIdentity);
 978                 }
 979         }
 980
 981         /**
 982          * Adds a local Sone from the given own identity.
 983          *
 984          * @param ownIdentity
 985          *            The own identity to create a Sone from
 986          * @return The added (or already existing) Sone
 987          */
 988         public Sone addLocalSone(OwnIdentity ownIdentity) {
 989                 if (ownIdentity == null) {
 990                         logger.log(Level.WARNING, "Given OwnIdentity is null!");
 991                         return null;
 992                 }
 993                 synchronized (localSones) {
 994                         final Sone sone;
 995                         try {
 996                                 sone = getLocalSone(ownIdentity.getId()).setIdentity(ownIdentity).setInsertUri(new FreenetURI(ownIdentity.getInsertUri())).setRequestUri(new FreenetURI(ownIdentity.getRequestUri()));
 997                         } catch (MalformedURLException mue1) {
 998                                 logger.log(Level.SEVERE, "Could not convert the Identity’s URIs to Freenet URIs: " + ownIdentity.getInsertUri() + ", " + ownIdentity.getRequestUri(), mue1);
 999                                 return null;
1000                         }
1001                         sone.setLatestEdition(Numbers.safeParseLong(ownIdentity.getProperty("Sone.LatestEdition"), (long) 0));
1002                         sone.setClient(new Client("Sone", SonePlugin.VERSION.toString()));
1003                         /* TODO - load posts ’n stuff */
1004                         localSones.put(ownIdentity.getId(), sone);
1005                         final SoneInserter soneInserter = new SoneInserter(this, freenetInterface, sone);
1006                         soneInserter.addSoneInsertListener(this);
1007                         soneInserters.put(sone, soneInserter);
1008                         setSoneStatus(sone, SoneStatus.idle);
1009                         loadSone(sone);
1010                         soneInserter.start();
1011                         return sone;
1012                 }
1013         }
1014
1015         /**
1016          * Creates a new Sone for the given own identity.
1017          *
1018          * @param ownIdentity
1019          *            The own identity to create a Sone for
1020          * @return The created Sone
1021          */
1022         public Sone createSone(OwnIdentity ownIdentity) {
1023                 try {
1024                         ownIdentity.addContext("Sone");
1025                 } catch (WebOfTrustException wote1) {
1026                         logger.log(Level.SEVERE, "Could not add “Sone” context to own identity: " + ownIdentity, wote1);
1027                         return null;
1028                 }
1029                 Sone sone = addLocalSone(ownIdentity);
1030                 sone.getOptions().addBooleanOption("AutoFollow", new DefaultOption<Boolean>(false));
1031                 sone.getOptions().addBooleanOption("EnableSoneInsertNotifications", new DefaultOption<Boolean>(false));
1032                 sone.getOptions().addBooleanOption("ShowNotification/NewSones", new DefaultOption<Boolean>(true));
1033                 sone.getOptions().addBooleanOption("ShowNotification/NewPosts", new DefaultOption<Boolean>(true));
1034                 sone.getOptions().addBooleanOption("ShowNotification/NewReplies", new DefaultOption<Boolean>(true));
1035                 followSone(sone, getSone("nwa8lHa271k2QvJ8aa0Ov7IHAV-DFOCFgmDt3X6BpCI"));
1036                 touchConfiguration();
1037                 return sone;
1038         }
1039
1040         /**
1041          * Adds the Sone of the given identity.
1042          *
1043          * @param identity
1044          *            The identity whose Sone to add
1045          * @return The added or already existing Sone
1046          */
1047         public Sone addRemoteSone(Identity identity) {
1048                 if (identity == null) {
1049                         logger.log(Level.WARNING, "Given Identity is null!");
1050                         return null;
1051                 }
1052                 synchronized (remoteSones) {
1053                         final Sone sone = getRemoteSone(identity.getId()).setIdentity(identity);
1054                         boolean newSone = sone.getRequestUri() == null;
1055                         sone.setRequestUri(getSoneUri(identity.getRequestUri()));
1056                         sone.setLatestEdition(Numbers.safeParseLong(identity.getProperty("Sone.LatestEdition"), (long) 0));
1057                         if (newSone) {
1058                                 synchronized (newSones) {
1059                                         newSone = !knownSones.contains(sone.getId());
1060                                         if (newSone) {
1061                                                 newSones.add(sone.getId());
1062                                         }
1063                                 }
1064                                 if (newSone) {
1065                                         coreListenerManager.fireNewSoneFound(sone);
1066                                         for (Sone localSone : getLocalSones()) {
1067                                                 if (localSone.getOptions().getBooleanOption("AutoFollow").get()) {
1068                                                         followSone(localSone, sone);
1069                                                 }
1070                                         }
1071                                 }
1072                         }
1073                         soneDownloader.addSone(sone);
1074                         setSoneStatus(sone, SoneStatus.unknown);
1075                         soneDownloaders.execute(new Runnable() {
1076
1077                                 @Override
1078                                 @SuppressWarnings("synthetic-access")
1079                                 public void run() {
1080                                         soneDownloader.fetchSone(sone, sone.getRequestUri());
1081                                 }
1082
1083                         });
1084                         return sone;
1085                 }
1086         }
1087
1088         /**
1089          * Lets the given local Sone follow the Sone with the given ID.
1090          *
1091          * @param sone
1092          *            The local Sone that should follow another Sone
1093          * @param soneId
1094          *            The ID of the Sone to follow
1095          */
1096         public void followSone(Sone sone, String soneId) {
1097                 Validation.begin().isNotNull("Sone", sone).isNotNull("Sone ID", soneId).check();
1098                 followSone(sone, getSone(soneId));
1099         }
1100
1101         /**
1102          * Lets the given local Sone follow the other given Sone. If the given Sone
1103          * was not followed by any local Sone before, this will mark all elements of
1104          * the followed Sone as read that have been created before the current
1105          * moment.
1106          *
1107          * @param sone
1108          *            The local Sone that should follow the other Sone
1109          * @param followedSone
1110          *            The Sone that should be followed
1111          */
1112         public void followSone(Sone sone, Sone followedSone) {
1113                 Validation.begin().isNotNull("Sone", sone).isNotNull("Followed Sone", followedSone).check();
1114                 sone.addFriend(followedSone.getId());
1115                 synchronized (soneFollowingTimes) {
1116                         if (!soneFollowingTimes.containsKey(followedSone)) {
1117                                 long now = System.currentTimeMillis();
1118                                 soneFollowingTimes.put(followedSone, now);
1119                                 for (Post post : followedSone.getPosts()) {
1120                                         if (post.getTime() < now) {
1121                                                 markPostKnown(post);
1122                                         }
1123                                 }
1124                                 for (PostReply reply : followedSone.getReplies()) {
1125                                         if (reply.getTime() < now) {
1126                                                 markReplyKnown(reply);
1127                                         }
1128                                 }
1129                         }
1130                 }
1131                 touchConfiguration();
1132         }
1133
1134         /**
1135          * Lets the given local Sone unfollow the Sone with the given ID.
1136          *
1137          * @param sone
1138          *            The local Sone that should unfollow another Sone
1139          * @param soneId
1140          *            The ID of the Sone being unfollowed
1141          */
1142         public void unfollowSone(Sone sone, String soneId) {
1143                 Validation.begin().isNotNull("Sone", sone).isNotNull("Sone ID", soneId).check();
1144                 unfollowSone(sone, getSone(soneId, false));
1145         }
1146
1147         /**
1148          * Lets the given local Sone unfollow the other given Sone. If the given
1149          * local Sone is the last local Sone that followed the given Sone, its
1150          * following time will be removed.
1151          *
1152          * @param sone
1153          *            The local Sone that should unfollow another Sone
1154          * @param unfollowedSone
1155          *            The Sone being unfollowed
1156          */
1157         public void unfollowSone(Sone sone, Sone unfollowedSone) {
1158                 Validation.begin().isNotNull("Sone", sone).isNotNull("Unfollowed Sone", unfollowedSone).check();
1159                 sone.removeFriend(unfollowedSone.getId());
1160                 boolean unfollowedSoneStillFollowed = false;
1161                 for (Sone localSone : getLocalSones()) {
1162                         unfollowedSoneStillFollowed |= localSone.hasFriend(unfollowedSone.getId());
1163                 }
1164                 if (!unfollowedSoneStillFollowed) {
1165                         synchronized (soneFollowingTimes) {
1166                                 soneFollowingTimes.remove(unfollowedSone);
1167                         }
1168                 }
1169                 touchConfiguration();
1170         }
1171
1172         /**
1173          * Retrieves the trust relationship from the origin to the target. If the
1174          * trust relationship can not be retrieved, {@code null} is returned.
1175          *
1176          * @see Identity#getTrust(OwnIdentity)
1177          * @param origin
1178          *            The origin of the trust tree
1179          * @param target
1180          *            The target of the trust
1181          * @return The trust relationship
1182          */
1183         public Trust getTrust(Sone origin, Sone target) {
1184                 if (!isLocalSone(origin)) {
1185                         logger.log(Level.WARNING, "Tried to get trust from remote Sone: %s", origin);
1186                         return null;
1187                 }
1188                 return target.getIdentity().getTrust((OwnIdentity) origin.getIdentity());
1189         }
1190
1191         /**
1192          * Sets the trust value of the given origin Sone for the target Sone.
1193          *
1194          * @param origin
1195          *            The origin Sone
1196          * @param target
1197          *            The target Sone
1198          * @param trustValue
1199          *            The trust value (from {@code -100} to {@code 100})
1200          */
1201         public void setTrust(Sone origin, Sone target, int trustValue) {
1202                 Validation.begin().isNotNull("Trust Origin", origin).check().isInstanceOf("Trust Origin", origin.getIdentity(), OwnIdentity.class).isNotNull("Trust Target", target).isLessOrEqual("Trust Value", trustValue, 100).isGreaterOrEqual("Trust Value", trustValue, -100).check();
1203                 try {
1204                         ((OwnIdentity) origin.getIdentity()).setTrust(target.getIdentity(), trustValue, preferences.getTrustComment());
1205                 } catch (WebOfTrustException wote1) {
1206                         logger.log(Level.WARNING, "Could not set trust for Sone: " + target, wote1);
1207                 }
1208         }
1209
1210         /**
1211          * Removes any trust assignment for the given target Sone.
1212          *
1213          * @param origin
1214          *            The trust origin
1215          * @param target
1216          *            The trust target
1217          */
1218         public void removeTrust(Sone origin, Sone target) {
1219                 Validation.begin().isNotNull("Trust Origin", origin).isNotNull("Trust Target", target).check().isInstanceOf("Trust Origin Identity", origin.getIdentity(), OwnIdentity.class).check();
1220                 try {
1221                         ((OwnIdentity) origin.getIdentity()).removeTrust(target.getIdentity());
1222                 } catch (WebOfTrustException wote1) {
1223                         logger.log(Level.WARNING, "Could not remove trust for Sone: " + target, wote1);
1224                 }
1225         }
1226
1227         /**
1228          * Assigns the configured positive trust value for the given target.
1229          *
1230          * @param origin
1231          *            The trust origin
1232          * @param target
1233          *            The trust target
1234          */
1235         public void trustSone(Sone origin, Sone target) {
1236                 setTrust(origin, target, preferences.getPositiveTrust());
1237         }
1238
1239         /**
1240          * Assigns the configured negative trust value for the given target.
1241          *
1242          * @param origin
1243          *            The trust origin
1244          * @param target
1245          *            The trust target
1246          */
1247         public void distrustSone(Sone origin, Sone target) {
1248                 setTrust(origin, target, preferences.getNegativeTrust());
1249         }
1250
1251         /**
1252          * Removes the trust assignment for the given target.
1253          *
1254          * @param origin
1255          *            The trust origin
1256          * @param target
1257          *            The trust target
1258          */
1259         public void untrustSone(Sone origin, Sone target) {
1260                 removeTrust(origin, target);
1261         }
1262
1263         /**
1264          * Updates the stored Sone with the given Sone.
1265          *
1266          * @param sone
1267          *            The updated Sone
1268          */
1269         public void updateSone(Sone sone) {
1270                 updateSone(sone, false);
1271         }
1272
1273         /**
1274          * Updates the stored Sone with the given Sone. If {@code soneRescueMode} is
1275          * {@code true}, an older Sone than the current Sone can be given to restore
1276          * an old state.
1277          *
1278          * @param sone
1279          *            The Sone to update
1280          * @param soneRescueMode
1281          *            {@code true} if the stored Sone should be updated regardless
1282          *            of the age of the given Sone
1283          */
1284         public void updateSone(Sone sone, boolean soneRescueMode) {
1285                 if (hasSone(sone.getId())) {
1286                         Sone storedSone = getSone(sone.getId());
1287                         if (!soneRescueMode && !(sone.getTime() > storedSone.getTime())) {
1288                                 logger.log(Level.FINE, "Downloaded Sone %s is not newer than stored Sone %s.", new Object[] { sone, storedSone });
1289                                 return;
1290                         }
1291                         synchronized (posts) {
1292                                 if (!soneRescueMode) {
1293                                         for (Post post : storedSone.getPosts()) {
1294                                                 posts.remove(post.getId());
1295                                                 if (!sone.getPosts().contains(post)) {
1296                                                         coreListenerManager.firePostRemoved(post);
1297                                                 }
1298                                         }
1299                                 }
1300                                 List<Post> storedPosts = storedSone.getPosts();
1301                                 synchronized (newPosts) {
1302                                         for (Post post : sone.getPosts()) {
1303                                                 post.setSone(storedSone);
1304                                                 if (!storedPosts.contains(post)) {
1305                                                         if (post.getTime() < getSoneFollowingTime(sone)) {
1306                                                                 knownPosts.add(post.getId());
1307                                                         } else if (!knownPosts.contains(post.getId())) {
1308                                                                 newPosts.add(post.getId());
1309                                                                 coreListenerManager.fireNewPostFound(post);
1310                                                         }
1311                                                 }
1312                                                 posts.put(post.getId(), post);
1313                                         }
1314                                 }
1315                         }
1316                         synchronized (replies) {
1317                                 if (!soneRescueMode) {
1318                                         for (PostReply reply : storedSone.getReplies()) {
1319                                                 replies.remove(reply.getId());
1320                                                 if (!sone.getReplies().contains(reply)) {
1321                                                         coreListenerManager.fireReplyRemoved(reply);
1322                                                 }
1323                                         }
1324                                 }
1325                                 Set<PostReply> storedReplies = storedSone.getReplies();
1326                                 synchronized (newReplies) {
1327                                         for (PostReply reply : sone.getReplies()) {
1328                                                 reply.setSone(storedSone);
1329                                                 if (!storedReplies.contains(reply)) {
1330                                                         if (reply.getTime() < getSoneFollowingTime(sone)) {
1331                                                                 knownReplies.add(reply.getId());
1332                                                         } else if (!knownReplies.contains(reply.getId())) {
1333                                                                 newReplies.add(reply.getId());
1334                                                                 coreListenerManager.fireNewReplyFound(reply);
1335                                                         }
1336                                                 }
1337                                                 replies.put(reply.getId(), reply);
1338                                         }
1339                                 }
1340                         }
1341                         synchronized (albums) {
1342                                 synchronized (images) {
1343                                         for (Album album : storedSone.getAlbums()) {
1344                                                 albums.remove(album.getId());
1345                                                 for (Image image : album.getImages()) {
1346                                                         images.remove(image.getId());
1347                                                 }
1348                                         }
1349                                         for (Album album : sone.getAlbums()) {
1350                                                 albums.put(album.getId(), album);
1351                                                 for (Image image : album.getImages()) {
1352                                                         images.put(image.getId(), image);
1353                                                 }
1354                                         }
1355                                 }
1356                         }
1357                         synchronized (storedSone) {
1358                                 if (!soneRescueMode || (sone.getTime() > storedSone.getTime())) {
1359                                         storedSone.setTime(sone.getTime());
1360                                 }
1361                                 storedSone.setClient(sone.getClient());
1362                                 storedSone.setProfile(sone.getProfile());
1363                                 if (soneRescueMode) {
1364                                         for (Post post : sone.getPosts()) {
1365                                                 storedSone.addPost(post);
1366                                         }
1367                                         for (PostReply reply : sone.getReplies()) {
1368                                                 storedSone.addReply(reply);
1369                                         }
1370                                         for (String likedPostId : sone.getLikedPostIds()) {
1371                                                 storedSone.addLikedPostId(likedPostId);
1372                                         }
1373                                         for (String likedReplyId : sone.getLikedReplyIds()) {
1374                                                 storedSone.addLikedReplyId(likedReplyId);
1375                                         }
1376                                         for (Album album : sone.getAlbums()) {
1377                                                 storedSone.addAlbum(album);
1378                                         }
1379                                 } else {
1380                                         storedSone.setPosts(sone.getPosts());
1381                                         storedSone.setReplies(sone.getReplies());
1382                                         storedSone.setLikePostIds(sone.getLikedPostIds());
1383                                         storedSone.setLikeReplyIds(sone.getLikedReplyIds());
1384                                         storedSone.setAlbums(sone.getAlbums());
1385                                 }
1386                                 storedSone.setLatestEdition(sone.getLatestEdition());
1387                         }
1388                 }
1389         }
1390
1391         /**
1392          * Deletes the given Sone. This will remove the Sone from the
1393          * {@link #getLocalSone(String) local Sones}, stops its {@link SoneInserter}
1394          * and remove the context from its identity.
1395          *
1396          * @param sone
1397          *            The Sone to delete
1398          */
1399         public void deleteSone(Sone sone) {
1400                 if (!(sone.getIdentity() instanceof OwnIdentity)) {
1401                         logger.log(Level.WARNING, "Tried to delete Sone of non-own identity: %s", sone);
1402                         return;
1403                 }
1404                 synchronized (localSones) {
1405                         if (!localSones.containsKey(sone.getId())) {
1406                                 logger.log(Level.WARNING, "Tried to delete non-local Sone: %s", sone);
1407                                 return;
1408                         }
1409                         localSones.remove(sone.getId());
1410                         SoneInserter soneInserter = soneInserters.remove(sone);
1411                         soneInserter.removeSoneInsertListener(this);
1412                         soneInserter.stop();
1413                 }
1414                 try {
1415                         ((OwnIdentity) sone.getIdentity()).removeContext("Sone");
1416                         ((OwnIdentity) sone.getIdentity()).removeProperty("Sone.LatestEdition");
1417                 } catch (WebOfTrustException wote1) {
1418                         logger.log(Level.WARNING, "Could not remove context and properties from Sone: " + sone, wote1);
1419                 }
1420                 try {
1421                         configuration.getLongValue("Sone/" + sone.getId() + "/Time").setValue(null);
1422                 } catch (ConfigurationException ce1) {
1423                         logger.log(Level.WARNING, "Could not remove Sone from configuration!", ce1);
1424                 }
1425         }
1426
1427         /**
1428          * Marks the given Sone as known. If the Sone was {@link #isNewPost(String)
1429          * new} before, a {@link CoreListener#markSoneKnown(Sone)} event is fired.
1430          *
1431          * @param sone
1432          *            The Sone to mark as known
1433          */
1434         public void markSoneKnown(Sone sone) {
1435                 synchronized (newSones) {
1436                         if (newSones.remove(sone.getId())) {
1437                                 knownSones.add(sone.getId());
1438                                 coreListenerManager.fireMarkSoneKnown(sone);
1439                                 touchConfiguration();
1440                         }
1441                 }
1442         }
1443
1444         /**
1445          * Loads and updates the given Sone from the configuration. If any error is
1446          * encountered, loading is aborted and the given Sone is not changed.
1447          *
1448          * @param sone
1449          *            The Sone to load and update
1450          */
1451         public void loadSone(Sone sone) {
1452                 if (!isLocalSone(sone)) {
1453                         logger.log(Level.FINE, "Tried to load non-local Sone: %s", sone);
1454                         return;
1455                 }
1456
1457                 /* initialize options. */
1458                 sone.getOptions().addBooleanOption("AutoFollow", new DefaultOption<Boolean>(false));
1459                 sone.getOptions().addBooleanOption("EnableSoneInsertNotifications", new DefaultOption<Boolean>(false));
1460                 sone.getOptions().addBooleanOption("ShowNotification/NewSones", new DefaultOption<Boolean>(true));
1461                 sone.getOptions().addBooleanOption("ShowNotification/NewPosts", new DefaultOption<Boolean>(true));
1462                 sone.getOptions().addBooleanOption("ShowNotification/NewReplies", new DefaultOption<Boolean>(true));
1463
1464                 /* load Sone. */
1465                 String sonePrefix = "Sone/" + sone.getId();
1466                 Long soneTime = configuration.getLongValue(sonePrefix + "/Time").getValue(null);
1467                 if (soneTime == null) {
1468                         logger.log(Level.INFO, "Could not load Sone because no Sone has been saved.");
1469                         return;
1470                 }
1471                 String lastInsertFingerprint = configuration.getStringValue(sonePrefix + "/LastInsertFingerprint").getValue("");
1472
1473                 /* load profile. */
1474                 Profile profile = new Profile();
1475                 profile.setFirstName(configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null));
1476                 profile.setMiddleName(configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null));
1477                 profile.setLastName(configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null));
1478                 profile.setBirthDay(configuration.getIntValue(sonePrefix + "/Profile/BirthDay").getValue(null));
1479                 profile.setBirthMonth(configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").getValue(null));
1480                 profile.setBirthYear(configuration.getIntValue(sonePrefix + "/Profile/BirthYear").getValue(null));
1481
1482                 /* load profile fields. */
1483                 while (true) {
1484                         String fieldPrefix = sonePrefix + "/Profile/Fields/" + profile.getFields().size();
1485                         String fieldName = configuration.getStringValue(fieldPrefix + "/Name").getValue(null);
1486                         if (fieldName == null) {
1487                                 break;
1488                         }
1489                         String fieldValue = configuration.getStringValue(fieldPrefix + "/Value").getValue("");
1490                         profile.addField(fieldName).setValue(fieldValue);
1491                 }
1492
1493                 /* load posts. */
1494                 Set<Post> posts = new HashSet<Post>();
1495                 while (true) {
1496                         String postPrefix = sonePrefix + "/Posts/" + posts.size();
1497                         String postId = configuration.getStringValue(postPrefix + "/ID").getValue(null);
1498                         if (postId == null) {
1499                                 break;
1500                         }
1501                         String postRecipientId = configuration.getStringValue(postPrefix + "/Recipient").getValue(null);
1502                         long postTime = configuration.getLongValue(postPrefix + "/Time").getValue((long) 0);
1503                         String postText = configuration.getStringValue(postPrefix + "/Text").getValue(null);
1504                         if ((postTime == 0) || (postText == null)) {
1505                                 logger.log(Level.WARNING, "Invalid post found, aborting load!");
1506                                 return;
1507                         }
1508                         Post post = getPost(postId).setSone(sone).setTime(postTime).setText(postText);
1509                         if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
1510                                 post.setRecipient(getSone(postRecipientId));
1511                         }
1512                         posts.add(post);
1513                 }
1514
1515                 /* load replies. */
1516                 Set<PostReply> replies = new HashSet<PostReply>();
1517                 while (true) {
1518                         String replyPrefix = sonePrefix + "/Replies/" + replies.size();
1519                         String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
1520                         if (replyId == null) {
1521                                 break;
1522                         }
1523                         String postId = configuration.getStringValue(replyPrefix + "/Post/ID").getValue(null);
1524                         long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue((long) 0);
1525                         String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
1526                         if ((postId == null) || (replyTime == 0) || (replyText == null)) {
1527                                 logger.log(Level.WARNING, "Invalid reply found, aborting load!");
1528                                 return;
1529                         }
1530                         replies.add(getReply(replyId).setSone(sone).setPost(getPost(postId)).setTime(replyTime).setText(replyText));
1531                 }
1532
1533                 /* load post likes. */
1534                 Set<String> likedPostIds = new HashSet<String>();
1535                 while (true) {
1536                         String likedPostId = configuration.getStringValue(sonePrefix + "/Likes/Post/" + likedPostIds.size() + "/ID").getValue(null);
1537                         if (likedPostId == null) {
1538                                 break;
1539                         }
1540                         likedPostIds.add(likedPostId);
1541                 }
1542
1543                 /* load reply likes. */
1544                 Set<String> likedReplyIds = new HashSet<String>();
1545                 while (true) {
1546                         String likedReplyId = configuration.getStringValue(sonePrefix + "/Likes/Reply/" + likedReplyIds.size() + "/ID").getValue(null);
1547                         if (likedReplyId == null) {
1548                                 break;
1549                         }
1550                         likedReplyIds.add(likedReplyId);
1551                 }
1552
1553                 /* load friends. */
1554                 Set<String> friends = new HashSet<String>();
1555                 while (true) {
1556                         String friendId = configuration.getStringValue(sonePrefix + "/Friends/" + friends.size() + "/ID").getValue(null);
1557                         if (friendId == null) {
1558                                 break;
1559                         }
1560                         friends.add(friendId);
1561                 }
1562
1563                 /* load albums. */
1564                 List<Album> topLevelAlbums = new ArrayList<Album>();
1565                 int albumCounter = 0;
1566                 while (true) {
1567                         String albumPrefix = sonePrefix + "/Albums/" + albumCounter++;
1568                         String albumId = configuration.getStringValue(albumPrefix + "/ID").getValue(null);
1569                         if (albumId == null) {
1570                                 break;
1571                         }
1572                         String albumTitle = configuration.getStringValue(albumPrefix + "/Title").getValue(null);
1573                         String albumDescription = configuration.getStringValue(albumPrefix + "/Description").getValue(null);
1574                         String albumParentId = configuration.getStringValue(albumPrefix + "/Parent").getValue(null);
1575                         String albumImageId = configuration.getStringValue(albumPrefix + "/AlbumImage").getValue(null);
1576                         if ((albumTitle == null) || (albumDescription == null)) {
1577                                 logger.log(Level.WARNING, "Invalid album found, aborting load!");
1578                                 return;
1579                         }
1580                         Album album = getAlbum(albumId).setSone(sone).setTitle(albumTitle).setDescription(albumDescription).setAlbumImage(albumImageId);
1581                         if (albumParentId != null) {
1582                                 Album parentAlbum = getAlbum(albumParentId, false);
1583                                 if (parentAlbum == null) {
1584                                         logger.log(Level.WARNING, "Invalid parent album ID: " + albumParentId);
1585                                         return;
1586                                 }
1587                                 parentAlbum.addAlbum(album);
1588                         } else {
1589                                 topLevelAlbums.add(album);
1590                         }
1591                 }
1592
1593                 /* load images. */
1594                 int imageCounter = 0;
1595                 while (true) {
1596                         String imagePrefix = sonePrefix + "/Images/" + imageCounter++;
1597                         String imageId = configuration.getStringValue(imagePrefix + "/ID").getValue(null);
1598                         if (imageId == null) {
1599                                 break;
1600                         }
1601                         String albumId = configuration.getStringValue(imagePrefix + "/Album").getValue(null);
1602                         String key = configuration.getStringValue(imagePrefix + "/Key").getValue(null);
1603                         String title = configuration.getStringValue(imagePrefix + "/Title").getValue(null);
1604                         String description = configuration.getStringValue(imagePrefix + "/Description").getValue(null);
1605                         Long creationTime = configuration.getLongValue(imagePrefix + "/CreationTime").getValue(null);
1606                         Integer width = configuration.getIntValue(imagePrefix + "/Width").getValue(null);
1607                         Integer height = configuration.getIntValue(imagePrefix + "/Height").getValue(null);
1608                         if ((albumId == null) || (key == null) || (title == null) || (description == null) || (creationTime == null) || (width == null) || (height == null)) {
1609                                 logger.log(Level.WARNING, "Invalid image found, aborting load!");
1610                                 return;
1611                         }
1612                         Album album = getAlbum(albumId, false);
1613                         if (album == null) {
1614                                 logger.log(Level.WARNING, "Invalid album image encountered, aborting load!");
1615                                 return;
1616                         }
1617                         Image image = getImage(imageId).setSone(sone).setCreationTime(creationTime).setKey(key);
1618                         image.setTitle(title).setDescription(description).setWidth(width).setHeight(height);
1619                         album.addImage(image);
1620                 }
1621
1622                 /* load options. */
1623                 sone.getOptions().getBooleanOption("AutoFollow").set(configuration.getBooleanValue(sonePrefix + "/Options/AutoFollow").getValue(null));
1624                 sone.getOptions().getBooleanOption("EnableSoneInsertNotifications").set(configuration.getBooleanValue(sonePrefix + "/Options/EnableSoneInsertNotifications").getValue(null));
1625                 sone.getOptions().getBooleanOption("ShowNotification/NewSones").set(configuration.getBooleanValue(sonePrefix + "/Options/ShowNotification/NewSones").getValue(null));
1626                 sone.getOptions().getBooleanOption("ShowNotification/NewPosts").set(configuration.getBooleanValue(sonePrefix + "/Options/ShowNotification/NewPosts").getValue(null));
1627                 sone.getOptions().getBooleanOption("ShowNotification/NewReplies").set(configuration.getBooleanValue(sonePrefix + "/Options/ShowNotification/NewReplies").getValue(null));
1628
1629                 /* if we’re still here, Sone was loaded successfully. */
1630                 synchronized (sone) {
1631                         sone.setTime(soneTime);
1632                         sone.setProfile(profile);
1633                         sone.setPosts(posts);
1634                         sone.setReplies(replies);
1635                         sone.setLikePostIds(likedPostIds);
1636                         sone.setLikeReplyIds(likedReplyIds);
1637                         for (String friendId : friends) {
1638                                 followSone(sone, friendId);
1639                         }
1640                         sone.setAlbums(topLevelAlbums);
1641                         soneInserters.get(sone).setLastInsertFingerprint(lastInsertFingerprint);
1642                 }
1643                 synchronized (newSones) {
1644                         for (String friend : friends) {
1645                                 knownSones.add(friend);
1646                         }
1647                 }
1648                 synchronized (newPosts) {
1649                         for (Post post : posts) {
1650                                 knownPosts.add(post.getId());
1651                         }
1652                 }
1653                 synchronized (newReplies) {
1654                         for (PostReply reply : replies) {
1655                                 knownReplies.add(reply.getId());
1656                         }
1657                 }
1658         }
1659
1660         /**
1661          * Creates a new post.
1662          *
1663          * @param sone
1664          *            The Sone that creates the post
1665          * @param text
1666          *            The text of the post
1667          * @return The created post
1668          */
1669         public Post createPost(Sone sone, String text) {
1670                 return createPost(sone, System.currentTimeMillis(), text);
1671         }
1672
1673         /**
1674          * Creates a new post.
1675          *
1676          * @param sone
1677          *            The Sone that creates the post
1678          * @param time
1679          *            The time of the post
1680          * @param text
1681          *            The text of the post
1682          * @return The created post
1683          */
1684         public Post createPost(Sone sone, long time, String text) {
1685                 return createPost(sone, null, time, text);
1686         }
1687
1688         /**
1689          * Creates a new post.
1690          *
1691          * @param sone
1692          *            The Sone that creates the post
1693          * @param recipient
1694          *            The recipient Sone, or {@code null} if this post does not have
1695          *            a recipient
1696          * @param text
1697          *            The text of the post
1698          * @return The created post
1699          */
1700         public Post createPost(Sone sone, Sone recipient, String text) {
1701                 return createPost(sone, recipient, System.currentTimeMillis(), text);
1702         }
1703
1704         /**
1705          * Creates a new post.
1706          *
1707          * @param sone
1708          *            The Sone that creates the post
1709          * @param recipient
1710          *            The recipient Sone, or {@code null} if this post does not have
1711          *            a recipient
1712          * @param time
1713          *            The time of the post
1714          * @param text
1715          *            The text of the post
1716          * @return The created post
1717          */
1718         public Post createPost(Sone sone, Sone recipient, long time, String text) {
1719                 if (!isLocalSone(sone)) {
1720                         logger.log(Level.FINE, "Tried to create post for non-local Sone: %s", sone);
1721                         return null;
1722                 }
1723                 final Post post = new Post(sone, time, text);
1724                 if (recipient != null) {
1725                         post.setRecipient(recipient);
1726                 }
1727                 synchronized (posts) {
1728                         posts.put(post.getId(), post);
1729                 }
1730                 synchronized (newPosts) {
1731                         newPosts.add(post.getId());
1732                         coreListenerManager.fireNewPostFound(post);
1733                 }
1734                 sone.addPost(post);
1735                 touchConfiguration();
1736                 localElementTicker.registerEvent(System.currentTimeMillis() + 10 * 1000, new Runnable() {
1737
1738                         /**
1739                          * {@inheritDoc}
1740                          */
1741                         @Override
1742                         public void run() {
1743                                 markPostKnown(post);
1744                         }
1745                 }, "Mark " + post + " read.");
1746                 return post;
1747         }
1748
1749         /**
1750          * Deletes the given post.
1751          *
1752          * @param post
1753          *            The post to delete
1754          */
1755         public void deletePost(Post post) {
1756                 if (!isLocalSone(post.getSone())) {
1757                         logger.log(Level.WARNING, "Tried to delete post of non-local Sone: %s", post.getSone());
1758                         return;
1759                 }
1760                 post.getSone().removePost(post);
1761                 synchronized (posts) {
1762                         posts.remove(post.getId());
1763                 }
1764                 coreListenerManager.firePostRemoved(post);
1765                 synchronized (newPosts) {
1766                         markPostKnown(post);
1767                         knownPosts.remove(post.getId());
1768                 }
1769                 touchConfiguration();
1770         }
1771
1772         /**
1773          * Marks the given post as known, if it is currently a new post (according
1774          * to {@link #isNewPost(String)}).
1775          *
1776          * @param post
1777          *            The post to mark as known
1778          */
1779         public void markPostKnown(Post post) {
1780                 synchronized (newPosts) {
1781                         if (newPosts.remove(post.getId())) {
1782                                 knownPosts.add(post.getId());
1783                                 coreListenerManager.fireMarkPostKnown(post);
1784                                 touchConfiguration();
1785                         }
1786                 }
1787         }
1788
1789         /**
1790          * Bookmarks the given post.
1791          *
1792          * @param post
1793          *            The post to bookmark
1794          */
1795         public void bookmark(Post post) {
1796                 bookmarkPost(post.getId());
1797         }
1798
1799         /**
1800          * Bookmarks the post with the given ID.
1801          *
1802          * @param id
1803          *            The ID of the post to bookmark
1804          */
1805         public void bookmarkPost(String id) {
1806                 synchronized (bookmarkedPosts) {
1807                         bookmarkedPosts.add(id);
1808                 }
1809         }
1810
1811         /**
1812          * Removes the given post from the bookmarks.
1813          *
1814          * @param post
1815          *            The post to unbookmark
1816          */
1817         public void unbookmark(Post post) {
1818                 unbookmarkPost(post.getId());
1819         }
1820
1821         /**
1822          * Removes the post with the given ID from the bookmarks.
1823          *
1824          * @param id
1825          *            The ID of the post to unbookmark
1826          */
1827         public void unbookmarkPost(String id) {
1828                 synchronized (bookmarkedPosts) {
1829                         bookmarkedPosts.remove(id);
1830                 }
1831         }
1832
1833         /**
1834          * Creates a new reply.
1835          *
1836          * @param sone
1837          *            The Sone that creates the reply
1838          * @param post
1839          *            The post that this reply refers to
1840          * @param text
1841          *            The text of the reply
1842          * @return The created reply
1843          */
1844         public PostReply createReply(Sone sone, Post post, String text) {
1845                 return createReply(sone, post, System.currentTimeMillis(), text);
1846         }
1847
1848         /**
1849          * Creates a new reply.
1850          *
1851          * @param sone
1852          *            The Sone that creates the reply
1853          * @param post
1854          *            The post that this reply refers to
1855          * @param time
1856          *            The time of the reply
1857          * @param text
1858          *            The text of the reply
1859          * @return The created reply
1860          */
1861         public PostReply createReply(Sone sone, Post post, long time, String text) {
1862                 if (!isLocalSone(sone)) {
1863                         logger.log(Level.FINE, "Tried to create reply for non-local Sone: %s", sone);
1864                         return null;
1865                 }
1866                 final PostReply reply = new PostReply(sone, post, System.currentTimeMillis(), text);
1867                 synchronized (replies) {
1868                         replies.put(reply.getId(), reply);
1869                 }
1870                 synchronized (newReplies) {
1871                         newReplies.add(reply.getId());
1872                         coreListenerManager.fireNewReplyFound(reply);
1873                 }
1874                 sone.addReply(reply);
1875                 touchConfiguration();
1876                 localElementTicker.registerEvent(System.currentTimeMillis() + 10 * 1000, new Runnable() {
1877
1878                         /**
1879                          * {@inheritDoc}
1880                          */
1881                         @Override
1882                         public void run() {
1883                                 markReplyKnown(reply);
1884                         }
1885                 }, "Mark " + reply + " read.");
1886                 return reply;
1887         }
1888
1889         /**
1890          * Deletes the given reply.
1891          *
1892          * @param reply
1893          *            The reply to delete
1894          */
1895         public void deleteReply(PostReply reply) {
1896                 Sone sone = reply.getSone();
1897                 if (!isLocalSone(sone)) {
1898                         logger.log(Level.FINE, "Tried to delete non-local reply: %s", reply);
1899                         return;
1900                 }
1901                 synchronized (replies) {
1902                         replies.remove(reply.getId());
1903                 }
1904                 synchronized (newReplies) {
1905                         markReplyKnown(reply);
1906                         knownReplies.remove(reply.getId());
1907                 }
1908                 sone.removeReply(reply);
1909                 touchConfiguration();
1910         }
1911
1912         /**
1913          * Marks the given reply as known, if it is currently a new reply (according
1914          * to {@link #isNewReply(String)}).
1915          *
1916          * @param reply
1917          *            The reply to mark as known
1918          */
1919         public void markReplyKnown(PostReply reply) {
1920                 synchronized (newReplies) {
1921                         if (newReplies.remove(reply.getId())) {
1922                                 knownReplies.add(reply.getId());
1923                                 coreListenerManager.fireMarkReplyKnown(reply);
1924                                 touchConfiguration();
1925                         }
1926                 }
1927         }
1928
1929         /**
1930          * Creates a new top-level album for the given Sone.
1931          *
1932          * @param sone
1933          *            The Sone to create the album for
1934          * @return The new album
1935          */
1936         public Album createAlbum(Sone sone) {
1937                 return createAlbum(sone, null);
1938         }
1939
1940         /**
1941          * Creates a new album for the given Sone.
1942          *
1943          * @param sone
1944          *            The Sone to create the album for
1945          * @param parent
1946          *            The parent of the album (may be {@code null} to create a
1947          *            top-level album)
1948          * @return The new album
1949          */
1950         public Album createAlbum(Sone sone, Album parent) {
1951                 Album album = new Album();
1952                 synchronized (albums) {
1953                         albums.put(album.getId(), album);
1954                 }
1955                 album.setSone(sone);
1956                 if (parent != null) {
1957                         parent.addAlbum(album);
1958                 } else {
1959                         sone.addAlbum(album);
1960                 }
1961                 return album;
1962         }
1963
1964         /**
1965          * Deletes the given album. The owner of the album has to be a local Sone,
1966          * and the album has to be {@link Album#isEmpty() empty} to be deleted.
1967          *
1968          * @param album
1969          *            The album to remove
1970          */
1971         public void deleteAlbum(Album album) {
1972                 Validation.begin().isNotNull("Album", album).check().is("Local Sone", isLocalSone(album.getSone())).check();
1973                 if (!album.isEmpty()) {
1974                         return;
1975                 }
1976                 if (album.getParent() == null) {
1977                         album.getSone().removeAlbum(album);
1978                 } else {
1979                         album.getParent().removeAlbum(album);
1980                 }
1981                 synchronized (albums) {
1982                         albums.remove(album.getId());
1983                 }
1984                 saveSone(album.getSone());
1985         }
1986
1987         /**
1988          * Creates a new image.
1989          *
1990          * @param sone
1991          *            The Sone creating the image
1992          * @param album
1993          *            The album the image will be inserted into
1994          * @param temporaryImage
1995          *            The temporary image to create the image from
1996          * @return The newly created image
1997          */
1998         public Image createImage(Sone sone, Album album, TemporaryImage temporaryImage) {
1999                 Validation.begin().isNotNull("Sone", sone).isNotNull("Album", album).isNotNull("Temporary Image", temporaryImage).check().is("Local Sone", isLocalSone(sone)).check().isEqual("Owner and Album Owner", sone, album.getSone()).check();
2000                 Image image = new Image(temporaryImage.getId()).setSone(sone).setCreationTime(System.currentTimeMillis());
2001                 album.addImage(image);
2002                 synchronized (images) {
2003                         images.put(image.getId(), image);
2004                 }
2005                 imageInserter.insertImage(temporaryImage, image);
2006                 return image;
2007         }
2008
2009         /**
2010          * Deletes the given image. This method will also delete a matching
2011          * temporary image.
2012          *
2013          * @see #deleteTemporaryImage(TemporaryImage)
2014          * @param image
2015          *            The image to delete
2016          */
2017         public void deleteImage(Image image) {
2018                 Validation.begin().isNotNull("Image", image).check().is("Local Sone", isLocalSone(image.getSone())).check();
2019                 deleteTemporaryImage(image.getId());
2020                 image.getAlbum().removeImage(image);
2021                 synchronized (images) {
2022                         images.remove(image.getId());
2023                 }
2024                 saveSone(image.getSone());
2025         }
2026
2027         /**
2028          * Creates a new temporary image.
2029          *
2030          * @param mimeType
2031          *            The MIME type of the temporary image
2032          * @param imageData
2033          *            The encoded data of the image
2034          * @return The temporary image
2035          */
2036         public TemporaryImage createTemporaryImage(String mimeType, byte[] imageData) {
2037                 TemporaryImage temporaryImage = new TemporaryImage();
2038                 temporaryImage.setMimeType(mimeType).setImageData(imageData);
2039                 synchronized (temporaryImages) {
2040                         temporaryImages.put(temporaryImage.getId(), temporaryImage);
2041                 }
2042                 return temporaryImage;
2043         }
2044
2045         /**
2046          * Deletes the given temporary image.
2047          *
2048          * @param temporaryImage
2049          *            The temporary image to delete
2050          */
2051         public void deleteTemporaryImage(TemporaryImage temporaryImage) {
2052                 Validation.begin().isNotNull("Temporary Image", temporaryImage).check();
2053                 deleteTemporaryImage(temporaryImage.getId());
2054         }
2055
2056         /**
2057          * Deletes the temporary image with the given ID.
2058          *
2059          * @param imageId
2060          *            The ID of the temporary image to delete
2061          */
2062         public void deleteTemporaryImage(String imageId) {
2063                 Validation.begin().isNotNull("Temporary Image ID", imageId).check();
2064                 synchronized (temporaryImages) {
2065                         temporaryImages.remove(imageId);
2066                 }
2067                 Image image = getImage(imageId, false);
2068                 if (image != null) {
2069                         imageInserter.cancelImageInsert(image);
2070                 }
2071         }
2072
2073         /**
2074          * Notifies the core that the configuration, either of the core or of a
2075          * single local Sone, has changed, and that the configuration should be
2076          * saved.
2077          */
2078         public void touchConfiguration() {
2079                 lastConfigurationUpdate = System.currentTimeMillis();
2080         }
2081
2082         //
2083         // SERVICE METHODS
2084         //
2085
2086         /**
2087          * Starts the core.
2088          */
2089         @Override
2090         public void serviceStart() {
2091                 loadConfiguration();
2092                 updateChecker.addUpdateListener(this);
2093                 updateChecker.start();
2094         }
2095
2096         /**
2097          * {@inheritDoc}
2098          */
2099         @Override
2100         public void serviceRun() {
2101                 long lastSaved = System.currentTimeMillis();
2102                 while (!shouldStop()) {
2103                         sleep(1000);
2104                         long now = System.currentTimeMillis();
2105                         if (shouldStop() || ((lastConfigurationUpdate > lastSaved) && ((now - lastConfigurationUpdate) > 5000))) {
2106                                 for (Sone localSone : getLocalSones()) {
2107                                         saveSone(localSone);
2108                                 }
2109                                 saveConfiguration();
2110                                 lastSaved = now;
2111                         }
2112                 }
2113         }
2114
2115         /**
2116          * Stops the core.
2117          */
2118         @Override
2119         public void serviceStop() {
2120                 synchronized (localSones) {
2121                         for (SoneInserter soneInserter : soneInserters.values()) {
2122                                 soneInserter.removeSoneInsertListener(this);
2123                                 soneInserter.stop();
2124                         }
2125                 }
2126                 updateChecker.stop();
2127                 updateChecker.removeUpdateListener(this);
2128                 soneDownloader.stop();
2129         }
2130
2131         //
2132         // PRIVATE METHODS
2133         //
2134
2135         /**
2136          * Saves the given Sone. This will persist all local settings for the given
2137          * Sone, such as the friends list and similar, private options.
2138          *
2139          * @param sone
2140          *            The Sone to save
2141          */
2142         private synchronized void saveSone(Sone sone) {
2143                 if (!isLocalSone(sone)) {
2144                         logger.log(Level.FINE, "Tried to save non-local Sone: %s", sone);
2145                         return;
2146                 }
2147                 if (!(sone.getIdentity() instanceof OwnIdentity)) {
2148                         logger.log(Level.WARNING, "Local Sone without OwnIdentity found, refusing to save: %s", sone);
2149                         return;
2150                 }
2151
2152                 logger.log(Level.INFO, "Saving Sone: %s", sone);
2153                 try {
2154                         /* save Sone into configuration. */
2155                         String sonePrefix = "Sone/" + sone.getId();
2156                         configuration.getLongValue(sonePrefix + "/Time").setValue(sone.getTime());
2157                         configuration.getStringValue(sonePrefix + "/LastInsertFingerprint").setValue(soneInserters.get(sone).getLastInsertFingerprint());
2158
2159                         /* save profile. */
2160                         Profile profile = sone.getProfile();
2161                         configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
2162                         configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
2163                         configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
2164                         configuration.getIntValue(sonePrefix + "/Profile/BirthDay").setValue(profile.getBirthDay());
2165                         configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").setValue(profile.getBirthMonth());
2166                         configuration.getIntValue(sonePrefix + "/Profile/BirthYear").setValue(profile.getBirthYear());
2167
2168                         /* save profile fields. */
2169                         int fieldCounter = 0;
2170                         for (Field profileField : profile.getFields()) {
2171                                 String fieldPrefix = sonePrefix + "/Profile/Fields/" + fieldCounter++;
2172                                 configuration.getStringValue(fieldPrefix + "/Name").setValue(profileField.getName());
2173                                 configuration.getStringValue(fieldPrefix + "/Value").setValue(profileField.getValue());
2174                         }
2175                         configuration.getStringValue(sonePrefix + "/Profile/Fields/" + fieldCounter + "/Name").setValue(null);
2176
2177                         /* save posts. */
2178                         int postCounter = 0;
2179                         for (Post post : sone.getPosts()) {
2180                                 String postPrefix = sonePrefix + "/Posts/" + postCounter++;
2181                                 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
2182                                 configuration.getStringValue(postPrefix + "/Recipient").setValue((post.getRecipient() != null) ? post.getRecipient().getId() : null);
2183                                 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
2184                                 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
2185                         }
2186                         configuration.getStringValue(sonePrefix + "/Posts/" + postCounter + "/ID").setValue(null);
2187
2188                         /* save replies. */
2189                         int replyCounter = 0;
2190                         for (PostReply reply : sone.getReplies()) {
2191                                 String replyPrefix = sonePrefix + "/Replies/" + replyCounter++;
2192                                 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
2193                                 configuration.getStringValue(replyPrefix + "/Post/ID").setValue(reply.getPost().getId());
2194                                 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
2195                                 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
2196                         }
2197                         configuration.getStringValue(sonePrefix + "/Replies/" + replyCounter + "/ID").setValue(null);
2198
2199                         /* save post likes. */
2200                         int postLikeCounter = 0;
2201                         for (String postId : sone.getLikedPostIds()) {
2202                                 configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter++ + "/ID").setValue(postId);
2203                         }
2204                         configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter + "/ID").setValue(null);
2205
2206                         /* save reply likes. */
2207                         int replyLikeCounter = 0;
2208                         for (String replyId : sone.getLikedReplyIds()) {
2209                                 configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter++ + "/ID").setValue(replyId);
2210                         }
2211                         configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter + "/ID").setValue(null);
2212
2213                         /* save friends. */
2214                         int friendCounter = 0;
2215                         for (String friendId : sone.getFriends()) {
2216                                 configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter++ + "/ID").setValue(friendId);
2217                         }
2218                         configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter + "/ID").setValue(null);
2219
2220                         /* save albums. first, collect in a flat structure, top-level first. */
2221                         List<Album> albums = sone.getAllAlbums();
2222
2223                         int albumCounter = 0;
2224                         for (Album album : albums) {
2225                                 String albumPrefix = sonePrefix + "/Albums/" + albumCounter++;
2226                                 configuration.getStringValue(albumPrefix + "/ID").setValue(album.getId());
2227                                 configuration.getStringValue(albumPrefix + "/Title").setValue(album.getTitle());
2228                                 configuration.getStringValue(albumPrefix + "/Description").setValue(album.getDescription());
2229                                 configuration.getStringValue(albumPrefix + "/Parent").setValue(album.getParent() == null ? null : album.getParent().getId());
2230                                 configuration.getStringValue(albumPrefix + "/AlbumImage").setValue(album.getAlbumImage() == null ? null : album.getAlbumImage().getId());
2231                         }
2232                         configuration.getStringValue(sonePrefix + "/Albums/" + albumCounter + "/ID").setValue(null);
2233
2234                         /* save images. */
2235                         int imageCounter = 0;
2236                         for (Album album : albums) {
2237                                 for (Image image : album.getImages()) {
2238                                         if (!image.isInserted()) {
2239                                                 continue;
2240                                         }
2241                                         String imagePrefix = sonePrefix + "/Images/" + imageCounter++;
2242                                         configuration.getStringValue(imagePrefix + "/ID").setValue(image.getId());
2243                                         configuration.getStringValue(imagePrefix + "/Album").setValue(album.getId());
2244                                         configuration.getStringValue(imagePrefix + "/Key").setValue(image.getKey());
2245                                         configuration.getStringValue(imagePrefix + "/Title").setValue(image.getTitle());
2246                                         configuration.getStringValue(imagePrefix + "/Description").setValue(image.getDescription());
2247                                         configuration.getLongValue(imagePrefix + "/CreationTime").setValue(image.getCreationTime());
2248                                         configuration.getIntValue(imagePrefix + "/Width").setValue(image.getWidth());
2249                                         configuration.getIntValue(imagePrefix + "/Height").setValue(image.getHeight());
2250                                 }
2251                         }
2252                         configuration.getStringValue(sonePrefix + "/Images/" + imageCounter + "/ID").setValue(null);
2253
2254                         /* save options. */
2255                         configuration.getBooleanValue(sonePrefix + "/Options/AutoFollow").setValue(sone.getOptions().getBooleanOption("AutoFollow").getReal());
2256                         configuration.getBooleanValue(sonePrefix + "/Options/ShowNotification/NewSones").setValue(sone.getOptions().getBooleanOption("ShowNotification/NewSones").getReal());
2257                         configuration.getBooleanValue(sonePrefix + "/Options/ShowNotification/NewPosts").setValue(sone.getOptions().getBooleanOption("ShowNotification/NewPosts").getReal());
2258                         configuration.getBooleanValue(sonePrefix + "/Options/ShowNotification/NewReplies").setValue(sone.getOptions().getBooleanOption("ShowNotification/NewReplies").getReal());
2259                         configuration.getBooleanValue(sonePrefix + "/Options/EnableSoneInsertNotifications").setValue(sone.getOptions().getBooleanOption("EnableSoneInsertNotifications").getReal());
2260
2261                         configuration.save();
2262
2263                         ((OwnIdentity) sone.getIdentity()).setProperty("Sone.LatestEdition", String.valueOf(sone.getLatestEdition()));
2264
2265                         logger.log(Level.INFO, "Sone %s saved.", sone);
2266                 } catch (ConfigurationException ce1) {
2267                         logger.log(Level.WARNING, "Could not save Sone: " + sone, ce1);
2268                 } catch (WebOfTrustException wote1) {
2269                         logger.log(Level.WARNING, "Could not set WoT property for Sone: " + sone, wote1);
2270                 }
2271         }
2272
2273         /**
2274          * Saves the current options.
2275          */
2276         private void saveConfiguration() {
2277                 synchronized (configuration) {
2278                         if (storingConfiguration) {
2279                                 logger.log(Level.FINE, "Already storing configuration…");
2280                                 return;
2281                         }
2282                         storingConfiguration = true;
2283                 }
2284
2285                 /* store the options first. */
2286                 try {
2287                         configuration.getIntValue("Option/ConfigurationVersion").setValue(0);
2288                         configuration.getIntValue("Option/InsertionDelay").setValue(options.getIntegerOption("InsertionDelay").getReal());
2289                         configuration.getIntValue("Option/PostsPerPage").setValue(options.getIntegerOption("PostsPerPage").getReal());
2290                         configuration.getIntValue("Option/CharactersPerPost").setValue(options.getIntegerOption("CharactersPerPost").getReal());
2291                         configuration.getIntValue("Option/PostCutOffLength").setValue(options.getIntegerOption("PostCutOffLength").getReal());
2292                         configuration.getBooleanValue("Option/RequireFullAccess").setValue(options.getBooleanOption("RequireFullAccess").getReal());
2293                         configuration.getIntValue("Option/PositiveTrust").setValue(options.getIntegerOption("PositiveTrust").getReal());
2294                         configuration.getIntValue("Option/NegativeTrust").setValue(options.getIntegerOption("NegativeTrust").getReal());
2295                         configuration.getStringValue("Option/TrustComment").setValue(options.getStringOption("TrustComment").getReal());
2296                         configuration.getBooleanValue("Option/ActivateFcpInterface").setValue(options.getBooleanOption("ActivateFcpInterface").getReal());
2297                         configuration.getIntValue("Option/FcpFullAccessRequired").setValue(options.getIntegerOption("FcpFullAccessRequired").getReal());
2298                         configuration.getBooleanValue("Option/SoneRescueMode").setValue(options.getBooleanOption("SoneRescueMode").getReal());
2299                         configuration.getBooleanValue("Option/ClearOnNextRestart").setValue(options.getBooleanOption("ClearOnNextRestart").getReal());
2300                         configuration.getBooleanValue("Option/ReallyClearOnNextRestart").setValue(options.getBooleanOption("ReallyClearOnNextRestart").getReal());
2301
2302                         /* save known Sones. */
2303                         int soneCounter = 0;
2304                         synchronized (newSones) {
2305                                 for (String knownSoneId : knownSones) {
2306                                         configuration.getStringValue("KnownSone/" + soneCounter++ + "/ID").setValue(knownSoneId);
2307                                 }
2308                                 configuration.getStringValue("KnownSone/" + soneCounter + "/ID").setValue(null);
2309                         }
2310
2311                         /* save Sone following times. */
2312                         soneCounter = 0;
2313                         synchronized (soneFollowingTimes) {
2314                                 for (Entry<Sone, Long> soneFollowingTime : soneFollowingTimes.entrySet()) {
2315                                         configuration.getStringValue("SoneFollowingTimes/" + soneCounter + "/Sone").setValue(soneFollowingTime.getKey().getId());
2316                                         configuration.getLongValue("SoneFollowingTimes/" + soneCounter + "/Time").setValue(soneFollowingTime.getValue());
2317                                         ++soneCounter;
2318                                 }
2319                                 configuration.getStringValue("SoneFollowingTimes/" + soneCounter + "/Sone").setValue(null);
2320                         }
2321
2322                         /* save known posts. */
2323                         int postCounter = 0;
2324                         synchronized (newPosts) {
2325                                 for (String knownPostId : knownPosts) {
2326                                         configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").setValue(knownPostId);
2327                                 }
2328                                 configuration.getStringValue("KnownPosts/" + postCounter + "/ID").setValue(null);
2329                         }
2330
2331                         /* save known replies. */
2332                         int replyCounter = 0;
2333                         synchronized (newReplies) {
2334                                 for (String knownReplyId : knownReplies) {
2335                                         configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").setValue(knownReplyId);
2336                                 }
2337                                 configuration.getStringValue("KnownReplies/" + replyCounter + "/ID").setValue(null);
2338                         }
2339
2340                         /* save bookmarked posts. */
2341                         int bookmarkedPostCounter = 0;
2342                         synchronized (bookmarkedPosts) {
2343                                 for (String bookmarkedPostId : bookmarkedPosts) {
2344                                         configuration.getStringValue("Bookmarks/Post/" + bookmarkedPostCounter++ + "/ID").setValue(bookmarkedPostId);
2345                                 }
2346                         }
2347                         configuration.getStringValue("Bookmarks/Post/" + bookmarkedPostCounter++ + "/ID").setValue(null);
2348
2349                         /* now save it. */
2350                         configuration.save();
2351
2352                 } catch (ConfigurationException ce1) {
2353                         logger.log(Level.SEVERE, "Could not store configuration!", ce1);
2354                 } finally {
2355                         synchronized (configuration) {
2356                                 storingConfiguration = false;
2357                         }
2358                 }
2359         }
2360
2361         /**
2362          * Loads the configuration.
2363          */
2364         @SuppressWarnings("unchecked")
2365         private void loadConfiguration() {
2366                 /* create options. */
2367                 options.addIntegerOption("InsertionDelay", new DefaultOption<Integer>(60, new IntegerRangeValidator(0, Integer.MAX_VALUE), new OptionWatcher<Integer>() {
2368
2369                         @Override
2370                         public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
2371                                 SoneInserter.setInsertionDelay(newValue);
2372                         }
2373
2374                 }));
2375                 options.addIntegerOption("PostsPerPage", new DefaultOption<Integer>(10, new IntegerRangeValidator(1, Integer.MAX_VALUE)));
2376                 options.addIntegerOption("CharactersPerPost", new DefaultOption<Integer>(400, new OrValidator<Integer>(new IntegerRangeValidator(50, Integer.MAX_VALUE), new EqualityValidator<Integer>(-1))));
2377                 options.addIntegerOption("PostCutOffLength", new DefaultOption<Integer>(200, new OrValidator<Integer>(new IntegerRangeValidator(50, Integer.MAX_VALUE), new EqualityValidator<Integer>(-1))));
2378                 options.addBooleanOption("RequireFullAccess", new DefaultOption<Boolean>(false));
2379                 options.addIntegerOption("PositiveTrust", new DefaultOption<Integer>(75, new IntegerRangeValidator(0, 100)));
2380                 options.addIntegerOption("NegativeTrust", new DefaultOption<Integer>(-25, new IntegerRangeValidator(-100, 100)));
2381                 options.addStringOption("TrustComment", new DefaultOption<String>("Set from Sone Web Interface"));
2382                 options.addBooleanOption("ActivateFcpInterface", new DefaultOption<Boolean>(false, new OptionWatcher<Boolean>() {
2383
2384                         @Override
2385                         @SuppressWarnings("synthetic-access")
2386                         public void optionChanged(Option<Boolean> option, Boolean oldValue, Boolean newValue) {
2387                                 fcpInterface.setActive(newValue);
2388                         }
2389                 }));
2390                 options.addIntegerOption("FcpFullAccessRequired", new DefaultOption<Integer>(2, new OptionWatcher<Integer>() {
2391
2392                         @Override
2393                         @SuppressWarnings("synthetic-access")
2394                         public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
2395                                 fcpInterface.setFullAccessRequired(FullAccessRequired.values()[newValue]);
2396                         }
2397
2398                 }));
2399                 options.addBooleanOption("SoneRescueMode", new DefaultOption<Boolean>(false));
2400                 options.addBooleanOption("ClearOnNextRestart", new DefaultOption<Boolean>(false));
2401                 options.addBooleanOption("ReallyClearOnNextRestart", new DefaultOption<Boolean>(false));
2402
2403                 /* read options from configuration. */
2404                 options.getBooleanOption("ClearOnNextRestart").set(configuration.getBooleanValue("Option/ClearOnNextRestart").getValue(null));
2405                 options.getBooleanOption("ReallyClearOnNextRestart").set(configuration.getBooleanValue("Option/ReallyClearOnNextRestart").getValue(null));
2406                 boolean clearConfiguration = options.getBooleanOption("ClearOnNextRestart").get() && options.getBooleanOption("ReallyClearOnNextRestart").get();
2407                 options.getBooleanOption("ClearOnNextRestart").set(null);
2408                 options.getBooleanOption("ReallyClearOnNextRestart").set(null);
2409                 if (clearConfiguration) {
2410                         /* stop loading the configuration. */
2411                         return;
2412                 }
2413
2414                 loadConfigurationValue("InsertionDelay");
2415                 loadConfigurationValue("PostsPerPage");
2416                 loadConfigurationValue("CharactersPerPost");
2417                 loadConfigurationValue("PostCutOffLength");
2418                 options.getBooleanOption("RequireFullAccess").set(configuration.getBooleanValue("Option/RequireFullAccess").getValue(null));
2419                 loadConfigurationValue("PositiveTrust");
2420                 loadConfigurationValue("NegativeTrust");
2421                 options.getStringOption("TrustComment").set(configuration.getStringValue("Option/TrustComment").getValue(null));
2422                 options.getBooleanOption("ActivateFcpInterface").set(configuration.getBooleanValue("Option/ActivateFcpInterface").getValue(null));
2423                 options.getIntegerOption("FcpFullAccessRequired").set(configuration.getIntValue("Option/FcpFullAccessRequired").getValue(null));
2424                 options.getBooleanOption("SoneRescueMode").set(configuration.getBooleanValue("Option/SoneRescueMode").getValue(null));
2425
2426                 /* load known Sones. */
2427                 int soneCounter = 0;
2428                 while (true) {
2429                         String knownSoneId = configuration.getStringValue("KnownSone/" + soneCounter++ + "/ID").getValue(null);
2430                         if (knownSoneId == null) {
2431                                 break;
2432                         }
2433                         synchronized (newSones) {
2434                                 knownSones.add(knownSoneId);
2435                         }
2436                 }
2437
2438                 /* load Sone following times. */
2439                 soneCounter = 0;
2440                 while (true) {
2441                         String soneId = configuration.getStringValue("SoneFollowingTimes/" + soneCounter + "/Sone").getValue(null);
2442                         if (soneId == null) {
2443                                 break;
2444                         }
2445                         long time = configuration.getLongValue("SoneFollowingTimes/" + soneCounter + "/Time").getValue(Long.MAX_VALUE);
2446                         synchronized (soneFollowingTimes) {
2447                                 soneFollowingTimes.put(getSone(soneId), time);
2448                         }
2449                         ++soneCounter;
2450                 }
2451
2452                 /* load known posts. */
2453                 int postCounter = 0;
2454                 while (true) {
2455                         String knownPostId = configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").getValue(null);
2456                         if (knownPostId == null) {
2457                                 break;
2458                         }
2459                         synchronized (newPosts) {
2460                                 knownPosts.add(knownPostId);
2461                         }
2462                 }
2463
2464                 /* load known replies. */
2465                 int replyCounter = 0;
2466                 while (true) {
2467                         String knownReplyId = configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").getValue(null);
2468                         if (knownReplyId == null) {
2469                                 break;
2470                         }
2471                         synchronized (newReplies) {
2472                                 knownReplies.add(knownReplyId);
2473                         }
2474                 }
2475
2476                 /* load bookmarked posts. */
2477                 int bookmarkedPostCounter = 0;
2478                 while (true) {
2479                         String bookmarkedPostId = configuration.getStringValue("Bookmarks/Post/" + bookmarkedPostCounter++ + "/ID").getValue(null);
2480                         if (bookmarkedPostId == null) {
2481                                 break;
2482                         }
2483                         synchronized (bookmarkedPosts) {
2484                                 bookmarkedPosts.add(bookmarkedPostId);
2485                         }
2486                 }
2487
2488         }
2489
2490         /**
2491          * Loads an {@link Integer} configuration value for the option with the
2492          * given name, logging validation failures.
2493          *
2494          * @param optionName
2495          *            The name of the option to load
2496          */
2497         private void loadConfigurationValue(String optionName) {
2498                 try {
2499                         options.getIntegerOption(optionName).set(configuration.getIntValue("Option/" + optionName).getValue(null));
2500                 } catch (IllegalArgumentException iae1) {
2501                         logger.log(Level.WARNING, "Invalid value for " + optionName + " in configuration, using default.");
2502                 }
2503         }
2504
2505         /**
2506          * Generate a Sone URI from the given URI and latest edition.
2507          *
2508          * @param uriString
2509          *            The URI to derive the Sone URI from
2510          * @return The derived URI
2511          */
2512         private FreenetURI getSoneUri(String uriString) {
2513                 try {
2514                         FreenetURI uri = new FreenetURI(uriString).setDocName("Sone").setMetaString(new String[0]);
2515                         return uri;
2516                 } catch (MalformedURLException mue1) {
2517                         logger.log(Level.WARNING, "Could not create Sone URI from URI: " + uriString, mue1);
2518                         return null;
2519                 }
2520         }
2521
2522         //
2523         // INTERFACE IdentityListener
2524         //
2525
2526         /**
2527          * {@inheritDoc}
2528          */
2529         @Override
2530         public void ownIdentityAdded(OwnIdentity ownIdentity) {
2531                 logger.log(Level.FINEST, "Adding OwnIdentity: " + ownIdentity);
2532                 if (ownIdentity.hasContext("Sone")) {
2533                         trustedIdentities.put(ownIdentity, Collections.synchronizedSet(new HashSet<Identity>()));
2534                         addLocalSone(ownIdentity);
2535                 }
2536         }
2537
2538         /**
2539          * {@inheritDoc}
2540          */
2541         @Override
2542         public void ownIdentityRemoved(OwnIdentity ownIdentity) {
2543                 logger.log(Level.FINEST, "Removing OwnIdentity: " + ownIdentity);
2544                 trustedIdentities.remove(ownIdentity);
2545         }
2546
2547         /**
2548          * {@inheritDoc}
2549          */
2550         @Override
2551         public void identityAdded(OwnIdentity ownIdentity, Identity identity) {
2552                 logger.log(Level.FINEST, "Adding Identity: " + identity);
2553                 trustedIdentities.get(ownIdentity).add(identity);
2554                 addRemoteSone(identity);
2555         }
2556
2557         /**
2558          * {@inheritDoc}
2559          */
2560         @Override
2561         public void identityUpdated(OwnIdentity ownIdentity, final Identity identity) {
2562                 new Thread(new Runnable() {
2563
2564                         @Override
2565                         @SuppressWarnings("synthetic-access")
2566                         public void run() {
2567                                 Sone sone = getRemoteSone(identity.getId());
2568                                 sone.setIdentity(identity);
2569                                 sone.setLatestEdition(Numbers.safeParseLong(identity.getProperty("Sone.LatestEdition"), sone.getLatestEdition()));
2570                                 soneDownloader.addSone(sone);
2571                                 soneDownloader.fetchSone(sone);
2572                         }
2573                 }).start();
2574         }
2575
2576         /**
2577          * {@inheritDoc}
2578          */
2579         @Override
2580         public void identityRemoved(OwnIdentity ownIdentity, Identity identity) {
2581                 trustedIdentities.get(ownIdentity).remove(identity);
2582                 boolean foundIdentity = false;
2583                 for (Entry<OwnIdentity, Set<Identity>> trustedIdentity : trustedIdentities.entrySet()) {
2584                         if (trustedIdentity.getKey().equals(ownIdentity)) {
2585                                 continue;
2586                         }
2587                         if (trustedIdentity.getValue().contains(identity)) {
2588                                 foundIdentity = true;
2589                         }
2590                 }
2591                 if (foundIdentity) {
2592                         /* some local identity still trusts this identity, don’t remove. */
2593                         return;
2594                 }
2595                 Sone sone = getSone(identity.getId(), false);
2596                 if (sone == null) {
2597                         /* TODO - we don’t have the Sone anymore. should this happen? */
2598                         return;
2599                 }
2600                 synchronized (posts) {
2601                         synchronized (newPosts) {
2602                                 for (Post post : sone.getPosts()) {
2603                                         posts.remove(post.getId());
2604                                         newPosts.remove(post.getId());
2605                                         coreListenerManager.firePostRemoved(post);
2606                                 }
2607                         }
2608                 }
2609                 synchronized (replies) {
2610                         synchronized (newReplies) {
2611                                 for (PostReply reply : sone.getReplies()) {
2612                                         replies.remove(reply.getId());
2613                                         newReplies.remove(reply.getId());
2614                                         coreListenerManager.fireReplyRemoved(reply);
2615                                 }
2616                         }
2617                 }
2618                 synchronized (remoteSones) {
2619                         remoteSones.remove(identity.getId());
2620                 }
2621                 synchronized (newSones) {
2622                         newSones.remove(identity.getId());
2623                         coreListenerManager.fireSoneRemoved(sone);
2624                 }
2625         }
2626
2627         //
2628         // INTERFACE UpdateListener
2629         //
2630
2631         /**
2632          * {@inheritDoc}
2633          */
2634         @Override
2635         public void updateFound(Version version, long releaseTime, long latestEdition) {
2636                 coreListenerManager.fireUpdateFound(version, releaseTime, latestEdition);
2637         }
2638
2639         //
2640         // INTERFACE ImageInsertListener
2641         //
2642
2643         /**
2644          * {@inheritDoc}
2645          */
2646         @Override
2647         public void insertStarted(Sone sone) {
2648                 coreListenerManager.fireSoneInserting(sone);
2649         }
2650
2651         /**
2652          * {@inheritDoc}
2653          */
2654         @Override
2655         public void insertFinished(Sone sone, long insertDuration) {
2656                 coreListenerManager.fireSoneInserted(sone, insertDuration);
2657         }
2658
2659         /**
2660          * {@inheritDoc}
2661          */
2662         @Override
2663         public void insertAborted(Sone sone, Throwable cause) {
2664                 coreListenerManager.fireSoneInsertAborted(sone, cause);
2665         }
2666
2667         //
2668         // SONEINSERTLISTENER METHODS
2669         //
2670
2671         /**
2672          * {@inheritDoc}
2673          */
2674         @Override
2675         public void imageInsertStarted(Image image) {
2676                 logger.log(Level.WARNING, "Image insert started for " + image);
2677                 coreListenerManager.fireImageInsertStarted(image);
2678         }
2679
2680         /**
2681          * {@inheritDoc}
2682          */
2683         @Override
2684         public void imageInsertAborted(Image image) {
2685                 logger.log(Level.WARNING, "Image insert aborted for " + image);
2686                 coreListenerManager.fireImageInsertAborted(image);
2687         }
2688
2689         /**
2690          * {@inheritDoc}
2691          */
2692         @Override
2693         public void imageInsertFinished(Image image, FreenetURI key) {
2694                 logger.log(Level.WARNING, "Image insert finished for " + image + ": " + key);
2695                 image.setKey(key.toString());
2696                 deleteTemporaryImage(image.getId());
2697                 saveSone(image.getSone());
2698                 coreListenerManager.fireImageInsertFinished(image);
2699         }
2700
2701         /**
2702          * {@inheritDoc}
2703          */
2704         @Override
2705         public void imageInsertFailed(Image image, Throwable cause) {
2706                 logger.log(Level.WARNING, "Image insert failed for " + image, cause);
2707                 coreListenerManager.fireImageInsertFailed(image, cause);
2708         }
2709
2710         /**
2711          * Convenience interface for external classes that want to access the core’s
2712          * configuration.
2713          *
2714          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
2715          */
2716         public static class Preferences {
2717
2718                 /** The wrapped options. */
2719                 private final Options options;
2720
2721                 /**
2722                  * Creates a new preferences object wrapped around the given options.
2723                  *
2724                  * @param options
2725                  *            The options to wrap
2726                  */
2727                 public Preferences(Options options) {
2728                         this.options = options;
2729                 }
2730
2731                 /**
2732                  * Returns the insertion delay.
2733                  *
2734                  * @return The insertion delay
2735                  */
2736                 public int getInsertionDelay() {
2737                         return options.getIntegerOption("InsertionDelay").get();
2738                 }
2739
2740                 /**
2741                  * Validates the given insertion delay.
2742                  *
2743                  * @param insertionDelay
2744                  *            The insertion delay to validate
2745                  * @return {@code true} if the given insertion delay was valid, {@code
2746                  *         false} otherwise
2747                  */
2748                 public boolean validateInsertionDelay(Integer insertionDelay) {
2749                         return options.getIntegerOption("InsertionDelay").validate(insertionDelay);
2750                 }
2751
2752                 /**
2753                  * Sets the insertion delay
2754                  *
2755                  * @param insertionDelay
2756                  *            The new insertion delay, or {@code null} to restore it to
2757                  *            the default value
2758                  * @return This preferences
2759                  */
2760                 public Preferences setInsertionDelay(Integer insertionDelay) {
2761                         options.getIntegerOption("InsertionDelay").set(insertionDelay);
2762                         return this;
2763                 }
2764
2765                 /**
2766                  * Returns the number of posts to show per page.
2767                  *
2768                  * @return The number of posts to show per page
2769                  */
2770                 public int getPostsPerPage() {
2771                         return options.getIntegerOption("PostsPerPage").get();
2772                 }
2773
2774                 /**
2775                  * Validates the number of posts per page.
2776                  *
2777                  * @param postsPerPage
2778                  *            The number of posts per page
2779                  * @return {@code true} if the number of posts per page was valid,
2780                  *         {@code false} otherwise
2781                  */
2782                 public boolean validatePostsPerPage(Integer postsPerPage) {
2783                         return options.getIntegerOption("PostsPerPage").validate(postsPerPage);
2784                 }
2785
2786                 /**
2787                  * Sets the number of posts to show per page.
2788                  *
2789                  * @param postsPerPage
2790                  *            The number of posts to show per page
2791                  * @return This preferences object
2792                  */
2793                 public Preferences setPostsPerPage(Integer postsPerPage) {
2794                         options.getIntegerOption("PostsPerPage").set(postsPerPage);
2795                         return this;
2796                 }
2797
2798                 /**
2799                  * Returns the number of characters per post, or <code>-1</code> if the
2800                  * posts should not be cut off.
2801                  *
2802                  * @return The numbers of characters per post
2803                  */
2804                 public int getCharactersPerPost() {
2805                         return options.getIntegerOption("CharactersPerPost").get();
2806                 }
2807
2808                 /**
2809                  * Validates the number of characters per post.
2810                  *
2811                  * @param charactersPerPost
2812                  *            The number of characters per post
2813                  * @return {@code true} if the number of characters per post was valid,
2814                  *         {@code false} otherwise
2815                  */
2816                 public boolean validateCharactersPerPost(Integer charactersPerPost) {
2817                         return options.getIntegerOption("CharactersPerPost").validate(charactersPerPost);
2818                 }
2819
2820                 /**
2821                  * Sets the number of characters per post.
2822                  *
2823                  * @param charactersPerPost
2824                  *            The number of characters per post, or <code>-1</code> to
2825                  *            not cut off the posts
2826                  * @return This preferences objects
2827                  */
2828                 public Preferences setCharactersPerPost(Integer charactersPerPost) {
2829                         options.getIntegerOption("CharactersPerPost").set(charactersPerPost);
2830                         return this;
2831                 }
2832
2833                 /**
2834                  * Returns the number of characters the shortened post should have.
2835                  *
2836                  * @return The number of characters of the snippet
2837                  */
2838                 public int getPostCutOffLength() {
2839                         return options.getIntegerOption("PostCutOffLength").get();
2840                 }
2841
2842                 /**
2843                  * Validates the number of characters after which to cut off the post.
2844                  *
2845                  * @param postCutOffLength
2846                  *            The number of characters of the snippet
2847                  * @return {@code true} if the number of characters of the snippet is
2848                  *         valid, {@code false} otherwise
2849                  */
2850                 public boolean validatePostCutOffLength(Integer postCutOffLength) {
2851                         return options.getIntegerOption("PostCutOffLength").validate(postCutOffLength);
2852                 }
2853
2854                 /**
2855                  * Sets the number of characters the shortened post should have.
2856                  *
2857                  * @param postCutOffLength
2858                  *            The number of characters of the snippet
2859                  * @return This preferences
2860                  */
2861                 public Preferences setPostCutOffLength(Integer postCutOffLength) {
2862                         options.getIntegerOption("PostCutOffLength").set(postCutOffLength);
2863                         return this;
2864                 }
2865
2866                 /**
2867                  * Returns whether Sone requires full access to be even visible.
2868                  *
2869                  * @return {@code true} if Sone requires full access, {@code false}
2870                  *         otherwise
2871                  */
2872                 public boolean isRequireFullAccess() {
2873                         return options.getBooleanOption("RequireFullAccess").get();
2874                 }
2875
2876                 /**
2877                  * Sets whether Sone requires full access to be even visible.
2878                  *
2879                  * @param requireFullAccess
2880                  *            {@code true} if Sone requires full access, {@code false}
2881                  *            otherwise
2882                  */
2883                 public void setRequireFullAccess(Boolean requireFullAccess) {
2884                         options.getBooleanOption("RequireFullAccess").set(requireFullAccess);
2885                 }
2886
2887                 /**
2888                  * Returns the positive trust.
2889                  *
2890                  * @return The positive trust
2891                  */
2892                 public int getPositiveTrust() {
2893                         return options.getIntegerOption("PositiveTrust").get();
2894                 }
2895
2896                 /**
2897                  * Validates the positive trust.
2898                  *
2899                  * @param positiveTrust
2900                  *            The positive trust to validate
2901                  * @return {@code true} if the positive trust was valid, {@code false}
2902                  *         otherwise
2903                  */
2904                 public boolean validatePositiveTrust(Integer positiveTrust) {
2905                         return options.getIntegerOption("PositiveTrust").validate(positiveTrust);
2906                 }
2907
2908                 /**
2909                  * Sets the positive trust.
2910                  *
2911                  * @param positiveTrust
2912                  *            The new positive trust, or {@code null} to restore it to
2913                  *            the default vlaue
2914                  * @return This preferences
2915                  */
2916                 public Preferences setPositiveTrust(Integer positiveTrust) {
2917                         options.getIntegerOption("PositiveTrust").set(positiveTrust);
2918                         return this;
2919                 }
2920
2921                 /**
2922                  * Returns the negative trust.
2923                  *
2924                  * @return The negative trust
2925                  */
2926                 public int getNegativeTrust() {
2927                         return options.getIntegerOption("NegativeTrust").get();
2928                 }
2929
2930                 /**
2931                  * Validates the negative trust.
2932                  *
2933                  * @param negativeTrust
2934                  *            The negative trust to validate
2935                  * @return {@code true} if the negative trust was valid, {@code false}
2936                  *         otherwise
2937                  */
2938                 public boolean validateNegativeTrust(Integer negativeTrust) {
2939                         return options.getIntegerOption("NegativeTrust").validate(negativeTrust);
2940                 }
2941
2942                 /**
2943                  * Sets the negative trust.
2944                  *
2945                  * @param negativeTrust
2946                  *            The negative trust, or {@code null} to restore it to the
2947                  *            default value
2948                  * @return The preferences
2949                  */
2950                 public Preferences setNegativeTrust(Integer negativeTrust) {
2951                         options.getIntegerOption("NegativeTrust").set(negativeTrust);
2952                         return this;
2953                 }
2954
2955                 /**
2956                  * Returns the trust comment. This is the comment that is set in the web
2957                  * of trust when a trust value is assigned to an identity.
2958                  *
2959                  * @return The trust comment
2960                  */
2961                 public String getTrustComment() {
2962                         return options.getStringOption("TrustComment").get();
2963                 }
2964
2965                 /**
2966                  * Sets the trust comment.
2967                  *
2968                  * @param trustComment
2969                  *            The trust comment, or {@code null} to restore it to the
2970                  *            default value
2971                  * @return This preferences
2972                  */
2973                 public Preferences setTrustComment(String trustComment) {
2974                         options.getStringOption("TrustComment").set(trustComment);
2975                         return this;
2976                 }
2977
2978                 /**
2979                  * Returns whether the {@link FcpInterface FCP interface} is currently
2980                  * active.
2981                  *
2982                  * @see FcpInterface#setActive(boolean)
2983                  * @return {@code true} if the FCP interface is currently active,
2984                  *         {@code false} otherwise
2985                  */
2986                 public boolean isFcpInterfaceActive() {
2987                         return options.getBooleanOption("ActivateFcpInterface").get();
2988                 }
2989
2990                 /**
2991                  * Sets whether the {@link FcpInterface FCP interface} is currently
2992                  * active.
2993                  *
2994                  * @see FcpInterface#setActive(boolean)
2995                  * @param fcpInterfaceActive
2996                  *            {@code true} to activate the FCP interface, {@code false}
2997                  *            to deactivate the FCP interface
2998                  * @return This preferences object
2999                  */
3000                 public Preferences setFcpInterfaceActive(boolean fcpInterfaceActive) {
3001                         options.getBooleanOption("ActivateFcpInterface").set(fcpInterfaceActive);
3002                         return this;
3003                 }
3004
3005                 /**
3006                  * Returns the action level for which full access to the FCP interface
3007                  * is required.
3008                  *
3009                  * @return The action level for which full access to the FCP interface
3010                  *         is required
3011                  */
3012                 public FullAccessRequired getFcpFullAccessRequired() {
3013                         return FullAccessRequired.values()[options.getIntegerOption("FcpFullAccessRequired").get()];
3014                 }
3015
3016                 /**
3017                  * Sets the action level for which full access to the FCP interface is
3018                  * required
3019                  *
3020                  * @param fcpFullAccessRequired
3021                  *            The action level
3022                  * @return This preferences
3023                  */
3024                 public Preferences setFcpFullAccessRequired(FullAccessRequired fcpFullAccessRequired) {
3025                         options.getIntegerOption("FcpFullAccessRequired").set((fcpFullAccessRequired != null) ? fcpFullAccessRequired.ordinal() : null);
3026                         return this;
3027                 }
3028
3029                 /**
3030                  * Returns whether Sone should clear its settings on the next restart.
3031                  * In order to be effective, {@link #isReallyClearOnNextRestart()} needs
3032                  * to return {@code true} as well!
3033                  *
3034                  * @return {@code true} if Sone should clear its settings on the next
3035                  *         restart, {@code false} otherwise
3036                  */
3037                 public boolean isClearOnNextRestart() {
3038                         return options.getBooleanOption("ClearOnNextRestart").get();
3039                 }
3040
3041                 /**
3042                  * Sets whether Sone will clear its settings on the next restart.
3043                  *
3044                  * @param clearOnNextRestart
3045                  *            {@code true} if Sone should clear its settings on the next
3046                  *            restart, {@code false} otherwise
3047                  * @return This preferences
3048                  */
3049                 public Preferences setClearOnNextRestart(Boolean clearOnNextRestart) {
3050                         options.getBooleanOption("ClearOnNextRestart").set(clearOnNextRestart);
3051                         return this;
3052                 }
3053
3054                 /**
3055                  * Returns whether Sone should really clear its settings on next
3056                  * restart. This is a confirmation option that needs to be set in
3057                  * addition to {@link #isClearOnNextRestart()} in order to clear Sone’s
3058                  * settings on the next restart.
3059                  *
3060                  * @return {@code true} if Sone should really clear its settings on the
3061                  *         next restart, {@code false} otherwise
3062                  */
3063                 public boolean isReallyClearOnNextRestart() {
3064                         return options.getBooleanOption("ReallyClearOnNextRestart").get();
3065                 }
3066
3067                 /**
3068                  * Sets whether Sone should really clear its settings on the next
3069                  * restart.
3070                  *
3071                  * @param reallyClearOnNextRestart
3072                  *            {@code true} if Sone should really clear its settings on
3073                  *            the next restart, {@code false} otherwise
3074                  * @return This preferences
3075                  */
3076                 public Preferences setReallyClearOnNextRestart(Boolean reallyClearOnNextRestart) {
3077                         options.getBooleanOption("ReallyClearOnNextRestart").set(reallyClearOnNextRestart);
3078                         return this;
3079                 }
3080
3081         }
3082
3083 }