src/main/java/net/pterodactylus/sone/freenet/wot/WebOfTrustConnector.java

   1 /*
   2  * Sone - WebOfTrustConnector.java - Copyright © 2010 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sone.freenet.wot;
  19
  20 import java.util.Collections;
  21 import java.util.HashMap;
  22 import java.util.HashSet;
  23 import java.util.Map;
  24 import java.util.Set;
  25 import java.util.logging.Level;
  26 import java.util.logging.Logger;
  27
  28 import net.pterodactylus.util.logging.Logging;
  29 import freenet.support.SimpleFieldSet;
  30 import freenet.support.api.Bucket;
  31
  32 /**
  33  * Connector for the Web of Trust plugin.
  34  *
  35  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  36  */
  37 public class WebOfTrustConnector implements ConnectorListener {
  38
  39         /** The logger. */
  40         private static final Logger logger = Logging.getLogger(WebOfTrustConnector.class);
  41
  42         /** The name of the WoT plugin. */
  43         private static final String WOT_PLUGIN_NAME = "plugins.WoT.WoT";
  44
  45         /** A random connection identifier. */
  46         private static final String PLUGIN_CONNECTION_IDENTIFIER = "Sone-WoT-Connector-" + Math.abs(Math.random());
  47
  48         /** The current replies that we wait for. */
  49         private final Map<String, Reply> replies = Collections.synchronizedMap(new HashMap<String, Reply>());
  50
  51         /** The plugin connector. */
  52         private final PluginConnector pluginConnector;
  53
  54         /**
  55          * Creates a new Web of Trust connector that uses the given plugin
  56          * connector.
  57          *
  58          * @param pluginConnector
  59          *            The plugin connector
  60          */
  61         public WebOfTrustConnector(PluginConnector pluginConnector) {
  62                 this.pluginConnector = pluginConnector;
  63                 pluginConnector.addConnectorListener(WOT_PLUGIN_NAME, PLUGIN_CONNECTION_IDENTIFIER, this);
  64         }
  65
  66         //
  67         // ACTIONS
  68         //
  69
  70         /**
  71          * Loads all own identities from the Web of Trust plugin.
  72          *
  73          * @return All own identity
  74          * @throws PluginException
  75          *             if the own identities can not be loaded
  76          */
  77         public Set<OwnIdentity> loadAllOwnIdentities() throws PluginException {
  78                 Reply reply = performRequest("OwnIdentities", SimpleFieldSetConstructor.create().put("Message", "GetOwnIdentities").get());
  79                 SimpleFieldSet fields = reply.getFields();
  80                 int ownIdentityCounter = -1;
  81                 Set<OwnIdentity> ownIdentities = new HashSet<OwnIdentity>();
  82                 while (true) {
  83                         String id = fields.get("Identity" + ++ownIdentityCounter);
  84                         if (id == null) {
  85                                 break;
  86                         }
  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);
  92                 }
  93                 return ownIdentities;
  94         }
  95
  96         /**
  97          * Loads the contexts of the given identity.
  98          *
  99          * @param 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
 104          */
 105         public Set<String> loadIdentityContexts(Identity identity) throws PluginException {
 106                 Reply reply = performRequest("Identity", SimpleFieldSetConstructor.create().put("Message", "GetIdentity").put("TreeOwner", identity.getId()).put("Identity", identity.getId()).get());
 107                 SimpleFieldSet fields = reply.getFields();
 108                 int contextCounter = -1;
 109                 Set<String> contexts = new HashSet<String>();
 110                 while (true) {
 111                         String context = fields.get("Context" + ++contextCounter);
 112                         if (context == null) {
 113                                 break;
 114                         }
 115                         contexts.add(context);
 116                 }
 117                 return contexts;
 118         }
 119
 120         //
 121         // PRIVATE ACTIONS
 122         //
 123
 124         /**
 125          * Sends a request containing the given fields and waits for the target
 126          * message.
 127          *
 128          * @param targetMessage
 129          *            The message of the reply to wait for
 130          * @param fields
 131          *            The fields of the message
 132          * @return The reply message
 133          * @throws PluginException
 134          *             if the request could not be sent
 135          */
 136         private Reply performRequest(String targetMessage, SimpleFieldSet fields) throws PluginException {
 137                 return performRequest(targetMessage, fields, null);
 138         }
 139
 140         /**
 141          * Sends a request containing the given fields and waits for the target
 142          * message.
 143          *
 144          * @param targetMessage
 145          *            The message of the reply to wait for
 146          * @param fields
 147          *            The fields of the message
 148          * @param data
 149          *            The payload of the message
 150          * @return The reply message
 151          * @throws PluginException
 152          *             if the request could not be sent
 153          */
 154         private Reply performRequest(String targetMessage, SimpleFieldSet fields, Bucket data) throws PluginException {
 155                 @SuppressWarnings("synthetic-access")
 156                 Reply reply = new Reply();
 157                 replies.put(targetMessage, reply);
 158                 synchronized (reply) {
 159                         pluginConnector.sendRequest(WOT_PLUGIN_NAME, PLUGIN_CONNECTION_IDENTIFIER, fields, data);
 160                         try {
 161                                 reply.wait();
 162                         } catch (InterruptedException ie1) {
 163                                 logger.log(Level.WARNING, "Got interrupted while waiting for reply on GetOwnIdentities.", ie1);
 164                         }
 165                 }
 166                 return reply;
 167         }
 168
 169         //
 170         // INTERFACE ConnectorListener
 171         //
 172
 173         /**
 174          * {@inheritDoc}
 175          */
 176         @Override
 177         public void receivedReply(PluginConnector pluginConnector, SimpleFieldSet fields, Bucket data) {
 178                 String messageName = fields.get("Message");
 179                 Reply reply = replies.remove(messageName);
 180                 if (reply == null) {
 181                         logger.log(Level.FINE, "Not waiting for a “%s” message.", messageName);
 182                         return;
 183                 }
 184                 synchronized (reply) {
 185                         reply.setFields(fields);
 186                         reply.setData(data);
 187                         reply.notify();
 188                 }
 189         }
 190
 191         /**
 192          * Container for the data of the reply from a plugin.
 193          *
 194          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 195          */
 196         private static class Reply {
 197
 198                 /** The fields of the reply. */
 199                 private SimpleFieldSet fields;
 200
 201                 /** The payload of the reply. */
 202                 private Bucket data;
 203
 204                 /**
 205                  * Returns the fields of the reply.
 206                  *
 207                  * @return The fields of the reply
 208                  */
 209                 public SimpleFieldSet getFields() {
 210                         return fields;
 211                 }
 212
 213                 /**
 214                  * Sets the fields of the reply.
 215                  *
 216                  * @param fields
 217                  *            The fields of the reply
 218                  */
 219                 public void setFields(SimpleFieldSet fields) {
 220                         this.fields = fields;
 221                 }
 222
 223                 /**
 224                  * Returns the payload of the reply.
 225                  *
 226                  * @return The payload of the reply (may be {@code null})
 227                  */
 228                 @SuppressWarnings("unused")
 229                 public Bucket getData() {
 230                         return data;
 231                 }
 232
 233                 /**
 234                  * Sets the payload of the reply.
 235                  *
 236                  * @param data
 237                  *            The payload of the reply (may be {@code null})
 238                  */
 239                 public void setData(Bucket data) {
 240                         this.data = data;
 241                 }
 242
 243         }
 244
 245         /**
 246          * Helper method to create {@link SimpleFieldSet}s with terser code.
 247          *
 248          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 249          */
 250         private static class SimpleFieldSetConstructor {
 251
 252                 /** The field set being created. */
 253                 private SimpleFieldSet simpleFieldSet;
 254
 255                 /**
 256                  * Creates a new simple field set constructor.
 257                  *
 258                  * @param shortLived
 259                  *            {@code true} if the resulting simple field set should be
 260                  *            short-lived, {@code false} otherwise
 261                  */
 262                 private SimpleFieldSetConstructor(boolean shortLived) {
 263                         simpleFieldSet = new SimpleFieldSet(shortLived);
 264                 }
 265
 266                 //
 267                 // ACCESSORS
 268                 //
 269
 270                 /**
 271                  * Returns the created simple field set.
 272                  *
 273                  * @return The created simple field set
 274                  */
 275                 public SimpleFieldSet get() {
 276                         return simpleFieldSet;
 277                 }
 278
 279                 /**
 280                  * Sets the field with the given name to the given value.
 281                  *
 282                  * @param name
 283                  *            The name of the fleld
 284                  * @param value
 285                  *            The value of the field
 286                  * @return This constructor (for method chaining)
 287                  */
 288                 public SimpleFieldSetConstructor put(String name, String value) {
 289                         simpleFieldSet.putOverwrite(name, value);
 290                         return this;
 291                 }
 292
 293                 //
 294                 // ACTIONS
 295                 //
 296
 297                 /**
 298                  * Creates a new simple field set constructor.
 299                  *
 300                  * @return The created simple field set constructor
 301                  */
 302                 public static SimpleFieldSetConstructor create() {
 303                         return create(true);
 304                 }
 305
 306                 /**
 307                  * Creates a new simple field set constructor.
 308                  *
 309                  * @param shortLived
 310                  *            {@code true} if the resulting simple field set should be
 311                  *            short-lived, {@code false} otherwise
 312                  * @return The created simple field set constructor
 313                  */
 314                 public static SimpleFieldSetConstructor create(boolean shortLived) {
 315                         SimpleFieldSetConstructor simpleFieldSetConstructor = new SimpleFieldSetConstructor(shortLived);
 316                         return simpleFieldSetConstructor;
 317                 }
 318
 319         }
 320
 321 }