Merge branch 'release-0.7.2'
[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.addFriend("nwa8lHa271k2QvJ8aa0Ov7IHAV-DFOCFgmDt3X6BpCI");
1012                 touchConfiguration();
1013                 return sone;
1014         }
1015
1016         /**
1017          * Adds the Sone of the given identity.
1018          *
1019          * @param identity
1020          *            The identity whose Sone to add
1021          * @return The added or already existing Sone
1022          */
1023         public Sone addRemoteSone(Identity identity) {
1024                 if (identity == null) {
1025                         logger.log(Level.WARNING, "Given Identity is null!");
1026                         return null;
1027                 }
1028                 synchronized (remoteSones) {
1029                         final Sone sone = getRemoteSone(identity.getId()).setIdentity(identity);
1030                         boolean newSone = sone.getRequestUri() == null;
1031                         sone.setRequestUri(getSoneUri(identity.getRequestUri()));
1032                         sone.setLatestEdition(Numbers.safeParseLong(identity.getProperty("Sone.LatestEdition"), (long) 0));
1033                         if (newSone) {
1034                                 synchronized (newSones) {
1035                                         newSone = !knownSones.contains(sone.getId());
1036                                         if (newSone) {
1037                                                 newSones.add(sone.getId());
1038                                         }
1039                                 }
1040                                 if (newSone) {
1041                                         coreListenerManager.fireNewSoneFound(sone);
1042                                         for (Sone localSone : getLocalSones()) {
1043                                                 if (localSone.getOptions().getBooleanOption("AutoFollow").get()) {
1044                                                         localSone.addFriend(sone.getId());
1045                                                         touchConfiguration();
1046                                                 }
1047                                         }
1048                                 }
1049                         }
1050                         remoteSones.put(identity.getId(), sone);
1051                         soneDownloader.addSone(sone);
1052                         setSoneStatus(sone, SoneStatus.unknown);
1053                         soneDownloaders.execute(new Runnable() {
1054
1055                                 @Override
1056                                 @SuppressWarnings("synthetic-access")
1057                                 public void run() {
1058                                         soneDownloader.fetchSone(sone, sone.getRequestUri());
1059                                 }
1060
1061                         });
1062                         return sone;
1063                 }
1064         }
1065
1066         /**
1067          * Retrieves the trust relationship from the origin to the target. If the
1068          * trust relationship can not be retrieved, {@code null} is returned.
1069          *
1070          * @see Identity#getTrust(OwnIdentity)
1071          * @param origin
1072          *            The origin of the trust tree
1073          * @param target
1074          *            The target of the trust
1075          * @return The trust relationship
1076          */
1077         public Trust getTrust(Sone origin, Sone target) {
1078                 if (!isLocalSone(origin)) {
1079                         logger.log(Level.WARNING, "Tried to get trust from remote Sone: %s", origin);
1080                         return null;
1081                 }
1082                 return target.getIdentity().getTrust((OwnIdentity) origin.getIdentity());
1083         }
1084
1085         /**
1086          * Sets the trust value of the given origin Sone for the target Sone.
1087          *
1088          * @param origin
1089          *            The origin Sone
1090          * @param target
1091          *            The target Sone
1092          * @param trustValue
1093          *            The trust value (from {@code -100} to {@code 100})
1094          */
1095         public void setTrust(Sone origin, Sone target, int trustValue) {
1096                 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();
1097                 try {
1098                         ((OwnIdentity) origin.getIdentity()).setTrust(target.getIdentity(), trustValue, preferences.getTrustComment());
1099                 } catch (WebOfTrustException wote1) {
1100                         logger.log(Level.WARNING, "Could not set trust for Sone: " + target, wote1);
1101                 }
1102         }
1103
1104         /**
1105          * Removes any trust assignment for the given target Sone.
1106          *
1107          * @param origin
1108          *            The trust origin
1109          * @param target
1110          *            The trust target
1111          */
1112         public void removeTrust(Sone origin, Sone target) {
1113                 Validation.begin().isNotNull("Trust Origin", origin).isNotNull("Trust Target", target).check().isInstanceOf("Trust Origin Identity", origin.getIdentity(), OwnIdentity.class).check();
1114                 try {
1115                         ((OwnIdentity) origin.getIdentity()).removeTrust(target.getIdentity());
1116                 } catch (WebOfTrustException wote1) {
1117                         logger.log(Level.WARNING, "Could not remove trust for Sone: " + target, wote1);
1118                 }
1119         }
1120
1121         /**
1122          * Assigns the configured positive trust value for the given target.
1123          *
1124          * @param origin
1125          *            The trust origin
1126          * @param target
1127          *            The trust target
1128          */
1129         public void trustSone(Sone origin, Sone target) {
1130                 setTrust(origin, target, preferences.getPositiveTrust());
1131         }
1132
1133         /**
1134          * Assigns the configured negative trust value for the given target.
1135          *
1136          * @param origin
1137          *            The trust origin
1138          * @param target
1139          *            The trust target
1140          */
1141         public void distrustSone(Sone origin, Sone target) {
1142                 setTrust(origin, target, preferences.getNegativeTrust());
1143         }
1144
1145         /**
1146          * Removes the trust assignment for the given target.
1147          *
1148          * @param origin
1149          *            The trust origin
1150          * @param target
1151          *            The trust target
1152          */
1153         public void untrustSone(Sone origin, Sone target) {
1154                 removeTrust(origin, target);
1155         }
1156
1157         /**
1158          * Updates the stored Sone with the given Sone.
1159          *
1160          * @param sone
1161          *            The updated Sone
1162          */
1163         public void updateSone(Sone sone) {
1164                 updateSone(sone, false);
1165         }
1166
1167         /**
1168          * Updates the stored Sone with the given Sone. If {@code soneRescueMode} is
1169          * {@code true}, an older Sone than the current Sone can be given to restore
1170          * an old state.
1171          *
1172          * @param sone
1173          *            The Sone to update
1174          * @param soneRescueMode
1175          *            {@code true} if the stored Sone should be updated regardless
1176          *            of the age of the given Sone
1177          */
1178         public void updateSone(Sone sone, boolean soneRescueMode) {
1179                 if (hasSone(sone.getId())) {
1180                         Sone storedSone = getSone(sone.getId());
1181                         if (!soneRescueMode && !(sone.getTime() > storedSone.getTime())) {
1182                                 logger.log(Level.FINE, "Downloaded Sone %s is not newer than stored Sone %s.", new Object[] { sone, storedSone });
1183                                 return;
1184                         }
1185                         synchronized (posts) {
1186                                 if (!soneRescueMode) {
1187                                         for (Post post : storedSone.getPosts()) {
1188                                                 posts.remove(post.getId());
1189                                                 if (!sone.getPosts().contains(post)) {
1190                                                         coreListenerManager.firePostRemoved(post);
1191                                                 }
1192                                         }
1193                                 }
1194                                 List<Post> storedPosts = storedSone.getPosts();
1195                                 synchronized (newPosts) {
1196                                         for (Post post : sone.getPosts()) {
1197                                                 post.setSone(storedSone);
1198                                                 if (!storedPosts.contains(post) && !knownPosts.contains(post.getId())) {
1199                                                         newPosts.add(post.getId());
1200                                                         coreListenerManager.fireNewPostFound(post);
1201                                                 }
1202                                                 posts.put(post.getId(), post);
1203                                         }
1204                                 }
1205                         }
1206                         synchronized (replies) {
1207                                 if (!soneRescueMode) {
1208                                         for (PostReply reply : storedSone.getReplies()) {
1209                                                 replies.remove(reply.getId());
1210                                                 if (!sone.getReplies().contains(reply)) {
1211                                                         coreListenerManager.fireReplyRemoved(reply);
1212                                                 }
1213                                         }
1214                                 }
1215                                 Set<PostReply> storedReplies = storedSone.getReplies();
1216                                 synchronized (newReplies) {
1217                                         for (PostReply reply : sone.getReplies()) {
1218                                                 reply.setSone(storedSone);
1219                                                 if (!storedReplies.contains(reply) && !knownReplies.contains(reply.getId())) {
1220                                                         newReplies.add(reply.getId());
1221                                                         coreListenerManager.fireNewReplyFound(reply);
1222                                                 }
1223                                                 replies.put(reply.getId(), reply);
1224                                         }
1225                                 }
1226                         }
1227                         synchronized (albums) {
1228                                 synchronized (images) {
1229                                         for (Album album : storedSone.getAlbums()) {
1230                                                 albums.remove(album.getId());
1231                                                 for (Image image : album.getImages()) {
1232                                                         images.remove(image.getId());
1233                                                 }
1234                                         }
1235                                         for (Album album : sone.getAlbums()) {
1236                                                 albums.put(album.getId(), album);
1237                                                 for (Image image : album.getImages()) {
1238                                                         images.put(image.getId(), image);
1239                                                 }
1240                                         }
1241                                 }
1242                         }
1243                         synchronized (storedSone) {
1244                                 if (!soneRescueMode || (sone.getTime() > storedSone.getTime())) {
1245                                         storedSone.setTime(sone.getTime());
1246                                 }
1247                                 storedSone.setClient(sone.getClient());
1248                                 storedSone.setProfile(sone.getProfile());
1249                                 if (soneRescueMode) {
1250                                         for (Post post : sone.getPosts()) {
1251                                                 storedSone.addPost(post);
1252                                         }
1253                                         for (PostReply reply : sone.getReplies()) {
1254                                                 storedSone.addReply(reply);
1255                                         }
1256                                         for (String likedPostId : sone.getLikedPostIds()) {
1257                                                 storedSone.addLikedPostId(likedPostId);
1258                                         }
1259                                         for (String likedReplyId : sone.getLikedReplyIds()) {
1260                                                 storedSone.addLikedReplyId(likedReplyId);
1261                                         }
1262                                         for (Album album : sone.getAlbums()) {
1263                                                 storedSone.addAlbum(album);
1264                                         }
1265                                 } else {
1266                                         storedSone.setPosts(sone.getPosts());
1267                                         storedSone.setReplies(sone.getReplies());
1268                                         storedSone.setLikePostIds(sone.getLikedPostIds());
1269                                         storedSone.setLikeReplyIds(sone.getLikedReplyIds());
1270                                         storedSone.setAlbums(sone.getAlbums());
1271                                 }
1272                                 storedSone.setLatestEdition(sone.getLatestEdition());
1273                         }
1274                 }
1275         }
1276
1277         /**
1278          * Deletes the given Sone. This will remove the Sone from the
1279          * {@link #getLocalSone(String) local Sones}, stops its {@link SoneInserter}
1280          * and remove the context from its identity.
1281          *
1282          * @param sone
1283          *            The Sone to delete
1284          */
1285         public void deleteSone(Sone sone) {
1286                 if (!(sone.getIdentity() instanceof OwnIdentity)) {
1287                         logger.log(Level.WARNING, "Tried to delete Sone of non-own identity: %s", sone);
1288                         return;
1289                 }
1290                 synchronized (localSones) {
1291                         if (!localSones.containsKey(sone.getId())) {
1292                                 logger.log(Level.WARNING, "Tried to delete non-local Sone: %s", sone);
1293                                 return;
1294                         }
1295                         localSones.remove(sone.getId());
1296                         SoneInserter soneInserter = soneInserters.remove(sone);
1297                         soneInserter.removeSoneInsertListener(this);
1298                         soneInserter.stop();
1299                 }
1300                 try {
1301                         ((OwnIdentity) sone.getIdentity()).removeContext("Sone");
1302                         ((OwnIdentity) sone.getIdentity()).removeProperty("Sone.LatestEdition");
1303                 } catch (WebOfTrustException wote1) {
1304                         logger.log(Level.WARNING, "Could not remove context and properties from Sone: " + sone, wote1);
1305                 }
1306                 try {
1307                         configuration.getLongValue("Sone/" + sone.getId() + "/Time").setValue(null);
1308                 } catch (ConfigurationException ce1) {
1309                         logger.log(Level.WARNING, "Could not remove Sone from configuration!", ce1);
1310                 }
1311         }
1312
1313         /**
1314          * Marks the given Sone as known. If the Sone was {@link #isNewPost(String)
1315          * new} before, a {@link CoreListener#markSoneKnown(Sone)} event is fired.
1316          *
1317          * @param sone
1318          *            The Sone to mark as known
1319          */
1320         public void markSoneKnown(Sone sone) {
1321                 synchronized (newSones) {
1322                         if (newSones.remove(sone.getId())) {
1323                                 knownSones.add(sone.getId());
1324                                 coreListenerManager.fireMarkSoneKnown(sone);
1325                                 touchConfiguration();
1326                         }
1327                 }
1328         }
1329
1330         /**
1331          * Loads and updates the given Sone from the configuration. If any error is
1332          * encountered, loading is aborted and the given Sone is not changed.
1333          *
1334          * @param sone
1335          *            The Sone to load and update
1336          */
1337         public void loadSone(Sone sone) {
1338                 if (!isLocalSone(sone)) {
1339                         logger.log(Level.FINE, "Tried to load non-local Sone: %s", sone);
1340                         return;
1341                 }
1342
1343                 /* initialize options. */
1344                 sone.getOptions().addBooleanOption("AutoFollow", new DefaultOption<Boolean>(false));
1345                 sone.getOptions().addBooleanOption("EnableSoneInsertNotifications", new DefaultOption<Boolean>(false));
1346
1347                 /* load Sone. */
1348                 String sonePrefix = "Sone/" + sone.getId();
1349                 Long soneTime = configuration.getLongValue(sonePrefix + "/Time").getValue(null);
1350                 if (soneTime == null) {
1351                         logger.log(Level.INFO, "Could not load Sone because no Sone has been saved.");
1352                         return;
1353                 }
1354                 String lastInsertFingerprint = configuration.getStringValue(sonePrefix + "/LastInsertFingerprint").getValue("");
1355
1356                 /* load profile. */
1357                 Profile profile = new Profile();
1358                 profile.setFirstName(configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null));
1359                 profile.setMiddleName(configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null));
1360                 profile.setLastName(configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null));
1361                 profile.setBirthDay(configuration.getIntValue(sonePrefix + "/Profile/BirthDay").getValue(null));
1362                 profile.setBirthMonth(configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").getValue(null));
1363                 profile.setBirthYear(configuration.getIntValue(sonePrefix + "/Profile/BirthYear").getValue(null));
1364
1365                 /* load profile fields. */
1366                 while (true) {
1367                         String fieldPrefix = sonePrefix + "/Profile/Fields/" + profile.getFields().size();
1368                         String fieldName = configuration.getStringValue(fieldPrefix + "/Name").getValue(null);
1369                         if (fieldName == null) {
1370                                 break;
1371                         }
1372                         String fieldValue = configuration.getStringValue(fieldPrefix + "/Value").getValue("");
1373                         profile.addField(fieldName).setValue(fieldValue);
1374                 }
1375
1376                 /* load posts. */
1377                 Set<Post> posts = new HashSet<Post>();
1378                 while (true) {
1379                         String postPrefix = sonePrefix + "/Posts/" + posts.size();
1380                         String postId = configuration.getStringValue(postPrefix + "/ID").getValue(null);
1381                         if (postId == null) {
1382                                 break;
1383                         }
1384                         String postRecipientId = configuration.getStringValue(postPrefix + "/Recipient").getValue(null);
1385                         long postTime = configuration.getLongValue(postPrefix + "/Time").getValue((long) 0);
1386                         String postText = configuration.getStringValue(postPrefix + "/Text").getValue(null);
1387                         if ((postTime == 0) || (postText == null)) {
1388                                 logger.log(Level.WARNING, "Invalid post found, aborting load!");
1389                                 return;
1390                         }
1391                         Post post = getPost(postId).setSone(sone).setTime(postTime).setText(postText);
1392                         if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
1393                                 post.setRecipient(getSone(postRecipientId));
1394                         }
1395                         posts.add(post);
1396                 }
1397
1398                 /* load replies. */
1399                 Set<PostReply> replies = new HashSet<PostReply>();
1400                 while (true) {
1401                         String replyPrefix = sonePrefix + "/Replies/" + replies.size();
1402                         String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
1403                         if (replyId == null) {
1404                                 break;
1405                         }
1406                         String postId = configuration.getStringValue(replyPrefix + "/Post/ID").getValue(null);
1407                         long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue((long) 0);
1408                         String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
1409                         if ((postId == null) || (replyTime == 0) || (replyText == null)) {
1410                                 logger.log(Level.WARNING, "Invalid reply found, aborting load!");
1411                                 return;
1412                         }
1413                         replies.add(getReply(replyId).setSone(sone).setPost(getPost(postId)).setTime(replyTime).setText(replyText));
1414                 }
1415
1416                 /* load post likes. */
1417                 Set<String> likedPostIds = new HashSet<String>();
1418                 while (true) {
1419                         String likedPostId = configuration.getStringValue(sonePrefix + "/Likes/Post/" + likedPostIds.size() + "/ID").getValue(null);
1420                         if (likedPostId == null) {
1421                                 break;
1422                         }
1423                         likedPostIds.add(likedPostId);
1424                 }
1425
1426                 /* load reply likes. */
1427                 Set<String> likedReplyIds = new HashSet<String>();
1428                 while (true) {
1429                         String likedReplyId = configuration.getStringValue(sonePrefix + "/Likes/Reply/" + likedReplyIds.size() + "/ID").getValue(null);
1430                         if (likedReplyId == null) {
1431                                 break;
1432                         }
1433                         likedReplyIds.add(likedReplyId);
1434                 }
1435
1436                 /* load friends. */
1437                 Set<String> friends = new HashSet<String>();
1438                 while (true) {
1439                         String friendId = configuration.getStringValue(sonePrefix + "/Friends/" + friends.size() + "/ID").getValue(null);
1440                         if (friendId == null) {
1441                                 break;
1442                         }
1443                         friends.add(friendId);
1444                 }
1445
1446                 /* load albums. */
1447                 List<Album> topLevelAlbums = new ArrayList<Album>();
1448                 int albumCounter = 0;
1449                 while (true) {
1450                         String albumPrefix = sonePrefix + "/Albums/" + albumCounter++;
1451                         String albumId = configuration.getStringValue(albumPrefix + "/ID").getValue(null);
1452                         if (albumId == null) {
1453                                 break;
1454                         }
1455                         String albumTitle = configuration.getStringValue(albumPrefix + "/Title").getValue(null);
1456                         String albumDescription = configuration.getStringValue(albumPrefix + "/Description").getValue(null);
1457                         String albumParentId = configuration.getStringValue(albumPrefix + "/Parent").getValue(null);
1458                         String albumImageId = configuration.getStringValue(albumPrefix + "/AlbumImage").getValue(null);
1459                         if ((albumTitle == null) || (albumDescription == null)) {
1460                                 logger.log(Level.WARNING, "Invalid album found, aborting load!");
1461                                 return;
1462                         }
1463                         Album album = getAlbum(albumId).setSone(sone).setTitle(albumTitle).setDescription(albumDescription).setAlbumImage(albumImageId);
1464                         if (albumParentId != null) {
1465                                 Album parentAlbum = getAlbum(albumParentId, false);
1466                                 if (parentAlbum == null) {
1467                                         logger.log(Level.WARNING, "Invalid parent album ID: " + albumParentId);
1468                                         return;
1469                                 }
1470                                 parentAlbum.addAlbum(album);
1471                         } else {
1472                                 topLevelAlbums.add(album);
1473                         }
1474                 }
1475
1476                 /* load images. */
1477                 int imageCounter = 0;
1478                 while (true) {
1479                         String imagePrefix = sonePrefix + "/Images/" + imageCounter++;
1480                         String imageId = configuration.getStringValue(imagePrefix + "/ID").getValue(null);
1481                         if (imageId == null) {
1482                                 break;
1483                         }
1484                         String albumId = configuration.getStringValue(imagePrefix + "/Album").getValue(null);
1485                         String key = configuration.getStringValue(imagePrefix + "/Key").getValue(null);
1486                         String title = configuration.getStringValue(imagePrefix + "/Title").getValue(null);
1487                         String description = configuration.getStringValue(imagePrefix + "/Description").getValue(null);
1488                         Long creationTime = configuration.getLongValue(imagePrefix + "/CreationTime").getValue(null);
1489                         Integer width = configuration.getIntValue(imagePrefix + "/Width").getValue(null);
1490                         Integer height = configuration.getIntValue(imagePrefix + "/Height").getValue(null);
1491                         if ((albumId == null) || (key == null) || (title == null) || (description == null) || (creationTime == null) || (width == null) || (height == null)) {
1492                                 logger.log(Level.WARNING, "Invalid image found, aborting load!");
1493                                 return;
1494                         }
1495                         Album album = getAlbum(albumId, false);
1496                         if (album == null) {
1497                                 logger.log(Level.WARNING, "Invalid album image encountered, aborting load!");
1498                                 return;
1499                         }
1500                         Image image = getImage(imageId).setSone(sone).setCreationTime(creationTime).setKey(key);
1501                         image.setTitle(title).setDescription(description).setWidth(width).setHeight(height);
1502                         album.addImage(image);
1503                 }
1504
1505                 /* load options. */
1506                 sone.getOptions().getBooleanOption("AutoFollow").set(configuration.getBooleanValue(sonePrefix + "/Options/AutoFollow").getValue(null));
1507                 sone.getOptions().getBooleanOption("EnableSoneInsertNotifications").set(configuration.getBooleanValue(sonePrefix + "/Options/EnableSoneInsertNotifications").getValue(null));
1508
1509                 /* if we’re still here, Sone was loaded successfully. */
1510                 synchronized (sone) {
1511                         sone.setTime(soneTime);
1512                         sone.setProfile(profile);
1513                         sone.setPosts(posts);
1514                         sone.setReplies(replies);
1515                         sone.setLikePostIds(likedPostIds);
1516                         sone.setLikeReplyIds(likedReplyIds);
1517                         sone.setFriends(friends);
1518                         sone.setAlbums(topLevelAlbums);
1519                         soneInserters.get(sone).setLastInsertFingerprint(lastInsertFingerprint);
1520                 }
1521                 synchronized (newSones) {
1522                         for (String friend : friends) {
1523                                 knownSones.add(friend);
1524                         }
1525                 }
1526                 synchronized (newPosts) {
1527                         for (Post post : posts) {
1528                                 knownPosts.add(post.getId());
1529                         }
1530                 }
1531                 synchronized (newReplies) {
1532                         for (PostReply reply : replies) {
1533                                 knownReplies.add(reply.getId());
1534                         }
1535                 }
1536         }
1537
1538         /**
1539          * Creates a new post.
1540          *
1541          * @param sone
1542          *            The Sone that creates the post
1543          * @param text
1544          *            The text of the post
1545          * @return The created post
1546          */
1547         public Post createPost(Sone sone, String text) {
1548                 return createPost(sone, System.currentTimeMillis(), text);
1549         }
1550
1551         /**
1552          * Creates a new post.
1553          *
1554          * @param sone
1555          *            The Sone that creates the post
1556          * @param time
1557          *            The time of the post
1558          * @param text
1559          *            The text of the post
1560          * @return The created post
1561          */
1562         public Post createPost(Sone sone, long time, String text) {
1563                 return createPost(sone, null, time, text);
1564         }
1565
1566         /**
1567          * Creates a new post.
1568          *
1569          * @param sone
1570          *            The Sone that creates the post
1571          * @param recipient
1572          *            The recipient Sone, or {@code null} if this post does not have
1573          *            a recipient
1574          * @param text
1575          *            The text of the post
1576          * @return The created post
1577          */
1578         public Post createPost(Sone sone, Sone recipient, String text) {
1579                 return createPost(sone, recipient, System.currentTimeMillis(), text);
1580         }
1581
1582         /**
1583          * Creates a new post.
1584          *
1585          * @param sone
1586          *            The Sone that creates the post
1587          * @param recipient
1588          *            The recipient Sone, or {@code null} if this post does not have
1589          *            a recipient
1590          * @param time
1591          *            The time of the post
1592          * @param text
1593          *            The text of the post
1594          * @return The created post
1595          */
1596         public Post createPost(Sone sone, Sone recipient, long time, String text) {
1597                 if (!isLocalSone(sone)) {
1598                         logger.log(Level.FINE, "Tried to create post for non-local Sone: %s", sone);
1599                         return null;
1600                 }
1601                 final Post post = new Post(sone, time, text);
1602                 if (recipient != null) {
1603                         post.setRecipient(recipient);
1604                 }
1605                 synchronized (posts) {
1606                         posts.put(post.getId(), post);
1607                 }
1608                 synchronized (newPosts) {
1609                         newPosts.add(post.getId());
1610                         coreListenerManager.fireNewPostFound(post);
1611                 }
1612                 sone.addPost(post);
1613                 touchConfiguration();
1614                 localElementTicker.registerEvent(System.currentTimeMillis() + 10 * 1000, new Runnable() {
1615
1616                         /**
1617                          * {@inheritDoc}
1618                          */
1619                         @Override
1620                         public void run() {
1621                                 markPostKnown(post);
1622                         }
1623                 }, "Mark " + post + " read.");
1624                 return post;
1625         }
1626
1627         /**
1628          * Deletes the given post.
1629          *
1630          * @param post
1631          *            The post to delete
1632          */
1633         public void deletePost(Post post) {
1634                 if (!isLocalSone(post.getSone())) {
1635                         logger.log(Level.WARNING, "Tried to delete post of non-local Sone: %s", post.getSone());
1636                         return;
1637                 }
1638                 post.getSone().removePost(post);
1639                 synchronized (posts) {
1640                         posts.remove(post.getId());
1641                 }
1642                 coreListenerManager.firePostRemoved(post);
1643                 synchronized (newPosts) {
1644                         markPostKnown(post);
1645                         knownPosts.remove(post.getId());
1646                 }
1647                 touchConfiguration();
1648         }
1649
1650         /**
1651          * Marks the given post as known, if it is currently a new post (according
1652          * to {@link #isNewPost(String)}).
1653          *
1654          * @param post
1655          *            The post to mark as known
1656          */
1657         public void markPostKnown(Post post) {
1658                 synchronized (newPosts) {
1659                         if (newPosts.remove(post.getId())) {
1660                                 knownPosts.add(post.getId());
1661                                 coreListenerManager.fireMarkPostKnown(post);
1662                                 touchConfiguration();
1663                         }
1664                 }
1665         }
1666
1667         /**
1668          * Bookmarks the given post.
1669          *
1670          * @param post
1671          *            The post to bookmark
1672          */
1673         public void bookmark(Post post) {
1674                 bookmarkPost(post.getId());
1675         }
1676
1677         /**
1678          * Bookmarks the post with the given ID.
1679          *
1680          * @param id
1681          *            The ID of the post to bookmark
1682          */
1683         public void bookmarkPost(String id) {
1684                 synchronized (bookmarkedPosts) {
1685                         bookmarkedPosts.add(id);
1686                 }
1687         }
1688
1689         /**
1690          * Removes the given post from the bookmarks.
1691          *
1692          * @param post
1693          *            The post to unbookmark
1694          */
1695         public void unbookmark(Post post) {
1696                 unbookmarkPost(post.getId());
1697         }
1698
1699         /**
1700          * Removes the post with the given ID from the bookmarks.
1701          *
1702          * @param id
1703          *            The ID of the post to unbookmark
1704          */
1705         public void unbookmarkPost(String id) {
1706                 synchronized (bookmarkedPosts) {
1707                         bookmarkedPosts.remove(id);
1708                 }
1709         }
1710
1711         /**
1712          * Creates a new reply.
1713          *
1714          * @param sone
1715          *            The Sone that creates the reply
1716          * @param post
1717          *            The post that this reply refers to
1718          * @param text
1719          *            The text of the reply
1720          * @return The created reply
1721          */
1722         public PostReply createReply(Sone sone, Post post, String text) {
1723                 return createReply(sone, post, System.currentTimeMillis(), text);
1724         }
1725
1726         /**
1727          * Creates a new reply.
1728          *
1729          * @param sone
1730          *            The Sone that creates the reply
1731          * @param post
1732          *            The post that this reply refers to
1733          * @param time
1734          *            The time of the reply
1735          * @param text
1736          *            The text of the reply
1737          * @return The created reply
1738          */
1739         public PostReply createReply(Sone sone, Post post, long time, String text) {
1740                 if (!isLocalSone(sone)) {
1741                         logger.log(Level.FINE, "Tried to create reply for non-local Sone: %s", sone);
1742                         return null;
1743                 }
1744                 final PostReply reply = new PostReply(sone, post, System.currentTimeMillis(), text);
1745                 synchronized (replies) {
1746                         replies.put(reply.getId(), reply);
1747                 }
1748                 synchronized (newReplies) {
1749                         newReplies.add(reply.getId());
1750                         coreListenerManager.fireNewReplyFound(reply);
1751                 }
1752                 sone.addReply(reply);
1753                 touchConfiguration();
1754                 localElementTicker.registerEvent(System.currentTimeMillis() + 10 * 1000, new Runnable() {
1755
1756                         /**
1757                          * {@inheritDoc}
1758                          */
1759                         @Override
1760                         public void run() {
1761                                 markReplyKnown(reply);
1762                         }
1763                 }, "Mark " + reply + " read.");
1764                 return reply;
1765         }
1766
1767         /**
1768          * Deletes the given reply.
1769          *
1770          * @param reply
1771          *            The reply to delete
1772          */
1773         public void deleteReply(PostReply reply) {
1774                 Sone sone = reply.getSone();
1775                 if (!isLocalSone(sone)) {
1776                         logger.log(Level.FINE, "Tried to delete non-local reply: %s", reply);
1777                         return;
1778                 }
1779                 synchronized (replies) {
1780                         replies.remove(reply.getId());
1781                 }
1782                 synchronized (newReplies) {
1783                         markReplyKnown(reply);
1784                         knownReplies.remove(reply.getId());
1785                 }
1786                 sone.removeReply(reply);
1787                 touchConfiguration();
1788         }
1789
1790         /**
1791          * Marks the given reply as known, if it is currently a new reply (according
1792          * to {@link #isNewReply(String)}).
1793          *
1794          * @param reply
1795          *            The reply to mark as known
1796          */
1797         public void markReplyKnown(PostReply reply) {
1798                 synchronized (newReplies) {
1799                         if (newReplies.remove(reply.getId())) {
1800                                 knownReplies.add(reply.getId());
1801                                 coreListenerManager.fireMarkReplyKnown(reply);
1802                                 touchConfiguration();
1803                         }
1804                 }
1805         }
1806
1807         /**
1808          * Creates a new top-level album for the given Sone.
1809          *
1810          * @param sone
1811          *            The Sone to create the album for
1812          * @return The new album
1813          */
1814         public Album createAlbum(Sone sone) {
1815                 return createAlbum(sone, null);
1816         }
1817
1818         /**
1819          * Creates a new album for the given Sone.
1820          *
1821          * @param sone
1822          *            The Sone to create the album for
1823          * @param parent
1824          *            The parent of the album (may be {@code null} to create a
1825          *            top-level album)
1826          * @return The new album
1827          */
1828         public Album createAlbum(Sone sone, Album parent) {
1829                 Album album = new Album();
1830                 synchronized (albums) {
1831                         albums.put(album.getId(), album);
1832                 }
1833                 album.setSone(sone);
1834                 if (parent != null) {
1835                         parent.addAlbum(album);
1836                 } else {
1837                         sone.addAlbum(album);
1838                 }
1839                 return album;
1840         }
1841
1842         /**
1843          * Deletes the given album. The owner of the album has to be a local Sone,
1844          * and the album has to be {@link Album#isEmpty() empty} to be deleted.
1845          *
1846          * @param album
1847          *            The album to remove
1848          */
1849         public void deleteAlbum(Album album) {
1850                 Validation.begin().isNotNull("Album", album).check().is("Local Sone", isLocalSone(album.getSone())).check();
1851                 if (!album.isEmpty()) {
1852                         return;
1853                 }
1854                 if (album.getParent() == null) {
1855                         album.getSone().removeAlbum(album);
1856                 } else {
1857                         album.getParent().removeAlbum(album);
1858                 }
1859                 synchronized (albums) {
1860                         albums.remove(album.getId());
1861                 }
1862                 saveSone(album.getSone());
1863         }
1864
1865         /**
1866          * Creates a new image.
1867          *
1868          * @param sone
1869          *            The Sone creating the image
1870          * @param album
1871          *            The album the image will be inserted into
1872          * @param temporaryImage
1873          *            The temporary image to create the image from
1874          * @return The newly created image
1875          */
1876         public Image createImage(Sone sone, Album album, TemporaryImage temporaryImage) {
1877                 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();
1878                 Image image = new Image(temporaryImage.getId()).setSone(sone).setCreationTime(System.currentTimeMillis());
1879                 album.addImage(image);
1880                 synchronized (images) {
1881                         images.put(image.getId(), image);
1882                 }
1883                 imageInserter.insertImage(temporaryImage, image);
1884                 return image;
1885         }
1886
1887         /**
1888          * Deletes the given image. This method will also delete a matching
1889          * temporary image.
1890          *
1891          * @see #deleteTemporaryImage(TemporaryImage)
1892          * @param image
1893          *            The image to delete
1894          */
1895         public void deleteImage(Image image) {
1896                 Validation.begin().isNotNull("Image", image).check().is("Local Sone", isLocalSone(image.getSone())).check();
1897                 deleteTemporaryImage(image.getId());
1898                 image.getAlbum().removeImage(image);
1899                 synchronized (images) {
1900                         images.remove(image.getId());
1901                 }
1902                 saveSone(image.getSone());
1903         }
1904
1905         /**
1906          * Creates a new temporary image.
1907          *
1908          * @param mimeType
1909          *            The MIME type of the temporary image
1910          * @param imageData
1911          *            The encoded data of the image
1912          * @return The temporary image
1913          */
1914         public TemporaryImage createTemporaryImage(String mimeType, byte[] imageData) {
1915                 TemporaryImage temporaryImage = new TemporaryImage();
1916                 temporaryImage.setMimeType(mimeType).setImageData(imageData);
1917                 synchronized (temporaryImages) {
1918                         temporaryImages.put(temporaryImage.getId(), temporaryImage);
1919                 }
1920                 return temporaryImage;
1921         }
1922
1923         /**
1924          * Deletes the given temporary image.
1925          *
1926          * @param temporaryImage
1927          *            The temporary image to delete
1928          */
1929         public void deleteTemporaryImage(TemporaryImage temporaryImage) {
1930                 Validation.begin().isNotNull("Temporary Image", temporaryImage).check();
1931                 deleteTemporaryImage(temporaryImage.getId());
1932         }
1933
1934         /**
1935          * Deletes the temporary image with the given ID.
1936          *
1937          * @param imageId
1938          *            The ID of the temporary image to delete
1939          */
1940         public void deleteTemporaryImage(String imageId) {
1941                 Validation.begin().isNotNull("Temporary Image ID", imageId).check();
1942                 synchronized (temporaryImages) {
1943                         temporaryImages.remove(imageId);
1944                 }
1945                 Image image = getImage(imageId, false);
1946                 if (image != null) {
1947                         imageInserter.cancelImageInsert(image);
1948                 }
1949         }
1950
1951         /**
1952          * Notifies the core that the configuration, either of the core or of a
1953          * single local Sone, has changed, and that the configuration should be
1954          * saved.
1955          */
1956         public void touchConfiguration() {
1957                 lastConfigurationUpdate = System.currentTimeMillis();
1958         }
1959
1960         //
1961         // SERVICE METHODS
1962         //
1963
1964         /**
1965          * Starts the core.
1966          */
1967         @Override
1968         public void serviceStart() {
1969                 loadConfiguration();
1970                 updateChecker.addUpdateListener(this);
1971                 updateChecker.start();
1972         }
1973
1974         /**
1975          * {@inheritDoc}
1976          */
1977         @Override
1978         public void serviceRun() {
1979                 long lastSaved = System.currentTimeMillis();
1980                 while (!shouldStop()) {
1981                         sleep(1000);
1982                         long now = System.currentTimeMillis();
1983                         if (shouldStop() || ((lastConfigurationUpdate > lastSaved) && ((now - lastConfigurationUpdate) > 5000))) {
1984                                 for (Sone localSone : getLocalSones()) {
1985                                         saveSone(localSone);
1986                                 }
1987                                 saveConfiguration();
1988                                 lastSaved = now;
1989                         }
1990                 }
1991         }
1992
1993         /**
1994          * Stops the core.
1995          */
1996         @Override
1997         public void serviceStop() {
1998                 synchronized (localSones) {
1999                         for (SoneInserter soneInserter : soneInserters.values()) {
2000                                 soneInserter.removeSoneInsertListener(this);
2001                                 soneInserter.stop();
2002                         }
2003                 }
2004                 updateChecker.stop();
2005                 updateChecker.removeUpdateListener(this);
2006                 soneDownloader.stop();
2007         }
2008
2009         //
2010         // PRIVATE METHODS
2011         //
2012
2013         /**
2014          * Saves the given Sone. This will persist all local settings for the given
2015          * Sone, such as the friends list and similar, private options.
2016          *
2017          * @param sone
2018          *            The Sone to save
2019          */
2020         private synchronized void saveSone(Sone sone) {
2021                 if (!isLocalSone(sone)) {
2022                         logger.log(Level.FINE, "Tried to save non-local Sone: %s", sone);
2023                         return;
2024                 }
2025                 if (!(sone.getIdentity() instanceof OwnIdentity)) {
2026                         logger.log(Level.WARNING, "Local Sone without OwnIdentity found, refusing to save: %s", sone);
2027                         return;
2028                 }
2029
2030                 logger.log(Level.INFO, "Saving Sone: %s", sone);
2031                 try {
2032                         /* save Sone into configuration. */
2033                         String sonePrefix = "Sone/" + sone.getId();
2034                         configuration.getLongValue(sonePrefix + "/Time").setValue(sone.getTime());
2035                         configuration.getStringValue(sonePrefix + "/LastInsertFingerprint").setValue(soneInserters.get(sone).getLastInsertFingerprint());
2036
2037                         /* save profile. */
2038                         Profile profile = sone.getProfile();
2039                         configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
2040                         configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
2041                         configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
2042                         configuration.getIntValue(sonePrefix + "/Profile/BirthDay").setValue(profile.getBirthDay());
2043                         configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").setValue(profile.getBirthMonth());
2044                         configuration.getIntValue(sonePrefix + "/Profile/BirthYear").setValue(profile.getBirthYear());
2045
2046                         /* save profile fields. */
2047                         int fieldCounter = 0;
2048                         for (Field profileField : profile.getFields()) {
2049                                 String fieldPrefix = sonePrefix + "/Profile/Fields/" + fieldCounter++;
2050                                 configuration.getStringValue(fieldPrefix + "/Name").setValue(profileField.getName());
2051                                 configuration.getStringValue(fieldPrefix + "/Value").setValue(profileField.getValue());
2052                         }
2053                         configuration.getStringValue(sonePrefix + "/Profile/Fields/" + fieldCounter + "/Name").setValue(null);
2054
2055                         /* save posts. */
2056                         int postCounter = 0;
2057                         for (Post post : sone.getPosts()) {
2058                                 String postPrefix = sonePrefix + "/Posts/" + postCounter++;
2059                                 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
2060                                 configuration.getStringValue(postPrefix + "/Recipient").setValue((post.getRecipient() != null) ? post.getRecipient().getId() : null);
2061                                 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
2062                                 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
2063                         }
2064                         configuration.getStringValue(sonePrefix + "/Posts/" + postCounter + "/ID").setValue(null);
2065
2066                         /* save replies. */
2067                         int replyCounter = 0;
2068                         for (PostReply reply : sone.getReplies()) {
2069                                 String replyPrefix = sonePrefix + "/Replies/" + replyCounter++;
2070                                 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
2071                                 configuration.getStringValue(replyPrefix + "/Post/ID").setValue(reply.getPost().getId());
2072                                 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
2073                                 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
2074                         }
2075                         configuration.getStringValue(sonePrefix + "/Replies/" + replyCounter + "/ID").setValue(null);
2076
2077                         /* save post likes. */
2078                         int postLikeCounter = 0;
2079                         for (String postId : sone.getLikedPostIds()) {
2080                                 configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter++ + "/ID").setValue(postId);
2081                         }
2082                         configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter + "/ID").setValue(null);
2083
2084                         /* save reply likes. */
2085                         int replyLikeCounter = 0;
2086                         for (String replyId : sone.getLikedReplyIds()) {
2087                                 configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter++ + "/ID").setValue(replyId);
2088                         }
2089                         configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter + "/ID").setValue(null);
2090
2091                         /* save friends. */
2092                         int friendCounter = 0;
2093                         for (String friendId : sone.getFriends()) {
2094                                 configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter++ + "/ID").setValue(friendId);
2095                         }
2096                         configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter + "/ID").setValue(null);
2097
2098                         /* save albums. first, collect in a flat structure, top-level first. */
2099                         List<Album> albums = sone.getAllAlbums();
2100
2101                         int albumCounter = 0;
2102                         for (Album album : albums) {
2103                                 String albumPrefix = sonePrefix + "/Albums/" + albumCounter++;
2104                                 configuration.getStringValue(albumPrefix + "/ID").setValue(album.getId());
2105                                 configuration.getStringValue(albumPrefix + "/Title").setValue(album.getTitle());
2106                                 configuration.getStringValue(albumPrefix + "/Description").setValue(album.getDescription());
2107                                 configuration.getStringValue(albumPrefix + "/Parent").setValue(album.getParent() == null ? null : album.getParent().getId());
2108                                 configuration.getStringValue(albumPrefix + "/AlbumImage").setValue(album.getAlbumImage() == null ? null : album.getAlbumImage().getId());
2109                         }
2110                         configuration.getStringValue(sonePrefix + "/Albums/" + albumCounter + "/ID").setValue(null);
2111
2112                         /* save images. */
2113                         int imageCounter = 0;
2114                         for (Album album : albums) {
2115                                 for (Image image : album.getImages()) {
2116                                         if (!image.isInserted()) {
2117                                                 continue;
2118                                         }
2119                                         String imagePrefix = sonePrefix + "/Images/" + imageCounter++;
2120                                         configuration.getStringValue(imagePrefix + "/ID").setValue(image.getId());
2121                                         configuration.getStringValue(imagePrefix + "/Album").setValue(album.getId());
2122                                         configuration.getStringValue(imagePrefix + "/Key").setValue(image.getKey());
2123                                         configuration.getStringValue(imagePrefix + "/Title").setValue(image.getTitle());
2124                                         configuration.getStringValue(imagePrefix + "/Description").setValue(image.getDescription());
2125                                         configuration.getLongValue(imagePrefix + "/CreationTime").setValue(image.getCreationTime());
2126                                         configuration.getIntValue(imagePrefix + "/Width").setValue(image.getWidth());
2127                                         configuration.getIntValue(imagePrefix + "/Height").setValue(image.getHeight());
2128                                 }
2129                         }
2130                         configuration.getStringValue(sonePrefix + "/Images/" + imageCounter + "/ID").setValue(null);
2131
2132                         /* save options. */
2133                         configuration.getBooleanValue(sonePrefix + "/Options/AutoFollow").setValue(sone.getOptions().getBooleanOption("AutoFollow").getReal());
2134                         configuration.getBooleanValue(sonePrefix + "/Options/EnableSoneInsertNotifications").setValue(sone.getOptions().getBooleanOption("EnableSoneInsertNotifications").getReal());
2135
2136                         configuration.save();
2137
2138                         ((OwnIdentity) sone.getIdentity()).setProperty("Sone.LatestEdition", String.valueOf(sone.getLatestEdition()));
2139
2140                         logger.log(Level.INFO, "Sone %s saved.", sone);
2141                 } catch (ConfigurationException ce1) {
2142                         logger.log(Level.WARNING, "Could not save Sone: " + sone, ce1);
2143                 } catch (WebOfTrustException wote1) {
2144                         logger.log(Level.WARNING, "Could not set WoT property for Sone: " + sone, wote1);
2145                 }
2146         }
2147
2148         /**
2149          * Saves the current options.
2150          */
2151         private void saveConfiguration() {
2152                 synchronized (configuration) {
2153                         if (storingConfiguration) {
2154                                 logger.log(Level.FINE, "Already storing configuration…");
2155                                 return;
2156                         }
2157                         storingConfiguration = true;
2158                 }
2159
2160                 /* store the options first. */
2161                 try {
2162                         configuration.getIntValue("Option/ConfigurationVersion").setValue(0);
2163                         configuration.getIntValue("Option/InsertionDelay").setValue(options.getIntegerOption("InsertionDelay").getReal());
2164                         configuration.getIntValue("Option/PostsPerPage").setValue(options.getIntegerOption("PostsPerPage").getReal());
2165                         configuration.getIntValue("Option/CharactersPerPost").setValue(options.getIntegerOption("CharactersPerPost").getReal());
2166                         configuration.getIntValue("Option/PostCutOffLength").setValue(options.getIntegerOption("PostCutOffLength").getReal());
2167                         configuration.getBooleanValue("Option/RequireFullAccess").setValue(options.getBooleanOption("RequireFullAccess").getReal());
2168                         configuration.getIntValue("Option/PositiveTrust").setValue(options.getIntegerOption("PositiveTrust").getReal());
2169                         configuration.getIntValue("Option/NegativeTrust").setValue(options.getIntegerOption("NegativeTrust").getReal());
2170                         configuration.getStringValue("Option/TrustComment").setValue(options.getStringOption("TrustComment").getReal());
2171                         configuration.getBooleanValue("Option/ActivateFcpInterface").setValue(options.getBooleanOption("ActivateFcpInterface").getReal());
2172                         configuration.getIntValue("Option/FcpFullAccessRequired").setValue(options.getIntegerOption("FcpFullAccessRequired").getReal());
2173                         configuration.getBooleanValue("Option/SoneRescueMode").setValue(options.getBooleanOption("SoneRescueMode").getReal());
2174                         configuration.getBooleanValue("Option/ClearOnNextRestart").setValue(options.getBooleanOption("ClearOnNextRestart").getReal());
2175                         configuration.getBooleanValue("Option/ReallyClearOnNextRestart").setValue(options.getBooleanOption("ReallyClearOnNextRestart").getReal());
2176
2177                         /* save known Sones. */
2178                         int soneCounter = 0;
2179                         synchronized (newSones) {
2180                                 for (String knownSoneId : knownSones) {
2181                                         configuration.getStringValue("KnownSone/" + soneCounter++ + "/ID").setValue(knownSoneId);
2182                                 }
2183                                 configuration.getStringValue("KnownSone/" + soneCounter + "/ID").setValue(null);
2184                         }
2185
2186                         /* save known posts. */
2187                         int postCounter = 0;
2188                         synchronized (newPosts) {
2189                                 for (String knownPostId : knownPosts) {
2190                                         configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").setValue(knownPostId);
2191                                 }
2192                                 configuration.getStringValue("KnownPosts/" + postCounter + "/ID").setValue(null);
2193                         }
2194
2195                         /* save known replies. */
2196                         int replyCounter = 0;
2197                         synchronized (newReplies) {
2198                                 for (String knownReplyId : knownReplies) {
2199                                         configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").setValue(knownReplyId);
2200                                 }
2201                                 configuration.getStringValue("KnownReplies/" + replyCounter + "/ID").setValue(null);
2202                         }
2203
2204                         /* save bookmarked posts. */
2205                         int bookmarkedPostCounter = 0;
2206                         synchronized (bookmarkedPosts) {
2207                                 for (String bookmarkedPostId : bookmarkedPosts) {
2208                                         configuration.getStringValue("Bookmarks/Post/" + bookmarkedPostCounter++ + "/ID").setValue(bookmarkedPostId);
2209                                 }
2210                         }
2211                         configuration.getStringValue("Bookmarks/Post/" + bookmarkedPostCounter++ + "/ID").setValue(null);
2212
2213                         /* now save it. */
2214                         configuration.save();
2215
2216                 } catch (ConfigurationException ce1) {
2217                         logger.log(Level.SEVERE, "Could not store configuration!", ce1);
2218                 } finally {
2219                         synchronized (configuration) {
2220                                 storingConfiguration = false;
2221                         }
2222                 }
2223         }
2224
2225         /**
2226          * Loads the configuration.
2227          */
2228         @SuppressWarnings("unchecked")
2229         private void loadConfiguration() {
2230                 /* create options. */
2231                 options.addIntegerOption("InsertionDelay", new DefaultOption<Integer>(60, new IntegerRangeValidator(0, Integer.MAX_VALUE), new OptionWatcher<Integer>() {
2232
2233                         @Override
2234                         public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
2235                                 SoneInserter.setInsertionDelay(newValue);
2236                         }
2237
2238                 }));
2239                 options.addIntegerOption("PostsPerPage", new DefaultOption<Integer>(10, new IntegerRangeValidator(1, Integer.MAX_VALUE)));
2240                 options.addIntegerOption("CharactersPerPost", new DefaultOption<Integer>(400, new OrValidator<Integer>(new IntegerRangeValidator(50, Integer.MAX_VALUE), new EqualityValidator<Integer>(-1))));
2241                 options.addIntegerOption("PostCutOffLength", new DefaultOption<Integer>(200, new OrValidator<Integer>(new IntegerRangeValidator(50, Integer.MAX_VALUE), new EqualityValidator<Integer>(-1))));
2242                 options.addBooleanOption("RequireFullAccess", new DefaultOption<Boolean>(false));
2243                 options.addIntegerOption("PositiveTrust", new DefaultOption<Integer>(75, new IntegerRangeValidator(0, 100)));
2244                 options.addIntegerOption("NegativeTrust", new DefaultOption<Integer>(-25, new IntegerRangeValidator(-100, 100)));
2245                 options.addStringOption("TrustComment", new DefaultOption<String>("Set from Sone Web Interface"));
2246                 options.addBooleanOption("ActivateFcpInterface", new DefaultOption<Boolean>(false, new OptionWatcher<Boolean>() {
2247
2248                         @Override
2249                         @SuppressWarnings("synthetic-access")
2250                         public void optionChanged(Option<Boolean> option, Boolean oldValue, Boolean newValue) {
2251                                 fcpInterface.setActive(newValue);
2252                         }
2253                 }));
2254                 options.addIntegerOption("FcpFullAccessRequired", new DefaultOption<Integer>(2, new OptionWatcher<Integer>() {
2255
2256                         @Override
2257                         @SuppressWarnings("synthetic-access")
2258                         public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
2259                                 fcpInterface.setFullAccessRequired(FullAccessRequired.values()[newValue]);
2260                         }
2261
2262                 }));
2263                 options.addBooleanOption("SoneRescueMode", new DefaultOption<Boolean>(false));
2264                 options.addBooleanOption("ClearOnNextRestart", new DefaultOption<Boolean>(false));
2265                 options.addBooleanOption("ReallyClearOnNextRestart", new DefaultOption<Boolean>(false));
2266
2267                 /* read options from configuration. */
2268                 options.getBooleanOption("ClearOnNextRestart").set(configuration.getBooleanValue("Option/ClearOnNextRestart").getValue(null));
2269                 options.getBooleanOption("ReallyClearOnNextRestart").set(configuration.getBooleanValue("Option/ReallyClearOnNextRestart").getValue(null));
2270                 boolean clearConfiguration = options.getBooleanOption("ClearOnNextRestart").get() && options.getBooleanOption("ReallyClearOnNextRestart").get();
2271                 options.getBooleanOption("ClearOnNextRestart").set(null);
2272                 options.getBooleanOption("ReallyClearOnNextRestart").set(null);
2273                 if (clearConfiguration) {
2274                         /* stop loading the configuration. */
2275                         return;
2276                 }
2277
2278                 loadConfigurationValue("InsertionDelay");
2279                 loadConfigurationValue("PostsPerPage");
2280                 loadConfigurationValue("CharactersPerPost");
2281                 loadConfigurationValue("PostCutOffLength");
2282                 options.getBooleanOption("RequireFullAccess").set(configuration.getBooleanValue("Option/RequireFullAccess").getValue(null));
2283                 loadConfigurationValue("PositiveTrust");
2284                 loadConfigurationValue("NegativeTrust");
2285                 options.getStringOption("TrustComment").set(configuration.getStringValue("Option/TrustComment").getValue(null));
2286                 options.getBooleanOption("ActivateFcpInterface").set(configuration.getBooleanValue("Option/ActivateFcpInterface").getValue(null));
2287                 options.getIntegerOption("FcpFullAccessRequired").set(configuration.getIntValue("Option/FcpFullAccessRequired").getValue(null));
2288                 options.getBooleanOption("SoneRescueMode").set(configuration.getBooleanValue("Option/SoneRescueMode").getValue(null));
2289
2290                 /* load known Sones. */
2291                 int soneCounter = 0;
2292                 while (true) {
2293                         String knownSoneId = configuration.getStringValue("KnownSone/" + soneCounter++ + "/ID").getValue(null);
2294                         if (knownSoneId == null) {
2295                                 break;
2296                         }
2297                         synchronized (newSones) {
2298                                 knownSones.add(knownSoneId);
2299                         }
2300                 }
2301
2302                 /* load known posts. */
2303                 int postCounter = 0;
2304                 while (true) {
2305                         String knownPostId = configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").getValue(null);
2306                         if (knownPostId == null) {
2307                                 break;
2308                         }
2309                         synchronized (newPosts) {
2310                                 knownPosts.add(knownPostId);
2311                         }
2312                 }
2313
2314                 /* load known replies. */
2315                 int replyCounter = 0;
2316                 while (true) {
2317                         String knownReplyId = configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").getValue(null);
2318                         if (knownReplyId == null) {
2319                                 break;
2320                         }
2321                         synchronized (newReplies) {
2322                                 knownReplies.add(knownReplyId);
2323                         }
2324                 }
2325
2326                 /* load bookmarked posts. */
2327                 int bookmarkedPostCounter = 0;
2328                 while (true) {
2329                         String bookmarkedPostId = configuration.getStringValue("Bookmarks/Post/" + bookmarkedPostCounter++ + "/ID").getValue(null);
2330                         if (bookmarkedPostId == null) {
2331                                 break;
2332                         }
2333                         synchronized (bookmarkedPosts) {
2334                                 bookmarkedPosts.add(bookmarkedPostId);
2335                         }
2336                 }
2337
2338         }
2339
2340         /**
2341          * Loads an {@link Integer} configuration value for the option with the
2342          * given name, logging validation failures.
2343          *
2344          * @param optionName
2345          *            The name of the option to load
2346          */
2347         private void loadConfigurationValue(String optionName) {
2348                 try {
2349                         options.getIntegerOption(optionName).set(configuration.getIntValue("Option/" + optionName).getValue(null));
2350                 } catch (IllegalArgumentException iae1) {
2351                         logger.log(Level.WARNING, "Invalid value for " + optionName + " in configuration, using default.");
2352                 }
2353         }
2354
2355         /**
2356          * Generate a Sone URI from the given URI and latest edition.
2357          *
2358          * @param uriString
2359          *            The URI to derive the Sone URI from
2360          * @return The derived URI
2361          */
2362         private FreenetURI getSoneUri(String uriString) {
2363                 try {
2364                         FreenetURI uri = new FreenetURI(uriString).setDocName("Sone").setMetaString(new String[0]);
2365                         return uri;
2366                 } catch (MalformedURLException mue1) {
2367                         logger.log(Level.WARNING, "Could not create Sone URI from URI: " + uriString, mue1);
2368                         return null;
2369                 }
2370         }
2371
2372         //
2373         // INTERFACE IdentityListener
2374         //
2375
2376         /**
2377          * {@inheritDoc}
2378          */
2379         @Override
2380         public void ownIdentityAdded(OwnIdentity ownIdentity) {
2381                 logger.log(Level.FINEST, "Adding OwnIdentity: " + ownIdentity);
2382                 if (ownIdentity.hasContext("Sone")) {
2383                         trustedIdentities.put(ownIdentity, Collections.synchronizedSet(new HashSet<Identity>()));
2384                         addLocalSone(ownIdentity);
2385                 }
2386         }
2387
2388         /**
2389          * {@inheritDoc}
2390          */
2391         @Override
2392         public void ownIdentityRemoved(OwnIdentity ownIdentity) {
2393                 logger.log(Level.FINEST, "Removing OwnIdentity: " + ownIdentity);
2394                 trustedIdentities.remove(ownIdentity);
2395         }
2396
2397         /**
2398          * {@inheritDoc}
2399          */
2400         @Override
2401         public void identityAdded(OwnIdentity ownIdentity, Identity identity) {
2402                 logger.log(Level.FINEST, "Adding Identity: " + identity);
2403                 trustedIdentities.get(ownIdentity).add(identity);
2404                 addRemoteSone(identity);
2405         }
2406
2407         /**
2408          * {@inheritDoc}
2409          */
2410         @Override
2411         public void identityUpdated(OwnIdentity ownIdentity, final Identity identity) {
2412                 new Thread(new Runnable() {
2413
2414                         @Override
2415                         @SuppressWarnings("synthetic-access")
2416                         public void run() {
2417                                 Sone sone = getRemoteSone(identity.getId());
2418                                 sone.setIdentity(identity);
2419                                 sone.setLatestEdition(Numbers.safeParseLong(identity.getProperty("Sone.LatestEdition"), sone.getLatestEdition()));
2420                                 soneDownloader.addSone(sone);
2421                                 soneDownloader.fetchSone(sone);
2422                         }
2423                 }).start();
2424         }
2425
2426         /**
2427          * {@inheritDoc}
2428          */
2429         @Override
2430         public void identityRemoved(OwnIdentity ownIdentity, Identity identity) {
2431                 trustedIdentities.get(ownIdentity).remove(identity);
2432                 boolean foundIdentity = false;
2433                 for (Entry<OwnIdentity, Set<Identity>> trustedIdentity : trustedIdentities.entrySet()) {
2434                         if (trustedIdentity.getKey().equals(ownIdentity)) {
2435                                 continue;
2436                         }
2437                         if (trustedIdentity.getValue().contains(identity)) {
2438                                 foundIdentity = true;
2439                         }
2440                 }
2441                 if (foundIdentity) {
2442                         /* some local identity still trusts this identity, don’t remove. */
2443                         return;
2444                 }
2445                 Sone sone = getSone(identity.getId(), false);
2446                 if (sone == null) {
2447                         /* TODO - we don’t have the Sone anymore. should this happen? */
2448                         return;
2449                 }
2450                 synchronized (posts) {
2451                         synchronized (newPosts) {
2452                                 for (Post post : sone.getPosts()) {
2453                                         posts.remove(post.getId());
2454                                         newPosts.remove(post.getId());
2455                                         coreListenerManager.firePostRemoved(post);
2456                                 }
2457                         }
2458                 }
2459                 synchronized (replies) {
2460                         synchronized (newReplies) {
2461                                 for (PostReply reply : sone.getReplies()) {
2462                                         replies.remove(reply.getId());
2463                                         newReplies.remove(reply.getId());
2464                                         coreListenerManager.fireReplyRemoved(reply);
2465                                 }
2466                         }
2467                 }
2468                 synchronized (remoteSones) {
2469                         remoteSones.remove(identity.getId());
2470                 }
2471                 synchronized (newSones) {
2472                         newSones.remove(identity.getId());
2473                         coreListenerManager.fireSoneRemoved(sone);
2474                 }
2475         }
2476
2477         //
2478         // INTERFACE UpdateListener
2479         //
2480
2481         /**
2482          * {@inheritDoc}
2483          */
2484         @Override
2485         public void updateFound(Version version, long releaseTime, long latestEdition) {
2486                 coreListenerManager.fireUpdateFound(version, releaseTime, latestEdition);
2487         }
2488
2489         //
2490         // INTERFACE ImageInsertListener
2491         //
2492
2493         /**
2494          * {@inheritDoc}
2495          */
2496         @Override
2497         public void insertStarted(Sone sone) {
2498                 coreListenerManager.fireSoneInserting(sone);
2499         }
2500
2501         /**
2502          * {@inheritDoc}
2503          */
2504         @Override
2505         public void insertFinished(Sone sone, long insertDuration) {
2506                 coreListenerManager.fireSoneInserted(sone, insertDuration);
2507         }
2508
2509         /**
2510          * {@inheritDoc}
2511          */
2512         @Override
2513         public void insertAborted(Sone sone, Throwable cause) {
2514                 coreListenerManager.fireSoneInsertAborted(sone, cause);
2515         }
2516
2517         //
2518         // SONEINSERTLISTENER METHODS
2519         //
2520
2521         /**
2522          * {@inheritDoc}
2523          */
2524         @Override
2525         public void imageInsertStarted(Image image) {
2526                 logger.log(Level.WARNING, "Image insert started for " + image);
2527                 coreListenerManager.fireImageInsertStarted(image);
2528         }
2529
2530         /**
2531          * {@inheritDoc}
2532          */
2533         @Override
2534         public void imageInsertAborted(Image image) {
2535                 logger.log(Level.WARNING, "Image insert aborted for " + image);
2536                 coreListenerManager.fireImageInsertAborted(image);
2537         }
2538
2539         /**
2540          * {@inheritDoc}
2541          */
2542         @Override
2543         public void imageInsertFinished(Image image, FreenetURI key) {
2544                 logger.log(Level.WARNING, "Image insert finished for " + image + ": " + key);
2545                 image.setKey(key.toString());
2546                 deleteTemporaryImage(image.getId());
2547                 saveSone(image.getSone());
2548                 coreListenerManager.fireImageInsertFinished(image);
2549         }
2550
2551         /**
2552          * {@inheritDoc}
2553          */
2554         @Override
2555         public void imageInsertFailed(Image image, Throwable cause) {
2556                 logger.log(Level.WARNING, "Image insert failed for " + image, cause);
2557                 coreListenerManager.fireImageInsertFailed(image, cause);
2558         }
2559
2560         /**
2561          * Convenience interface for external classes that want to access the core’s
2562          * configuration.
2563          *
2564          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
2565          */
2566         public static class Preferences {
2567
2568                 /** The wrapped options. */
2569                 private final Options options;
2570
2571                 /**
2572                  * Creates a new preferences object wrapped around the given options.
2573                  *
2574                  * @param options
2575                  *            The options to wrap
2576                  */
2577                 public Preferences(Options options) {
2578                         this.options = options;
2579                 }
2580
2581                 /**
2582                  * Returns the insertion delay.
2583                  *
2584                  * @return The insertion delay
2585                  */
2586                 public int getInsertionDelay() {
2587                         return options.getIntegerOption("InsertionDelay").get();
2588                 }
2589
2590                 /**
2591                  * Validates the given insertion delay.
2592                  *
2593                  * @param insertionDelay
2594                  *            The insertion delay to validate
2595                  * @return {@code true} if the given insertion delay was valid, {@code
2596                  *         false} otherwise
2597                  */
2598                 public boolean validateInsertionDelay(Integer insertionDelay) {
2599                         return options.getIntegerOption("InsertionDelay").validate(insertionDelay);
2600                 }
2601
2602                 /**
2603                  * Sets the insertion delay
2604                  *
2605                  * @param insertionDelay
2606                  *            The new insertion delay, or {@code null} to restore it to
2607                  *            the default value
2608                  * @return This preferences
2609                  */
2610                 public Preferences setInsertionDelay(Integer insertionDelay) {
2611                         options.getIntegerOption("InsertionDelay").set(insertionDelay);
2612                         return this;
2613                 }
2614
2615                 /**
2616                  * Returns the number of posts to show per page.
2617                  *
2618                  * @return The number of posts to show per page
2619                  */
2620                 public int getPostsPerPage() {
2621                         return options.getIntegerOption("PostsPerPage").get();
2622                 }
2623
2624                 /**
2625                  * Validates the number of posts per page.
2626                  *
2627                  * @param postsPerPage
2628                  *            The number of posts per page
2629                  * @return {@code true} if the number of posts per page was valid,
2630                  *         {@code false} otherwise
2631                  */
2632                 public boolean validatePostsPerPage(Integer postsPerPage) {
2633                         return options.getIntegerOption("PostsPerPage").validate(postsPerPage);
2634                 }
2635
2636                 /**
2637                  * Sets the number of posts to show per page.
2638                  *
2639                  * @param postsPerPage
2640                  *            The number of posts to show per page
2641                  * @return This preferences object
2642                  */
2643                 public Preferences setPostsPerPage(Integer postsPerPage) {
2644                         options.getIntegerOption("PostsPerPage").set(postsPerPage);
2645                         return this;
2646                 }
2647
2648                 /**
2649                  * Returns the number of characters per post, or <code>-1</code> if the
2650                  * posts should not be cut off.
2651                  *
2652                  * @return The numbers of characters per post
2653                  */
2654                 public int getCharactersPerPost() {
2655                         return options.getIntegerOption("CharactersPerPost").get();
2656                 }
2657
2658                 /**
2659                  * Validates the number of characters per post.
2660                  *
2661                  * @param charactersPerPost
2662                  *            The number of characters per post
2663                  * @return {@code true} if the number of characters per post was valid,
2664                  *         {@code false} otherwise
2665                  */
2666                 public boolean validateCharactersPerPost(Integer charactersPerPost) {
2667                         return options.getIntegerOption("CharactersPerPost").validate(charactersPerPost);
2668                 }
2669
2670                 /**
2671                  * Sets the number of characters per post.
2672                  *
2673                  * @param charactersPerPost
2674                  *            The number of characters per post, or <code>-1</code> to
2675                  *            not cut off the posts
2676                  * @return This preferences objects
2677                  */
2678                 public Preferences setCharactersPerPost(Integer charactersPerPost) {
2679                         options.getIntegerOption("CharactersPerPost").set(charactersPerPost);
2680                         return this;
2681                 }
2682
2683                 /**
2684                  * Returns the number of characters the shortened post should have.
2685                  *
2686                  * @return The number of characters of the snippet
2687                  */
2688                 public int getPostCutOffLength() {
2689                         return options.getIntegerOption("PostCutOffLength").get();
2690                 }
2691
2692                 /**
2693                  * Validates the number of characters after which to cut off the post.
2694                  *
2695                  * @param postCutOffLength
2696                  *            The number of characters of the snippet
2697                  * @return {@code true} if the number of characters of the snippet is
2698                  *         valid, {@code false} otherwise
2699                  */
2700                 public boolean validatePostCutOffLength(Integer postCutOffLength) {
2701                         return options.getIntegerOption("PostCutOffLength").validate(postCutOffLength);
2702                 }
2703
2704                 /**
2705                  * Sets the number of characters the shortened post should have.
2706                  *
2707                  * @param postCutOffLength
2708                  *            The number of characters of the snippet
2709                  * @return This preferences
2710                  */
2711                 public Preferences setPostCutOffLength(Integer postCutOffLength) {
2712                         options.getIntegerOption("PostCutOffLength").set(postCutOffLength);
2713                         return this;
2714                 }
2715
2716                 /**
2717                  * Returns whether Sone requires full access to be even visible.
2718                  *
2719                  * @return {@code true} if Sone requires full access, {@code false}
2720                  *         otherwise
2721                  */
2722                 public boolean isRequireFullAccess() {
2723                         return options.getBooleanOption("RequireFullAccess").get();
2724                 }
2725
2726                 /**
2727                  * Sets whether Sone requires full access to be even visible.
2728                  *
2729                  * @param requireFullAccess
2730                  *            {@code true} if Sone requires full access, {@code false}
2731                  *            otherwise
2732                  */
2733                 public void setRequireFullAccess(Boolean requireFullAccess) {
2734                         options.getBooleanOption("RequireFullAccess").set(requireFullAccess);
2735                 }
2736
2737                 /**
2738                  * Returns the positive trust.
2739                  *
2740                  * @return The positive trust
2741                  */
2742                 public int getPositiveTrust() {
2743                         return options.getIntegerOption("PositiveTrust").get();
2744                 }
2745
2746                 /**
2747                  * Validates the positive trust.
2748                  *
2749                  * @param positiveTrust
2750                  *            The positive trust to validate
2751                  * @return {@code true} if the positive trust was valid, {@code false}
2752                  *         otherwise
2753                  */
2754                 public boolean validatePositiveTrust(Integer positiveTrust) {
2755                         return options.getIntegerOption("PositiveTrust").validate(positiveTrust);
2756                 }
2757
2758                 /**
2759                  * Sets the positive trust.
2760                  *
2761                  * @param positiveTrust
2762                  *            The new positive trust, or {@code null} to restore it to
2763                  *            the default vlaue
2764                  * @return This preferences
2765                  */
2766                 public Preferences setPositiveTrust(Integer positiveTrust) {
2767                         options.getIntegerOption("PositiveTrust").set(positiveTrust);
2768                         return this;
2769                 }
2770
2771                 /**
2772                  * Returns the negative trust.
2773                  *
2774                  * @return The negative trust
2775                  */
2776                 public int getNegativeTrust() {
2777                         return options.getIntegerOption("NegativeTrust").get();
2778                 }
2779
2780                 /**
2781                  * Validates the negative trust.
2782                  *
2783                  * @param negativeTrust
2784                  *            The negative trust to validate
2785                  * @return {@code true} if the negative trust was valid, {@code false}
2786                  *         otherwise
2787                  */
2788                 public boolean validateNegativeTrust(Integer negativeTrust) {
2789                         return options.getIntegerOption("NegativeTrust").validate(negativeTrust);
2790                 }
2791
2792                 /**
2793                  * Sets the negative trust.
2794                  *
2795                  * @param negativeTrust
2796                  *            The negative trust, or {@code null} to restore it to the
2797                  *            default value
2798                  * @return The preferences
2799                  */
2800                 public Preferences setNegativeTrust(Integer negativeTrust) {
2801                         options.getIntegerOption("NegativeTrust").set(negativeTrust);
2802                         return this;
2803                 }
2804
2805                 /**
2806                  * Returns the trust comment. This is the comment that is set in the web
2807                  * of trust when a trust value is assigned to an identity.
2808                  *
2809                  * @return The trust comment
2810                  */
2811                 public String getTrustComment() {
2812                         return options.getStringOption("TrustComment").get();
2813                 }
2814
2815                 /**
2816                  * Sets the trust comment.
2817                  *
2818                  * @param trustComment
2819                  *            The trust comment, or {@code null} to restore it to the
2820                  *            default value
2821                  * @return This preferences
2822                  */
2823                 public Preferences setTrustComment(String trustComment) {
2824                         options.getStringOption("TrustComment").set(trustComment);
2825                         return this;
2826                 }
2827
2828                 /**
2829                  * Returns whether the {@link FcpInterface FCP interface} is currently
2830                  * active.
2831                  *
2832                  * @see FcpInterface#setActive(boolean)
2833                  * @return {@code true} if the FCP interface is currently active,
2834                  *         {@code false} otherwise
2835                  */
2836                 public boolean isFcpInterfaceActive() {
2837                         return options.getBooleanOption("ActivateFcpInterface").get();
2838                 }
2839
2840                 /**
2841                  * Sets whether the {@link FcpInterface FCP interface} is currently
2842                  * active.
2843                  *
2844                  * @see FcpInterface#setActive(boolean)
2845                  * @param fcpInterfaceActive
2846                  *            {@code true} to activate the FCP interface, {@code false}
2847                  *            to deactivate the FCP interface
2848                  * @return This preferences object
2849                  */
2850                 public Preferences setFcpInterfaceActive(boolean fcpInterfaceActive) {
2851                         options.getBooleanOption("ActivateFcpInterface").set(fcpInterfaceActive);
2852                         return this;
2853                 }
2854
2855                 /**
2856                  * Returns the action level for which full access to the FCP interface
2857                  * is required.
2858                  *
2859                  * @return The action level for which full access to the FCP interface
2860                  *         is required
2861                  */
2862                 public FullAccessRequired getFcpFullAccessRequired() {
2863                         return FullAccessRequired.values()[options.getIntegerOption("FcpFullAccessRequired").get()];
2864                 }
2865
2866                 /**
2867                  * Sets the action level for which full access to the FCP interface is
2868                  * required
2869                  *
2870                  * @param fcpFullAccessRequired
2871                  *            The action level
2872                  * @return This preferences
2873                  */
2874                 public Preferences setFcpFullAccessRequired(FullAccessRequired fcpFullAccessRequired) {
2875                         options.getIntegerOption("FcpFullAccessRequired").set((fcpFullAccessRequired != null) ? fcpFullAccessRequired.ordinal() : null);
2876                         return this;
2877                 }
2878
2879                 /**
2880                  * Returns whether Sone should clear its settings on the next restart.
2881                  * In order to be effective, {@link #isReallyClearOnNextRestart()} needs
2882                  * to return {@code true} as well!
2883                  *
2884                  * @return {@code true} if Sone should clear its settings on the next
2885                  *         restart, {@code false} otherwise
2886                  */
2887                 public boolean isClearOnNextRestart() {
2888                         return options.getBooleanOption("ClearOnNextRestart").get();
2889                 }
2890
2891                 /**
2892                  * Sets whether Sone will clear its settings on the next restart.
2893                  *
2894                  * @param clearOnNextRestart
2895                  *            {@code true} if Sone should clear its settings on the next
2896                  *            restart, {@code false} otherwise
2897                  * @return This preferences
2898                  */
2899                 public Preferences setClearOnNextRestart(Boolean clearOnNextRestart) {
2900                         options.getBooleanOption("ClearOnNextRestart").set(clearOnNextRestart);
2901                         return this;
2902                 }
2903
2904                 /**
2905                  * Returns whether Sone should really clear its settings on next
2906                  * restart. This is a confirmation option that needs to be set in
2907                  * addition to {@link #isClearOnNextRestart()} in order to clear Sone’s
2908                  * settings on the next restart.
2909                  *
2910                  * @return {@code true} if Sone should really clear its settings on the
2911                  *         next restart, {@code false} otherwise
2912                  */
2913                 public boolean isReallyClearOnNextRestart() {
2914                         return options.getBooleanOption("ReallyClearOnNextRestart").get();
2915                 }
2916
2917                 /**
2918                  * Sets whether Sone should really clear its settings on the next
2919                  * restart.
2920                  *
2921                  * @param reallyClearOnNextRestart
2922                  *            {@code true} if Sone should really clear its settings on
2923                  *            the next restart, {@code false} otherwise
2924                  * @return This preferences
2925                  */
2926                 public Preferences setReallyClearOnNextRestart(Boolean reallyClearOnNextRestart) {
2927                         options.getBooleanOption("ReallyClearOnNextRestart").set(reallyClearOnNextRestart);
2928                         return this;
2929                 }
2930
2931         }
2932
2933 }