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 Sone sone = getRemoteSone(id);
207 sone = getLocalSone(id);
212 * Returns whether the given Sone is a local Sone.
215 * The Sone to check for its locality
216 * @return {@code true} if the given Sone is local, {@code false} otherwise
218 public boolean isLocalSone(Sone sone) {
219 synchronized (localSones) {
220 return localSones.containsKey(sone.getId());
225 * Returns all local Sones.
227 * @return All local Sones
229 public Set<Sone> getLocalSones() {
230 synchronized (localSones) {
231 return new HashSet<Sone>(localSones.values());
236 * Returns the local Sone with the given ID.
239 * The ID of the Sone to get
240 * @return The Sone, or {@code null} if there is no Sone with the given ID
242 public Sone getLocalSone(String id) {
243 synchronized (localSones) {
244 return localSones.get(id);
249 * Returns all remote Sones.
251 * @return All remote Sones
253 public Set<Sone> getRemoteSones() {
254 synchronized (remoteSones) {
255 return new HashSet<Sone>(remoteSones.values());
260 * Returns the remote Sone with the given ID.
263 * The ID of the remote Sone to get
264 * @return The Sone, or {@code null} if there is no such Sone
266 public Sone getRemoteSone(String id) {
267 synchronized (remoteSones) {
268 return remoteSones.get(id);
273 * Returns whether the given Sone is a remote Sone.
277 * @return {@code true} if the given Sone is a remote Sone, {@code false}
280 public boolean isRemoteSone(Sone sone) {
281 synchronized (remoteSones) {
282 return remoteSones.containsKey(sone.getId());
287 * Returns the post with the given ID.
290 * The ID of the post to get
291 * @return The post, or {@code null} if there is no such post
293 public Post getPost(String postId) {
294 synchronized (posts) {
295 Post post = posts.get(postId);
297 post = new Post(postId);
298 posts.put(postId, post);
305 * Returns the reply with the given ID.
308 * The ID of the reply to get
309 * @return The reply, or {@code null} if there is no such reply
311 public Reply getReply(String replyId) {
312 synchronized (replies) {
313 return replies.get(replyId);
318 * Returns all replies for the given post, order ascending by time.
321 * The post to get all replies for
322 * @return All replies for the given post
324 public List<Reply> getReplies(Post post) {
325 Set<Sone> sones = getSones();
326 List<Reply> replies = new ArrayList<Reply>();
327 for (Sone sone : sones) {
328 for (Reply reply : sone.getReplies()) {
329 if (reply.getPost().equals(post)) {
334 Collections.sort(replies, Reply.TIME_COMPARATOR);
339 * Returns all Sones that have liked the given post.
342 * The post to get the liking Sones for
343 * @return The Sones that like the given post
345 public Set<Sone> getLikes(Post post) {
346 Set<Sone> sones = new HashSet<Sone>();
347 for (Sone sone : getSones()) {
348 if (sone.getLikedPostIds().contains(post.getId())) {
356 * Returns all Sones that have liked the given reply.
359 * The reply to get the liking Sones for
360 * @return The Sones that like the given reply
362 public Set<Sone> getLikes(Reply reply) {
363 Set<Sone> sones = new HashSet<Sone>();
364 for (Sone sone : getSones()) {
365 if (sone.getLikedPostIds().contains(reply.getId())) {
377 * Adds a local Sone from the given ID which has to be the ID of an own
381 * The ID of an own identity to add a Sone for
382 * @return The added (or already existing) Sone
384 public Sone addLocalSone(String id) {
385 synchronized (localSones) {
386 if (localSones.containsKey(id)) {
387 logger.log(Level.FINE, "Tried to add known local Sone: %s", id);
388 return localSones.get(id);
390 OwnIdentity ownIdentity = identityManager.getOwnIdentity(id);
391 if (ownIdentity == null) {
392 logger.log(Level.INFO, "Invalid Sone ID: %s", id);
395 return addLocalSone(ownIdentity);
400 * Adds a local Sone from the given own identity.
403 * The own identity to create a Sone from
404 * @return The added (or already existing) Sone
406 public Sone addLocalSone(OwnIdentity ownIdentity) {
407 if (ownIdentity == null) {
408 logger.log(Level.WARNING, "Given OwnIdentity is null!");
411 synchronized (localSones) {
412 if (localSones.containsKey(ownIdentity.getId())) {
413 logger.log(Level.FINE, "Tried to add known local Sone: %s", ownIdentity);
414 return localSones.get(ownIdentity.getId());
418 sone = new Sone(ownIdentity).setInsertUri(new FreenetURI(ownIdentity.getInsertUri())).setRequestUri(new FreenetURI(ownIdentity.getRequestUri()));
419 sone.setLatestEdition(Numbers.safeParseLong(ownIdentity.getProperty("Sone.LatestEdition"), (long) 0));
420 } catch (MalformedURLException mue1) {
421 logger.log(Level.SEVERE, "Could not convert the Identity’s URIs to Freenet URIs: " + ownIdentity.getInsertUri() + ", " + ownIdentity.getRequestUri(), mue1);
424 /* TODO - load posts ’n stuff */
425 localSones.put(ownIdentity.getId(), sone);
426 SoneInserter soneInserter = new SoneInserter(this, freenetInterface, sone);
427 soneInserters.put(sone, soneInserter);
428 soneInserter.start();
429 setSoneStatus(sone, SoneStatus.idle);
430 new Thread(new Runnable() {
433 @SuppressWarnings("synthetic-access")
435 soneDownloader.fetchSone(sone);
438 }, "Sone Downloader").start();
444 * Creates a new Sone for the given own identity.
447 * The own identity to create a Sone for
448 * @return The created Sone
450 public Sone createSone(OwnIdentity ownIdentity) {
451 identityManager.addContext(ownIdentity, "Sone");
452 Sone sone = addLocalSone(ownIdentity);
453 synchronized (sone) {
454 /* mark as modified so that it gets inserted immediately. */
455 sone.setModificationCounter(sone.getModificationCounter() + 1);
461 * Adds the Sone of the given identity.
464 * The identity whose Sone to add
465 * @return The added or already existing Sone
467 public Sone addRemoteSone(Identity identity) {
468 if (identity == null) {
469 logger.log(Level.WARNING, "Given Identity is null!");
472 synchronized (remoteSones) {
473 if (remoteSones.containsKey(identity.getId())) {
474 logger.log(Level.FINE, "Identity already exists: %s", identity);
475 return remoteSones.get(identity.getId());
477 Sone sone = new Sone(identity);
478 sone.setRequestUri(getSoneUri(identity.getRequestUri(), identity.getProperty("Sone.LatestEdition")));
479 remoteSones.put(identity.getId(), sone);
480 soneDownloader.addSone(sone);
481 setSoneStatus(sone, SoneStatus.idle);
487 * Updates the stores Sone with the given Sone.
492 public void updateSone(Sone sone) {
493 if (isRemoteSone(sone)) {
494 Sone storedSone = getRemoteSone(sone.getId());
495 if (!(sone.getTime() > storedSone.getTime())) {
496 logger.log(Level.FINE, "Downloaded Sone %s is not newer than stored Sone %s.", new Object[] { sone, storedSone });
499 synchronized (posts) {
500 for (Post post : storedSone.getPosts()) {
501 posts.remove(post.getId());
503 for (Post post : sone.getPosts()) {
504 posts.put(post.getId(), post);
507 synchronized (replies) {
508 for (Reply reply : storedSone.getReplies()) {
509 replies.remove(reply.getId());
511 for (Reply reply : sone.getReplies()) {
512 replies.put(reply.getId(), reply);
515 synchronized (storedSone) {
516 storedSone.setTime(sone.getTime());
517 storedSone.setProfile(sone.getProfile());
518 storedSone.setPosts(sone.getPosts());
519 storedSone.setReplies(sone.getReplies());
520 storedSone.setLikePostIds(sone.getLikedPostIds());
521 storedSone.setLikeReplyIds(sone.getLikedReplyIds());
522 storedSone.setLatestEdition(sone.getRequestUri().getEdition());
524 saveSone(storedSone);
529 * Deletes the given Sone. This will remove the Sone from the
530 * {@link #getLocalSone(String) local Sones}, stops its {@link SoneInserter}
531 * and remove the context from its identity.
536 public void deleteSone(Sone sone) {
537 if (!(sone.getIdentity() instanceof OwnIdentity)) {
538 logger.log(Level.WARNING, "Tried to delete Sone of non-own identity: %s", sone);
541 synchronized (localSones) {
542 if (!localSones.containsKey(sone.getId())) {
543 logger.log(Level.WARNING, "Tried to delete non-local Sone: %s", sone);
546 localSones.remove(sone.getId());
547 soneInserters.remove(sone.getId()).stop();
549 identityManager.removeContext((OwnIdentity) sone.getIdentity(), "Sone");
553 * Saves the given Sone. This will persist all local settings for the given
554 * Sone, such as the friends list and similar, private options.
559 public void saveSone(Sone sone) {
560 if (!isLocalSone(sone)) {
561 logger.log(Level.FINE, "Tried to save non-local Sone: %s", sone);
564 if (!(sone.getIdentity() instanceof OwnIdentity)) {
565 logger.log(Level.WARNING, "Local Sone without OwnIdentity found, refusing to save: %s", sone);
569 logger.log(Level.INFO, "Saving Sone: %s", sone);
570 identityManager.setProperty((OwnIdentity) sone.getIdentity(), "Sone.LatestEdition", String.valueOf(sone.getLatestEdition()));
572 /* save Sone into configuration. */
573 String sonePrefix = "Sone/" + sone.getId();
574 configuration.getLongValue(sonePrefix + "/Time").setValue(sone.getTime());
577 Profile profile = sone.getProfile();
578 configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
579 configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
580 configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
581 configuration.getIntValue(sonePrefix + "/Profile/BirthDay").setValue(profile.getBirthDay());
582 configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").setValue(profile.getBirthMonth());
583 configuration.getIntValue(sonePrefix + "/Profile/BirthYear").setValue(profile.getBirthYear());
587 for (Post post : sone.getPosts()) {
588 String postPrefix = sonePrefix + "/Posts/" + postCounter++;
589 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
590 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
591 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
593 configuration.getStringValue(sonePrefix + "/Posts/" + postCounter + "/ID").setValue(null);
596 int replyCounter = 0;
597 for (Reply reply : sone.getReplies()) {
598 String replyPrefix = sonePrefix + "/Replies/" + replyCounter++;
599 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
600 configuration.getStringValue(replyPrefix + "/Post/ID").setValue(reply.getPost().getId());
601 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
602 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
604 configuration.getStringValue(sonePrefix + "/Replies/" + replyCounter + "/ID").setValue(null);
606 /* save post likes. */
607 int postLikeCounter = 0;
608 for (String postId : sone.getLikedPostIds()) {
609 configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter++ + "/ID").setValue(postId);
611 configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter + "/ID").setValue(null);
613 /* save reply likes. */
614 int replyLikeCounter = 0;
615 for (String replyId : sone.getLikedReplyIds()) {
616 configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter++ + "/ID").setValue(replyId);
618 configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter + "/ID").setValue(null);
620 logger.log(Level.INFO, "Sone %s saved.", sone);
621 } catch (ConfigurationException ce1) {
622 logger.log(Level.WARNING, "Could not save Sone: " + sone, ce1);
627 * Creates a new post.
630 * The Sone that creates the post
632 * The text of the post
634 public void createPost(Sone sone, String text) {
635 createPost(sone, System.currentTimeMillis(), text);
639 * Creates a new post.
642 * The Sone that creates the post
644 * The time of the post
646 * The text of the post
648 public void createPost(Sone sone, long time, String text) {
649 if (!isLocalSone(sone)) {
650 logger.log(Level.FINE, "Tried to create post for non-local Sone: %s", sone);
653 Post post = new Post(sone, time, text);
654 synchronized (posts) {
655 posts.put(post.getId(), post);
662 * Deletes the given post.
667 public void deletePost(Post post) {
668 if (!isLocalSone(post.getSone())) {
669 logger.log(Level.WARNING, "Tried to delete post of non-local Sone: %s", post.getSone());
672 post.getSone().removePost(post);
673 synchronized (posts) {
674 posts.remove(post.getId());
676 saveSone(post.getSone());
680 * Creates a new reply.
683 * The Sone that creates the reply
685 * The post that this reply refers to
687 * The text of the reply
689 public void createReply(Sone sone, Post post, String text) {
690 createReply(sone, post, System.currentTimeMillis(), text);
694 * Creates a new reply.
697 * The Sone that creates the reply
699 * The post that this reply refers to
701 * The time of the reply
703 * The text of the reply
705 public void createReply(Sone sone, Post post, long time, String text) {
706 if (!isLocalSone(sone)) {
707 logger.log(Level.FINE, "Tried to create reply for non-local Sone: %s", sone);
710 Reply reply = new Reply(sone, post, System.currentTimeMillis(), text);
711 synchronized (replies) {
712 replies.put(reply.getId(), reply);
714 sone.addReply(reply);
719 * Deletes the given reply.
722 * The reply to delete
724 public void deleteReply(Reply reply) {
725 Sone sone = reply.getSone();
726 if (!isLocalSone(sone)) {
727 logger.log(Level.FINE, "Tried to delete non-local reply: %s", reply);
730 synchronized (replies) {
731 replies.remove(reply.getId());
733 sone.removeReply(reply);
740 public void start() {
748 synchronized (localSones) {
749 for (SoneInserter soneInserter : soneInserters.values()) {
761 * Loads the configuration.
763 @SuppressWarnings("unchecked")
764 private void loadConfiguration() {
765 /* create options. */
766 options.addIntegerOption("InsertionDelay", new DefaultOption<Integer>(60, new OptionWatcher<Integer>() {
769 public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
770 SoneInserter.setInsertionDelay(newValue);
774 options.addBooleanOption("ClearOnNextRestart", new DefaultOption<Boolean>(false));
775 options.addBooleanOption("ReallyClearOnNextRestart", new DefaultOption<Boolean>(false));
777 /* read options from configuration. */
778 options.getBooleanOption("ClearOnNextRestart").set(configuration.getBooleanValue("Option/ClearOnNextRestart").getValue(null));
779 options.getBooleanOption("ReallyClearOnNextRestart").set(configuration.getBooleanValue("Option/ReallyClearOnNextRestart").getValue(null));
780 boolean clearConfiguration = options.getBooleanOption("ClearOnNextRestart").get() && options.getBooleanOption("ReallyClearOnNextRestart").get();
781 options.getBooleanOption("ClearOnNextRestart").set(null);
782 options.getBooleanOption("ReallyClearOnNextRestart").set(null);
783 if (clearConfiguration) {
784 /* stop loading the configuration. */
788 options.getIntegerOption("InsertionDelay").set(configuration.getIntValue("Option/InsertionDelay").getValue(null));
793 * Saves the current options.
795 private void saveConfiguration() {
796 /* store the options first. */
798 configuration.getIntValue("Option/InsertionDelay").setValue(options.getIntegerOption("InsertionDelay").getReal());
799 configuration.getBooleanValue("Option/ClearOnNextRestart").setValue(options.getBooleanOption("ClearOnNextRestart").getReal());
800 configuration.getBooleanValue("Option/ReallyClearOnNextRestart").setValue(options.getBooleanOption("ReallyClearOnNextRestart").getReal());
801 } catch (ConfigurationException ce1) {
802 logger.log(Level.SEVERE, "Could not store configuration!", ce1);
807 * Generate a Sone URI from the given URI and latest edition.
810 * The URI to derive the Sone URI from
811 * @param latestEditionString
812 * The latest edition as a {@link String}, or {@code null}
813 * @return The derived URI
815 private FreenetURI getSoneUri(String uriString, String latestEditionString) {
817 FreenetURI uri = new FreenetURI(uriString).setDocName("Sone").setMetaString(new String[0]).setSuggestedEdition(Numbers.safeParseLong(latestEditionString, (long) 0));
819 } catch (MalformedURLException mue1) {
820 logger.log(Level.WARNING, "Could not create Sone URI from URI: " + uriString, mue1);
826 // INTERFACE IdentityListener
833 public void ownIdentityAdded(OwnIdentity ownIdentity) {
834 logger.log(Level.FINEST, "Adding OwnIdentity: " + ownIdentity);
835 if (ownIdentity.hasContext("Sone")) {
836 addLocalSone(ownIdentity);
844 public void ownIdentityRemoved(OwnIdentity ownIdentity) {
852 public void identityAdded(Identity identity) {
853 logger.log(Level.FINEST, "Adding Identity: " + identity);
854 addRemoteSone(identity);
861 public void identityUpdated(Identity identity) {
869 public void identityRemoved(Identity identity) {