Turn profile fields into their own container classes.
[Sone.git] / src / main / java / net / pterodactylus / sone / core / Core.java
index e23ce6b..a1282cc 100644 (file)
@@ -34,6 +34,7 @@ import net.pterodactylus.sone.core.Options.OptionWatcher;
 import net.pterodactylus.sone.data.Client;
 import net.pterodactylus.sone.data.Post;
 import net.pterodactylus.sone.data.Profile;
+import net.pterodactylus.sone.data.Profile.Field;
 import net.pterodactylus.sone.data.Reply;
 import net.pterodactylus.sone.data.Sone;
 import net.pterodactylus.sone.freenet.wot.Identity;
@@ -45,6 +46,7 @@ import net.pterodactylus.util.config.Configuration;
 import net.pterodactylus.util.config.ConfigurationException;
 import net.pterodactylus.util.logging.Logging;
 import net.pterodactylus.util.number.Numbers;
+import net.pterodactylus.util.version.Version;
 import freenet.keys.FreenetURI;
 
 /**
@@ -52,7 +54,7 @@ import freenet.keys.FreenetURI;
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class Core implements IdentityListener {
+public class Core implements IdentityListener, UpdateListener {
 
        /**
         * Enumeration for the possible states of a {@link Sone}.
@@ -84,7 +86,10 @@ public class Core implements IdentityListener {
        private final CoreListenerManager coreListenerManager = new CoreListenerManager(this);
 
        /** The configuration. */
-       private final Configuration configuration;
+       private Configuration configuration;
+
+       /** Whether we’re currently saving the configuration. */
+       private boolean storingConfiguration = false;
 
        /** The identity manager. */
        private final IdentityManager identityManager;
@@ -95,6 +100,9 @@ public class Core implements IdentityListener {
        /** The Sone downloader. */
        private final SoneDownloader soneDownloader;
 
+       /** The update checker. */
+       private final UpdateChecker updateChecker;
+
        /** Whether the core has been stopped. */
        private volatile boolean stopped;
 
@@ -159,6 +167,7 @@ public class Core implements IdentityListener {
                this.freenetInterface = freenetInterface;
                this.identityManager = identityManager;
                this.soneDownloader = new SoneDownloader(this, freenetInterface);
+               this.updateChecker = new UpdateChecker(freenetInterface);
        }
 
        //
@@ -190,6 +199,18 @@ public class Core implements IdentityListener {
        //
 
        /**
+        * Sets the configuration to use. This will automatically save the current
+        * configuration to the given configuration.
+        *
+        * @param configuration
+        *            The new configuration to use
+        */
+       public void setConfiguration(Configuration configuration) {
+               this.configuration = configuration;
+               saveConfiguration();
+       }
+
+       /**
         * Returns the options used by the core.
         *
         * @return The options of the core
@@ -218,6 +239,15 @@ public class Core implements IdentityListener {
        }
 
        /**
+        * Returns the update checker.
+        *
+        * @return The update checker
+        */
+       public UpdateChecker getUpdateChecker() {
+               return updateChecker;
+       }
+
+       /**
         * Returns the status of the given Sone.
         *
         * @param sone
@@ -529,27 +559,63 @@ public class Core implements IdentityListener {
         *         otherwise
         */
        public boolean isNewPost(String postId) {
+               return isNewPost(postId, true);
+       }
+
+       /**
+        * Returns whether the given post ID is new. If {@code markAsKnown} is
+        * {@code true} then after this method returns the post ID is marked a known
+        * post ID.
+        *
+        * @param postId
+        *            The post ID
+        * @param markAsKnown
+        *            {@code true} to mark the post ID as known, {@code false} to
+        *            not to mark it as known
+        * @return {@code true} if the post is considered to be new, {@code false}
+        *         otherwise
+        */
+       public boolean isNewPost(String postId, boolean markAsKnown) {
                synchronized (newPosts) {
-                       boolean isNew = !knownPosts.contains(postId) && newPosts.remove(postId);
-                       knownPosts.add(postId);
-                       if (isNew) {
-                               coreListenerManager.fireMarkPostKnown(getPost(postId));
+                       boolean isNew = !knownPosts.contains(postId) && newPosts.contains(postId);
+                       if (markAsKnown) {
+                               Post post = getPost(postId, false);
+                               if (post != null) {
+                                       markPostKnown(post);
+                               }
                        }
                        return isNew;
                }
        }
 
        /**
-        * Returns the reply with the given ID.
+        * Returns the reply with the given ID. If there is no reply with the given
+        * ID yet, a new one is created.
         *
         * @param replyId
         *            The ID of the reply to get
-        * @return The reply, or {@code null} if there is no such reply
+        * @return The reply
         */
        public Reply getReply(String replyId) {
+               return getReply(replyId, true);
+       }
+
+       /**
+        * Returns the reply with the given ID. If there is no reply with the given
+        * ID yet, a new one is created, unless {@code create} is false in which
+        * case {@code null} is returned.
+        *
+        * @param replyId
+        *            The ID of the reply to get
+        * @param create
+        *            {@code true} to always return a {@link Reply}, {@code false}
+        *            to return {@code null} if no reply can be found
+        * @return The reply, or {@code null} if there is no such reply
+        */
+       public Reply getReply(String replyId, boolean create) {
                synchronized (replies) {
                        Reply reply = replies.get(replyId);
-                       if (reply == null) {
+                       if (create && (reply == null)) {
                                reply = new Reply(replyId);
                                replies.put(replyId, reply);
                        }
@@ -587,11 +653,28 @@ public class Core implements IdentityListener {
         *         otherwise
         */
        public boolean isNewReply(String replyId) {
+               return isNewReply(replyId, true);
+       }
+
+       /**
+        * Returns whether the reply with the given ID is new.
+        *
+        * @param replyId
+        *            The ID of the reply to check
+        * @param markAsKnown
+        *            {@code true} to mark the reply as known, {@code false} to not
+        *            to mark it as known
+        * @return {@code true} if the reply is considered to be new, {@code false}
+        *         otherwise
+        */
+       public boolean isNewReply(String replyId, boolean markAsKnown) {
                synchronized (newReplies) {
-                       boolean isNew = !knownReplies.contains(replyId) && newReplies.remove(replyId);
-                       knownReplies.add(replyId);
-                       if (isNew) {
-                               coreListenerManager.fireMarkReplyKnown(getReply(replyId));
+                       boolean isNew = !knownReplies.contains(replyId) && newReplies.contains(replyId);
+                       if (markAsKnown) {
+                               Reply reply = getReply(replyId, false);
+                               if (reply != null) {
+                                       markReplyKnown(reply);
+                               }
                        }
                        return isNew;
                }
@@ -645,7 +728,9 @@ public class Core implements IdentityListener {
         */
        public void lockSone(Sone sone) {
                synchronized (lockedSones) {
-                       lockedSones.add(sone);
+                       if (lockedSones.add(sone)) {
+                               coreListenerManager.fireSoneLocked(sone);
+                       }
                }
        }
 
@@ -658,7 +743,9 @@ public class Core implements IdentityListener {
         */
        public void unlockSone(Sone sone) {
                synchronized (lockedSones) {
-                       lockedSones.remove(sone);
+                       if (lockedSones.remove(sone)) {
+                               coreListenerManager.fireSoneUnlocked(sone);
+                       }
                }
        }
 
@@ -820,6 +907,9 @@ public class Core implements IdentityListener {
                                if (!soneRescueMode) {
                                        for (Post post : storedSone.getPosts()) {
                                                posts.remove(post.getId());
+                                               if (!sone.getPosts().contains(post)) {
+                                                       coreListenerManager.firePostRemoved(post);
+                                               }
                                        }
                                }
                                synchronized (newPosts) {
@@ -837,6 +927,9 @@ public class Core implements IdentityListener {
                                if (!soneRescueMode) {
                                        for (Reply reply : storedSone.getReplies()) {
                                                replies.remove(reply.getId());
+                                               if (!sone.getReplies().contains(reply)) {
+                                                       coreListenerManager.fireReplyRemoved(reply);
+                                               }
                                        }
                                }
                                synchronized (newReplies) {
@@ -875,7 +968,7 @@ public class Core implements IdentityListener {
                                        storedSone.setLikePostIds(sone.getLikedPostIds());
                                        storedSone.setLikeReplyIds(sone.getLikedReplyIds());
                                }
-                               storedSone.setLatestEdition(sone.getRequestUri().getEdition());
+                               storedSone.setLatestEdition(sone.getLatestEdition());
                        }
                }
        }
@@ -941,6 +1034,17 @@ public class Core implements IdentityListener {
                profile.setBirthMonth(configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").getValue(null));
                profile.setBirthYear(configuration.getIntValue(sonePrefix + "/Profile/BirthYear").getValue(null));
 
+               /* load profile fields. */
+               while (true) {
+                       String fieldPrefix = sonePrefix + "/Profile/Fields/" + profile.getFields().size();
+                       String fieldName = configuration.getStringValue(fieldPrefix + "/Name").getValue(null);
+                       if (fieldName == null) {
+                               break;
+                       }
+                       String fieldValue = configuration.getStringValue(fieldPrefix + "/Value").getValue("");
+                       profile.addField(fieldName).setValue(fieldValue);
+               }
+
                /* load posts. */
                Set<Post> posts = new HashSet<Post>();
                while (true) {
@@ -949,13 +1053,18 @@ public class Core implements IdentityListener {
                        if (postId == null) {
                                break;
                        }
+                       String postRecipientId = configuration.getStringValue(postPrefix + "/Recipient").getValue(null);
                        long postTime = configuration.getLongValue(postPrefix + "/Time").getValue((long) 0);
                        String postText = configuration.getStringValue(postPrefix + "/Text").getValue(null);
                        if ((postTime == 0) || (postText == null)) {
                                logger.log(Level.WARNING, "Invalid post found, aborting load!");
                                return;
                        }
-                       posts.add(getPost(postId).setSone(sone).setTime(postTime).setText(postText));
+                       Post post = getPost(postId).setSone(sone).setTime(postTime).setText(postText);
+                       if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
+                               post.setRecipient(getSone(postRecipientId));
+                       }
+                       posts.add(post);
                }
 
                /* load replies. */
@@ -1041,7 +1150,7 @@ public class Core implements IdentityListener {
         * @param sone
         *            The Sone to save
         */
-       public void saveSone(Sone sone) {
+       public synchronized void saveSone(Sone sone) {
                if (!isLocalSone(sone)) {
                        logger.log(Level.FINE, "Tried to save non-local Sone: %s", sone);
                        return;
@@ -1068,11 +1177,21 @@ public class Core implements IdentityListener {
                        configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").setValue(profile.getBirthMonth());
                        configuration.getIntValue(sonePrefix + "/Profile/BirthYear").setValue(profile.getBirthYear());
 
+                       /* save profile fields. */
+                       int fieldCounter = 0;
+                       for (Field profileField : profile.getFields()) {
+                               String fieldPrefix = sonePrefix + "/Profile/Fields/" + fieldCounter++;
+                               configuration.getStringValue(fieldPrefix + "/Name").setValue(profileField.getName());
+                               configuration.getStringValue(fieldPrefix + "/Value").setValue(profileField.getValue());
+                       }
+                       configuration.getStringValue(sonePrefix + "/Profile/Fields/" + fieldCounter + "/Name").setValue(null);
+
                        /* save posts. */
                        int postCounter = 0;
                        for (Post post : sone.getPosts()) {
                                String postPrefix = sonePrefix + "/Posts/" + postCounter++;
                                configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
+                               configuration.getStringValue(postPrefix + "/Recipient").setValue((post.getRecipient() != null) ? post.getRecipient().getId() : null);
                                configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
                                configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
                        }
@@ -1110,6 +1229,7 @@ public class Core implements IdentityListener {
                        }
                        configuration.getStringValue(sonePrefix + "/Friends/" + friendCounter + "/ID").setValue(null);
 
+                       configuration.save();
                        logger.log(Level.INFO, "Sone %s saved.", sone);
                } catch (ConfigurationException ce1) {
                        logger.log(Level.WARNING, "Could not save Sone: " + sone, ce1);
@@ -1123,9 +1243,10 @@ public class Core implements IdentityListener {
         *            The Sone that creates the post
         * @param text
         *            The text of the post
+        * @return The created post
         */
-       public void createPost(Sone sone, String text) {
-               createPost(sone, System.currentTimeMillis(), text);
+       public Post createPost(Sone sone, String text) {
+               return createPost(sone, System.currentTimeMillis(), text);
        }
 
        /**
@@ -1137,13 +1258,51 @@ public class Core implements IdentityListener {
         *            The time of the post
         * @param text
         *            The text of the post
+        * @return The created post
+        */
+       public Post createPost(Sone sone, long time, String text) {
+               return createPost(sone, null, time, text);
+       }
+
+       /**
+        * Creates a new post.
+        *
+        * @param sone
+        *            The Sone that creates the post
+        * @param recipient
+        *            The recipient Sone, or {@code null} if this post does not have
+        *            a recipient
+        * @param text
+        *            The text of the post
+        * @return The created post
         */
-       public void createPost(Sone sone, long time, String text) {
+       public Post createPost(Sone sone, Sone recipient, String text) {
+               return createPost(sone, recipient, System.currentTimeMillis(), text);
+       }
+
+       /**
+        * Creates a new post.
+        *
+        * @param sone
+        *            The Sone that creates the post
+        * @param recipient
+        *            The recipient Sone, or {@code null} if this post does not have
+        *            a recipient
+        * @param time
+        *            The time of the post
+        * @param text
+        *            The text of the post
+        * @return The created post
+        */
+       public Post createPost(Sone sone, Sone recipient, long time, String text) {
                if (!isLocalSone(sone)) {
                        logger.log(Level.FINE, "Tried to create post for non-local Sone: %s", sone);
-                       return;
+                       return null;
                }
                Post post = new Post(sone, time, text);
+               if (recipient != null) {
+                       post.setRecipient(recipient);
+               }
                synchronized (posts) {
                        posts.put(post.getId(), post);
                }
@@ -1152,6 +1311,7 @@ public class Core implements IdentityListener {
                }
                sone.addPost(post);
                saveSone(sone);
+               return post;
        }
 
        /**
@@ -1173,6 +1333,23 @@ public class Core implements IdentityListener {
        }
 
        /**
+        * Marks the given post as known, if it is currently a new post (according
+        * to {@link #isNewPost(String)}).
+        *
+        * @param post
+        *            The post to mark as known
+        */
+       public void markPostKnown(Post post) {
+               synchronized (newPosts) {
+                       if (newPosts.remove(post.getId())) {
+                               knownPosts.add(post.getId());
+                               coreListenerManager.fireMarkPostKnown(post);
+                               saveConfiguration();
+                       }
+               }
+       }
+
+       /**
         * Creates a new reply.
         *
         * @param sone
@@ -1237,10 +1414,29 @@ public class Core implements IdentityListener {
        }
 
        /**
+        * Marks the given reply as known, if it is currently a new reply (according
+        * to {@link #isNewReply(String)}).
+        *
+        * @param reply
+        *            The reply to mark as known
+        */
+       public void markReplyKnown(Reply reply) {
+               synchronized (newReplies) {
+                       if (newReplies.remove(reply.getId())) {
+                               knownReplies.add(reply.getId());
+                               coreListenerManager.fireMarkReplyKnown(reply);
+                               saveConfiguration();
+                       }
+               }
+       }
+
+       /**
         * Starts the core.
         */
        public void start() {
                loadConfiguration();
+               updateChecker.addUpdateListener(this);
+               updateChecker.start();
        }
 
        /**
@@ -1252,10 +1448,72 @@ public class Core implements IdentityListener {
                                soneInserter.stop();
                        }
                }
+               updateChecker.stop();
+               updateChecker.removeUpdateListener(this);
+               soneDownloader.stop();
                saveConfiguration();
                stopped = true;
        }
 
+       /**
+        * Saves the current options.
+        */
+       public void saveConfiguration() {
+               synchronized (configuration) {
+                       if (storingConfiguration) {
+                               logger.log(Level.FINE, "Already storing configuration…");
+                               return;
+                       }
+                       storingConfiguration = true;
+               }
+
+               /* store the options first. */
+               try {
+                       configuration.getIntValue("Option/ConfigurationVersion").setValue(0);
+                       configuration.getIntValue("Option/InsertionDelay").setValue(options.getIntegerOption("InsertionDelay").getReal());
+                       configuration.getBooleanValue("Option/SoneRescueMode").setValue(options.getBooleanOption("SoneRescueMode").getReal());
+                       configuration.getBooleanValue("Option/ClearOnNextRestart").setValue(options.getBooleanOption("ClearOnNextRestart").getReal());
+                       configuration.getBooleanValue("Option/ReallyClearOnNextRestart").setValue(options.getBooleanOption("ReallyClearOnNextRestart").getReal());
+
+                       /* save known Sones. */
+                       int soneCounter = 0;
+                       synchronized (newSones) {
+                               for (String knownSoneId : knownSones) {
+                                       configuration.getStringValue("KnownSone/" + soneCounter++ + "/ID").setValue(knownSoneId);
+                               }
+                               configuration.getStringValue("KnownSone/" + soneCounter + "/ID").setValue(null);
+                       }
+
+                       /* save known posts. */
+                       int postCounter = 0;
+                       synchronized (newPosts) {
+                               for (String knownPostId : knownPosts) {
+                                       configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").setValue(knownPostId);
+                               }
+                               configuration.getStringValue("KnownPosts/" + postCounter + "/ID").setValue(null);
+                       }
+
+                       /* save known replies. */
+                       int replyCounter = 0;
+                       synchronized (newReplies) {
+                               for (String knownReplyId : knownReplies) {
+                                       configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").setValue(knownReplyId);
+                               }
+                               configuration.getStringValue("KnownReplies/" + replyCounter + "/ID").setValue(null);
+                       }
+
+                       /* now save it. */
+                       configuration.save();
+
+               } catch (ConfigurationException ce1) {
+                       logger.log(Level.SEVERE, "Could not store configuration!", ce1);
+               } finally {
+                       synchronized (configuration) {
+                               storingConfiguration = false;
+                       }
+               }
+       }
+
        //
        // PRIVATE METHODS
        //
@@ -1331,49 +1589,6 @@ public class Core implements IdentityListener {
        }
 
        /**
-        * Saves the current options.
-        */
-       private void saveConfiguration() {
-               /* store the options first. */
-               try {
-                       configuration.getIntValue("Option/InsertionDelay").setValue(options.getIntegerOption("InsertionDelay").getReal());
-                       configuration.getBooleanValue("Option/SoneRescueMode").setValue(options.getBooleanOption("SoneRescueMode").getReal());
-                       configuration.getBooleanValue("Option/ClearOnNextRestart").setValue(options.getBooleanOption("ClearOnNextRestart").getReal());
-                       configuration.getBooleanValue("Option/ReallyClearOnNextRestart").setValue(options.getBooleanOption("ReallyClearOnNextRestart").getReal());
-
-                       /* save known Sones. */
-                       int soneCounter = 0;
-                       synchronized (newSones) {
-                               for (String knownSoneId : knownSones) {
-                                       configuration.getStringValue("KnownSone/" + soneCounter++ + "/ID").setValue(knownSoneId);
-                               }
-                               configuration.getStringValue("KnownSone/" + soneCounter + "/ID").setValue(null);
-                       }
-
-                       /* save known posts. */
-                       int postCounter = 0;
-                       synchronized (newPosts) {
-                               for (String knownPostId : knownPosts) {
-                                       configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").setValue(knownPostId);
-                               }
-                               configuration.getStringValue("KnownPosts/" + postCounter + "/ID").setValue(null);
-                       }
-
-                       /* save known replies. */
-                       int replyCounter = 0;
-                       synchronized (newReplies) {
-                               for (String knownReplyId : knownReplies) {
-                                       configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").setValue(knownReplyId);
-                               }
-                               configuration.getStringValue("KnownReplies/" + replyCounter + "/ID").setValue(null);
-                       }
-
-               } catch (ConfigurationException ce1) {
-                       logger.log(Level.SEVERE, "Could not store configuration!", ce1);
-               }
-       }
-
-       /**
         * Generate a Sone URI from the given URI and latest edition.
         *
         * @param uriString
@@ -1446,4 +1661,16 @@ public class Core implements IdentityListener {
                /* TODO */
        }
 
+       //
+       // INTERFACE UpdateListener
+       //
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       public void updateFound(Version version, long releaseTime) {
+               coreListenerManager.fireUpdateFound(version, releaseTime);
+       }
+
 }