🔀 Merge branch “release-80”
[Sone.git] / src / main / java / net / pterodactylus / sone / freenet / wot / WebOfTrustConnector.java
index de30a5d..c1dbef9 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Sone - WebOfTrustConnector.java - Copyright © 2010 David Roden
+ * Sone - WebOfTrustConnector.java - Copyright © 2010–2019 David Roden
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 
 package net.pterodactylus.sone.freenet.wot;
 
+import static java.util.logging.Logger.getLogger;
+import static net.pterodactylus.sone.utils.NumberParsers.parseInt;
+
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
+import java.util.concurrent.atomic.AtomicLong;
 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 net.pterodactylus.sone.freenet.plugin.event.ReceivedReplyEvent;
+
+import com.google.common.base.Optional;
+import com.google.common.collect.MapMaker;
+import com.google.common.eventbus.Subscribe;
+import com.google.inject.Inject;
+import com.google.inject.Singleton;
+
 import freenet.support.SimpleFieldSet;
 import freenet.support.api.Bucket;
 
 /**
  * Connector for the Web of Trust plugin.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class WebOfTrustConnector implements ConnectorListener {
+@Singleton
+public class WebOfTrustConnector {
 
        /** The logger. */
-       private static final Logger logger = Logging.getLogger(WebOfTrustConnector.class);
+       private static final Logger logger = getLogger(WebOfTrustConnector.class.getName());
 
        /** The name of the WoT plugin. */
        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 reply. */
-       private Reply reply;
+       /** Counter for connection identifiers. */
+       private final AtomicLong counter = new AtomicLong();
 
        /** The plugin connector. */
        private final PluginConnector pluginConnector;
 
+       /** Map for replies. */
+       private final Map<PluginIdentifier, Reply> replies = new MapMaker().makeMap();
+
        /**
         * Creates a new Web of Trust connector that uses the given plugin
         * connector.
@@ -60,9 +69,9 @@ public class WebOfTrustConnector implements ConnectorListener {
         * @param pluginConnector
         *            The plugin connector
         */
+       @Inject
        public WebOfTrustConnector(PluginConnector pluginConnector) {
                this.pluginConnector = pluginConnector;
-               pluginConnector.addConnectorListener(WOT_PLUGIN_NAME, PLUGIN_CONNECTION_IDENTIFIER, this);
        }
 
        //
@@ -73,7 +82,7 @@ public class WebOfTrustConnector implements ConnectorListener {
         * Stops the web of trust connector.
         */
        public void stop() {
-               pluginConnector.removeConnectorListener(WOT_PLUGIN_NAME, PLUGIN_CONNECTION_IDENTIFIER, this);
+               /* does nothing. */
        }
 
        /**
@@ -87,7 +96,7 @@ public class WebOfTrustConnector implements ConnectorListener {
                Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetOwnIdentities").get());
                SimpleFieldSet fields = reply.getFields();
                int ownIdentityCounter = -1;
-               Set<OwnIdentity> ownIdentities = new HashSet<OwnIdentity>();
+               Set<OwnIdentity> ownIdentities = new HashSet<>();
                while (true) {
                        String id = fields.get("Identity" + ++ownIdentityCounter);
                        if (id == null) {
@@ -96,9 +105,9 @@ public class WebOfTrustConnector implements ConnectorListener {
                        String requestUri = fields.get("RequestURI" + ownIdentityCounter);
                        String insertUri = fields.get("InsertURI" + ownIdentityCounter);
                        String nickname = fields.get("Nickname" + ownIdentityCounter);
-                       DefaultOwnIdentity ownIdentity = new DefaultOwnIdentity(this, id, nickname, requestUri, insertUri);
-                       ownIdentity.setContextsPrivate(parseContexts("Contexts" + ownIdentityCounter + ".", fields));
-                       ownIdentity.setPropertiesPrivate(parseProperties("Properties" + ownIdentityCounter + ".", fields));
+                       DefaultOwnIdentity ownIdentity = new DefaultOwnIdentity(id, nickname, requestUri, insertUri);
+                       ownIdentity.setContexts(parseContexts("Contexts" + ownIdentityCounter + ".", fields));
+                       ownIdentity.setProperties(parseProperties("Properties" + ownIdentityCounter + ".", fields));
                        ownIdentities.add(ownIdentity);
                }
                return ownIdentities;
@@ -115,7 +124,7 @@ public class WebOfTrustConnector implements ConnectorListener {
         *             if an error occured talking to the Web of Trust plugin
         */
        public Set<Identity> loadTrustedIdentities(OwnIdentity ownIdentity) throws PluginException {
-               return loadTrustedIdentities(ownIdentity, null);
+               return loadTrustedIdentities(ownIdentity, Optional.<String>absent());
        }
 
        /**
@@ -130,10 +139,10 @@ public class WebOfTrustConnector implements ConnectorListener {
         * @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());
+       public Set<Identity> loadTrustedIdentities(OwnIdentity ownIdentity, Optional<String> context) throws PluginException {
+               Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetIdentitiesByScore").put("Truster", ownIdentity.getId()).put("Selection", "+").put("Context", context.or("")).put("WantTrustValues", "true").get());
                SimpleFieldSet fields = reply.getFields();
-               Set<Identity> identities = new HashSet<Identity>();
+               Set<Identity> identities = new HashSet<>();
                int identityCounter = -1;
                while (true) {
                        String id = fields.get("Identity" + ++identityCounter);
@@ -142,9 +151,13 @@ public class WebOfTrustConnector implements ConnectorListener {
                        }
                        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));
+                       DefaultIdentity identity = new DefaultIdentity(id, nickname, requestUri);
+                       identity.setContexts(parseContexts("Contexts" + identityCounter + ".", fields));
+                       identity.setProperties(parseProperties("Properties" + identityCounter + ".", fields));
+                       Integer trust = parseInt(fields.get("Trust" + identityCounter), null);
+                       int score = parseInt(fields.get("Score" + identityCounter), 0);
+                       int rank = parseInt(fields.get("Rank" + identityCounter), 0);
+                       identity.setTrust(ownIdentity, new Trust(trust, score, rank));
                        identities.add(identity);
                }
                return identities;
@@ -315,8 +328,8 @@ public class WebOfTrustConnector implements ConnectorListener {
         *            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>();
+       private static Set<String> parseContexts(String prefix, SimpleFieldSet fields) {
+               Set<String> contexts = new HashSet<>();
                int contextCounter = -1;
                while (true) {
                        String context = fields.get(prefix + "Context" + ++contextCounter);
@@ -337,8 +350,8 @@ public class WebOfTrustConnector implements ConnectorListener {
         *            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>();
+       private static Map<String, String> parseProperties(String prefix, SimpleFieldSet fields) {
+               Map<String, String> properties = new HashMap<>();
                int propertiesCounter = -1;
                while (true) {
                        String propertyName = fields.get(prefix + "Property" + ++propertiesCounter + ".Name");
@@ -377,46 +390,57 @@ public class WebOfTrustConnector implements ConnectorListener {
         * @throws PluginException
         *             if the request could not be sent
         */
-       private synchronized Reply performRequest(SimpleFieldSet fields, Bucket data) throws PluginException {
-               reply = new Reply();
-               logger.log(Level.FINE, "Sending FCP Request: " + fields.get("Message"));
+       private Reply performRequest(SimpleFieldSet fields, Bucket data) throws PluginException {
+               String identifier = "FCP-Command-" + System.currentTimeMillis() + "-" + counter.getAndIncrement();
+               Reply reply = new Reply();
+               PluginIdentifier pluginIdentifier = new PluginIdentifier(WOT_PLUGIN_NAME, identifier);
+               replies.put(pluginIdentifier, 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 " + fields.get("Message") + ".", ie1);
+                               pluginConnector.sendRequest(WOT_PLUGIN_NAME, identifier, fields, data);
+                               while (reply.getFields() == null) {
+                                       try {
+                                               reply.wait();
+                                       } catch (InterruptedException ie1) {
+                                               logger.log(Level.WARNING, String.format("Got interrupted while waiting for reply on %s.", fields.get("Message")), ie1);
+                                       }
+                               }
+                       } finally {
+                               replies.remove(pluginIdentifier);
                        }
                }
-               logger.log(Level.FINEST, "Received FCP Response for %s: %s", new Object[] { fields.get("Message"), (reply.getFields() != null) ? reply.getFields().get("Message") : null });
+               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;
        }
 
-       //
-       // INTERFACE ConnectorListener
-       //
-
        /**
-        * {@inheritDoc}
+        * Notifies the connector that a plugin reply was received.
+        *
+        * @param receivedReplyEvent
+        *            The event
         */
-       @Override
-       public void receivedReply(PluginConnector pluginConnector, SimpleFieldSet fields, Bucket data) {
-               String messageName = fields.get("Message");
-               logger.log(Level.FINEST, "Received Reply from Plugin: " + messageName);
+       @Subscribe
+       public void receivedReply(ReceivedReplyEvent receivedReplyEvent) {
+               PluginIdentifier pluginIdentifier = new PluginIdentifier(receivedReplyEvent.pluginName(), receivedReplyEvent.identifier());
+               Reply reply = replies.remove(pluginIdentifier);
+               if (reply == null) {
+                       return;
+               }
+               logger.log(Level.FINEST, String.format("Received Reply from Plugin: %s", receivedReplyEvent.fieldSet().get("Message")));
                synchronized (reply) {
-                       reply.setFields(fields);
-                       reply.setData(data);
+                       reply.setFields(receivedReplyEvent.fieldSet());
+                       reply.setData(receivedReplyEvent.data());
                        reply.notify();
                }
        }
 
        /**
         * Container for the data of the reply from a plugin.
-        *
-        * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
         */
        private static class Reply {
 
@@ -474,8 +498,6 @@ public class WebOfTrustConnector implements ConnectorListener {
 
        /**
         * Helper method to create {@link SimpleFieldSet}s with terser code.
-        *
-        * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
         */
        private static class SimpleFieldSetConstructor {
 
@@ -542,8 +564,58 @@ public class WebOfTrustConnector implements ConnectorListener {
                 * @return The created simple field set constructor
                 */
                public static SimpleFieldSetConstructor create(boolean shortLived) {
-                       SimpleFieldSetConstructor simpleFieldSetConstructor = new SimpleFieldSetConstructor(shortLived);
-                       return simpleFieldSetConstructor;
+                       return new SimpleFieldSetConstructor(shortLived);
+               }
+
+       }
+
+       /**
+        * Container for identifying plugins. Plugins are identified by their plugin
+        * name and their unique identifier.
+        */
+       private static class PluginIdentifier {
+
+               /** The plugin name. */
+               private final String pluginName;
+
+               /** The plugin identifier. */
+               private final String identifier;
+
+               /**
+                * Creates a new plugin identifier.
+                *
+                * @param pluginName
+                *            The name of the plugin
+                * @param identifier
+                *            The identifier of the plugin
+                */
+               public PluginIdentifier(String pluginName, String identifier) {
+                       this.pluginName = pluginName;
+                       this.identifier = identifier;
+               }
+
+               //
+               // OBJECT METHODS
+               //
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public int hashCode() {
+                       return pluginName.hashCode() ^ identifier.hashCode();
+               }
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public boolean equals(Object object) {
+                       if (!(object instanceof PluginIdentifier)) {
+                               return false;
+                       }
+                       PluginIdentifier pluginIdentifier = (PluginIdentifier) object;
+                       return pluginName.equals(pluginIdentifier.pluginName) && identifier.equals(pluginIdentifier.identifier);
                }
 
        }