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
116 * more than 0 and the (optional) given context.
121 * The context to filter, or {@code null}
122 * @return All trusted identities
123 * @throws PluginException
124 * if an error occured talking to the Web of Trust plugin
126 public Set<Identity> loadTrustedIdentities(OwnIdentity ownIdentity, String context) throws PluginException {
127 Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetIdentitiesByScore").put("Truster", ownIdentity.getId()).put("Selection", "+").put("Context", (context == null) ? "" : context).put("WantTrustValues", "true").get());
128 SimpleFieldSet fields = reply.getFields();
129 Set<Identity> identities = new HashSet<Identity>();
130 int identityCounter = -1;
132 String id = fields.get("Identity" + ++identityCounter);
136 String nickname = fields.get("Nickname" + identityCounter);
137 String requestUri = fields.get("RequestURI" + identityCounter);
138 DefaultIdentity identity = new DefaultIdentity(id, nickname, requestUri);
139 identity.setContexts(parseContexts("Contexts" + identityCounter + ".", fields));
140 identity.setProperties(parseProperties("Properties" + identityCounter + ".", fields));
141 Integer trust = Numbers.safeParseInteger(fields.get("Trust" + identityCounter), null);
142 int score = Numbers.safeParseInteger(fields.get("Score" + identityCounter), 0);
143 int rank = Numbers.safeParseInteger(fields.get("Rank" + identityCounter), 0);
144 identity.setTrust(ownIdentity, new Trust(trust, score, rank));
145 identities.add(identity);
151 * Adds the given context to the given identity.
154 * The identity to add the context to
157 * @throws PluginException
158 * if an error occured talking to the Web of Trust plugin
160 public void addContext(OwnIdentity ownIdentity, String context) throws PluginException {
161 performRequest(SimpleFieldSetConstructor.create().put("Message", "AddContext").put("Identity", ownIdentity.getId()).put("Context", context).get());
165 * Removes the given context from the given identity.
168 * The identity to remove the context from
170 * The context to remove
171 * @throws PluginException
172 * if an error occured talking to the Web of Trust plugin
174 public void removeContext(OwnIdentity ownIdentity, String context) throws PluginException {
175 performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveContext").put("Identity", ownIdentity.getId()).put("Context", context).get());
179 * Returns the value of the property with the given name.
182 * The identity whose properties to check
184 * The name of the property to return
185 * @return The value of the property, or {@code null} if there is no value
186 * @throws PluginException
187 * if an error occured talking to the Web of Trust plugin
189 public String getProperty(Identity identity, String name) throws PluginException {
190 Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetProperty").put("Identity", identity.getId()).put("Property", name).get());
191 return reply.getFields().get("Property");
195 * Sets the property with the given name to the given value.
198 * The identity to set the property on
200 * The name of the property to set
203 * @throws PluginException
204 * if an error occured talking to the Web of Trust plugin
206 public void setProperty(OwnIdentity ownIdentity, String name, String value) throws PluginException {
207 performRequest(SimpleFieldSetConstructor.create().put("Message", "SetProperty").put("Identity", ownIdentity.getId()).put("Property", name).put("Value", value).get());
211 * Removes the property with the given name.
214 * The identity to remove the property from
216 * The name of the property to remove
217 * @throws PluginException
218 * if an error occured talking to the Web of Trust plugin
220 public void removeProperty(OwnIdentity ownIdentity, String name) throws PluginException {
221 performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveProperty").put("Identity", ownIdentity.getId()).put("Property", name).get());
225 * Returns the trust for the given identity assigned to it by the given own
231 * The identity to get the trust for
232 * @return The trust for the given identity
233 * @throws PluginException
234 * if an error occured talking to the Web of Trust plugin
236 public Trust getTrust(OwnIdentity ownIdentity, Identity identity) throws PluginException {
237 Reply getTrustReply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetIdentity").put("Truster", ownIdentity.getId()).put("Identity", identity.getId()).get());
238 String trust = getTrustReply.getFields().get("Trust");
239 String score = getTrustReply.getFields().get("Score");
240 String rank = getTrustReply.getFields().get("Rank");
241 Integer explicit = null;
242 Integer implicit = null;
243 Integer distance = null;
245 explicit = Integer.valueOf(trust);
246 } catch (NumberFormatException nfe1) {
250 implicit = Integer.valueOf(score);
251 distance = Integer.valueOf(rank);
252 } catch (NumberFormatException nfe1) {
255 return new Trust(explicit, implicit, distance);
259 * Sets the trust for the given identity.
262 * The trusting identity
264 * The trusted identity
266 * The amount of trust (-100 thru 100)
268 * The comment or explanation of the trust value
269 * @throws PluginException
270 * if an error occured talking to the Web of Trust plugin
272 public void setTrust(OwnIdentity ownIdentity, Identity identity, int trust, String comment) throws PluginException {
273 performRequest(SimpleFieldSetConstructor.create().put("Message", "SetTrust").put("Truster", ownIdentity.getId()).put("Trustee", identity.getId()).put("Value", String.valueOf(trust)).put("Comment", comment).get());
277 * Removes any trust assignment of the given own identity for the given
283 * The identity to remove all trust for
284 * @throws WebOfTrustException
287 public void removeTrust(OwnIdentity ownIdentity, Identity identity) throws WebOfTrustException {
288 performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveTrust").put("Truster", ownIdentity.getId()).put("Trustee", identity.getId()).get());
292 * Pings the Web of Trust plugin. If the plugin can not be reached, a
293 * {@link PluginException} is thrown.
295 * @throws PluginException
296 * if the plugin is not loaded
298 public void ping() throws PluginException {
299 performRequest(SimpleFieldSetConstructor.create().put("Message", "Ping").get());
307 * Parses the contexts from the given fields.
310 * The prefix to use to access the contexts
312 * The fields to parse the contexts from
313 * @return The parsed contexts
315 private static Set<String> parseContexts(String prefix, SimpleFieldSet fields) {
316 Set<String> contexts = new HashSet<String>();
317 int contextCounter = -1;
319 String context = fields.get(prefix + "Context" + ++contextCounter);
320 if (context == null) {
323 contexts.add(context);
329 * Parses the properties from the given fields.
332 * The prefix to use to access the properties
334 * The fields to parse the properties from
335 * @return The parsed properties
337 private static Map<String, String> parseProperties(String prefix, SimpleFieldSet fields) {
338 Map<String, String> properties = new HashMap<String, String>();
339 int propertiesCounter = -1;
341 String propertyName = fields.get(prefix + "Property" + ++propertiesCounter + ".Name");
342 if (propertyName == null) {
345 String propertyValue = fields.get(prefix + "Property" + propertiesCounter + ".Value");
346 properties.put(propertyName, propertyValue);
352 * Sends a request containing the given fields and waits for the target
356 * The fields of the message
357 * @return The reply message
358 * @throws PluginException
359 * if the request could not be sent
361 private Reply performRequest(SimpleFieldSet fields) throws PluginException {
362 return performRequest(fields, null);
366 * Sends a request containing the given fields and waits for the target
370 * The fields of the message
372 * The payload of the message
373 * @return The reply message
374 * @throws PluginException
375 * if the request could not be sent
377 private Reply performRequest(SimpleFieldSet fields, Bucket data) throws PluginException {
378 String identifier = "FCP-Command-" + System.currentTimeMillis() + "-" + counter.getAndIncrement();
379 Reply reply = new Reply();
380 PluginIdentifier pluginIdentifier = new PluginIdentifier(WOT_PLUGIN_NAME, identifier);
381 replies.put(pluginIdentifier, reply);
383 logger.log(Level.FINE, String.format("Sending FCP Request: %s", fields.get("Message")));
384 synchronized (reply) {
386 pluginConnector.sendRequest(WOT_PLUGIN_NAME, identifier, fields, data);
387 while (reply.getFields() == null) {
390 } catch (InterruptedException ie1) {
391 logger.log(Level.WARNING, String.format("Got interrupted while waiting for reply on %s.", fields.get("Message")), ie1);
395 replies.remove(pluginIdentifier);
398 logger.log(Level.FINEST, String.format("Received FCP Response for %s: %s", fields.get("Message"), (reply.getFields() != null) ? reply.getFields().get("Message") : null));
399 if ((reply.getFields() == null) || "Error".equals(reply.getFields().get("Message"))) {
400 throw new PluginException("Could not perform request for " + fields.get("Message"));
406 * Notifies the connector that a plugin reply was received.
408 * @param receivedReplyEvent
412 public void receivedReply(ReceivedReplyEvent receivedReplyEvent) {
413 PluginIdentifier pluginIdentifier = new PluginIdentifier(receivedReplyEvent.pluginName(), receivedReplyEvent.identifier());
414 Reply reply = replies.remove(pluginIdentifier);
418 logger.log(Level.FINEST, String.format("Received Reply from Plugin: %s", receivedReplyEvent.fieldSet().get("Message")));
419 synchronized (reply) {
420 reply.setFields(receivedReplyEvent.fieldSet());
421 reply.setData(receivedReplyEvent.data());
427 * Container for the data of the reply from a plugin.
429 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
431 private static class Reply {
433 /** The fields of the reply. */
434 private SimpleFieldSet fields;
436 /** The payload of the reply. */
439 /** Empty constructor. */
445 * Returns the fields of the reply.
447 * @return The fields of the reply
449 public SimpleFieldSet getFields() {
454 * Sets the fields of the reply.
457 * The fields of the reply
459 public void setFields(SimpleFieldSet fields) {
460 this.fields = fields;
464 * Returns the payload of the reply.
466 * @return The payload of the reply (may be {@code null})
468 @SuppressWarnings("unused")
469 public Bucket getData() {
474 * Sets the payload of the reply.
477 * The payload of the reply (may be {@code null})
479 public void setData(Bucket data) {
486 * Helper method to create {@link SimpleFieldSet}s with terser code.
488 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
490 private static class SimpleFieldSetConstructor {
492 /** The field set being created. */
493 private SimpleFieldSet simpleFieldSet;
496 * Creates a new simple field set constructor.
499 * {@code true} if the resulting simple field set should be
500 * short-lived, {@code false} otherwise
502 private SimpleFieldSetConstructor(boolean shortLived) {
503 simpleFieldSet = new SimpleFieldSet(shortLived);
511 * Returns the created simple field set.
513 * @return The created simple field set
515 public SimpleFieldSet get() {
516 return simpleFieldSet;
520 * Sets the field with the given name to the given value.
523 * The name of the fleld
525 * The value of the field
526 * @return This constructor (for method chaining)
528 public SimpleFieldSetConstructor put(String name, String value) {
529 simpleFieldSet.putOverwrite(name, value);
538 * Creates a new simple field set constructor.
540 * @return The created simple field set constructor
542 public static SimpleFieldSetConstructor create() {
547 * Creates a new simple field set constructor.
550 * {@code true} if the resulting simple field set should be
551 * short-lived, {@code false} otherwise
552 * @return The created simple field set constructor
554 public static SimpleFieldSetConstructor create(boolean shortLived) {
555 SimpleFieldSetConstructor simpleFieldSetConstructor = new SimpleFieldSetConstructor(shortLived);
556 return simpleFieldSetConstructor;
562 * Container for identifying plugins. Plugins are identified by their plugin
563 * name and their unique identifier.
565 * @author <a href="mailto:d.roden@xplosion.de">David Roden</a>
567 private static class PluginIdentifier {
569 /** The plugin name. */
570 private final String pluginName;
572 /** The plugin identifier. */
573 private final String identifier;
576 * Creates a new plugin identifier.
579 * The name of the plugin
581 * The identifier of the plugin
583 public PluginIdentifier(String pluginName, String identifier) {
584 this.pluginName = pluginName;
585 this.identifier = identifier;
596 public int hashCode() {
597 return pluginName.hashCode() ^ identifier.hashCode();
604 public boolean equals(Object object) {
605 if (!(object instanceof PluginIdentifier)) {
608 PluginIdentifier pluginIdentifier = (PluginIdentifier) object;
609 return pluginName.equals(pluginIdentifier.pluginName) && identifier.equals(pluginIdentifier.identifier);