2 * Sone - IdentityManager.java - Copyright © 2010 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.wotns.freenet.wot;
20 import java.util.Collection;
21 import java.util.Collections;
22 import java.util.HashMap;
23 import java.util.HashSet;
26 import java.util.Map.Entry;
27 import java.util.logging.Level;
28 import java.util.logging.Logger;
30 import net.pterodactylus.util.logging.Logging;
31 import net.pterodactylus.util.service.AbstractService;
32 import net.pterodactylus.wotns.freenet.plugin.PluginException;
35 * The identity manager takes care of loading and storing identities, their
36 * contexts, and properties. It does so in a way that does not expose errors via
37 * exceptions but it only logs them and tries to return sensible defaults.
39 * It is also responsible for polling identities from the Web of Trust plugin
40 * and notifying registered {@link IdentityListener}s when {@link Identity}s and
41 * {@link OwnIdentity}s are discovered or disappearing.
43 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
45 public class IdentityManager extends AbstractService {
47 /** Object used for synchronization. */
48 private final Object syncObject = new Object() {
49 /* inner class for better lock names. */
53 private static final Logger logger = Logging.getLogger(IdentityManager.class);
55 /** The event manager. */
56 private final IdentityListenerManager identityListenerManager = new IdentityListenerManager();
58 /** The Web of Trust connector. */
59 private final WebOfTrustConnector webOfTrustConnector;
61 /** The context to filter for. */
62 private volatile String context;
64 /** The currently known own identities. */
65 /* synchronize access on syncObject. */
66 private Map<String, OwnIdentity> currentOwnIdentities = new HashMap<String, OwnIdentity>();
68 /** The currently trusted identities. */
69 private Map<OwnIdentity, Collection<Identity>> currentTrustedIdentities = new HashMap<OwnIdentity, Collection<Identity>>();
72 * Creates a new identity manager.
74 * @param webOfTrustConnector
75 * The Web of Trust connector
77 public IdentityManager(WebOfTrustConnector webOfTrustConnector) {
78 super("Sone Identity Manager", false);
79 this.webOfTrustConnector = webOfTrustConnector;
83 // LISTENER MANAGEMENT
87 * Adds a listener for identity events.
89 * @param identityListener
92 public void addIdentityListener(IdentityListener identityListener) {
93 identityListenerManager.addListener(identityListener);
97 * Removes a listener for identity events.
99 * @param identityListener
100 * The listener to remove
102 public void removeIdentityListener(IdentityListener identityListener) {
103 identityListenerManager.removeListener(identityListener);
111 * Sets the context to filter own identities and trusted identities for.
114 * The context to filter for, or {@code null} to not filter
116 public void setContext(String context) {
117 this.context = context;
121 * Returns whether the Web of Trust plugin could be reached during the last
124 * @return {@code true} if the Web of Trust plugin is connected, {@code
127 public boolean isConnected() {
129 webOfTrustConnector.ping();
131 } catch (PluginException pe1) {
132 /* not connected, ignore. */
138 * Returns the own identity with the given ID.
141 * The ID of the own identity
142 * @return The own identity, or {@code null} if there is no such identity
144 public OwnIdentity getOwnIdentity(String id) {
145 Set<OwnIdentity> allOwnIdentities = getAllOwnIdentities();
146 for (OwnIdentity ownIdentity : allOwnIdentities) {
147 if (ownIdentity.getId().equals(id)) {
155 * Returns all own identities.
157 * @return All own identities
159 public Set<OwnIdentity> getAllOwnIdentities() {
161 Set<OwnIdentity> ownIdentities = webOfTrustConnector.loadAllOwnIdentities();
162 Map<String, OwnIdentity> newOwnIdentities = new HashMap<String, OwnIdentity>();
163 for (OwnIdentity ownIdentity : ownIdentities) {
164 newOwnIdentities.put(ownIdentity.getId(), ownIdentity);
166 checkOwnIdentities(newOwnIdentities);
167 return ownIdentities;
168 } catch (WebOfTrustException wote1) {
169 logger.log(Level.WARNING, "Could not load all own identities!", wote1);
170 return Collections.emptySet();
175 * Returns all identities that are trusted by the given own identity. In
176 * addition to all non-own identities the given own identity is also
180 * The own identity to get the trusted identities for
181 * @return The identities trusted by the given own identity
183 public Set<Identity> getTrustedIdentities(OwnIdentity ownIdentity) {
184 Set<Identity> identities = new HashSet<Identity>();
185 for (OwnIdentity additionalOwnIdentity : getAllOwnIdentities()) {
186 if ((context == null) || additionalOwnIdentity.getContexts().contains(context)) {
187 identities.add(additionalOwnIdentity);
191 Set<Identity> trustedIdentities = webOfTrustConnector.loadTrustedIdentities(ownIdentity, context);
192 Map<String, Identity> newTrustedIdentities = new HashMap<String, Identity>();
193 for (Identity trustedIdentity : trustedIdentities) {
194 newTrustedIdentities.put(trustedIdentity.getId(), trustedIdentity);
196 checkTrustedIdentities(ownIdentity, newTrustedIdentities);
197 identities.addAll(trustedIdentities);
198 } catch (WebOfTrustException wote1) {
199 logger.log(Level.WARNING, String.format("Could not load all trusted identities for %s.", ownIdentity), wote1);
212 protected void serviceRun() {
213 while (!shouldStop()) {
214 Map<OwnIdentity, Map<String, Identity>> currentIdentities = new HashMap<OwnIdentity, Map<String, Identity>>();
215 Map<String, OwnIdentity> currentOwnIdentities = new HashMap<String, OwnIdentity>();
217 Set<OwnIdentity> ownIdentities = null;
218 boolean identitiesLoaded = false;
220 /* get all identities with the wanted context from WoT. */
221 ownIdentities = webOfTrustConnector.loadAllOwnIdentities();
223 /* load trusted identities. */
224 for (OwnIdentity ownIdentity : ownIdentities) {
225 if ((context != null) && !ownIdentity.hasContext(context)) {
228 currentOwnIdentities.put(ownIdentity.getId(), ownIdentity);
230 Set<Identity> trustedIdentities = webOfTrustConnector.loadTrustedIdentities(ownIdentity, context);
231 Map<String, Identity> identities = new HashMap<String, Identity>();
232 currentIdentities.put(ownIdentity, identities);
233 for (Identity identity : trustedIdentities) {
234 identities.put(identity.getId(), identity);
238 * add own identities, too, as long as the WoT doesn’t do
241 for (OwnIdentity additionalOwnIdentity : ownIdentities) {
242 if (additionalOwnIdentity == ownIdentity) {
245 if ((context != null) && !additionalOwnIdentity.hasContext(context)) {
248 identities.put(additionalOwnIdentity.getId(), additionalOwnIdentity);
251 identitiesLoaded = true;
252 } catch (WebOfTrustException wote1) {
253 logger.log(Level.WARNING, "WoT has disappeared!", wote1);
256 if (identitiesLoaded) {
258 /* check for changes. */
259 checkOwnIdentities(currentOwnIdentities);
261 /* now check for changes in remote identities. */
262 for (OwnIdentity ownIdentity : currentOwnIdentities.values()) {
263 checkTrustedIdentities(ownIdentity, currentIdentities.get(ownIdentity));
267 /* wait a minute before checking again. */
277 * Checks the given new list of own identities for added or removed own
278 * identities, as compared to {@link #currentOwnIdentities}.
280 * @param newOwnIdentities
281 * The new own identities
283 private void checkOwnIdentities(Map<String, OwnIdentity> newOwnIdentities) {
284 synchronized (syncObject) {
286 /* find removed own identities: */
287 for (OwnIdentity oldOwnIdentity : currentOwnIdentities.values()) {
288 if (!newOwnIdentities.containsKey(oldOwnIdentity.getId())) {
289 identityListenerManager.fireOwnIdentityRemoved(oldOwnIdentity);
290 currentTrustedIdentities.remove(oldOwnIdentity);
294 /* find added own identities. */
295 for (OwnIdentity currentOwnIdentity : newOwnIdentities.values()) {
296 if (!currentOwnIdentities.containsKey(currentOwnIdentity.getId())) {
297 identityListenerManager.fireOwnIdentityAdded(currentOwnIdentity);
301 currentOwnIdentities.clear();
302 currentOwnIdentities.putAll(newOwnIdentities);
307 * Checks the given identities for changes since the last check.
310 * The own identity trusting the given identities
311 * @param trustedIdentities
312 * The trusted identities
314 private void checkTrustedIdentities(OwnIdentity ownIdentity, Map<String, Identity> trustedIdentities) {
316 Map<String, Identity> currentTrustedIdentities = new HashMap<String, Identity>();
317 synchronized (syncObject) {
318 if (this.currentTrustedIdentities.containsKey(ownIdentity)) {
319 for (Identity identity : this.currentTrustedIdentities.get(ownIdentity)) {
320 currentTrustedIdentities.put(identity.getId(), identity);
325 /* find new identities. */
326 for (Identity currentIdentity : trustedIdentities.values()) {
327 if (!currentTrustedIdentities.containsKey(currentIdentity.getId())) {
328 identityListenerManager.fireIdentityAdded(ownIdentity, currentIdentity);
332 /* find removed identities. */
333 for (Identity oldIdentity : currentTrustedIdentities.values()) {
334 if (!trustedIdentities.containsKey(oldIdentity.getId())) {
335 identityListenerManager.fireIdentityRemoved(ownIdentity, oldIdentity);
339 /* check for changes in the contexts. */
340 for (Identity oldIdentity : currentTrustedIdentities.values()) {
341 if (!trustedIdentities.containsKey(oldIdentity.getId())) {
344 Identity newIdentity = trustedIdentities.get(oldIdentity.getId());
345 Set<String> oldContexts = oldIdentity.getContexts();
346 Set<String> newContexts = newIdentity.getContexts();
347 if (oldContexts.size() != newContexts.size()) {
348 identityListenerManager.fireIdentityUpdated(ownIdentity, newIdentity);
351 boolean changed = false;
352 for (String oldContext : oldContexts) {
353 if (!newContexts.contains(oldContext)) {
354 identityListenerManager.fireIdentityUpdated(ownIdentity, newIdentity);
362 Map<String, String> oldProperties = oldIdentity.getProperties();
363 Map<String, String> newProperties = newIdentity.getProperties();
364 if (oldProperties.size() != newProperties.size()) {
365 identityListenerManager.fireIdentityUpdated(ownIdentity, newIdentity);
368 for (Entry<String, String> oldProperty : oldProperties.entrySet()) {
369 if (!newProperties.containsKey(oldProperty.getKey()) || !newProperties.get(oldProperty.getKey()).equals(oldProperty.getValue())) {
370 identityListenerManager.fireIdentityUpdated(ownIdentity, newIdentity);
376 synchronized (syncObject) {
377 this.currentTrustedIdentities.put(ownIdentity, trustedIdentities.values());