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