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

   1 /*
   2  * Sone - FreenetInterface.java - Copyright © 2010–2013 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.Collections;
  22 import java.util.HashMap;
  23 import java.util.Map;
  24 import java.util.concurrent.TimeUnit;
  25 import java.util.logging.Level;
  26 import java.util.logging.Logger;
  27
  28 import net.pterodactylus.sone.core.event.ImageInsertAbortedEvent;
  29 import net.pterodactylus.sone.core.event.ImageInsertFailedEvent;
  30 import net.pterodactylus.sone.core.event.ImageInsertFinishedEvent;
  31 import net.pterodactylus.sone.core.event.ImageInsertStartedEvent;
  32 import net.pterodactylus.sone.data.Image;
  33 import net.pterodactylus.sone.data.Sone;
  34 import net.pterodactylus.sone.data.TemporaryImage;
  35 import net.pterodactylus.util.logging.Logging;
  36
  37 import com.google.common.eventbus.EventBus;
  38 import com.google.inject.Inject;
  39
  40 import freenet.client.ClientMetadata;
  41 import freenet.client.FetchException;
  42 import freenet.client.FetchException.FetchExceptionMode;
  43 import freenet.client.FetchResult;
  44 import freenet.client.HighLevelSimpleClient;
  45 import freenet.client.HighLevelSimpleClientImpl;
  46 import freenet.client.InsertBlock;
  47 import freenet.client.InsertContext;
  48 import freenet.client.InsertException;
  49 import freenet.client.async.BaseClientPutter;
  50 import freenet.client.async.ClientContext;
  51 import freenet.client.async.ClientPutCallback;
  52 import freenet.client.async.ClientPutter;
  53 import freenet.client.async.USKCallback;
  54 import freenet.keys.FreenetURI;
  55 import freenet.keys.InsertableClientSSK;
  56 import freenet.keys.USK;
  57 import freenet.node.Node;
  58 import freenet.node.RequestClient;
  59 import freenet.node.RequestStarter;
  60 import freenet.support.api.Bucket;
  61 import freenet.support.api.RandomAccessBucket;
  62 import freenet.support.io.ArrayBucket;
  63 import freenet.support.io.ResumeFailedException;
  64
  65 /**
  66  * Contains all necessary functionality for interacting with the Freenet node.
  67  *
  68  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  69  */
  70 public class FreenetInterface {
  71
  72         /** The logger. */
  73         private static final Logger logger = Logging.getLogger(FreenetInterface.class);
  74
  75         /** The event bus. */
  76         private final EventBus eventBus;
  77
  78         /** The node to interact with. */
  79         private final Node node;
  80
  81         /** The high-level client to use for requests. */
  82         private final HighLevelSimpleClient client;
  83
  84         /** The USK callbacks. */
  85         private final Map<String, USKCallback> soneUskCallbacks = new HashMap<String, USKCallback>();
  86
  87         /** The not-Sone-related USK callbacks. */
  88         private final Map<FreenetURI, USKCallback> uriUskCallbacks = Collections.synchronizedMap(new HashMap<FreenetURI, USKCallback>());
  89
  90         /**
  91          * Creates a new Freenet interface.
  92          *
  93          * @param eventBus
  94          *            The event bus
  95          * @param node
  96          *            The node to interact with
  97          */
  98         @Inject
  99         public FreenetInterface(EventBus eventBus, Node node) {
 100                 this.eventBus = eventBus;
 101                 this.node = node;
 102                 this.client = node.clientCore.makeClient(RequestStarter.INTERACTIVE_PRIORITY_CLASS, false, true);
 103         }
 104
 105         //
 106         // ACTIONS
 107         //
 108
 109         /**
 110          * Fetches the given URI.
 111          *
 112          * @param uri
 113          *            The URI to fetch
 114          * @return The result of the fetch, or {@code null} if an error occured
 115          */
 116         public Fetched fetchUri(FreenetURI uri) {
 117                 FetchResult fetchResult = null;
 118                 FreenetURI currentUri = new FreenetURI(uri);
 119                 while (true) {
 120                         try {
 121                                 fetchResult = client.fetch(currentUri);
 122                                 return new Fetched(currentUri, fetchResult);
 123                         } catch (FetchException fe1) {
 124                                 if (fe1.getMode() == FetchExceptionMode.PERMANENT_REDIRECT) {
 125                                         currentUri = fe1.newURI;
 126                                         continue;
 127                                 }
 128                                 logger.log(Level.WARNING, String.format("Could not fetch “%s”!", uri), fe1);
 129                                 return null;
 130                         }
 131                 }
 132         }
 133
 134         /**
 135          * Creates a key pair.
 136          *
 137          * @return The request key at index 0, the insert key at index 1
 138          */
 139         public String[] generateKeyPair() {
 140                 FreenetURI[] keyPair = client.generateKeyPair("");
 141                 return new String[] { keyPair[1].toString(), keyPair[0].toString() };
 142         }
 143
 144         /**
 145          * Inserts the image data of the given {@link TemporaryImage} and returns
 146          * the given insert token that can be used to add listeners or cancel the
 147          * insert.
 148          *
 149          * @param temporaryImage
 150          *            The temporary image data
 151          * @param image
 152          *            The image
 153          * @param insertToken
 154          *            The insert token
 155          * @throws SoneException
 156          *             if the insert could not be started
 157          */
 158         public void insertImage(TemporaryImage temporaryImage, Image image, InsertToken insertToken) throws SoneException {
 159                 String filenameHint = image.getId() + "." + temporaryImage.getMimeType().substring(temporaryImage.getMimeType().lastIndexOf("/") + 1);
 160                 InsertableClientSSK key = InsertableClientSSK.createRandom(node.random, "");
 161                 FreenetURI targetUri = key.getInsertURI().setDocName(filenameHint);
 162                 InsertContext insertContext = client.getInsertContext(true);
 163                 RandomAccessBucket bucket = new ArrayBucket(temporaryImage.getImageData());
 164                 ClientMetadata metadata = new ClientMetadata(temporaryImage.getMimeType());
 165                 InsertBlock insertBlock = new InsertBlock(bucket, metadata, targetUri);
 166                 try {
 167                         ClientPutter clientPutter = client.insert(insertBlock, null, false, insertContext, insertToken, RequestStarter.INTERACTIVE_PRIORITY_CLASS);
 168                         insertToken.setClientPutter(clientPutter);
 169                 } catch (InsertException ie1) {
 170                         throw new SoneInsertException("Could not start image insert.", ie1);
 171                 }
 172         }
 173
 174         /**
 175          * Inserts a directory into Freenet.
 176          *
 177          * @param insertUri
 178          *            The insert URI
 179          * @param manifestEntries
 180          *            The directory entries
 181          * @param defaultFile
 182          *            The name of the default file
 183          * @return The generated URI
 184          * @throws SoneException
 185          *             if an insert error occurs
 186          */
 187         public FreenetURI insertDirectory(FreenetURI insertUri, HashMap<String, Object> manifestEntries, String defaultFile) throws SoneException {
 188                 try {
 189                         return client.insertManifest(insertUri, manifestEntries, defaultFile);
 190                 } catch (InsertException ie1) {
 191                         throw new SoneException(ie1);
 192                 }
 193         }
 194
 195         /**
 196          * Registers the USK for the given Sone and notifies the given
 197          * {@link SoneDownloader} if an update was found.
 198          *
 199          * @param sone
 200          *            The Sone to watch
 201          * @param soneDownloader
 202          *            The Sone download to notify on updates
 203          */
 204         public void registerUsk(final Sone sone, final SoneDownloader soneDownloader) {
 205                 try {
 206                         logger.log(Level.FINE, String.format("Registering Sone “%s” for USK updates at %s…", sone, sone.getRequestUri().setMetaString(new String[] { "sone.xml" })));
 207                         USKCallback uskCallback = new USKCallback() {
 208
 209                                 @Override
 210                                 @SuppressWarnings("synthetic-access")
 211                                 public void onFoundEdition(long edition, USK key, ClientContext clientContext, boolean metadata, short codec, byte[] data, boolean newKnownGood, boolean newSlotToo) {
 212                                         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));
 213                                         if (edition > sone.getLatestEdition()) {
 214                                                 sone.setLatestEdition(edition);
 215                                                 new Thread(new Runnable() {
 216
 217                                                         @Override
 218                                                         public void run() {
 219                                                                 soneDownloader.fetchSone(sone);
 220                                                         }
 221                                                 }, "Sone Downloader").start();
 222                                         }
 223                                 }
 224
 225                                 @Override
 226                                 public short getPollingPriorityProgress() {
 227                                         return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
 228                                 }
 229
 230                                 @Override
 231                                 public short getPollingPriorityNormal() {
 232                                         return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
 233                                 }
 234                         };
 235                         soneUskCallbacks.put(sone.getId(), uskCallback);
 236                         boolean runBackgroundFetch = (System.currentTimeMillis() - sone.getTime()) < TimeUnit.DAYS.toMillis(7);
 237                         node.clientCore.uskManager.subscribe(USK.create(sone.getRequestUri()), uskCallback, runBackgroundFetch, (HighLevelSimpleClientImpl) client);
 238                 } catch (MalformedURLException mue1) {
 239                         logger.log(Level.WARNING, String.format("Could not subscribe USK “%s”!", sone.getRequestUri()), mue1);
 240                 }
 241         }
 242
 243         /**
 244          * Unsubscribes the request URI of the given Sone.
 245          *
 246          * @param sone
 247          *            The Sone to unregister
 248          */
 249         public void unregisterUsk(Sone sone) {
 250                 USKCallback uskCallback = soneUskCallbacks.remove(sone.getId());
 251                 if (uskCallback == null) {
 252                         return;
 253                 }
 254                 try {
 255                         logger.log(Level.FINEST, String.format("Unsubscribing from USK for %s…", sone));
 256                         node.clientCore.uskManager.unsubscribe(USK.create(sone.getRequestUri()), uskCallback);
 257                 } catch (MalformedURLException mue1) {
 258                         logger.log(Level.FINE, String.format("Could not unsubscribe USK “%s”!", sone.getRequestUri()), mue1);
 259                 }
 260         }
 261
 262         /**
 263          * Registers an arbitrary URI and calls the given callback if a new edition
 264          * is found.
 265          *
 266          * @param uri
 267          *            The URI to watch
 268          * @param callback
 269          *            The callback to call
 270          */
 271         public void registerUsk(FreenetURI uri, final Callback callback) {
 272                 USKCallback uskCallback = new USKCallback() {
 273
 274                         @Override
 275                         public void onFoundEdition(long edition, USK key, ClientContext clientContext, boolean metadata, short codec, byte[] data, boolean newKnownGood, boolean newSlotToo) {
 276                                 callback.editionFound(key.getURI(), edition, newKnownGood, newSlotToo);
 277                         }
 278
 279                         @Override
 280                         public short getPollingPriorityNormal() {
 281                                 return RequestStarter.PREFETCH_PRIORITY_CLASS;
 282                         }
 283
 284                         @Override
 285                         public short getPollingPriorityProgress() {
 286                                 return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
 287                         }
 288
 289                 };
 290                 try {
 291                         node.clientCore.uskManager.subscribe(USK.create(uri), uskCallback, true, (HighLevelSimpleClientImpl) client);
 292                         uriUskCallbacks.put(uri, uskCallback);
 293                 } catch (MalformedURLException mue1) {
 294                         logger.log(Level.WARNING, String.format("Could not subscribe to USK: %s", uri), mue1);
 295                 }
 296         }
 297
 298         /**
 299          * Unregisters the USK watcher for the given URI.
 300          *
 301          * @param uri
 302          *            The URI to unregister the USK watcher for
 303          */
 304         public void unregisterUsk(FreenetURI uri) {
 305                 USKCallback uskCallback = uriUskCallbacks.remove(uri);
 306                 if (uskCallback == null) {
 307                         logger.log(Level.INFO, String.format("Could not unregister unknown USK: %s", uri));
 308                         return;
 309                 }
 310                 try {
 311                         node.clientCore.uskManager.unsubscribe(USK.create(uri), uskCallback);
 312                 } catch (MalformedURLException mue1) {
 313                         logger.log(Level.INFO, String.format("Could not unregister invalid USK: %s", uri), mue1);
 314                 }
 315         }
 316
 317         /**
 318          * Container for a fetched URI and the {@link FetchResult}.
 319          *
 320          * @author <a href="mailto:d.roden@xplosion.de">David Roden</a>
 321          */
 322         public static class Fetched {
 323
 324                 /** The fetched URI. */
 325                 private final FreenetURI freenetUri;
 326
 327                 /** The fetch result. */
 328                 private final FetchResult fetchResult;
 329
 330                 /**
 331                  * Creates a new fetched URI.
 332                  *
 333                  * @param freenetUri
 334                  *            The URI that was fetched
 335                  * @param fetchResult
 336                  *            The fetch result
 337                  */
 338                 public Fetched(FreenetURI freenetUri, FetchResult fetchResult) {
 339                         this.freenetUri = freenetUri;
 340                         this.fetchResult = fetchResult;
 341                 }
 342
 343                 //
 344                 // ACCESSORS
 345                 //
 346
 347                 /**
 348                  * Returns the fetched URI.
 349                  *
 350                  * @return The fetched URI
 351                  */
 352                 public FreenetURI getFreenetUri() {
 353                         return freenetUri;
 354                 }
 355
 356                 /**
 357                  * Returns the fetch result.
 358                  *
 359                  * @return The fetch result
 360                  */
 361                 public FetchResult getFetchResult() {
 362                         return fetchResult;
 363                 }
 364
 365         }
 366
 367         /**
 368          * Callback for USK watcher events.
 369          *
 370          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 371          */
 372         public static interface Callback {
 373
 374                 /**
 375                  * Notifies a listener that a new edition was found for a URI.
 376                  *
 377                  * @param uri
 378                  *            The URI that a new edition was found for
 379                  * @param edition
 380                  *            The found edition
 381                  * @param newKnownGood
 382                  *            Whether the found edition was actually fetched
 383                  * @param newSlot
 384                  *            Whether the found edition is higher than all previously
 385                  *            found editions
 386                  */
 387                 public void editionFound(FreenetURI uri, long edition, boolean newKnownGood, boolean newSlot);
 388
 389         }
 390
 391         /**
 392          * Insert token that can cancel a running insert and sends events.
 393          *
 394          * @see ImageInsertAbortedEvent
 395          * @see ImageInsertStartedEvent
 396          * @see ImageInsertFailedEvent
 397          * @see ImageInsertFinishedEvent
 398          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 399          */
 400         public class InsertToken implements ClientPutCallback {
 401
 402                 /** The image being inserted. */
 403                 private final Image image;
 404
 405                 /** The client putter. */
 406                 private ClientPutter clientPutter;
 407
 408                 /** The final URI. */
 409                 private volatile FreenetURI resultingUri;
 410
 411                 /**
 412                  * Creates a new insert token for the given image.
 413                  *
 414                  * @param image
 415                  *            The image being inserted
 416                  */
 417                 public InsertToken(Image image) {
 418                         this.image = image;
 419                 }
 420
 421                 //
 422                 // ACCESSORS
 423                 //
 424
 425                 /**
 426                  * Sets the client putter that is inserting the image. This will also
 427                  * signal all registered listeners that the image has started.
 428                  *
 429                  * @param clientPutter
 430                  *            The client putter
 431                  */
 432                 @SuppressWarnings("synthetic-access")
 433                 public void setClientPutter(ClientPutter clientPutter) {
 434                         this.clientPutter = clientPutter;
 435                         eventBus.post(new ImageInsertStartedEvent(image));
 436                 }
 437
 438                 //
 439                 // ACTIONS
 440                 //
 441
 442                 /**
 443                  * Cancels the running insert.
 444                  */
 445                 @SuppressWarnings("synthetic-access")
 446                 public void cancel() {
 447                         clientPutter.cancel(node.clientCore.clientContext);
 448                         eventBus.post(new ImageInsertAbortedEvent(image));
 449                 }
 450
 451                 //
 452                 // INTERFACE ClientPutCallback
 453                 //
 454
 455                 @Override
 456                 public RequestClient getRequestClient() {
 457                         return clientPutter.getClient();
 458                 }
 459
 460                 @Override
 461                 public void onResume(ClientContext context) throws ResumeFailedException {
 462                         /* ignore. */
 463                 }
 464
 465                 /**
 466                  * {@inheritDoc}
 467                  */
 468                 @Override
 469                 @SuppressWarnings("synthetic-access")
 470                 public void onFailure(InsertException insertException, BaseClientPutter clientPutter) {
 471                         if ((insertException != null) && ("Cancelled by user".equals(insertException.getMessage()))) {
 472                                 eventBus.post(new ImageInsertAbortedEvent(image));
 473                         } else {
 474                                 eventBus.post(new ImageInsertFailedEvent(image, insertException));
 475                         }
 476                 }
 477
 478                 /**
 479                  * {@inheritDoc}
 480                  */
 481                 @Override
 482                 public void onFetchable(BaseClientPutter clientPutter) {
 483                         /* ignore, we don’t care. */
 484                 }
 485
 486                 /**
 487                  * {@inheritDoc}
 488                  */
 489                 @Override
 490                 public void onGeneratedMetadata(Bucket metadata, BaseClientPutter clientPutter) {
 491                         /* ignore, we don’t care. */
 492                 }
 493
 494                 /**
 495                  * {@inheritDoc}
 496                  */
 497                 @Override
 498                 public void onGeneratedURI(FreenetURI generatedUri, BaseClientPutter clientPutter) {
 499                         resultingUri = generatedUri;
 500                 }
 501
 502                 /**
 503                  * {@inheritDoc}
 504                  */
 505                 @Override
 506                 @SuppressWarnings("synthetic-access")
 507                 public void onSuccess(BaseClientPutter clientPutter) {
 508                         eventBus.post(new ImageInsertFinishedEvent(image, resultingUri));
 509                 }
 510
 511         }
 512
 513 }