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 Reply reply = replies.get(replyId);
315 reply = new Reply(replyId);
316 replies.put(replyId, reply);
323 * Returns all replies for the given post, order ascending by time.
326 * The post to get all replies for
327 * @return All replies for the given post
329 public List<Reply> getReplies(Post post) {
330 Set<Sone> sones = getSones();
331 List<Reply> replies = new ArrayList<Reply>();
332 for (Sone sone : sones) {
333 for (Reply reply : sone.getReplies()) {
334 if (reply.getPost().equals(post)) {
339 Collections.sort(replies, Reply.TIME_COMPARATOR);
344 * Returns all Sones that have liked the given post.
347 * The post to get the liking Sones for
348 * @return The Sones that like the given post
350 public Set<Sone> getLikes(Post post) {
351 Set<Sone> sones = new HashSet<Sone>();
352 for (Sone sone : getSones()) {
353 if (sone.getLikedPostIds().contains(post.getId())) {
361 * Returns all Sones that have liked the given reply.
364 * The reply to get the liking Sones for
365 * @return The Sones that like the given reply
367 public Set<Sone> getLikes(Reply reply) {
368 Set<Sone> sones = new HashSet<Sone>();
369 for (Sone sone : getSones()) {
370 if (sone.getLikedPostIds().contains(reply.getId())) {
382 * Adds a local Sone from the given ID which has to be the ID of an own
386 * The ID of an own identity to add a Sone for
387 * @return The added (or already existing) Sone
389 public Sone addLocalSone(String id) {
390 synchronized (localSones) {
391 if (localSones.containsKey(id)) {
392 logger.log(Level.FINE, "Tried to add known local Sone: %s", id);
393 return localSones.get(id);
395 OwnIdentity ownIdentity = identityManager.getOwnIdentity(id);
396 if (ownIdentity == null) {
397 logger.log(Level.INFO, "Invalid Sone ID: %s", id);
400 return addLocalSone(ownIdentity);
405 * Adds a local Sone from the given own identity.
408 * The own identity to create a Sone from
409 * @return The added (or already existing) Sone
411 public Sone addLocalSone(OwnIdentity ownIdentity) {
412 if (ownIdentity == null) {
413 logger.log(Level.WARNING, "Given OwnIdentity is null!");
416 synchronized (localSones) {
417 if (localSones.containsKey(ownIdentity.getId())) {
418 logger.log(Level.FINE, "Tried to add known local Sone: %s", ownIdentity);
419 return localSones.get(ownIdentity.getId());
423 sone = new Sone(ownIdentity).setInsertUri(new FreenetURI(ownIdentity.getInsertUri())).setRequestUri(new FreenetURI(ownIdentity.getRequestUri()));
424 sone.setLatestEdition(Numbers.safeParseLong(ownIdentity.getProperty("Sone.LatestEdition"), (long) 0));
425 } catch (MalformedURLException mue1) {
426 logger.log(Level.SEVERE, "Could not convert the Identity’s URIs to Freenet URIs: " + ownIdentity.getInsertUri() + ", " + ownIdentity.getRequestUri(), mue1);
429 /* TODO - load posts ’n stuff */
430 localSones.put(ownIdentity.getId(), sone);
431 SoneInserter soneInserter = new SoneInserter(this, freenetInterface, sone);
432 soneInserters.put(sone, soneInserter);
433 soneInserter.start();
434 setSoneStatus(sone, SoneStatus.idle);
435 new Thread(new Runnable() {
438 @SuppressWarnings("synthetic-access")
440 soneDownloader.fetchSone(sone);
443 }, "Sone Downloader").start();
449 * Creates a new Sone for the given own identity.
452 * The own identity to create a Sone for
453 * @return The created Sone
455 public Sone createSone(OwnIdentity ownIdentity) {
456 identityManager.addContext(ownIdentity, "Sone");
457 Sone sone = addLocalSone(ownIdentity);
458 synchronized (sone) {
459 /* mark as modified so that it gets inserted immediately. */
460 sone.setModificationCounter(sone.getModificationCounter() + 1);
466 * Adds the Sone of the given identity.
469 * The identity whose Sone to add
470 * @return The added or already existing Sone
472 public Sone addRemoteSone(Identity identity) {
473 if (identity == null) {
474 logger.log(Level.WARNING, "Given Identity is null!");
477 synchronized (remoteSones) {
478 if (remoteSones.containsKey(identity.getId())) {
479 logger.log(Level.FINE, "Identity already exists: %s", identity);
480 return remoteSones.get(identity.getId());
482 Sone sone = new Sone(identity);
483 sone.setRequestUri(getSoneUri(identity.getRequestUri(), identity.getProperty("Sone.LatestEdition")));
484 remoteSones.put(identity.getId(), sone);
485 soneDownloader.addSone(sone);
486 setSoneStatus(sone, SoneStatus.idle);
492 * Updates the stores Sone with the given Sone.
497 public void updateSone(Sone sone) {
498 if (isRemoteSone(sone)) {
499 Sone storedSone = getRemoteSone(sone.getId());
500 if (!(sone.getTime() > storedSone.getTime())) {
501 logger.log(Level.FINE, "Downloaded Sone %s is not newer than stored Sone %s.", new Object[] { sone, storedSone });
504 synchronized (posts) {
505 for (Post post : storedSone.getPosts()) {
506 posts.remove(post.getId());
508 for (Post post : sone.getPosts()) {
509 posts.put(post.getId(), post);
512 synchronized (replies) {
513 for (Reply reply : storedSone.getReplies()) {
514 replies.remove(reply.getId());
516 for (Reply reply : sone.getReplies()) {
517 replies.put(reply.getId(), reply);
520 synchronized (storedSone) {
521 storedSone.setTime(sone.getTime());
522 storedSone.setProfile(sone.getProfile());
523 storedSone.setPosts(sone.getPosts());
524 storedSone.setReplies(sone.getReplies());
525 storedSone.setLikePostIds(sone.getLikedPostIds());
526 storedSone.setLikeReplyIds(sone.getLikedReplyIds());
527 storedSone.setLatestEdition(sone.getRequestUri().getEdition());
529 saveSone(storedSone);
534 * Deletes the given Sone. This will remove the Sone from the
535 * {@link #getLocalSone(String) local Sones}, stops its {@link SoneInserter}
536 * and remove the context from its identity.
541 public void deleteSone(Sone sone) {
542 if (!(sone.getIdentity() instanceof OwnIdentity)) {
543 logger.log(Level.WARNING, "Tried to delete Sone of non-own identity: %s", sone);
546 synchronized (localSones) {
547 if (!localSones.containsKey(sone.getId())) {
548 logger.log(Level.WARNING, "Tried to delete non-local Sone: %s", sone);
551 localSones.remove(sone.getId());
552 soneInserters.remove(sone.getId()).stop();
554 identityManager.removeContext((OwnIdentity) sone.getIdentity(), "Sone");
558 * Saves the given Sone. This will persist all local settings for the given
559 * Sone, such as the friends list and similar, private options.
564 public void saveSone(Sone sone) {
565 if (!isLocalSone(sone)) {
566 logger.log(Level.FINE, "Tried to save non-local Sone: %s", sone);
569 if (!(sone.getIdentity() instanceof OwnIdentity)) {
570 logger.log(Level.WARNING, "Local Sone without OwnIdentity found, refusing to save: %s", sone);
574 logger.log(Level.INFO, "Saving Sone: %s", sone);
575 identityManager.setProperty((OwnIdentity) sone.getIdentity(), "Sone.LatestEdition", String.valueOf(sone.getLatestEdition()));
577 /* save Sone into configuration. */
578 String sonePrefix = "Sone/" + sone.getId();
579 configuration.getLongValue(sonePrefix + "/Time").setValue(sone.getTime());
582 Profile profile = sone.getProfile();
583 configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
584 configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
585 configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
586 configuration.getIntValue(sonePrefix + "/Profile/BirthDay").setValue(profile.getBirthDay());
587 configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").setValue(profile.getBirthMonth());
588 configuration.getIntValue(sonePrefix + "/Profile/BirthYear").setValue(profile.getBirthYear());
592 for (Post post : sone.getPosts()) {
593 String postPrefix = sonePrefix + "/Posts/" + postCounter++;
594 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
595 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
596 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
598 configuration.getStringValue(sonePrefix + "/Posts/" + postCounter + "/ID").setValue(null);
601 int replyCounter = 0;
602 for (Reply reply : sone.getReplies()) {
603 String replyPrefix = sonePrefix + "/Replies/" + replyCounter++;
604 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
605 configuration.getStringValue(replyPrefix + "/Post/ID").setValue(reply.getPost().getId());
606 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
607 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
609 configuration.getStringValue(sonePrefix + "/Replies/" + replyCounter + "/ID").setValue(null);
611 /* save post likes. */
612 int postLikeCounter = 0;
613 for (String postId : sone.getLikedPostIds()) {
614 configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter++ + "/ID").setValue(postId);
616 configuration.getStringValue(sonePrefix + "/Likes/Post/" + postLikeCounter + "/ID").setValue(null);
618 /* save reply likes. */
619 int replyLikeCounter = 0;
620 for (String replyId : sone.getLikedReplyIds()) {
621 configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter++ + "/ID").setValue(replyId);
623 configuration.getStringValue(sonePrefix + "/Likes/Reply/" + replyLikeCounter + "/ID").setValue(null);
625 logger.log(Level.INFO, "Sone %s saved.", sone);
626 } catch (ConfigurationException ce1) {
627 logger.log(Level.WARNING, "Could not save Sone: " + sone, ce1);
632 * Creates a new post.
635 * The Sone that creates the post
637 * The text of the post
639 public void createPost(Sone sone, String text) {
640 createPost(sone, System.currentTimeMillis(), text);
644 * Creates a new post.
647 * The Sone that creates the post
649 * The time of the post
651 * The text of the post
653 public void createPost(Sone sone, long time, String text) {
654 if (!isLocalSone(sone)) {
655 logger.log(Level.FINE, "Tried to create post for non-local Sone: %s", sone);
658 Post post = new Post(sone, time, text);
659 synchronized (posts) {
660 posts.put(post.getId(), post);
667 * Deletes the given post.
672 public void deletePost(Post post) {
673 if (!isLocalSone(post.getSone())) {
674 logger.log(Level.WARNING, "Tried to delete post of non-local Sone: %s", post.getSone());
677 post.getSone().removePost(post);
678 synchronized (posts) {
679 posts.remove(post.getId());
681 saveSone(post.getSone());
685 * Creates a new reply.
688 * The Sone that creates the reply
690 * The post that this reply refers to
692 * The text of the reply
694 public void createReply(Sone sone, Post post, String text) {
695 createReply(sone, post, System.currentTimeMillis(), text);
699 * Creates a new reply.
702 * The Sone that creates the reply
704 * The post that this reply refers to
706 * The time of the reply
708 * The text of the reply
710 public void createReply(Sone sone, Post post, long time, String text) {
711 if (!isLocalSone(sone)) {
712 logger.log(Level.FINE, "Tried to create reply for non-local Sone: %s", sone);
715 Reply reply = new Reply(sone, post, System.currentTimeMillis(), text);
716 synchronized (replies) {
717 replies.put(reply.getId(), reply);
719 sone.addReply(reply);
724 * Deletes the given reply.
727 * The reply to delete
729 public void deleteReply(Reply reply) {
730 Sone sone = reply.getSone();
731 if (!isLocalSone(sone)) {
732 logger.log(Level.FINE, "Tried to delete non-local reply: %s", reply);
735 synchronized (replies) {
736 replies.remove(reply.getId());
738 sone.removeReply(reply);
745 public void start() {
753 synchronized (localSones) {
754 for (SoneInserter soneInserter : soneInserters.values()) {
766 * Loads the configuration.
768 @SuppressWarnings("unchecked")
769 private void loadConfiguration() {
770 /* create options. */
771 options.addIntegerOption("InsertionDelay", new DefaultOption<Integer>(60, new OptionWatcher<Integer>() {
774 public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
775 SoneInserter.setInsertionDelay(newValue);
779 options.addBooleanOption("ClearOnNextRestart", new DefaultOption<Boolean>(false));
780 options.addBooleanOption("ReallyClearOnNextRestart", new DefaultOption<Boolean>(false));
782 /* read options from configuration. */
783 options.getBooleanOption("ClearOnNextRestart").set(configuration.getBooleanValue("Option/ClearOnNextRestart").getValue(null));
784 options.getBooleanOption("ReallyClearOnNextRestart").set(configuration.getBooleanValue("Option/ReallyClearOnNextRestart").getValue(null));
785 boolean clearConfiguration = options.getBooleanOption("ClearOnNextRestart").get() && options.getBooleanOption("ReallyClearOnNextRestart").get();
786 options.getBooleanOption("ClearOnNextRestart").set(null);
787 options.getBooleanOption("ReallyClearOnNextRestart").set(null);
788 if (clearConfiguration) {
789 /* stop loading the configuration. */
793 options.getIntegerOption("InsertionDelay").set(configuration.getIntValue("Option/InsertionDelay").getValue(null));
798 * Saves the current options.
800 private void saveConfiguration() {
801 /* store the options first. */
803 configuration.getIntValue("Option/InsertionDelay").setValue(options.getIntegerOption("InsertionDelay").getReal());
804 configuration.getBooleanValue("Option/ClearOnNextRestart").setValue(options.getBooleanOption("ClearOnNextRestart").getReal());
805 configuration.getBooleanValue("Option/ReallyClearOnNextRestart").setValue(options.getBooleanOption("ReallyClearOnNextRestart").getReal());
806 } catch (ConfigurationException ce1) {
807 logger.log(Level.SEVERE, "Could not store configuration!", ce1);
812 * Generate a Sone URI from the given URI and latest edition.
815 * The URI to derive the Sone URI from
816 * @param latestEditionString
817 * The latest edition as a {@link String}, or {@code null}
818 * @return The derived URI
820 private FreenetURI getSoneUri(String uriString, String latestEditionString) {
822 FreenetURI uri = new FreenetURI(uriString).setDocName("Sone").setMetaString(new String[0]).setSuggestedEdition(Numbers.safeParseLong(latestEditionString, (long) 0));
824 } catch (MalformedURLException mue1) {
825 logger.log(Level.WARNING, "Could not create Sone URI from URI: " + uriString, mue1);
831 // INTERFACE IdentityListener
838 public void ownIdentityAdded(OwnIdentity ownIdentity) {
839 logger.log(Level.FINEST, "Adding OwnIdentity: " + ownIdentity);
840 if (ownIdentity.hasContext("Sone")) {
841 addLocalSone(ownIdentity);
849 public void ownIdentityRemoved(OwnIdentity ownIdentity) {
857 public void identityAdded(Identity identity) {
858 logger.log(Level.FINEST, "Adding Identity: " + identity);
859 addRemoteSone(identity);
866 public void identityUpdated(Identity identity) {
874 public void identityRemoved(Identity identity) {