2 * Sone - WebOfTrustUpdater.java - Copyright © 2013 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.common.annotations.VisibleForTesting;
38 import com.google.inject.Inject;
41 * Updates WebOfTrust identity data in a background thread because communicating
42 * with the WebOfTrust plugin can potentially last quite long.
44 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
46 public class WebOfTrustUpdater extends AbstractService {
49 private static final Logger logger = Logging.getLogger(WebOfTrustUpdater.class);
52 @SuppressWarnings("synthetic-access")
53 private final WebOfTrustUpdateJob stopJob = new WebOfTrustUpdateJob();
55 /** The web of trust connector. */
56 private final WebOfTrustConnector webOfTrustConnector;
58 /** The queue for jobs. */
59 private final BlockingQueue<WebOfTrustUpdateJob> updateJobs = new LinkedBlockingQueue<WebOfTrustUpdateJob>();
62 * Creates a new trust updater.
64 * @param webOfTrustConnector
65 * The web of trust connector
68 public WebOfTrustUpdater(WebOfTrustConnector webOfTrustConnector) {
69 super("Trust Updater");
70 this.webOfTrustConnector = webOfTrustConnector;
78 * Updates the trust relation between the truster and the trustee. This method
79 * will return immediately and perform a trust update in the background.
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} to remove
87 * 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, waiting for completion of
109 * The own identity to add the context to
112 * @return {@code true} if the context was added successfully, {@code false}
115 public boolean addContextWait(OwnIdentity ownIdentity, String context) {
116 AddContextJob addContextJob = new AddContextJob(ownIdentity, context);
117 if (!updateJobs.contains(addContextJob)) {
118 logger.log(Level.FINER, "Adding Context Job: " + addContextJob);
120 updateJobs.put(addContextJob);
121 } catch (InterruptedException ie1) {
122 /* the queue is unbounded so it should never block. */
124 return addContextJob.waitForCompletion();
126 for (WebOfTrustUpdateJob updateJob : updateJobs) {
127 if (updateJob.equals(addContextJob)) {
128 return updateJob.waitForCompletion();
136 * Removes the given context from the given own identity.
139 * The own identity to remove the context from
141 * The context to remove
143 public void removeContext(OwnIdentity ownIdentity, String context) {
144 RemoveContextJob removeContextJob = new RemoveContextJob(ownIdentity, context);
145 if (!updateJobs.contains(removeContextJob)) {
146 logger.log(Level.FINER, "Adding Context Job: " + removeContextJob);
148 updateJobs.put(removeContextJob);
149 } catch (InterruptedException ie1) {
150 /* the queue is unbounded so it should never block. */
156 * Sets a property on the given own identity.
159 * The own identity to set the property on
160 * @param propertyName
161 * The name of the property to set
162 * @param propertyValue
163 * The value of the property to set
165 public void setProperty(OwnIdentity ownIdentity, String propertyName, String propertyValue) {
166 SetPropertyJob setPropertyJob = new SetPropertyJob(ownIdentity, propertyName, propertyValue);
167 if (updateJobs.contains(setPropertyJob)) {
168 updateJobs.remove(setPropertyJob);
170 logger.log(Level.FINER, "Adding Property Job: " + setPropertyJob);
172 updateJobs.put(setPropertyJob);
173 } catch (InterruptedException e) {
174 /* the queue is unbounded so it should never block. */
179 * Removes a property from the given own identity.
182 * The own identity to remove the property from
183 * @param propertyName
184 * The name of the property to remove
186 public void removeProperty(OwnIdentity ownIdentity, String propertyName) {
187 setProperty(ownIdentity, propertyName, null);
196 protected void serviceRun() {
197 while (!shouldStop()) {
199 WebOfTrustUpdateJob updateJob = updateJobs.take();
203 logger.log(Level.FINE, "Running Trust Update Job: " + updateJob);
204 long startTime = System.currentTimeMillis();
206 long endTime = System.currentTimeMillis();
207 logger.log(Level.FINE, "Trust Update Job finished, took " + (endTime - startTime) + " ms.");
208 } catch (InterruptedException ie1) {
209 /* happens, ignore, loop. */
216 protected void serviceStop() {
218 updateJobs.put(stopJob);
219 } catch (InterruptedException ie1) {
220 /* the queue is unbounded so it should never block. */
225 * Base class for WebOfTrust update jobs.
227 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
230 class WebOfTrustUpdateJob implements Runnable {
232 /** Object for synchronization. */
233 @SuppressWarnings("hiding")
234 private final Object syncObject = new Object();
236 /** Whether the job has finished. */
237 private boolean finished;
239 /** Whether the job was successful. */
240 private boolean success;
247 * Performs the actual update operation.
249 * The implementation of this class does nothing.
257 * Waits for completion of this job or stopping of the WebOfTrust updater.
259 * @return {@code true} if this job finished successfully, {@code false}
261 * @see WebOfTrustUpdater#stop()
263 @SuppressWarnings("synthetic-access")
264 public boolean waitForCompletion() {
265 synchronized (syncObject) {
266 while (!finished && !shouldStop()) {
269 } catch (InterruptedException ie1) {
270 /* we’re looping, ignore. */
282 * Signals that this job has finished.
285 * {@code true} if this job finished successfully, {@code false} otherwise
287 protected void finish(boolean success) {
288 synchronized (syncObject) {
290 this.success = success;
291 syncObject.notifyAll();
298 * Update job that sets the trust relation between two identities.
300 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
303 class SetTrustJob extends WebOfTrustUpdateJob {
305 /** The identity giving the trust. */
306 private final OwnIdentity truster;
308 /** The identity receiving the trust. */
309 private final Identity trustee;
311 /** The score of the relation. */
312 private final Integer score;
314 /** The comment of the relation. */
315 private final String comment;
318 * Creates a new set trust job.
321 * The identity giving the trust
323 * The identity receiving the trust
325 * The score of the trust (from -100 to 100, may be {@code null} to remote
326 * the trust relation completely)
328 * The comment of the trust relation
330 public SetTrustJob(OwnIdentity truster, Identity trustee, Integer score, String comment) {
331 this.truster = checkNotNull(truster, "truster must not be null");
332 this.trustee = checkNotNull(trustee, "trustee must not be null");
334 this.comment = comment;
339 @SuppressWarnings("synthetic-access")
343 webOfTrustConnector.setTrust(truster, trustee, score, comment);
344 trustee.setTrust(truster, new Trust(score, null, 0));
346 webOfTrustConnector.removeTrust(truster, trustee);
347 trustee.removeTrust(truster);
350 } catch (WebOfTrustException wote1) {
351 logger.log(Level.WARNING, "Could not set Trust value for " + truster + " -> " + trustee + " to " + score + " (" + comment + ")!", wote1);
362 public boolean equals(Object object) {
363 if ((object == null) || !object.getClass().equals(getClass())) {
366 SetTrustJob updateJob = (SetTrustJob) object;
367 return updateJob.truster.equals(truster) && updateJob.trustee.equals(trustee);
372 public int hashCode() {
373 return getClass().hashCode() ^ truster.hashCode() ^ trustee.hashCode();
378 public String toString() {
379 return String.format("%s[truster=%s,trustee=%s]", getClass().getSimpleName(), truster.getId(), trustee.getId());
385 * Base class for context updates of an {@link OwnIdentity}.
387 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
390 class WebOfTrustContextUpdateJob extends WebOfTrustUpdateJob {
392 /** The own identity whose contexts to manage. */
393 protected final OwnIdentity ownIdentity;
395 /** The context to update. */
396 protected final String context;
399 * Creates a new context update job.
402 * The own identity to update
404 * The context to update
406 @SuppressWarnings("synthetic-access")
407 public WebOfTrustContextUpdateJob(OwnIdentity ownIdentity, String context) {
408 this.ownIdentity = checkNotNull(ownIdentity, "ownIdentity must not be null");
409 this.context = checkNotNull(context, "context must not be null");
418 public boolean equals(Object object) {
419 if ((object == null) || !object.getClass().equals(getClass())) {
422 WebOfTrustContextUpdateJob updateJob = (WebOfTrustContextUpdateJob) object;
423 return updateJob.ownIdentity.equals(ownIdentity) && updateJob.context.equals(context);
428 public int hashCode() {
429 return getClass().hashCode() ^ ownIdentity.hashCode() ^ context.hashCode();
434 public String toString() {
435 return String.format("%s[ownIdentity=%s,context=%s]", getClass().getSimpleName(), ownIdentity, context);
441 * Job that adds a context to an {@link OwnIdentity}.
443 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
446 class AddContextJob extends WebOfTrustContextUpdateJob {
449 * Creates a new add-context job.
452 * The own identity whose contexts to manage
456 public AddContextJob(OwnIdentity ownIdentity, String context) {
457 super(ownIdentity, context);
462 @SuppressWarnings("synthetic-access")
465 webOfTrustConnector.addContext(ownIdentity, context);
466 ownIdentity.addContext(context);
468 } catch (PluginException pe1) {
469 logger.log(Level.WARNING, String.format("Could not add Context “%2$s” to Own Identity %1$s!", ownIdentity, context), pe1);
477 * Job that removes a context from an {@link OwnIdentity}.
479 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
482 class RemoveContextJob extends WebOfTrustContextUpdateJob {
485 * Creates a new remove-context job.
488 * The own identity whose contexts to manage
490 * The context to remove
492 public RemoveContextJob(OwnIdentity ownIdentity, String context) {
493 super(ownIdentity, context);
498 @SuppressWarnings("synthetic-access")
501 webOfTrustConnector.removeContext(ownIdentity, context);
502 ownIdentity.removeContext(context);
504 } catch (PluginException pe1) {
505 logger.log(Level.WARNING, String.format("Could not remove Context “%2$s” to Own Identity %1$s!", ownIdentity, context), pe1);
513 * WebOfTrust update job that sets a property on an {@link OwnIdentity}.
515 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
518 class SetPropertyJob extends WebOfTrustUpdateJob {
520 /** The own identity to update properties on. */
521 private final OwnIdentity ownIdentity;
523 /** The name of the property to update. */
524 private final String propertyName;
526 /** The value of the property to set. */
527 private final String propertyValue;
530 * Creates a new set-property job.
533 * The own identity to set the property on
534 * @param propertyName
535 * The name of the property to set
536 * @param propertyValue
537 * The value of the property to set
539 public SetPropertyJob(OwnIdentity ownIdentity, String propertyName, String propertyValue) {
540 this.ownIdentity = ownIdentity;
541 this.propertyName = propertyName;
542 this.propertyValue = propertyValue;
547 @SuppressWarnings("synthetic-access")
550 if (propertyValue == null) {
551 webOfTrustConnector.removeProperty(ownIdentity, propertyName);
552 ownIdentity.removeProperty(propertyName);
554 webOfTrustConnector.setProperty(ownIdentity, propertyName, propertyValue);
555 ownIdentity.setProperty(propertyName, propertyValue);
558 } catch (PluginException pe1) {
559 logger.log(Level.WARNING, String.format("Could not set Property “%2$s” to “%3$s” on Own Identity %1$s!", ownIdentity, propertyName, propertyValue), pe1);
570 public boolean equals(Object object) {
571 if ((object == null) || !object.getClass().equals(getClass())) {
574 SetPropertyJob updateJob = (SetPropertyJob) object;
575 return updateJob.ownIdentity.equals(ownIdentity) && updateJob.propertyName.equals(propertyName);
580 public int hashCode() {
581 return getClass().hashCode() ^ ownIdentity.hashCode() ^ propertyName.hashCode();
586 public String toString() {
587 return String.format("%s[ownIdentity=%s,propertyName=%s]", getClass().getSimpleName(), ownIdentity, propertyName);