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 javax.inject.Inject;
34 import net.pterodactylus.sone.core.FreenetInterface.Fetched;
35 import net.pterodactylus.sone.data.Sone;
36 import net.pterodactylus.sone.data.Sone.SoneStatus;
37 import net.pterodactylus.util.service.AbstractService;
39 import freenet.client.FetchResult;
40 import freenet.client.async.ClientContext;
41 import freenet.client.async.USKCallback;
42 import freenet.keys.FreenetURI;
43 import freenet.keys.USK;
44 import freenet.node.RequestStarter;
45 import freenet.support.api.Bucket;
47 import com.google.common.annotations.VisibleForTesting;
50 * The Sone downloader is responsible for download Sones as they are updated.
52 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
54 public class SoneDownloaderImpl extends AbstractService implements SoneDownloader {
57 private static final Logger logger = getLogger(SoneDownloaderImpl.class.getName());
59 /** The maximum protocol version. */
60 private static final int MAX_PROTOCOL_VERSION = 0;
63 private final Core core;
64 private final SoneParser soneParser;
66 /** The Freenet interface. */
67 private final FreenetInterface freenetInterface;
69 /** The sones to update. */
70 private final Set<Sone> sones = new HashSet<Sone>();
73 * Creates a new Sone downloader.
77 * @param freenetInterface
78 * The Freenet interface
81 public SoneDownloaderImpl(Core core, FreenetInterface freenetInterface) {
82 this(core, freenetInterface, new SoneParser(core));
86 * Creates a new Sone downloader.
90 * @param freenetInterface
91 * The Freenet interface
95 SoneDownloaderImpl(Core core, FreenetInterface freenetInterface, SoneParser soneParser) {
96 super("Sone Downloader", false);
98 this.freenetInterface = freenetInterface;
99 this.soneParser = soneParser;
107 * Adds the given Sone to the set of Sones that will be watched for updates.
113 public void addSone(final Sone sone) {
114 if (!sones.add(sone)) {
115 freenetInterface.unregisterUsk(sone);
117 final USKCallback uskCallback = new USKCallback() {
120 @SuppressWarnings("synthetic-access")
121 public void onFoundEdition(long edition, USK key,
122 ClientContext clientContext, boolean metadata,
123 short codec, byte[] data, boolean newKnownGood,
124 boolean newSlotToo) {
125 logger.log(Level.FINE, format(
126 "Found USK update for Sone “%s” at %s, new known good: %s, new slot too: %s.",
127 sone, key, newKnownGood, newSlotToo));
128 if (edition > sone.getLatestEdition()) {
129 sone.setLatestEdition(edition);
130 new Thread(fetchSoneAsSskAction(sone),
131 "Sone Downloader").start();
136 public short getPollingPriorityProgress() {
137 return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
141 public short getPollingPriorityNormal() {
142 return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
145 if (soneHasBeenActiveRecently(sone)) {
146 freenetInterface.registerActiveUsk(sone.getRequestUri(),
149 freenetInterface.registerPassiveUsk(sone.getRequestUri(),
154 private boolean soneHasBeenActiveRecently(Sone sone) {
155 return (currentTimeMillis() - sone.getTime()) < DAYS.toMillis(7);
158 private void fetchSoneAsSsk(Sone sone) {
159 fetchSone(sone, sone.getRequestUri().sskForUSK(), false);
163 * Fetches the Sone from the given URI.
168 * The URI of the Sone to fetch
170 * {@code true} to only fetch and parse the Sone, {@code false}
171 * to {@link Core#updateSone(Sone) update} it in the core
172 * @return The downloaded Sone, or {@code null} if the Sone could not be
176 public Sone fetchSone(Sone sone, FreenetURI soneUri, boolean fetchOnly) {
177 logger.log(Level.FINE, String.format("Starting fetch for Sone “%s” from %s…", sone, soneUri));
178 FreenetURI requestUri = soneUri.setMetaString(new String[] { "sone.xml" });
179 sone.setStatus(SoneStatus.downloading);
181 Fetched fetchResults = freenetInterface.fetchUri(requestUri);
182 if (fetchResults == null) {
183 /* TODO - mark Sone as bad. */
186 logger.log(Level.FINEST, String.format("Got %d bytes back.", fetchResults.getFetchResult().size()));
187 Sone parsedSone = parseSone(sone, fetchResults.getFetchResult(), fetchResults.getFreenetUri());
188 if (parsedSone != null) {
190 parsedSone.setStatus((parsedSone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
191 core.updateSone(parsedSone);
197 sone.setStatus((sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
202 * Parses a Sone from a fetch result.
204 * @param originalSone
205 * The sone to parse, or {@code null} if the Sone is yet unknown
210 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
212 private Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
213 logger.log(Level.FINEST, String.format("Parsing FetchResult (%d bytes, %s) for %s…", fetchResult.size(), fetchResult.getMimeType(), originalSone));
214 Bucket soneBucket = fetchResult.asBucket();
215 InputStream soneInputStream = null;
217 soneInputStream = soneBucket.getInputStream();
218 Sone parsedSone = soneParser.parseSone(originalSone,
220 if (parsedSone != null) {
221 parsedSone.setLatestEdition(requestUri.getEdition());
224 } catch (Exception e1) {
225 logger.log(Level.WARNING, String.format("Could not parse Sone from %s!", requestUri), e1);
227 close(soneInputStream);
234 public Runnable fetchSoneAsUskAction(final Sone sone) {
235 return new Runnable() {
238 fetchSone(sone, sone.getRequestUri(), false);
244 public Runnable fetchSoneAsSskAction(final Sone sone) {
245 return new Runnable() {
248 fetchSoneAsSsk(sone);
255 protected void serviceStop() {
256 for (Sone sone : sones) {
257 freenetInterface.unregisterUsk(sone);