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