A Sone is only new if it has no request URI.
[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.logging.Level;
29 import java.util.logging.Logger;
30
31 import net.pterodactylus.sone.core.Options.DefaultOption;
32 import net.pterodactylus.sone.core.Options.Option;
33 import net.pterodactylus.sone.core.Options.OptionWatcher;
34 import net.pterodactylus.sone.data.Post;
35 import net.pterodactylus.sone.data.Profile;
36 import net.pterodactylus.sone.data.Reply;
37 import net.pterodactylus.sone.data.Sone;
38 import net.pterodactylus.sone.freenet.wot.Identity;
39 import net.pterodactylus.sone.freenet.wot.IdentityListener;
40 import net.pterodactylus.sone.freenet.wot.IdentityManager;
41 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
42 import net.pterodactylus.util.config.Configuration;
43 import net.pterodactylus.util.config.ConfigurationException;
44 import net.pterodactylus.util.logging.Logging;
45 import net.pterodactylus.util.number.Numbers;
46 import freenet.keys.FreenetURI;
47
48 /**
49  * The Sone core.
50  *
51  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
52  */
53 public class Core implements IdentityListener {
54
55         /**
56          * Enumeration for the possible states of a {@link Sone}.
57          *
58          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
59          */
60         public enum SoneStatus {
61
62                 /** The Sone is unknown, i.e. not yet downloaded. */
63                 unknown,
64
65                 /** The Sone is idle, i.e. not being downloaded or inserted. */
66                 idle,
67
68                 /** The Sone is currently being inserted. */
69                 inserting,
70
71                 /** The Sone is currently being downloaded. */
72                 downloading,
73         }
74
75         /** The logger. */
76         private static final Logger logger = Logging.getLogger(Core.class);
77
78         /** The options. */
79         private final Options options = new Options();
80
81         /** The configuration. */
82         private final Configuration configuration;
83
84         /** The identity manager. */
85         private final IdentityManager identityManager;
86
87         /** Interface to freenet. */
88         private final FreenetInterface freenetInterface;
89
90         /** The Sone downloader. */
91         private final SoneDownloader soneDownloader;
92
93         /** The Sones’ statuses. */
94         /* synchronize access on itself. */
95         private final Map<Sone, SoneStatus> soneStatuses = new HashMap<Sone, SoneStatus>();
96
97         /** Sone inserters. */
98         /* synchronize access on this on localSones. */
99         private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
100
101         /** All local Sones. */
102         /* synchronize access on this on itself. */
103         private Map<String, Sone> localSones = new HashMap<String, Sone>();
104
105         /** All remote Sones. */
106         /* synchronize access on this on itself. */
107         private Map<String, Sone> remoteSones = new HashMap<String, Sone>();
108
109         /** All new Sones. */
110         private Set<Sone> newSones = new HashSet<Sone>();
111
112         /** All posts. */
113         private Map<String, Post> posts = new HashMap<String, Post>();
114
115         /** All replies. */
116         private Map<String, Reply> replies = new HashMap<String, Reply>();
117
118         /**
119          * Creates a new core.
120          *
121          * @param configuration
122          *            The configuration of the core
123          * @param freenetInterface
124          *            The freenet interface
125          * @param identityManager
126          *            The identity manager
127          */
128         public Core(Configuration configuration, FreenetInterface freenetInterface, IdentityManager identityManager) {
129                 this.configuration = configuration;
130                 this.freenetInterface = freenetInterface;
131                 this.identityManager = identityManager;
132                 this.soneDownloader = new SoneDownloader(this, freenetInterface);
133         }
134
135         //
136         // ACCESSORS
137         //
138
139         /**
140          * Returns the options used by the core.
141          *
142          * @return The options of the core
143          */
144         public Options getOptions() {
145                 return options;
146         }
147
148         /**
149          * Returns the identity manager used by the core.
150          *
151          * @return The identity manager
152          */
153         public IdentityManager getIdentityManager() {
154                 return identityManager;
155         }
156
157         /**
158          * Returns the status of the given Sone.
159          *
160          * @param sone
161          *            The Sone to get the status for
162          * @return The status of the Sone
163          */
164         public SoneStatus getSoneStatus(Sone sone) {
165                 synchronized (soneStatuses) {
166                         return soneStatuses.get(sone);
167                 }
168         }
169
170         /**
171          * Sets the status of the given Sone.
172          *
173          * @param sone
174          *            The Sone to set the status of
175          * @param soneStatus
176          *            The status to set
177          */
178         public void setSoneStatus(Sone sone, SoneStatus soneStatus) {
179                 synchronized (soneStatuses) {
180                         soneStatuses.put(sone, soneStatus);
181                 }
182         }
183
184         /**
185          * Returns all Sones, remote and local.
186          *
187          * @return All Sones
188          */
189         public Set<Sone> getSones() {
190                 Set<Sone> allSones = new HashSet<Sone>();
191                 allSones.addAll(getLocalSones());
192                 allSones.addAll(getRemoteSones());
193                 return allSones;
194         }
195
196         /**
197          * Returns the Sone with the given ID, regardless whether it’s local or
198          * remote.
199          *
200          * @param id
201          *            The ID of the Sone to get
202          * @return The Sone with the given ID, or {@code null} if there is no such
203          *         Sone
204          */
205         public Sone getSone(String id) {
206                 if (isLocalSone(id)) {
207                         return getLocalSone(id);
208                 }
209                 return getRemoteSone(id);
210         }
211
212         /**
213          * Returns whether the given Sone is a local Sone.
214          *
215          * @param sone
216          *            The Sone to check for its locality
217          * @return {@code true} if the given Sone is local, {@code false} otherwise
218          */
219         public boolean isLocalSone(Sone sone) {
220                 synchronized (localSones) {
221                         return localSones.containsKey(sone.getId());
222                 }
223         }
224
225         /**
226          * Returns whether the given ID is the ID of a local Sone.
227          *
228          * @param id
229          *            The Sone ID to check for its locality
230          * @return {@code true} if the given ID is a local Sone, {@code false}
231          *         otherwise
232          */
233         public boolean isLocalSone(String id) {
234                 synchronized (localSones) {
235                         return localSones.containsKey(id);
236                 }
237         }
238
239         /**
240          * Returns all local Sones.
241          *
242          * @return All local Sones
243          */
244         public Set<Sone> getLocalSones() {
245                 synchronized (localSones) {
246                         return new HashSet<Sone>(localSones.values());
247                 }
248         }
249
250         /**
251          * Returns the local Sone with the given ID.
252          *
253          * @param id
254          *            The ID of the Sone to get
255          * @return The Sone with the given ID
256          */
257         public Sone getLocalSone(String id) {
258                 synchronized (localSones) {
259                         Sone sone = localSones.get(id);
260                         if (sone == null) {
261                                 sone = new Sone(id);
262                                 localSones.put(id, sone);
263                         }
264                         return sone;
265                 }
266         }
267
268         /**
269          * Returns all remote Sones.
270          *
271          * @return All remote Sones
272          */
273         public Set<Sone> getRemoteSones() {
274                 synchronized (remoteSones) {
275                         return new HashSet<Sone>(remoteSones.values());
276                 }
277         }
278
279         /**
280          * Returns the remote Sone with the given ID.
281          *
282          * @param id
283          *            The ID of the remote Sone to get
284          * @return The Sone with the given ID
285          */
286         public Sone getRemoteSone(String id) {
287                 synchronized (remoteSones) {
288                         Sone sone = remoteSones.get(id);
289                         if (sone == null) {
290                                 sone = new Sone(id);
291                                 remoteSones.put(id, sone);
292                         }
293                         return sone;
294                 }
295         }
296
297         /**
298          * Returns whether the given Sone is a remote Sone.
299          *
300          * @param sone
301          *            The Sone to check
302          * @return {@code true} if the given Sone is a remote Sone, {@code false}
303          *         otherwise
304          */
305         public boolean isRemoteSone(Sone sone) {
306                 synchronized (remoteSones) {
307                         return remoteSones.containsKey(sone.getId());
308                 }
309         }
310
311         /**
312          * Returns whether the Sone with the given ID is a remote Sone.
313          *
314          * @param id
315          *            The ID of the Sone to check
316          * @return {@code true} if the Sone with the given ID is a remote Sone,
317          *         {@code false} otherwise
318          */
319         public boolean isRemoteSone(String id) {
320                 synchronized (remoteSones) {
321                         return remoteSones.containsKey(id);
322                 }
323         }
324
325         /**
326          * Returns whether the given Sone is a new Sone. After this check, the Sone
327          * is marked as known, i.e. a second call with the same parameters will
328          * always yield {@code false}.
329          *
330          * @param sone
331          *            The sone to check for
332          * @return {@code true} if the given Sone is new, false otherwise
333          */
334         public boolean isNewSone(Sone sone) {
335                 synchronized (newSones) {
336                         return newSones.remove(sone);
337                 }
338         }
339
340         /**
341          * Returns the post with the given ID.
342          *
343          * @param postId
344          *            The ID of the post to get
345          * @return The post, or {@code null} if there is no such post
346          */
347         public Post getPost(String postId) {
348                 synchronized (posts) {
349                         Post post = posts.get(postId);
350                         if (post == null) {
351                                 post = new Post(postId);
352                                 posts.put(postId, post);
353                         }
354                         return post;
355                 }
356         }
357
358         /**
359          * Returns the reply with the given ID.
360          *
361          * @param replyId
362          *            The ID of the reply to get
363          * @return The reply, or {@code null} if there is no such reply
364          */
365         public Reply getReply(String replyId) {
366                 synchronized (replies) {
367                         Reply reply = replies.get(replyId);
368                         if (reply == null) {
369                                 reply = new Reply(replyId);
370                                 replies.put(replyId, reply);
371                         }
372                         return reply;
373                 }
374         }
375
376         /**
377          * Returns all replies for the given post, order ascending by time.
378          *
379          * @param post
380          *            The post to get all replies for
381          * @return All replies for the given post
382          */
383         public List<Reply> getReplies(Post post) {
384                 Set<Sone> sones = getSones();
385                 List<Reply> replies = new ArrayList<Reply>();
386                 for (Sone sone : sones) {
387                         for (Reply reply : sone.getReplies()) {
388                                 if (reply.getPost().equals(post)) {
389                                         replies.add(reply);
390                                 }
391                         }
392                 }
393                 Collections.sort(replies, Reply.TIME_COMPARATOR);
394                 return replies;
395         }
396
397         /**
398          * Returns all Sones that have liked the given post.
399          *
400          * @param post
401          *            The post to get the liking Sones for
402          * @return The Sones that like the given post
403          */
404         public Set<Sone> getLikes(Post post) {
405                 Set<Sone> sones = new HashSet<Sone>();
406                 for (Sone sone : getSones()) {
407                         if (sone.getLikedPostIds().contains(post.getId())) {
408                                 sones.add(sone);
409                         }
410                 }
411                 return sones;
412         }
413
414         /**
415          * Returns all Sones that have liked the given reply.
416          *
417          * @param reply
418          *            The reply to get the liking Sones for
419          * @return The Sones that like the given reply
420          */
421         public Set<Sone> getLikes(Reply reply) {
422                 Set<Sone> sones = new HashSet<Sone>();
423                 for (Sone sone : getSones()) {
424                         if (sone.getLikedReplyIds().contains(reply.getId())) {
425                                 sones.add(sone);
426                         }
427                 }
428                 return sones;
429         }
430
431         //
432         // ACTIONS
433         //
434
435         /**
436          * Adds a local Sone from the given ID which has to be the ID of an own
437          * identity.
438          *
439          * @param id
440          *            The ID of an own identity to add a Sone for
441          * @return The added (or already existing) Sone
442          */
443         public Sone addLocalSone(String id) {
444                 synchronized (localSones) {
445                         if (localSones.containsKey(id)) {
446                                 logger.log(Level.FINE, "Tried to add known local Sone: %s", id);
447                                 return localSones.get(id);
448                         }
449                         OwnIdentity ownIdentity = identityManager.getOwnIdentity(id);
450                         if (ownIdentity == null) {
451                                 logger.log(Level.INFO, "Invalid Sone ID: %s", id);
452                                 return null;
453                         }
454                         return addLocalSone(ownIdentity);
455                 }
456         }
457
458         /**
459          * Adds a local Sone from the given own identity.
460          *
461          * @param ownIdentity
462          *            The own identity to create a Sone from
463          * @return The added (or already existing) Sone
464          */
465         public Sone addLocalSone(OwnIdentity ownIdentity) {
466                 if (ownIdentity == null) {
467                         logger.log(Level.WARNING, "Given OwnIdentity is null!");
468                         return null;
469                 }
470                 synchronized (localSones) {
471                         final Sone sone;
472                         try {
473                                 sone = getLocalSone(ownIdentity.getId()).setIdentity(ownIdentity).setInsertUri(new FreenetURI(ownIdentity.getInsertUri())).setRequestUri(new FreenetURI(ownIdentity.getRequestUri()));
474                                 sone.setLatestEdition(Numbers.safeParseLong(ownIdentity.getProperty("Sone.LatestEdition"), (long) 0));
475                         } catch (MalformedURLException mue1) {
476                                 logger.log(Level.SEVERE, "Could not convert the Identity’s URIs to Freenet URIs: " + ownIdentity.getInsertUri() + ", " + ownIdentity.getRequestUri(), mue1);
477                                 return null;
478                         }
479                         /* TODO - load posts ’n stuff */
480                         localSones.put(ownIdentity.getId(), sone);
481                         SoneInserter soneInserter = new SoneInserter(this, freenetInterface, sone);
482                         soneInserters.put(sone, soneInserter);
483                         soneInserter.start();
484                         setSoneStatus(sone, SoneStatus.idle);
485                         loadSone(sone);
486                         new Thread(new Runnable() {
487
488                                 @Override
489                                 @SuppressWarnings("synthetic-access")
490                                 public void run() {
491                                         soneDownloader.fetchSone(sone);
492                                 }
493
494                         }, "Sone Downloader").start();
495                         return sone;
496                 }
497         }
498
499         /**
500          * Creates a new Sone for the given own identity.
501          *
502          * @param ownIdentity
503          *            The own identity to create a Sone for
504          * @return The created Sone
505          */
506         public Sone createSone(OwnIdentity ownIdentity) {
507                 identityManager.addContext(ownIdentity, "Sone");
508                 Sone sone = addLocalSone(ownIdentity);
509                 synchronized (sone) {
510                         /* mark as modified so that it gets inserted immediately. */
511                         sone.setModificationCounter(sone.getModificationCounter() + 1);
512                 }
513                 return sone;
514         }
515
516         /**
517          * Adds the Sone of the given identity.
518          *
519          * @param identity
520          *            The identity whose Sone to add
521          * @return The added or already existing Sone
522          */
523         public Sone addRemoteSone(Identity identity) {
524                 if (identity == null) {
525                         logger.log(Level.WARNING, "Given Identity is null!");
526                         return null;
527                 }
528                 synchronized (remoteSones) {
529                         boolean newSone = !isRemoteSone(identity.getId());
530                         final Sone sone = getRemoteSone(identity.getId()).setIdentity(identity);
531                         newSone &= sone.getRequestUri() == null;
532                         sone.setRequestUri(getSoneUri(identity.getRequestUri()));
533                         sone.setLatestEdition(Numbers.safeParseLong(identity.getProperty("Sone.LatestEdition"), (long) 0));
534                         if (newSone) {
535                                 synchronized (newSones) {
536                                         newSones.add(sone);
537                                 }
538                         }
539                         remoteSones.put(identity.getId(), sone);
540                         soneDownloader.addSone(sone);
541                         setSoneStatus(sone, SoneStatus.unknown);
542                         new Thread(new Runnable() {
543
544                                 @Override
545                                 @SuppressWarnings("synthetic-access")
546                                 public void run() {
547                                         soneDownloader.fetchSone(sone);
548                                 }
549
550                         }, "Sone Downloader").start();
551                         return sone;
552                 }
553         }
554
555         /**
556          * Updates the stores Sone with the given Sone.
557          *
558          * @param sone
559          *            The updated Sone
560          */
561         public void updateSone(Sone sone) {
562                 if (isRemoteSone(sone)) {
563                         Sone storedSone = getRemoteSone(sone.getId());
564                         if (!(sone.getTime() > storedSone.getTime())) {
565                                 logger.log(Level.FINE, "Downloaded Sone %s is not newer than stored Sone %s.", new Object[] { sone, storedSone });
566                                 return;
567                         }
568                         synchronized (posts) {
569                                 for (Post post : storedSone.getPosts()) {
570                                         posts.remove(post.getId());
571                                 }
572                                 for (Post post : sone.getPosts()) {
573                                         posts.put(post.getId(), post);
574                                 }
575                         }
576                         synchronized (replies) {
577                                 for (Reply reply : storedSone.getReplies()) {
578                                         replies.remove(reply.getId());
579                                 }
580                                 for (Reply reply : sone.getReplies()) {
581                                         replies.put(reply.getId(), reply);
582                                 }
583                         }
584                         synchronized (storedSone) {
585                                 storedSone.setTime(sone.getTime());
586                                 storedSone.setProfile(sone.getProfile());
587                                 storedSone.setPosts(sone.getPosts());
588                                 storedSone.setReplies(sone.getReplies());
589                                 storedSone.setLikePostIds(sone.getLikedPostIds());
590                                 storedSone.setLikeReplyIds(sone.getLikedReplyIds());
591                                 storedSone.setLatestEdition(sone.getRequestUri().getEdition());
592                                 storedSone.setModificationCounter(0);
593                         }
594                 }
595         }
596
597         /**
598          * Deletes the given Sone. This will remove the Sone from the
599          * {@link #getLocalSone(String) local Sones}, stops its {@link SoneInserter}
600          * and remove the context from its identity.
601          *
602          * @param sone
603          *            The Sone to delete
604          */
605         public void deleteSone(Sone sone) {
606                 if (!(sone.getIdentity() instanceof OwnIdentity)) {
607                         logger.log(Level.WARNING, "Tried to delete Sone of non-own identity: %s", sone);
608                         return;
609                 }
610                 synchronized (localSones) {
611                         if (!localSones.containsKey(sone.getId())) {
612                                 logger.log(Level.WARNING, "Tried to delete non-local Sone: %s", sone);
613                                 return;
614                         }
615                         localSones.remove(sone.getId());
616                         soneInserters.remove(sone).stop();
617                 }
618                 identityManager.removeContext((OwnIdentity) sone.getIdentity(), "Sone");
619                 identityManager.removeProperty((OwnIdentity) sone.getIdentity(), "Sone.LatestEdition");
620                 try {
621                         configuration.getLongValue("Sone/" + sone.getId() + "/Time").setValue(null);
622                 } catch (ConfigurationException ce1) {
623                         logger.log(Level.WARNING, "Could not remove Sone from configuration!", ce1);
624                 }
625         }
626
627         /**
628          * Loads and updates the given Sone from the configuration. If any error is
629          * encountered, loading is aborted and the given Sone is not changed.
630          *
631          * @param sone
632          *            The Sone to load and update
633          */
634         public void loadSone(Sone sone) {
635                 if (!isLocalSone(sone)) {
636                         logger.log(Level.FINE, "Tried to load non-local Sone: %s", sone);
637                         return;
638                 }
639
640                 /* load Sone. */
641                 String sonePrefix = "Sone/" + sone.getId();
642                 Long soneTime = configuration.getLongValue(sonePrefix + "/Time").getValue(null);
643                 if (soneTime == null) {
644                         logger.log(Level.INFO, "Could not load Sone because no Sone has been saved.");
645                         return;
646                 }
647                 long soneModificationCounter = configuration.getLongValue(sonePrefix + "/ModificationCounter").getValue((long) 0);
648
649                 /* load profile. */
650                 Profile profile = new Profile();
651                 profile.setFirstName(configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null));
652                 profile.setMiddleName(configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null));
653                 profile.setLastName(configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null));
654                 profile.setBirthDay(configuration.getIntValue(sonePrefix + "/Profile/BirthDay").getValue(null));
655                 profile.setBirthMonth(configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").getValue(null));
656                 profile.setBirthYear(configuration.getIntValue(sonePrefix + "/Profile/BirthYear").getValue(null));
657
658                 /* load posts. */
659                 Set<Post> posts = new HashSet<Post>();
660                 while (true) {
661                         String postPrefix = sonePrefix + "/Posts/" + posts.size();
662                         String postId = configuration.getStringValue(postPrefix + "/ID").getValue(null);
663                         if (postId == null) {
664                                 break;
665                         }
666                         long postTime = configuration.getLongValue(postPrefix + "/Time").getValue((long) 0);
667                         String postText = configuration.getStringValue(postPrefix + "/Text").getValue(null);
668                         if ((postTime == 0) || (postText == null)) {
669                                 logger.log(Level.WARNING, "Invalid post found, aborting load!");
670                                 return;
671                         }
672                         posts.add(getPost(postId).setSone(sone).setTime(postTime).setText(postText));
673                 }
674
675                 /* load replies. */
676                 Set<Reply> replies = new HashSet<Reply>();
677                 while (true) {
678                         String replyPrefix = sonePrefix + "/Replies/" + replies.size();
679                         String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
680                         if (replyId == null) {
681                                 break;
682                         }
683                         String postId = configuration.getStringValue(replyPrefix + "/Post/ID").getValue(null);
684                         long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue((long) 0);
685                         String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
686                         if ((postId == null) || (replyTime == 0) || (replyText == null)) {
687                                 logger.log(Level.WARNING, "Invalid reply found, aborting load!");
688                                 return;
689                         }
690                         replies.add(getReply(replyId).setSone(sone).setPost(getPost(postId)).setTime(replyTime).setText(replyText));
691                 }
692
693                 /* load post likes. */
694                 Set<String> likedPostIds = new HashSet<String>();
695                 while (true) {
696                         String likedPostId = configuration.getStringValue(sonePrefix + "/Likes/Post/" + likedPostIds.size() + "/ID").getValue(null);
697                         if (likedPostId == null) {
698                                 break;
699                         }
700                         likedPostIds.add(likedPostId);
701                 }
702
703                 /* load reply likes. */
704                 Set<String> likedReplyIds = new HashSet<String>();
705                 while (true) {
706                         String likedReplyId = configuration.getStringValue(sonePrefix + "/Likes/Reply/" + likedReplyIds.size() + "/ID").getValue(null);
707                         if (likedReplyId == null) {
708                                 break;
709                         }
710                         likedReplyIds.add(likedReplyId);
711                 }
712
713                 /* load friends. */
714                 Set<Sone> friends = new HashSet<Sone>();
715                 while (true) {
716                         String friendId = configuration.getStringValue(sonePrefix + "/Friends/" + friends.size() + "/ID").getValue(null);
717                         if (friendId == null) {
718                                 break;
719                         }
720                         Boolean friendLocal = configuration.getBooleanValue(sonePrefix + "/Friends/" + friends.size() + "/Local").getValue(null);
721                         if (friendLocal == null) {
722                                 logger.log(Level.WARNING, "Invalid friend found, aborting load!");
723                                 return;
724                         }
725                         friends.add(friendLocal ? getLocalSone(friendId) : getRemoteSone(friendId));
726                 }
727
728                 /* if we’re still here, Sone was loaded successfully. */
729                 synchronized (sone) {
730                         sone.setTime(soneTime);
731                         sone.setProfile(profile);
732                         sone.setPosts(posts);
733                         sone.setReplies(replies);
734                         sone.setLikePostIds(likedPostIds);
735                         sone.setLikeReplyIds(likedReplyIds);
736                         sone.setFriends(friends);
737                         sone.setModificationCounter(soneModificationCounter);
738                 }
739         }
740
741         /**
742          * Saves the given Sone. This will persist all local settings for the given
743          * Sone, such as the friends list and similar, private options.
744          *
745          * @param sone
746          *            The Sone to save
747          */
748         public void saveSone(Sone sone) {
749                 if (!isLocalSone(sone)) {
750                         logger.log(Level.FINE, "Tried to save non-local Sone: %s", sone);
751                         return;
752                 }
753                 if (!(sone.getIdentity() instanceof OwnIdentity)) {
754                         logger.log(Level.WARNING, "Local Sone without OwnIdentity found, refusing to save: %s", sone);
755                         return;
756                 }
757
758                 logger.log(Level.INFO, "Saving Sone: %s", sone);
759                 identityManager.setProperty((OwnIdentity) sone.getIdentity(), "Sone.LatestEdition", String.valueOf(sone.getLatestEdition()));
760                 try {
761                         /* save Sone into configuration. */
762                         String sonePrefix = "Sone/" + sone.getId();
763                         configuration.getLongValue(sonePrefix + "/Time").setValue(sone.getTime());
764                         configuration.getLongValue(sonePrefix + "/ModificationCounter").setValue(sone.getModificationCounter());
765
766                         /* save profile. */
767                         Profile profile = sone.getProfile();
768                         configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
769                         configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
770                         configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
771                         configuration.getIntValue(sonePrefix + "/Profile/BirthDay").setValue(profile.getBirthDay());
772                         configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").setValue(profile.getBirthMonth());
773                         configuration.getIntValue(sonePrefix + "/Profile/BirthYear").setValue(profile.getBirthYear());
774
775                         /* save posts. */
776                         int postCounter = 0;
777                         for (Post post : sone.getPosts()) {
778                                 String postPrefix = sonePrefix + "/Posts/" + postCounter++;
779                                 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
780                                 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
781                                 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
782                         }
783                         configuration.getStringValue(sonePrefix + "/Posts/" + postCounter + "/ID").setValue(null);
784
785                         /* save replies. */
786                         int replyCounter = 0;
787                         for (Reply reply : sone.getReplies()) {
788                                 String replyPrefix = sonePrefix + "/Replies/" + replyCounter++;
789                                 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
790                                 configuration.getStringValue(replyPrefix + "/Post/ID").setValue(reply.getPost().getId());
791                                 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
792                                 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
793                         }
794                         configuration.getStringValue(sonePrefix + "/Replies/" + replyCounter + "/ID").setValue(null);
795
796                         /* save post likes. */
797                         int postLikeCounter = 0;
798                         for (String postId : sone.getLikedPostIds()) {
799                                 configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter++ + "/ID").setValue(postId);
800                         }
801                         configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter + "/ID").setValue(null);
802
803                         /* save reply likes. */
804                         int replyLikeCounter = 0;
805                         for (String replyId : sone.getLikedReplyIds()) {
806                                 configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter++ + "/ID").setValue(replyId);
807                         }
808                         configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter + "/ID").setValue(null);
809
810                         /* save friends. */
811                         int friendCounter = 0;
812                         for (Sone friend : sone.getFriends()) {
813                                 configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter + "/ID").setValue(friend.getId());
814                                 configuration.getBooleanValue(sonePrefix + "/Friends/" + friendCounter++ + "/Local").setValue(friend.getInsertUri() != null);
815                         }
816                         configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter + "/ID").setValue(null);
817
818                         logger.log(Level.INFO, "Sone %s saved.", sone);
819                 } catch (ConfigurationException ce1) {
820                         logger.log(Level.WARNING, "Could not save Sone: " + sone, ce1);
821                 }
822         }
823
824         /**
825          * Creates a new post.
826          *
827          * @param sone
828          *            The Sone that creates the post
829          * @param text
830          *            The text of the post
831          */
832         public void createPost(Sone sone, String text) {
833                 createPost(sone, System.currentTimeMillis(), text);
834         }
835
836         /**
837          * Creates a new post.
838          *
839          * @param sone
840          *            The Sone that creates the post
841          * @param time
842          *            The time of the post
843          * @param text
844          *            The text of the post
845          */
846         public void createPost(Sone sone, long time, String text) {
847                 if (!isLocalSone(sone)) {
848                         logger.log(Level.FINE, "Tried to create post for non-local Sone: %s", sone);
849                         return;
850                 }
851                 Post post = new Post(sone, time, text);
852                 synchronized (posts) {
853                         posts.put(post.getId(), post);
854                 }
855                 sone.addPost(post);
856                 saveSone(sone);
857         }
858
859         /**
860          * Deletes the given post.
861          *
862          * @param post
863          *            The post to delete
864          */
865         public void deletePost(Post post) {
866                 if (!isLocalSone(post.getSone())) {
867                         logger.log(Level.WARNING, "Tried to delete post of non-local Sone: %s", post.getSone());
868                         return;
869                 }
870                 post.getSone().removePost(post);
871                 synchronized (posts) {
872                         posts.remove(post.getId());
873                 }
874                 saveSone(post.getSone());
875         }
876
877         /**
878          * Creates a new reply.
879          *
880          * @param sone
881          *            The Sone that creates the reply
882          * @param post
883          *            The post that this reply refers to
884          * @param text
885          *            The text of the reply
886          */
887         public void createReply(Sone sone, Post post, String text) {
888                 createReply(sone, post, System.currentTimeMillis(), text);
889         }
890
891         /**
892          * Creates a new reply.
893          *
894          * @param sone
895          *            The Sone that creates the reply
896          * @param post
897          *            The post that this reply refers to
898          * @param time
899          *            The time of the reply
900          * @param text
901          *            The text of the reply
902          */
903         public void createReply(Sone sone, Post post, long time, String text) {
904                 if (!isLocalSone(sone)) {
905                         logger.log(Level.FINE, "Tried to create reply for non-local Sone: %s", sone);
906                         return;
907                 }
908                 Reply reply = new Reply(sone, post, System.currentTimeMillis(), text);
909                 synchronized (replies) {
910                         replies.put(reply.getId(), reply);
911                 }
912                 sone.addReply(reply);
913                 saveSone(sone);
914         }
915
916         /**
917          * Deletes the given reply.
918          *
919          * @param reply
920          *            The reply to delete
921          */
922         public void deleteReply(Reply reply) {
923                 Sone sone = reply.getSone();
924                 if (!isLocalSone(sone)) {
925                         logger.log(Level.FINE, "Tried to delete non-local reply: %s", reply);
926                         return;
927                 }
928                 synchronized (replies) {
929                         replies.remove(reply.getId());
930                 }
931                 sone.removeReply(reply);
932                 saveSone(sone);
933         }
934
935         /**
936          * Starts the core.
937          */
938         public void start() {
939                 loadConfiguration();
940         }
941
942         /**
943          * Stops the core.
944          */
945         public void stop() {
946                 synchronized (localSones) {
947                         for (SoneInserter soneInserter : soneInserters.values()) {
948                                 soneInserter.stop();
949                         }
950                 }
951                 saveConfiguration();
952         }
953
954         //
955         // PRIVATE METHODS
956         //
957
958         /**
959          * Loads the configuration.
960          */
961         @SuppressWarnings("unchecked")
962         private void loadConfiguration() {
963                 /* create options. */
964                 options.addIntegerOption("InsertionDelay", new DefaultOption<Integer>(60, new OptionWatcher<Integer>() {
965
966                         @Override
967                         public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
968                                 SoneInserter.setInsertionDelay(newValue);
969                         }
970
971                 }));
972                 options.addBooleanOption("ClearOnNextRestart", new DefaultOption<Boolean>(false));
973                 options.addBooleanOption("ReallyClearOnNextRestart", new DefaultOption<Boolean>(false));
974
975                 /* read options from configuration. */
976                 options.getBooleanOption("ClearOnNextRestart").set(configuration.getBooleanValue("Option/ClearOnNextRestart").getValue(null));
977                 options.getBooleanOption("ReallyClearOnNextRestart").set(configuration.getBooleanValue("Option/ReallyClearOnNextRestart").getValue(null));
978                 boolean clearConfiguration = options.getBooleanOption("ClearOnNextRestart").get() && options.getBooleanOption("ReallyClearOnNextRestart").get();
979                 options.getBooleanOption("ClearOnNextRestart").set(null);
980                 options.getBooleanOption("ReallyClearOnNextRestart").set(null);
981                 if (clearConfiguration) {
982                         /* stop loading the configuration. */
983                         return;
984                 }
985
986                 options.getIntegerOption("InsertionDelay").set(configuration.getIntValue("Option/InsertionDelay").getValue(null));
987
988         }
989
990         /**
991          * Saves the current options.
992          */
993         private void saveConfiguration() {
994                 /* store the options first. */
995                 try {
996                         configuration.getIntValue("Option/InsertionDelay").setValue(options.getIntegerOption("InsertionDelay").getReal());
997                         configuration.getBooleanValue("Option/ClearOnNextRestart").setValue(options.getBooleanOption("ClearOnNextRestart").getReal());
998                         configuration.getBooleanValue("Option/ReallyClearOnNextRestart").setValue(options.getBooleanOption("ReallyClearOnNextRestart").getReal());
999                 } catch (ConfigurationException ce1) {
1000                         logger.log(Level.SEVERE, "Could not store configuration!", ce1);
1001                 }
1002         }
1003
1004         /**
1005          * Generate a Sone URI from the given URI and latest edition.
1006          *
1007          * @param uriString
1008          *            The URI to derive the Sone URI from
1009          * @return The derived URI
1010          */
1011         private FreenetURI getSoneUri(String uriString) {
1012                 try {
1013                         FreenetURI uri = new FreenetURI(uriString).setDocName("Sone").setMetaString(new String[0]);
1014                         return uri;
1015                 } catch (MalformedURLException mue1) {
1016                         logger.log(Level.WARNING, "Could not create Sone URI from URI: " + uriString, mue1);
1017                         return null;
1018                 }
1019         }
1020
1021         //
1022         // INTERFACE IdentityListener
1023         //
1024
1025         /**
1026          * {@inheritDoc}
1027          */
1028         @Override
1029         public void ownIdentityAdded(OwnIdentity ownIdentity) {
1030                 logger.log(Level.FINEST, "Adding OwnIdentity: " + ownIdentity);
1031                 if (ownIdentity.hasContext("Sone")) {
1032                         addLocalSone(ownIdentity);
1033                 }
1034         }
1035
1036         /**
1037          * {@inheritDoc}
1038          */
1039         @Override
1040         public void ownIdentityRemoved(OwnIdentity ownIdentity) {
1041                 logger.log(Level.FINEST, "Removing OwnIdentity: " + ownIdentity);
1042         }
1043
1044         /**
1045          * {@inheritDoc}
1046          */
1047         @Override
1048         public void identityAdded(Identity identity) {
1049                 logger.log(Level.FINEST, "Adding Identity: " + identity);
1050                 addRemoteSone(identity);
1051         }
1052
1053         /**
1054          * {@inheritDoc}
1055          */
1056         @Override
1057         public void identityUpdated(final Identity identity) {
1058                 new Thread(new Runnable() {
1059
1060                         @Override
1061                         @SuppressWarnings("synthetic-access")
1062                         public void run() {
1063                                 Sone sone = getRemoteSone(identity.getId());
1064                                 soneDownloader.fetchSone(sone);
1065                         }
1066                 }).start();
1067         }
1068
1069         /**
1070          * {@inheritDoc}
1071          */
1072         @Override
1073         public void identityRemoved(Identity identity) {
1074                 /* TODO */
1075         }
1076
1077 }