Fix ALL the logging!
[Sone.git] / src / main / java / net / pterodactylus / sone / freenet / wot / WebOfTrustConnector.java
index 65b7ce8..5cacb68 100644 (file)
@@ -17,7 +17,6 @@
 
 package net.pterodactylus.sone.freenet.wot;
 
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
@@ -25,6 +24,9 @@ import java.util.Set;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import net.pterodactylus.sone.freenet.plugin.ConnectorListener;
+import net.pterodactylus.sone.freenet.plugin.PluginConnector;
+import net.pterodactylus.sone.freenet.plugin.PluginException;
 import net.pterodactylus.util.logging.Logging;
 import freenet.support.SimpleFieldSet;
 import freenet.support.api.Bucket;
@@ -40,13 +42,13 @@ public class WebOfTrustConnector implements ConnectorListener {
        private static final Logger logger = Logging.getLogger(WebOfTrustConnector.class);
 
        /** The name of the WoT plugin. */
-       private static final String WOT_PLUGIN_NAME = "plugins.WoT.WoT";
+       private static final String WOT_PLUGIN_NAME = "plugins.WebOfTrust.WebOfTrust";
 
        /** A random connection identifier. */
        private static final String PLUGIN_CONNECTION_IDENTIFIER = "Sone-WoT-Connector-" + Math.abs(Math.random());
 
-       /** The current replies that we wait for. */
-       private final Map<String, Reply> replies = Collections.synchronizedMap(new HashMap<String, Reply>());
+       /** The current reply. */
+       private Reply reply;
 
        /** The plugin connector. */
        private final PluginConnector pluginConnector;
@@ -68,14 +70,24 @@ public class WebOfTrustConnector implements ConnectorListener {
        //
 
        /**
+        * Stops the web of trust connector.
+        */
+       public void stop() {
+               pluginConnector.removeConnectorListener(WOT_PLUGIN_NAME, PLUGIN_CONNECTION_IDENTIFIER, this);
+               synchronized (reply) {
+                       reply.notifyAll();
+               }
+       }
+
+       /**
         * Loads all own identities from the Web of Trust plugin.
         *
         * @return All own identity
-        * @throws PluginException
+        * @throws WebOfTrustException
         *             if the own identities can not be loaded
         */
-       public Set<OwnIdentity> loadAllOwnIdentities() throws PluginException {
-               Reply reply = performRequest("OwnIdentities", SimpleFieldSetConstructor.create().put("Message", "GetOwnIdentities").get());
+       public Set<OwnIdentity> loadAllOwnIdentities() throws WebOfTrustException {
+               Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetOwnIdentities").get());
                SimpleFieldSet fields = reply.getFields();
                int ownIdentityCounter = -1;
                Set<OwnIdentity> ownIdentities = new HashSet<OwnIdentity>();
@@ -87,38 +99,279 @@ public class WebOfTrustConnector implements ConnectorListener {
                        String requestUri = fields.get("RequestURI" + ownIdentityCounter);
                        String insertUri = fields.get("InsertURI" + ownIdentityCounter);
                        String nickname = fields.get("Nickname" + ownIdentityCounter);
-                       OwnIdentity ownIdentity = new OwnIdentity(id, nickname, requestUri, insertUri);
+                       DefaultOwnIdentity ownIdentity = new DefaultOwnIdentity(this, id, nickname, requestUri, insertUri);
+                       ownIdentity.setContextsPrivate(parseContexts("Contexts" + ownIdentityCounter + ".", fields));
+                       ownIdentity.setPropertiesPrivate(parseProperties("Properties" + ownIdentityCounter + ".", fields));
                        ownIdentities.add(ownIdentity);
                }
                return ownIdentities;
        }
 
+       /**
+        * Loads all identities that the given identities trusts with a score of
+        * more than 0.
+        *
+        * @param ownIdentity
+        *            The own identity
+        * @return All trusted identities
+        * @throws PluginException
+        *             if an error occured talking to the Web of Trust plugin
+        */
+       public Set<Identity> loadTrustedIdentities(OwnIdentity ownIdentity) throws PluginException {
+               return loadTrustedIdentities(ownIdentity, null);
+       }
+
+       /**
+        * Loads all identities that the given identities trusts with a score of
+        * more than 0 and the (optional) given context.
+        *
+        * @param ownIdentity
+        *            The own identity
+        * @param context
+        *            The context to filter, or {@code null}
+        * @return All trusted identities
+        * @throws PluginException
+        *             if an error occured talking to the Web of Trust plugin
+        */
+       public Set<Identity> loadTrustedIdentities(OwnIdentity ownIdentity, String context) throws PluginException {
+               Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetIdentitiesByScore").put("TreeOwner", ownIdentity.getId()).put("Selection", "+").put("Context", (context == null) ? "" : context).get());
+               SimpleFieldSet fields = reply.getFields();
+               Set<Identity> identities = new HashSet<Identity>();
+               int identityCounter = -1;
+               while (true) {
+                       String id = fields.get("Identity" + ++identityCounter);
+                       if (id == null) {
+                               break;
+                       }
+                       String nickname = fields.get("Nickname" + identityCounter);
+                       String requestUri = fields.get("RequestURI" + identityCounter);
+                       DefaultIdentity identity = new DefaultIdentity(this, id, nickname, requestUri);
+                       identity.setContextsPrivate(parseContexts("Contexts" + identityCounter + ".", fields));
+                       identity.setPropertiesPrivate(parseProperties("Properties" + identityCounter + ".", fields));
+                       identities.add(identity);
+               }
+               return identities;
+       }
+
+       /**
+        * Adds the given context to the given identity.
+        *
+        * @param ownIdentity
+        *            The identity to add the context to
+        * @param context
+        *            The context to add
+        * @throws PluginException
+        *             if an error occured talking to the Web of Trust plugin
+        */
+       public void addContext(OwnIdentity ownIdentity, String context) throws PluginException {
+               performRequest(SimpleFieldSetConstructor.create().put("Message", "AddContext").put("Identity", ownIdentity.getId()).put("Context", context).get());
+       }
+
+       /**
+        * Removes the given context from the given identity.
+        *
+        * @param ownIdentity
+        *            The identity to remove the context from
+        * @param context
+        *            The context to remove
+        * @throws PluginException
+        *             if an error occured talking to the Web of Trust plugin
+        */
+       public void removeContext(OwnIdentity ownIdentity, String context) throws PluginException {
+               performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveContext").put("Identity", ownIdentity.getId()).put("Context", context).get());
+       }
+
+       /**
+        * Returns the value of the property with the given name.
+        *
+        * @param identity
+        *            The identity whose properties to check
+        * @param name
+        *            The name of the property to return
+        * @return The value of the property, or {@code null} if there is no value
+        * @throws PluginException
+        *             if an error occured talking to the Web of Trust plugin
+        */
+       public String getProperty(Identity identity, String name) throws PluginException {
+               Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetProperty").put("Identity", identity.getId()).put("Property", name).get());
+               return reply.getFields().get("Property");
+       }
+
+       /**
+        * Sets the property with the given name to the given value.
+        *
+        * @param ownIdentity
+        *            The identity to set the property on
+        * @param name
+        *            The name of the property to set
+        * @param value
+        *            The value to set
+        * @throws PluginException
+        *             if an error occured talking to the Web of Trust plugin
+        */
+       public void setProperty(OwnIdentity ownIdentity, String name, String value) throws PluginException {
+               performRequest(SimpleFieldSetConstructor.create().put("Message", "SetProperty").put("Identity", ownIdentity.getId()).put("Property", name).put("Value", value).get());
+       }
+
+       /**
+        * Removes the property with the given name.
+        *
+        * @param ownIdentity
+        *            The identity to remove the property from
+        * @param name
+        *            The name of the property to remove
+        * @throws PluginException
+        *             if an error occured talking to the Web of Trust plugin
+        */
+       public void removeProperty(OwnIdentity ownIdentity, String name) throws PluginException {
+               performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveProperty").put("Identity", ownIdentity.getId()).put("Property", name).get());
+       }
+
+       /**
+        * Returns the trust for the given identity assigned to it by the given own
+        * identity.
+        *
+        * @param ownIdentity
+        *            The own identity
+        * @param identity
+        *            The identity to get the trust for
+        * @return The trust for the given identity
+        * @throws PluginException
+        *             if an error occured talking to the Web of Trust plugin
+        */
+       public Trust getTrust(OwnIdentity ownIdentity, Identity identity) throws PluginException {
+               Reply getTrustReply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetIdentity").put("Truster", ownIdentity.getId()).put("Identity", identity.getId()).get());
+               String trust = getTrustReply.getFields().get("Trust");
+               String score = getTrustReply.getFields().get("Score");
+               String rank = getTrustReply.getFields().get("Rank");
+               Integer explicit = null;
+               Integer implicit = null;
+               Integer distance = null;
+               try {
+                       explicit = Integer.valueOf(trust);
+               } catch (NumberFormatException nfe1) {
+                       /* ignore. */
+               }
+               try {
+                       implicit = Integer.valueOf(score);
+                       distance = Integer.valueOf(rank);
+               } catch (NumberFormatException nfe1) {
+                       /* ignore. */
+               }
+               return new Trust(explicit, implicit, distance);
+       }
+
+       /**
+        * Sets the trust for the given identity.
+        *
+        * @param ownIdentity
+        *            The trusting identity
+        * @param identity
+        *            The trusted identity
+        * @param trust
+        *            The amount of trust (-100 thru 100)
+        * @param comment
+        *            The comment or explanation of the trust value
+        * @throws PluginException
+        *             if an error occured talking to the Web of Trust plugin
+        */
+       public void setTrust(OwnIdentity ownIdentity, Identity identity, int trust, String comment) throws PluginException {
+               performRequest(SimpleFieldSetConstructor.create().put("Message", "SetTrust").put("Truster", ownIdentity.getId()).put("Trustee", identity.getId()).put("Value", String.valueOf(trust)).put("Comment", comment).get());
+       }
+
+       /**
+        * Removes any trust assignment of the given own identity for the given
+        * identity.
+        *
+        * @param ownIdentity
+        *            The own identity
+        * @param identity
+        *            The identity to remove all trust for
+        * @throws WebOfTrustException
+        *             if an error occurs
+        */
+       public void removeTrust(OwnIdentity ownIdentity, Identity identity) throws WebOfTrustException {
+               performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveTrust").put("Truster", ownIdentity.getId()).put("Trustee", identity.getId()).get());
+       }
+
+       /**
+        * Pings the Web of Trust plugin. If the plugin can not be reached, a
+        * {@link PluginException} is thrown.
+        *
+        * @throws PluginException
+        *             if the plugin is not loaded
+        */
+       public void ping() throws PluginException {
+               performRequest(SimpleFieldSetConstructor.create().put("Message", "Ping").get());
+       }
+
        //
        // PRIVATE ACTIONS
        //
 
        /**
+        * Parses the contexts from the given fields.
+        *
+        * @param prefix
+        *            The prefix to use to access the contexts
+        * @param fields
+        *            The fields to parse the contexts from
+        * @return The parsed contexts
+        */
+       private Set<String> parseContexts(String prefix, SimpleFieldSet fields) {
+               Set<String> contexts = new HashSet<String>();
+               int contextCounter = -1;
+               while (true) {
+                       String context = fields.get(prefix + "Context" + ++contextCounter);
+                       if (context == null) {
+                               break;
+                       }
+                       contexts.add(context);
+               }
+               return contexts;
+       }
+
+       /**
+        * Parses the properties from the given fields.
+        *
+        * @param prefix
+        *            The prefix to use to access the properties
+        * @param fields
+        *            The fields to parse the properties from
+        * @return The parsed properties
+        */
+       private Map<String, String> parseProperties(String prefix, SimpleFieldSet fields) {
+               Map<String, String> properties = new HashMap<String, String>();
+               int propertiesCounter = -1;
+               while (true) {
+                       String propertyName = fields.get(prefix + "Property" + ++propertiesCounter + ".Name");
+                       if (propertyName == null) {
+                               break;
+                       }
+                       String propertyValue = fields.get(prefix + "Property" + propertiesCounter + ".Value");
+                       properties.put(propertyName, propertyValue);
+               }
+               return properties;
+       }
+
+       /**
         * Sends a request containing the given fields and waits for the target
         * message.
         *
-        * @param targetMessage
-        *            The message of the reply to wait for
         * @param fields
         *            The fields of the message
         * @return The reply message
         * @throws PluginException
         *             if the request could not be sent
         */
-       private Reply performRequest(String targetMessage, SimpleFieldSet fields) throws PluginException {
-               return performRequest(targetMessage, fields, null);
+       private Reply performRequest(SimpleFieldSet fields) throws PluginException {
+               return performRequest(fields, null);
        }
 
        /**
         * Sends a request containing the given fields and waits for the target
         * message.
         *
-        * @param targetMessage
-        *            The message of the reply to wait for
         * @param fields
         *            The fields of the message
         * @param data
@@ -127,18 +380,21 @@ public class WebOfTrustConnector implements ConnectorListener {
         * @throws PluginException
         *             if the request could not be sent
         */
-       private Reply performRequest(String targetMessage, SimpleFieldSet fields, Bucket data) throws PluginException {
-               @SuppressWarnings("synthetic-access")
-               Reply reply = new Reply();
-               replies.put(targetMessage, reply);
+       private synchronized Reply performRequest(SimpleFieldSet fields, Bucket data) throws PluginException {
+               reply = new Reply();
+               logger.log(Level.FINE, String.format("Sending FCP Request: %s", fields.get("Message")));
                synchronized (reply) {
                        pluginConnector.sendRequest(WOT_PLUGIN_NAME, PLUGIN_CONNECTION_IDENTIFIER, fields, data);
                        try {
                                reply.wait();
                        } catch (InterruptedException ie1) {
-                               logger.log(Level.WARNING, "Got interrupted while waiting for reply on GetOwnIdentities.", ie1);
+                               logger.log(Level.WARNING, String.format("Got interrupted while waiting for reply on %s.", fields.get("Message")), ie1);
                        }
                }
+               logger.log(Level.FINEST, String.format("Received FCP Response for %s: %s", fields.get("Message"), (reply.getFields() != null) ? reply.getFields().get("Message") : null));
+               if ((reply.getFields() == null) || "Error".equals(reply.getFields().get("Message"))) {
+                       throw new PluginException("Could not perform request for " + fields.get("Message"));
+               }
                return reply;
        }
 
@@ -152,11 +408,7 @@ public class WebOfTrustConnector implements ConnectorListener {
        @Override
        public void receivedReply(PluginConnector pluginConnector, SimpleFieldSet fields, Bucket data) {
                String messageName = fields.get("Message");
-               Reply reply = replies.remove(messageName);
-               if (reply == null) {
-                       logger.log(Level.FINE, "Not waiting for a ā€œ%sā€ message.", messageName);
-                       return;
-               }
+               logger.log(Level.FINEST, String.format("Received Reply from Plugin: %s", messageName));
                synchronized (reply) {
                        reply.setFields(fields);
                        reply.setData(data);
@@ -177,6 +429,11 @@ public class WebOfTrustConnector implements ConnectorListener {
                /** The payload of the reply. */
                private Bucket data;
 
+               /** Empty constructor. */
+               public Reply() {
+                       /* do nothing. */
+               }
+
                /**
                 * Returns the fields of the reply.
                 *