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.updateSone(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 and updates the given Sone, or
170 * creates a new Sone.
174 * @param soneInputStream
175 * The input stream to parse the Sone from
176 * @return The parsed Sone
178 public Sone parseSone(Sone sone, InputStream soneInputStream) {
179 /* TODO - impose a size limit? */
182 /* XML parsing is not thread-safe. */
183 synchronized (this) {
184 document = XML.transformToDocument(soneInputStream);
186 if (document == null) {
187 /* TODO - mark Sone as bad. */
188 logger.log(Level.WARNING, "Could not parse XML for Sone %s!", new Object[] { sone });
193 soneXml = SimpleXML.fromDocument(document);
194 } catch (NullPointerException npe1) {
195 /* for some reason, invalid XML can cause NPEs. */
196 logger.log(Level.WARNING, "XML for Sone " + sone + " can not be parsed!", npe1);
200 String soneTime = soneXml.getValue("time", null);
201 if (soneTime == null) {
202 /* TODO - mark Sone as bad. */
203 logger.log(Level.WARNING, "Downloaded time for Sone %s was null!", new Object[] { sone });
207 sone.setTime(Long.parseLong(soneTime));
208 } catch (NumberFormatException nfe1) {
209 /* TODO - mark Sone as bad. */
210 logger.log(Level.WARNING, "Downloaded Sone %s with invalid time: %s", new Object[] { sone, soneTime });
214 String soneRequestUri = soneXml.getValue("request-uri", null);
215 if (soneRequestUri != null) {
217 sone.setRequestUri(new FreenetURI(soneRequestUri));
218 } catch (MalformedURLException mue1) {
219 /* TODO - mark Sone as bad. */
220 logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid request URI: " + soneRequestUri, mue1);
225 String soneInsertUri = soneXml.getValue("insert-uri", null);
226 if ((soneInsertUri != null) && (sone.getInsertUri() == null)) {
228 sone.setInsertUri(new FreenetURI(soneInsertUri));
229 sone.setLatestEdition(Math.max(sone.getRequestUri().getSuggestedEdition(), sone.getInsertUri().getSuggestedEdition()));
230 } catch (MalformedURLException mue1) {
231 /* TODO - mark Sone as bad. */
232 logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid insert URI: " + soneInsertUri, mue1);
237 SimpleXML profileXml = soneXml.getNode("profile");
238 if (profileXml == null) {
239 /* TODO - mark Sone as bad. */
240 logger.log(Level.WARNING, "Downloaded Sone %s has no profile!", new Object[] { sone });
245 String profileFirstName = profileXml.getValue("first-name", null);
246 String profileMiddleName = profileXml.getValue("middle-name", null);
247 String profileLastName = profileXml.getValue("last-name", null);
248 Integer profileBirthDay = Numbers.safeParseInteger(profileXml.getValue("birth-day", null));
249 Integer profileBirthMonth = Numbers.safeParseInteger(profileXml.getValue("birth-month", null));
250 Integer profileBirthYear = Numbers.safeParseInteger(profileXml.getValue("birth-year", null));
251 Profile profile = new Profile().setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
252 profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
255 SimpleXML postsXml = soneXml.getNode("posts");
256 Set<Post> posts = new HashSet<Post>();
257 if (postsXml == null) {
258 /* TODO - mark Sone as bad. */
259 logger.log(Level.WARNING, "Downloaded Sone %s has no posts!", new Object[] { sone });
261 for (SimpleXML postXml : postsXml.getNodes("post")) {
262 String postId = postXml.getValue("id", null);
263 String postTime = postXml.getValue("time", null);
264 String postText = postXml.getValue("text", null);
265 if ((postId == null) || (postTime == null) || (postText == null)) {
266 /* TODO - mark Sone as bad. */
267 logger.log(Level.WARNING, "Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", new Object[] { sone, postId, postTime, postText });
271 posts.add(core.getPost(postId).setSone(sone).setTime(Long.parseLong(postTime)).setText(postText));
272 } catch (NumberFormatException nfe1) {
273 /* TODO - mark Sone as bad. */
274 logger.log(Level.WARNING, "Downloaded post for Sone %s with invalid time: %s", new Object[] { sone, postTime });
281 SimpleXML repliesXml = soneXml.getNode("replies");
282 Set<Reply> replies = new HashSet<Reply>();
283 if (repliesXml == null) {
284 /* TODO - mark Sone as bad. */
285 logger.log(Level.WARNING, "Downloaded Sone %s has no replies!", new Object[] { sone });
287 for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
288 String replyId = replyXml.getValue("id", null);
289 String replyPostId = replyXml.getValue("post-id", null);
290 String replyTime = replyXml.getValue("time", null);
291 String replyText = replyXml.getValue("text", null);
292 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
293 /* TODO - mark Sone as bad. */
294 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 });
298 replies.add(core.getReply(replyId).setSone(sone).setPost(core.getPost(replyPostId)).setTime(Long.parseLong(replyTime)).setText(replyText));
299 } catch (NumberFormatException nfe1) {
300 /* TODO - mark Sone as bad. */
301 logger.log(Level.WARNING, "Downloaded reply for Sone %s with invalid time: %s", new Object[] { sone, replyTime });
307 /* parse liked post IDs. */
308 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
309 Set<String> likedPostIds = new HashSet<String>();
310 if (likePostIdsXml == null) {
311 /* TODO - mark Sone as bad. */
312 logger.log(Level.WARNING, "Downloaded Sone %s has no post likes!", new Object[] { sone });
314 for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
315 String postId = likedPostIdXml.getValue();
316 likedPostIds.add(postId);
320 /* parse liked reply IDs. */
321 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
322 Set<String> likedReplyIds = new HashSet<String>();
323 if (likeReplyIdsXml == null) {
324 /* TODO - mark Sone as bad. */
325 logger.log(Level.WARNING, "Downloaded Sone %s has no reply likes!", new Object[] { sone });
327 for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
328 String replyId = likedReplyIdXml.getValue();
329 likedReplyIds.add(replyId);
333 /* okay, apparently everything was parsed correctly. Now import. */
334 /* atomic setter operation on the Sone. */
335 synchronized (sone) {
336 sone.setProfile(profile);
337 sone.setPosts(posts);
338 sone.setReplies(replies);
339 sone.setLikePostIds(likedPostIds);
340 sone.setModificationCounter(0);
354 protected void serviceStop() {
355 for (Sone sone : sones) {
356 freenetInterface.unregisterUsk(sone);