2 * Sone - SoneDownloader.java - Copyright © 2010 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 java.io.IOException;
21 import java.io.InputStream;
22 import java.net.MalformedURLException;
23 import java.util.HashSet;
25 import java.util.logging.Level;
26 import java.util.logging.Logger;
28 import net.pterodactylus.sone.core.Core.SoneStatus;
29 import net.pterodactylus.sone.data.Client;
30 import net.pterodactylus.sone.data.Post;
31 import net.pterodactylus.sone.data.Profile;
32 import net.pterodactylus.sone.data.Reply;
33 import net.pterodactylus.sone.data.Sone;
34 import net.pterodactylus.util.collection.Pair;
35 import net.pterodactylus.util.io.Closer;
36 import net.pterodactylus.util.logging.Logging;
37 import net.pterodactylus.util.number.Numbers;
38 import net.pterodactylus.util.service.AbstractService;
39 import net.pterodactylus.util.xml.SimpleXML;
40 import net.pterodactylus.util.xml.XML;
42 import org.w3c.dom.Document;
44 import freenet.client.FetchResult;
45 import freenet.keys.FreenetURI;
46 import freenet.support.api.Bucket;
49 * The Sone downloader is responsible for download Sones as they are updated.
51 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
53 public class SoneDownloader extends AbstractService {
56 private static final Logger logger = Logging.getLogger(SoneDownloader.class);
59 private final Core core;
61 /** The Freenet interface. */
62 private final FreenetInterface freenetInterface;
64 /** The sones to update. */
65 private final Set<Sone> sones = new HashSet<Sone>();
68 * Creates a new Sone downloader.
72 * @param freenetInterface
73 * The Freenet interface
75 public SoneDownloader(Core core, FreenetInterface freenetInterface) {
76 super("Sone Downloader", false);
78 this.freenetInterface = freenetInterface;
86 * Adds the given Sone to the set of Sones that will be watched for updates.
91 public void addSone(Sone sone) {
92 if (sones.add(sone)) {
93 freenetInterface.registerUsk(sone, this);
98 * Removes the given Sone from the downloader.
101 * The Sone to stop watching
103 public void removeSone(Sone sone) {
104 if (sones.remove(sone)) {
105 freenetInterface.unregisterUsk(sone);
110 * Fetches the updated Sone. This method is a callback method for
111 * {@link FreenetInterface#registerUsk(Sone, SoneDownloader)}.
116 public void fetchSone(Sone sone) {
117 fetchSone(sone, sone.getRequestUri());
121 * Fetches the updated Sone. This method can be used to fetch a Sone from a
122 * specific URI (which happens when {@link Core#isSoneRescueMode() „Sone
123 * rescue mode“} is active).
128 * The URI to fetch the Sone from
130 public void fetchSone(Sone sone, FreenetURI soneUri) {
131 if (core.getSoneStatus(sone) == SoneStatus.downloading) {
134 logger.log(Level.FINE, "Starting fetch for Sone “%s” from %s…", new Object[] { sone, soneUri });
135 FreenetURI requestUri = soneUri.setMetaString(new String[] { "sone.xml" });
136 core.setSoneStatus(sone, SoneStatus.downloading);
138 Pair<FreenetURI, FetchResult> fetchResults = freenetInterface.fetchUri(requestUri);
139 if (fetchResults == null) {
140 /* TODO - mark Sone as bad. */
143 logger.log(Level.FINEST, "Got %d bytes back.", fetchResults.getRight().size());
144 Sone parsedSone = parseSone(sone, fetchResults.getRight(), fetchResults.getLeft());
145 if (parsedSone != null) {
146 core.updateSone(parsedSone);
149 core.setSoneStatus(sone, (sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
154 * Parses a Sone from a fetch result.
156 * @param originalSone
157 * The sone to parse, or {@code null} if the Sone is yet unknown
162 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
164 public Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
165 logger.log(Level.FINEST, "Parsing FetchResult (%d bytes, %s) for %s…", new Object[] { fetchResult.size(), fetchResult.getMimeType(), originalSone });
166 Bucket soneBucket = fetchResult.asBucket();
167 InputStream soneInputStream = null;
169 soneInputStream = soneBucket.getInputStream();
170 Sone parsedSone = parseSone(originalSone, soneInputStream);
171 if (parsedSone != null) {
172 if (requestUri.getKeyType().equals("USK")) {
173 parsedSone.setRequestUri(requestUri.setMetaString(new String[0]));
175 parsedSone.setRequestUri(requestUri.setKeyType("USK").setDocName("Sone").setMetaString(new String[0]));
179 } catch (IOException ioe1) {
180 logger.log(Level.WARNING, "Could not parse Sone from " + requestUri + "!", ioe1);
182 Closer.close(soneInputStream);
189 * Parses a Sone from the given input stream and creates a new Sone from the
192 * @param originalSone
194 * @param soneInputStream
195 * The input stream to parse the Sone from
196 * @return The parsed Sone
198 public Sone parseSone(Sone originalSone, InputStream soneInputStream) {
199 /* TODO - impose a size limit? */
202 /* XML parsing is not thread-safe. */
203 synchronized (this) {
204 document = XML.transformToDocument(soneInputStream);
206 if (document == null) {
207 /* TODO - mark Sone as bad. */
208 logger.log(Level.WARNING, "Could not parse XML for Sone %s!", new Object[] { originalSone });
212 Sone sone = new Sone(originalSone.getId()).setIdentity(originalSone.getIdentity());
216 soneXml = SimpleXML.fromDocument(document);
217 } catch (NullPointerException npe1) {
218 /* for some reason, invalid XML can cause NPEs. */
219 logger.log(Level.WARNING, "XML for Sone " + sone + " can not be parsed!", npe1);
223 String soneTime = soneXml.getValue("time", null);
224 if (soneTime == null) {
225 /* TODO - mark Sone as bad. */
226 logger.log(Level.WARNING, "Downloaded time for Sone %s was null!", new Object[] { sone });
230 sone.setTime(Long.parseLong(soneTime));
231 } catch (NumberFormatException nfe1) {
232 /* TODO - mark Sone as bad. */
233 logger.log(Level.WARNING, "Downloaded Sone %s with invalid time: %s", new Object[] { sone, soneTime });
237 SimpleXML clientXml = soneXml.getNode("client");
238 if (clientXml != null) {
239 String clientName = clientXml.getValue("name", null);
240 String clientVersion = clientXml.getValue("version", null);
241 if ((clientName == null) || (clientVersion == null)) {
242 logger.log(Level.WARNING, "Download Sone %s with client XML but missing name or version!", sone);
245 sone.setClient(new Client(clientName, clientVersion));
248 String soneRequestUri = soneXml.getValue("request-uri", null);
249 if (soneRequestUri != null) {
251 sone.setRequestUri(new FreenetURI(soneRequestUri));
252 } catch (MalformedURLException mue1) {
253 /* TODO - mark Sone as bad. */
254 logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid request URI: " + soneRequestUri, mue1);
259 String soneInsertUri = soneXml.getValue("insert-uri", null);
260 if ((soneInsertUri != null) && (sone.getInsertUri() == null)) {
262 sone.setInsertUri(new FreenetURI(soneInsertUri));
263 sone.setLatestEdition(Math.max(sone.getRequestUri().getSuggestedEdition(), sone.getInsertUri().getSuggestedEdition()));
264 } catch (MalformedURLException mue1) {
265 /* TODO - mark Sone as bad. */
266 logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid insert URI: " + soneInsertUri, mue1);
271 SimpleXML profileXml = soneXml.getNode("profile");
272 if (profileXml == null) {
273 /* TODO - mark Sone as bad. */
274 logger.log(Level.WARNING, "Downloaded Sone %s has no profile!", new Object[] { sone });
279 String profileFirstName = profileXml.getValue("first-name", null);
280 String profileMiddleName = profileXml.getValue("middle-name", null);
281 String profileLastName = profileXml.getValue("last-name", null);
282 Integer profileBirthDay = Numbers.safeParseInteger(profileXml.getValue("birth-day", null));
283 Integer profileBirthMonth = Numbers.safeParseInteger(profileXml.getValue("birth-month", null));
284 Integer profileBirthYear = Numbers.safeParseInteger(profileXml.getValue("birth-year", null));
285 Profile profile = new Profile().setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
286 profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
289 SimpleXML postsXml = soneXml.getNode("posts");
290 Set<Post> posts = new HashSet<Post>();
291 if (postsXml == null) {
292 /* TODO - mark Sone as bad. */
293 logger.log(Level.WARNING, "Downloaded Sone %s has no posts!", new Object[] { sone });
295 for (SimpleXML postXml : postsXml.getNodes("post")) {
296 String postId = postXml.getValue("id", null);
297 String postTime = postXml.getValue("time", null);
298 String postText = postXml.getValue("text", null);
299 if ((postId == null) || (postTime == null) || (postText == null)) {
300 /* TODO - mark Sone as bad. */
301 logger.log(Level.WARNING, "Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", new Object[] { sone, postId, postTime, postText });
305 posts.add(core.getPost(postId).setSone(sone).setTime(Long.parseLong(postTime)).setText(postText));
306 } catch (NumberFormatException nfe1) {
307 /* TODO - mark Sone as bad. */
308 logger.log(Level.WARNING, "Downloaded post for Sone %s with invalid time: %s", new Object[] { sone, postTime });
315 SimpleXML repliesXml = soneXml.getNode("replies");
316 Set<Reply> replies = new HashSet<Reply>();
317 if (repliesXml == null) {
318 /* TODO - mark Sone as bad. */
319 logger.log(Level.WARNING, "Downloaded Sone %s has no replies!", new Object[] { sone });
321 for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
322 String replyId = replyXml.getValue("id", null);
323 String replyPostId = replyXml.getValue("post-id", null);
324 String replyTime = replyXml.getValue("time", null);
325 String replyText = replyXml.getValue("text", null);
326 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
327 /* TODO - mark Sone as bad. */
328 logger.log(Level.WARNING, "Downloaded reply for Sone %s with missing data! ID: %s, Post: %s, Time: %s, Text: %s", new Object[] { sone, replyId, replyPostId, replyTime, replyText });
332 replies.add(core.getReply(replyId).setSone(sone).setPost(core.getPost(replyPostId)).setTime(Long.parseLong(replyTime)).setText(replyText));
333 } catch (NumberFormatException nfe1) {
334 /* TODO - mark Sone as bad. */
335 logger.log(Level.WARNING, "Downloaded reply for Sone %s with invalid time: %s", new Object[] { sone, replyTime });
341 /* parse liked post IDs. */
342 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
343 Set<String> likedPostIds = new HashSet<String>();
344 if (likePostIdsXml == null) {
345 /* TODO - mark Sone as bad. */
346 logger.log(Level.WARNING, "Downloaded Sone %s has no post likes!", new Object[] { sone });
348 for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
349 String postId = likedPostIdXml.getValue();
350 likedPostIds.add(postId);
354 /* parse liked reply IDs. */
355 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
356 Set<String> likedReplyIds = new HashSet<String>();
357 if (likeReplyIdsXml == null) {
358 /* TODO - mark Sone as bad. */
359 logger.log(Level.WARNING, "Downloaded Sone %s has no reply likes!", new Object[] { sone });
361 for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
362 String replyId = likedReplyIdXml.getValue();
363 likedReplyIds.add(replyId);
367 /* okay, apparently everything was parsed correctly. Now import. */
368 /* atomic setter operation on the Sone. */
369 synchronized (sone) {
370 sone.setProfile(profile);
371 sone.setPosts(posts);
372 sone.setReplies(replies);
373 sone.setLikePostIds(likedPostIds);
387 protected void serviceStop() {
388 for (Sone sone : sones) {
389 freenetInterface.unregisterUsk(sone);