Implement GetIdentitiesByScore message.
[jFCPlib.git] / src / net / pterodactylus / fcp / plugin / WebOfTrustPlugin.java
index df6991e..7e1861c 100644 (file)
@@ -134,26 +134,24 @@ public class WebOfTrustPlugin {
        }
 
        /**
-        * Returns the identity with the given identifier and the trust values
-        * depending on the given own identity.
+        * Returns the trust given to the identity with the given identifier by the
+        * given own identity.
         *
         * @param ownIdentity
         *            The own identity that is used to calculate trust values
         * @param identifier
-        *            The identifier of the identity to get
-        * @return The request identity
+        *            The identifier of the identity whose trust to get
+        * @return The request identity trust
         * @throws IOException
         *             if an I/O error occurs
         * @throws FcpException
         *             if an FCP error occurs
         */
-       public Identity getIdentity(OwnIdentity ownIdentity, String identifier) throws IOException, FcpException {
+       public IdentityTrust getIdentityTrust(OwnIdentity ownIdentity, String identifier) throws IOException, FcpException {
                Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", createParameters("Message", "GetIdentity", "TreeOwner", ownIdentity.getIdentifier(), "Identity", identifier));
                if (!replies.get("Message").equals("Identity")) {
                        throw new FcpException("WebOfTrust Plugin did not reply with “Identity” message!");
                }
-               String nickname = replies.get("Nickname");
-               String requestUri = replies.get("RequestURI");
                Byte trust = null;
                try {
                        trust = Byte.valueOf(replies.get("Trust"));
@@ -172,7 +170,60 @@ public class WebOfTrustPlugin {
                } catch (NumberFormatException nfe1) {
                        /* ignore. */
                }
-               return new Identity(identifier, nickname, requestUri, trust, score, rank);
+               return new IdentityTrust(trust, score, rank);
+       }
+
+       /**
+        * Adds a new identity by its request URI.
+        *
+        * @param requestUri
+        *            The request URI of the identity to add
+        * @return The added identity
+        * @throws IOException
+        *             if an I/O error occurs
+        * @throws FcpException
+        *             if an FCP error occurs
+        */
+       public Identity addIdentity(String requestUri) throws IOException, FcpException {
+               Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", createParameters("Message", "AddIdentity", "RequestURI", requestUri));
+               if (!replies.get("Message").equals("IdentityAdded")) {
+                       throw new FcpException("WebOfTrust Plugin did not reply with “IdentityAdded” message!");
+               }
+               String identifier = replies.get("ID");
+               String nickname = replies.get("Nickname");
+               return new Identity(identifier, nickname, requestUri);
+       }
+
+       /**
+        * Returns identities by the given score.
+        *
+        * @param ownIdentity
+        *            The own identity
+        * @param context
+        *            The context to get the identities for
+        * @param positive
+        *            {@code null} to return neutrally trusted identities, {@code
+        *            true} to return positively trusted identities, {@code false}
+        *            for negatively trusted identities
+        * @return The trusted identites
+        * @throws IOException
+        *             if an I/O error occurs
+        * @throws FcpException
+        *             if an FCP error occurs
+        */
+       public Set<Identity> getIdentitesByScore(OwnIdentity ownIdentity, String context, Boolean positive) throws IOException, FcpException {
+               Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", createParameters("Message", "GetIdentitesByScore", "TreeOwner", ownIdentity.getIdentifier(), "Context", context, "Selection", ((positive == null) ? "0" : (positive ? "+" : "-"))));
+               if (!replies.get("Message").equals("Identities")) {
+                       throw new FcpException("WebOfTrust Plugin did not reply with “Identities” message!");
+               }
+               Set<Identity> identities = new HashSet<Identity>();
+               for (int identityIndex = 1; replies.containsKey("Identity" + identityIndex); identityIndex++) {
+                       String identifier = replies.get("Identity" + identityIndex);
+                       String nickname = replies.get("Nickname" + identityIndex);
+                       String requestUri = replies.get("RequestURI" + identityIndex);
+                       identities.add(new Identity(identifier, nickname, requestUri));
+               }
+               return identities;
        }
 
        //
@@ -213,15 +264,6 @@ public class WebOfTrustPlugin {
                /** The identity’s request URI. */
                private final String requestUri;
 
-               /** The identity’s trust value. */
-               private final Byte trust;
-
-               /** The identity’s score value. */
-               private final Integer score;
-
-               /** The identity’s rank. */
-               private final Integer rank;
-
                /**
                 * Creates a new identity.
                 *
@@ -231,20 +273,11 @@ public class WebOfTrustPlugin {
                 *            The nickname of the identity
                 * @param requestUri
                 *            The request URI of the identity
-                * @param trust
-                *            The trust value of the identity
-                * @param score
-                *            The score value of the identity
-                * @param rank
-                *            The rank of the identity
                 */
-               public Identity(String identifier, String nickname, String requestUri, Byte trust, Integer score, Integer rank) {
+               public Identity(String identifier, String nickname, String requestUri) {
                        this.identifier = identifier;
                        this.nickname = nickname;
                        this.requestUri = requestUri;
-                       this.trust = trust;
-                       this.score = score;
-                       this.rank = rank;
                }
 
                /**
@@ -274,6 +307,40 @@ public class WebOfTrustPlugin {
                        return requestUri;
                }
 
+       }
+
+       /**
+        * Container that stores the trust given to an identity.
+        *
+        * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
+        */
+       public static class IdentityTrust {
+
+               /** The identity’s trust value. */
+               private final Byte trust;
+
+               /** The identity’s score value. */
+               private final Integer score;
+
+               /** The identity’s rank. */
+               private final Integer rank;
+
+               /**
+                * Creates a new identity trust container.
+                *
+                * @param trust
+                *            The trust value of the identity
+                * @param score
+                *            The score value of the identity
+                * @param rank
+                *            The rank of the identity
+                */
+               public IdentityTrust(Byte trust, Integer score, Integer rank) {
+                       this.trust = trust;
+                       this.score = score;
+                       this.rank = rank;
+               }
+
                /**
                 * Returns the trust value of this identity.
                 *
@@ -311,16 +378,7 @@ public class WebOfTrustPlugin {
         *
         * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
         */
-       public static class OwnIdentity {
-
-               /** The identity’s identifier. */
-               private final String identifier;
-
-               /** The identity’s nickname. */
-               private final String nickname;
-
-               /** The identity’s request URI. */
-               private final String requestUri;
+       public static class OwnIdentity extends Identity {
 
                /** The identity’s insert URI. */
                private final String insertUri;
@@ -338,40 +396,11 @@ public class WebOfTrustPlugin {
                 *            The insert URI of the identity
                 */
                public OwnIdentity(String identifier, String nickname, String requestUri, String insertUri) {
-                       this.identifier = identifier;
-                       this.nickname = nickname;
-                       this.requestUri = requestUri;
+                       super(identifier, nickname, requestUri);
                        this.insertUri = insertUri;
                }
 
                /**
-                * Returns the identifier of this identity.
-                *
-                * @return This identity’s identifier
-                */
-               public String getIdentifier() {
-                       return identifier;
-               }
-
-               /**
-                * Returns the nickname of this identity.
-                *
-                * @return This identity’s nickname
-                */
-               public String getNickname() {
-                       return nickname;
-               }
-
-               /**
-                * Returns the request URI of this identity.
-                *
-                * @return This identity’s request URI
-                */
-               public String getRequestUri() {
-                       return requestUri;
-               }
-
-               /**
                 * Returns the insert URI of this identity.
                 *
                 * @return This identity’s insert URI