Move dependency injection configuration closer to where it’s useful.
[Sone.git] / src / main / java / net / pterodactylus / sone / core / FreenetInterface.java
index f7fa975..d4640f8 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * FreenetSone - FreenetInterface.java - Copyright © 2010 David Roden
+ * Sone - FreenetInterface.java - Copyright © 2010–2013 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
 package net.pterodactylus.sone.core;
 
 import java.net.MalformedURLException;
-import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
+import java.util.concurrent.TimeUnit;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import net.pterodactylus.sone.core.SoneException.Type;
+import net.pterodactylus.sone.core.event.ImageInsertAbortedEvent;
+import net.pterodactylus.sone.core.event.ImageInsertFailedEvent;
+import net.pterodactylus.sone.core.event.ImageInsertFinishedEvent;
+import net.pterodactylus.sone.core.event.ImageInsertStartedEvent;
 import net.pterodactylus.sone.data.Image;
 import net.pterodactylus.sone.data.Sone;
 import net.pterodactylus.sone.data.TemporaryImage;
-import net.pterodactylus.util.collection.Pair;
 import net.pterodactylus.util.logging.Logging;
 
 import com.db4o.ObjectContainer;
 
+import com.google.common.base.Function;
+import com.google.common.eventbus.EventBus;
+import com.google.inject.Inject;
+import com.google.inject.Singleton;
+
 import freenet.client.ClientMetadata;
 import freenet.client.FetchException;
 import freenet.client.FetchResult;
 import freenet.client.HighLevelSimpleClient;
-import freenet.client.HighLevelSimpleClientImpl;
 import freenet.client.InsertBlock;
 import freenet.client.InsertContext;
 import freenet.client.InsertException;
@@ -52,6 +57,7 @@ import freenet.keys.FreenetURI;
 import freenet.keys.InsertableClientSSK;
 import freenet.keys.USK;
 import freenet.node.Node;
+import freenet.node.RequestClient;
 import freenet.node.RequestStarter;
 import freenet.support.api.Bucket;
 import freenet.support.io.ArrayBucket;
@@ -61,11 +67,15 @@ import freenet.support.io.ArrayBucket;
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
+@Singleton
 public class FreenetInterface {
 
        /** The logger. */
        private static final Logger logger = Logging.getLogger(FreenetInterface.class);
 
+       /** The event bus. */
+       private final EventBus eventBus;
+
        /** The node to interact with. */
        private final Node node;
 
@@ -81,10 +91,14 @@ public class FreenetInterface {
        /**
         * Creates a new Freenet interface.
         *
+        * @param eventBus
+        *            The event bus
         * @param node
         *            The node to interact with
         */
-       public FreenetInterface(Node node) {
+       @Inject
+       public FreenetInterface(EventBus eventBus, Node node) {
+               this.eventBus = eventBus;
                this.node = node;
                this.client = node.clientCore.makeClient(RequestStarter.INTERACTIVE_PRIORITY_CLASS, false, true);
        }
@@ -100,35 +114,24 @@ public class FreenetInterface {
         *            The URI to fetch
         * @return The result of the fetch, or {@code null} if an error occured
         */
-       public Pair<FreenetURI, FetchResult> fetchUri(FreenetURI uri) {
-               FetchResult fetchResult = null;
+       public Fetched fetchUri(FreenetURI uri) {
                FreenetURI currentUri = new FreenetURI(uri);
                while (true) {
                        try {
-                               fetchResult = client.fetch(currentUri);
-                               return new Pair<FreenetURI, FetchResult>(currentUri, fetchResult);
+                               FetchResult fetchResult = client.fetch(currentUri);
+                               return new Fetched(currentUri, fetchResult);
                        } catch (FetchException fe1) {
                                if (fe1.getMode() == FetchException.PERMANENT_REDIRECT) {
                                        currentUri = fe1.newURI;
                                        continue;
                                }
-                               logger.log(Level.WARNING, "Could not fetch “" + uri + "”!", fe1);
+                               logger.log(Level.WARNING, String.format("Could not fetch “%s”!", uri), fe1);
                                return null;
                        }
                }
        }
 
        /**
-        * Creates a key pair.
-        *
-        * @return The request key at index 0, the insert key at index 1
-        */
-       public String[] generateKeyPair() {
-               FreenetURI[] keyPair = client.generateKeyPair("");
-               return new String[] { keyPair[1].toString(), keyPair[0].toString() };
-       }
-
-       /**
         * Inserts the image data of the given {@link TemporaryImage} and returns
         * the given insert token that can be used to add listeners or cancel the
         * insert.
@@ -154,7 +157,7 @@ public class FreenetInterface {
                        ClientPutter clientPutter = client.insert(insertBlock, false, null, false, insertContext, insertToken, RequestStarter.INTERACTIVE_PRIORITY_CLASS);
                        insertToken.setClientPutter(clientPutter);
                } catch (InsertException ie1) {
-                       throw new SoneException(Type.INSERT_FAILED, "Could not start image insert.", ie1);
+                       throw new SoneInsertException("Could not start image insert.", ie1);
                }
        }
 
@@ -175,7 +178,7 @@ public class FreenetInterface {
                try {
                        return client.insertManifest(insertUri, manifestEntries, defaultFile);
                } catch (InsertException ie1) {
-                       throw new SoneException(null, ie1);
+                       throw new SoneException(ie1);
                }
        }
 
@@ -190,13 +193,13 @@ public class FreenetInterface {
         */
        public void registerUsk(final Sone sone, final SoneDownloader soneDownloader) {
                try {
-                       logger.log(Level.FINE, "Registering Sone “%s” for USK updates at %s…", new Object[] { sone, sone.getRequestUri().setMetaString(new String[] { "sone.xml" }) });
+                       logger.log(Level.FINE, String.format("Registering Sone “%s” for USK updates at %s…", sone, sone.getRequestUri().setMetaString(new String[] { "sone.xml" })));
                        USKCallback uskCallback = new USKCallback() {
 
                                @Override
                                @SuppressWarnings("synthetic-access")
                                public void onFoundEdition(long edition, USK key, ObjectContainer objectContainer, ClientContext clientContext, boolean metadata, short codec, byte[] data, boolean newKnownGood, boolean newSlotToo) {
-                                       logger.log(Level.FINE, "Found USK update for Sone “%s” at %s, new known good: %s, new slot too: %s.", new Object[] { sone, key, newKnownGood, newSlotToo });
+                                       logger.log(Level.FINE, String.format("Found USK update for Sone “%s” at %s, new known good: %s, new slot too: %s.", sone, key, newKnownGood, newSlotToo));
                                        if (edition > sone.getLatestEdition()) {
                                                sone.setLatestEdition(edition);
                                                new Thread(new Runnable() {
@@ -220,9 +223,10 @@ public class FreenetInterface {
                                }
                        };
                        soneUskCallbacks.put(sone.getId(), uskCallback);
-                       node.clientCore.uskManager.subscribe(USK.create(sone.getRequestUri()), uskCallback, (System.currentTimeMillis() - sone.getTime()) < 7 * 24 * 60 * 60 * 1000, (HighLevelSimpleClientImpl) client);
+                       boolean runBackgroundFetch = (System.currentTimeMillis() - sone.getTime()) < TimeUnit.DAYS.toMillis(7);
+                       node.clientCore.uskManager.subscribe(USK.create(sone.getRequestUri()), uskCallback, runBackgroundFetch, (RequestClient) client);
                } catch (MalformedURLException mue1) {
-                       logger.log(Level.WARNING, "Could not subscribe USK “" + sone.getRequestUri() + "”!", mue1);
+                       logger.log(Level.WARNING, String.format("Could not subscribe USK “%s”!", sone.getRequestUri()), mue1);
                }
        }
 
@@ -238,10 +242,10 @@ public class FreenetInterface {
                        return;
                }
                try {
-                       logger.log(Level.FINEST, "Unsubscribing from USK for %s…", new Object[] { sone });
+                       logger.log(Level.FINEST, String.format("Unsubscribing from USK for %s…", sone));
                        node.clientCore.uskManager.unsubscribe(USK.create(sone.getRequestUri()), uskCallback);
                } catch (MalformedURLException mue1) {
-                       logger.log(Level.FINE, "Could not unsubscribe USK “" + sone.getRequestUri() + "”!", mue1);
+                       logger.log(Level.FINE, String.format("Could not unsubscribe USK “%s”!", sone.getRequestUri()), mue1);
                }
        }
 
@@ -274,10 +278,10 @@ public class FreenetInterface {
 
                };
                try {
-                       node.clientCore.uskManager.subscribe(USK.create(uri), uskCallback, true, (HighLevelSimpleClientImpl) client);
+                       node.clientCore.uskManager.subscribe(USK.create(uri), uskCallback, true, (RequestClient) client);
                        uriUskCallbacks.put(uri, uskCallback);
                } catch (MalformedURLException mue1) {
-                       logger.log(Level.WARNING, "Could not subscribe to USK: " + uri, uri);
+                       logger.log(Level.WARNING, String.format("Could not subscribe to USK: %s", uri), mue1);
                }
        }
 
@@ -290,17 +294,67 @@ public class FreenetInterface {
        public void unregisterUsk(FreenetURI uri) {
                USKCallback uskCallback = uriUskCallbacks.remove(uri);
                if (uskCallback == null) {
-                       logger.log(Level.INFO, "Could not unregister unknown USK: " + uri);
+                       logger.log(Level.INFO, String.format("Could not unregister unknown USK: %s", uri));
                        return;
                }
                try {
                        node.clientCore.uskManager.unsubscribe(USK.create(uri), uskCallback);
                } catch (MalformedURLException mue1) {
-                       logger.log(Level.INFO, "Could not unregister invalid USK: " + uri);
+                       logger.log(Level.INFO, String.format("Could not unregister invalid USK: %s", uri), mue1);
                }
        }
 
        /**
+        * Container for a fetched URI and the {@link FetchResult}.
+        *
+        * @author <a href="mailto:d.roden@xplosion.de">David Roden</a>
+        */
+       public static class Fetched {
+
+               /** The fetched URI. */
+               private final FreenetURI freenetUri;
+
+               /** The fetch result. */
+               private final FetchResult fetchResult;
+
+               /**
+                * Creates a new fetched URI.
+                *
+                * @param freenetUri
+                *            The URI that was fetched
+                * @param fetchResult
+                *            The fetch result
+                */
+               public Fetched(FreenetURI freenetUri, FetchResult fetchResult) {
+                       this.freenetUri = freenetUri;
+                       this.fetchResult = fetchResult;
+               }
+
+               //
+               // ACCESSORS
+               //
+
+               /**
+                * Returns the fetched URI.
+                *
+                * @return The fetched URI
+                */
+               public FreenetURI getFreenetUri() {
+                       return freenetUri;
+               }
+
+               /**
+                * Returns the fetch result.
+                *
+                * @return The fetch result
+                */
+               public FetchResult getFetchResult() {
+                       return fetchResult;
+               }
+
+       }
+
+       /**
         * Callback for USK watcher events.
         *
         * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
@@ -325,24 +379,24 @@ public class FreenetInterface {
        }
 
        /**
-        * Insert token that can be used to add {@link ImageInsertListener}s and
-        * cancel a running insert.
+        * Insert token that can cancel a running insert and sends events.
         *
+        * @see ImageInsertAbortedEvent
+        * @see ImageInsertStartedEvent
+        * @see ImageInsertFailedEvent
+        * @see ImageInsertFinishedEvent
         * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
         */
-       public static class InsertToken implements ClientPutCallback {
+       public class InsertToken implements ClientPutCallback {
 
                /** The image being inserted. */
                private final Image image;
 
-               /** The list of registered image insert listeners. */
-               private final List<ImageInsertListener> imageInsertListeners = Collections.synchronizedList(new ArrayList<ImageInsertListener>());
-
                /** The client putter. */
                private ClientPutter clientPutter;
 
                /** The final URI. */
-               private FreenetURI resultingUri;
+               private volatile FreenetURI resultingUri;
 
                /**
                 * Creates a new insert token for the given image.
@@ -355,30 +409,6 @@ public class FreenetInterface {
                }
 
                //
-               // LISTENER MANAGEMENT
-               //
-
-               /**
-                * Adds the given listener to the list of registered listener.
-                *
-                * @param imageInsertListener
-                *            The listener to add
-                */
-               public void addImageInsertListener(ImageInsertListener imageInsertListener) {
-                       imageInsertListeners.add(imageInsertListener);
-               }
-
-               /**
-                * Removes the given listener from the list of registered listener.
-                *
-                * @param imageInsertListener
-                *            The listener to remove
-                */
-               public void removeImageInsertListener(ImageInsertListener imageInsertListener) {
-                       imageInsertListeners.remove(imageInsertListener);
-               }
-
-               //
                // ACCESSORS
                //
 
@@ -386,15 +416,13 @@ public class FreenetInterface {
                 * Sets the client putter that is inserting the image. This will also
                 * signal all registered listeners that the image has started.
                 *
-                * @see ImageInsertListener#imageInsertStarted(Image)
                 * @param clientPutter
                 *            The client putter
                 */
+               @SuppressWarnings("synthetic-access")
                public void setClientPutter(ClientPutter clientPutter) {
                        this.clientPutter = clientPutter;
-                       for (ImageInsertListener imageInsertListener : imageInsertListeners) {
-                               imageInsertListener.imageInsertStarted(image);
-                       }
+                       eventBus.post(new ImageInsertStartedEvent(image));
                }
 
                //
@@ -403,14 +431,11 @@ public class FreenetInterface {
 
                /**
                 * Cancels the running insert.
-                *
-                * @see ImageInsertListener#imageInsertAborted(Image)
                 */
+               @SuppressWarnings("synthetic-access")
                public void cancel() {
-                       clientPutter.cancel(null, null);
-                       for (ImageInsertListener imageInsertListener : imageInsertListeners) {
-                               imageInsertListener.imageInsertAborted(image);
-                       }
+                       clientPutter.cancel(null, node.clientCore.clientContext);
+                       eventBus.post(new ImageInsertAbortedEvent(image));
                }
 
                //
@@ -429,9 +454,12 @@ public class FreenetInterface {
                 * {@inheritDoc}
                 */
                @Override
+               @SuppressWarnings("synthetic-access")
                public void onFailure(InsertException insertException, BaseClientPutter clientPutter, ObjectContainer objectContainer) {
-                       for (ImageInsertListener imageInsertListener : imageInsertListeners) {
-                               imageInsertListener.imageInsertFailed(image, insertException);
+                       if ((insertException != null) && ("Cancelled by user".equals(insertException.getMessage()))) {
+                               eventBus.post(new ImageInsertAbortedEvent(image));
+                       } else {
+                               eventBus.post(new ImageInsertFailedEvent(image, insertException));
                        }
                }
 
@@ -447,6 +475,14 @@ public class FreenetInterface {
                 * {@inheritDoc}
                 */
                @Override
+               public void onGeneratedMetadata(Bucket metadata, BaseClientPutter clientPutter, ObjectContainer objectContainer) {
+                       /* ignore, we don’t care. */
+               }
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
                public void onGeneratedURI(FreenetURI generatedUri, BaseClientPutter clientPutter, ObjectContainer objectContainer) {
                        resultingUri = generatedUri;
                }
@@ -455,10 +491,18 @@ public class FreenetInterface {
                 * {@inheritDoc}
                 */
                @Override
+               @SuppressWarnings("synthetic-access")
                public void onSuccess(BaseClientPutter clientPutter, ObjectContainer objectContainer) {
-                       for (ImageInsertListener imageInsertListener : imageInsertListeners) {
-                               imageInsertListener.imageInsertFinished(image, resultingUri);
-                       }
+                       eventBus.post(new ImageInsertFinishedEvent(image, resultingUri));
+               }
+
+       }
+
+       public class InsertTokenSupplier implements Function<Image, InsertToken> {
+
+               @Override
+               public InsertToken apply(Image image) {
+                       return new InsertToken(image);
                }
 
        }