2 * Sone - WebOfTrustConnector.java - Copyright © 2010–2013 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sone.freenet.wot;
20 import java.util.HashMap;
21 import java.util.HashSet;
24 import java.util.concurrent.atomic.AtomicLong;
25 import java.util.logging.Level;
26 import java.util.logging.Logger;
28 import net.pterodactylus.sone.freenet.plugin.PluginConnector;
29 import net.pterodactylus.sone.freenet.plugin.PluginException;
30 import net.pterodactylus.sone.freenet.plugin.event.ReceivedReplyEvent;
31 import net.pterodactylus.util.logging.Logging;
32 import net.pterodactylus.util.number.Numbers;
34 import com.google.common.collect.MapMaker;
35 import com.google.common.eventbus.Subscribe;
36 import com.google.inject.Inject;
38 import freenet.support.SimpleFieldSet;
39 import freenet.support.api.Bucket;
42 * Connector for the Web of Trust plugin.
44 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
46 public class WebOfTrustConnector {
49 private static final Logger logger = Logging.getLogger(WebOfTrustConnector.class);
51 /** The name of the WoT plugin. */
52 private static final String WOT_PLUGIN_NAME = "plugins.WebOfTrust.WebOfTrust";
54 /** Counter for connection identifiers. */
55 private final AtomicLong counter = new AtomicLong();
57 /** The plugin connector. */
58 private final PluginConnector pluginConnector;
60 /** Map for replies. */
61 private final Map<PluginIdentifier, Reply> replies = new MapMaker().makeMap();
64 * Creates a new Web of Trust connector that uses the given plugin
67 * @param pluginConnector
68 * The plugin connector
71 public WebOfTrustConnector(PluginConnector pluginConnector) {
72 this.pluginConnector = pluginConnector;
80 * Stops the web of trust connector.
87 * Loads all own identities from the Web of Trust plugin.
89 * @return All own identity
90 * @throws WebOfTrustException
91 * if the own identities can not be loaded
93 public Set<OwnIdentity> loadAllOwnIdentities() throws WebOfTrustException {
94 Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetOwnIdentities").get());
95 SimpleFieldSet fields = reply.getFields();
96 int ownIdentityCounter = -1;
97 Set<OwnIdentity> ownIdentities = new HashSet<OwnIdentity>();
99 String id = fields.get("Identity" + ++ownIdentityCounter);
103 String requestUri = fields.get("RequestURI" + ownIdentityCounter);
104 String insertUri = fields.get("InsertURI" + ownIdentityCounter);
105 String nickname = fields.get("Nickname" + ownIdentityCounter);
106 DefaultOwnIdentity ownIdentity = new DefaultOwnIdentity(id, nickname, requestUri, insertUri);
107 ownIdentity.setContexts(parseContexts("Contexts" + ownIdentityCounter + ".", fields));
108 ownIdentity.setProperties(parseProperties("Properties" + ownIdentityCounter + ".", fields));
109 ownIdentities.add(ownIdentity);
111 return ownIdentities;
115 * Loads all identities that the given identities trusts with a score of
120 * @return All trusted identities
121 * @throws PluginException
122 * if an error occured talking to the Web of Trust plugin
124 public Set<Identity> loadTrustedIdentities(OwnIdentity ownIdentity) throws PluginException {
125 return loadTrustedIdentities(ownIdentity, null);
129 * Loads all identities that the given identities trusts with a score of
130 * more than 0 and the (optional) given context.
135 * The context to filter, or {@code null}
136 * @return All trusted identities
137 * @throws PluginException
138 * if an error occured talking to the Web of Trust plugin
140 public Set<Identity> loadTrustedIdentities(OwnIdentity ownIdentity, String context) throws PluginException {
141 Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetIdentitiesByScore").put("Truster", ownIdentity.getId()).put("Selection", "+").put("Context", (context == null) ? "" : context).put("WantTrustValues", "true").get());
142 SimpleFieldSet fields = reply.getFields();
143 Set<Identity> identities = new HashSet<Identity>();
144 int identityCounter = -1;
146 String id = fields.get("Identity" + ++identityCounter);
150 String nickname = fields.get("Nickname" + identityCounter);
151 String requestUri = fields.get("RequestURI" + identityCounter);
152 DefaultIdentity identity = new DefaultIdentity(id, nickname, requestUri);
153 identity.setContexts(parseContexts("Contexts" + identityCounter + ".", fields));
154 identity.setProperties(parseProperties("Properties" + identityCounter + ".", fields));
155 Integer trust = Numbers.safeParseInteger(fields.get("Trust" + identityCounter), null);
156 int score = Numbers.safeParseInteger(fields.get("Score" + identityCounter), 0);
157 int rank = Numbers.safeParseInteger(fields.get("Rank" + identityCounter), 0);
158 identity.setTrust(ownIdentity, new Trust(trust, score, rank));
159 identities.add(identity);
165 * Adds the given context to the given identity.
168 * The identity to add the context to
171 * @throws PluginException
172 * if an error occured talking to the Web of Trust plugin
174 public void addContext(OwnIdentity ownIdentity, String context) throws PluginException {
175 performRequest(SimpleFieldSetConstructor.create().put("Message", "AddContext").put("Identity", ownIdentity.getId()).put("Context", context).get());
179 * Removes the given context from the given identity.
182 * The identity to remove the context from
184 * The context to remove
185 * @throws PluginException
186 * if an error occured talking to the Web of Trust plugin
188 public void removeContext(OwnIdentity ownIdentity, String context) throws PluginException {
189 performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveContext").put("Identity", ownIdentity.getId()).put("Context", context).get());
193 * Returns the value of the property with the given name.
196 * The identity whose properties to check
198 * The name of the property to return
199 * @return The value of the property, or {@code null} if there is no value
200 * @throws PluginException
201 * if an error occured talking to the Web of Trust plugin
203 public String getProperty(Identity identity, String name) throws PluginException {
204 Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetProperty").put("Identity", identity.getId()).put("Property", name).get());
205 return reply.getFields().get("Property");
209 * Sets the property with the given name to the given value.
212 * The identity to set the property on
214 * The name of the property to set
217 * @throws PluginException
218 * if an error occured talking to the Web of Trust plugin
220 public void setProperty(OwnIdentity ownIdentity, String name, String value) throws PluginException {
221 performRequest(SimpleFieldSetConstructor.create().put("Message", "SetProperty").put("Identity", ownIdentity.getId()).put("Property", name).put("Value", value).get());
225 * Removes the property with the given name.
228 * The identity to remove the property from
230 * The name of the property to remove
231 * @throws PluginException
232 * if an error occured talking to the Web of Trust plugin
234 public void removeProperty(OwnIdentity ownIdentity, String name) throws PluginException {
235 performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveProperty").put("Identity", ownIdentity.getId()).put("Property", name).get());
239 * Returns the trust for the given identity assigned to it by the given own
245 * The identity to get the trust for
246 * @return The trust for the given identity
247 * @throws PluginException
248 * if an error occured talking to the Web of Trust plugin
250 public Trust getTrust(OwnIdentity ownIdentity, Identity identity) throws PluginException {
251 Reply getTrustReply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetIdentity").put("Truster", ownIdentity.getId()).put("Identity", identity.getId()).get());
252 String trust = getTrustReply.getFields().get("Trust");
253 String score = getTrustReply.getFields().get("Score");
254 String rank = getTrustReply.getFields().get("Rank");
255 Integer explicit = null;
256 Integer implicit = null;
257 Integer distance = null;
259 explicit = Integer.valueOf(trust);
260 } catch (NumberFormatException nfe1) {
264 implicit = Integer.valueOf(score);
265 distance = Integer.valueOf(rank);
266 } catch (NumberFormatException nfe1) {
269 return new Trust(explicit, implicit, distance);
273 * Sets the trust for the given identity.
276 * The trusting identity
278 * The trusted identity
280 * The amount of trust (-100 thru 100)
282 * The comment or explanation of the trust value
283 * @throws PluginException
284 * if an error occured talking to the Web of Trust plugin
286 public void setTrust(OwnIdentity ownIdentity, Identity identity, int trust, String comment) throws PluginException {
287 performRequest(SimpleFieldSetConstructor.create().put("Message", "SetTrust").put("Truster", ownIdentity.getId()).put("Trustee", identity.getId()).put("Value", String.valueOf(trust)).put("Comment", comment).get());
291 * Removes any trust assignment of the given own identity for the given
297 * The identity to remove all trust for
298 * @throws WebOfTrustException
301 public void removeTrust(OwnIdentity ownIdentity, Identity identity) throws WebOfTrustException {
302 performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveTrust").put("Truster", ownIdentity.getId()).put("Trustee", identity.getId()).get());
306 * Pings the Web of Trust plugin. If the plugin can not be reached, a
307 * {@link PluginException} is thrown.
309 * @throws PluginException
310 * if the plugin is not loaded
312 public void ping() throws PluginException {
313 performRequest(SimpleFieldSetConstructor.create().put("Message", "Ping").get());
321 * Parses the contexts from the given fields.
324 * The prefix to use to access the contexts
326 * The fields to parse the contexts from
327 * @return The parsed contexts
329 private static Set<String> parseContexts(String prefix, SimpleFieldSet fields) {
330 Set<String> contexts = new HashSet<String>();
331 int contextCounter = -1;
333 String context = fields.get(prefix + "Context" + ++contextCounter);
334 if (context == null) {
337 contexts.add(context);
343 * Parses the properties from the given fields.
346 * The prefix to use to access the properties
348 * The fields to parse the properties from
349 * @return The parsed properties
351 private static Map<String, String> parseProperties(String prefix, SimpleFieldSet fields) {
352 Map<String, String> properties = new HashMap<String, String>();
353 int propertiesCounter = -1;
355 String propertyName = fields.get(prefix + "Property" + ++propertiesCounter + ".Name");
356 if (propertyName == null) {
359 String propertyValue = fields.get(prefix + "Property" + propertiesCounter + ".Value");
360 properties.put(propertyName, propertyValue);
366 * Sends a request containing the given fields and waits for the target
370 * The fields of the message
371 * @return The reply message
372 * @throws PluginException
373 * if the request could not be sent
375 private Reply performRequest(SimpleFieldSet fields) throws PluginException {
376 return performRequest(fields, null);
380 * Sends a request containing the given fields and waits for the target
384 * The fields of the message
386 * The payload of the message
387 * @return The reply message
388 * @throws PluginException
389 * if the request could not be sent
391 private Reply performRequest(SimpleFieldSet fields, Bucket data) throws PluginException {
392 String identifier = "FCP-Command-" + System.currentTimeMillis() + "-" + counter.getAndIncrement();
393 Reply reply = new Reply();
394 PluginIdentifier pluginIdentifier = new PluginIdentifier(WOT_PLUGIN_NAME, identifier);
395 replies.put(pluginIdentifier, reply);
397 logger.log(Level.FINE, String.format("Sending FCP Request: %s", fields.get("Message")));
398 synchronized (reply) {
400 pluginConnector.sendRequest(WOT_PLUGIN_NAME, identifier, fields, data);
401 while (reply.getFields() == null) {
404 } catch (InterruptedException ie1) {
405 logger.log(Level.WARNING, String.format("Got interrupted while waiting for reply on %s.", fields.get("Message")), ie1);
409 replies.remove(pluginIdentifier);
412 logger.log(Level.FINEST, String.format("Received FCP Response for %s: %s", fields.get("Message"), (reply.getFields() != null) ? reply.getFields().get("Message") : null));
413 if ((reply.getFields() == null) || "Error".equals(reply.getFields().get("Message"))) {
414 throw new PluginException("Could not perform request for " + fields.get("Message"));
420 * Notifies the connector that a plugin reply was received.
422 * @param receivedReplyEvent
426 public void receivedReply(ReceivedReplyEvent receivedReplyEvent) {
427 PluginIdentifier pluginIdentifier = new PluginIdentifier(receivedReplyEvent.pluginName(), receivedReplyEvent.identifier());
428 Reply reply = replies.remove(pluginIdentifier);
432 logger.log(Level.FINEST, String.format("Received Reply from Plugin: %s", receivedReplyEvent.fieldSet().get("Message")));
433 synchronized (reply) {
434 reply.setFields(receivedReplyEvent.fieldSet());
435 reply.setData(receivedReplyEvent.data());
441 * Container for the data of the reply from a plugin.
443 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
445 private static class Reply {
447 /** The fields of the reply. */
448 private SimpleFieldSet fields;
450 /** The payload of the reply. */
453 /** Empty constructor. */
459 * Returns the fields of the reply.
461 * @return The fields of the reply
463 public SimpleFieldSet getFields() {
468 * Sets the fields of the reply.
471 * The fields of the reply
473 public void setFields(SimpleFieldSet fields) {
474 this.fields = fields;
478 * Returns the payload of the reply.
480 * @return The payload of the reply (may be {@code null})
482 @SuppressWarnings("unused")
483 public Bucket getData() {
488 * Sets the payload of the reply.
491 * The payload of the reply (may be {@code null})
493 public void setData(Bucket data) {
500 * Helper method to create {@link SimpleFieldSet}s with terser code.
502 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
504 private static class SimpleFieldSetConstructor {
506 /** The field set being created. */
507 private SimpleFieldSet simpleFieldSet;
510 * Creates a new simple field set constructor.
513 * {@code true} if the resulting simple field set should be
514 * short-lived, {@code false} otherwise
516 private SimpleFieldSetConstructor(boolean shortLived) {
517 simpleFieldSet = new SimpleFieldSet(shortLived);
525 * Returns the created simple field set.
527 * @return The created simple field set
529 public SimpleFieldSet get() {
530 return simpleFieldSet;
534 * Sets the field with the given name to the given value.
537 * The name of the fleld
539 * The value of the field
540 * @return This constructor (for method chaining)
542 public SimpleFieldSetConstructor put(String name, String value) {
543 simpleFieldSet.putOverwrite(name, value);
552 * Creates a new simple field set constructor.
554 * @return The created simple field set constructor
556 public static SimpleFieldSetConstructor create() {
561 * Creates a new simple field set constructor.
564 * {@code true} if the resulting simple field set should be
565 * short-lived, {@code false} otherwise
566 * @return The created simple field set constructor
568 public static SimpleFieldSetConstructor create(boolean shortLived) {
569 SimpleFieldSetConstructor simpleFieldSetConstructor = new SimpleFieldSetConstructor(shortLived);
570 return simpleFieldSetConstructor;
576 * Container for identifying plugins. Plugins are identified by their plugin
577 * name and their unique identifier.
579 * @author <a href="mailto:d.roden@xplosion.de">David Roden</a>
581 private static class PluginIdentifier {
583 /** The plugin name. */
584 private final String pluginName;
586 /** The plugin identifier. */
587 private final String identifier;
590 * Creates a new plugin identifier.
593 * The name of the plugin
595 * The identifier of the plugin
597 public PluginIdentifier(String pluginName, String identifier) {
598 this.pluginName = pluginName;
599 this.identifier = identifier;
610 public int hashCode() {
611 return pluginName.hashCode() ^ identifier.hashCode();
618 public boolean equals(Object object) {
619 if (!(object instanceof PluginIdentifier)) {
622 PluginIdentifier pluginIdentifier = (PluginIdentifier) object;
623 return pluginName.equals(pluginIdentifier.pluginName) && identifier.equals(pluginIdentifier.identifier);