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