Remove blocking, blacklisting, and distribution of known Sones.
[Sone.git] / src / main / java / net / pterodactylus / sone / core / Core.java
index 6ecd5fc..1a1c6df 100644 (file)
@@ -17,6 +17,7 @@
 
 package net.pterodactylus.sone.core;
 
+import java.io.InputStream;
 import java.net.MalformedURLException;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -31,11 +32,15 @@ import java.util.UUID;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import net.pterodactylus.sone.core.Options.DefaultOption;
+import net.pterodactylus.sone.core.Options.Option;
+import net.pterodactylus.sone.core.Options.OptionWatcher;
 import net.pterodactylus.sone.core.SoneException.Type;
 import net.pterodactylus.sone.data.Post;
 import net.pterodactylus.sone.data.Profile;
 import net.pterodactylus.sone.data.Reply;
 import net.pterodactylus.sone.data.Sone;
+import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
 import net.pterodactylus.util.config.Configuration;
 import net.pterodactylus.util.config.ConfigurationException;
 import net.pterodactylus.util.filter.Filter;
@@ -52,40 +57,79 @@ import freenet.keys.FreenetURI;
  */
 public class Core extends AbstractService {
 
+       /** The default Sones. */
+       private static final Set<String> defaultSones = new HashSet<String>();
+
+       static {
+               /* Sone of Sone. */
+               defaultSones.add("USK@eRHt0ceFsHjRZ11j6dd68RSdIvfd8f9YjJLZ9lnhEyo,iJWjIWh6TkMZm1NY8qBranKTIuwsCPkVPG6T6c6ft-I,AQACAAE/Sone/4");
+               /* Sone of Bombe. */
+               defaultSones.add("USK@RuW~uAO35Ipne896-1OmaVJNPuYE4ZIB5oZ5ziaU57A,7rV3uiyztXBDt03DCoRiNwiGjgFCJuznM9Okc1opURU,AQACAAE/Sone/29");
+       }
+
+       /**
+        * Enumeration for the possible states of a {@link Sone}.
+        *
+        * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+        */
+       public enum SoneStatus {
+
+               /** The Sone is unknown, i.e. not yet downloaded. */
+               unknown,
+
+               /** The Sone is idle, i.e. not being downloaded or inserted. */
+               idle,
+
+               /** The Sone is currently being inserted. */
+               inserting,
+
+               /** The Sone is currently being downloaded. */
+               downloading,
+       }
+
        /** The logger. */
        private static final Logger logger = Logging.getLogger(Core.class);
 
+       /** The options. */
+       private final Options options = new Options();
+
        /** The configuration. */
        private Configuration configuration;
 
        /** Interface to freenet. */
        private FreenetInterface freenetInterface;
 
+       /** The WoT connector. */
+       private WebOfTrustConnector webOfTrustConnector;
+
        /** The Sone downloader. */
        private SoneDownloader soneDownloader;
 
        /** The local Sones. */
-       private final Set<Sone> localSones = new HashSet<Sone>();
+       private final Set<Sone> localSones = Collections.synchronizedSet(new HashSet<Sone>());
 
        /** Sone inserters. */
-       private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
+       private final Map<Sone, SoneInserter> soneInserters = Collections.synchronizedMap(new HashMap<Sone, SoneInserter>());
+
+       /** The Sones’ statuses. */
+       private final Map<Sone, SoneStatus> soneStatuses = Collections.synchronizedMap(new HashMap<Sone, SoneStatus>());
 
        /* various caches follow here. */
 
        /** Cache for all known Sones. */
-       private final Map<String, Sone> soneCache = new HashMap<String, Sone>();
+       private final Map<String, Sone> soneCache = Collections.synchronizedMap(new HashMap<String, Sone>());
 
        /** Cache for all known posts. */
-       private final Map<String, Post> postCache = new HashMap<String, Post>();
+       private final Map<String, Post> postCache = Collections.synchronizedMap(new HashMap<String, Post>());
 
        /** Cache for all known replies. */
-       private final Map<String, Reply> replyCache = new HashMap<String, Reply>();
+       private final Map<String, Reply> replyCache = Collections.synchronizedMap(new HashMap<String, Reply>());
 
        /**
         * Creates a new core.
         */
        public Core() {
-               super("Sone Core");
+               super("Sone Core", false);
        }
 
        //
@@ -93,6 +137,15 @@ public class Core extends AbstractService {
        //
 
        /**
+        * Returns the options of the Sone plugin.
+        *
+        * @return The options of the Sone plugin
+        */
+       public Options getOptions() {
+               return options;
+       }
+
+       /**
         * Sets the configuration of the core.
         *
         * @param configuration
@@ -119,6 +172,27 @@ public class Core extends AbstractService {
        }
 
        /**
+        * Returns the Web of Trust connector.
+        *
+        * @return The Web of Trust connector
+        */
+       public WebOfTrustConnector getWebOfTrustConnector() {
+               return webOfTrustConnector;
+       }
+
+       /**
+        * Sets the Web of Trust connector.
+        *
+        * @param webOfTrustConnector
+        *            The Web of Trust connector
+        * @return This core (for method chaining)
+        */
+       public Core setWebOfTrustConnector(WebOfTrustConnector webOfTrustConnector) {
+               this.webOfTrustConnector = webOfTrustConnector;
+               return this;
+       }
+
+       /**
         * Returns the local Sones.
         *
         * @return The local Sones
@@ -139,6 +213,7 @@ public class Core extends AbstractService {
                if (!soneCache.containsKey(soneId)) {
                        Sone sone = new Sone(soneId);
                        soneCache.put(soneId, sone);
+                       setSoneStatus(sone, SoneStatus.unknown);
                }
                return soneCache.get(soneId);
        }
@@ -149,7 +224,7 @@ public class Core extends AbstractService {
         * @return All known sones
         */
        public Collection<Sone> getKnownSones() {
-               return soneCache.values();
+               return Collections.unmodifiableCollection(soneCache.values());
        }
 
        /**
@@ -158,14 +233,30 @@ public class Core extends AbstractService {
         * @return All remote Sones
         */
        public Collection<Sone> getRemoteSones() {
-               return Filters.filteredCollection(getKnownSones(), new Filter<Sone>() {
+               return Collections.unmodifiableCollection(getKnownSones());
+       }
 
-                       @Override
-                       @SuppressWarnings("synthetic-access")
-                       public boolean filterObject(Sone object) {
-                               return !localSones.contains(object);
-                       }
-               });
+       /**
+        * Returns the status of the given Sone.
+        *
+        * @param sone
+        *            The Sone to get the status for
+        * @return The status of the Sone
+        */
+       public SoneStatus getSoneStatus(Sone sone) {
+               return soneStatuses.get(sone);
+       }
+
+       /**
+        * Sets the status of the Sone.
+        *
+        * @param sone
+        *            The Sone to set the status for
+        * @param soneStatus
+        *            The status of the Sone
+        */
+       public void setSoneStatus(Sone sone, SoneStatus soneStatus) {
+               soneStatuses.put(sone, soneStatus);
        }
 
        /**
@@ -258,7 +349,8 @@ public class Core extends AbstractService {
         */
        public void addLocalSone(Sone sone) {
                if (localSones.add(sone)) {
-                       SoneInserter soneInserter = new SoneInserter(freenetInterface, sone);
+                       setSoneStatus(sone, SoneStatus.idle);
+                       SoneInserter soneInserter = new SoneInserter(this, freenetInterface, sone);
                        soneInserter.start();
                        soneInserters.put(sone, soneInserter);
                }
@@ -274,7 +366,7 @@ public class Core extends AbstractService {
         *             if a Sone error occurs
         */
        public Sone createSone(String name) throws SoneException {
-               return createSone(name, null, null);
+               return createSone(name, "Sone", null, null);
        }
 
        /**
@@ -284,6 +376,8 @@ public class Core extends AbstractService {
         *
         * @param name
         *            The name of the Sone
+        * @param documentName
+        *            The document name in the SSK
         * @param requestUri
         *            The request URI of the Sone, or {@link NullPointerException}
         *            to create a Sone at a random location
@@ -294,7 +388,7 @@ public class Core extends AbstractService {
         * @throws SoneException
         *             if a Sone error occurs
         */
-       public Sone createSone(String name, String requestUri, String insertUri) throws SoneException {
+       public Sone createSone(String name, String documentName, String requestUri, String insertUri) throws SoneException {
                if ((name == null) || (name.trim().length() == 0)) {
                        throw new SoneException(Type.INVALID_SONE_NAME);
                }
@@ -311,7 +405,7 @@ public class Core extends AbstractService {
                Sone sone;
                try {
                        logger.log(Level.FINEST, "Creating new Sone “%s” at %s (%s)…", new Object[] { name, finalRequestUri, finalInsertUri });
-                       sone = getSone(UUID.randomUUID().toString()).setName(name).setRequestUri(new FreenetURI(finalRequestUri).setKeyType("USK").setDocName("Sone-" + name)).setInsertUri(new FreenetURI(finalInsertUri).setKeyType("USK").setDocName("Sone-" + name));
+                       sone = getSone(UUID.randomUUID().toString()).setName(name).setRequestUri(new FreenetURI(finalRequestUri).setKeyType("USK").setDocName(documentName)).setInsertUri(new FreenetURI(finalInsertUri).setKeyType("USK").setDocName(documentName));
                        sone.setProfile(new Profile());
                        /* set modification counter to 1 so it is inserted immediately. */
                        sone.setModificationCounter(1);
@@ -330,6 +424,21 @@ public class Core extends AbstractService {
         *            The request URI to load the Sone from
         */
        public void loadSone(final String requestUri) {
+               loadSone(requestUri, null);
+       }
+
+       /**
+        * Loads the Sone from the given request URI. The fetching of the data is
+        * performed in a new thread so this method returns immediately. If
+        * {@code insertUri} is not {@code null} the loaded Sone is converted into a
+        * local Sone and available using as any other local Sone.
+        *
+        * @param requestUri
+        *            The request URI to load the Sone from
+        * @param insertUri
+        *            The insert URI of the Sone
+        */
+       public void loadSone(final String requestUri, final String insertUri) {
                new Thread(new Runnable() {
 
                        @Override
@@ -338,9 +447,18 @@ public class Core extends AbstractService {
                                try {
                                        FreenetURI realRequestUri = new FreenetURI(requestUri).setMetaString(new String[] { "sone.xml" });
                                        FetchResult fetchResult = freenetInterface.fetchUri(realRequestUri);
+                                       if (fetchResult == null) {
+                                               return;
+                                       }
                                        Sone parsedSone = soneDownloader.parseSone(null, fetchResult, realRequestUri);
                                        if (parsedSone != null) {
-                                               addSone(parsedSone);
+                                               if (insertUri != null) {
+                                                       parsedSone.setInsertUri(new FreenetURI(insertUri));
+                                                       addLocalSone(parsedSone);
+                                               } else {
+                                                       addSone(parsedSone);
+                                               }
+                                               setSoneStatus(parsedSone, SoneStatus.idle);
                                        }
                                } catch (MalformedURLException mue1) {
                                        logger.log(Level.INFO, "Could not create URI from “" + requestUri + "”.", mue1);
@@ -350,6 +468,26 @@ public class Core extends AbstractService {
        }
 
        /**
+        * Loads a Sone from an input stream.
+        *
+        * @param soneInputStream
+        *            The input stream to load the Sone from
+        * @return The parsed Sone, or {@code null} if the Sone could not be parsed
+        */
+       public Sone loadSone(InputStream soneInputStream) {
+               Sone parsedSone = soneDownloader.parseSone(soneInputStream);
+               if (parsedSone == null) {
+                       return null;
+               }
+               if (parsedSone.getInsertUri() != null) {
+                       addLocalSone(parsedSone);
+               } else {
+                       addSone(parsedSone);
+               }
+               return parsedSone;
+       }
+
+       /**
         * Loads and updates the given Sone.
         *
         * @param sone
@@ -362,10 +500,19 @@ public class Core extends AbstractService {
                        @SuppressWarnings("synthetic-access")
                        public void run() {
                                FreenetURI realRequestUri = sone.getRequestUri().setMetaString(new String[] { "sone.xml" });
-                               FetchResult fetchResult = freenetInterface.fetchUri(realRequestUri);
-                               Sone parsedSone = soneDownloader.parseSone(sone, fetchResult, realRequestUri);
-                               if (parsedSone != null) {
-                                       addSone(parsedSone);
+                               setSoneStatus(sone, SoneStatus.downloading);
+                               try {
+                                       FetchResult fetchResult = freenetInterface.fetchUri(realRequestUri);
+                                       if (fetchResult == null) {
+                                               /* TODO - mark Sone as bad. */
+                                               return;
+                                       }
+                                       Sone parsedSone = soneDownloader.parseSone(sone, fetchResult, realRequestUri);
+                                       if (parsedSone != null) {
+                                               addSone(parsedSone);
+                                       }
+                               } finally {
+                                       setSoneStatus(sone, (sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
                                }
                        }
                }, "Sone Downloader").start();
@@ -381,6 +528,8 @@ public class Core extends AbstractService {
                SoneInserter soneInserter = soneInserters.remove(sone);
                soneInserter.stop();
                localSones.remove(sone);
+               soneStatuses.remove(sone);
+               soneCache.remove(sone.getId());
        }
 
        /**
@@ -440,6 +589,52 @@ public class Core extends AbstractService {
                return replies;
        }
 
+       /**
+        * Gets all Sones that like the given post.
+        *
+        * @param post
+        *            The post to check for
+        * @return All Sones that like the post
+        */
+       public Collection<Sone> getLikes(final Post post) {
+               return Filters.filteredCollection(getKnownSones(), new Filter<Sone>() {
+
+                       @Override
+                       public boolean filterObject(Sone sone) {
+                               return sone.isLikedPostId(post.getId());
+                       }
+               });
+       }
+
+       /**
+        * Gets all Sones that like the given reply.
+        *
+        * @param reply
+        *            The reply to check for
+        * @return All Sones that like the reply
+        */
+       public Collection<Sone> getLikes(final Reply reply) {
+               return Filters.filteredCollection(getKnownSones(), new Filter<Sone>() {
+
+                       @Override
+                       public boolean filterObject(Sone sone) {
+                               return sone.isLikedReplyId(reply.getId());
+                       }
+               });
+       }
+
+       /**
+        * Deletes the given reply. It is removed from its Sone and from the reply
+        * cache.
+        *
+        * @param reply
+        *            The reply to remove
+        */
+       public void deleteReply(Reply reply) {
+               reply.getSone().removeReply(reply);
+               replyCache.remove(reply.getId());
+       }
+
        //
        // SERVICE METHODS
        //
@@ -470,11 +665,61 @@ public class Core extends AbstractService {
        //
 
        /**
+        * Adds some default Sones.
+        */
+       private void addDefaultSones() {
+               for (String soneUri : defaultSones) {
+                       loadSone(soneUri);
+               }
+       }
+
+       /**
         * Loads the configuration.
         */
+       @SuppressWarnings("unchecked")
        private void loadConfiguration() {
                logger.entering(Core.class.getName(), "loadConfiguration()");
 
+               boolean firstStart = configuration.getBooleanValue("FirstStart").getValue(true);
+               if (firstStart) {
+                       logger.log(Level.INFO, "First start of Sone, adding a couple of default Sones…");
+                       addDefaultSones();
+                       try {
+                               configuration.getBooleanValue("FirstStart").setValue(false);
+                       } catch (ConfigurationException ce1) {
+                               logger.log(Level.WARNING, "Could not clear “first start” flag!");
+                       }
+               }
+
+               options.addIntegerOption("InsertionDelay", new DefaultOption<Integer>(60, new OptionWatcher<Integer>() {
+
+                       @Override
+                       public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
+                               SoneInserter.setInsertionDelay(newValue);
+                       }
+
+               }));
+
+               options.addBooleanOption("ClearOnNextRestart", new DefaultOption<Boolean>(false));
+               options.addBooleanOption("ReallyClearOnNextRestart", new DefaultOption<Boolean>(false));
+
+               if (firstStart) {
+                       return;
+               }
+
+               options.getBooleanOption("ClearOnNextRestart").set(configuration.getBooleanValue("Option/ClearOnNextRestart").getValue(null));
+               options.getBooleanOption("ReallyClearOnNextRestart").set(configuration.getBooleanValue("Option/ReallyClearOnNextRestart").getValue(null));
+               boolean clearConfiguration = options.getBooleanOption("ClearOnNextRestart").get() && options.getBooleanOption("ReallyClearOnNextRestart").get();
+               options.getBooleanOption("ClearOnNextRestart").set(null);
+               options.getBooleanOption("ReallyClearOnNextRestart").set(null);
+               if (clearConfiguration) {
+                       /* stop loading the configuration. */
+                       addDefaultSones();
+                       return;
+               }
+
+               options.getIntegerOption("InsertionDelay").set(configuration.getIntValue("Option/InsertionDelay").getValue(null));
+
                /* parse local Sones. */
                logger.log(Level.INFO, "Loading Sones…");
                int soneId = 0;
@@ -485,18 +730,23 @@ public class Core extends AbstractService {
                                break;
                        }
                        String name = configuration.getStringValue(sonePrefix + "/Name").getValue(null);
+                       long time = configuration.getLongValue(sonePrefix + "/Time").getValue((long) 0);
                        String insertUri = configuration.getStringValue(sonePrefix + "/InsertURI").getValue(null);
                        String requestUri = configuration.getStringValue(sonePrefix + "/RequestURI").getValue(null);
                        long modificationCounter = configuration.getLongValue(sonePrefix + "/ModificationCounter").getValue((long) 0);
                        String firstName = configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null);
                        String middleName = configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null);
                        String lastName = configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null);
+                       Integer birthDay = configuration.getIntValue(sonePrefix + "/Profile/BirthDay").getValue(null);
+                       Integer birthMonth = configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").getValue(null);
+                       Integer birthYear = configuration.getIntValue(sonePrefix + "/Profile/BirthYear").getValue(null);
                        try {
                                Profile profile = new Profile();
                                profile.setFirstName(firstName);
                                profile.setMiddleName(middleName);
                                profile.setLastName(lastName);
-                               Sone sone = getSone(id).setName(name).setRequestUri(new FreenetURI(requestUri)).setInsertUri(new FreenetURI(insertUri));
+                               profile.setBirthDay(birthDay).setBirthMonth(birthMonth).setBirthYear(birthYear);
+                               Sone sone = getSone(id).setName(name).setTime(time).setRequestUri(new FreenetURI(requestUri)).setInsertUri(new FreenetURI(insertUri));
                                sone.setProfile(profile);
                                int postId = 0;
                                do {
@@ -505,7 +755,7 @@ public class Core extends AbstractService {
                                        if (id == null) {
                                                break;
                                        }
-                                       long time = configuration.getLongValue(postPrefix + "/Time").getValue(null);
+                                       time = configuration.getLongValue(postPrefix + "/Time").getValue((long) 0);
                                        String text = configuration.getStringValue(postPrefix + "/Text").getValue(null);
                                        Post post = getPost(id).setSone(sone).setTime(time).setText(text);
                                        sone.addPost(post);
@@ -539,6 +789,28 @@ public class Core extends AbstractService {
                                        sone.addFriend(friendSone);
                                }
 
+                               /* load liked post IDs. */
+                               int likedPostIdCounter = 0;
+                               while (true) {
+                                       String likedPostIdPrefix = sonePrefix + "/LikedPostId." + likedPostIdCounter++;
+                                       String likedPostId = configuration.getStringValue(likedPostIdPrefix + "/ID").getValue(null);
+                                       if (likedPostId == null) {
+                                               break;
+                                       }
+                                       sone.addLikedPostId(likedPostId);
+                               }
+
+                               /* load liked reply IDs. */
+                               int likedReplyIdCounter = 0;
+                               while (true) {
+                                       String likedReplyIdPrefix = sonePrefix + "/LikedReplyId." + likedReplyIdCounter++;
+                                       String likedReplyId = configuration.getStringValue(likedReplyIdPrefix + "/ID").getValue(null);
+                                       if (likedReplyId == null) {
+                                               break;
+                                       }
+                                       sone.addLikedReplyId(likedReplyId);
+                               }
+
                                sone.setModificationCounter(modificationCounter);
                                addLocalSone(sone);
                        } catch (MalformedURLException mue1) {
@@ -561,13 +833,20 @@ public class Core extends AbstractService {
        private void saveConfiguration() {
                Set<Sone> sones = getSones();
                logger.log(Level.INFO, "Storing %d Sones…", sones.size());
+
                try {
+                       /* store the options first. */
+                       configuration.getIntValue("Option/InsertionDelay").setValue(options.getIntegerOption("InsertionDelay").getReal());
+                       configuration.getBooleanValue("Option/ClearOnNextRestart").setValue(options.getBooleanOption("ClearOnNextRestart").getReal());
+                       configuration.getBooleanValue("Option/ReallyClearOnNextRestart").setValue(options.getBooleanOption("ReallyClearOnNextRestart").getReal());
+
                        /* store all Sones. */
                        int soneId = 0;
                        for (Sone sone : localSones) {
                                String sonePrefix = "Sone/Sone." + soneId++;
                                configuration.getStringValue(sonePrefix + "/ID").setValue(sone.getId());
                                configuration.getStringValue(sonePrefix + "/Name").setValue(sone.getName());
+                               configuration.getLongValue(sonePrefix + "/Time").setValue(sone.getTime());
                                configuration.getStringValue(sonePrefix + "/RequestURI").setValue(sone.getRequestUri().toString());
                                configuration.getStringValue(sonePrefix + "/InsertURI").setValue(sone.getInsertUri().toString());
                                configuration.getLongValue(sonePrefix + "/ModificationCounter").setValue(sone.getModificationCounter());
@@ -575,6 +854,9 @@ public class Core extends AbstractService {
                                configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
                                configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
                                configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
+                               configuration.getIntValue(sonePrefix + "/Profile/BirthDay").setValue(profile.getBirthDay());
+                               configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").setValue(profile.getBirthMonth());
+                               configuration.getIntValue(sonePrefix + "/Profile/BirthYear").setValue(profile.getBirthYear());
                                int postId = 0;
                                for (Post post : sone.getPosts()) {
                                        String postPrefix = sonePrefix + "/Post." + postId++;
@@ -606,6 +888,22 @@ public class Core extends AbstractService {
                                /* write null ID as terminator. */
                                configuration.getStringValue(sonePrefix + "/Friend." + friendId + "/ID").setValue(null);
 
+                               /* write all liked posts. */
+                               int likedPostIdCounter = 0;
+                               for (String soneLikedPostId : sone.getLikedPostIds()) {
+                                       String likedPostIdPrefix = sonePrefix + "/LikedPostId." + likedPostIdCounter++;
+                                       configuration.getStringValue(likedPostIdPrefix + "/ID").setValue(soneLikedPostId);
+                               }
+                               configuration.getStringValue(sonePrefix + "/LikedPostId." + likedPostIdCounter + "/ID").setValue(null);
+
+                               /* write all liked replies. */
+                               int likedReplyIdCounter = 0;
+                               for (String soneLikedReplyId : sone.getLikedReplyIds()) {
+                                       String likedReplyIdPrefix = sonePrefix + "/LikedReplyId." + likedReplyIdCounter++;
+                                       configuration.getStringValue(likedReplyIdPrefix + "/ID").setValue(soneLikedReplyId);
+                               }
+                               configuration.getStringValue(sonePrefix + "/LikedReplyId." + likedReplyIdCounter + "/ID").setValue(null);
+
                        }
                        /* write null ID as terminator. */
                        configuration.getStringValue("Sone/Sone." + soneId + "/ID").setValue(null);