2 * Sone - WebOfTrustConnector.java - Copyright © 2010 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.Collections;
21 import java.util.HashMap;
22 import java.util.HashSet;
25 import java.util.logging.Level;
26 import java.util.logging.Logger;
28 import net.pterodactylus.util.logging.Logging;
29 import freenet.support.SimpleFieldSet;
30 import freenet.support.api.Bucket;
33 * Connector for the Web of Trust plugin.
35 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
37 public class WebOfTrustConnector implements ConnectorListener {
40 private static final Logger logger = Logging.getLogger(WebOfTrustConnector.class);
42 /** The name of the WoT plugin. */
43 private static final String WOT_PLUGIN_NAME = "plugins.WoT.WoT";
45 /** A random connection identifier. */
46 private static final String PLUGIN_CONNECTION_IDENTIFIER = "Sone-WoT-Connector-" + Math.abs(Math.random());
48 /** The current replies that we wait for. */
49 private final Map<String, Reply> replies = Collections.synchronizedMap(new HashMap<String, Reply>());
51 /** The plugin connector. */
52 private final PluginConnector pluginConnector;
55 * Creates a new Web of Trust connector that uses the given plugin
58 * @param pluginConnector
59 * The plugin connector
61 public WebOfTrustConnector(PluginConnector pluginConnector) {
62 this.pluginConnector = pluginConnector;
63 pluginConnector.addConnectorListener(WOT_PLUGIN_NAME, PLUGIN_CONNECTION_IDENTIFIER, this);
71 * Loads all own identities from the Web of Trust plugin.
73 * @return All own identity
74 * @throws PluginException
75 * if the own identities can not be loaded
77 public Set<OwnIdentity> loadAllOwnIdentities() throws PluginException {
78 Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetOwnIdentities").get(), "OwnIdentities");
79 SimpleFieldSet fields = reply.getFields();
80 int ownIdentityCounter = -1;
81 Set<OwnIdentity> ownIdentities = new HashSet<OwnIdentity>();
83 String id = fields.get("Identity" + ++ownIdentityCounter);
87 String requestUri = fields.get("RequestURI" + ownIdentityCounter);
88 String insertUri = fields.get("InsertURI" + ownIdentityCounter);
89 String nickname = fields.get("Nickname" + ownIdentityCounter);
90 OwnIdentity ownIdentity = new OwnIdentity(this, id, nickname, requestUri, insertUri);
91 ownIdentities.add(ownIdentity);
97 * Loads the contexts of the given identity.
100 * The identity to load the contexts for
101 * @return The contexts of the identity
102 * @throws PluginException
103 * if an error occured talking to the Web of Trust plugin
105 public Set<String> loadIdentityContexts(Identity identity) throws PluginException {
106 Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetIdentity").put("TreeOwner", identity.getId()).put("Identity", identity.getId()).get(), "Identity");
107 SimpleFieldSet fields = reply.getFields();
108 int contextCounter = -1;
109 Set<String> contexts = new HashSet<String>();
111 String context = fields.get("Context" + ++contextCounter);
112 if (context == null) {
115 contexts.add(context);
121 * Loads all identities that the given identities trusts with a score of
126 * @return All trusted identities
127 * @throws PluginException
128 * if an error occured talking to the Web of Trust plugin
130 public Set<Identity> loadTrustedIdentities(OwnIdentity ownIdentity) throws PluginException {
131 return loadTrustedIdentities(ownIdentity, null);
135 * Loads all identities that the given identities trusts with a score of
136 * more than 0 and the (optional) given context.
141 * The context to filter, or {@code null}
142 * @return All trusted identities
143 * @throws PluginException
144 * if an error occured talking to the Web of Trust plugin
146 public Set<Identity> loadTrustedIdentities(OwnIdentity ownIdentity, String context) throws PluginException {
147 Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetIdentitiesByScore").put("TreeOwner", ownIdentity.getId()).put("Selection", "+").put("Context", (context == null) ? "" : context).get(), "Identities");
148 SimpleFieldSet fields = reply.getFields();
149 Set<Identity> identities = new HashSet<Identity>();
150 int identityCounter = -1;
152 String id = fields.get("Identity" + ++identityCounter);
156 String nickname = fields.get("Nickname" + identityCounter);
157 String requestUri = fields.get("RequestURI" + identityCounter);
158 identities.add(new Identity(this, id, nickname, requestUri));
164 * Adds the given context to the given identity.
167 * The identity to add the context to
170 * @throws PluginException
171 * if an error occured talking to the Web of Trust plugin
173 public void addContext(OwnIdentity ownIdentity, String context) throws PluginException {
174 performRequest(SimpleFieldSetConstructor.create().put("Message", "AddContext").put("Identity", ownIdentity.getId()).put("Context", context).get(), "ContextAdded");
178 * Removes the given context from the given identity.
181 * The identity to remove the context from
183 * The context to remove
184 * @throws PluginException
185 * if an error occured talking to the Web of Trust plugin
187 public void removeContext(OwnIdentity ownIdentity, String context) throws PluginException {
188 performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveContext").put("Identity", ownIdentity.getId()).put("Context", context).get(), "ContextRemoved");
192 * Returns the value of the property with the given name.
195 * The identity whose properties to check
197 * The name of the property to return
198 * @return The value of the property, or {@code null} if there is no value
199 * @throws PluginException
200 * if an error occured talking to the Web of Trust plugin
202 public String getProperty(Identity identity, String name) throws PluginException {
203 Reply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetProperty").put("Identity", identity.getId()).put("Property", name).get(), "PropertyValue", "Error");
204 return reply.getFields().get("Property");
208 * Sets the property with the given name to the given value.
211 * The identity to set the property on
213 * The name of the property to set
216 * @throws PluginException
217 * if an error occured talking to the Web of Trust plugin
219 public void setProperty(OwnIdentity ownIdentity, String name, String value) throws PluginException {
220 performRequest(SimpleFieldSetConstructor.create().put("Message", "SetProperty").put("Identity", ownIdentity.getId()).put("Property", name).put("Value", value).get(), "PropertyAdded");
224 * Removes the property with the given name.
227 * The identity to remove the property from
229 * The name of the property to remove
230 * @throws PluginException
231 * if an error occured talking to the Web of Trust plugin
233 public void removeProperty(OwnIdentity ownIdentity, String name) throws PluginException {
234 performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveProperty").put("Identity", ownIdentity.getId()).put("Property", name).get(), "PropertyRemoved");
242 * Sends a request containing the given fields and waits for the target
246 * The fields of the message
247 * @param targetMessages
248 * The messages of the reply to wait for
249 * @return The reply message
250 * @throws PluginException
251 * if the request could not be sent
253 private Reply performRequest(SimpleFieldSet fields, String... targetMessages) throws PluginException {
254 return performRequest(fields, null, targetMessages);
258 * Sends a request containing the given fields and waits for the target
262 * The fields of the message
264 * The payload of the message
265 * @param targetMessages
266 * The messages of the reply to wait for
267 * @return The reply message
268 * @throws PluginException
269 * if the request could not be sent
271 private Reply performRequest(SimpleFieldSet fields, Bucket data, String... targetMessages) throws PluginException {
272 @SuppressWarnings("synthetic-access")
273 Reply reply = new Reply();
274 for (String targetMessage : targetMessages) {
275 replies.put(targetMessage, reply);
277 synchronized (reply) {
278 pluginConnector.sendRequest(WOT_PLUGIN_NAME, PLUGIN_CONNECTION_IDENTIFIER, fields, data);
281 } catch (InterruptedException ie1) {
282 logger.log(Level.WARNING, "Got interrupted while waiting for reply on GetOwnIdentities.", ie1);
285 for (String targetMessage : targetMessages) {
286 replies.remove(targetMessage);
292 // INTERFACE ConnectorListener
299 public void receivedReply(PluginConnector pluginConnector, SimpleFieldSet fields, Bucket data) {
300 String messageName = fields.get("Message");
301 Reply reply = replies.remove(messageName);
303 logger.log(Level.FINE, "Not waiting for a “%s” message.", messageName);
306 synchronized (reply) {
307 reply.setFields(fields);
314 * Container for the data of the reply from a plugin.
316 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
318 private static class Reply {
320 /** The fields of the reply. */
321 private SimpleFieldSet fields;
323 /** The payload of the reply. */
327 * Returns the fields of the reply.
329 * @return The fields of the reply
331 public SimpleFieldSet getFields() {
336 * Sets the fields of the reply.
339 * The fields of the reply
341 public void setFields(SimpleFieldSet fields) {
342 this.fields = fields;
346 * Returns the payload of the reply.
348 * @return The payload of the reply (may be {@code null})
350 @SuppressWarnings("unused")
351 public Bucket getData() {
356 * Sets the payload of the reply.
359 * The payload of the reply (may be {@code null})
361 public void setData(Bucket data) {
368 * Helper method to create {@link SimpleFieldSet}s with terser code.
370 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
372 private static class SimpleFieldSetConstructor {
374 /** The field set being created. */
375 private SimpleFieldSet simpleFieldSet;
378 * Creates a new simple field set constructor.
381 * {@code true} if the resulting simple field set should be
382 * short-lived, {@code false} otherwise
384 private SimpleFieldSetConstructor(boolean shortLived) {
385 simpleFieldSet = new SimpleFieldSet(shortLived);
393 * Returns the created simple field set.
395 * @return The created simple field set
397 public SimpleFieldSet get() {
398 return simpleFieldSet;
402 * Sets the field with the given name to the given value.
405 * The name of the fleld
407 * The value of the field
408 * @return This constructor (for method chaining)
410 public SimpleFieldSetConstructor put(String name, String value) {
411 simpleFieldSet.putOverwrite(name, value);
420 * Creates a new simple field set constructor.
422 * @return The created simple field set constructor
424 public static SimpleFieldSetConstructor create() {
429 * Creates a new simple field set constructor.
432 * {@code true} if the resulting simple field set should be
433 * short-lived, {@code false} otherwise
434 * @return The created simple field set constructor
436 public static SimpleFieldSetConstructor create(boolean shortLived) {
437 SimpleFieldSetConstructor simpleFieldSetConstructor = new SimpleFieldSetConstructor(shortLived);
438 return simpleFieldSetConstructor;