2 * Sone - WebOfTrustUpdaterImpl.java - Copyright © 2013–2019 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;
21 import static java.util.logging.Logger.getLogger;
23 import java.util.concurrent.BlockingQueue;
24 import java.util.concurrent.LinkedBlockingQueue;
25 import java.util.logging.Level;
26 import java.util.logging.Logger;
28 import net.pterodactylus.sone.freenet.plugin.PluginException;
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.service.AbstractService;
36 import com.google.common.annotations.VisibleForTesting;
37 import com.google.inject.Inject;
38 import com.google.inject.Singleton;
41 * Updates WebOfTrust identity data in a background thread because communicating
42 * with the WebOfTrust plugin can potentially last quite long.
45 public class WebOfTrustUpdaterImpl extends AbstractService implements WebOfTrustUpdater {
48 private static final Logger logger = getLogger(WebOfTrustUpdaterImpl.class.getName());
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<>();
61 * Creates a new trust updater.
63 * @param webOfTrustConnector
64 * The web of trust connector
67 public WebOfTrustUpdaterImpl(WebOfTrustConnector webOfTrustConnector) {
68 super("Trust Updater");
69 this.webOfTrustConnector = webOfTrustConnector;
77 * Updates the trust relation between the truster and the trustee. This method
78 * will return immediately and perform a trust update in the background.
81 * The identity giving the trust
83 * The identity receiving the trust
85 * The new level of trust (from -100 to 100, may be {@code null} to remove
86 * the trust completely)
88 * 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}
116 public boolean addContextWait(OwnIdentity ownIdentity, String context) {
117 AddContextJob addContextJob = new AddContextJob(ownIdentity, context);
118 if (!updateJobs.contains(addContextJob)) {
119 logger.log(Level.FINER, "Adding Context Job: " + addContextJob);
121 updateJobs.put(addContextJob);
122 } catch (InterruptedException ie1) {
123 /* the queue is unbounded so it should never block. */
125 return addContextJob.waitForCompletion();
127 for (WebOfTrustUpdateJob updateJob : updateJobs) {
128 if (updateJob.equals(addContextJob)) {
129 return updateJob.waitForCompletion();
137 * Removes the given context from the given own identity.
140 * The own identity to remove the context from
142 * The context to remove
145 public void removeContext(OwnIdentity ownIdentity, String context) {
146 RemoveContextJob removeContextJob = new RemoveContextJob(ownIdentity, context);
147 if (!updateJobs.contains(removeContextJob)) {
148 logger.log(Level.FINER, "Adding Context Job: " + removeContextJob);
150 updateJobs.put(removeContextJob);
151 } catch (InterruptedException ie1) {
152 /* the queue is unbounded so it should never block. */
158 * Sets a property on the given own identity.
161 * The own identity to set the property on
162 * @param propertyName
163 * The name of the property to set
164 * @param propertyValue
165 * The value of the property to set
168 public void setProperty(OwnIdentity ownIdentity, String propertyName, String propertyValue) {
169 SetPropertyJob setPropertyJob = new SetPropertyJob(ownIdentity, propertyName, propertyValue);
170 if (updateJobs.contains(setPropertyJob)) {
171 updateJobs.remove(setPropertyJob);
173 logger.log(Level.FINER, "Adding Property Job: " + setPropertyJob);
175 updateJobs.put(setPropertyJob);
176 } catch (InterruptedException e) {
177 /* the queue is unbounded so it should never block. */
182 * Removes a property from the given own identity.
185 * The own identity to remove the property from
186 * @param propertyName
187 * The name of the property to remove
190 public void removeProperty(OwnIdentity ownIdentity, String propertyName) {
191 setProperty(ownIdentity, propertyName, null);
200 protected void serviceRun() {
201 while (!shouldStop()) {
203 WebOfTrustUpdateJob updateJob = updateJobs.take();
207 logger.log(Level.FINE, "Running Trust Update Job: " + updateJob);
208 long startTime = System.currentTimeMillis();
210 long endTime = System.currentTimeMillis();
211 logger.log(Level.FINE, "Trust Update Job finished, took " + (endTime - startTime) + " ms.");
212 } catch (InterruptedException ie1) {
213 /* happens, ignore, loop. */
220 protected void serviceStop() {
222 updateJobs.put(stopJob);
223 } catch (InterruptedException ie1) {
224 /* the queue is unbounded so it should never block. */
229 * Base class for WebOfTrust update jobs.
232 class WebOfTrustUpdateJob implements Runnable {
234 /** Object for synchronization. */
235 @SuppressWarnings("hiding")
236 private final Object syncObject = new Object();
238 /** Whether the job has finished. */
239 private boolean finished;
241 /** Whether the job was successful. */
242 private boolean success;
249 * Performs the actual update operation.
251 * The implementation of this class does nothing.
259 * Waits for completion of this job or stopping of the WebOfTrust updater.
261 * @return {@code true} if this job finished successfully, {@code false}
263 * @see WebOfTrustUpdaterImpl#stop()
265 @SuppressWarnings("synthetic-access")
266 public boolean waitForCompletion() {
267 synchronized (syncObject) {
268 while (!finished && !shouldStop()) {
271 } catch (InterruptedException ie1) {
272 /* we’re looping, ignore. */
284 * Signals that this job has finished.
287 * {@code true} if this job finished successfully, {@code false} otherwise
289 protected void finish(boolean success) {
290 synchronized (syncObject) {
292 this.success = success;
293 syncObject.notifyAll();
300 * Update job that sets the trust relation between two identities.
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}.
388 class WebOfTrustContextUpdateJob extends WebOfTrustUpdateJob {
390 /** The own identity whose contexts to manage. */
391 protected final OwnIdentity ownIdentity;
393 /** The context to update. */
394 protected final String context;
397 * Creates a new context update job.
400 * The own identity to update
402 * The context to update
404 @SuppressWarnings("synthetic-access")
405 public WebOfTrustContextUpdateJob(OwnIdentity ownIdentity, String context) {
406 this.ownIdentity = checkNotNull(ownIdentity, "ownIdentity must not be null");
407 this.context = checkNotNull(context, "context must not be null");
416 public boolean equals(Object object) {
417 if ((object == null) || !object.getClass().equals(getClass())) {
420 WebOfTrustContextUpdateJob updateJob = (WebOfTrustContextUpdateJob) object;
421 return updateJob.ownIdentity.equals(ownIdentity) && updateJob.context.equals(context);
426 public int hashCode() {
427 return getClass().hashCode() ^ ownIdentity.hashCode() ^ context.hashCode();
432 public String toString() {
433 return String.format("%s[ownIdentity=%s,context=%s]", getClass().getSimpleName(), ownIdentity, context);
439 * Job that adds a context to an {@link OwnIdentity}.
442 class AddContextJob extends WebOfTrustContextUpdateJob {
445 * Creates a new add-context job.
448 * The own identity whose contexts to manage
452 public AddContextJob(OwnIdentity ownIdentity, String context) {
453 super(ownIdentity, context);
458 @SuppressWarnings("synthetic-access")
461 webOfTrustConnector.addContext(ownIdentity, context);
462 ownIdentity.addContext(context);
464 } catch (PluginException pe1) {
465 logger.log(Level.WARNING, String.format("Could not add Context “%2$s” to Own Identity %1$s!", ownIdentity, context), pe1);
473 * Job that removes a context from an {@link OwnIdentity}.
476 class RemoveContextJob extends WebOfTrustContextUpdateJob {
479 * Creates a new remove-context job.
482 * The own identity whose contexts to manage
484 * The context to remove
486 public RemoveContextJob(OwnIdentity ownIdentity, String context) {
487 super(ownIdentity, context);
492 @SuppressWarnings("synthetic-access")
495 webOfTrustConnector.removeContext(ownIdentity, context);
496 ownIdentity.removeContext(context);
498 } catch (PluginException pe1) {
499 logger.log(Level.WARNING, String.format("Could not remove Context “%2$s” to Own Identity %1$s!", ownIdentity, context), pe1);
507 * WebOfTrust update job that sets a property on an {@link OwnIdentity}.
510 class SetPropertyJob extends WebOfTrustUpdateJob {
512 /** The own identity to update properties on. */
513 private final OwnIdentity ownIdentity;
515 /** The name of the property to update. */
516 private final String propertyName;
518 /** The value of the property to set. */
519 private final String propertyValue;
522 * Creates a new set-property job.
525 * The own identity to set the property on
526 * @param propertyName
527 * The name of the property to set
528 * @param propertyValue
529 * The value of the property to set
531 public SetPropertyJob(OwnIdentity ownIdentity, String propertyName, String propertyValue) {
532 this.ownIdentity = ownIdentity;
533 this.propertyName = propertyName;
534 this.propertyValue = propertyValue;
539 @SuppressWarnings("synthetic-access")
542 if (propertyValue == null) {
543 webOfTrustConnector.removeProperty(ownIdentity, propertyName);
544 ownIdentity.removeProperty(propertyName);
546 webOfTrustConnector.setProperty(ownIdentity, propertyName, propertyValue);
547 ownIdentity.setProperty(propertyName, propertyValue);
550 } catch (PluginException pe1) {
551 logger.log(Level.WARNING, String.format("Could not set Property “%2$s” to “%3$s” on Own Identity %1$s!", ownIdentity, propertyName, propertyValue), pe1);
562 public boolean equals(Object object) {
563 if ((object == null) || !object.getClass().equals(getClass())) {
566 SetPropertyJob updateJob = (SetPropertyJob) object;
567 return updateJob.ownIdentity.equals(ownIdentity) && updateJob.propertyName.equals(propertyName);
572 public int hashCode() {
573 return getClass().hashCode() ^ ownIdentity.hashCode() ^ propertyName.hashCode();
578 public String toString() {
579 return String.format("%s[ownIdentity=%s,propertyName=%s]", getClass().getSimpleName(), ownIdentity, propertyName);