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