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.logging.Level;
  29 import java.util.logging.Logger;
  30
  31 import net.pterodactylus.sone.core.Options.DefaultOption;
  32 import net.pterodactylus.sone.core.Options.Option;
  33 import net.pterodactylus.sone.core.Options.OptionWatcher;
  34 import net.pterodactylus.sone.data.Client;
  35 import net.pterodactylus.sone.data.Post;
  36 import net.pterodactylus.sone.data.Profile;
  37 import net.pterodactylus.sone.data.Profile.Field;
  38 import net.pterodactylus.sone.data.Reply;
  39 import net.pterodactylus.sone.data.Sone;
  40 import net.pterodactylus.sone.freenet.wot.Identity;
  41 import net.pterodactylus.sone.freenet.wot.IdentityListener;
  42 import net.pterodactylus.sone.freenet.wot.IdentityManager;
  43 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
  44 import net.pterodactylus.sone.freenet.wot.Trust;
  45 import net.pterodactylus.sone.freenet.wot.WebOfTrustException;
  46 import net.pterodactylus.sone.main.SonePlugin;
  47 import net.pterodactylus.util.config.Configuration;
  48 import net.pterodactylus.util.config.ConfigurationException;
  49 import net.pterodactylus.util.logging.Logging;
  50 import net.pterodactylus.util.number.Numbers;
  51 import net.pterodactylus.util.validation.Validation;
  52 import net.pterodactylus.util.version.Version;
  53 import freenet.keys.FreenetURI;
  54
  55 /**
  56  * The Sone core.
  57  *
  58  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  59  */
  60 public class Core implements IdentityListener, UpdateListener {
  61
  62         /**
  63          * Enumeration for the possible states of a {@link Sone}.
  64          *
  65          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  66          */
  67         public enum SoneStatus {
  68
  69                 /** The Sone is unknown, i.e. not yet downloaded. */
  70                 unknown,
  71
  72                 /** The Sone is idle, i.e. not being downloaded or inserted. */
  73                 idle,
  74
  75                 /** The Sone is currently being inserted. */
  76                 inserting,
  77
  78                 /** The Sone is currently being downloaded. */
  79                 downloading,
  80         }
  81
  82         /** The logger. */
  83         private static final Logger logger = Logging.getLogger(Core.class);
  84
  85         /** The options. */
  86         private final Options options = new Options();
  87
  88         /** The preferences. */
  89         private final Preferences preferences = new Preferences(options);
  90
  91         /** The core listener manager. */
  92         private final CoreListenerManager coreListenerManager = new CoreListenerManager(this);
  93
  94         /** The configuration. */
  95         private Configuration configuration;
  96
  97         /** Whether we’re currently saving the configuration. */
  98         private boolean storingConfiguration = false;
  99
 100         /** The identity manager. */
 101         private final IdentityManager identityManager;
 102
 103         /** Interface to freenet. */
 104         private final FreenetInterface freenetInterface;
 105
 106         /** The Sone downloader. */
 107         private final SoneDownloader soneDownloader;
 108
 109         /** The update checker. */
 110         private final UpdateChecker updateChecker;
 111
 112         /** Whether the core has been stopped. */
 113         private volatile boolean stopped;
 114
 115         /** The Sones’ statuses. */
 116         /* synchronize access on itself. */
 117         private final Map<Sone, SoneStatus> soneStatuses = new HashMap<Sone, SoneStatus>();
 118
 119         /** Locked local Sones. */
 120         /* synchronize on itself. */
 121         private final Set<Sone> lockedSones = new HashSet<Sone>();
 122
 123         /** Sone inserters. */
 124         /* synchronize access on this on localSones. */
 125         private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
 126
 127         /** All local Sones. */
 128         /* synchronize access on this on itself. */
 129         private Map<String, Sone> localSones = new HashMap<String, Sone>();
 130
 131         /** All remote Sones. */
 132         /* synchronize access on this on itself. */
 133         private Map<String, Sone> remoteSones = new HashMap<String, Sone>();
 134
 135         /** All new Sones. */
 136         private Set<String> newSones = new HashSet<String>();
 137
 138         /** All known Sones. */
 139         /* synchronize access on {@link #newSones}. */
 140         private Set<String> knownSones = new HashSet<String>();
 141
 142         /** All posts. */
 143         private Map<String, Post> posts = new HashMap<String, Post>();
 144
 145         /** All new posts. */
 146         private Set<String> newPosts = new HashSet<String>();
 147
 148         /** All known posts. */
 149         /* synchronize access on {@link #newPosts}. */
 150         private Set<String> knownPosts = new HashSet<String>();
 151
 152         /** All replies. */
 153         private Map<String, Reply> replies = new HashMap<String, Reply>();
 154
 155         /** All new replies. */
 156         private Set<String> newReplies = new HashSet<String>();
 157
 158         /** All known replies. */
 159         private Set<String> knownReplies = new HashSet<String>();
 160
 161         /** All bookmarked posts. */
 162         /* synchronize access on itself. */
 163         private Set<String> bookmarkedPosts = new HashSet<String>();
 164
 165         /** Trusted identities, sorted by own identities. */
 166         private Map<OwnIdentity, Set<Identity>> trustedIdentities = Collections.synchronizedMap(new HashMap<OwnIdentity, Set<Identity>>());
 167
 168         /**
 169          * Creates a new core.
 170          *
 171          * @param configuration
 172          *            The configuration of the core
 173          * @param freenetInterface
 174          *            The freenet interface
 175          * @param identityManager
 176          *            The identity manager
 177          */
 178         public Core(Configuration configuration, FreenetInterface freenetInterface, IdentityManager identityManager) {
 179                 this.configuration = configuration;
 180                 this.freenetInterface = freenetInterface;
 181                 this.identityManager = identityManager;
 182                 this.soneDownloader = new SoneDownloader(this, freenetInterface);
 183                 this.updateChecker = new UpdateChecker(freenetInterface);
 184         }
 185
 186         //
 187         // LISTENER MANAGEMENT
 188         //
 189
 190         /**
 191          * Adds a new core listener.
 192          *
 193          * @param coreListener
 194          *            The listener to add
 195          */
 196         public void addCoreListener(CoreListener coreListener) {
 197                 coreListenerManager.addListener(coreListener);
 198         }
 199
 200         /**
 201          * Removes a core listener.
 202          *
 203          * @param coreListener
 204          *            The listener to remove
 205          */
 206         public void removeCoreListener(CoreListener coreListener) {
 207                 coreListenerManager.removeListener(coreListener);
 208         }
 209
 210         //
 211         // ACCESSORS
 212         //
 213
 214         /**
 215          * Sets the configuration to use. This will automatically save the current
 216          * configuration to the given configuration.
 217          *
 218          * @param configuration
 219          *            The new configuration to use
 220          */
 221         public void setConfiguration(Configuration configuration) {
 222                 this.configuration = configuration;
 223                 saveConfiguration();
 224         }
 225
 226         /**
 227          * Returns the options used by the core.
 228          *
 229          * @return The options of the core
 230          */
 231         public Preferences getPreferences() {
 232                 return preferences;
 233         }
 234
 235         /**
 236          * Returns the identity manager used by the core.
 237          *
 238          * @return The identity manager
 239          */
 240         public IdentityManager getIdentityManager() {
 241                 return identityManager;
 242         }
 243
 244         /**
 245          * Returns the update checker.
 246          *
 247          * @return The update checker
 248          */
 249         public UpdateChecker getUpdateChecker() {
 250                 return updateChecker;
 251         }
 252
 253         /**
 254          * Returns the status of the given Sone.
 255          *
 256          * @param sone
 257          *            The Sone to get the status for
 258          * @return The status of the Sone
 259          */
 260         public SoneStatus getSoneStatus(Sone sone) {
 261                 synchronized (soneStatuses) {
 262                         return soneStatuses.get(sone);
 263                 }
 264         }
 265
 266         /**
 267          * Sets the status of the given Sone.
 268          *
 269          * @param sone
 270          *            The Sone to set the status of
 271          * @param soneStatus
 272          *            The status to set
 273          */
 274         public void setSoneStatus(Sone sone, SoneStatus soneStatus) {
 275                 synchronized (soneStatuses) {
 276                         soneStatuses.put(sone, soneStatus);
 277                 }
 278         }
 279
 280         /**
 281          * Returns whether the given Sone is currently locked.
 282          *
 283          * @param sone
 284          *            The sone to check
 285          * @return {@code true} if the Sone is locked, {@code false} if it is not
 286          */
 287         public boolean isLocked(Sone sone) {
 288                 synchronized (lockedSones) {
 289                         return lockedSones.contains(sone);
 290                 }
 291         }
 292
 293         /**
 294          * Returns all Sones, remote and local.
 295          *
 296          * @return All Sones
 297          */
 298         public Set<Sone> getSones() {
 299                 Set<Sone> allSones = new HashSet<Sone>();
 300                 allSones.addAll(getLocalSones());
 301                 allSones.addAll(getRemoteSones());
 302                 return allSones;
 303         }
 304
 305         /**
 306          * Returns the Sone with the given ID, regardless whether it’s local or
 307          * remote.
 308          *
 309          * @param id
 310          *            The ID of the Sone to get
 311          * @return The Sone with the given ID, or {@code null} if there is no such
 312          *         Sone
 313          */
 314         public Sone getSone(String id) {
 315                 return getSone(id, true);
 316         }
 317
 318         /**
 319          * Returns the Sone with the given ID, regardless whether it’s local or
 320          * remote.
 321          *
 322          * @param id
 323          *            The ID of the Sone to get
 324          * @param create
 325          *            {@code true} to create a new Sone if none exists,
 326          *            {@code false} to return {@code null} if a Sone with the given
 327          *            ID does not exist
 328          * @return The Sone with the given ID, or {@code null} if there is no such
 329          *         Sone
 330          */
 331         public Sone getSone(String id, boolean create) {
 332                 if (isLocalSone(id)) {
 333                         return getLocalSone(id);
 334                 }
 335                 return getRemoteSone(id, create);
 336         }
 337
 338         /**
 339          * Checks whether the core knows a Sone with the given ID.
 340          *
 341          * @param id
 342          *            The ID of the Sone
 343          * @return {@code true} if there is a Sone with the given ID, {@code false}
 344          *         otherwise
 345          */
 346         public boolean hasSone(String id) {
 347                 return isLocalSone(id) || isRemoteSone(id);
 348         }
 349
 350         /**
 351          * Returns whether the given Sone is a local Sone.
 352          *
 353          * @param sone
 354          *            The Sone to check for its locality
 355          * @return {@code true} if the given Sone is local, {@code false} otherwise
 356          */
 357         public boolean isLocalSone(Sone sone) {
 358                 synchronized (localSones) {
 359                         return localSones.containsKey(sone.getId());
 360                 }
 361         }
 362
 363         /**
 364          * Returns whether the given ID is the ID of a local Sone.
 365          *
 366          * @param id
 367          *            The Sone ID to check for its locality
 368          * @return {@code true} if the given ID is a local Sone, {@code false}
 369          *         otherwise
 370          */
 371         public boolean isLocalSone(String id) {
 372                 synchronized (localSones) {
 373                         return localSones.containsKey(id);
 374                 }
 375         }
 376
 377         /**
 378          * Returns all local Sones.
 379          *
 380          * @return All local Sones
 381          */
 382         public Set<Sone> getLocalSones() {
 383                 synchronized (localSones) {
 384                         return new HashSet<Sone>(localSones.values());
 385                 }
 386         }
 387
 388         /**
 389          * Returns the local Sone with the given ID.
 390          *
 391          * @param id
 392          *            The ID of the Sone to get
 393          * @return The Sone with the given ID
 394          */
 395         public Sone getLocalSone(String id) {
 396                 return getLocalSone(id, true);
 397         }
 398
 399         /**
 400          * Returns the local Sone with the given ID, optionally creating a new Sone.
 401          *
 402          * @param id
 403          *            The ID of the Sone
 404          * @param create
 405          *            {@code true} to create a new Sone if none exists,
 406          *            {@code false} to return null if none exists
 407          * @return The Sone with the given ID, or {@code null}
 408          */
 409         public Sone getLocalSone(String id, boolean create) {
 410                 synchronized (localSones) {
 411                         Sone sone = localSones.get(id);
 412                         if ((sone == null) && create) {
 413                                 sone = new Sone(id);
 414                                 localSones.put(id, sone);
 415                                 setSoneStatus(sone, SoneStatus.unknown);
 416                         }
 417                         return sone;
 418                 }
 419         }
 420
 421         /**
 422          * Returns all remote Sones.
 423          *
 424          * @return All remote Sones
 425          */
 426         public Set<Sone> getRemoteSones() {
 427                 synchronized (remoteSones) {
 428                         return new HashSet<Sone>(remoteSones.values());
 429                 }
 430         }
 431
 432         /**
 433          * Returns the remote Sone with the given ID.
 434          *
 435          * @param id
 436          *            The ID of the remote Sone to get
 437          * @return The Sone with the given ID
 438          */
 439         public Sone getRemoteSone(String id) {
 440                 return getRemoteSone(id, true);
 441         }
 442
 443         /**
 444          * Returns the remote Sone with the given ID.
 445          *
 446          * @param id
 447          *            The ID of the remote Sone to get
 448          * @param create
 449          *            {@code true} to always create a Sone, {@code false} to return
 450          *            {@code null} if no Sone with the given ID exists
 451          * @return The Sone with the given ID
 452          */
 453         public Sone getRemoteSone(String id, boolean create) {
 454                 synchronized (remoteSones) {
 455                         Sone sone = remoteSones.get(id);
 456                         if ((sone == null) && create) {
 457                                 sone = new Sone(id);
 458                                 remoteSones.put(id, sone);
 459                                 setSoneStatus(sone, SoneStatus.unknown);
 460                         }
 461                         return sone;
 462                 }
 463         }
 464
 465         /**
 466          * Returns whether the given Sone is a remote Sone.
 467          *
 468          * @param sone
 469          *            The Sone to check
 470          * @return {@code true} if the given Sone is a remote Sone, {@code false}
 471          *         otherwise
 472          */
 473         public boolean isRemoteSone(Sone sone) {
 474                 synchronized (remoteSones) {
 475                         return remoteSones.containsKey(sone.getId());
 476                 }
 477         }
 478
 479         /**
 480          * Returns whether the Sone with the given ID is a remote Sone.
 481          *
 482          * @param id
 483          *            The ID of the Sone to check
 484          * @return {@code true} if the Sone with the given ID is a remote Sone,
 485          *         {@code false} otherwise
 486          */
 487         public boolean isRemoteSone(String id) {
 488                 synchronized (remoteSones) {
 489                         return remoteSones.containsKey(id);
 490                 }
 491         }
 492
 493         /**
 494          * Returns whether the Sone with the given ID is a new Sone.
 495          *
 496          * @param soneId
 497          *            The ID of the sone to check for
 498          * @return {@code true} if the given Sone is new, false otherwise
 499          */
 500         public boolean isNewSone(String soneId) {
 501                 synchronized (newSones) {
 502                         return !knownSones.contains(soneId) && newSones.contains(soneId);
 503                 }
 504         }
 505
 506         /**
 507          * Returns whether the given Sone has been modified.
 508          *
 509          * @param sone
 510          *            The Sone to check for modifications
 511          * @return {@code true} if a modification has been detected in the Sone,
 512          *         {@code false} otherwise
 513          */
 514         public boolean isModifiedSone(Sone sone) {
 515                 return (soneInserters.containsKey(sone)) ? soneInserters.get(sone).isModified() : false;
 516         }
 517
 518         /**
 519          * Returns whether the target Sone is trusted by the origin Sone.
 520          *
 521          * @param origin
 522          *            The origin Sone
 523          * @param target
 524          *            The target Sone
 525          * @return {@code true} if the target Sone is trusted by the origin Sone
 526          */
 527         public boolean isSoneTrusted(Sone origin, Sone target) {
 528                 return trustedIdentities.containsKey(origin) && trustedIdentities.get(origin.getIdentity()).contains(target);
 529         }
 530
 531         /**
 532          * Returns the post with the given ID.
 533          *
 534          * @param postId
 535          *            The ID of the post to get
 536          * @return The post, or {@code null} if there is no such post
 537          */
 538         public Post getPost(String postId) {
 539                 return getPost(postId, true);
 540         }
 541
 542         /**
 543          * Returns the post with the given ID, optionally creating a new post.
 544          *
 545          * @param postId
 546          *            The ID of the post to get
 547          * @param create
 548          *            {@code true} it create a new post if no post with the given ID
 549          *            exists, {@code false} to return {@code null}
 550          * @return The post, or {@code null} if there is no such post
 551          */
 552         public Post getPost(String postId, boolean create) {
 553                 synchronized (posts) {
 554                         Post post = posts.get(postId);
 555                         if ((post == null) && create) {
 556                                 post = new Post(postId);
 557                                 posts.put(postId, post);
 558                         }
 559                         return post;
 560                 }
 561         }
 562
 563         /**
 564          * Returns whether the given post ID is new.
 565          *
 566          * @param postId
 567          *            The post ID
 568          * @return {@code true} if the post is considered to be new, {@code false}
 569          *         otherwise
 570          */
 571         public boolean isNewPost(String postId) {
 572                 synchronized (newPosts) {
 573                         return !knownPosts.contains(postId) && newPosts.contains(postId);
 574                 }
 575         }
 576
 577         /**
 578          * Returns the reply with the given ID. If there is no reply with the given
 579          * ID yet, a new one is created.
 580          *
 581          * @param replyId
 582          *            The ID of the reply to get
 583          * @return The reply
 584          */
 585         public Reply getReply(String replyId) {
 586                 return getReply(replyId, true);
 587         }
 588
 589         /**
 590          * Returns the reply with the given ID. If there is no reply with the given
 591          * ID yet, a new one is created, unless {@code create} is false in which
 592          * case {@code null} is returned.
 593          *
 594          * @param replyId
 595          *            The ID of the reply to get
 596          * @param create
 597          *            {@code true} to always return a {@link Reply}, {@code false}
 598          *            to return {@code null} if no reply can be found
 599          * @return The reply, or {@code null} if there is no such reply
 600          */
 601         public Reply getReply(String replyId, boolean create) {
 602                 synchronized (replies) {
 603                         Reply reply = replies.get(replyId);
 604                         if (create && (reply == null)) {
 605                                 reply = new Reply(replyId);
 606                                 replies.put(replyId, reply);
 607                         }
 608                         return reply;
 609                 }
 610         }
 611
 612         /**
 613          * Returns all replies for the given post, order ascending by time.
 614          *
 615          * @param post
 616          *            The post to get all replies for
 617          * @return All replies for the given post
 618          */
 619         public List<Reply> getReplies(Post post) {
 620                 Set<Sone> sones = getSones();
 621                 List<Reply> replies = new ArrayList<Reply>();
 622                 for (Sone sone : sones) {
 623                         for (Reply reply : sone.getReplies()) {
 624                                 if (reply.getPost().equals(post)) {
 625                                         replies.add(reply);
 626                                 }
 627                         }
 628                 }
 629                 Collections.sort(replies, Reply.TIME_COMPARATOR);
 630                 return replies;
 631         }
 632
 633         /**
 634          * Returns whether the reply with the given ID is new.
 635          *
 636          * @param replyId
 637          *            The ID of the reply to check
 638          * @return {@code true} if the reply is considered to be new, {@code false}
 639          *         otherwise
 640          */
 641         public boolean isNewReply(String replyId) {
 642                 synchronized (newReplies) {
 643                         return !knownReplies.contains(replyId) && newReplies.contains(replyId);
 644                 }
 645         }
 646
 647         /**
 648          * Returns all Sones that have liked the given post.
 649          *
 650          * @param post
 651          *            The post to get the liking Sones for
 652          * @return The Sones that like the given post
 653          */
 654         public Set<Sone> getLikes(Post post) {
 655                 Set<Sone> sones = new HashSet<Sone>();
 656                 for (Sone sone : getSones()) {
 657                         if (sone.getLikedPostIds().contains(post.getId())) {
 658                                 sones.add(sone);
 659                         }
 660                 }
 661                 return sones;
 662         }
 663
 664         /**
 665          * Returns all Sones that have liked the given reply.
 666          *
 667          * @param reply
 668          *            The reply to get the liking Sones for
 669          * @return The Sones that like the given reply
 670          */
 671         public Set<Sone> getLikes(Reply reply) {
 672                 Set<Sone> sones = new HashSet<Sone>();
 673                 for (Sone sone : getSones()) {
 674                         if (sone.getLikedReplyIds().contains(reply.getId())) {
 675                                 sones.add(sone);
 676                         }
 677                 }
 678                 return sones;
 679         }
 680
 681         /**
 682          * Returns whether the given post is bookmarked.
 683          *
 684          * @param post
 685          *            The post to check
 686          * @return {@code true} if the given post is bookmarked, {@code false}
 687          *         otherwise
 688          */
 689         public boolean isBookmarked(Post post) {
 690                 return isPostBookmarked(post.getId());
 691         }
 692
 693         /**
 694          * Returns whether the post with the given ID is bookmarked.
 695          *
 696          * @param id
 697          *            The ID of the post to check
 698          * @return {@code true} if the post with the given ID is bookmarked,
 699          *         {@code false} otherwise
 700          */
 701         public boolean isPostBookmarked(String id) {
 702                 synchronized (bookmarkedPosts) {
 703                         return bookmarkedPosts.contains(id);
 704                 }
 705         }
 706
 707         /**
 708          * Returns all currently known bookmarked posts.
 709          *
 710          * @return All bookmarked posts
 711          */
 712         public Set<Post> getBookmarkedPosts() {
 713                 Set<Post> posts = new HashSet<Post>();
 714                 synchronized (bookmarkedPosts) {
 715                         for (String bookmarkedPostId : bookmarkedPosts) {
 716                                 Post post = getPost(bookmarkedPostId, false);
 717                                 if (post != null) {
 718                                         posts.add(post);
 719                                 }
 720                         }
 721                 }
 722                 return posts;
 723         }
 724
 725         //
 726         // ACTIONS
 727         //
 728
 729         /**
 730          * Locks the given Sone. A locked Sone will not be inserted by
 731          * {@link SoneInserter} until it is {@link #unlockSone(Sone) unlocked}
 732          * again.
 733          *
 734          * @param sone
 735          *            The sone to lock
 736          */
 737         public void lockSone(Sone sone) {
 738                 synchronized (lockedSones) {
 739                         if (lockedSones.add(sone)) {
 740                                 coreListenerManager.fireSoneLocked(sone);
 741                         }
 742                 }
 743         }
 744
 745         /**
 746          * Unlocks the given Sone.
 747          *
 748          * @see #lockSone(Sone)
 749          * @param sone
 750          *            The sone to unlock
 751          */
 752         public void unlockSone(Sone sone) {
 753                 synchronized (lockedSones) {
 754                         if (lockedSones.remove(sone)) {
 755                                 coreListenerManager.fireSoneUnlocked(sone);
 756                         }
 757                 }
 758         }
 759
 760         /**
 761          * Adds a local Sone from the given ID which has to be the ID of an own
 762          * identity.
 763          *
 764          * @param id
 765          *            The ID of an own identity to add a Sone for
 766          * @return The added (or already existing) Sone
 767          */
 768         public Sone addLocalSone(String id) {
 769                 synchronized (localSones) {
 770                         if (localSones.containsKey(id)) {
 771                                 logger.log(Level.FINE, "Tried to add known local Sone: %s", id);
 772                                 return localSones.get(id);
 773                         }
 774                         OwnIdentity ownIdentity = identityManager.getOwnIdentity(id);
 775                         if (ownIdentity == null) {
 776                                 logger.log(Level.INFO, "Invalid Sone ID: %s", id);
 777                                 return null;
 778                         }
 779                         return addLocalSone(ownIdentity);
 780                 }
 781         }
 782
 783         /**
 784          * Adds a local Sone from the given own identity.
 785          *
 786          * @param ownIdentity
 787          *            The own identity to create a Sone from
 788          * @return The added (or already existing) Sone
 789          */
 790         public Sone addLocalSone(OwnIdentity ownIdentity) {
 791                 if (ownIdentity == null) {
 792                         logger.log(Level.WARNING, "Given OwnIdentity is null!");
 793                         return null;
 794                 }
 795                 synchronized (localSones) {
 796                         final Sone sone;
 797                         try {
 798                                 sone = getLocalSone(ownIdentity.getId()).setIdentity(ownIdentity).setInsertUri(new FreenetURI(ownIdentity.getInsertUri())).setRequestUri(new FreenetURI(ownIdentity.getRequestUri()));
 799                         } catch (MalformedURLException mue1) {
 800                                 logger.log(Level.SEVERE, "Could not convert the Identity’s URIs to Freenet URIs: " + ownIdentity.getInsertUri() + ", " + ownIdentity.getRequestUri(), mue1);
 801                                 return null;
 802                         }
 803                         sone.setLatestEdition(Numbers.safeParseLong(ownIdentity.getProperty("Sone.LatestEdition"), (long) 0));
 804                         sone.setClient(new Client("Sone", SonePlugin.VERSION.toString()));
 805                         /* TODO - load posts ’n stuff */
 806                         localSones.put(ownIdentity.getId(), sone);
 807                         final SoneInserter soneInserter = new SoneInserter(this, freenetInterface, sone);
 808                         soneInserters.put(sone, soneInserter);
 809                         setSoneStatus(sone, SoneStatus.idle);
 810                         loadSone(sone);
 811                         if (!preferences.isSoneRescueMode()) {
 812                                 soneInserter.start();
 813                         }
 814                         new Thread(new Runnable() {
 815
 816                                 @Override
 817                                 @SuppressWarnings("synthetic-access")
 818                                 public void run() {
 819                                         if (!preferences.isSoneRescueMode()) {
 820                                                 return;
 821                                         }
 822                                         logger.log(Level.INFO, "Trying to restore Sone from Freenet…");
 823                                         coreListenerManager.fireRescuingSone(sone);
 824                                         lockSone(sone);
 825                                         long edition = sone.getLatestEdition();
 826                                         while (!stopped && (edition >= 0) && preferences.isSoneRescueMode()) {
 827                                                 logger.log(Level.FINE, "Downloading edition " + edition + "…");
 828                                                 soneDownloader.fetchSone(sone, sone.getRequestUri().setKeyType("SSK").setDocName("Sone-" + edition));
 829                                                 --edition;
 830                                         }
 831                                         logger.log(Level.INFO, "Finished restoring Sone from Freenet, starting Inserter…");
 832                                         saveSone(sone);
 833                                         coreListenerManager.fireRescuedSone(sone);
 834                                         soneInserter.start();
 835                                 }
 836
 837                         }, "Sone Downloader").start();
 838                         return sone;
 839                 }
 840         }
 841
 842         /**
 843          * Creates a new Sone for the given own identity.
 844          *
 845          * @param ownIdentity
 846          *            The own identity to create a Sone for
 847          * @return The created Sone
 848          */
 849         public Sone createSone(OwnIdentity ownIdentity) {
 850                 try {
 851                         ownIdentity.addContext("Sone");
 852                 } catch (WebOfTrustException wote1) {
 853                         logger.log(Level.SEVERE, "Could not add “Sone” context to own identity: " + ownIdentity, wote1);
 854                         return null;
 855                 }
 856                 Sone sone = addLocalSone(ownIdentity);
 857                 return sone;
 858         }
 859
 860         /**
 861          * Adds the Sone of the given identity.
 862          *
 863          * @param identity
 864          *            The identity whose Sone to add
 865          * @return The added or already existing Sone
 866          */
 867         public Sone addRemoteSone(Identity identity) {
 868                 if (identity == null) {
 869                         logger.log(Level.WARNING, "Given Identity is null!");
 870                         return null;
 871                 }
 872                 synchronized (remoteSones) {
 873                         final Sone sone = getRemoteSone(identity.getId()).setIdentity(identity);
 874                         boolean newSone = sone.getRequestUri() == null;
 875                         sone.setRequestUri(getSoneUri(identity.getRequestUri()));
 876                         sone.setLatestEdition(Numbers.safeParseLong(identity.getProperty("Sone.LatestEdition"), (long) 0));
 877                         if (newSone) {
 878                                 synchronized (newSones) {
 879                                         newSone = !knownSones.contains(sone.getId());
 880                                         if (newSone) {
 881                                                 newSones.add(sone.getId());
 882                                         }
 883                                 }
 884                                 if (newSone) {
 885                                         coreListenerManager.fireNewSoneFound(sone);
 886                                 }
 887                         }
 888                         remoteSones.put(identity.getId(), sone);
 889                         soneDownloader.addSone(sone);
 890                         setSoneStatus(sone, SoneStatus.unknown);
 891                         new Thread(new Runnable() {
 892
 893                                 @Override
 894                                 @SuppressWarnings("synthetic-access")
 895                                 public void run() {
 896                                         soneDownloader.fetchSone(sone);
 897                                 }
 898
 899                         }, "Sone Downloader").start();
 900                         return sone;
 901                 }
 902         }
 903
 904         /**
 905          * Retrieves the trust relationship from the origin to the target. If the
 906          * trust relationship can not be retrieved, {@code null} is returned.
 907          *
 908          * @see Identity#getTrust(OwnIdentity)
 909          * @param origin
 910          *            The origin of the trust tree
 911          * @param target
 912          *            The target of the trust
 913          * @return The trust relationship
 914          */
 915         public Trust getTrust(Sone origin, Sone target) {
 916                 if (!isLocalSone(origin)) {
 917                         logger.log(Level.WARNING, "Tried to get trust from remote Sone: %s", origin);
 918                         return null;
 919                 }
 920                 return target.getIdentity().getTrust((OwnIdentity) origin.getIdentity());
 921         }
 922
 923         /**
 924          * Sets the trust value of the given origin Sone for the target Sone.
 925          *
 926          * @param origin
 927          *            The origin Sone
 928          * @param target
 929          *            The target Sone
 930          * @param trustValue
 931          *            The trust value (from {@code -100} to {@code 100})
 932          */
 933         public void setTrust(Sone origin, Sone target, int trustValue) {
 934                 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();
 935                 try {
 936                         ((OwnIdentity) origin.getIdentity()).setTrust(target.getIdentity(), trustValue, preferences.getTrustComment());
 937                 } catch (WebOfTrustException wote1) {
 938                         logger.log(Level.WARNING, "Could not set trust for Sone: " + target, wote1);
 939                 }
 940         }
 941
 942         /**
 943          * Removes any trust assignment for the given target Sone.
 944          *
 945          * @param origin
 946          *            The trust origin
 947          * @param target
 948          *            The trust target
 949          */
 950         public void removeTrust(Sone origin, Sone target) {
 951                 Validation.begin().isNotNull("Trust Origin", origin).isNotNull("Trust Target", target).check().isInstanceOf("Trust Origin Identity", origin.getIdentity(), OwnIdentity.class).check();
 952                 try {
 953                         ((OwnIdentity) origin.getIdentity()).removeTrust(target.getIdentity());
 954                 } catch (WebOfTrustException wote1) {
 955                         logger.log(Level.WARNING, "Could not remove trust for Sone: " + target, wote1);
 956                 }
 957         }
 958
 959         /**
 960          * Assigns the configured positive trust value for the given target.
 961          *
 962          * @param origin
 963          *            The trust origin
 964          * @param target
 965          *            The trust target
 966          */
 967         public void trustSone(Sone origin, Sone target) {
 968                 setTrust(origin, target, preferences.getPositiveTrust());
 969         }
 970
 971         /**
 972          * Assigns the configured negative trust value for the given target.
 973          *
 974          * @param origin
 975          *            The trust origin
 976          * @param target
 977          *            The trust target
 978          */
 979         public void distrustSone(Sone origin, Sone target) {
 980                 setTrust(origin, target, preferences.getNegativeTrust());
 981         }
 982
 983         /**
 984          * Removes the trust assignment for the given target.
 985          *
 986          * @param origin
 987          *            The trust origin
 988          * @param target
 989          *            The trust target
 990          */
 991         public void untrustSone(Sone origin, Sone target) {
 992                 removeTrust(origin, target);
 993         }
 994
 995         /**
 996          * Updates the stores Sone with the given Sone.
 997          *
 998          * @param sone
 999          *            The updated Sone
1000          */
1001         public void updateSone(Sone sone) {
1002                 if (hasSone(sone.getId())) {
1003                         boolean soneRescueMode = isLocalSone(sone) && preferences.isSoneRescueMode();
1004                         Sone storedSone = getSone(sone.getId());
1005                         if (!soneRescueMode && !(sone.getTime() > storedSone.getTime())) {
1006                                 logger.log(Level.FINE, "Downloaded Sone %s is not newer than stored Sone %s.", new Object[] { sone, storedSone });
1007                                 return;
1008                         }
1009                         synchronized (posts) {
1010                                 if (!soneRescueMode) {
1011                                         for (Post post : storedSone.getPosts()) {
1012                                                 posts.remove(post.getId());
1013                                                 if (!sone.getPosts().contains(post)) {
1014                                                         coreListenerManager.firePostRemoved(post);
1015                                                 }
1016                                         }
1017                                 }
1018                                 List<Post> storedPosts = storedSone.getPosts();
1019                                 synchronized (newPosts) {
1020                                         for (Post post : sone.getPosts()) {
1021                                                 post.setSone(storedSone);
1022                                                 if (!storedPosts.contains(post) && !knownPosts.contains(post.getId())) {
1023                                                         newPosts.add(post.getId());
1024                                                         coreListenerManager.fireNewPostFound(post);
1025                                                 }
1026                                                 posts.put(post.getId(), post);
1027                                         }
1028                                 }
1029                         }
1030                         synchronized (replies) {
1031                                 if (!soneRescueMode) {
1032                                         for (Reply reply : storedSone.getReplies()) {
1033                                                 replies.remove(reply.getId());
1034                                                 if (!sone.getReplies().contains(reply)) {
1035                                                         coreListenerManager.fireReplyRemoved(reply);
1036                                                 }
1037                                         }
1038                                 }
1039                                 Set<Reply> storedReplies = storedSone.getReplies();
1040                                 synchronized (newReplies) {
1041                                         for (Reply reply : sone.getReplies()) {
1042                                                 reply.setSone(storedSone);
1043                                                 if (!storedReplies.contains(reply) && !knownReplies.contains(reply.getId())) {
1044                                                         newReplies.add(reply.getId());
1045                                                         coreListenerManager.fireNewReplyFound(reply);
1046                                                 }
1047                                                 replies.put(reply.getId(), reply);
1048                                         }
1049                                 }
1050                         }
1051                         synchronized (storedSone) {
1052                                 if (!soneRescueMode || (sone.getTime() > storedSone.getTime())) {
1053                                         storedSone.setTime(sone.getTime());
1054                                 }
1055                                 storedSone.setClient(sone.getClient());
1056                                 storedSone.setProfile(sone.getProfile());
1057                                 if (soneRescueMode) {
1058                                         for (Post post : sone.getPosts()) {
1059                                                 storedSone.addPost(post);
1060                                         }
1061                                         for (Reply reply : sone.getReplies()) {
1062                                                 storedSone.addReply(reply);
1063                                         }
1064                                         for (String likedPostId : sone.getLikedPostIds()) {
1065                                                 storedSone.addLikedPostId(likedPostId);
1066                                         }
1067                                         for (String likedReplyId : sone.getLikedReplyIds()) {
1068                                                 storedSone.addLikedReplyId(likedReplyId);
1069                                         }
1070                                 } else {
1071                                         storedSone.setPosts(sone.getPosts());
1072                                         storedSone.setReplies(sone.getReplies());
1073                                         storedSone.setLikePostIds(sone.getLikedPostIds());
1074                                         storedSone.setLikeReplyIds(sone.getLikedReplyIds());
1075                                 }
1076                                 storedSone.setLatestEdition(sone.getLatestEdition());
1077                         }
1078                 }
1079         }
1080
1081         /**
1082          * Deletes the given Sone. This will remove the Sone from the
1083          * {@link #getLocalSone(String) local Sones}, stops its {@link SoneInserter}
1084          * and remove the context from its identity.
1085          *
1086          * @param sone
1087          *            The Sone to delete
1088          */
1089         public void deleteSone(Sone sone) {
1090                 if (!(sone.getIdentity() instanceof OwnIdentity)) {
1091                         logger.log(Level.WARNING, "Tried to delete Sone of non-own identity: %s", sone);
1092                         return;
1093                 }
1094                 synchronized (localSones) {
1095                         if (!localSones.containsKey(sone.getId())) {
1096                                 logger.log(Level.WARNING, "Tried to delete non-local Sone: %s", sone);
1097                                 return;
1098                         }
1099                         localSones.remove(sone.getId());
1100                         soneInserters.remove(sone).stop();
1101                 }
1102                 try {
1103                         ((OwnIdentity) sone.getIdentity()).removeContext("Sone");
1104                         ((OwnIdentity) sone.getIdentity()).removeProperty("Sone.LatestEdition");
1105                 } catch (WebOfTrustException wote1) {
1106                         logger.log(Level.WARNING, "Could not remove context and properties from Sone: " + sone, wote1);
1107                 }
1108                 try {
1109                         configuration.getLongValue("Sone/" + sone.getId() + "/Time").setValue(null);
1110                 } catch (ConfigurationException ce1) {
1111                         logger.log(Level.WARNING, "Could not remove Sone from configuration!", ce1);
1112                 }
1113         }
1114
1115         /**
1116          * Marks the given Sone as known. If the Sone was {@link #isNewPost(String)
1117          * new} before, a {@link CoreListener#markSoneKnown(Sone)} event is fired.
1118          *
1119          * @param sone
1120          *            The Sone to mark as known
1121          */
1122         public void markSoneKnown(Sone sone) {
1123                 synchronized (newSones) {
1124                         if (newSones.remove(sone.getId())) {
1125                                 knownSones.add(sone.getId());
1126                                 coreListenerManager.fireMarkSoneKnown(sone);
1127                                 saveConfiguration();
1128                         }
1129                 }
1130         }
1131
1132         /**
1133          * Loads and updates the given Sone from the configuration. If any error is
1134          * encountered, loading is aborted and the given Sone is not changed.
1135          *
1136          * @param sone
1137          *            The Sone to load and update
1138          */
1139         public void loadSone(Sone sone) {
1140                 if (!isLocalSone(sone)) {
1141                         logger.log(Level.FINE, "Tried to load non-local Sone: %s", sone);
1142                         return;
1143                 }
1144
1145                 /* load Sone. */
1146                 String sonePrefix = "Sone/" + sone.getId();
1147                 Long soneTime = configuration.getLongValue(sonePrefix + "/Time").getValue(null);
1148                 if (soneTime == null) {
1149                         logger.log(Level.INFO, "Could not load Sone because no Sone has been saved.");
1150                         return;
1151                 }
1152                 String lastInsertFingerprint = configuration.getStringValue(sonePrefix + "/LastInsertFingerprint").getValue("");
1153
1154                 /* load profile. */
1155                 Profile profile = new Profile();
1156                 profile.setFirstName(configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null));
1157                 profile.setMiddleName(configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null));
1158                 profile.setLastName(configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null));
1159                 profile.setBirthDay(configuration.getIntValue(sonePrefix + "/Profile/BirthDay").getValue(null));
1160                 profile.setBirthMonth(configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").getValue(null));
1161                 profile.setBirthYear(configuration.getIntValue(sonePrefix + "/Profile/BirthYear").getValue(null));
1162
1163                 /* load profile fields. */
1164                 while (true) {
1165                         String fieldPrefix = sonePrefix + "/Profile/Fields/" + profile.getFields().size();
1166                         String fieldName = configuration.getStringValue(fieldPrefix + "/Name").getValue(null);
1167                         if (fieldName == null) {
1168                                 break;
1169                         }
1170                         String fieldValue = configuration.getStringValue(fieldPrefix + "/Value").getValue("");
1171                         profile.addField(fieldName).setValue(fieldValue);
1172                 }
1173
1174                 /* load posts. */
1175                 Set<Post> posts = new HashSet<Post>();
1176                 while (true) {
1177                         String postPrefix = sonePrefix + "/Posts/" + posts.size();
1178                         String postId = configuration.getStringValue(postPrefix + "/ID").getValue(null);
1179                         if (postId == null) {
1180                                 break;
1181                         }
1182                         String postRecipientId = configuration.getStringValue(postPrefix + "/Recipient").getValue(null);
1183                         long postTime = configuration.getLongValue(postPrefix + "/Time").getValue((long) 0);
1184                         String postText = configuration.getStringValue(postPrefix + "/Text").getValue(null);
1185                         if ((postTime == 0) || (postText == null)) {
1186                                 logger.log(Level.WARNING, "Invalid post found, aborting load!");
1187                                 return;
1188                         }
1189                         Post post = getPost(postId).setSone(sone).setTime(postTime).setText(postText);
1190                         if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
1191                                 post.setRecipient(getSone(postRecipientId));
1192                         }
1193                         posts.add(post);
1194                 }
1195
1196                 /* load replies. */
1197                 Set<Reply> replies = new HashSet<Reply>();
1198                 while (true) {
1199                         String replyPrefix = sonePrefix + "/Replies/" + replies.size();
1200                         String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
1201                         if (replyId == null) {
1202                                 break;
1203                         }
1204                         String postId = configuration.getStringValue(replyPrefix + "/Post/ID").getValue(null);
1205                         long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue((long) 0);
1206                         String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
1207                         if ((postId == null) || (replyTime == 0) || (replyText == null)) {
1208                                 logger.log(Level.WARNING, "Invalid reply found, aborting load!");
1209                                 return;
1210                         }
1211                         replies.add(getReply(replyId).setSone(sone).setPost(getPost(postId)).setTime(replyTime).setText(replyText));
1212                 }
1213
1214                 /* load post likes. */
1215                 Set<String> likedPostIds = new HashSet<String>();
1216                 while (true) {
1217                         String likedPostId = configuration.getStringValue(sonePrefix + "/Likes/Post/" + likedPostIds.size() + "/ID").getValue(null);
1218                         if (likedPostId == null) {
1219                                 break;
1220                         }
1221                         likedPostIds.add(likedPostId);
1222                 }
1223
1224                 /* load reply likes. */
1225                 Set<String> likedReplyIds = new HashSet<String>();
1226                 while (true) {
1227                         String likedReplyId = configuration.getStringValue(sonePrefix + "/Likes/Reply/" + likedReplyIds.size() + "/ID").getValue(null);
1228                         if (likedReplyId == null) {
1229                                 break;
1230                         }
1231                         likedReplyIds.add(likedReplyId);
1232                 }
1233
1234                 /* load friends. */
1235                 Set<String> friends = new HashSet<String>();
1236                 while (true) {
1237                         String friendId = configuration.getStringValue(sonePrefix + "/Friends/" + friends.size() + "/ID").getValue(null);
1238                         if (friendId == null) {
1239                                 break;
1240                         }
1241                         friends.add(friendId);
1242                 }
1243
1244                 /* if we’re still here, Sone was loaded successfully. */
1245                 synchronized (sone) {
1246                         sone.setTime(soneTime);
1247                         sone.setProfile(profile);
1248                         sone.setPosts(posts);
1249                         sone.setReplies(replies);
1250                         sone.setLikePostIds(likedPostIds);
1251                         sone.setLikeReplyIds(likedReplyIds);
1252                         sone.setFriends(friends);
1253                         soneInserters.get(sone).setLastInsertFingerprint(lastInsertFingerprint);
1254                 }
1255                 synchronized (newSones) {
1256                         for (String friend : friends) {
1257                                 knownSones.add(friend);
1258                         }
1259                 }
1260                 synchronized (newPosts) {
1261                         for (Post post : posts) {
1262                                 knownPosts.add(post.getId());
1263                         }
1264                 }
1265                 synchronized (newReplies) {
1266                         for (Reply reply : replies) {
1267                                 knownReplies.add(reply.getId());
1268                         }
1269                 }
1270         }
1271
1272         /**
1273          * Saves the given Sone. This will persist all local settings for the given
1274          * Sone, such as the friends list and similar, private options.
1275          *
1276          * @param sone
1277          *            The Sone to save
1278          */
1279         public synchronized void saveSone(Sone sone) {
1280                 if (!isLocalSone(sone)) {
1281                         logger.log(Level.FINE, "Tried to save non-local Sone: %s", sone);
1282                         return;
1283                 }
1284                 if (!(sone.getIdentity() instanceof OwnIdentity)) {
1285                         logger.log(Level.WARNING, "Local Sone without OwnIdentity found, refusing to save: %s", sone);
1286                         return;
1287                 }
1288
1289                 logger.log(Level.INFO, "Saving Sone: %s", sone);
1290                 try {
1291                         ((OwnIdentity) sone.getIdentity()).setProperty("Sone.LatestEdition", String.valueOf(sone.getLatestEdition()));
1292
1293                         /* save Sone into configuration. */
1294                         String sonePrefix = "Sone/" + sone.getId();
1295                         configuration.getLongValue(sonePrefix + "/Time").setValue(sone.getTime());
1296                         configuration.getStringValue(sonePrefix + "/LastInsertFingerprint").setValue(soneInserters.get(sone).getLastInsertFingerprint());
1297
1298                         /* save profile. */
1299                         Profile profile = sone.getProfile();
1300                         configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
1301                         configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
1302                         configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
1303                         configuration.getIntValue(sonePrefix + "/Profile/BirthDay").setValue(profile.getBirthDay());
1304                         configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").setValue(profile.getBirthMonth());
1305                         configuration.getIntValue(sonePrefix + "/Profile/BirthYear").setValue(profile.getBirthYear());
1306
1307                         /* save profile fields. */
1308                         int fieldCounter = 0;
1309                         for (Field profileField : profile.getFields()) {
1310                                 String fieldPrefix = sonePrefix + "/Profile/Fields/" + fieldCounter++;
1311                                 configuration.getStringValue(fieldPrefix + "/Name").setValue(profileField.getName());
1312                                 configuration.getStringValue(fieldPrefix + "/Value").setValue(profileField.getValue());
1313                         }
1314                         configuration.getStringValue(sonePrefix + "/Profile/Fields/" + fieldCounter + "/Name").setValue(null);
1315
1316                         /* save posts. */
1317                         int postCounter = 0;
1318                         for (Post post : sone.getPosts()) {
1319                                 String postPrefix = sonePrefix + "/Posts/" + postCounter++;
1320                                 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
1321                                 configuration.getStringValue(postPrefix + "/Recipient").setValue((post.getRecipient() != null) ? post.getRecipient().getId() : null);
1322                                 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
1323                                 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
1324                         }
1325                         configuration.getStringValue(sonePrefix + "/Posts/" + postCounter + "/ID").setValue(null);
1326
1327                         /* save replies. */
1328                         int replyCounter = 0;
1329                         for (Reply reply : sone.getReplies()) {
1330                                 String replyPrefix = sonePrefix + "/Replies/" + replyCounter++;
1331                                 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
1332                                 configuration.getStringValue(replyPrefix + "/Post/ID").setValue(reply.getPost().getId());
1333                                 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
1334                                 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
1335                         }
1336                         configuration.getStringValue(sonePrefix + "/Replies/" + replyCounter + "/ID").setValue(null);
1337
1338                         /* save post likes. */
1339                         int postLikeCounter = 0;
1340                         for (String postId : sone.getLikedPostIds()) {
1341                                 configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter++ + "/ID").setValue(postId);
1342                         }
1343                         configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter + "/ID").setValue(null);
1344
1345                         /* save reply likes. */
1346                         int replyLikeCounter = 0;
1347                         for (String replyId : sone.getLikedReplyIds()) {
1348                                 configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter++ + "/ID").setValue(replyId);
1349                         }
1350                         configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter + "/ID").setValue(null);
1351
1352                         /* save friends. */
1353                         int friendCounter = 0;
1354                         for (String friendId : sone.getFriends()) {
1355                                 configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter++ + "/ID").setValue(friendId);
1356                         }
1357                         configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter + "/ID").setValue(null);
1358
1359                         configuration.save();
1360                         logger.log(Level.INFO, "Sone %s saved.", sone);
1361                 } catch (ConfigurationException ce1) {
1362                         logger.log(Level.WARNING, "Could not save Sone: " + sone, ce1);
1363                 } catch (WebOfTrustException wote1) {
1364                         logger.log(Level.WARNING, "Could not set WoT property for Sone: " + sone, wote1);
1365                 }
1366         }
1367
1368         /**
1369          * Creates a new post.
1370          *
1371          * @param sone
1372          *            The Sone that creates the post
1373          * @param text
1374          *            The text of the post
1375          * @return The created post
1376          */
1377         public Post createPost(Sone sone, String text) {
1378                 return createPost(sone, System.currentTimeMillis(), text);
1379         }
1380
1381         /**
1382          * Creates a new post.
1383          *
1384          * @param sone
1385          *            The Sone that creates the post
1386          * @param time
1387          *            The time of the post
1388          * @param text
1389          *            The text of the post
1390          * @return The created post
1391          */
1392         public Post createPost(Sone sone, long time, String text) {
1393                 return createPost(sone, null, time, text);
1394         }
1395
1396         /**
1397          * Creates a new post.
1398          *
1399          * @param sone
1400          *            The Sone that creates the post
1401          * @param recipient
1402          *            The recipient Sone, or {@code null} if this post does not have
1403          *            a recipient
1404          * @param text
1405          *            The text of the post
1406          * @return The created post
1407          */
1408         public Post createPost(Sone sone, Sone recipient, String text) {
1409                 return createPost(sone, recipient, System.currentTimeMillis(), text);
1410         }
1411
1412         /**
1413          * Creates a new post.
1414          *
1415          * @param sone
1416          *            The Sone that creates the post
1417          * @param recipient
1418          *            The recipient Sone, or {@code null} if this post does not have
1419          *            a recipient
1420          * @param time
1421          *            The time of the post
1422          * @param text
1423          *            The text of the post
1424          * @return The created post
1425          */
1426         public Post createPost(Sone sone, Sone recipient, long time, String text) {
1427                 if (!isLocalSone(sone)) {
1428                         logger.log(Level.FINE, "Tried to create post for non-local Sone: %s", sone);
1429                         return null;
1430                 }
1431                 Post post = new Post(sone, time, text);
1432                 if (recipient != null) {
1433                         post.setRecipient(recipient);
1434                 }
1435                 synchronized (posts) {
1436                         posts.put(post.getId(), post);
1437                 }
1438                 synchronized (newPosts) {
1439                         knownPosts.add(post.getId());
1440                 }
1441                 sone.addPost(post);
1442                 saveSone(sone);
1443                 return post;
1444         }
1445
1446         /**
1447          * Deletes the given post.
1448          *
1449          * @param post
1450          *            The post to delete
1451          */
1452         public void deletePost(Post post) {
1453                 if (!isLocalSone(post.getSone())) {
1454                         logger.log(Level.WARNING, "Tried to delete post of non-local Sone: %s", post.getSone());
1455                         return;
1456                 }
1457                 post.getSone().removePost(post);
1458                 synchronized (posts) {
1459                         posts.remove(post.getId());
1460                 }
1461                 saveSone(post.getSone());
1462         }
1463
1464         /**
1465          * Marks the given post as known, if it is currently a new post (according
1466          * to {@link #isNewPost(String)}).
1467          *
1468          * @param post
1469          *            The post to mark as known
1470          */
1471         public void markPostKnown(Post post) {
1472                 synchronized (newPosts) {
1473                         if (newPosts.remove(post.getId())) {
1474                                 knownPosts.add(post.getId());
1475                                 coreListenerManager.fireMarkPostKnown(post);
1476                                 saveConfiguration();
1477                         }
1478                 }
1479         }
1480
1481         /**
1482          * Bookmarks the given post.
1483          *
1484          * @param post
1485          *            The post to bookmark
1486          */
1487         public void bookmark(Post post) {
1488                 bookmarkPost(post.getId());
1489         }
1490
1491         /**
1492          * Bookmarks the post with the given ID.
1493          *
1494          * @param id
1495          *            The ID of the post to bookmark
1496          */
1497         public void bookmarkPost(String id) {
1498                 synchronized (bookmarkedPosts) {
1499                         bookmarkedPosts.add(id);
1500                 }
1501         }
1502
1503         /**
1504          * Removes the given post from the bookmarks.
1505          *
1506          * @param post
1507          *            The post to unbookmark
1508          */
1509         public void unbookmark(Post post) {
1510                 unbookmarkPost(post.getId());
1511         }
1512
1513         /**
1514          * Removes the post with the given ID from the bookmarks.
1515          *
1516          * @param id
1517          *            The ID of the post to unbookmark
1518          */
1519         public void unbookmarkPost(String id) {
1520                 synchronized (bookmarkedPosts) {
1521                         bookmarkedPosts.remove(id);
1522                 }
1523         }
1524
1525         /**
1526          * Creates a new reply.
1527          *
1528          * @param sone
1529          *            The Sone that creates the reply
1530          * @param post
1531          *            The post that this reply refers to
1532          * @param text
1533          *            The text of the reply
1534          * @return The created reply
1535          */
1536         public Reply createReply(Sone sone, Post post, String text) {
1537                 return createReply(sone, post, System.currentTimeMillis(), text);
1538         }
1539
1540         /**
1541          * Creates a new reply.
1542          *
1543          * @param sone
1544          *            The Sone that creates the reply
1545          * @param post
1546          *            The post that this reply refers to
1547          * @param time
1548          *            The time of the reply
1549          * @param text
1550          *            The text of the reply
1551          * @return The created reply
1552          */
1553         public Reply createReply(Sone sone, Post post, long time, String text) {
1554                 if (!isLocalSone(sone)) {
1555                         logger.log(Level.FINE, "Tried to create reply for non-local Sone: %s", sone);
1556                         return null;
1557                 }
1558                 Reply reply = new Reply(sone, post, System.currentTimeMillis(), text);
1559                 synchronized (replies) {
1560                         replies.put(reply.getId(), reply);
1561                 }
1562                 synchronized (newReplies) {
1563                         knownReplies.add(reply.getId());
1564                 }
1565                 sone.addReply(reply);
1566                 saveSone(sone);
1567                 return reply;
1568         }
1569
1570         /**
1571          * Deletes the given reply.
1572          *
1573          * @param reply
1574          *            The reply to delete
1575          */
1576         public void deleteReply(Reply reply) {
1577                 Sone sone = reply.getSone();
1578                 if (!isLocalSone(sone)) {
1579                         logger.log(Level.FINE, "Tried to delete non-local reply: %s", reply);
1580                         return;
1581                 }
1582                 synchronized (replies) {
1583                         replies.remove(reply.getId());
1584                 }
1585                 sone.removeReply(reply);
1586                 saveSone(sone);
1587         }
1588
1589         /**
1590          * Marks the given reply as known, if it is currently a new reply (according
1591          * to {@link #isNewReply(String)}).
1592          *
1593          * @param reply
1594          *            The reply to mark as known
1595          */
1596         public void markReplyKnown(Reply reply) {
1597                 synchronized (newReplies) {
1598                         if (newReplies.remove(reply.getId())) {
1599                                 knownReplies.add(reply.getId());
1600                                 coreListenerManager.fireMarkReplyKnown(reply);
1601                                 saveConfiguration();
1602                         }
1603                 }
1604         }
1605
1606         /**
1607          * Starts the core.
1608          */
1609         public void start() {
1610                 loadConfiguration();
1611                 updateChecker.addUpdateListener(this);
1612                 updateChecker.start();
1613         }
1614
1615         /**
1616          * Stops the core.
1617          */
1618         public void stop() {
1619                 synchronized (localSones) {
1620                         for (SoneInserter soneInserter : soneInserters.values()) {
1621                                 soneInserter.stop();
1622                         }
1623                 }
1624                 updateChecker.stop();
1625                 updateChecker.removeUpdateListener(this);
1626                 soneDownloader.stop();
1627                 saveConfiguration();
1628                 stopped = true;
1629         }
1630
1631         /**
1632          * Saves the current options.
1633          */
1634         public void saveConfiguration() {
1635                 synchronized (configuration) {
1636                         if (storingConfiguration) {
1637                                 logger.log(Level.FINE, "Already storing configuration…");
1638                                 return;
1639                         }
1640                         storingConfiguration = true;
1641                 }
1642
1643                 /* store the options first. */
1644                 try {
1645                         configuration.getIntValue("Option/ConfigurationVersion").setValue(0);
1646                         configuration.getIntValue("Option/InsertionDelay").setValue(options.getIntegerOption("InsertionDelay").getReal());
1647                         configuration.getIntValue("Option/PositiveTrust").setValue(options.getIntegerOption("PositiveTrust").getReal());
1648                         configuration.getIntValue("Option/NegativeTrust").setValue(options.getIntegerOption("NegativeTrust").getReal());
1649                         configuration.getStringValue("Option/TrustComment").setValue(options.getStringOption("TrustComment").getReal());
1650                         configuration.getBooleanValue("Option/SoneRescueMode").setValue(options.getBooleanOption("SoneRescueMode").getReal());
1651                         configuration.getBooleanValue("Option/ClearOnNextRestart").setValue(options.getBooleanOption("ClearOnNextRestart").getReal());
1652                         configuration.getBooleanValue("Option/ReallyClearOnNextRestart").setValue(options.getBooleanOption("ReallyClearOnNextRestart").getReal());
1653
1654                         /* save known Sones. */
1655                         int soneCounter = 0;
1656                         synchronized (newSones) {
1657                                 for (String knownSoneId : knownSones) {
1658                                         configuration.getStringValue("KnownSone/" + soneCounter++ + "/ID").setValue(knownSoneId);
1659                                 }
1660                                 configuration.getStringValue("KnownSone/" + soneCounter + "/ID").setValue(null);
1661                         }
1662
1663                         /* save known posts. */
1664                         int postCounter = 0;
1665                         synchronized (newPosts) {
1666                                 for (String knownPostId : knownPosts) {
1667                                         configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").setValue(knownPostId);
1668                                 }
1669                                 configuration.getStringValue("KnownPosts/" + postCounter + "/ID").setValue(null);
1670                         }
1671
1672                         /* save known replies. */
1673                         int replyCounter = 0;
1674                         synchronized (newReplies) {
1675                                 for (String knownReplyId : knownReplies) {
1676                                         configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").setValue(knownReplyId);
1677                                 }
1678                                 configuration.getStringValue("KnownReplies/" + replyCounter + "/ID").setValue(null);
1679                         }
1680
1681                         /* save bookmarked posts. */
1682                         int bookmarkedPostCounter = 0;
1683                         synchronized (bookmarkedPosts) {
1684                                 for (String bookmarkedPostId : bookmarkedPosts) {
1685                                         configuration.getStringValue("Bookmarks/Post/" + bookmarkedPostCounter++ + "/ID").setValue(bookmarkedPostId);
1686                                 }
1687                         }
1688                         configuration.getStringValue("Bookmarks/Post/" + bookmarkedPostCounter++ + "/ID").setValue(null);
1689
1690                         /* now save it. */
1691                         configuration.save();
1692
1693                 } catch (ConfigurationException ce1) {
1694                         logger.log(Level.SEVERE, "Could not store configuration!", ce1);
1695                 } finally {
1696                         synchronized (configuration) {
1697                                 storingConfiguration = false;
1698                         }
1699                 }
1700         }
1701
1702         //
1703         // PRIVATE METHODS
1704         //
1705
1706         /**
1707          * Loads the configuration.
1708          */
1709         @SuppressWarnings("unchecked")
1710         private void loadConfiguration() {
1711                 /* create options. */
1712                 options.addIntegerOption("InsertionDelay", new DefaultOption<Integer>(60, new OptionWatcher<Integer>() {
1713
1714                         @Override
1715                         public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
1716                                 SoneInserter.setInsertionDelay(newValue);
1717                         }
1718
1719                 }));
1720                 options.addIntegerOption("PositiveTrust", new DefaultOption<Integer>(75));
1721                 options.addIntegerOption("NegativeTrust", new DefaultOption<Integer>(-100));
1722                 options.addStringOption("TrustComment", new DefaultOption<String>("Set from Sone Web Interface"));
1723                 options.addBooleanOption("SoneRescueMode", new DefaultOption<Boolean>(false));
1724                 options.addBooleanOption("ClearOnNextRestart", new DefaultOption<Boolean>(false));
1725                 options.addBooleanOption("ReallyClearOnNextRestart", new DefaultOption<Boolean>(false));
1726
1727                 /* read options from configuration. */
1728                 options.getBooleanOption("ClearOnNextRestart").set(configuration.getBooleanValue("Option/ClearOnNextRestart").getValue(null));
1729                 options.getBooleanOption("ReallyClearOnNextRestart").set(configuration.getBooleanValue("Option/ReallyClearOnNextRestart").getValue(null));
1730                 boolean clearConfiguration = options.getBooleanOption("ClearOnNextRestart").get() && options.getBooleanOption("ReallyClearOnNextRestart").get();
1731                 options.getBooleanOption("ClearOnNextRestart").set(null);
1732                 options.getBooleanOption("ReallyClearOnNextRestart").set(null);
1733                 if (clearConfiguration) {
1734                         /* stop loading the configuration. */
1735                         return;
1736                 }
1737
1738                 options.getIntegerOption("InsertionDelay").set(configuration.getIntValue("Option/InsertionDelay").getValue(null));
1739                 options.getIntegerOption("PositiveTrust").set(configuration.getIntValue("Option/PositiveTrust").getValue(null));
1740                 options.getIntegerOption("NegativeTrust").set(configuration.getIntValue("Option/NegativeTrust").getValue(null));
1741                 options.getStringOption("TrustComment").set(configuration.getStringValue("Option/TrustComment").getValue(null));
1742                 options.getBooleanOption("SoneRescueMode").set(configuration.getBooleanValue("Option/SoneRescueMode").getValue(null));
1743
1744                 /* load known Sones. */
1745                 int soneCounter = 0;
1746                 while (true) {
1747                         String knownSoneId = configuration.getStringValue("KnownSone/" + soneCounter++ + "/ID").getValue(null);
1748                         if (knownSoneId == null) {
1749                                 break;
1750                         }
1751                         synchronized (newSones) {
1752                                 knownSones.add(knownSoneId);
1753                         }
1754                 }
1755
1756                 /* load known posts. */
1757                 int postCounter = 0;
1758                 while (true) {
1759                         String knownPostId = configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").getValue(null);
1760                         if (knownPostId == null) {
1761                                 break;
1762                         }
1763                         synchronized (newPosts) {
1764                                 knownPosts.add(knownPostId);
1765                         }
1766                 }
1767
1768                 /* load known replies. */
1769                 int replyCounter = 0;
1770                 while (true) {
1771                         String knownReplyId = configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").getValue(null);
1772                         if (knownReplyId == null) {
1773                                 break;
1774                         }
1775                         synchronized (newReplies) {
1776                                 knownReplies.add(knownReplyId);
1777                         }
1778                 }
1779
1780                 /* load bookmarked posts. */
1781                 int bookmarkedPostCounter = 0;
1782                 while (true) {
1783                         String bookmarkedPostId = configuration.getStringValue("Bookmarks/Post/" + bookmarkedPostCounter++ + "/ID").getValue(null);
1784                         if (bookmarkedPostId == null) {
1785                                 break;
1786                         }
1787                         synchronized (bookmarkedPosts) {
1788                                 bookmarkedPosts.add(bookmarkedPostId);
1789                         }
1790                 }
1791
1792         }
1793
1794         /**
1795          * Generate a Sone URI from the given URI and latest edition.
1796          *
1797          * @param uriString
1798          *            The URI to derive the Sone URI from
1799          * @return The derived URI
1800          */
1801         private FreenetURI getSoneUri(String uriString) {
1802                 try {
1803                         FreenetURI uri = new FreenetURI(uriString).setDocName("Sone").setMetaString(new String[0]);
1804                         return uri;
1805                 } catch (MalformedURLException mue1) {
1806                         logger.log(Level.WARNING, "Could not create Sone URI from URI: " + uriString, mue1);
1807                         return null;
1808                 }
1809         }
1810
1811         //
1812         // INTERFACE IdentityListener
1813         //
1814
1815         /**
1816          * {@inheritDoc}
1817          */
1818         @Override
1819         public void ownIdentityAdded(OwnIdentity ownIdentity) {
1820                 logger.log(Level.FINEST, "Adding OwnIdentity: " + ownIdentity);
1821                 if (ownIdentity.hasContext("Sone")) {
1822                         trustedIdentities.put(ownIdentity, Collections.synchronizedSet(new HashSet<Identity>()));
1823                         addLocalSone(ownIdentity);
1824                 }
1825         }
1826
1827         /**
1828          * {@inheritDoc}
1829          */
1830         @Override
1831         public void ownIdentityRemoved(OwnIdentity ownIdentity) {
1832                 logger.log(Level.FINEST, "Removing OwnIdentity: " + ownIdentity);
1833                 trustedIdentities.remove(ownIdentity);
1834         }
1835
1836         /**
1837          * {@inheritDoc}
1838          */
1839         @Override
1840         public void identityAdded(OwnIdentity ownIdentity, Identity identity) {
1841                 logger.log(Level.FINEST, "Adding Identity: " + identity);
1842                 trustedIdentities.get(ownIdentity).add(identity);
1843                 addRemoteSone(identity);
1844         }
1845
1846         /**
1847          * {@inheritDoc}
1848          */
1849         @Override
1850         public void identityUpdated(OwnIdentity ownIdentity, final Identity identity) {
1851                 new Thread(new Runnable() {
1852
1853                         @Override
1854                         @SuppressWarnings("synthetic-access")
1855                         public void run() {
1856                                 Sone sone = getRemoteSone(identity.getId());
1857                                 sone.setIdentity(identity);
1858                                 soneDownloader.addSone(sone);
1859                                 soneDownloader.fetchSone(sone);
1860                         }
1861                 }).start();
1862         }
1863
1864         /**
1865          * {@inheritDoc}
1866          */
1867         @Override
1868         public void identityRemoved(OwnIdentity ownIdentity, Identity identity) {
1869                 trustedIdentities.get(ownIdentity).remove(identity);
1870         }
1871
1872         //
1873         // INTERFACE UpdateListener
1874         //
1875
1876         /**
1877          * {@inheritDoc}
1878          */
1879         @Override
1880         public void updateFound(Version version, long releaseTime, long latestEdition) {
1881                 coreListenerManager.fireUpdateFound(version, releaseTime, latestEdition);
1882         }
1883
1884         /**
1885          * Convenience interface for external classes that want to access the core’s
1886          * configuration.
1887          *
1888          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1889          */
1890         public static class Preferences {
1891
1892                 /** The wrapped options. */
1893                 private final Options options;
1894
1895                 /**
1896                  * Creates a new preferences object wrapped around the given options.
1897                  *
1898                  * @param options
1899                  *            The options to wrap
1900                  */
1901                 public Preferences(Options options) {
1902                         this.options = options;
1903                 }
1904
1905                 /**
1906                  * Returns the insertion delay.
1907                  *
1908                  * @return The insertion delay
1909                  */
1910                 public int getInsertionDelay() {
1911                         return options.getIntegerOption("InsertionDelay").get();
1912                 }
1913
1914                 /**
1915                  * Sets the insertion delay
1916                  *
1917                  * @param insertionDelay
1918                  *            The new insertion delay, or {@code null} to restore it to
1919                  *            the default value
1920                  * @return This preferences
1921                  */
1922                 public Preferences setInsertionDelay(Integer insertionDelay) {
1923                         options.getIntegerOption("InsertionDelay").set(insertionDelay);
1924                         return this;
1925                 }
1926
1927                 /**
1928                  * Returns the positive trust.
1929                  *
1930                  * @return The positive trust
1931                  */
1932                 public int getPositiveTrust() {
1933                         return options.getIntegerOption("PositiveTrust").get();
1934                 }
1935
1936                 /**
1937                  * Sets the positive trust.
1938                  *
1939                  * @param positiveTrust
1940                  *            The new positive trust, or {@code null} to restore it to
1941                  *            the default vlaue
1942                  * @return This preferences
1943                  */
1944                 public Preferences setPositiveTrust(Integer positiveTrust) {
1945                         options.getIntegerOption("PositiveTrust").set(positiveTrust);
1946                         return this;
1947                 }
1948
1949                 /**
1950                  * Returns the negative trust.
1951                  *
1952                  * @return The negative trust
1953                  */
1954                 public int getNegativeTrust() {
1955                         return options.getIntegerOption("NegativeTrust").get();
1956                 }
1957
1958                 /**
1959                  * Sets the negative trust.
1960                  *
1961                  * @param negativeTrust
1962                  *            The negative trust, or {@code null} to restore it to the
1963                  *            default value
1964                  * @return The preferences
1965                  */
1966                 public Preferences setNegativeTrust(Integer negativeTrust) {
1967                         options.getIntegerOption("NegativeTrust").set(negativeTrust);
1968                         return this;
1969                 }
1970
1971                 /**
1972                  * Returns the trust comment. This is the comment that is set in the web
1973                  * of trust when a trust value is assigned to an identity.
1974                  *
1975                  * @return The trust comment
1976                  */
1977                 public String getTrustComment() {
1978                         return options.getStringOption("TrustComment").get();
1979                 }
1980
1981                 /**
1982                  * Sets the trust comment.
1983                  *
1984                  * @param trustComment
1985                  *            The trust comment, or {@code null} to restore it to the
1986                  *            default value
1987                  * @return This preferences
1988                  */
1989                 public Preferences setTrustComment(String trustComment) {
1990                         options.getStringOption("TrustComment").set(trustComment);
1991                         return this;
1992                 }
1993
1994                 /**
1995                  * Returns whether the rescue mode is active.
1996                  *
1997                  * @return {@code true} if the rescue mode is active, {@code false}
1998                  *         otherwise
1999                  */
2000                 public boolean isSoneRescueMode() {
2001                         return options.getBooleanOption("SoneRescueMode").get();
2002                 }
2003
2004                 /**
2005                  * Sets whether the rescue mode is active.
2006                  *
2007                  * @param soneRescueMode
2008                  *            {@code true} if the rescue mode is active, {@code false}
2009                  *            otherwise
2010                  * @return This preferences
2011                  */
2012                 public Preferences setSoneRescueMode(Boolean soneRescueMode) {
2013                         options.getBooleanOption("SoneRescueMode").set(soneRescueMode);
2014                         return this;
2015                 }
2016
2017                 /**
2018                  * Returns whether Sone should clear its settings on the next restart.
2019                  * In order to be effective, {@link #isReallyClearOnNextRestart()} needs
2020                  * to return {@code true} as well!
2021                  *
2022                  * @return {@code true} if Sone should clear its settings on the next
2023                  *         restart, {@code false} otherwise
2024                  */
2025                 public boolean isClearOnNextRestart() {
2026                         return options.getBooleanOption("ClearOnNextRestart").get();
2027                 }
2028
2029                 /**
2030                  * Sets whether Sone will clear its settings on the next restart.
2031                  *
2032                  * @param clearOnNextRestart
2033                  *            {@code true} if Sone should clear its settings on the next
2034                  *            restart, {@code false} otherwise
2035                  * @return This preferences
2036                  */
2037                 public Preferences setClearOnNextRestart(Boolean clearOnNextRestart) {
2038                         options.getBooleanOption("ClearOnNextRestart").set(clearOnNextRestart);
2039                         return this;
2040                 }
2041
2042                 /**
2043                  * Returns whether Sone should really clear its settings on next
2044                  * restart. This is a confirmation option that needs to be set in
2045                  * addition to {@link #isClearOnNextRestart()} in order to clear Sone’s
2046                  * settings on the next restart.
2047                  *
2048                  * @return {@code true} if Sone should really clear its settings on the
2049                  *         next restart, {@code false} otherwise
2050                  */
2051                 public boolean isReallyClearOnNextRestart() {
2052                         return options.getBooleanOption("ReallyClearOnNextRestart").get();
2053                 }
2054
2055                 /**
2056                  * Sets whether Sone should really clear its settings on the next
2057                  * restart.
2058                  *
2059                  * @param reallyClearOnNextRestart
2060                  *            {@code true} if Sone should really clear its settings on
2061                  *            the next restart, {@code false} otherwise
2062                  * @return This preferences
2063                  */
2064                 public Preferences setReallyClearOnNextRestart(Boolean reallyClearOnNextRestart) {
2065                         options.getBooleanOption("ReallyClearOnNextRestart").set(reallyClearOnNextRestart);
2066                         return this;
2067                 }
2068
2069         }
2070
2071 }