2 * Sone - WebOfTrustUpdater.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 static com.google.common.base.Preconditions.checkNotNull;
22 import java.util.concurrent.BlockingQueue;
23 import java.util.concurrent.LinkedBlockingQueue;
24 import java.util.logging.Level;
25 import java.util.logging.Logger;
27 import net.pterodactylus.sone.freenet.plugin.PluginException;
28 import net.pterodactylus.sone.freenet.wot.DefaultIdentity;
29 import net.pterodactylus.sone.freenet.wot.Identity;
30 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
31 import net.pterodactylus.sone.freenet.wot.Trust;
32 import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
33 import net.pterodactylus.sone.freenet.wot.WebOfTrustException;
34 import net.pterodactylus.util.logging.Logging;
35 import net.pterodactylus.util.service.AbstractService;
37 import com.google.inject.Inject;
40 * Updates WebOfTrust identity data in a background thread because communicating
41 * with the WebOfTrust plugin can potentially last quite long.
43 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
45 public class WebOfTrustUpdater extends AbstractService {
48 private static final Logger logger = Logging.getLogger(WebOfTrustUpdater.class);
51 @SuppressWarnings("synthetic-access")
52 private final WebOfTrustUpdateJob stopJob = new WebOfTrustUpdateJob();
54 /** The web of trust connector. */
55 private final WebOfTrustConnector webOfTrustConnector;
57 /** The queue for jobs. */
58 private final BlockingQueue<WebOfTrustUpdateJob> updateJobs = new LinkedBlockingQueue<WebOfTrustUpdateJob>();
61 * Creates a new trust updater.
63 * @param webOfTrustConnector
64 * The web of trust connector
67 public WebOfTrustUpdater(WebOfTrustConnector webOfTrustConnector) {
68 super("Trust Updater");
69 this.webOfTrustConnector = webOfTrustConnector;
77 * Updates the trust relation between the truster and the trustee. This
78 * method will return immediately and perform a trust update in the
82 * The identity giving the trust
84 * The identity receiving the trust
86 * The new level of trust (from -100 to 100, may be {@code null}
87 * to remove the trust completely)
89 * The comment of the trust relation
91 public void setTrust(OwnIdentity truster, Identity trustee, Integer score, String comment) {
92 SetTrustJob setTrustJob = new SetTrustJob(truster, trustee, score, comment);
93 if (updateJobs.contains(setTrustJob)) {
94 updateJobs.remove(setTrustJob);
96 logger.log(Level.FINER, "Adding Trust Update Job: " + setTrustJob);
98 updateJobs.put(setTrustJob);
99 } catch (InterruptedException e) {
100 /* the queue is unbounded so it should never block. */
105 * Adds the given context to the given own identity.
108 * The own identity to add the context to
112 public void addContext(OwnIdentity ownIdentity, String context) {
113 addContextWait(ownIdentity, context, false);
117 * Adds the given context to the given own identity, waiting for completion
121 * The own identity to add the context to
124 * @return {@code true} if the context was added successfully, {@code false}
127 public boolean addContextWait(OwnIdentity ownIdentity, String context) {
128 return addContextWait(ownIdentity, context, true);
132 * Adds the given context to the given own identity, waiting for completion
136 * The own identity to add the context to
140 * {@code true} to wait for the end of the operation,
141 * {@code false} to return immediately
142 * @return {@code true} if the context was added successfully, {@code false}
143 * if the context was not added successfully, or if the job should
144 * not wait for completion
146 private boolean addContextWait(OwnIdentity ownIdentity, String context, boolean wait) {
147 AddContextJob addContextJob = new AddContextJob(ownIdentity, context);
148 if (!updateJobs.contains(addContextJob)) {
149 logger.log(Level.FINER, "Adding Context Job: " + addContextJob);
151 updateJobs.put(addContextJob);
152 } catch (InterruptedException ie1) {
153 /* the queue is unbounded so it should never block. */
156 return addContextJob.waitForCompletion();
159 for (WebOfTrustUpdateJob updateJob : updateJobs) {
160 if (updateJob.equals(addContextJob)) {
161 return updateJob.waitForCompletion();
169 * Removes the given context from the given own identity.
172 * The own identity to remove the context from
174 * The context to remove
176 public void removeContext(OwnIdentity ownIdentity, String context) {
177 RemoveContextJob removeContextJob = new RemoveContextJob(ownIdentity, context);
178 if (!updateJobs.contains(removeContextJob)) {
179 logger.log(Level.FINER, "Adding Context Job: " + removeContextJob);
181 updateJobs.put(removeContextJob);
182 } catch (InterruptedException ie1) {
183 /* the queue is unbounded so it should never block. */
189 * Sets a property on the given own identity.
192 * The own identity to set the property on
193 * @param propertyName
194 * The name of the property to set
195 * @param propertyValue
196 * The value of the property to set
198 public void setProperty(OwnIdentity ownIdentity, String propertyName, String propertyValue) {
199 SetPropertyJob setPropertyJob = new SetPropertyJob(ownIdentity, propertyName, propertyValue);
200 if (updateJobs.contains(setPropertyJob)) {
201 updateJobs.remove(setPropertyJob);
203 logger.log(Level.FINER, "Adding Property Job: " + setPropertyJob);
205 updateJobs.put(setPropertyJob);
206 } catch (InterruptedException e) {
207 /* the queue is unbounded so it should never block. */
212 * Removes a property from the given own identity.
215 * The own identity to remove the property from
216 * @param propertyName
217 * The name of the property to remove
219 public void removeProperty(OwnIdentity ownIdentity, String propertyName) {
220 setProperty(ownIdentity, propertyName, null);
231 protected void serviceRun() {
232 while (!shouldStop()) {
234 WebOfTrustUpdateJob updateJob = updateJobs.take();
235 if (shouldStop() || (updateJob == stopJob)) {
238 logger.log(Level.FINE, "Running Trust Update Job: " + updateJob);
239 long startTime = System.currentTimeMillis();
241 long endTime = System.currentTimeMillis();
242 logger.log(Level.FINE, "Trust Update Job finished, took " + (endTime - startTime) + " ms.");
243 } catch (InterruptedException ie1) {
244 /* happens, ignore, loop. */
253 protected void serviceStop() {
255 updateJobs.put(stopJob);
256 } catch (InterruptedException ie1) {
257 /* the queue is unbounded so it should never block. */
262 * Base class for WebOfTrust update jobs.
264 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
266 private class WebOfTrustUpdateJob {
268 /** Object for synchronization. */
269 @SuppressWarnings("hiding")
270 private final Object syncObject = new Object();
272 /** Whether the job has finished. */
273 private boolean finished;
275 /** Whether the job was successful. */
276 private boolean success;
283 * Performs the actual update operation.
285 * The implementation of this class does nothing.
292 * Waits for completion of this job or stopping of the WebOfTrust
295 * @return {@code true} if this job finished successfully, {@code false}
298 * @see WebOfTrustUpdater#stop()
300 @SuppressWarnings("synthetic-access")
301 public boolean waitForCompletion() {
302 synchronized (syncObject) {
303 while (!finished && !shouldStop()) {
306 } catch (InterruptedException ie1) {
307 /* we’re looping, ignore. */
319 * Signals that this job has finished.
322 * {@code true} if this job finished successfully,
323 * {@code false} otherwise
325 protected void finish(boolean success) {
326 synchronized (syncObject) {
328 this.success = success;
329 syncObject.notifyAll();
336 * Base class for WebOfTrust trust update jobs.
338 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
340 private class WebOfTrustTrustUpdateJob extends WebOfTrustUpdateJob {
342 /** The identity giving the trust. */
343 protected final OwnIdentity truster;
345 /** The identity receiving the trust. */
346 protected final Identity trustee;
349 * Creates a new trust update job.
352 * The identity giving the trust
354 * The identity receiving the trust
356 @SuppressWarnings("synthetic-access")
357 public WebOfTrustTrustUpdateJob(OwnIdentity truster, Identity trustee) {
358 this.truster = truster;
359 this.trustee = trustee;
370 public boolean equals(Object object) {
371 if ((object == null) || !object.getClass().equals(getClass())) {
374 WebOfTrustTrustUpdateJob updateJob = (WebOfTrustTrustUpdateJob) object;
375 return ((truster == null) ? (updateJob.truster == null) : updateJob.truster.equals(truster)) && ((trustee == null) ? (updateJob.trustee == null) : updateJob.trustee.equals(trustee));
382 public int hashCode() {
383 return getClass().hashCode() ^ ((truster == null) ? 0 : truster.hashCode()) ^ ((trustee == null) ? 0 : trustee.hashCode());
390 public String toString() {
391 return String.format("%s[truster=%s,trustee=%s]", getClass().getSimpleName(), (truster == null) ? null : truster.getId(), (trustee == null) ? null : trustee.getId());
397 * Update job that sets the trust relation between two identities.
399 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
401 private class SetTrustJob extends WebOfTrustTrustUpdateJob {
403 /** The score of the relation. */
404 private final Integer score;
406 /** The comment of the relation. */
407 private final String comment;
410 * Creates a new set trust job.
413 * The identity giving the trust
415 * The identity receiving the trust
417 * The score of the trust (from -100 to 100, may be
418 * {@code null} to remote the trust relation completely)
420 * The comment of the trust relation
422 public SetTrustJob(OwnIdentity truster, Identity trustee, Integer score, String comment) {
423 super(truster, trustee);
425 this.comment = comment;
432 @SuppressWarnings("synthetic-access")
436 if (trustee instanceof DefaultIdentity) {
437 ((DefaultIdentity) trustee).setTrust(truster, new Trust(score, null, 0));
439 webOfTrustConnector.setTrust(truster, trustee, score, comment);
441 if (trustee instanceof DefaultIdentity) {
442 ((DefaultIdentity) trustee).setTrust(truster, null);
444 webOfTrustConnector.removeTrust(truster, trustee);
447 } catch (WebOfTrustException wote1) {
448 logger.log(Level.WARNING, "Could not set Trust value for " + truster + " -> " + trustee + " to " + score + " (" + comment + ")!", wote1);
456 * Base class for context updates of an {@link OwnIdentity}.
458 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
460 private class WebOfTrustContextUpdateJob extends WebOfTrustUpdateJob {
462 /** The own identity whose contexts to manage. */
463 protected final OwnIdentity ownIdentity;
465 /** The context to update. */
466 protected final String context;
469 * Creates a new context update job.
472 * The own identity to update
474 * The context to update
476 @SuppressWarnings("synthetic-access")
477 public WebOfTrustContextUpdateJob(OwnIdentity ownIdentity, String context) {
478 this.ownIdentity = checkNotNull(ownIdentity, "ownIdentity must not be null");
479 this.context = checkNotNull(context, "context must not be null");
490 public boolean equals(Object object) {
491 if ((object == null) || !object.getClass().equals(getClass())) {
494 WebOfTrustContextUpdateJob updateJob = (WebOfTrustContextUpdateJob) object;
495 return updateJob.ownIdentity.equals(ownIdentity) && updateJob.context.equals(context);
502 public int hashCode() {
503 return getClass().hashCode() ^ ownIdentity.hashCode() ^ context.hashCode();
510 public String toString() {
511 return String.format("%s[ownIdentity=%s,context=%s]", getClass().getSimpleName(), ownIdentity, context);
517 * Job that adds a context to an {@link OwnIdentity}.
519 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
521 private class AddContextJob extends WebOfTrustContextUpdateJob {
524 * Creates a new add-context job.
527 * The own identity whose contexts to manage
531 public AddContextJob(OwnIdentity ownIdentity, String context) {
532 super(ownIdentity, context);
539 @SuppressWarnings("synthetic-access")
542 webOfTrustConnector.addContext(ownIdentity, context);
543 ownIdentity.addContext(context);
545 } catch (PluginException pe1) {
546 logger.log(Level.WARNING, String.format("Could not add Context “%2$s” to Own Identity %1$s!", ownIdentity, context), pe1);
554 * Job that removes a context from an {@link OwnIdentity}.
556 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
558 private class RemoveContextJob extends WebOfTrustContextUpdateJob {
561 * Creates a new remove-context job.
564 * The own identity whose contexts to manage
566 * The context to remove
568 public RemoveContextJob(OwnIdentity ownIdentity, String context) {
569 super(ownIdentity, context);
576 @SuppressWarnings("synthetic-access")
579 webOfTrustConnector.removeContext(ownIdentity, context);
580 ownIdentity.removeContext(context);
582 } catch (PluginException pe1) {
583 logger.log(Level.WARNING, String.format("Could not remove Context “%2$s” to Own Identity %1$s!", ownIdentity, context), pe1);
591 * Base class for update jobs that deal with properties.
593 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
595 private class WebOfTrustPropertyUpdateJob extends WebOfTrustUpdateJob {
597 /** The own identity to update properties on. */
598 protected final OwnIdentity ownIdentity;
600 /** The name of the property to update. */
601 protected final String propertyName;
604 * Creates a new property update job.
607 * The own identity to update the property on
608 * @param propertyName
609 * The name of the property to update
611 @SuppressWarnings("synthetic-access")
612 public WebOfTrustPropertyUpdateJob(OwnIdentity ownIdentity, String propertyName) {
613 this.ownIdentity = ownIdentity;
614 this.propertyName = propertyName;
625 public boolean equals(Object object) {
626 if ((object == null) || !object.getClass().equals(getClass())) {
629 WebOfTrustPropertyUpdateJob updateJob = (WebOfTrustPropertyUpdateJob) object;
630 return updateJob.ownIdentity.equals(ownIdentity) && updateJob.propertyName.equals(propertyName);
637 public int hashCode() {
638 return getClass().hashCode() ^ ownIdentity.hashCode() ^ propertyName.hashCode();
645 public String toString() {
646 return String.format("%s[ownIdentity=%s,propertyName=%s]", getClass().getSimpleName(), ownIdentity, propertyName);
652 * WebOfTrust update job that sets a property on an {@link OwnIdentity}.
654 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
656 private class SetPropertyJob extends WebOfTrustPropertyUpdateJob {
658 /** The value of the property to set. */
659 private final String propertyValue;
662 * Creates a new set-property job.
665 * The own identity to set the property on
666 * @param propertyName
667 * The name of the property to set
668 * @param propertyValue
669 * The value of the property to set
671 public SetPropertyJob(OwnIdentity ownIdentity, String propertyName, String propertyValue) {
672 super(ownIdentity, propertyName);
673 this.propertyValue = propertyValue;
680 @SuppressWarnings("synthetic-access")
683 if (propertyValue == null) {
684 webOfTrustConnector.removeProperty(ownIdentity, propertyName);
685 ownIdentity.removeProperty(propertyName);
687 webOfTrustConnector.setProperty(ownIdentity, propertyName, propertyValue);
688 ownIdentity.setProperty(propertyName, propertyValue);
691 } catch (PluginException pe1) {
692 logger.log(Level.WARNING, String.format("Could not set Property “%2$s” to “%3$s” on Own Identity %1$s!", ownIdentity, propertyName, propertyValue), pe1);