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