src/main/java/net/pterodactylus/sone/core/FreenetInterface.java

   1 /*
   2  * FreenetSone - FreenetInterface.java - Copyright © 2010 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sone.core;
  19
  20 import java.net.MalformedURLException;
  21 import java.util.HashMap;
  22 import java.util.Map;
  23 import java.util.logging.Level;
  24 import java.util.logging.Logger;
  25
  26 import net.pterodactylus.sone.data.Sone;
  27 import net.pterodactylus.util.collection.Pair;
  28 import net.pterodactylus.util.logging.Logging;
  29
  30 import com.db4o.ObjectContainer;
  31
  32 import freenet.client.FetchException;
  33 import freenet.client.FetchResult;
  34 import freenet.client.HighLevelSimpleClient;
  35 import freenet.client.HighLevelSimpleClientImpl;
  36 import freenet.client.InsertException;
  37 import freenet.client.async.ClientContext;
  38 import freenet.client.async.USKCallback;
  39 import freenet.keys.FreenetURI;
  40 import freenet.keys.USK;
  41 import freenet.node.Node;
  42 import freenet.node.RequestStarter;
  43
  44 /**
  45  * Contains all necessary functionality for interacting with the Freenet node.
  46  *
  47  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  48  */
  49 public class FreenetInterface {
  50
  51         /** The logger. */
  52         private static final Logger logger = Logging.getLogger(FreenetInterface.class);
  53
  54         /** The node to interact with. */
  55         private final Node node;
  56
  57         /** The high-level client to use for requests. */
  58         private final HighLevelSimpleClient client;
  59
  60         /** The USK callbacks. */
  61         private final Map<String, USKCallback> soneUskCallbacks = new HashMap<String, USKCallback>();
  62
  63         /**
  64          * Creates a new Freenet interface.
  65          *
  66          * @param node
  67          *            The node to interact with
  68          * @param client
  69          *            The high-level client
  70          */
  71         public FreenetInterface(Node node, HighLevelSimpleClient client) {
  72                 this.node = node;
  73                 this.client = client;
  74         }
  75
  76         //
  77         // ACTIONS
  78         //
  79
  80         /**
  81          * Fetches the given URI.
  82          *
  83          * @param uri
  84          *            The URI to fetch
  85          * @return The result of the fetch, or {@code null} if an error occured
  86          */
  87         public Pair<FreenetURI, FetchResult> fetchUri(FreenetURI uri) {
  88                 FetchResult fetchResult = null;
  89                 FreenetURI currentUri = new FreenetURI(uri);
  90                 while (true) {
  91                         try {
  92                                 fetchResult = client.fetch(currentUri);
  93                                 return new Pair<FreenetURI, FetchResult>(currentUri, fetchResult);
  94                         } catch (FetchException fe1) {
  95                                 if (fe1.getMode() == FetchException.PERMANENT_REDIRECT) {
  96                                         currentUri = fe1.newURI;
  97                                         continue;
  98                                 }
  99                                 logger.log(Level.WARNING, "Could not fetch “" + uri + "”!", fe1);
 100                                 return null;
 101                         }
 102                 }
 103         }
 104
 105         /**
 106          * Creates a key pair.
 107          *
 108          * @return The request key at index 0, the insert key at index 1
 109          */
 110         public String[] generateKeyPair() {
 111                 FreenetURI[] keyPair = client.generateKeyPair("");
 112                 return new String[] { keyPair[1].toString(), keyPair[0].toString() };
 113         }
 114
 115         /**
 116          * Inserts a directory into Freenet.
 117          *
 118          * @param insertUri
 119          *            The insert URI
 120          * @param manifestEntries
 121          *            The directory entries
 122          * @param defaultFile
 123          *            The name of the default file
 124          * @return The generated URI
 125          * @throws SoneException
 126          *             if an insert error occurs
 127          */
 128         public FreenetURI insertDirectory(FreenetURI insertUri, HashMap<String, Object> manifestEntries, String defaultFile) throws SoneException {
 129                 try {
 130                         return client.insertManifest(insertUri, manifestEntries, defaultFile);
 131                 } catch (InsertException ie1) {
 132                         throw new SoneException(null, ie1);
 133                 }
 134         }
 135
 136         /**
 137          * Registers the USK for the given Sone and notifies the given
 138          * {@link SoneDownloader} if an update was found.
 139          *
 140          * @param sone
 141          *            The Sone to watch
 142          * @param soneDownloader
 143          *            The Sone download to notify on updates
 144          */
 145         public void registerUsk(final Sone sone, final SoneDownloader soneDownloader) {
 146                 try {
 147                         logger.log(Level.FINE, "Registering Sone “%s” for USK updates at %s…", new Object[] { sone, sone.getRequestUri().setMetaString(new String[] { "sone.xml" }) });
 148                         USKCallback uskCallback = new USKCallback() {
 149
 150                                 @Override
 151                                 @SuppressWarnings("synthetic-access")
 152                                 public void onFoundEdition(long edition, USK key, ObjectContainer objectContainer, ClientContext clientContext, boolean metadata, short codec, byte[] data, boolean newKnownGood, boolean newSlotToo) {
 153                                         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 });
 154                                         if (newKnownGood) {
 155                                                 sone.setLatestEdition(key.suggestedEdition);
 156                                                 soneDownloader.fetchSone(sone);
 157                                         }
 158                                 }
 159
 160                                 @Override
 161                                 public short getPollingPriorityProgress() {
 162                                         return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
 163                                 }
 164
 165                                 @Override
 166                                 public short getPollingPriorityNormal() {
 167                                         return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
 168                                 }
 169                         };
 170                         soneUskCallbacks.put(sone.getId(), uskCallback);
 171                         node.clientCore.uskManager.subscribe(USK.create(sone.getRequestUri()), uskCallback, true, (HighLevelSimpleClientImpl) client);
 172                 } catch (MalformedURLException mue1) {
 173                         logger.log(Level.WARNING, "Could not subscribe USK “" + sone.getRequestUri() + "”!", mue1);
 174                 }
 175         }
 176
 177         /**
 178          * Unsubscribes the request URI of the given Sone.
 179          *
 180          * @param sone
 181          *            The Sone to unregister
 182          */
 183         public void unregisterUsk(Sone sone) {
 184                 USKCallback uskCallback = soneUskCallbacks.remove(sone.getId());
 185                 if (uskCallback == null) {
 186                         return;
 187                 }
 188                 try {
 189                         logger.log(Level.FINEST, "Unsubscribing from USK for %s…", new Object[] { sone });
 190                         node.clientCore.uskManager.unsubscribe(USK.create(sone.getRequestUri()), uskCallback);
 191                 } catch (MalformedURLException mue1) {
 192                         logger.log(Level.FINE, "Could not unsubscribe USK “" + sone.getRequestUri() + "”!", mue1);
 193                 }
 194         }
 195
 196 }