2 * Sone - SoneDownloader.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 static java.util.logging.Level.FINER;
21 import static net.pterodactylus.sone.data.Sone.TO_FREENET_URI;
23 import java.io.InputStream;
24 import java.util.HashSet;
26 import java.util.logging.Level;
27 import java.util.logging.Logger;
29 import net.pterodactylus.sone.core.FreenetInterface.Fetched;
30 import net.pterodactylus.sone.data.Sone;
31 import net.pterodactylus.sone.data.Sone.SoneStatus;
32 import net.pterodactylus.util.io.Closer;
33 import net.pterodactylus.util.logging.Logging;
34 import net.pterodactylus.util.service.AbstractService;
36 import freenet.client.FetchResult;
37 import freenet.keys.FreenetURI;
38 import freenet.support.api.Bucket;
41 * The Sone downloader is responsible for download Sones as they are updated.
43 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
45 public class SoneDownloader extends AbstractService {
48 private static final Logger logger = Logging.getLogger(SoneDownloader.class);
50 /** The maximum protocol version. */
51 private static final int MAX_PROTOCOL_VERSION = 0;
54 private final Core core;
56 /** The Freenet interface. */
57 private final FreenetInterface freenetInterface;
59 /** The sones to update. */
60 private final Set<Sone> sones = new HashSet<Sone>();
63 * Creates a new Sone downloader.
67 * @param freenetInterface
68 * The Freenet interface
70 public SoneDownloader(Core core, FreenetInterface freenetInterface) {
71 super("Sone Downloader", false);
73 this.freenetInterface = freenetInterface;
81 * Adds the given Sone to the set of Sones that will be watched for updates.
86 public void addSone(Sone sone) {
87 if (!sones.add(sone)) {
88 freenetInterface.unregisterUsk(sone);
90 freenetInterface.registerUsk(sone, this);
94 * Removes the given Sone from the downloader.
97 * The Sone to stop watching
99 public void removeSone(Sone sone) {
100 if (sones.remove(sone)) {
101 freenetInterface.unregisterUsk(sone);
106 * Fetches the updated Sone. This method is a callback method for
107 * {@link FreenetInterface#registerUsk(Sone, SoneDownloader)}.
112 public void fetchSone(Sone sone) {
113 fetchSone(sone, TO_FREENET_URI.apply(sone).sskForUSK());
117 * Fetches the updated Sone. This method can be used to fetch a Sone from a
123 * The URI to fetch the Sone from
125 public void fetchSone(Sone sone, FreenetURI soneUri) {
126 fetchSone(sone, soneUri, false);
130 * Fetches the Sone from the given URI.
135 * The URI of the Sone to fetch
137 * {@code true} to only fetch and parse the Sone, {@code false}
138 * to {@link Core#updateSone(Sone) update} it in the core
139 * @return The downloaded Sone, or {@code null} if the Sone could not be
142 public Sone fetchSone(Sone sone, FreenetURI soneUri, boolean fetchOnly) {
143 logger.log(Level.FINE, String.format("Starting fetch for Sone “%s” from %s…", sone, soneUri));
144 FreenetURI requestUri = soneUri.setMetaString(new String[] { "sone.xml" });
145 sone.setStatus(SoneStatus.downloading);
147 Fetched fetchResults = freenetInterface.fetchUri(requestUri);
148 if (fetchResults == null) {
149 /* TODO - mark Sone as bad. */
153 logger.log(FINER, "Sone was stopped, won’t process download.");
156 logger.log(Level.FINEST, String.format("Got %d bytes back.", fetchResults.getFetchResult().size()));
157 Sone parsedSone = parseSone(sone, fetchResults.getFetchResult(), fetchResults.getFreenetUri());
158 if (parsedSone != null) {
160 parsedSone.setStatus((parsedSone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
161 core.updateSone(parsedSone);
167 sone.setStatus((sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
172 * Parses a Sone from a fetch result.
174 * @param originalSone
175 * The sone to parse, or {@code null} if the Sone is yet unknown
180 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
182 public Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
183 logger.log(Level.FINEST, String.format("Parsing FetchResult (%d bytes, %s) for %s…", fetchResult.size(), fetchResult.getMimeType(), originalSone));
184 Bucket soneBucket = fetchResult.asBucket();
185 InputStream soneInputStream = null;
187 soneInputStream = soneBucket.getInputStream();
188 Sone parsedSone = parseSone(originalSone, soneInputStream);
189 if (parsedSone != null) {
190 parsedSone.modify().setLatestEdition(requestUri.getEdition()).update();
193 } catch (Exception e1) {
194 logger.log(Level.WARNING, String.format("Could not parse Sone from %s!", requestUri), e1);
196 Closer.close(soneInputStream);
203 * Parses a Sone from the given input stream and creates a new Sone from the
206 * @param originalSone
208 * @param soneInputStream
209 * The input stream to parse the Sone from
210 * @return The parsed Sone
212 public Sone parseSone(Sone originalSone, InputStream soneInputStream) {
213 return new SoneParser().parseSone(core.getDatabase(), originalSone, soneInputStream);
221 protected void serviceStop() {
222 for (Sone sone : sones) {
223 freenetInterface.unregisterUsk(sone);