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.Post;
30 import net.pterodactylus.sone.data.Profile;
31 import net.pterodactylus.sone.data.Reply;
32 import net.pterodactylus.sone.data.Sone;
33 import net.pterodactylus.util.io.Closer;
34 import net.pterodactylus.util.logging.Logging;
35 import net.pterodactylus.util.number.Numbers;
36 import net.pterodactylus.util.service.AbstractService;
37 import net.pterodactylus.util.xml.SimpleXML;
38 import net.pterodactylus.util.xml.XML;
40 import org.w3c.dom.Document;
42 import freenet.client.FetchResult;
43 import freenet.keys.FreenetURI;
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 SoneDownloader extends AbstractService {
54 private static final Logger logger = Logging.getLogger(SoneDownloader.class);
57 private final Core core;
59 /** The Freenet interface. */
60 private final FreenetInterface freenetInterface;
62 /** The sones to update. */
63 private final Set<Sone> sones = new HashSet<Sone>();
66 * Creates a new Sone downloader.
70 * @param freenetInterface
71 * The Freenet interface
73 public SoneDownloader(Core core, FreenetInterface freenetInterface) {
74 super("Sone Downloader", false);
76 this.freenetInterface = freenetInterface;
84 * Adds the given Sone to the set of Sones that will be watched for updates.
89 public void addSone(Sone sone) {
90 if (sones.add(sone)) {
91 freenetInterface.registerUsk(sone, this);
96 * Removes the given Sone from the downloader.
99 * The Sone to stop watching
101 public void removeSone(Sone sone) {
102 if (sones.remove(sone)) {
103 freenetInterface.unregisterUsk(sone);
108 * Fetches the updated Sone. This method is a callback method for
109 * {@link FreenetInterface#registerUsk(Sone, SoneDownloader)}.
114 public void fetchSone(Sone sone) {
115 if (core.getSoneStatus(sone) == SoneStatus.downloading) {
118 logger.log(Level.FINE, "Starting fetch for Sone “%s” from %s…", new Object[] { sone, sone.getRequestUri().setMetaString(new String[] { "sone.xml" }) });
119 FreenetURI requestUri = sone.getRequestUri().setMetaString(new String[] { "sone.xml" });
120 core.setSoneStatus(sone, SoneStatus.downloading);
122 FetchResult fetchResult = freenetInterface.fetchUri(requestUri);
123 if (fetchResult == null) {
124 /* TODO - mark Sone as bad. */
127 logger.log(Level.FINEST, "Got %d bytes back.", fetchResult.size());
128 Sone parsedSone = parseSone(sone, fetchResult, requestUri);
129 if (parsedSone != null) {
130 core.addSone(parsedSone);
133 core.setSoneStatus(sone, (sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
138 * Parses a Sone from a fetch result.
140 * @param originalSone
141 * The sone to parse, or {@code null} if the Sone is yet unknown
146 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
148 public Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
149 logger.log(Level.FINEST, "Persing FetchResult (%d bytes, %s) for %s…", new Object[] { fetchResult.size(), fetchResult.getMimeType(), originalSone });
150 Bucket soneBucket = fetchResult.asBucket();
151 InputStream soneInputStream = null;
153 soneInputStream = soneBucket.getInputStream();
154 Sone parsedSone = parseSone(originalSone, soneInputStream);
155 if (parsedSone != null) {
156 parsedSone.setRequestUri(requestUri.setMetaString(new String[0]));
159 } catch (IOException ioe1) {
160 logger.log(Level.WARNING, "Could not parse Sone from " + requestUri + "!", ioe1);
162 Closer.close(soneInputStream);
169 * Parses a Sone from the given input stream.
171 * @param soneInputStream
172 * The input stream to parse the Sone from
173 * @return The parsed Sone
175 public Sone parseSone(InputStream soneInputStream) {
176 return parseSone(null, soneInputStream);
180 * Parses a Sone from the given input stream and updates the given Sone, or
181 * creates a new Sone.
183 * @param originalSone
184 * The Sone to update (may be {@code null})
185 * @param soneInputStream
186 * The input stream to parse the Sone from
187 * @return The parsed Sone
189 public Sone parseSone(Sone originalSone, InputStream soneInputStream) {
190 /* TODO - impose a size limit? */
194 /* XML parsing is not thread-safe. */
195 synchronized (this) {
196 document = XML.transformToDocument(soneInputStream);
198 if (document == null) {
199 /* TODO - mark Sone as bad. */
200 logger.log(Level.WARNING, "Could not parse XML for Sone %s!", new Object[] { originalSone });
205 soneXml = SimpleXML.fromDocument(document);
206 } catch (NullPointerException npe1) {
207 /* for some reason, invalid XML can cause NPEs. */
208 logger.log(Level.WARNING, "XML for Sone " + originalSone + " can not be parsed!", npe1);
213 String soneId = soneXml.getValue("id", null);
214 if ((originalSone != null) && !originalSone.getId().equals(soneId)) {
215 /* TODO - mark Sone as bad. */
216 logger.log(Level.WARNING, "Downloaded ID for Sone %s (%s) does not match known ID (%s)!", new Object[] { originalSone, originalSone.getId(), soneId });
220 /* load Sone from core. */
223 sone = core.getSone(soneId);
226 String soneName = soneXml.getValue("name", null);
227 if (soneName == null) {
228 /* TODO - mark Sone as bad. */
229 logger.log(Level.WARNING, "Downloaded name for Sone %s was null!", new Object[] { sone });
232 sone.setName(soneName);
234 String soneTime = soneXml.getValue("time", null);
235 if (soneTime == null) {
236 /* TODO - mark Sone as bad. */
237 logger.log(Level.WARNING, "Downloaded time for Sone %s was null!", new Object[] { sone });
241 sone.setTime(Long.parseLong(soneTime));
242 } catch (NumberFormatException nfe1) {
243 /* TODO - mark Sone as bad. */
244 logger.log(Level.WARNING, "Downloaded Sone %s with invalid time: %s", new Object[] { sone, soneTime });
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) {
262 sone.setInsertUri(new FreenetURI(soneInsertUri));
263 } catch (MalformedURLException mue1) {
264 /* TODO - mark Sone as bad. */
265 logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid insert URI: " + soneInsertUri, mue1);
270 SimpleXML profileXml = soneXml.getNode("profile");
271 if (profileXml == null) {
272 /* TODO - mark Sone as bad. */
273 logger.log(Level.WARNING, "Downloaded Sone %s has no profile!", new Object[] { sone });
278 String profileFirstName = profileXml.getValue("first-name", null);
279 String profileMiddleName = profileXml.getValue("middle-name", null);
280 String profileLastName = profileXml.getValue("last-name", null);
281 Integer profileBirthDay = Numbers.safeParseInteger(profileXml.getValue("birth-day", null));
282 Integer profileBirthMonth = Numbers.safeParseInteger(profileXml.getValue("birth-month", null));
283 Integer profileBirthYear = Numbers.safeParseInteger(profileXml.getValue("birth-year", null));
284 Profile profile = new Profile().setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
285 profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
288 SimpleXML postsXml = soneXml.getNode("posts");
289 Set<Post> posts = new HashSet<Post>();
290 if (postsXml == null) {
291 /* TODO - mark Sone as bad. */
292 logger.log(Level.WARNING, "Downloaded Sone %s has no posts!", new Object[] { sone });
294 for (SimpleXML postXml : postsXml.getNodes("post")) {
295 String postId = postXml.getValue("id", null);
296 String postTime = postXml.getValue("time", null);
297 String postText = postXml.getValue("text", null);
298 if ((postId == null) || (postTime == null) || (postText == null)) {
299 /* TODO - mark Sone as bad. */
300 logger.log(Level.WARNING, "Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", new Object[] { sone, postId, postTime, postText });
304 posts.add(core.getPost(postId).setSone(sone).setTime(Long.parseLong(postTime)).setText(postText));
305 } catch (NumberFormatException nfe1) {
306 /* TODO - mark Sone as bad. */
307 logger.log(Level.WARNING, "Downloaded post for Sone %s with invalid time: %s", new Object[] { sone, postTime });
314 SimpleXML repliesXml = soneXml.getNode("replies");
315 Set<Reply> replies = new HashSet<Reply>();
316 if (repliesXml == null) {
317 /* TODO - mark Sone as bad. */
318 logger.log(Level.WARNING, "Downloaded Sone %s has no replies!", new Object[] { sone });
320 for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
321 String replyId = replyXml.getValue("id", null);
322 String replyPostId = replyXml.getValue("post-id", null);
323 String replyTime = replyXml.getValue("time", null);
324 String replyText = replyXml.getValue("text", null);
325 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
326 /* TODO - mark Sone as bad. */
327 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 });
331 replies.add(core.getReply(replyId).setSone(sone).setPost(core.getPost(replyPostId)).setTime(Long.parseLong(replyTime)).setText(replyText));
332 } catch (NumberFormatException nfe1) {
333 /* TODO - mark Sone as bad. */
334 logger.log(Level.WARNING, "Downloaded reply for Sone %s with invalid time: %s", new Object[] { sone, replyTime });
340 /* parse liked post IDs. */
341 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
342 Set<String> likedPostIds = new HashSet<String>();
343 if (likePostIdsXml == null) {
344 /* TODO - mark Sone as bad. */
345 logger.log(Level.WARNING, "Downloaded Sone %s has no post likes!", new Object[] { sone });
347 for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
348 String postId = likedPostIdXml.getValue();
349 likedPostIds.add(postId);
353 /* parse liked reply IDs. */
354 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
355 Set<String> likedReplyIds = new HashSet<String>();
356 if (likeReplyIdsXml == null) {
357 /* TODO - mark Sone as bad. */
358 logger.log(Level.WARNING, "Downloaded Sone %s has no reply likes!", new Object[] { sone });
360 for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
361 String replyId = likedReplyIdXml.getValue();
362 likedReplyIds.add(replyId);
366 /* parse known Sones. */
367 SimpleXML knownSonesXml = soneXml.getNode("known-sones");
368 Set<Sone> knownSones = new HashSet<Sone>();
369 if (knownSonesXml == null) {
370 /* TODO - mark Sone as bad. */
371 logger.log(Level.WARNING, "Downloaded Sone %s has no known Sones!", new Object[] { sone });
373 for (SimpleXML knownSoneXml : knownSonesXml.getNodes("known-sone")) {
374 String knownSoneId = knownSoneXml.getValue("sone-id", null);
375 String knownSoneKey = knownSoneXml.getValue("sone-key", null);
376 String knownSoneName = knownSoneXml.getValue("sone-name", null);
377 if ((knownSoneId == null) || (knownSoneKey == null) || (knownSoneName == null)) {
378 /* TODO - mark Sone as bad. */
379 logger.log(Level.WARNING, "Downloaded known Sone for Sone %s with missing data! ID: %s, Key: %s, Name: %s", new Object[] { sone, knownSoneId, knownSoneKey, knownSoneName });
383 knownSones.add(core.getSone(knownSoneId).setRequestUri(new FreenetURI(knownSoneKey)).setName(knownSoneName));
384 } catch (MalformedURLException mue1) {
385 /* TODO - mark Sone as bad. */
386 logger.log(Level.WARNING, "Downloaded known Sone for Sone %s with invalid key: %s", new Object[] { sone, knownSoneKey });
392 /* okay, apparently everything was parsed correctly. Now import. */
393 /* atomic setter operation on the Sone. */
394 synchronized (sone) {
395 sone.setProfile(profile);
396 sone.setPosts(posts);
397 sone.setReplies(replies);
398 sone.setLikePostIds(likedPostIds);
399 sone.setModificationCounter(0);
402 /* add all known Sones to core for downloading. */
403 for (Sone knownSone : knownSones) {
404 core.addSone(knownSone);
417 protected void serviceStop() {
418 for (Sone sone : sones) {
419 freenetInterface.unregisterUsk(sone);