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