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);
58 /** The maximum protocol version. */
59 private static final int MAX_PROTOCOL_VERSION = 0;
62 private final Core core;
64 /** The Freenet interface. */
65 private final FreenetInterface freenetInterface;
67 /** The sones to update. */
68 private final Set<Sone> sones = new HashSet<Sone>();
71 * Creates a new Sone downloader.
75 * @param freenetInterface
76 * The Freenet interface
78 public SoneDownloader(Core core, FreenetInterface freenetInterface) {
79 super("Sone Downloader", false);
81 this.freenetInterface = freenetInterface;
89 * Adds the given Sone to the set of Sones that will be watched for updates.
94 public void addSone(Sone sone) {
95 if (!sones.add(sone)) {
96 freenetInterface.unregisterUsk(sone);
98 freenetInterface.registerUsk(sone, this);
102 * Removes the given Sone from the downloader.
105 * The Sone to stop watching
107 public void removeSone(Sone sone) {
108 if (sones.remove(sone)) {
109 freenetInterface.unregisterUsk(sone);
114 * Fetches the updated Sone. This method is a callback method for
115 * {@link FreenetInterface#registerUsk(Sone, SoneDownloader)}.
120 public void fetchSone(Sone sone) {
121 fetchSone(sone, sone.getRequestUri().sskForUSK());
125 * Fetches the updated Sone. This method can be used to fetch a Sone from a
131 * The URI to fetch the Sone from
133 public void fetchSone(Sone sone, FreenetURI soneUri) {
134 fetchSone(sone, soneUri, false);
138 * Fetches the Sone from the given URI.
143 * The URI of the Sone to fetch
145 * {@code true} to only fetch and parse the Sone, {@code false}
146 * to {@link Core#updateSone(Sone) update} it in the core
147 * @return The downloaded Sone, or {@code null} if the Sone could not be
150 public Sone fetchSone(Sone sone, FreenetURI soneUri, boolean fetchOnly) {
151 logger.log(Level.FINE, "Starting fetch for Sone “%s” from %s…", new Object[] { sone, soneUri });
152 FreenetURI requestUri = soneUri.setMetaString(new String[] { "sone.xml" });
153 core.setSoneStatus(sone, SoneStatus.downloading);
155 Pair<FreenetURI, FetchResult> fetchResults = freenetInterface.fetchUri(requestUri);
156 if (fetchResults == null) {
157 /* TODO - mark Sone as bad. */
160 logger.log(Level.FINEST, "Got %d bytes back.", fetchResults.getRight().size());
161 Sone parsedSone = parseSone(sone, fetchResults.getRight(), fetchResults.getLeft());
162 if (parsedSone != null) {
164 core.updateSone(parsedSone);
170 core.setSoneStatus(sone, (sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
175 * Parses a Sone from a fetch result.
177 * @param originalSone
178 * The sone to parse, or {@code null} if the Sone is yet unknown
183 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
185 public Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
186 logger.log(Level.FINEST, "Parsing FetchResult (%d bytes, %s) for %s…", new Object[] { fetchResult.size(), fetchResult.getMimeType(), originalSone });
187 Bucket soneBucket = fetchResult.asBucket();
188 InputStream soneInputStream = null;
190 soneInputStream = soneBucket.getInputStream();
191 Sone parsedSone = parseSone(originalSone, soneInputStream);
192 if (parsedSone != null) {
193 parsedSone.setLatestEdition(requestUri.getEdition());
194 if (requestUri.getKeyType().equals("USK")) {
195 parsedSone.setRequestUri(requestUri.setMetaString(new String[0]));
197 parsedSone.setRequestUri(requestUri.setKeyType("USK").setDocName("Sone").setMetaString(new String[0]));
201 } catch (IOException ioe1) {
202 logger.log(Level.WARNING, "Could not parse Sone from " + requestUri + "!", ioe1);
204 Closer.close(soneInputStream);
211 * Parses a Sone from the given input stream and creates a new Sone from the
214 * @param originalSone
216 * @param soneInputStream
217 * The input stream to parse the Sone from
218 * @return The parsed Sone
220 public Sone parseSone(Sone originalSone, InputStream soneInputStream) {
221 /* TODO - impose a size limit? */
224 /* XML parsing is not thread-safe. */
225 synchronized (this) {
226 document = XML.transformToDocument(soneInputStream);
228 if (document == null) {
229 /* TODO - mark Sone as bad. */
230 logger.log(Level.WARNING, "Could not parse XML for Sone %s!", new Object[] { originalSone });
234 Sone sone = new Sone(originalSone.getId()).setIdentity(originalSone.getIdentity());
238 soneXml = SimpleXML.fromDocument(document);
239 } catch (NullPointerException npe1) {
240 /* for some reason, invalid XML can cause NPEs. */
241 logger.log(Level.WARNING, "XML for Sone " + sone + " can not be parsed!", npe1);
245 Integer protocolVersion = null;
246 String soneProtocolVersion = soneXml.getValue("protocol-version", null);
247 if (soneProtocolVersion != null) {
248 protocolVersion = Numbers.safeParseInteger(soneProtocolVersion);
250 if (protocolVersion == null) {
251 logger.log(Level.INFO, "No protocol version found, assuming 0.");
255 if (protocolVersion < 0) {
256 logger.log(Level.WARNING, "Invalid protocol version: " + protocolVersion + "! Not parsing Sone.");
260 /* check for valid versions. */
261 if (protocolVersion > MAX_PROTOCOL_VERSION) {
262 logger.log(Level.WARNING, "Unknown protocol version: " + protocolVersion + "! Not parsing Sone.");
266 String soneTime = soneXml.getValue("time", null);
267 if (soneTime == null) {
268 /* TODO - mark Sone as bad. */
269 logger.log(Level.WARNING, "Downloaded time for Sone %s was null!", new Object[] { sone });
273 sone.setTime(Long.parseLong(soneTime));
274 } catch (NumberFormatException nfe1) {
275 /* TODO - mark Sone as bad. */
276 logger.log(Level.WARNING, "Downloaded Sone %s with invalid time: %s", new Object[] { sone, soneTime });
280 SimpleXML clientXml = soneXml.getNode("client");
281 if (clientXml != null) {
282 String clientName = clientXml.getValue("name", null);
283 String clientVersion = clientXml.getValue("version", null);
284 if ((clientName == null) || (clientVersion == null)) {
285 logger.log(Level.WARNING, "Download Sone %s with client XML but missing name or version!", sone);
288 sone.setClient(new Client(clientName, clientVersion));
291 String soneRequestUri = soneXml.getValue("request-uri", null);
292 if (soneRequestUri != null) {
294 sone.setRequestUri(new FreenetURI(soneRequestUri));
295 } catch (MalformedURLException mue1) {
296 /* TODO - mark Sone as bad. */
297 logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid request URI: " + soneRequestUri, mue1);
302 String soneInsertUri = soneXml.getValue("insert-uri", null);
303 if ((soneInsertUri != null) && (sone.getInsertUri() == null)) {
305 sone.setInsertUri(new FreenetURI(soneInsertUri));
306 sone.setLatestEdition(Math.max(sone.getRequestUri().getEdition(), sone.getInsertUri().getEdition()));
307 } catch (MalformedURLException mue1) {
308 /* TODO - mark Sone as bad. */
309 logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid insert URI: " + soneInsertUri, mue1);
314 SimpleXML profileXml = soneXml.getNode("profile");
315 if (profileXml == null) {
316 /* TODO - mark Sone as bad. */
317 logger.log(Level.WARNING, "Downloaded Sone %s has no profile!", new Object[] { sone });
322 String profileFirstName = profileXml.getValue("first-name", null);
323 String profileMiddleName = profileXml.getValue("middle-name", null);
324 String profileLastName = profileXml.getValue("last-name", null);
325 Integer profileBirthDay = Numbers.safeParseInteger(profileXml.getValue("birth-day", null));
326 Integer profileBirthMonth = Numbers.safeParseInteger(profileXml.getValue("birth-month", null));
327 Integer profileBirthYear = Numbers.safeParseInteger(profileXml.getValue("birth-year", null));
328 Profile profile = new Profile().setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
329 profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
331 /* parse profile fields. */
332 SimpleXML profileFieldsXml = profileXml.getNode("fields");
333 if (profileFieldsXml != null) {
334 for (SimpleXML fieldXml : profileFieldsXml.getNodes("field")) {
335 String fieldName = fieldXml.getValue("field-name", null);
336 String fieldValue = fieldXml.getValue("field-value", null);
337 if ((fieldName == null) || (fieldValue == null)) {
338 logger.log(Level.WARNING, "Downloaded profile field for Sone %s with missing data! Name: %s, Value: %s", new Object[] { sone, fieldName, fieldValue });
342 profile.addField(fieldName).setValue(fieldValue);
343 } catch (IllegalArgumentException iae1) {
344 logger.log(Level.WARNING, "Duplicate field: " + fieldName, iae1);
351 SimpleXML postsXml = soneXml.getNode("posts");
352 Set<Post> posts = new HashSet<Post>();
353 if (postsXml == null) {
354 /* TODO - mark Sone as bad. */
355 logger.log(Level.WARNING, "Downloaded Sone %s has no posts!", new Object[] { sone });
357 for (SimpleXML postXml : postsXml.getNodes("post")) {
358 String postId = postXml.getValue("id", null);
359 String postRecipientId = postXml.getValue("recipient", null);
360 String postTime = postXml.getValue("time", null);
361 String postText = postXml.getValue("text", null);
362 if ((postId == null) || (postTime == null) || (postText == null)) {
363 /* TODO - mark Sone as bad. */
364 logger.log(Level.WARNING, "Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", new Object[] { sone, postId, postTime, postText });
368 Post post = core.getPost(postId).setSone(sone).setTime(Long.parseLong(postTime)).setText(postText);
369 if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
370 post.setRecipient(core.getSone(postRecipientId));
373 } catch (NumberFormatException nfe1) {
374 /* TODO - mark Sone as bad. */
375 logger.log(Level.WARNING, "Downloaded post for Sone %s with invalid time: %s", new Object[] { sone, postTime });
382 SimpleXML repliesXml = soneXml.getNode("replies");
383 Set<Reply> replies = new HashSet<Reply>();
384 if (repliesXml == null) {
385 /* TODO - mark Sone as bad. */
386 logger.log(Level.WARNING, "Downloaded Sone %s has no replies!", new Object[] { sone });
388 for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
389 String replyId = replyXml.getValue("id", null);
390 String replyPostId = replyXml.getValue("post-id", null);
391 String replyTime = replyXml.getValue("time", null);
392 String replyText = replyXml.getValue("text", null);
393 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
394 /* TODO - mark Sone as bad. */
395 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 });
399 replies.add(core.getReply(replyId).setSone(sone).setPost(core.getPost(replyPostId)).setTime(Long.parseLong(replyTime)).setText(replyText));
400 } catch (NumberFormatException nfe1) {
401 /* TODO - mark Sone as bad. */
402 logger.log(Level.WARNING, "Downloaded reply for Sone %s with invalid time: %s", new Object[] { sone, replyTime });
408 /* parse liked post IDs. */
409 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
410 Set<String> likedPostIds = new HashSet<String>();
411 if (likePostIdsXml == null) {
412 /* TODO - mark Sone as bad. */
413 logger.log(Level.WARNING, "Downloaded Sone %s has no post likes!", new Object[] { sone });
415 for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
416 String postId = likedPostIdXml.getValue();
417 likedPostIds.add(postId);
421 /* parse liked reply IDs. */
422 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
423 Set<String> likedReplyIds = new HashSet<String>();
424 if (likeReplyIdsXml == null) {
425 /* TODO - mark Sone as bad. */
426 logger.log(Level.WARNING, "Downloaded Sone %s has no reply likes!", new Object[] { sone });
428 for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
429 String replyId = likedReplyIdXml.getValue();
430 likedReplyIds.add(replyId);
434 /* okay, apparently everything was parsed correctly. Now import. */
435 /* atomic setter operation on the Sone. */
436 synchronized (sone) {
437 sone.setProfile(profile);
438 sone.setPosts(posts);
439 sone.setReplies(replies);
440 sone.setLikePostIds(likedPostIds);
441 sone.setLikeReplyIds(likedReplyIds);
455 protected void serviceStop() {
456 for (Sone sone : sones) {
457 freenetInterface.unregisterUsk(sone);