2 * Sone - Core.java - Copyright © 2010 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.core;
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;
28 import java.util.logging.Level;
29 import java.util.logging.Logger;
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;
51 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
53 public class Core implements IdentityListener {
56 * Enumeration for the possible states of a {@link Sone}.
58 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
60 public enum SoneStatus {
62 /** The Sone is unknown, i.e. not yet downloaded. */
65 /** The Sone is idle, i.e. not being downloaded or inserted. */
68 /** The Sone is currently being inserted. */
71 /** The Sone is currently being downloaded. */
76 private static final Logger logger = Logging.getLogger(Core.class);
79 private final Options options = new Options();
81 /** The configuration. */
82 private final Configuration configuration;
84 /** The identity manager. */
85 private final IdentityManager identityManager;
87 /** Interface to freenet. */
88 private final FreenetInterface freenetInterface;
90 /** The Sone downloader. */
91 private final SoneDownloader soneDownloader;
93 /** The Sones’ statuses. */
94 /* synchronize access on itself. */
95 private final Map<Sone, SoneStatus> soneStatuses = new HashMap<Sone, SoneStatus>();
97 /** Sone inserters. */
98 /* synchronize access on this on localSones. */
99 private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
101 /** All local Sones. */
102 /* synchronize access on this on itself. */
103 private Map<String, Sone> localSones = new HashMap<String, Sone>();
105 /** All remote Sones. */
106 /* synchronize access on this on itself. */
107 private Map<String, Sone> remoteSones = new HashMap<String, Sone>();
110 private Map<String, Post> posts = new HashMap<String, Post>();
113 private Map<String, Reply> replies = new HashMap<String, Reply>();
116 * Creates a new core.
118 * @param configuration
119 * The configuration of the core
120 * @param freenetInterface
121 * The freenet interface
122 * @param identityManager
123 * The identity manager
125 public Core(Configuration configuration, FreenetInterface freenetInterface, IdentityManager identityManager) {
126 this.configuration = configuration;
127 this.freenetInterface = freenetInterface;
128 this.identityManager = identityManager;
129 this.soneDownloader = new SoneDownloader(this, freenetInterface);
137 * Returns the options used by the core.
139 * @return The options of the core
141 public Options getOptions() {
146 * Returns the identity manager used by the core.
148 * @return The identity manager
150 public IdentityManager getIdentityManager() {
151 return identityManager;
155 * Returns the status of the given Sone.
158 * The Sone to get the status for
159 * @return The status of the Sone
161 public SoneStatus getSoneStatus(Sone sone) {
162 synchronized (soneStatuses) {
163 return soneStatuses.get(sone);
168 * Sets the status of the given Sone.
171 * The Sone to set the status of
175 public void setSoneStatus(Sone sone, SoneStatus soneStatus) {
176 synchronized (soneStatuses) {
177 soneStatuses.put(sone, soneStatus);
182 * Returns all Sones, remote and local.
186 public Set<Sone> getSones() {
187 Set<Sone> allSones = new HashSet<Sone>();
188 allSones.addAll(getLocalSones());
189 allSones.addAll(getRemoteSones());
194 * Returns the Sone with the given ID, regardless whether it’s local or
198 * The ID of the Sone to get
199 * @return The Sone with the given ID, or {@code null} if there is no such
202 public Sone getSone(String id) {
203 if (isLocalSone(id)) {
204 return getLocalSone(id);
206 return getRemoteSone(id);
210 * Returns whether the given Sone is a local Sone.
213 * The Sone to check for its locality
214 * @return {@code true} if the given Sone is local, {@code false} otherwise
216 public boolean isLocalSone(Sone sone) {
217 synchronized (localSones) {
218 return localSones.containsKey(sone.getId());
223 * Returns whether the given ID is the ID of a local Sone.
226 * The Sone ID to check for its locality
227 * @return {@code true} if the given ID is a local Sone, {@code false}
230 public boolean isLocalSone(String id) {
231 synchronized (localSones) {
232 return localSones.containsKey(id);
237 * Returns all local Sones.
239 * @return All local Sones
241 public Set<Sone> getLocalSones() {
242 synchronized (localSones) {
243 return new HashSet<Sone>(localSones.values());
248 * Returns the local Sone with the given ID.
251 * The ID of the Sone to get
252 * @return The Sone with the given ID
254 public Sone getLocalSone(String id) {
255 synchronized (localSones) {
256 Sone sone = localSones.get(id);
259 localSones.put(id, sone);
266 * Returns all remote Sones.
268 * @return All remote Sones
270 public Set<Sone> getRemoteSones() {
271 synchronized (remoteSones) {
272 return new HashSet<Sone>(remoteSones.values());
277 * Returns the remote Sone with the given ID.
280 * The ID of the remote Sone to get
281 * @return The Sone with the given ID
283 public Sone getRemoteSone(String id) {
284 synchronized (remoteSones) {
285 Sone sone = remoteSones.get(id);
288 remoteSones.put(id, sone);
295 * Returns whether the given Sone is a remote Sone.
299 * @return {@code true} if the given Sone is a remote Sone, {@code false}
302 public boolean isRemoteSone(Sone sone) {
303 synchronized (remoteSones) {
304 return remoteSones.containsKey(sone.getId());
309 * Returns the post with the given ID.
312 * The ID of the post to get
313 * @return The post, or {@code null} if there is no such post
315 public Post getPost(String postId) {
316 synchronized (posts) {
317 Post post = posts.get(postId);
319 post = new Post(postId);
320 posts.put(postId, post);
327 * Returns the reply with the given ID.
330 * The ID of the reply to get
331 * @return The reply, or {@code null} if there is no such reply
333 public Reply getReply(String replyId) {
334 synchronized (replies) {
335 Reply reply = replies.get(replyId);
337 reply = new Reply(replyId);
338 replies.put(replyId, reply);
345 * Returns all replies for the given post, order ascending by time.
348 * The post to get all replies for
349 * @return All replies for the given post
351 public List<Reply> getReplies(Post post) {
352 Set<Sone> sones = getSones();
353 List<Reply> replies = new ArrayList<Reply>();
354 for (Sone sone : sones) {
355 for (Reply reply : sone.getReplies()) {
356 if (reply.getPost().equals(post)) {
361 Collections.sort(replies, Reply.TIME_COMPARATOR);
366 * Returns all Sones that have liked the given post.
369 * The post to get the liking Sones for
370 * @return The Sones that like the given post
372 public Set<Sone> getLikes(Post post) {
373 Set<Sone> sones = new HashSet<Sone>();
374 for (Sone sone : getSones()) {
375 if (sone.getLikedPostIds().contains(post.getId())) {
383 * Returns all Sones that have liked the given reply.
386 * The reply to get the liking Sones for
387 * @return The Sones that like the given reply
389 public Set<Sone> getLikes(Reply reply) {
390 Set<Sone> sones = new HashSet<Sone>();
391 for (Sone sone : getSones()) {
392 if (sone.getLikedPostIds().contains(reply.getId())) {
404 * Adds a local Sone from the given ID which has to be the ID of an own
408 * The ID of an own identity to add a Sone for
409 * @return The added (or already existing) Sone
411 public Sone addLocalSone(String id) {
412 synchronized (localSones) {
413 if (localSones.containsKey(id)) {
414 logger.log(Level.FINE, "Tried to add known local Sone: %s", id);
415 return localSones.get(id);
417 OwnIdentity ownIdentity = identityManager.getOwnIdentity(id);
418 if (ownIdentity == null) {
419 logger.log(Level.INFO, "Invalid Sone ID: %s", id);
422 return addLocalSone(ownIdentity);
427 * Adds a local Sone from the given own identity.
430 * The own identity to create a Sone from
431 * @return The added (or already existing) Sone
433 public Sone addLocalSone(OwnIdentity ownIdentity) {
434 if (ownIdentity == null) {
435 logger.log(Level.WARNING, "Given OwnIdentity is null!");
438 synchronized (localSones) {
439 if (localSones.containsKey(ownIdentity.getId())) {
440 logger.log(Level.FINE, "Tried to add known local Sone: %s", ownIdentity);
441 return localSones.get(ownIdentity.getId());
445 sone = getLocalSone(ownIdentity.getId()).setIdentity(ownIdentity).setInsertUri(new FreenetURI(ownIdentity.getInsertUri())).setRequestUri(new FreenetURI(ownIdentity.getRequestUri()));
446 sone.setLatestEdition(Numbers.safeParseLong(ownIdentity.getProperty("Sone.LatestEdition"), (long) 0));
447 } catch (MalformedURLException mue1) {
448 logger.log(Level.SEVERE, "Could not convert the Identity’s URIs to Freenet URIs: " + ownIdentity.getInsertUri() + ", " + ownIdentity.getRequestUri(), mue1);
451 /* TODO - load posts ’n stuff */
452 localSones.put(ownIdentity.getId(), sone);
453 SoneInserter soneInserter = new SoneInserter(this, freenetInterface, sone);
454 soneInserters.put(sone, soneInserter);
455 soneInserter.start();
456 setSoneStatus(sone, SoneStatus.idle);
457 new Thread(new Runnable() {
460 @SuppressWarnings("synthetic-access")
462 soneDownloader.fetchSone(sone);
465 }, "Sone Downloader").start();
471 * Creates a new Sone for the given own identity.
474 * The own identity to create a Sone for
475 * @return The created Sone
477 public Sone createSone(OwnIdentity ownIdentity) {
478 identityManager.addContext(ownIdentity, "Sone");
479 Sone sone = addLocalSone(ownIdentity);
480 synchronized (sone) {
481 /* mark as modified so that it gets inserted immediately. */
482 sone.setModificationCounter(sone.getModificationCounter() + 1);
488 * Adds the Sone of the given identity.
491 * The identity whose Sone to add
492 * @return The added or already existing Sone
494 public Sone addRemoteSone(Identity identity) {
495 if (identity == null) {
496 logger.log(Level.WARNING, "Given Identity is null!");
499 synchronized (remoteSones) {
500 if (remoteSones.containsKey(identity.getId())) {
501 logger.log(Level.FINE, "Identity already exists: %s", identity);
502 return remoteSones.get(identity.getId());
504 Sone sone = new Sone(identity);
505 sone.setRequestUri(getSoneUri(identity.getRequestUri(), identity.getProperty("Sone.LatestEdition")));
506 remoteSones.put(identity.getId(), sone);
507 soneDownloader.addSone(sone);
508 setSoneStatus(sone, SoneStatus.idle);
514 * Updates the stores Sone with the given Sone.
519 public void updateSone(Sone sone) {
520 if (isRemoteSone(sone)) {
521 Sone storedSone = getRemoteSone(sone.getId());
522 if (!(sone.getTime() > storedSone.getTime())) {
523 logger.log(Level.FINE, "Downloaded Sone %s is not newer than stored Sone %s.", new Object[] { sone, storedSone });
526 synchronized (posts) {
527 for (Post post : storedSone.getPosts()) {
528 posts.remove(post.getId());
530 for (Post post : sone.getPosts()) {
531 posts.put(post.getId(), post);
534 synchronized (replies) {
535 for (Reply reply : storedSone.getReplies()) {
536 replies.remove(reply.getId());
538 for (Reply reply : sone.getReplies()) {
539 replies.put(reply.getId(), reply);
542 synchronized (storedSone) {
543 storedSone.setTime(sone.getTime());
544 storedSone.setProfile(sone.getProfile());
545 storedSone.setPosts(sone.getPosts());
546 storedSone.setReplies(sone.getReplies());
547 storedSone.setLikePostIds(sone.getLikedPostIds());
548 storedSone.setLikeReplyIds(sone.getLikedReplyIds());
549 storedSone.setLatestEdition(sone.getRequestUri().getEdition());
551 saveSone(storedSone);
556 * Deletes the given Sone. This will remove the Sone from the
557 * {@link #getLocalSone(String) local Sones}, stops its {@link SoneInserter}
558 * and remove the context from its identity.
563 public void deleteSone(Sone sone) {
564 if (!(sone.getIdentity() instanceof OwnIdentity)) {
565 logger.log(Level.WARNING, "Tried to delete Sone of non-own identity: %s", sone);
568 synchronized (localSones) {
569 if (!localSones.containsKey(sone.getId())) {
570 logger.log(Level.WARNING, "Tried to delete non-local Sone: %s", sone);
573 localSones.remove(sone.getId());
574 soneInserters.remove(sone.getId()).stop();
576 identityManager.removeContext((OwnIdentity) sone.getIdentity(), "Sone");
580 * Saves the given Sone. This will persist all local settings for the given
581 * Sone, such as the friends list and similar, private options.
586 public void saveSone(Sone sone) {
587 if (!isLocalSone(sone)) {
588 logger.log(Level.FINE, "Tried to save non-local Sone: %s", sone);
591 if (!(sone.getIdentity() instanceof OwnIdentity)) {
592 logger.log(Level.WARNING, "Local Sone without OwnIdentity found, refusing to save: %s", sone);
596 logger.log(Level.INFO, "Saving Sone: %s", sone);
597 identityManager.setProperty((OwnIdentity) sone.getIdentity(), "Sone.LatestEdition", String.valueOf(sone.getLatestEdition()));
599 /* save Sone into configuration. */
600 String sonePrefix = "Sone/" + sone.getId();
601 configuration.getLongValue(sonePrefix + "/Time").setValue(sone.getTime());
604 Profile profile = sone.getProfile();
605 configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
606 configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
607 configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
608 configuration.getIntValue(sonePrefix + "/Profile/BirthDay").setValue(profile.getBirthDay());
609 configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").setValue(profile.getBirthMonth());
610 configuration.getIntValue(sonePrefix + "/Profile/BirthYear").setValue(profile.getBirthYear());
614 for (Post post : sone.getPosts()) {
615 String postPrefix = sonePrefix + "/Posts/" + postCounter++;
616 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
617 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
618 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
620 configuration.getStringValue(sonePrefix + "/Posts/" + postCounter + "/ID").setValue(null);
623 int replyCounter = 0;
624 for (Reply reply : sone.getReplies()) {
625 String replyPrefix = sonePrefix + "/Replies/" + replyCounter++;
626 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
627 configuration.getStringValue(replyPrefix + "/Post/ID").setValue(reply.getPost().getId());
628 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
629 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
631 configuration.getStringValue(sonePrefix + "/Replies/" + replyCounter + "/ID").setValue(null);
633 /* save post likes. */
634 int postLikeCounter = 0;
635 for (String postId : sone.getLikedPostIds()) {
636 configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter++ + "/ID").setValue(postId);
638 configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter + "/ID").setValue(null);
640 /* save reply likes. */
641 int replyLikeCounter = 0;
642 for (String replyId : sone.getLikedReplyIds()) {
643 configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter++ + "/ID").setValue(replyId);
645 configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter + "/ID").setValue(null);
648 int friendCounter = 0;
649 for (Sone friend : sone.getFriends()) {
650 configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter + "/ID").setValue(friend.getId());
651 configuration.getBooleanValue(sonePrefix + "/Friends/" + friendCounter++ + "/Local").setValue(friend.getInsertUri() != null);
653 configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter + "/ID").setValue(null);
655 logger.log(Level.INFO, "Sone %s saved.", sone);
656 } catch (ConfigurationException ce1) {
657 logger.log(Level.WARNING, "Could not save Sone: " + sone, ce1);
662 * Creates a new post.
665 * The Sone that creates the post
667 * The text of the post
669 public void createPost(Sone sone, String text) {
670 createPost(sone, System.currentTimeMillis(), text);
674 * Creates a new post.
677 * The Sone that creates the post
679 * The time of the post
681 * The text of the post
683 public void createPost(Sone sone, long time, String text) {
684 if (!isLocalSone(sone)) {
685 logger.log(Level.FINE, "Tried to create post for non-local Sone: %s", sone);
688 Post post = new Post(sone, time, text);
689 synchronized (posts) {
690 posts.put(post.getId(), post);
697 * Deletes the given post.
702 public void deletePost(Post post) {
703 if (!isLocalSone(post.getSone())) {
704 logger.log(Level.WARNING, "Tried to delete post of non-local Sone: %s", post.getSone());
707 post.getSone().removePost(post);
708 synchronized (posts) {
709 posts.remove(post.getId());
711 saveSone(post.getSone());
715 * Creates a new reply.
718 * The Sone that creates the reply
720 * The post that this reply refers to
722 * The text of the reply
724 public void createReply(Sone sone, Post post, String text) {
725 createReply(sone, post, System.currentTimeMillis(), text);
729 * Creates a new reply.
732 * The Sone that creates the reply
734 * The post that this reply refers to
736 * The time of the reply
738 * The text of the reply
740 public void createReply(Sone sone, Post post, long time, String text) {
741 if (!isLocalSone(sone)) {
742 logger.log(Level.FINE, "Tried to create reply for non-local Sone: %s", sone);
745 Reply reply = new Reply(sone, post, System.currentTimeMillis(), text);
746 synchronized (replies) {
747 replies.put(reply.getId(), reply);
749 sone.addReply(reply);
754 * Deletes the given reply.
757 * The reply to delete
759 public void deleteReply(Reply reply) {
760 Sone sone = reply.getSone();
761 if (!isLocalSone(sone)) {
762 logger.log(Level.FINE, "Tried to delete non-local reply: %s", reply);
765 synchronized (replies) {
766 replies.remove(reply.getId());
768 sone.removeReply(reply);
775 public void start() {
783 synchronized (localSones) {
784 for (SoneInserter soneInserter : soneInserters.values()) {
796 * Loads the configuration.
798 @SuppressWarnings("unchecked")
799 private void loadConfiguration() {
800 /* create options. */
801 options.addIntegerOption("InsertionDelay", new DefaultOption<Integer>(60, new OptionWatcher<Integer>() {
804 public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
805 SoneInserter.setInsertionDelay(newValue);
809 options.addBooleanOption("ClearOnNextRestart", new DefaultOption<Boolean>(false));
810 options.addBooleanOption("ReallyClearOnNextRestart", new DefaultOption<Boolean>(false));
812 /* read options from configuration. */
813 options.getBooleanOption("ClearOnNextRestart").set(configuration.getBooleanValue("Option/ClearOnNextRestart").getValue(null));
814 options.getBooleanOption("ReallyClearOnNextRestart").set(configuration.getBooleanValue("Option/ReallyClearOnNextRestart").getValue(null));
815 boolean clearConfiguration = options.getBooleanOption("ClearOnNextRestart").get() && options.getBooleanOption("ReallyClearOnNextRestart").get();
816 options.getBooleanOption("ClearOnNextRestart").set(null);
817 options.getBooleanOption("ReallyClearOnNextRestart").set(null);
818 if (clearConfiguration) {
819 /* stop loading the configuration. */
823 options.getIntegerOption("InsertionDelay").set(configuration.getIntValue("Option/InsertionDelay").getValue(null));
828 * Saves the current options.
830 private void saveConfiguration() {
831 /* store the options first. */
833 configuration.getIntValue("Option/InsertionDelay").setValue(options.getIntegerOption("InsertionDelay").getReal());
834 configuration.getBooleanValue("Option/ClearOnNextRestart").setValue(options.getBooleanOption("ClearOnNextRestart").getReal());
835 configuration.getBooleanValue("Option/ReallyClearOnNextRestart").setValue(options.getBooleanOption("ReallyClearOnNextRestart").getReal());
836 } catch (ConfigurationException ce1) {
837 logger.log(Level.SEVERE, "Could not store configuration!", ce1);
842 * Generate a Sone URI from the given URI and latest edition.
845 * The URI to derive the Sone URI from
846 * @param latestEditionString
847 * The latest edition as a {@link String}, or {@code null}
848 * @return The derived URI
850 private FreenetURI getSoneUri(String uriString, String latestEditionString) {
852 FreenetURI uri = new FreenetURI(uriString).setDocName("Sone").setMetaString(new String[0]).setSuggestedEdition(Numbers.safeParseLong(latestEditionString, (long) 0));
854 } catch (MalformedURLException mue1) {
855 logger.log(Level.WARNING, "Could not create Sone URI from URI: " + uriString, mue1);
861 // INTERFACE IdentityListener
868 public void ownIdentityAdded(OwnIdentity ownIdentity) {
869 logger.log(Level.FINEST, "Adding OwnIdentity: " + ownIdentity);
870 if (ownIdentity.hasContext("Sone")) {
871 addLocalSone(ownIdentity);
879 public void ownIdentityRemoved(OwnIdentity ownIdentity) {
887 public void identityAdded(Identity identity) {
888 logger.log(Level.FINEST, "Adding Identity: " + identity);
889 addRemoteSone(identity);
896 public void identityUpdated(Identity identity) {
904 public void identityRemoved(Identity identity) {