2 * Sone - FreenetInterface.java - Copyright © 2010–2013 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.core;
20 import java.net.MalformedURLException;
21 import java.util.Collections;
22 import java.util.HashMap;
24 import java.util.concurrent.TimeUnit;
25 import java.util.logging.Level;
26 import java.util.logging.Logger;
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;
37 import freenet.client.ClientMetadata;
38 import freenet.client.FetchException;
39 import freenet.client.FetchResult;
40 import freenet.client.HighLevelSimpleClient;
41 import freenet.client.HighLevelSimpleClientImpl;
42 import freenet.client.InsertBlock;
43 import freenet.client.InsertContext;
44 import freenet.client.InsertException;
45 import freenet.client.async.BaseClientPutter;
46 import freenet.client.async.ClientContext;
47 import freenet.client.async.ClientPutCallback;
48 import freenet.client.async.ClientPutter;
49 import freenet.client.async.USKCallback;
50 import freenet.client.async.USKManager;
51 import freenet.keys.FreenetURI;
52 import freenet.keys.InsertableClientSSK;
53 import freenet.keys.USK;
54 import freenet.node.Node;
55 import freenet.node.RequestClient;
56 import freenet.node.RequestStarter;
57 import freenet.support.api.Bucket;
58 import freenet.support.io.ArrayBucket;
59 import com.db4o.ObjectContainer;
61 import com.google.common.annotations.VisibleForTesting;
62 import com.google.common.eventbus.EventBus;
63 import com.google.inject.Inject;
66 * Contains all necessary functionality for interacting with the Freenet node.
68 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
70 public class FreenetInterface {
73 private static final Logger logger = Logging.getLogger(FreenetInterface.class);
76 private final EventBus eventBus;
78 /** The node to interact with. */
79 private final Node node;
81 /** The high-level client to use for requests. */
82 private final HighLevelSimpleClient client;
83 private final RequestClient requestClient;
85 /** The USK callbacks. */
86 private final Map<String, USKCallback> soneUskCallbacks = new HashMap<String, USKCallback>();
88 /** The not-Sone-related USK callbacks. */
89 private final Map<FreenetURI, USKCallback> uriUskCallbacks = Collections.synchronizedMap(new HashMap<FreenetURI, USKCallback>());
90 private USKManager uskManager;
93 * Creates a new Freenet interface.
98 * The node to interact with
101 public FreenetInterface(EventBus eventBus, Node node) {
102 this.eventBus = eventBus;
104 this.client = node.clientCore.makeClient(RequestStarter.INTERACTIVE_PRIORITY_CLASS, false, true);
105 this.requestClient = (HighLevelSimpleClientImpl) client;
106 this.uskManager = node.clientCore.uskManager;
110 public FreenetInterface(EventBus eventBus, Node node, HighLevelSimpleClient highLevelSimpleClient, RequestClient requestClient, USKManager uskManager) {
111 this.eventBus = eventBus;
113 this.client = highLevelSimpleClient;
114 this.requestClient = requestClient;
115 this.uskManager = uskManager;
123 * Fetches the given URI.
127 * @return The result of the fetch, or {@code null} if an error occured
129 public Fetched fetchUri(FreenetURI uri) {
130 FetchResult fetchResult = null;
131 FreenetURI currentUri = new FreenetURI(uri);
134 fetchResult = client.fetch(currentUri);
135 return new Fetched(currentUri, fetchResult);
136 } catch (FetchException fe1) {
137 if (fe1.getMode() == FetchException.PERMANENT_REDIRECT) {
138 currentUri = fe1.newURI;
141 logger.log(Level.WARNING, String.format("Could not fetch “%s”!", uri), fe1);
148 * Creates a key pair.
150 * @return The request key at index 0, the insert key at index 1
152 public String[] generateKeyPair() {
153 FreenetURI[] keyPair = client.generateKeyPair("");
154 return new String[] { keyPair[1].toString(), keyPair[0].toString() };
158 * Inserts the image data of the given {@link TemporaryImage} and returns
159 * the given insert token that can be used to add listeners or cancel the
162 * @param temporaryImage
163 * The temporary image data
168 * @throws SoneException
169 * if the insert could not be started
171 public void insertImage(TemporaryImage temporaryImage, Image image, InsertToken insertToken) throws SoneException {
172 String filenameHint = image.getId() + "." + temporaryImage.getMimeType().substring(temporaryImage.getMimeType().lastIndexOf("/") + 1);
173 InsertableClientSSK key = InsertableClientSSK.createRandom(node.random, "");
174 FreenetURI targetUri = key.getInsertURI().setDocName(filenameHint);
175 InsertContext insertContext = client.getInsertContext(true);
176 Bucket bucket = new ArrayBucket(temporaryImage.getImageData());
177 ClientMetadata metadata = new ClientMetadata(temporaryImage.getMimeType());
178 InsertBlock insertBlock = new InsertBlock(bucket, metadata, targetUri);
180 ClientPutter clientPutter = client.insert(insertBlock, false, null, false, insertContext, insertToken, RequestStarter.INTERACTIVE_PRIORITY_CLASS);
181 insertToken.setClientPutter(clientPutter);
182 } catch (InsertException ie1) {
183 throw new SoneInsertException("Could not start image insert.", ie1);
188 * Inserts a directory into Freenet.
192 * @param manifestEntries
193 * The directory entries
195 * The name of the default file
196 * @return The generated URI
197 * @throws SoneException
198 * if an insert error occurs
200 public FreenetURI insertDirectory(FreenetURI insertUri, HashMap<String, Object> manifestEntries, String defaultFile) throws SoneException {
202 return client.insertManifest(insertUri, manifestEntries, defaultFile);
203 } catch (InsertException ie1) {
204 throw new SoneException(ie1);
209 * Registers the USK for the given Sone and notifies the given
210 * {@link SoneDownloader} if an update was found.
214 * @param soneDownloader
215 * The Sone download to notify on updates
217 public void registerUsk(final Sone sone, final SoneDownloader soneDownloader) {
219 logger.log(Level.FINE, String.format("Registering Sone “%s” for USK updates at %s…", sone, sone.getRequestUri().setMetaString(new String[] { "sone.xml" })));
220 USKCallback uskCallback = new USKCallback() {
223 @SuppressWarnings("synthetic-access")
224 public void onFoundEdition(long edition, USK key, ObjectContainer objectContainer, ClientContext clientContext, boolean metadata, short codec, byte[] data, boolean newKnownGood, boolean newSlotToo) {
225 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));
226 if (edition > sone.getLatestEdition()) {
227 sone.setLatestEdition(edition);
228 new Thread(new Runnable() {
232 soneDownloader.fetchSone(sone);
234 }, "Sone Downloader").start();
239 public short getPollingPriorityProgress() {
240 return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
244 public short getPollingPriorityNormal() {
245 return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
248 soneUskCallbacks.put(sone.getId(), uskCallback);
249 boolean runBackgroundFetch = (System.currentTimeMillis() - sone.getTime()) < TimeUnit.DAYS.toMillis(7);
250 uskManager.subscribe(USK.create(sone.getRequestUri()), uskCallback, runBackgroundFetch, requestClient);
251 } catch (MalformedURLException mue1) {
252 logger.log(Level.WARNING, String.format("Could not subscribe USK “%s”!", sone.getRequestUri()), mue1);
257 * Unsubscribes the request URI of the given Sone.
260 * The Sone to unregister
262 public void unregisterUsk(Sone sone) {
263 USKCallback uskCallback = soneUskCallbacks.remove(sone.getId());
264 if (uskCallback == null) {
268 logger.log(Level.FINEST, String.format("Unsubscribing from USK for %s…", sone));
269 uskManager.unsubscribe(USK.create(sone.getRequestUri()), uskCallback);
270 } catch (MalformedURLException mue1) {
271 logger.log(Level.FINE, String.format("Could not unsubscribe USK “%s”!", sone.getRequestUri()), mue1);
276 * Registers an arbitrary URI and calls the given callback if a new edition
282 * The callback to call
284 public void registerUsk(FreenetURI uri, final Callback callback) {
285 USKCallback uskCallback = new USKCallback() {
288 public void onFoundEdition(long edition, USK key, ObjectContainer objectContainer, ClientContext clientContext, boolean metadata, short codec, byte[] data, boolean newKnownGood, boolean newSlotToo) {
289 callback.editionFound(key.getURI(), edition, newKnownGood, newSlotToo);
293 public short getPollingPriorityNormal() {
294 return RequestStarter.PREFETCH_PRIORITY_CLASS;
298 public short getPollingPriorityProgress() {
299 return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
304 uskManager.subscribe(USK.create(uri), uskCallback, true, requestClient);
305 uriUskCallbacks.put(uri, uskCallback);
306 } catch (MalformedURLException mue1) {
307 logger.log(Level.WARNING, String.format("Could not subscribe to USK: %s", uri), mue1);
312 * Unregisters the USK watcher for the given URI.
315 * The URI to unregister the USK watcher for
317 public void unregisterUsk(FreenetURI uri) {
318 USKCallback uskCallback = uriUskCallbacks.remove(uri);
319 if (uskCallback == null) {
320 logger.log(Level.INFO, String.format("Could not unregister unknown USK: %s", uri));
324 uskManager.unsubscribe(USK.create(uri), uskCallback);
325 } catch (MalformedURLException mue1) {
326 logger.log(Level.INFO, String.format("Could not unregister invalid USK: %s", uri), mue1);
331 * Container for a fetched URI and the {@link FetchResult}.
333 * @author <a href="mailto:d.roden@xplosion.de">David Roden</a>
335 public static class Fetched {
337 /** The fetched URI. */
338 private final FreenetURI freenetUri;
340 /** The fetch result. */
341 private final FetchResult fetchResult;
344 * Creates a new fetched URI.
347 * The URI that was fetched
351 public Fetched(FreenetURI freenetUri, FetchResult fetchResult) {
352 this.freenetUri = freenetUri;
353 this.fetchResult = fetchResult;
361 * Returns the fetched URI.
363 * @return The fetched URI
365 public FreenetURI getFreenetUri() {
370 * Returns the fetch result.
372 * @return The fetch result
374 public FetchResult getFetchResult() {
381 * Callback for USK watcher events.
383 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
385 public static interface Callback {
388 * Notifies a listener that a new edition was found for a URI.
391 * The URI that a new edition was found for
394 * @param newKnownGood
395 * Whether the found edition was actually fetched
397 * Whether the found edition is higher than all previously
400 public void editionFound(FreenetURI uri, long edition, boolean newKnownGood, boolean newSlot);
405 * Insert token that can cancel a running insert and sends events.
407 * @see ImageInsertAbortedEvent
408 * @see ImageInsertStartedEvent
409 * @see ImageInsertFailedEvent
410 * @see ImageInsertFinishedEvent
411 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
413 public class InsertToken implements ClientPutCallback {
415 /** The image being inserted. */
416 private final Image image;
418 /** The client putter. */
419 private ClientPutter clientPutter;
421 /** The final URI. */
422 private volatile FreenetURI resultingUri;
425 * Creates a new insert token for the given image.
428 * The image being inserted
430 public InsertToken(Image image) {
439 * Sets the client putter that is inserting the image. This will also
440 * signal all registered listeners that the image has started.
442 * @param clientPutter
445 @SuppressWarnings("synthetic-access")
446 public void setClientPutter(ClientPutter clientPutter) {
447 this.clientPutter = clientPutter;
448 eventBus.post(new ImageInsertStartedEvent(image));
456 * Cancels the running insert.
458 @SuppressWarnings("synthetic-access")
459 public void cancel() {
460 clientPutter.cancel(null, node.clientCore.clientContext);
461 eventBus.post(new ImageInsertAbortedEvent(image));
465 // INTERFACE ClientPutCallback
469 public void onMajorProgress(ObjectContainer objectContainer) {
470 /* ignore, we don’t care. */
474 @SuppressWarnings("synthetic-access")
475 public void onFailure(InsertException insertException, BaseClientPutter clientPutter, ObjectContainer objectContainer) {
476 if ((insertException != null) && ("Cancelled by user".equals(insertException.getMessage()))) {
477 eventBus.post(new ImageInsertAbortedEvent(image));
479 eventBus.post(new ImageInsertFailedEvent(image, insertException));
484 public void onFetchable(BaseClientPutter clientPutter, ObjectContainer objectContainer) {
485 /* ignore, we don’t care. */
489 public void onGeneratedMetadata(Bucket metadata, BaseClientPutter clientPutter, ObjectContainer objectContainer) {
490 /* ignore, we don’t care. */
494 public void onGeneratedURI(FreenetURI generatedUri, BaseClientPutter clientPutter, ObjectContainer objectContainer) {
495 resultingUri = generatedUri;
499 @SuppressWarnings("synthetic-access")
500 public void onSuccess(BaseClientPutter clientPutter, ObjectContainer objectContainer) {
501 eventBus.post(new ImageInsertFinishedEvent(image, resultingUri));