🔀 Merge branch “release-80”
[Sone.git] / src / main / java / net / pterodactylus / sone / freenet / wot / IdentityManager.java
index 89e4297..c0f6f1b 100644 (file)
-/*
- * Sone - IdentityManager.java - Copyright © 2010–2012 David Roden
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
 package net.pterodactylus.sone.freenet.wot;
 
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Map.Entry;
 import java.util.Set;
-import java.util.logging.Level;
-import java.util.logging.Logger;
 
-import net.pterodactylus.sone.freenet.plugin.PluginException;
-import net.pterodactylus.util.collection.Mapper;
-import net.pterodactylus.util.collection.Mappers;
-import net.pterodactylus.util.logging.Logging;
-import net.pterodactylus.util.service.AbstractService;
+import net.pterodactylus.util.service.Service;
+
+import com.google.common.eventbus.EventBus;
+import com.google.inject.ImplementedBy;
 
 /**
- * The identity manager takes care of loading and storing identities, their
- * contexts, and properties. It does so in a way that does not expose errors via
- * exceptions but it only logs them and tries to return sensible defaults.
- * <p>
- * It is also responsible for polling identities from the Web of Trust plugin
- * and notifying registered {@link IdentityListener}s when {@link Identity}s and
- * {@link OwnIdentity}s are discovered or disappearing.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ * Connects to a {@link WebOfTrustConnector} and sends identity events to an
+ * {@link EventBus}.
  */
-public class IdentityManager extends AbstractService {
-
-       /** Object used for synchronization. */
-       @SuppressWarnings("hiding")
-       private final Object syncObject = new Object() {
-               /* inner class for better lock names. */
-       };
-
-       /** The logger. */
-       private static final Logger logger = Logging.getLogger(IdentityManager.class);
-
-       /** The event manager. */
-       private final IdentityListenerManager identityListenerManager = new IdentityListenerManager();
-
-       /** The Web of Trust connector. */
-       private final WebOfTrustConnector webOfTrustConnector;
-
-       /** The context to filter for. */
-       private volatile String context;
-
-       /** The currently known own identities. */
-       /* synchronize access on syncObject. */
-       private Map<String, OwnIdentity> currentOwnIdentities = new HashMap<String, OwnIdentity>();
-
-       /**
-        * Creates a new identity manager.
-        *
-        * @param webOfTrustConnector
-        *            The Web of Trust connector
-        */
-       public IdentityManager(WebOfTrustConnector webOfTrustConnector) {
-               super("Sone Identity Manager", false);
-               this.webOfTrustConnector = webOfTrustConnector;
-       }
-
-       //
-       // LISTENER MANAGEMENT
-       //
-
-       /**
-        * Adds a listener for identity events.
-        *
-        * @param identityListener
-        *            The listener to add
-        */
-       public void addIdentityListener(IdentityListener identityListener) {
-               identityListenerManager.addListener(identityListener);
-       }
-
-       /**
-        * Removes a listener for identity events.
-        *
-        * @param identityListener
-        *            The listener to remove
-        */
-       public void removeIdentityListener(IdentityListener identityListener) {
-               identityListenerManager.removeListener(identityListener);
-       }
-
-       //
-       // ACCESSORS
-       //
-
-       /**
-        * Sets the context to filter own identities and trusted identities for.
-        *
-        * @param context
-        *            The context to filter for, or {@code null} to not filter
-        */
-       public void setContext(String context) {
-               this.context = context;
-       }
-
-       /**
-        * Returns whether the Web of Trust plugin could be reached during the last
-        * try.
-        *
-        * @return {@code true} if the Web of Trust plugin is connected,
-        *         {@code false} otherwise
-        */
-       public boolean isConnected() {
-               try {
-                       webOfTrustConnector.ping();
-                       return true;
-               } catch (PluginException pe1) {
-                       /* not connected, ignore. */
-                       return false;
-               }
-       }
-
-       /**
-        * Returns the own identity with the given ID.
-        *
-        * @param id
-        *            The ID of the own identity
-        * @return The own identity, or {@code null} if there is no such identity
-        */
-       public OwnIdentity getOwnIdentity(String id) {
-               Set<OwnIdentity> allOwnIdentities = getAllOwnIdentities();
-               for (OwnIdentity ownIdentity : allOwnIdentities) {
-                       if (ownIdentity.getId().equals(id)) {
-                               return new DefaultOwnIdentity(webOfTrustConnector, ownIdentity);
-                       }
-               }
-               return null;
-       }
-
-       /**
-        * Returns all own identities.
-        *
-        * @return All own identities
-        */
-       public Set<OwnIdentity> getAllOwnIdentities() {
-               try {
-                       Set<OwnIdentity> ownIdentities = webOfTrustConnector.loadAllOwnIdentities();
-                       Map<String, OwnIdentity> newOwnIdentities = new HashMap<String, OwnIdentity>();
-                       for (OwnIdentity ownIdentity : ownIdentities) {
-                               newOwnIdentities.put(ownIdentity.getId(), ownIdentity);
-                       }
-                       checkOwnIdentities(newOwnIdentities);
-                       return Mappers.mappedSet(ownIdentities, new Mapper<OwnIdentity, OwnIdentity>() {
-
-                               /**
-                                * {@inheritDoc}
-                                */
-                               @Override
-                               @SuppressWarnings("synthetic-access")
-                               public OwnIdentity map(OwnIdentity input) {
-                                       return new DefaultOwnIdentity(webOfTrustConnector, input);
-                               }
-                       });
-               } catch (WebOfTrustException wote1) {
-                       logger.log(Level.WARNING, "Could not load all own identities!", wote1);
-                       return Collections.emptySet();
-               }
-       }
-
-       //
-       // SERVICE METHODS
-       //
-
-       /**
-        * {@inheritDoc}
-        */
-       @Override
-       protected void serviceRun() {
-               Map<OwnIdentity, Map<String, Identity>> oldIdentities = Collections.emptyMap();
-               while (!shouldStop()) {
-                       Map<OwnIdentity, Map<String, Identity>> currentIdentities = new HashMap<OwnIdentity, Map<String, Identity>>();
-                       Map<String, OwnIdentity> currentOwnIdentities = new HashMap<String, OwnIdentity>();
-
-                       Set<OwnIdentity> ownIdentities = null;
-                       boolean identitiesLoaded = false;
-                       try {
-                               /* get all identities with the wanted context from WoT. */
-                               ownIdentities = webOfTrustConnector.loadAllOwnIdentities();
-
-                               /* load trusted identities. */
-                               for (OwnIdentity ownIdentity : ownIdentities) {
-                                       if ((context != null) && !ownIdentity.hasContext(context)) {
-                                               continue;
-                                       }
-                                       currentOwnIdentities.put(ownIdentity.getId(), ownIdentity);
-
-                                       Set<Identity> trustedIdentities = webOfTrustConnector.loadTrustedIdentities(ownIdentity, context);
-                                       Map<String, Identity> identities = new HashMap<String, Identity>();
-                                       currentIdentities.put(ownIdentity, identities);
-                                       for (Identity identity : trustedIdentities) {
-                                               identities.put(identity.getId(), identity);
-                                       }
-                               }
-                               identitiesLoaded = true;
-                       } catch (WebOfTrustException wote1) {
-                               logger.log(Level.WARNING, "WoT has disappeared!", wote1);
-                       }
-
-                       if (identitiesLoaded) {
-
-                               /* check for changes. */
-                               checkOwnIdentities(currentOwnIdentities);
-
-                               /* now check for changes in remote identities. */
-                               for (OwnIdentity ownIdentity : currentOwnIdentities.values()) {
-
-                                       /* find new identities. */
-                                       for (Identity currentIdentity : currentIdentities.get(ownIdentity).values()) {
-                                               if (!oldIdentities.containsKey(ownIdentity) || !oldIdentities.get(ownIdentity).containsKey(currentIdentity.getId())) {
-                                                       identityListenerManager.fireIdentityAdded(ownIdentity, currentIdentity);
-                                               }
-                                       }
-
-                                       /* find removed identities. */
-                                       if (oldIdentities.containsKey(ownIdentity)) {
-                                               for (Identity oldIdentity : oldIdentities.get(ownIdentity).values()) {
-                                                       if (!currentIdentities.get(ownIdentity).containsKey(oldIdentity.getId())) {
-                                                               identityListenerManager.fireIdentityRemoved(ownIdentity, oldIdentity);
-                                                       }
-                                               }
-
-                                               /* check for changes in the contexts. */
-                                               for (Identity oldIdentity : oldIdentities.get(ownIdentity).values()) {
-                                                       if (!currentIdentities.get(ownIdentity).containsKey(oldIdentity.getId())) {
-                                                               continue;
-                                                       }
-                                                       Identity newIdentity = currentIdentities.get(ownIdentity).get(oldIdentity.getId());
-                                                       Set<String> oldContexts = oldIdentity.getContexts();
-                                                       Set<String> newContexts = newIdentity.getContexts();
-                                                       if (oldContexts.size() != newContexts.size()) {
-                                                               identityListenerManager.fireIdentityUpdated(ownIdentity, newIdentity);
-                                                               continue;
-                                                       }
-                                                       for (String oldContext : oldContexts) {
-                                                               if (!newContexts.contains(oldContext)) {
-                                                                       identityListenerManager.fireIdentityUpdated(ownIdentity, newIdentity);
-                                                                       break;
-                                                               }
-                                                       }
-                                               }
-
-                                               /* check for changes in the properties. */
-                                               for (Identity oldIdentity : oldIdentities.get(ownIdentity).values()) {
-                                                       if (!currentIdentities.get(ownIdentity).containsKey(oldIdentity.getId())) {
-                                                               continue;
-                                                       }
-                                                       Identity newIdentity = currentIdentities.get(ownIdentity).get(oldIdentity.getId());
-                                                       Map<String, String> oldProperties = oldIdentity.getProperties();
-                                                       Map<String, String> newProperties = newIdentity.getProperties();
-                                                       if (oldProperties.size() != newProperties.size()) {
-                                                               identityListenerManager.fireIdentityUpdated(ownIdentity, newIdentity);
-                                                               continue;
-                                                       }
-                                                       for (Entry<String, String> oldProperty : oldProperties.entrySet()) {
-                                                               if (!newProperties.containsKey(oldProperty.getKey()) || !newProperties.get(oldProperty.getKey()).equals(oldProperty.getValue())) {
-                                                                       identityListenerManager.fireIdentityUpdated(ownIdentity, newIdentity);
-                                                                       break;
-                                                               }
-                                                       }
-                                               }
-                                       }
-                               }
-
-                               /* remember the current set of identities. */
-                               oldIdentities = currentIdentities;
-                       }
-
-                       /* wait a minute before checking again. */
-                       sleep(60 * 1000);
-               }
-       }
-
-       //
-       // PRIVATE METHODS
-       //
-
-       /**
-        * Checks the given new list of own identities for added or removed own
-        * identities, as compared to {@link #currentOwnIdentities}.
-        *
-        * @param newOwnIdentities
-        *            The new own identities
-        */
-       private void checkOwnIdentities(Map<String, OwnIdentity> newOwnIdentities) {
-               synchronized (syncObject) {
-
-                       /* find removed own identities: */
-                       for (OwnIdentity oldOwnIdentity : currentOwnIdentities.values()) {
-                               OwnIdentity newOwnIdentity = newOwnIdentities.get(oldOwnIdentity.getId());
-                               if ((newOwnIdentity == null) || ((context != null) && oldOwnIdentity.hasContext(context) && !newOwnIdentity.hasContext(context))) {
-                                       identityListenerManager.fireOwnIdentityRemoved(new DefaultOwnIdentity(webOfTrustConnector, oldOwnIdentity));
-                               }
-                       }
-
-                       /* find added own identities. */
-                       for (OwnIdentity currentOwnIdentity : newOwnIdentities.values()) {
-                               OwnIdentity oldOwnIdentity = currentOwnIdentities.get(currentOwnIdentity.getId());
-                               if (((oldOwnIdentity == null) && ((context == null) || currentOwnIdentity.hasContext(context))) || ((oldOwnIdentity != null) && (context != null) && (!oldOwnIdentity.hasContext(context) && currentOwnIdentity.hasContext(context)))) {
-                                       identityListenerManager.fireOwnIdentityAdded(new DefaultOwnIdentity(webOfTrustConnector, currentOwnIdentity));
-                               }
-                       }
+@ImplementedBy(IdentityManagerImpl.class)
+public interface IdentityManager extends Service {
 
-                       currentOwnIdentities.clear();
-                       currentOwnIdentities.putAll(newOwnIdentities);
-               }
-       }
+       boolean isConnected();
+       Set<OwnIdentity> getAllOwnIdentities();
 
 }