2 * Sone - TrustUpdater.java - Copyright © 2012 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.core;
20 import java.util.concurrent.BlockingQueue;
21 import java.util.concurrent.LinkedBlockingQueue;
22 import java.util.logging.Level;
23 import java.util.logging.Logger;
25 import net.pterodactylus.sone.freenet.plugin.PluginException;
26 import net.pterodactylus.sone.freenet.wot.DefaultIdentity;
27 import net.pterodactylus.sone.freenet.wot.Identity;
28 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
29 import net.pterodactylus.sone.freenet.wot.Trust;
30 import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
31 import net.pterodactylus.sone.freenet.wot.WebOfTrustException;
32 import net.pterodactylus.util.logging.Logging;
33 import net.pterodactylus.util.service.AbstractService;
36 * Updates identity’s trust in a background thread because getting updates from
37 * the WebOfTrust plugin can potentially last quite long.
39 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
41 public class TrustUpdater extends AbstractService {
44 private static final Logger logger = Logging.getLogger(TrustUpdater.class);
47 private static final TrustUpdateJob stopJob = new TrustUpdateJob(null, null);
49 /** The web of trust connector. */
50 private final WebOfTrustConnector webOfTrustConnector;
52 /** The queue for jobs. */
53 private final BlockingQueue<TrustUpdateJob> updateJobs = new LinkedBlockingQueue<TrustUpdateJob>();
56 * Creates a new trust updater.
58 * @param webOfTrustConnector
59 * The web of trust connector
61 public TrustUpdater(WebOfTrustConnector webOfTrustConnector) {
62 super("Trust Updater");
63 this.webOfTrustConnector = webOfTrustConnector;
71 * Retrieves the trust relation between the truster and the trustee. This
72 * method will return immediately and perform a trust update in the
76 * The identity giving the trust
78 * The identity receiving the trust
80 public void getTrust(OwnIdentity truster, Identity trustee) {
81 updateJobs.add(new GetTrustJob(truster, trustee));
85 * Updates the trust relation between the truster and the trustee. This
86 * method will return immediately and perform a trust update in the
90 * The identity giving the trust
92 * The identity receiving the trust
94 * The new level of trust (from -100 to 100, may be {@code null}
95 * to remove the trust completely)
97 * The comment of the trust relation
99 public void setTrust(OwnIdentity truster, Identity trustee, Integer score, String comment) {
100 updateJobs.add(new SetTrustJob(truster, trustee, score, comment));
111 protected void serviceRun() {
112 while (!shouldStop()) {
114 TrustUpdateJob updateJob = updateJobs.take();
115 if (shouldStop() || (updateJob == stopJob)) {
119 } catch (InterruptedException ie1) {
120 /* happens, ignore, loop. */
129 protected void serviceStop() {
131 updateJobs.put(stopJob);
132 } catch (InterruptedException ie1) {
133 /* the queue is unbounded so it should never block. */
138 * Base class for trust update jobs.
140 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
142 private static class TrustUpdateJob {
144 /** The identity giving the trust. */
145 protected final OwnIdentity truster;
147 /** The identity receiving the trust. */
148 protected final Identity trustee;
151 * Creates a new trust update job.
154 * The identity giving the trust
156 * The identity receiving the trust
158 public TrustUpdateJob(OwnIdentity truster, Identity trustee) {
159 this.truster = truster;
160 this.trustee = trustee;
168 * Performs the actual update operation.
170 * The implementation of this class does nothing.
184 public boolean equals(Object object) {
185 if ((object == null) || !object.getClass().equals(getClass())) {
188 TrustUpdateJob updateJob = (TrustUpdateJob) object;
189 return ((truster == null) ? (updateJob.truster == null) : updateJob.truster.equals(truster)) && ((trustee == null) ? (updateJob.trustee == null) : updateJob.trustee.equals(trustee));
196 public int hashCode() {
197 return ((truster == null) ? 0 : truster.hashCode()) ^ ((trustee == null) ? 0 : trustee.hashCode());
204 public String toString() {
205 return String.format("%s[truster=%s,trustee=%s]", getClass().getSimpleName(), (truster == null) ? null : truster.getId(), (trustee == null) ? null : trustee.getId());
211 * Update job that sets the trust relation between two identities.
213 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
215 private class SetTrustJob extends TrustUpdateJob {
217 /** The score of the relation. */
218 private final Integer score;
220 /** The comment of the relation. */
221 private final String comment;
224 * Creates a new set trust job.
227 * The identity giving the trust
229 * The identity receiving the trust
231 * The score of the trust (from -100 to 100, may be
232 * {@code null} to remote the trust relation completely)
234 * The comment of the trust relation
236 public SetTrustJob(OwnIdentity truster, Identity trustee, Integer score, String comment) {
237 super(truster, trustee);
239 this.comment = comment;
246 @SuppressWarnings("synthetic-access")
250 if (trustee instanceof DefaultIdentity) {
251 ((DefaultIdentity) trustee).setTrust(truster, new Trust(score, null, 0));
253 webOfTrustConnector.setTrust(truster, trustee, score, comment);
255 if (trustee instanceof DefaultIdentity) {
256 ((DefaultIdentity) trustee).setTrust(truster, null);
258 webOfTrustConnector.removeTrust(truster, trustee);
260 } catch (WebOfTrustException wote1) {
261 logger.log(Level.WARNING, "Could not set Trust value for " + truster + " -> " + trustee + " to " + score + " (" + comment + ")!", wote1);
268 * Update job that retrieves the trust relation between two identities.
270 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
272 private class GetTrustJob extends TrustUpdateJob {
275 * Creates a new trust update job.
278 * The identity giving the trust
280 * The identity receiving the trust
282 public GetTrustJob(OwnIdentity truster, Identity trustee) {
283 super(truster, trustee);
290 @SuppressWarnings("synthetic-access")
293 Trust trust = webOfTrustConnector.getTrust(truster, trustee);
294 if (trustee instanceof DefaultIdentity) {
295 ((DefaultIdentity) trustee).setTrust(truster, trust);
297 } catch (PluginException pe1) {
298 logger.log(Level.WARNING, "Could not get Trust value for " + truster + " -> " + trustee + "!", pe1);