src/net/pterodactylus/fcp/plugin/WebOfTrustPlugin.java

   1 /*
   2  * jFCPlib - WebOfTrustPlugin.java -
   3  * Copyright © 2009 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.fcp.plugin;
  21
  22 import java.io.IOException;
  23 import java.util.HashMap;
  24 import java.util.HashSet;
  25 import java.util.Map;
  26 import java.util.Set;
  27
  28 import net.pterodactylus.fcp.highlevel.FcpClient;
  29 import net.pterodactylus.fcp.highlevel.FcpException;
  30
  31 /**
  32  * Simplifies handling of the web-of-trust plugin.
  33  *
  34  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  35  */
  36 public class WebOfTrustPlugin {
  37
  38         /** The FCP client to use. */
  39         private final FcpClient fcpClient;
  40
  41         /**
  42          * Creates a new web-of-trust plugin wrapper around the given FCP client.
  43          *
  44          * @param fcpClient
  45          *            The FCP client to use for communication with the web-of-trust
  46          *            plugin
  47          */
  48         public WebOfTrustPlugin(FcpClient fcpClient) {
  49                 this.fcpClient = fcpClient;
  50         }
  51
  52         /**
  53          * Creates a new identity.
  54          *
  55          * @param nickname
  56          *            The nickname of the new identity
  57          * @param context
  58          *            The context for the new identity
  59          * @param publishTrustList
  60          *            {@code true} if the new identity should publish its trust list
  61          * @return The new identity
  62          * @throws IOException
  63          *             if an I/O error occurs
  64          * @throws FcpException
  65          *             if an FCP error occurs
  66          */
  67         public OwnIdentity createIdentity(String nickname, String context, boolean publishTrustList) throws IOException, FcpException {
  68                 return createIdentity(nickname, context, publishTrustList, null, null);
  69         }
  70
  71         /**
  72          * Creates a new identity from the given request and insert URI.
  73          *
  74          * @param nickname
  75          *            The nickname of the new identity
  76          * @param context
  77          *            The context for the new identity
  78          * @param publishTrustList
  79          *            {@code true} if the new identity should publish its trust list
  80          * @param requestUri
  81          *            The request URI of the identity
  82          * @param insertUri
  83          *            The insert URI of the identity
  84          * @return The new identity
  85          * @throws IOException
  86          *             if an I/O error occurs
  87          * @throws FcpException
  88          *             if an FCP error occurs
  89          */
  90         public OwnIdentity createIdentity(String nickname, String context, boolean publishTrustList, String requestUri, String insertUri) throws IOException, FcpException {
  91                 Map<String, String> parameters = new HashMap<String, String>();
  92                 parameters.put("Message", "CreateIdentity");
  93                 parameters.put("Nickname", nickname);
  94                 parameters.put("Context", context);
  95                 parameters.put("PublishTrustList", String.valueOf(publishTrustList));
  96                 if ((requestUri != null) && (insertUri != null)) {
  97                         parameters.put("RequestURI", requestUri);
  98                         parameters.put("InsertURI", insertUri);
  99                 }
 100                 Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", parameters);
 101                 if (!replies.get("Message").equals("IdentityCreated")) {
 102                         throw new FcpException("WebOfTrust Plugin did not reply with “IdentityCreated” message!");
 103                 }
 104                 String identifier = replies.get("ID");
 105                 String newRequestUri = replies.get("RequestURI");
 106                 String newInsertUri = replies.get("InsertURI");
 107                 return new OwnIdentity(identifier, nickname, newRequestUri, newInsertUri);
 108         }
 109
 110         /**
 111          * Returns all own identities of the web-of-trust plugins. Almost all other
 112          * commands require an {@link OwnIdentity} to return meaningful values.
 113          *
 114          * @return All own identities of the web-of-trust plugin
 115          * @throws IOException
 116          *             if an I/O error occurs
 117          * @throws FcpException
 118          *             if an FCP error occurs
 119          */
 120         public Set<OwnIdentity> getOwnIdentites() throws IOException, FcpException {
 121                 Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", createParameters("Message", "GetOwnIdentities"));
 122                 if (!replies.get("Message").equals("OwnIdentities")) {
 123                         throw new FcpException("WebOfTrust Plugin did not reply with “OwnIdentities” message!");
 124                 }
 125                 Set<OwnIdentity> ownIdentities = new HashSet<OwnIdentity>();
 126                 for (int identityIndex = 1; replies.containsKey("Identity" + identityIndex); identityIndex++) {
 127                         String identity = replies.get("Identity" + identityIndex);
 128                         String nickname = replies.get("Nickname" + identityIndex);
 129                         String requestUri = replies.get("RequestURI" + identityIndex);
 130                         String insertUri = replies.get("InsertURI" + identityIndex);
 131                         ownIdentities.add(new OwnIdentity(identity, nickname, requestUri, insertUri));
 132                 }
 133                 return ownIdentities;
 134         }
 135
 136         /**
 137          * Returns the trust given to the identity with the given identifier by the
 138          * given own identity.
 139          *
 140          * @param ownIdentity
 141          *            The own identity that is used to calculate trust values
 142          * @param identifier
 143          *            The identifier of the identity whose trust to get
 144          * @return The request identity trust
 145          * @throws IOException
 146          *             if an I/O error occurs
 147          * @throws FcpException
 148          *             if an FCP error occurs
 149          */
 150         public IdentityTrust getIdentityTrust(OwnIdentity ownIdentity, String identifier) throws IOException, FcpException {
 151                 Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", createParameters("Message", "GetIdentity", "TreeOwner", ownIdentity.getIdentifier(), "Identity", identifier));
 152                 if (!replies.get("Message").equals("Identity")) {
 153                         throw new FcpException("WebOfTrust Plugin did not reply with “Identity” message!");
 154                 }
 155                 Byte trust = null;
 156                 try {
 157                         trust = Byte.valueOf(replies.get("Trust"));
 158                 } catch (NumberFormatException nfe1) {
 159                         /* ignore. */
 160                 }
 161                 Integer score = null;
 162                 try {
 163                         score = Integer.valueOf(replies.get("Score"));
 164                 } catch (NumberFormatException nfe1) {
 165                         /* ignore. */
 166                 }
 167                 Integer rank = null;
 168                 try {
 169                         rank = Integer.valueOf(replies.get("Rank"));
 170                 } catch (NumberFormatException nfe1) {
 171                         /* ignore. */
 172                 }
 173                 return new IdentityTrust(trust, score, rank);
 174         }
 175
 176         /**
 177          * Adds a new identity by its request URI.
 178          *
 179          * @param requestUri
 180          *            The request URI of the identity to add
 181          * @return The added identity
 182          * @throws IOException
 183          *             if an I/O error occurs
 184          * @throws FcpException
 185          *             if an FCP error occurs
 186          */
 187         public Identity addIdentity(String requestUri) throws IOException, FcpException {
 188                 Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", createParameters("Message", "AddIdentity", "RequestURI", requestUri));
 189                 if (!replies.get("Message").equals("IdentityAdded")) {
 190                         throw new FcpException("WebOfTrust Plugin did not reply with “IdentityAdded” message!");
 191                 }
 192                 String identifier = replies.get("ID");
 193                 String nickname = replies.get("Nickname");
 194                 return new Identity(identifier, nickname, requestUri);
 195         }
 196
 197         //
 198         // PRIVATE METHODS
 199         //
 200
 201         /**
 202          * Creates a map from each pair of parameters in the given array.
 203          *
 204          * @param parameters
 205          *            The array of parameters
 206          * @return The map created from the array
 207          * @throws ArrayIndexOutOfBoundsException
 208          *             if the given parameter array does not contains an even number
 209          *             of elements
 210          */
 211         private Map<String, String> createParameters(String... parameters) throws ArrayIndexOutOfBoundsException {
 212                 Map<String, String> parameterMap = new HashMap<String, String>();
 213                 for (int index = 0; index < parameters.length; index += 2) {
 214                         parameterMap.put(parameters[index], parameters[index + 1]);
 215                 }
 216                 return parameterMap;
 217         }
 218
 219         /**
 220          * Wrapper around a web-of-trust identity.
 221          *
 222          * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
 223          */
 224         public static class Identity {
 225
 226                 /** The identity’s identifier. */
 227                 private final String identifier;
 228
 229                 /** The identity’s nickname. */
 230                 private final String nickname;
 231
 232                 /** The identity’s request URI. */
 233                 private final String requestUri;
 234
 235                 /**
 236                  * Creates a new identity.
 237                  *
 238                  * @param identifier
 239                  *            The identifies of the identity
 240                  * @param nickname
 241                  *            The nickname of the identity
 242                  * @param requestUri
 243                  *            The request URI of the identity
 244                  */
 245                 public Identity(String identifier, String nickname, String requestUri) {
 246                         this.identifier = identifier;
 247                         this.nickname = nickname;
 248                         this.requestUri = requestUri;
 249                 }
 250
 251                 /**
 252                  * Returns the identifier of this identity.
 253                  *
 254                  * @return This identity’s identifier
 255                  */
 256                 public String getIdentifier() {
 257                         return identifier;
 258                 }
 259
 260                 /**
 261                  * Returns the nickname of this identity.
 262                  *
 263                  * @return This identity’s nickname
 264                  */
 265                 public String getNickname() {
 266                         return nickname;
 267                 }
 268
 269                 /**
 270                  * Returns the request URI of this identity.
 271                  *
 272                  * @return This identity’s request URI
 273                  */
 274                 public String getRequestUri() {
 275                         return requestUri;
 276                 }
 277
 278         }
 279
 280         /**
 281          * Container that stores the trust given to an identity.
 282          *
 283          * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
 284          */
 285         public static class IdentityTrust {
 286
 287                 /** The identity’s trust value. */
 288                 private final Byte trust;
 289
 290                 /** The identity’s score value. */
 291                 private final Integer score;
 292
 293                 /** The identity’s rank. */
 294                 private final Integer rank;
 295
 296                 /**
 297                  * Creates a new identity trust container.
 298                  *
 299                  * @param trust
 300                  *            The trust value of the identity
 301                  * @param score
 302                  *            The score value of the identity
 303                  * @param rank
 304                  *            The rank of the identity
 305                  */
 306                 public IdentityTrust(Byte trust, Integer score, Integer rank) {
 307                         this.trust = trust;
 308                         this.score = score;
 309                         this.rank = rank;
 310                 }
 311
 312                 /**
 313                  * Returns the trust value of this identity.
 314                  *
 315                  * @return This identity’s trust value, or {@code null} if this
 316                  *         identity’s trust value is not known
 317                  */
 318                 public Byte getTrust() {
 319                         return trust;
 320                 }
 321
 322                 /**
 323                  * Returns the score value of this identity.
 324                  *
 325                  * @return This identity’s score value, or {@code null} if this
 326                  *         identity’s score value is not known
 327                  */
 328                 public Integer getScore() {
 329                         return score;
 330                 }
 331
 332                 /**
 333                  * Returns the rank of this identity.
 334                  *
 335                  * @return This identity’s rank, or {@code null} if this identity’s rank
 336                  *         is not known
 337                  */
 338                 public Integer getRank() {
 339                         return rank;
 340                 }
 341
 342         }
 343
 344         /**
 345          * Wrapper around a web-of-trust own identity.
 346          *
 347          * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
 348          */
 349         public static class OwnIdentity extends Identity {
 350
 351                 /** The identity’s insert URI. */
 352                 private final String insertUri;
 353
 354                 /**
 355                  * Creates a new web-of-trust own identity.
 356                  *
 357                  * @param identifier
 358                  *            The identifier of the identity
 359                  * @param nickname
 360                  *            The nickname of the identity
 361                  * @param requestUri
 362                  *            The request URI of the identity
 363                  * @param insertUri
 364                  *            The insert URI of the identity
 365                  */
 366                 public OwnIdentity(String identifier, String nickname, String requestUri, String insertUri) {
 367                         super(identifier, nickname, requestUri);
 368                         this.insertUri = insertUri;
 369                 }
 370
 371                 /**
 372                  * Returns the insert URI of this identity.
 373                  *
 374                  * @return This identity’s insert URI
 375                  */
 376                 public String getInsertUri() {
 377                         return insertUri;
 378                 }
 379
 380         }
 381
 382 }