🔥 Remove unused method
[Sone.git] / src / main / java / net / pterodactylus / sone / freenet / wot / WebOfTrustConnector.java
index 5cacb68..cd1b7fb 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 java.util.HashMap;
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Set;
-import java.util.logging.Level;
+import java.util.*;
 import java.util.logging.Logger;
+import java.util.logging.*;
+import javax.annotation.*;
 
-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;
+import net.pterodactylus.sone.freenet.plugin.*;
+
+import com.google.inject.*;
+import freenet.support.*;
+import freenet.support.api.*;
+
+import static java.lang.String.*;
+import static java.util.logging.Logger.*;
+import static net.pterodactylus.sone.utils.NumberParsers.*;
 
 /**
  * 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;
-
        /** The plugin connector. */
        private final PluginConnector pluginConnector;
 
@@ -60,9 +54,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,10 +67,7 @@ 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();
-               }
+               /* does nothing. */
        }
 
        /**
@@ -87,10 +78,10 @@ public class WebOfTrustConnector implements ConnectorListener {
         *             if the own identities can not be loaded
         */
        public Set<OwnIdentity> loadAllOwnIdentities() throws WebOfTrustException {
-               Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetOwnIdentities").get());
+               PluginReply 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) {
@@ -99,9 +90,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;
@@ -133,10 +124,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, @Nullable String context) throws PluginException {
+               PluginReply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetIdentitiesByScore").put("Truster", ownIdentity.getId()).put("Selection", "+").put("Context", (context == null) ? "" : context).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);
@@ -145,9 +136,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;
@@ -182,22 +177,6 @@ public class WebOfTrustConnector implements ConnectorListener {
        }
 
        /**
-        * 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
@@ -240,7 +219,7 @@ public class WebOfTrustConnector implements ConnectorListener {
         *             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());
+               PluginReply 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");
@@ -318,8 +297,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);
@@ -340,8 +319,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");
@@ -364,7 +343,7 @@ public class WebOfTrustConnector implements ConnectorListener {
         * @throws PluginException
         *             if the request could not be sent
         */
-       private Reply performRequest(SimpleFieldSet fields) throws PluginException {
+       private PluginReply performRequest(SimpleFieldSet fields) throws PluginException {
                return performRequest(fields, null);
        }
 
@@ -380,105 +359,18 @@ 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, 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, 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"))) {
+       private PluginReply performRequest(SimpleFieldSet fields, Bucket data) throws PluginException {
+               logger.log(Level.FINE, format("Sending FCP Request: %s", fields.get("Message")));
+               PluginReply pluginReply = pluginConnector.sendRequest(WOT_PLUGIN_NAME, "", fields, data);
+               logger.log(Level.FINEST, format("Received FCP Response for %s: %s", fields.get("Message"), pluginReply.getFields().get("Message")));
+               if ("Error".equals(pluginReply.getFields().get("Message"))) {
                        throw new PluginException("Could not perform request for " + fields.get("Message"));
                }
-               return reply;
-       }
-
-       //
-       // INTERFACE ConnectorListener
-       //
-
-       /**
-        * {@inheritDoc}
-        */
-       @Override
-       public void receivedReply(PluginConnector pluginConnector, SimpleFieldSet fields, Bucket data) {
-               String messageName = fields.get("Message");
-               logger.log(Level.FINEST, String.format("Received Reply from Plugin: %s", messageName));
-               synchronized (reply) {
-                       reply.setFields(fields);
-                       reply.setData(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 {
-
-               /** The fields of the reply. */
-               private SimpleFieldSet fields;
-
-               /** The payload of the reply. */
-               private Bucket data;
-
-               /** Empty constructor. */
-               public Reply() {
-                       /* do nothing. */
-               }
-
-               /**
-                * Returns the fields of the reply.
-                *
-                * @return The fields of the reply
-                */
-               public SimpleFieldSet getFields() {
-                       return fields;
-               }
-
-               /**
-                * Sets the fields of the reply.
-                *
-                * @param fields
-                *            The fields of the reply
-                */
-               public void setFields(SimpleFieldSet fields) {
-                       this.fields = fields;
-               }
-
-               /**
-                * Returns the payload of the reply.
-                *
-                * @return The payload of the reply (may be {@code null})
-                */
-               @SuppressWarnings("unused")
-               public Bucket getData() {
-                       return data;
-               }
-
-               /**
-                * Sets the payload of the reply.
-                *
-                * @param data
-                *            The payload of the reply (may be {@code null})
-                */
-               public void setData(Bucket data) {
-                       this.data = data;
-               }
-
+               return pluginReply;
        }
 
        /**
         * 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 {
 
@@ -545,8 +437,7 @@ 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);
                }
 
        }