Merge branch 'release-0.4.2'
[Sone.git] / src / main / java / net / pterodactylus / sone / core / FreenetInterface.java
index 5d0a1a2..3ccda5b 100644 (file)
 
 package net.pterodactylus.sone.core;
 
+import java.net.MalformedURLException;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import net.pterodactylus.sone.data.Sone;
+import net.pterodactylus.util.collection.Pair;
 import net.pterodactylus.util.logging.Logging;
-import net.pterodactylus.util.service.AbstractService;
+
+import com.db4o.ObjectContainer;
+
 import freenet.client.FetchException;
 import freenet.client.FetchResult;
 import freenet.client.HighLevelSimpleClient;
+import freenet.client.HighLevelSimpleClientImpl;
+import freenet.client.InsertException;
+import freenet.client.async.ClientContext;
+import freenet.client.async.USKCallback;
 import freenet.keys.FreenetURI;
+import freenet.keys.USK;
 import freenet.node.Node;
+import freenet.node.RequestStarter;
 
 /**
  * Contains all necessary functionality for interacting with the Freenet node.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class FreenetInterface extends AbstractService {
+public class FreenetInterface {
 
        /** The logger. */
        private static final Logger logger = Logging.getLogger(FreenetInterface.class);
@@ -44,17 +58,21 @@ public class FreenetInterface extends AbstractService {
        /** The high-level client to use for requests. */
        private final HighLevelSimpleClient client;
 
+       /** The USK callbacks. */
+       private final Map<String, USKCallback> soneUskCallbacks = new HashMap<String, USKCallback>();
+
+       /** The not-Sone-related USK callbacks. */
+       private final Map<FreenetURI, USKCallback> uriUskCallbacks = Collections.synchronizedMap(new HashMap<FreenetURI, USKCallback>());
+
        /**
         * Creates a new Freenet interface.
         *
         * @param node
         *            The node to interact with
-        * @param client
-        *            The high-level client
         */
-       public FreenetInterface(Node node, HighLevelSimpleClient client) {
+       public FreenetInterface(Node node) {
                this.node = node;
-               this.client = client;
+               this.client = node.clientCore.makeClient(RequestStarter.INTERACTIVE_PRIORITY_CLASS, false, true);
        }
 
        //
@@ -68,17 +86,198 @@ public class FreenetInterface extends AbstractService {
         *            The URI to fetch
         * @return The result of the fetch, or {@code null} if an error occured
         */
-       public FetchResult fetchUri(FreenetURI uri) {
-               logger.entering(FreenetInterface.class.getName(), "fetchUri(FreenetURI)", uri);
+       public Pair<FreenetURI, FetchResult> fetchUri(FreenetURI uri) {
                FetchResult fetchResult = null;
+               FreenetURI currentUri = new FreenetURI(uri);
+               while (true) {
+                       try {
+                               fetchResult = client.fetch(currentUri);
+                               return new Pair<FreenetURI, FetchResult>(currentUri, fetchResult);
+                       } catch (FetchException fe1) {
+                               if (fe1.getMode() == FetchException.PERMANENT_REDIRECT) {
+                                       currentUri = fe1.newURI;
+                                       continue;
+                               }
+                               logger.log(Level.WARNING, "Could not fetch “" + 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 a directory into Freenet.
+        *
+        * @param insertUri
+        *            The insert URI
+        * @param manifestEntries
+        *            The directory entries
+        * @param defaultFile
+        *            The name of the default file
+        * @return The generated URI
+        * @throws SoneException
+        *             if an insert error occurs
+        */
+       public FreenetURI insertDirectory(FreenetURI insertUri, HashMap<String, Object> manifestEntries, String defaultFile) throws SoneException {
+               try {
+                       return client.insertManifest(insertUri, manifestEntries, defaultFile);
+               } catch (InsertException ie1) {
+                       throw new SoneException(null, ie1);
+               }
+       }
+
+       /**
+        * Registers the USK for the given Sone and notifies the given
+        * {@link SoneDownloader} if an update was found.
+        *
+        * @param sone
+        *            The Sone to watch
+        * @param soneDownloader
+        *            The Sone download to notify on updates
+        */
+       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" }) });
+                       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 });
+                                       if (edition > sone.getLatestEdition()) {
+                                               sone.setLatestEdition(edition);
+                                               new Thread(new Runnable() {
+
+                                                       @Override
+                                                       public void run() {
+                                                               soneDownloader.fetchSone(sone);
+                                                       }
+                                               }, "Sone Downloader").start();
+                                       }
+                               }
+
+                               @Override
+                               public short getPollingPriorityProgress() {
+                                       return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
+                               }
+
+                               @Override
+                               public short getPollingPriorityNormal() {
+                                       return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
+                               }
+                       };
+                       soneUskCallbacks.put(sone.getId(), uskCallback);
+                       node.clientCore.uskManager.subscribe(USK.create(sone.getRequestUri()), uskCallback, true, (HighLevelSimpleClientImpl) client);
+               } catch (MalformedURLException mue1) {
+                       logger.log(Level.WARNING, "Could not subscribe USK “" + sone.getRequestUri() + "”!", mue1);
+               }
+       }
+
+       /**
+        * Unsubscribes the request URI of the given Sone.
+        *
+        * @param sone
+        *            The Sone to unregister
+        */
+       public void unregisterUsk(Sone sone) {
+               USKCallback uskCallback = soneUskCallbacks.remove(sone.getId());
+               if (uskCallback == null) {
+                       return;
+               }
+               try {
+                       logger.log(Level.FINEST, "Unsubscribing from USK for %s…", new Object[] { sone });
+                       node.clientCore.uskManager.unsubscribe(USK.create(sone.getRequestUri()), uskCallback);
+               } catch (MalformedURLException mue1) {
+                       logger.log(Level.FINE, "Could not unsubscribe USK “" + sone.getRequestUri() + "”!", mue1);
+               }
+       }
+
+       /**
+        * Registers an arbitrary URI and calls the given callback if a new edition
+        * is found.
+        *
+        * @param uri
+        *            The URI to watch
+        * @param callback
+        *            The callback to call
+        */
+       public void registerUsk(FreenetURI uri, final Callback callback) {
+               USKCallback uskCallback = new USKCallback() {
+
+                       @Override
+                       public void onFoundEdition(long edition, USK key, ObjectContainer objectContainer, ClientContext clientContext, boolean metadata, short codec, byte[] data, boolean newKnownGood, boolean newSlotToo) {
+                               callback.editionFound(key.getURI(), edition, newKnownGood, newSlotToo);
+                       }
+
+                       @Override
+                       public short getPollingPriorityNormal() {
+                               return RequestStarter.PREFETCH_PRIORITY_CLASS;
+                       }
+
+                       @Override
+                       public short getPollingPriorityProgress() {
+                               return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
+                       }
+
+               };
                try {
-                       fetchResult = client.fetch(uri);
-               } catch (FetchException fe1) {
-                       logger.log(Level.WARNING, "Could not fetch “" + uri + "”!", fe1);
-               } finally {
-                       logger.exiting(FreenetInterface.class.getName(), "fetchUri(FreenetURI)", fetchResult);
+                       node.clientCore.uskManager.subscribe(USK.create(uri), uskCallback, true, (HighLevelSimpleClientImpl) client);
+                       uriUskCallbacks.put(uri, uskCallback);
+               } catch (MalformedURLException mue1) {
+                       logger.log(Level.WARNING, "Could not subscribe to USK: " + uri, uri);
                }
-               return fetchResult;
+       }
+
+       /**
+        * Unregisters the USK watcher for the given URI.
+        *
+        * @param uri
+        *            The URI to unregister the USK watcher for
+        */
+       public void unregisterUsk(FreenetURI uri) {
+               USKCallback uskCallback = uriUskCallbacks.remove(uri);
+               if (uskCallback == null) {
+                       logger.log(Level.INFO, "Could not unregister unknown USK: " + uri);
+                       return;
+               }
+               try {
+                       node.clientCore.uskManager.unsubscribe(USK.create(uri), uskCallback);
+               } catch (MalformedURLException mue1) {
+                       logger.log(Level.INFO, "Could not unregister invalid USK: " + uri);
+               }
+       }
+
+       /**
+        * Callback for USK watcher events.
+        *
+        * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+        */
+       public static interface Callback {
+
+               /**
+                * Notifies a listener that a new edition was found for a URI.
+                *
+                * @param uri
+                *            The URI that a new edition was found for
+                * @param edition
+                *            The found edition
+                * @param newKnownGood
+                *            Whether the found edition was actually fetched
+                * @param newSlot
+                *            Whether the found edition is higher than all previously
+                *            found editions
+                */
+               public void editionFound(FreenetURI uri, long edition, boolean newKnownGood, boolean newSlot);
+
        }
 
 }