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 net.pterodactylus.sone.data.Sone.TO_FREENET_URI;
22 import java.io.InputStream;
23 import java.util.HashSet;
25 import java.util.logging.Level;
26 import java.util.logging.Logger;
28 import net.pterodactylus.sone.core.FreenetInterface.Fetched;
29 import net.pterodactylus.sone.data.Sone;
30 import net.pterodactylus.sone.data.Sone.SoneStatus;
31 import net.pterodactylus.util.io.Closer;
32 import net.pterodactylus.util.logging.Logging;
33 import net.pterodactylus.util.service.AbstractService;
35 import freenet.client.FetchResult;
36 import freenet.keys.FreenetURI;
37 import freenet.support.api.Bucket;
39 import com.google.common.base.Optional;
42 * The Sone downloader is responsible for download Sones as they are updated.
44 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
46 public class SoneDownloader extends AbstractService {
49 private static final Logger logger = Logging.getLogger(SoneDownloader.class);
51 /** The maximum protocol version. */
52 private static final int MAX_PROTOCOL_VERSION = 0;
55 private final Core core;
57 /** The Freenet interface. */
58 private final FreenetInterface freenetInterface;
60 /** The sones to update. */
61 private final Set<Sone> sones = new HashSet<Sone>();
64 * Creates a new Sone downloader.
68 * @param freenetInterface
69 * The Freenet interface
71 public SoneDownloader(Core core, FreenetInterface freenetInterface) {
72 super("Sone Downloader", false);
74 this.freenetInterface = freenetInterface;
82 * Adds the given Sone to the set of Sones that will be watched for updates.
87 public void addSone(Sone sone) {
88 if (!sones.add(sone)) {
89 freenetInterface.unregisterUsk(sone);
91 freenetInterface.registerUsk(sone, this);
95 * Removes the given Sone from the downloader.
98 * The Sone to stop watching
100 public void removeSone(Sone sone) {
101 if (sones.remove(sone)) {
102 freenetInterface.unregisterUsk(sone);
107 * Fetches the updated Sone. This method is a callback method for
108 * {@link FreenetInterface#registerUsk(Sone, SoneDownloader)}.
113 public void fetchSone(Sone sone) {
114 fetchSone(sone, TO_FREENET_URI.apply(sone).sskForUSK());
118 * Fetches the updated Sone. This method can be used to fetch a Sone from a
124 * The URI to fetch the Sone from
126 public void fetchSone(Sone sone, FreenetURI soneUri) {
127 fetchSone(sone, soneUri, false);
131 * Fetches the Sone from the given URI.
136 * The URI of the Sone to fetch
138 * {@code true} to only fetch and parse the Sone, {@code false}
139 * to {@link Core#updateSone(Sone) update} it in the core
140 * @return The downloaded Sone, or {@code null} if the Sone could not be
143 public Optional<Sone> fetchSone(Sone sone, FreenetURI soneUri, boolean fetchOnly) {
144 logger.log(Level.FINE, String.format("Starting fetch for Sone “%s” from %s…", sone, soneUri));
145 FreenetURI requestUri = soneUri.setMetaString(new String[] { "sone.xml" });
146 sone.setStatus(SoneStatus.downloading);
148 Fetched fetchResults = freenetInterface.fetchUri(requestUri);
149 if (fetchResults == null) {
150 /* TODO - mark Sone as bad. */
153 logger.log(Level.FINEST, String.format("Got %d bytes back.", fetchResults.getFetchResult().size()));
154 Optional<Sone> parsedSone = parseSone(sone, fetchResults.getFetchResult(), fetchResults.getFreenetUri());
155 if (parsedSone.isPresent()) {
157 parsedSone.get().setStatus((parsedSone.get().getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
158 core.updateSone(parsedSone.get());
159 addSone(parsedSone.get());
164 sone.setStatus((sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
169 * Parses a Sone from a fetch result.
171 * @param originalSone
172 * The sone to parse, or {@code null} if the Sone is yet unknown
177 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
179 public Optional<Sone> parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
180 logger.log(Level.FINEST, String.format("Parsing FetchResult (%d bytes, %s) for %s…", fetchResult.size(), fetchResult.getMimeType(), originalSone));
181 Bucket soneBucket = fetchResult.asBucket();
182 InputStream soneInputStream = null;
184 soneInputStream = soneBucket.getInputStream();
185 Optional<Sone> parsedSone = parseSone(originalSone, soneInputStream);
186 if (parsedSone.isPresent()) {
187 parsedSone.get().modify().setLatestEdition(requestUri.getEdition()).update();
190 } catch (Exception e1) {
191 logger.log(Level.WARNING, String.format("Could not parse Sone from %s!", requestUri), e1);
193 Closer.close(soneInputStream);
200 * Parses a Sone from the given input stream and creates a new Sone from the
203 * @param originalSone
205 * @param soneInputStream
206 * The input stream to parse the Sone from
207 * @return The parsed Sone
209 public Optional<Sone> parseSone(Sone originalSone, InputStream soneInputStream) {
210 return new SoneParser().parseSone(core.getDatabase(), originalSone, soneInputStream);
218 protected void serviceStop() {
219 for (Sone sone : sones) {
220 freenetInterface.unregisterUsk(sone);