2 * jFCPlib - WebOfTrustPlugin.java -
3 * Copyright © 2009 David Roden
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.
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.
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.
20 package net.pterodactylus.fcp.plugin;
22 import java.io.IOException;
23 import java.util.HashMap;
24 import java.util.HashSet;
28 import net.pterodactylus.fcp.highlevel.FcpClient;
29 import net.pterodactylus.fcp.highlevel.FcpException;
32 * Simplifies handling of the web-of-trust plugin.
34 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
36 public class WebOfTrustPlugin {
38 /** The FCP client to use. */
39 private final FcpClient fcpClient;
42 * Creates a new web-of-trust plugin wrapper around the given FCP client.
45 * The FCP client to use for communication with the web-of-trust
48 public WebOfTrustPlugin(FcpClient fcpClient) {
49 this.fcpClient = fcpClient;
53 * Creates a new identity.
56 * The nickname of the new identity
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
63 * if an I/O error occurs
64 * @throws FcpException
65 * if an FCP error occurs
67 public OwnIdentity createIdentity(String nickname, String context, boolean publishTrustList) throws IOException, FcpException {
68 return createIdentity(nickname, context, publishTrustList, null, null);
72 * Creates a new identity from the given request and insert URI.
75 * The nickname of the new identity
77 * The context for the new identity
78 * @param publishTrustList
79 * {@code true} if the new identity should publish its trust list
81 * The request URI of the identity
83 * The insert URI of the identity
84 * @return The new identity
86 * if an I/O error occurs
87 * @throws FcpException
88 * if an FCP error occurs
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);
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!");
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);
111 * Returns all own identities of the web-of-trust plugins. Almost all other
112 * commands require an {@link OwnIdentity} to return meaningful values.
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
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!");
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));
133 return ownIdentities;
137 * Returns the trust given to the identity with the given identifier by the
138 * given own identity.
141 * The own identity that is used to calculate trust values
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
150 public CalculatedTrust 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!");
157 trust = Byte.valueOf(replies.get("Trust"));
158 } catch (NumberFormatException nfe1) {
161 Integer score = null;
163 score = Integer.valueOf(replies.get("Score"));
164 } catch (NumberFormatException nfe1) {
169 rank = Integer.valueOf(replies.get("Rank"));
170 } catch (NumberFormatException nfe1) {
173 return new CalculatedTrust(trust, score, rank);
177 * Adds a new identity by its request URI.
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
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!");
192 String identifier = replies.get("ID");
193 String nickname = replies.get("Nickname");
194 return new Identity(identifier, nickname, requestUri);
198 * Returns identities by the given score.
203 * The context to get the identities for
205 * {@code null} to return neutrally trusted identities, {@code
206 * true} to return positively trusted identities, {@code false}
207 * for negatively trusted identities
208 * @return The trusted identites
209 * @throws IOException
210 * if an I/O error occurs
211 * @throws FcpException
212 * if an FCP error occurs
214 public Set<Identity> getIdentitesByScore(OwnIdentity ownIdentity, String context, Boolean positive) throws IOException, FcpException {
215 Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", createParameters("Message", "GetIdentitesByScore", "TreeOwner", ownIdentity.getIdentifier(), "Context", context, "Selection", ((positive == null) ? "0" : (positive ? "+" : "-"))));
216 if (!replies.get("Message").equals("Identities")) {
217 throw new FcpException("WebOfTrust Plugin did not reply with “Identities” message!");
219 Set<Identity> identities = new HashSet<Identity>();
220 for (int identityIndex = 1; replies.containsKey("Identity" + identityIndex); identityIndex++) {
221 String identifier = replies.get("Identity" + identityIndex);
222 String nickname = replies.get("Nickname" + identityIndex);
223 String requestUri = replies.get("RequestURI" + identityIndex);
224 identities.add(new Identity(identifier, nickname, requestUri));
230 * Sets the trust given to the given identify by the given own identity.
233 * The identity that gives the trust
235 * The identity that receives the trust
237 * The trust value (ranging from {@code -100} to {@code 100}
239 * The comment for setting the trust
240 * @throws IOException
241 * if an I/O error occurs
242 * @throws FcpException
243 * if an FCP error occurs
245 public void setTrust(OwnIdentity ownIdentity, Identity identity, byte trust, String comment) throws IOException, FcpException {
246 Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", createParameters("Message", "SetTrust", "Truster", ownIdentity.getIdentifier(), "Trustee", identity.getIdentifier(), "Value", String.valueOf(trust), "Comment", comment));
247 if (!replies.get("Message").equals("TrustSet")) {
248 throw new FcpException("WebOfTrust Plugin did not reply with “TrustSet” message!");
257 * Creates a map from each pair of parameters in the given array.
260 * The array of parameters
261 * @return The map created from the array
262 * @throws ArrayIndexOutOfBoundsException
263 * if the given parameter array does not contains an even number
266 private Map<String, String> createParameters(String... parameters) throws ArrayIndexOutOfBoundsException {
267 Map<String, String> parameterMap = new HashMap<String, String>();
268 for (int index = 0; index < parameters.length; index += 2) {
269 parameterMap.put(parameters[index], parameters[index + 1]);
275 * Wrapper around a web-of-trust identity.
277 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
279 public static class Identity {
281 /** The identity’s identifier. */
282 private final String identifier;
284 /** The identity’s nickname. */
285 private final String nickname;
287 /** The identity’s request URI. */
288 private final String requestUri;
291 * Creates a new identity.
294 * The identifies of the identity
296 * The nickname of the identity
298 * The request URI of the identity
300 public Identity(String identifier, String nickname, String requestUri) {
301 this.identifier = identifier;
302 this.nickname = nickname;
303 this.requestUri = requestUri;
307 * Returns the identifier of this identity.
309 * @return This identity’s identifier
311 public String getIdentifier() {
316 * Returns the nickname of this identity.
318 * @return This identity’s nickname
320 public String getNickname() {
325 * Returns the request URI of this identity.
327 * @return This identity’s request URI
329 public String getRequestUri() {
336 * Container that stores the trust that is calculated by taking all trustees
337 * and their trust lists into account.
339 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
341 public static class CalculatedTrust {
343 /** The calculated trust value. */
344 private final Byte trust;
346 /** The calculated score value. */
347 private final Integer score;
349 /** The calculated rank. */
350 private final Integer rank;
353 * Creates a new calculated trust container.
356 * The calculated trust value
358 * The calculated score value
360 * The calculated rank of the
362 public CalculatedTrust(Byte trust, Integer score, Integer rank) {
369 * Returns the calculated trust value.
371 * @return The calculated trust value, or {@code null} if the trust
374 public Byte getTrust() {
379 * Returns the calculated score value.
381 * @return The calculated score value, or {@code null} if the score
384 public Integer getScore() {
389 * Returns the calculated rank.
391 * @return The calculated rank, or {@code null} if the rank is not known
393 public Integer getRank() {
400 * Wrapper around a web-of-trust own identity.
402 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
404 public static class OwnIdentity extends Identity {
406 /** The identity’s insert URI. */
407 private final String insertUri;
410 * Creates a new web-of-trust own identity.
413 * The identifier of the identity
415 * The nickname of the identity
417 * The request URI of the identity
419 * The insert URI of the identity
421 public OwnIdentity(String identifier, String nickname, String requestUri, String insertUri) {
422 super(identifier, nickname, requestUri);
423 this.insertUri = insertUri;
427 * Returns the insert URI of this identity.
429 * @return This identity’s insert URI
431 public String getInsertUri() {