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

   1 /*
   2  * Sone - WebOfTrustConnector.java - Copyright © 2010–2019 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.*;
  21 import java.util.logging.Logger;
  22 import java.util.logging.*;
  23 import javax.annotation.*;
  24
  25 import net.pterodactylus.sone.freenet.plugin.*;
  26
  27 import com.google.inject.*;
  28 import freenet.support.*;
  29 import freenet.support.api.*;
  30
  31 import static java.lang.String.*;
  32 import static java.util.logging.Logger.*;
  33 import static net.pterodactylus.sone.utils.NumberParsers.*;
  34
  35 /**
  36  * Connector for the Web of Trust plugin.
  37  */
  38 @Singleton
  39 public class WebOfTrustConnector {
  40
  41         /** The logger. */
  42         private static final Logger logger = getLogger(WebOfTrustConnector.class.getName());
  43
  44         /** The name of the WoT plugin. */
  45         private static final String WOT_PLUGIN_NAME = "plugins.WebOfTrust.WebOfTrust";
  46
  47         /** The plugin connector. */
  48         private final PluginConnector pluginConnector;
  49
  50         /**
  51          * Creates a new Web of Trust connector that uses the given plugin
  52          * connector.
  53          *
  54          * @param pluginConnector
  55          *            The plugin connector
  56          */
  57         @Inject
  58         public WebOfTrustConnector(PluginConnector pluginConnector) {
  59                 this.pluginConnector = pluginConnector;
  60         }
  61
  62         //
  63         // ACTIONS
  64         //
  65
  66         /**
  67          * Stops the web of trust connector.
  68          */
  69         public void stop() {
  70                 /* does nothing. */
  71         }
  72
  73         /**
  74          * Loads all own identities from the Web of Trust plugin.
  75          *
  76          * @return All own identity
  77          * @throws WebOfTrustException
  78          *             if the own identities can not be loaded
  79          */
  80         public Set<OwnIdentity> loadAllOwnIdentities() throws WebOfTrustException {
  81                 PluginReply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetOwnIdentities").get());
  82                 SimpleFieldSet fields = reply.getFields();
  83                 int ownIdentityCounter = -1;
  84                 Set<OwnIdentity> ownIdentities = new HashSet<>();
  85                 while (true) {
  86                         String id = fields.get("Identity" + ++ownIdentityCounter);
  87                         if (id == null) {
  88                                 break;
  89                         }
  90                         String requestUri = fields.get("RequestURI" + ownIdentityCounter);
  91                         String insertUri = fields.get("InsertURI" + ownIdentityCounter);
  92                         String nickname = fields.get("Nickname" + ownIdentityCounter);
  93                         DefaultOwnIdentity ownIdentity = new DefaultOwnIdentity(id, nickname, requestUri, insertUri);
  94                         ownIdentity.setContexts(parseContexts("Contexts" + ownIdentityCounter + ".", fields));
  95                         ownIdentity.setProperties(parseProperties("Properties" + ownIdentityCounter + ".", fields));
  96                         ownIdentities.add(ownIdentity);
  97                 }
  98                 return ownIdentities;
  99         }
 100
 101         /**
 102          * Loads all identities that the given identities trusts with a score of
 103          * more than 0.
 104          *
 105          * @param ownIdentity
 106          *            The own identity
 107          * @return All trusted identities
 108          * @throws PluginException
 109          *             if an error occured talking to the Web of Trust plugin
 110          */
 111         public Set<Identity> loadTrustedIdentities(OwnIdentity ownIdentity) throws PluginException {
 112                 return loadTrustedIdentities(ownIdentity, null);
 113         }
 114
 115         /**
 116          * Loads all identities that the given identities trusts with a score of
 117          * more than 0 and the (optional) given context.
 118          *
 119          * @param ownIdentity
 120          *            The own identity
 121          * @param context
 122          *            The context to filter, or {@code null}
 123          * @return All trusted identities
 124          * @throws PluginException
 125          *             if an error occured talking to the Web of Trust plugin
 126          */
 127         public Set<Identity> loadTrustedIdentities(OwnIdentity ownIdentity, @Nullable String context) throws PluginException {
 128                 PluginReply reply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetIdentitiesByScore").put("Truster", ownIdentity.getId()).put("Selection", "+").put("Context", (context == null) ? "" : context).put("WantTrustValues", "true").get());
 129                 SimpleFieldSet fields = reply.getFields();
 130                 Set<Identity> identities = new HashSet<>();
 131                 int identityCounter = -1;
 132                 while (true) {
 133                         String id = fields.get("Identity" + ++identityCounter);
 134                         if (id == null) {
 135                                 break;
 136                         }
 137                         String nickname = fields.get("Nickname" + identityCounter);
 138                         String requestUri = fields.get("RequestURI" + identityCounter);
 139                         DefaultIdentity identity = new DefaultIdentity(id, nickname, requestUri);
 140                         identity.setContexts(parseContexts("Contexts" + identityCounter + ".", fields));
 141                         identity.setProperties(parseProperties("Properties" + identityCounter + ".", fields));
 142                         Integer trust = parseInt(fields.get("Trust" + identityCounter), null);
 143                         int score = parseInt(fields.get("Score" + identityCounter), 0);
 144                         int rank = parseInt(fields.get("Rank" + identityCounter), 0);
 145                         identity.setTrust(ownIdentity, new Trust(trust, score, rank));
 146                         identities.add(identity);
 147                 }
 148                 return identities;
 149         }
 150
 151         /**
 152          * Adds the given context to the given identity.
 153          *
 154          * @param ownIdentity
 155          *            The identity to add the context to
 156          * @param context
 157          *            The context to add
 158          * @throws PluginException
 159          *             if an error occured talking to the Web of Trust plugin
 160          */
 161         public void addContext(OwnIdentity ownIdentity, String context) throws PluginException {
 162                 performRequest(SimpleFieldSetConstructor.create().put("Message", "AddContext").put("Identity", ownIdentity.getId()).put("Context", context).get());
 163         }
 164
 165         /**
 166          * Removes the given context from the given identity.
 167          *
 168          * @param ownIdentity
 169          *            The identity to remove the context from
 170          * @param context
 171          *            The context to remove
 172          * @throws PluginException
 173          *             if an error occured talking to the Web of Trust plugin
 174          */
 175         public void removeContext(OwnIdentity ownIdentity, String context) throws PluginException {
 176                 performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveContext").put("Identity", ownIdentity.getId()).put("Context", context).get());
 177         }
 178
 179         /**
 180          * Sets the property with the given name to the given value.
 181          *
 182          * @param ownIdentity
 183          *            The identity to set the property on
 184          * @param name
 185          *            The name of the property to set
 186          * @param value
 187          *            The value to set
 188          * @throws PluginException
 189          *             if an error occured talking to the Web of Trust plugin
 190          */
 191         public void setProperty(OwnIdentity ownIdentity, String name, String value) throws PluginException {
 192                 performRequest(SimpleFieldSetConstructor.create().put("Message", "SetProperty").put("Identity", ownIdentity.getId()).put("Property", name).put("Value", value).get());
 193         }
 194
 195         /**
 196          * Removes the property with the given name.
 197          *
 198          * @param ownIdentity
 199          *            The identity to remove the property from
 200          * @param name
 201          *            The name of the property to remove
 202          * @throws PluginException
 203          *             if an error occured talking to the Web of Trust plugin
 204          */
 205         public void removeProperty(OwnIdentity ownIdentity, String name) throws PluginException {
 206                 performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveProperty").put("Identity", ownIdentity.getId()).put("Property", name).get());
 207         }
 208
 209         /**
 210          * Returns the trust for the given identity assigned to it by the given own
 211          * identity.
 212          *
 213          * @param ownIdentity
 214          *            The own identity
 215          * @param identity
 216          *            The identity to get the trust for
 217          * @return The trust for the given identity
 218          * @throws PluginException
 219          *             if an error occured talking to the Web of Trust plugin
 220          */
 221         public Trust getTrust(OwnIdentity ownIdentity, Identity identity) throws PluginException {
 222                 PluginReply getTrustReply = performRequest(SimpleFieldSetConstructor.create().put("Message", "GetIdentity").put("Truster", ownIdentity.getId()).put("Identity", identity.getId()).get());
 223                 String trust = getTrustReply.getFields().get("Trust");
 224                 String score = getTrustReply.getFields().get("Score");
 225                 String rank = getTrustReply.getFields().get("Rank");
 226                 Integer explicit = null;
 227                 Integer implicit = null;
 228                 Integer distance = null;
 229                 try {
 230                         explicit = Integer.valueOf(trust);
 231                 } catch (NumberFormatException nfe1) {
 232                         /* ignore. */
 233                 }
 234                 try {
 235                         implicit = Integer.valueOf(score);
 236                         distance = Integer.valueOf(rank);
 237                 } catch (NumberFormatException nfe1) {
 238                         /* ignore. */
 239                 }
 240                 return new Trust(explicit, implicit, distance);
 241         }
 242
 243         /**
 244          * Sets the trust for the given identity.
 245          *
 246          * @param ownIdentity
 247          *            The trusting identity
 248          * @param identity
 249          *            The trusted identity
 250          * @param trust
 251          *            The amount of trust (-100 thru 100)
 252          * @param comment
 253          *            The comment or explanation of the trust value
 254          * @throws PluginException
 255          *             if an error occured talking to the Web of Trust plugin
 256          */
 257         public void setTrust(OwnIdentity ownIdentity, Identity identity, int trust, String comment) throws PluginException {
 258                 performRequest(SimpleFieldSetConstructor.create().put("Message", "SetTrust").put("Truster", ownIdentity.getId()).put("Trustee", identity.getId()).put("Value", String.valueOf(trust)).put("Comment", comment).get());
 259         }
 260
 261         /**
 262          * Removes any trust assignment of the given own identity for the given
 263          * identity.
 264          *
 265          * @param ownIdentity
 266          *            The own identity
 267          * @param identity
 268          *            The identity to remove all trust for
 269          * @throws WebOfTrustException
 270          *             if an error occurs
 271          */
 272         public void removeTrust(OwnIdentity ownIdentity, Identity identity) throws WebOfTrustException {
 273                 performRequest(SimpleFieldSetConstructor.create().put("Message", "RemoveTrust").put("Truster", ownIdentity.getId()).put("Trustee", identity.getId()).get());
 274         }
 275
 276         /**
 277          * Pings the Web of Trust plugin. If the plugin can not be reached, a
 278          * {@link PluginException} is thrown.
 279          *
 280          * @throws PluginException
 281          *             if the plugin is not loaded
 282          */
 283         public void ping() throws PluginException {
 284                 performRequest(SimpleFieldSetConstructor.create().put("Message", "Ping").get());
 285         }
 286
 287         //
 288         // PRIVATE ACTIONS
 289         //
 290
 291         /**
 292          * Parses the contexts from the given fields.
 293          *
 294          * @param prefix
 295          *            The prefix to use to access the contexts
 296          * @param fields
 297          *            The fields to parse the contexts from
 298          * @return The parsed contexts
 299          */
 300         private static Set<String> parseContexts(String prefix, SimpleFieldSet fields) {
 301                 Set<String> contexts = new HashSet<>();
 302                 int contextCounter = -1;
 303                 while (true) {
 304                         String context = fields.get(prefix + "Context" + ++contextCounter);
 305                         if (context == null) {
 306                                 break;
 307                         }
 308                         contexts.add(context);
 309                 }
 310                 return contexts;
 311         }
 312
 313         /**
 314          * Parses the properties from the given fields.
 315          *
 316          * @param prefix
 317          *            The prefix to use to access the properties
 318          * @param fields
 319          *            The fields to parse the properties from
 320          * @return The parsed properties
 321          */
 322         private static Map<String, String> parseProperties(String prefix, SimpleFieldSet fields) {
 323                 Map<String, String> properties = new HashMap<>();
 324                 int propertiesCounter = -1;
 325                 while (true) {
 326                         String propertyName = fields.get(prefix + "Property" + ++propertiesCounter + ".Name");
 327                         if (propertyName == null) {
 328                                 break;
 329                         }
 330                         String propertyValue = fields.get(prefix + "Property" + propertiesCounter + ".Value");
 331                         properties.put(propertyName, propertyValue);
 332                 }
 333                 return properties;
 334         }
 335
 336         /**
 337          * Sends a request containing the given fields and waits for the target
 338          * message.
 339          *
 340          * @param fields
 341          *            The fields of the message
 342          * @return The reply message
 343          * @throws PluginException
 344          *             if the request could not be sent
 345          */
 346         private PluginReply performRequest(SimpleFieldSet fields) throws PluginException {
 347                 return performRequest(fields, null);
 348         }
 349
 350         /**
 351          * Sends a request containing the given fields and waits for the target
 352          * message.
 353          *
 354          * @param fields
 355          *            The fields of the message
 356          * @param data
 357          *            The payload of the message
 358          * @return The reply message
 359          * @throws PluginException
 360          *             if the request could not be sent
 361          */
 362         private PluginReply performRequest(SimpleFieldSet fields, Bucket data) throws PluginException {
 363                 logger.log(Level.FINE, format("Sending FCP Request: %s", fields.get("Message")));
 364                 PluginReply pluginReply = pluginConnector.sendRequest(WOT_PLUGIN_NAME, "", fields, data);
 365                 logger.log(Level.FINEST, format("Received FCP Response for %s: %s", fields.get("Message"), pluginReply.getFields().get("Message")));
 366                 if ("Error".equals(pluginReply.getFields().get("Message"))) {
 367                         throw new PluginException("Could not perform request for " + fields.get("Message"));
 368                 }
 369                 return pluginReply;
 370         }
 371
 372         /**
 373          * Helper method to create {@link SimpleFieldSet}s with terser code.
 374          */
 375         private static class SimpleFieldSetConstructor {
 376
 377                 /** The field set being created. */
 378                 private SimpleFieldSet simpleFieldSet;
 379
 380                 /**
 381                  * Creates a new simple field set constructor.
 382                  *
 383                  * @param shortLived
 384                  *            {@code true} if the resulting simple field set should be
 385                  *            short-lived, {@code false} otherwise
 386                  */
 387                 private SimpleFieldSetConstructor(boolean shortLived) {
 388                         simpleFieldSet = new SimpleFieldSet(shortLived);
 389                 }
 390
 391                 //
 392                 // ACCESSORS
 393                 //
 394
 395                 /**
 396                  * Returns the created simple field set.
 397                  *
 398                  * @return The created simple field set
 399                  */
 400                 public SimpleFieldSet get() {
 401                         return simpleFieldSet;
 402                 }
 403
 404                 /**
 405                  * Sets the field with the given name to the given value.
 406                  *
 407                  * @param name
 408                  *            The name of the fleld
 409                  * @param value
 410                  *            The value of the field
 411                  * @return This constructor (for method chaining)
 412                  */
 413                 public SimpleFieldSetConstructor put(String name, String value) {
 414                         simpleFieldSet.putOverwrite(name, value);
 415                         return this;
 416                 }
 417
 418                 //
 419                 // ACTIONS
 420                 //
 421
 422                 /**
 423                  * Creates a new simple field set constructor.
 424                  *
 425                  * @return The created simple field set constructor
 426                  */
 427                 public static SimpleFieldSetConstructor create() {
 428                         return create(true);
 429                 }
 430
 431                 /**
 432                  * Creates a new simple field set constructor.
 433                  *
 434                  * @param shortLived
 435                  *            {@code true} if the resulting simple field set should be
 436                  *            short-lived, {@code false} otherwise
 437                  * @return The created simple field set constructor
 438                  */
 439                 public static SimpleFieldSetConstructor create(boolean shortLived) {
 440                         return new SimpleFieldSetConstructor(shortLived);
 441                 }
 442
 443         }
 444
 445 }