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