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         // PRIVATE METHODS
 138         //
 139
 140         /**
 141          * Creates a map from each pair of parameters in the given array.
 142          *
 143          * @param parameters
 144          *            The array of parameters
 145          * @return The map created from the array
 146          * @throws ArrayIndexOutOfBoundsException
 147          *             if the given parameter array does not contains an even number
 148          *             of elements
 149          */
 150         private Map<String, String> createParameters(String... parameters) throws ArrayIndexOutOfBoundsException {
 151                 Map<String, String> parameterMap = new HashMap<String, String>();
 152                 for (int index = 0; index < parameters.length; index += 2) {
 153                         parameterMap.put(parameters[index], parameters[index + 1]);
 154                 }
 155                 return parameterMap;
 156         }
 157
 158         /**
 159          * Wrapper around a web-of-trust identity.
 160          *
 161          * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
 162          */
 163         public static class Identity {
 164
 165                 /** The identity’s identifier. */
 166                 private final String identifier;
 167
 168                 /** The identity’s nickname. */
 169                 private final String nickname;
 170
 171                 /** The identity’s request URI. */
 172                 private final String requestUri;
 173
 174                 /** The identity’s trust value. */
 175                 private final Byte trust;
 176
 177                 /** The identity’s score value. */
 178                 private final Integer score;
 179
 180                 /** The identity’s rank. */
 181                 private final Integer rank;
 182
 183                 /**
 184                  * Creates a new identity.
 185                  *
 186                  * @param identifier
 187                  *            The identifies of the identity
 188                  * @param nickname
 189                  *            The nickname of the identity
 190                  * @param requestUri
 191                  *            The request URI of the identity
 192                  * @param trust
 193                  *            The trust value of the identity
 194                  * @param score
 195                  *            The score value of the identity
 196                  * @param rank
 197                  *            The rank of the identity
 198                  */
 199                 public Identity(String identifier, String nickname, String requestUri, Byte trust, Integer score, Integer rank) {
 200                         this.identifier = identifier;
 201                         this.nickname = nickname;
 202                         this.requestUri = requestUri;
 203                         this.trust = trust;
 204                         this.score = score;
 205                         this.rank = rank;
 206                 }
 207
 208                 /**
 209                  * Returns the identifier of this identity.
 210                  *
 211                  * @return This identity’s identifier
 212                  */
 213                 public String getIdentifier() {
 214                         return identifier;
 215                 }
 216
 217                 /**
 218                  * Returns the nickname of this identity.
 219                  *
 220                  * @return This identity’s nickname
 221                  */
 222                 public String getNickname() {
 223                         return nickname;
 224                 }
 225
 226                 /**
 227                  * Returns the request URI of this identity.
 228                  *
 229                  * @return This identity’s request URI
 230                  */
 231                 public String getRequestUri() {
 232                         return requestUri;
 233                 }
 234
 235                 /**
 236                  * Returns the trust value of this identity.
 237                  *
 238                  * @return This identity’s trust value, or {@code null} if this
 239                  *         identity’s trust value is not known
 240                  */
 241                 public Byte getTrust() {
 242                         return trust;
 243                 }
 244
 245                 /**
 246                  * Returns the score value of this identity.
 247                  *
 248                  * @return This identity’s score value, or {@code null} if this
 249                  *         identity’s score value is not known
 250                  */
 251                 public Integer getScore() {
 252                         return score;
 253                 }
 254
 255                 /**
 256                  * Returns the rank of this identity.
 257                  *
 258                  * @return This identity’s rank, or {@code null} if this identity’s rank
 259                  *         is not known
 260                  */
 261                 public Integer getRank() {
 262                         return rank;
 263                 }
 264
 265         }
 266
 267         /**
 268          * Wrapper around a web-of-trust own identity.
 269          *
 270          * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
 271          */
 272         public static class OwnIdentity extends Identity {
 273
 274                 /** The identity’s insert URI. */
 275                 private final String insertUri;
 276
 277                 /**
 278                  * Creates a new web-of-trust own identity.
 279                  *
 280                  * @param identifier
 281                  *            The identifier of the identity
 282                  * @param nickname
 283                  *            The nickname of the identity
 284                  * @param requestUri
 285                  *            The request URI of the identity
 286                  * @param insertUri
 287                  *            The insert URI of the identity
 288                  */
 289                 public OwnIdentity(String identifier, String nickname, String requestUri, String insertUri) {
 290                         super(identifier, nickname, requestUri);
 291                         this.insertUri = insertUri;
 292                 }
 293
 294                 /**
 295                  * Returns the insert URI of this identity.
 296                  *
 297                  * @return This identity’s insert URI
 298                  */
 299                 public String getInsertUri() {
 300                         return insertUri;
 301                 }
 302
 303         }
 304
 305 }