/*
- * 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.Collections;
+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.util.logging.Logging;
+import net.pterodactylus.sone.freenet.plugin.PluginConnector;
+import net.pterodactylus.sone.freenet.plugin.PluginException;
+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.WoT.WoT";
-
- /** A random connection identifier. */
- private static final String PLUGIN_CONNECTION_IDENTIFIER = "Sone-WoT-Connector-" + Math.abs(Math.random());
+ private static final String WOT_PLUGIN_NAME = "plugins.WebOfTrust.WebOfTrust";
- /** The current replies that we wait for. */
- private final Map<String, Reply> replies = Collections.synchronizedMap(new HashMap<String, 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.
* @param pluginConnector
* The plugin connector
*/
+ @Inject
public WebOfTrustConnector(PluginConnector pluginConnector) {
this.pluginConnector = pluginConnector;
- pluginConnector.addConnectorListener(WOT_PLUGIN_NAME, PLUGIN_CONNECTION_IDENTIFIER, this);
}
//
//
/**
+ * Stops the web of trust connector.
+ */
+ public void stop() {
+ /* does nothing. */
+ }
+
+ /**
* 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>();
+ Set<OwnIdentity> ownIdentities = new HashSet<>();
while (true) {
String id = fields.get("Identity" + ++ownIdentityCounter);
if (id == null) {
String requestUri = fields.get("RequestURI" + ownIdentityCounter);
String insertUri = fields.get("InsertURI" + ownIdentityCounter);
String nickname = fields.get("Nickname" + ownIdentityCounter);
- OwnIdentity ownIdentity = new OwnIdentity(this, id, nickname, requestUri, insertUri);
+ 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;
}
/**
- * Loads the contexts of the given identity.
- *
- * @param identity
- * The identity to load the contexts for
- * @return The contexts of the identity
- * @throws PluginException
- * if an error occured talking to the Web of Trust plugin
- */
- public Set<String> loadIdentityContexts(Identity identity) throws PluginException {
- Reply reply = performRequest("Identity", SimpleFieldSetConstructor.create().put("Message", "GetIdentity").put("TreeOwner", identity.getId()).put("Identity", identity.getId()).get());
- SimpleFieldSet fields = reply.getFields();
- int contextCounter = -1;
- Set<String> contexts = new HashSet<String>();
- while (true) {
- String context = fields.get("Context" + ++contextCounter);
- if (context == null) {
- break;
- }
- contexts.add(context);
- }
- return contexts;
- }
-
- /**
* Loads all identities that the given identities trusts with a score of
* more than 0.
*
* 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());
}
/**
* @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("Identities", 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);
}
String nickname = fields.get("Nickname" + identityCounter);
String requestUri = fields.get("RequestURI" + identityCounter);
- identities.add(new Identity(this, id, nickname, requestUri));
+ 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;
}
+ /**
+ * 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 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);
+ 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 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");
+ 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
* @throws PluginException
* if the request could not be sent
*/
- private Reply performRequest(String targetMessage, SimpleFieldSet fields, Bucket data) throws PluginException {
- @SuppressWarnings("synthetic-access")
+ private Reply performRequest(SimpleFieldSet fields, Bucket data) throws PluginException {
+ String identifier = "FCP-Command-" + System.currentTimeMillis() + "-" + counter.getAndIncrement();
Reply reply = new Reply();
- replies.put(targetMessage, 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 GetOwnIdentities.", 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, 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");
- Reply reply = replies.remove(messageName);
+ @Subscribe
+ public void receivedReply(ReceivedReplyEvent receivedReplyEvent) {
+ PluginIdentifier pluginIdentifier = new PluginIdentifier(receivedReplyEvent.pluginName(), receivedReplyEvent.identifier());
+ Reply reply = replies.remove(pluginIdentifier);
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", 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 {
/** The payload of the reply. */
private Bucket data;
+ /** Empty constructor. */
+ public Reply() {
+ /* do nothing. */
+ }
+
/**
* Returns the fields of the reply.
*
/**
* 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 {
* @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);
}
}
projects / Sone.git / blobdiff