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

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