2 * Sone - SoneDownloaderImpl.java - Copyright © 2010–2016 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 static freenet.support.io.Closer.close;
21 import static java.lang.String.format;
22 import static java.lang.System.currentTimeMillis;
23 import static java.util.concurrent.TimeUnit.DAYS;
24 import static java.util.logging.Logger.getLogger;
26 import java.io.InputStream;
27 import java.util.HashSet;
29 import java.util.logging.Level;
30 import java.util.logging.Logger;
32 import net.pterodactylus.sone.core.FreenetInterface.Fetched;
33 import net.pterodactylus.sone.data.Sone;
34 import net.pterodactylus.sone.data.Sone.SoneStatus;
35 import net.pterodactylus.util.service.AbstractService;
37 import freenet.client.FetchResult;
38 import freenet.client.async.ClientContext;
39 import freenet.client.async.USKCallback;
40 import freenet.keys.FreenetURI;
41 import freenet.keys.USK;
42 import freenet.node.RequestStarter;
43 import freenet.support.api.Bucket;
45 import com.google.common.annotations.VisibleForTesting;
48 * The Sone downloader is responsible for download Sones as they are updated.
50 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
52 public class SoneDownloaderImpl extends AbstractService implements SoneDownloader {
55 private static final Logger logger = getLogger(SoneDownloaderImpl.class.getName());
57 /** The maximum protocol version. */
58 private static final int MAX_PROTOCOL_VERSION = 0;
61 private final Core core;
62 private final SoneParser soneParser;
64 /** The Freenet interface. */
65 private final FreenetInterface freenetInterface;
67 /** The sones to update. */
68 private final Set<Sone> sones = new HashSet<Sone>();
71 * Creates a new Sone downloader.
75 * @param freenetInterface
76 * The Freenet interface
78 public SoneDownloaderImpl(Core core, FreenetInterface freenetInterface) {
79 this(core, freenetInterface, new SoneParser(core));
83 * Creates a new Sone downloader.
87 * @param freenetInterface
88 * The Freenet interface
92 SoneDownloaderImpl(Core core, FreenetInterface freenetInterface, SoneParser soneParser) {
93 super("Sone Downloader", false);
95 this.freenetInterface = freenetInterface;
96 this.soneParser = soneParser;
104 * Adds the given Sone to the set of Sones that will be watched for updates.
110 public void addSone(final Sone sone) {
111 if (!sones.add(sone)) {
112 freenetInterface.unregisterUsk(sone);
114 final USKCallback uskCallback = new USKCallback() {
117 @SuppressWarnings("synthetic-access")
118 public void onFoundEdition(long edition, USK key,
119 ClientContext clientContext, boolean metadata,
120 short codec, byte[] data, boolean newKnownGood,
121 boolean newSlotToo) {
122 logger.log(Level.FINE, format(
123 "Found USK update for Sone “%s” at %s, new known good: %s, new slot too: %s.",
124 sone, key, newKnownGood, newSlotToo));
125 if (edition > sone.getLatestEdition()) {
126 sone.setLatestEdition(edition);
127 new Thread(fetchSoneAction(sone),
128 "Sone Downloader").start();
133 public short getPollingPriorityProgress() {
134 return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
138 public short getPollingPriorityNormal() {
139 return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
142 if (soneHasBeenActiveRecently(sone)) {
143 freenetInterface.registerActiveUsk(sone.getRequestUri(),
146 freenetInterface.registerPassiveUsk(sone.getRequestUri(),
151 private boolean soneHasBeenActiveRecently(Sone sone) {
152 return (currentTimeMillis() - sone.getTime()) < DAYS.toMillis(7);
155 private void fetchSone(Sone sone) {
156 fetchSone(sone, sone.getRequestUri().sskForUSK());
160 * Fetches the updated Sone. This method can be used to fetch a Sone from a
166 * The URI to fetch the Sone from
169 public void fetchSone(Sone sone, FreenetURI soneUri) {
170 fetchSone(sone, soneUri, false);
174 * Fetches the Sone from the given URI.
179 * The URI of the Sone to fetch
181 * {@code true} to only fetch and parse the Sone, {@code false}
182 * to {@link Core#updateSone(Sone) update} it in the core
183 * @return The downloaded Sone, or {@code null} if the Sone could not be
187 public Sone fetchSone(Sone sone, FreenetURI soneUri, boolean fetchOnly) {
188 logger.log(Level.FINE, String.format("Starting fetch for Sone “%s” from %s…", sone, soneUri));
189 FreenetURI requestUri = soneUri.setMetaString(new String[] { "sone.xml" });
190 sone.setStatus(SoneStatus.downloading);
192 Fetched fetchResults = freenetInterface.fetchUri(requestUri);
193 if (fetchResults == null) {
194 /* TODO - mark Sone as bad. */
197 logger.log(Level.FINEST, String.format("Got %d bytes back.", fetchResults.getFetchResult().size()));
198 Sone parsedSone = parseSone(sone, fetchResults.getFetchResult(), fetchResults.getFreenetUri());
199 if (parsedSone != null) {
201 parsedSone.setStatus((parsedSone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
202 core.updateSone(parsedSone);
208 sone.setStatus((sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
213 * Parses a Sone from a fetch result.
215 * @param originalSone
216 * The sone to parse, or {@code null} if the Sone is yet unknown
221 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
223 private Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
224 logger.log(Level.FINEST, String.format("Parsing FetchResult (%d bytes, %s) for %s…", fetchResult.size(), fetchResult.getMimeType(), originalSone));
225 Bucket soneBucket = fetchResult.asBucket();
226 InputStream soneInputStream = null;
228 soneInputStream = soneBucket.getInputStream();
229 Sone parsedSone = soneParser.parseSone(originalSone,
231 if (parsedSone != null) {
232 parsedSone.setLatestEdition(requestUri.getEdition());
235 } catch (Exception e1) {
236 logger.log(Level.WARNING, String.format("Could not parse Sone from %s!", requestUri), e1);
238 close(soneInputStream);
245 public Runnable fetchSoneWithUriAction(final Sone sone) {
246 return new Runnable() {
249 fetchSone(sone, sone.getRequestUri());
255 public Runnable fetchSoneAction(final Sone sone) {
256 return new Runnable() {
266 protected void serviceStop() {
267 for (Sone sone : sones) {
268 freenetInterface.unregisterUsk(sone);