--- /dev/null
+/*
+ * Sone - WebOfTrustConnector.java - Copyright © 2010–2013 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.freenet.wot;
+
+import static java.util.logging.Logger.getLogger;
+
+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 javax.inject.Inject;
+import javax.inject.Singleton;
+
+import net.pterodactylus.freenet.plugin.PluginConnector;
+import net.pterodactylus.freenet.plugin.PluginException;
+import net.pterodactylus.freenet.plugin.event.ReceivedReplyEvent;
+
+import freenet.support.SimpleFieldSet;
+import freenet.support.api.Bucket;
+
+import com.google.common.base.Optional;
+import com.google.common.collect.MapMaker;
+import com.google.common.eventbus.Subscribe;
+import com.google.common.primitives.Ints;
+
+/**
+ * Connector for the Web of Trust plugin.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+@Singleton
+public class WebOfTrustConnector {
+
+ private static final Logger logger = getLogger("Sone.WoT.Connector");
+ private static final String WOT_PLUGIN_NAME = "plugins.WebOfTrust.WebOfTrust";
+
+ private final AtomicLong counter = new AtomicLong();
+ private final PluginConnector pluginConnector;
+ private final Map<PluginIdentifier, Reply> replies = new MapMaker().makeMap();
+
+ @Inject
+ public WebOfTrustConnector(PluginConnector pluginConnector) {
+ this.pluginConnector = pluginConnector;
+ }
+
+ public Set<OwnIdentity> loadAllOwnIdentities() throws PluginException {
+ Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetOwnIdentities").get());
+ SimpleFieldSet fields = reply.getFields();
+ int ownIdentityCounter = -1;
+ Set<OwnIdentity> ownIdentities = new HashSet<>();
+ while (true) {
+ String id = fields.get("Identity" + ++ownIdentityCounter);
+ if (id == null) {
+ break;
+ }
+ String requestUri = fields.get("RequestURI" + ownIdentityCounter);
+ String insertUri = fields.get("InsertURI" + ownIdentityCounter);
+ String nickname = fields.get("Nickname" + ownIdentityCounter);
+ 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 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, 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<>();
+ 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(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;
+ }
+
+ private static Integer parseInt(String value, Integer defaultValue) {
+ return java.util.Optional.ofNullable(value).map(Ints::tryParse).orElse(defaultValue);
+ }
+
+ /**
+ * 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 PluginException {
+ 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 fields
+ * The fields of the message
+ * @return The reply message
+ * @throws PluginException
+ * if the request could not be sent
+ */
+ 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 fields
+ * The fields of the message
+ * @param data
+ * The payload of the message
+ * @return The reply message
+ * @throws PluginException
+ * if the request could not be sent
+ */
+ 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) {
+ try {
+ 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;
+ }
+
+ /**
+ * Notifies the connector that a plugin reply was received.
+ *
+ * @param receivedReplyEvent
+ * The event
+ */
+ @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(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 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;
+ }
+
+ }
+
+ /**
+ * 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 {
+
+ /** The field set being created. */
+ private final SimpleFieldSet simpleFieldSet;
+
+ /**
+ * Creates a new simple field set constructor.
+ *
+ * @param shortLived
+ * {@code true} if the resulting simple field set should be
+ * short-lived, {@code false} otherwise
+ */
+ private SimpleFieldSetConstructor(boolean shortLived) {
+ simpleFieldSet = new SimpleFieldSet(shortLived);
+ }
+
+ //
+ // ACCESSORS
+ //
+
+ /**
+ * Returns the created simple field set.
+ *
+ * @return The created simple field set
+ */
+ public SimpleFieldSet get() {
+ return simpleFieldSet;
+ }
+
+ /**
+ * Sets the field with the given name to the given value.
+ *
+ * @param name
+ * The name of the fleld
+ * @param value
+ * The value of the field
+ * @return This constructor (for method chaining)
+ */
+ public SimpleFieldSetConstructor put(String name, String value) {
+ simpleFieldSet.putOverwrite(name, value);
+ return this;
+ }
+
+ //
+ // ACTIONS
+ //
+
+ /**
+ * Creates a new simple field set constructor.
+ *
+ * @return The created simple field set constructor
+ */
+ public static SimpleFieldSetConstructor create() {
+ return create(true);
+ }
+
+ /**
+ * Creates a new simple field set constructor.
+ *
+ * @param shortLived
+ * {@code true} if the resulting simple field set should be
+ * short-lived, {@code false} otherwise
+ * @return The created simple field set constructor
+ */
+ public static SimpleFieldSetConstructor create(boolean shortLived) {
+ return new SimpleFieldSetConstructor(shortLived);
+ }
+
+ }
+
+ /**
+ * Container for identifying plugins. Plugins are identified by their plugin
+ * name and their unique identifier.
+ *
+ * @author <a href="mailto:d.roden@xplosion.de">David Roden</a>
+ */
+ 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 / fwot.git / blobdiff