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.data.Sone;
35 import net.pterodactylus.sone.data.Sone.SoneStatus;
36 import net.pterodactylus.util.service.AbstractService;
38 import freenet.client.FetchResult;
39 import freenet.client.async.ClientContext;
40 import freenet.client.async.USKCallback;
41 import freenet.keys.FreenetURI;
42 import freenet.keys.USK;
43 import freenet.node.RequestStarter;
44 import freenet.support.api.Bucket;
47 * The Sone downloader is responsible for download Sones as they are updated.
49 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
51 public class SoneDownloaderImpl extends AbstractService implements SoneDownloader {
54 private static final Logger logger = getLogger(SoneDownloaderImpl.class.getName());
56 /** The maximum protocol version. */
57 private static final int MAX_PROTOCOL_VERSION = 0;
60 private final Core core;
61 private final SoneParser soneParser;
63 /** The Freenet interface. */
64 private final FreenetInterface freenetInterface;
66 /** The sones to update. */
67 private final Set<Sone> sones = new HashSet<Sone>();
70 * Creates a new Sone downloader.
74 * @param freenetInterface
75 * The Freenet interface
79 SoneDownloaderImpl(Core core, FreenetInterface freenetInterface, SoneParser soneParser) {
80 super("Sone Downloader", false);
82 this.freenetInterface = freenetInterface;
83 this.soneParser = soneParser;
91 * Adds the given Sone to the set of Sones that will be watched for updates.
97 public void addSone(final Sone sone) {
98 if (!sones.add(sone)) {
99 freenetInterface.unregisterUsk(sone);
101 final USKCallback uskCallback = new USKCallback() {
104 @SuppressWarnings("synthetic-access")
105 public void onFoundEdition(long edition, USK key,
106 ClientContext clientContext, boolean metadata,
107 short codec, byte[] data, boolean newKnownGood,
108 boolean newSlotToo) {
109 logger.log(Level.FINE, format(
110 "Found USK update for Sone “%s” at %s, new known good: %s, new slot too: %s.",
111 sone, key, newKnownGood, newSlotToo));
112 if (edition > sone.getLatestEdition()) {
113 sone.setLatestEdition(edition);
114 new Thread(fetchSoneAsSskAction(sone),
115 "Sone Downloader").start();
120 public short getPollingPriorityProgress() {
121 return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
125 public short getPollingPriorityNormal() {
126 return RequestStarter.INTERACTIVE_PRIORITY_CLASS;
129 if (soneHasBeenActiveRecently(sone)) {
130 freenetInterface.registerActiveUsk(sone.getRequestUri(),
133 freenetInterface.registerPassiveUsk(sone.getRequestUri(),
138 private boolean soneHasBeenActiveRecently(Sone sone) {
139 return (currentTimeMillis() - sone.getTime()) < DAYS.toMillis(7);
142 private void fetchSoneAsSsk(Sone sone) {
143 fetchSone(sone, sone.getRequestUri().sskForUSK(), false);
147 * Fetches the Sone from the given URI.
152 * The URI of the Sone to fetch
154 * {@code true} to only fetch and parse the Sone, {@code false}
155 * to {@link Core#updateSone(Sone) update} it in the core
156 * @return The downloaded Sone, or {@code null} if the Sone could not be
160 public Sone fetchSone(Sone sone, FreenetURI soneUri, boolean fetchOnly) {
161 logger.log(Level.FINE, String.format("Starting fetch for Sone “%s” from %s…", sone, soneUri));
162 FreenetURI requestUri = soneUri.setMetaString(new String[] { "sone.xml" });
163 sone.setStatus(SoneStatus.downloading);
165 Fetched fetchResults = freenetInterface.fetchUri(requestUri);
166 if (fetchResults == null) {
167 /* TODO - mark Sone as bad. */
170 logger.log(Level.FINEST, String.format("Got %d bytes back.", fetchResults.getFetchResult().size()));
171 Sone parsedSone = parseSone(sone, fetchResults.getFetchResult(), fetchResults.getFreenetUri());
172 if (parsedSone != null) {
174 parsedSone.setStatus((parsedSone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
175 core.updateSone(parsedSone);
181 sone.setStatus((sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
186 * Parses a Sone from a fetch result.
188 * @param originalSone
189 * The sone to parse, or {@code null} if the Sone is yet unknown
194 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
196 private Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
197 logger.log(Level.FINEST, String.format("Parsing FetchResult (%d bytes, %s) for %s…", fetchResult.size(), fetchResult.getMimeType(), originalSone));
198 Bucket soneBucket = fetchResult.asBucket();
199 InputStream soneInputStream = null;
201 soneInputStream = soneBucket.getInputStream();
202 Sone parsedSone = soneParser.parseSone(originalSone,
204 if (parsedSone != null) {
205 parsedSone.setLatestEdition(requestUri.getEdition());
208 } catch (Exception e1) {
209 logger.log(Level.WARNING, String.format("Could not parse Sone from %s!", requestUri), e1);
211 close(soneInputStream);
218 public Runnable fetchSoneAsUskAction(final Sone sone) {
219 return new Runnable() {
222 fetchSone(sone, sone.getRequestUri(), false);
228 public Runnable fetchSoneAsSskAction(final Sone sone) {
229 return new Runnable() {
232 fetchSoneAsSsk(sone);
239 protected void serviceStop() {
240 for (Sone sone : sones) {
241 freenetInterface.unregisterUsk(sone);