/*
- * Sone - SoneDownloader.java - Copyright © 2010 David Roden
+ * Sone - SoneDownloader.java - Copyright © 2010–2013 David Roden
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
package net.pterodactylus.sone.core;
-import java.io.IOException;
+import static net.pterodactylus.sone.data.Sone.TO_FREENET_URI;
+
import java.io.InputStream;
-import java.net.MalformedURLException;
import java.util.HashSet;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
-import net.pterodactylus.sone.core.Core.Preferences;
-import net.pterodactylus.sone.core.Core.SoneStatus;
-import net.pterodactylus.sone.data.Client;
-import net.pterodactylus.sone.data.Post;
-import net.pterodactylus.sone.data.Profile;
-import net.pterodactylus.sone.data.Reply;
+import net.pterodactylus.sone.core.FreenetInterface.Fetched;
import net.pterodactylus.sone.data.Sone;
-import net.pterodactylus.util.collection.Pair;
+import net.pterodactylus.sone.data.Sone.SoneStatus;
import net.pterodactylus.util.io.Closer;
import net.pterodactylus.util.logging.Logging;
-import net.pterodactylus.util.number.Numbers;
import net.pterodactylus.util.service.AbstractService;
-import net.pterodactylus.util.xml.SimpleXML;
-import net.pterodactylus.util.xml.XML;
-
-import org.w3c.dom.Document;
import freenet.client.FetchResult;
import freenet.keys.FreenetURI;
import freenet.support.api.Bucket;
+import com.google.common.base.Optional;
+
/**
* The Sone downloader is responsible for download Sones as they are updated.
*
* The Sone to fetch
*/
public void fetchSone(Sone sone) {
- fetchSone(sone, sone.getRequestUri());
+ fetchSone(sone, TO_FREENET_URI.apply(sone).sskForUSK());
}
/**
* Fetches the updated Sone. This method can be used to fetch a Sone from a
- * specific URI (which happens when {@link Preferences#isSoneRescueMode()
- * „Sone rescue mode“} is active).
+ * specific URI.
*
* @param sone
* The Sone to fetch
* The URI to fetch the Sone from
*/
public void fetchSone(Sone sone, FreenetURI soneUri) {
- logger.log(Level.FINE, "Starting fetch for Sone “%s” from %s…", new Object[] { sone, soneUri });
+ fetchSone(sone, soneUri, false);
+ }
+
+ /**
+ * Fetches the Sone from the given URI.
+ *
+ * @param sone
+ * The Sone to fetch
+ * @param soneUri
+ * The URI of the Sone to fetch
+ * @param fetchOnly
+ * {@code true} to only fetch and parse the Sone, {@code false}
+ * to {@link Core#updateSone(Sone) update} it in the core
+ * @return The downloaded Sone, or {@code null} if the Sone could not be
+ * downloaded
+ */
+ public Optional<Sone> fetchSone(Sone sone, FreenetURI soneUri, boolean fetchOnly) {
+ logger.log(Level.FINE, String.format("Starting fetch for Sone “%s” from %s…", sone, soneUri));
FreenetURI requestUri = soneUri.setMetaString(new String[] { "sone.xml" });
- core.setSoneStatus(sone, SoneStatus.downloading);
+ sone.setStatus(SoneStatus.downloading);
try {
- Pair<FreenetURI, FetchResult> fetchResults = freenetInterface.fetchUri(requestUri);
+ Fetched fetchResults = freenetInterface.fetchUri(requestUri);
if (fetchResults == null) {
/* TODO - mark Sone as bad. */
- return;
+ return null;
}
- logger.log(Level.FINEST, "Got %d bytes back.", fetchResults.getRight().size());
- Sone parsedSone = parseSone(sone, fetchResults.getRight(), fetchResults.getLeft());
- if (parsedSone != null) {
- addSone(parsedSone);
- core.updateSone(parsedSone);
+ logger.log(Level.FINEST, String.format("Got %d bytes back.", fetchResults.getFetchResult().size()));
+ Optional<Sone> parsedSone = parseSone(sone, fetchResults.getFetchResult(), fetchResults.getFreenetUri());
+ if (parsedSone.isPresent()) {
+ if (!fetchOnly) {
+ parsedSone.get().setStatus((parsedSone.get().getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
+ core.updateSone(parsedSone.get());
+ addSone(parsedSone.get());
+ }
}
+ return parsedSone;
} finally {
- core.setSoneStatus(sone, (sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
+ sone.setStatus((sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
}
}
* The requested URI
* @return The parsed Sone, or {@code null} if the Sone could not be parsed
*/
- public Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
- logger.log(Level.FINEST, "Parsing FetchResult (%d bytes, %s) for %s…", new Object[] { fetchResult.size(), fetchResult.getMimeType(), originalSone });
+ public Optional<Sone> parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
+ logger.log(Level.FINEST, String.format("Parsing FetchResult (%d bytes, %s) for %s…", fetchResult.size(), fetchResult.getMimeType(), originalSone));
Bucket soneBucket = fetchResult.asBucket();
InputStream soneInputStream = null;
try {
soneInputStream = soneBucket.getInputStream();
- Sone parsedSone = parseSone(originalSone, soneInputStream);
- if (parsedSone != null) {
- parsedSone.setLatestEdition(requestUri.getEdition());
- if (requestUri.getKeyType().equals("USK")) {
- parsedSone.setRequestUri(requestUri.setMetaString(new String[0]));
- } else {
- parsedSone.setRequestUri(requestUri.setKeyType("USK").setDocName("Sone").setMetaString(new String[0]));
- }
+ Optional<Sone> parsedSone = parseSone(originalSone, soneInputStream);
+ if (parsedSone.isPresent()) {
+ parsedSone.get().modify().setLatestEdition(requestUri.getEdition()).update();
}
return parsedSone;
- } catch (IOException ioe1) {
- logger.log(Level.WARNING, "Could not parse Sone from " + requestUri + "!", ioe1);
+ } catch (Exception e1) {
+ logger.log(Level.WARNING, String.format("Could not parse Sone from %s!", requestUri), e1);
} finally {
Closer.close(soneInputStream);
soneBucket.free();
* The input stream to parse the Sone from
* @return The parsed Sone
*/
- public Sone parseSone(Sone originalSone, InputStream soneInputStream) {
- /* TODO - impose a size limit? */
-
- Document document;
- /* XML parsing is not thread-safe. */
- synchronized (this) {
- document = XML.transformToDocument(soneInputStream);
- }
- if (document == null) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Could not parse XML for Sone %s!", new Object[] { originalSone });
- return null;
- }
-
- Sone sone = new Sone(originalSone.getId()).setIdentity(originalSone.getIdentity());
-
- SimpleXML soneXml;
- try {
- soneXml = SimpleXML.fromDocument(document);
- } catch (NullPointerException npe1) {
- /* for some reason, invalid XML can cause NPEs. */
- logger.log(Level.WARNING, "XML for Sone " + sone + " can not be parsed!", npe1);
- return null;
- }
-
- Integer protocolVersion = null;
- String soneProtocolVersion = soneXml.getValue("protocol-version", null);
- if (soneProtocolVersion != null) {
- protocolVersion = Numbers.safeParseInteger(soneProtocolVersion);
- }
- if (protocolVersion == null) {
- logger.log(Level.INFO, "No protocol version found, assuming 0.");
- protocolVersion = 0;
- }
-
- if (protocolVersion < 0) {
- logger.log(Level.WARNING, "Invalid protocol version: " + protocolVersion + "! Not parsing Sone.");
- return null;
- }
-
- /* check for valid versions. */
- if (protocolVersion > MAX_PROTOCOL_VERSION) {
- logger.log(Level.WARNING, "Unknown protocol version: " + protocolVersion + "! Not parsing Sone.");
- return null;
- }
-
- String soneTime = soneXml.getValue("time", null);
- if (soneTime == null) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Downloaded time for Sone %s was null!", new Object[] { sone });
- return null;
- }
- try {
- sone.setTime(Long.parseLong(soneTime));
- } catch (NumberFormatException nfe1) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Downloaded Sone %s with invalid time: %s", new Object[] { sone, soneTime });
- return null;
- }
-
- SimpleXML clientXml = soneXml.getNode("client");
- if (clientXml != null) {
- String clientName = clientXml.getValue("name", null);
- String clientVersion = clientXml.getValue("version", null);
- if ((clientName == null) || (clientVersion == null)) {
- logger.log(Level.WARNING, "Download Sone %s with client XML but missing name or version!", sone);
- return null;
- }
- sone.setClient(new Client(clientName, clientVersion));
- }
-
- String soneRequestUri = soneXml.getValue("request-uri", null);
- if (soneRequestUri != null) {
- try {
- sone.setRequestUri(new FreenetURI(soneRequestUri));
- } catch (MalformedURLException mue1) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid request URI: " + soneRequestUri, mue1);
- return null;
- }
- }
-
- String soneInsertUri = soneXml.getValue("insert-uri", null);
- if ((soneInsertUri != null) && (sone.getInsertUri() == null)) {
- try {
- sone.setInsertUri(new FreenetURI(soneInsertUri));
- sone.setLatestEdition(Math.max(sone.getRequestUri().getEdition(), sone.getInsertUri().getEdition()));
- } catch (MalformedURLException mue1) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid insert URI: " + soneInsertUri, mue1);
- return null;
- }
- }
-
- SimpleXML profileXml = soneXml.getNode("profile");
- if (profileXml == null) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Downloaded Sone %s has no profile!", new Object[] { sone });
- return null;
- }
-
- /* parse profile. */
- String profileFirstName = profileXml.getValue("first-name", null);
- String profileMiddleName = profileXml.getValue("middle-name", null);
- String profileLastName = profileXml.getValue("last-name", null);
- Integer profileBirthDay = Numbers.safeParseInteger(profileXml.getValue("birth-day", null));
- Integer profileBirthMonth = Numbers.safeParseInteger(profileXml.getValue("birth-month", null));
- Integer profileBirthYear = Numbers.safeParseInteger(profileXml.getValue("birth-year", null));
- Profile profile = new Profile().setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
- profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
-
- /* parse profile fields. */
- SimpleXML profileFieldsXml = profileXml.getNode("fields");
- if (profileFieldsXml != null) {
- for (SimpleXML fieldXml : profileFieldsXml.getNodes("field")) {
- String fieldName = fieldXml.getValue("field-name", null);
- String fieldValue = fieldXml.getValue("field-value", null);
- if ((fieldName == null) || (fieldValue == null)) {
- logger.log(Level.WARNING, "Downloaded profile field for Sone %s with missing data! Name: %s, Value: %s", new Object[] { sone, fieldName, fieldValue });
- return null;
- }
- try {
- profile.addField(fieldName).setValue(fieldValue);
- } catch (IllegalArgumentException iae1) {
- logger.log(Level.WARNING, "Duplicate field: " + fieldName, iae1);
- return null;
- }
- }
- }
-
- /* parse posts. */
- SimpleXML postsXml = soneXml.getNode("posts");
- Set<Post> posts = new HashSet<Post>();
- if (postsXml == null) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Downloaded Sone %s has no posts!", new Object[] { sone });
- } else {
- for (SimpleXML postXml : postsXml.getNodes("post")) {
- String postId = postXml.getValue("id", null);
- String postRecipientId = postXml.getValue("recipient", null);
- String postTime = postXml.getValue("time", null);
- String postText = postXml.getValue("text", null);
- if ((postId == null) || (postTime == null) || (postText == null)) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", new Object[] { sone, postId, postTime, postText });
- return null;
- }
- try {
- Post post = core.getPost(postId).setSone(sone).setTime(Long.parseLong(postTime)).setText(postText);
- if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
- post.setRecipient(core.getSone(postRecipientId));
- }
- posts.add(post);
- } catch (NumberFormatException nfe1) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Downloaded post for Sone %s with invalid time: %s", new Object[] { sone, postTime });
- return null;
- }
- }
- }
-
- /* parse replies. */
- SimpleXML repliesXml = soneXml.getNode("replies");
- Set<Reply> replies = new HashSet<Reply>();
- if (repliesXml == null) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Downloaded Sone %s has no replies!", new Object[] { sone });
- } else {
- for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
- String replyId = replyXml.getValue("id", null);
- String replyPostId = replyXml.getValue("post-id", null);
- String replyTime = replyXml.getValue("time", null);
- String replyText = replyXml.getValue("text", null);
- if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
- /* TODO - mark Sone as bad. */
- 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 });
- return null;
- }
- try {
- replies.add(core.getReply(replyId).setSone(sone).setPost(core.getPost(replyPostId)).setTime(Long.parseLong(replyTime)).setText(replyText));
- } catch (NumberFormatException nfe1) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Downloaded reply for Sone %s with invalid time: %s", new Object[] { sone, replyTime });
- return null;
- }
- }
- }
-
- /* parse liked post IDs. */
- SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
- Set<String> likedPostIds = new HashSet<String>();
- if (likePostIdsXml == null) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Downloaded Sone %s has no post likes!", new Object[] { sone });
- } else {
- for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
- String postId = likedPostIdXml.getValue();
- likedPostIds.add(postId);
- }
- }
-
- /* parse liked reply IDs. */
- SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
- Set<String> likedReplyIds = new HashSet<String>();
- if (likeReplyIdsXml == null) {
- /* TODO - mark Sone as bad. */
- logger.log(Level.WARNING, "Downloaded Sone %s has no reply likes!", new Object[] { sone });
- } else {
- for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
- String replyId = likedReplyIdXml.getValue();
- likedReplyIds.add(replyId);
- }
- }
-
- /* okay, apparently everything was parsed correctly. Now import. */
- /* atomic setter operation on the Sone. */
- synchronized (sone) {
- sone.setProfile(profile);
- sone.setPosts(posts);
- sone.setReplies(replies);
- sone.setLikePostIds(likedPostIds);
- sone.setLikeReplyIds(likedReplyIds);
- }
-
- return sone;
+ public Optional<Sone> parseSone(Sone originalSone, InputStream soneInputStream) {
+ return new SoneParser().parseSone(core.getDatabase(), originalSone, soneInputStream);
}
//
// SERVICE METHODS
//
- /**
- * {@inheritDoc}
- */
@Override
protected void serviceStop() {
for (Sone sone : sones) {