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