Fix ALL the logging!
[Sone.git] / src / main / java / net / pterodactylus / sone / core / SoneDownloader.java
index b2d1da4..98337b9 100644 (file)
 
 package net.pterodactylus.sone.core;
 
-import java.io.IOException;
 import java.io.InputStream;
 import java.net.MalformedURLException;
+import java.util.ArrayList;
 import java.util.HashSet;
+import java.util.List;
 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.Album;
 import net.pterodactylus.sone.data.Client;
+import net.pterodactylus.sone.data.Image;
 import net.pterodactylus.sone.data.Post;
+import net.pterodactylus.sone.data.PostReply;
 import net.pterodactylus.sone.data.Profile;
-import net.pterodactylus.sone.data.Reply;
 import net.pterodactylus.sone.data.Sone;
+import net.pterodactylus.sone.data.Sone.SoneStatus;
 import net.pterodactylus.util.collection.Pair;
 import net.pterodactylus.util.io.Closer;
 import net.pterodactylus.util.logging.Logging;
@@ -93,10 +95,10 @@ public class SoneDownloader extends AbstractService {
         *            The Sone to add
         */
        public void addSone(Sone sone) {
-               if (sones.add(sone)) {
+               if (!sones.add(sone)) {
                        freenetInterface.unregisterUsk(sone);
-                       freenetInterface.registerUsk(sone, this);
                }
+               freenetInterface.registerUsk(sone, this);
        }
 
        /**
@@ -119,13 +121,12 @@ public class SoneDownloader extends AbstractService {
         *            The Sone to fetch
         */
        public void fetchSone(Sone sone) {
-               fetchSone(sone, sone.getRequestUri());
+               fetchSone(sone, sone.getRequestUri().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
@@ -133,23 +134,43 @@ public class SoneDownloader extends AbstractService {
         *            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 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);
                        if (fetchResults == null) {
                                /* TODO - mark Sone as bad. */
-                               return;
+                               return null;
                        }
-                       logger.log(Level.FINEST, "Got %d bytes back.", fetchResults.getRight().size());
+                       logger.log(Level.FINEST, String.format("Got %d bytes back.", fetchResults.getRight().size()));
                        Sone parsedSone = parseSone(sone, fetchResults.getRight(), fetchResults.getLeft());
                        if (parsedSone != null) {
-                               addSone(parsedSone);
-                               core.updateSone(parsedSone);
+                               if (!fetchOnly) {
+                                       core.updateSone(parsedSone);
+                                       addSone(parsedSone);
+                               }
                        }
+                       return parsedSone;
                } finally {
-                       core.setSoneStatus(sone, (sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
+                       sone.setStatus((sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
                }
        }
 
@@ -165,7 +186,7 @@ public class SoneDownloader extends AbstractService {
         * @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 });
+               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 {
@@ -180,8 +201,8 @@ public class SoneDownloader extends AbstractService {
                                }
                        }
                        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();
@@ -198,8 +219,10 @@ public class SoneDownloader extends AbstractService {
         * @param soneInputStream
         *            The input stream to parse the Sone from
         * @return The parsed Sone
+        * @throws SoneException
+        *             if a parse error occurs, or the protocol is invalid
         */
-       public Sone parseSone(Sone originalSone, InputStream soneInputStream) {
+       public Sone parseSone(Sone originalSone, InputStream soneInputStream) throws SoneException {
                /* TODO - impose a size limit? */
 
                Document document;
@@ -209,7 +232,7 @@ public class SoneDownloader extends AbstractService {
                }
                if (document == null) {
                        /* TODO - mark Sone as bad. */
-                       logger.log(Level.WARNING, "Could not parse XML for Sone %s!", new Object[] { originalSone });
+                       logger.log(Level.WARNING, String.format("Could not parse XML for Sone %s!", originalSone));
                        return null;
                }
 
@@ -220,7 +243,7 @@ public class SoneDownloader extends AbstractService {
                        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);
+                       logger.log(Level.WARNING, String.format("XML for Sone %s can not be parsed!", sone), npe1);
                        return null;
                }
 
@@ -235,27 +258,27 @@ public class SoneDownloader extends AbstractService {
                }
 
                if (protocolVersion < 0) {
-                       logger.log(Level.WARNING, "Invalid protocol version: " + protocolVersion + "! Not parsing Sone.");
+                       logger.log(Level.WARNING, String.format("Invalid protocol version: %d! Not parsing Sone.", protocolVersion));
                        return null;
                }
 
                /* check for valid versions. */
                if (protocolVersion > MAX_PROTOCOL_VERSION) {
-                       logger.log(Level.WARNING, "Unknown protocol version: " + protocolVersion + "! Not parsing Sone.");
+                       logger.log(Level.WARNING, String.format("Unknown protocol version: %d! Not parsing Sone.", protocolVersion));
                        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 });
+                       logger.log(Level.WARNING, String.format("Downloaded time for Sone %s was null!", 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 });
+                       logger.log(Level.WARNING, String.format("Downloaded Sone %s with invalid time: %s", sone, soneTime));
                        return null;
                }
 
@@ -264,7 +287,7 @@ public class SoneDownloader extends AbstractService {
                        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);
+                               logger.log(Level.WARNING, String.format("Download Sone %s with client XML but missing name or version!", sone));
                                return null;
                        }
                        sone.setClient(new Client(clientName, clientVersion));
@@ -276,7 +299,7 @@ public class SoneDownloader extends AbstractService {
                                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);
+                               logger.log(Level.WARNING, String.format("Downloaded Sone %s has invalid request URI: %s", sone, soneRequestUri), mue1);
                                return null;
                        }
                }
@@ -288,7 +311,7 @@ public class SoneDownloader extends AbstractService {
                                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);
+                               logger.log(Level.WARNING, String.format("Downloaded Sone %s has invalid insert URI: %s", sone, soneInsertUri), mue1);
                                return null;
                        }
                }
@@ -296,7 +319,7 @@ public class SoneDownloader extends AbstractService {
                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 });
+                       logger.log(Level.WARNING, String.format("Downloaded Sone %s has no profile!", sone));
                        return null;
                }
 
@@ -307,23 +330,25 @@ public class SoneDownloader extends AbstractService {
                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 profile = new Profile(sone).setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
                profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
+               /* avatar is processed after images are loaded. */
+               String avatarId = profileXml.getValue("avatar", null);
 
                /* 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 });
+                               String fieldValue = fieldXml.getValue("field-value", "");
+                               if (fieldName == null) {
+                                       logger.log(Level.WARNING, String.format("Downloaded profile field for Sone %s with missing data! Name: %s, Value: %s", sone, fieldName, fieldValue));
                                        return null;
                                }
                                try {
                                        profile.addField(fieldName).setValue(fieldValue);
                                } catch (IllegalArgumentException iae1) {
-                                       logger.log(Level.WARNING, "Duplicate field: " + fieldName, iae1);
+                                       logger.log(Level.WARNING, String.format("Duplicate field: %s", fieldName), iae1);
                                        return null;
                                }
                        }
@@ -334,7 +359,7 @@ public class SoneDownloader extends AbstractService {
                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 });
+                       logger.log(Level.WARNING, String.format("Downloaded Sone %s has no posts!", sone));
                } else {
                        for (SimpleXML postXml : postsXml.getNodes("post")) {
                                String postId = postXml.getValue("id", null);
@@ -343,7 +368,7 @@ public class SoneDownloader extends AbstractService {
                                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 });
+                                       logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", sone, postId, postTime, postText));
                                        return null;
                                }
                                try {
@@ -354,7 +379,7 @@ public class SoneDownloader extends AbstractService {
                                        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 });
+                                       logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with invalid time: %s", sone, postTime));
                                        return null;
                                }
                        }
@@ -362,10 +387,10 @@ public class SoneDownloader extends AbstractService {
 
                /* parse replies. */
                SimpleXML repliesXml = soneXml.getNode("replies");
-               Set<Reply> replies = new HashSet<Reply>();
+               Set<PostReply> replies = new HashSet<PostReply>();
                if (repliesXml == null) {
                        /* TODO - mark Sone as bad. */
-                       logger.log(Level.WARNING, "Downloaded Sone %s has no replies!", new Object[] { sone });
+                       logger.log(Level.WARNING, String.format("Downloaded Sone %s has no replies!", sone));
                } else {
                        for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
                                String replyId = replyXml.getValue("id", null);
@@ -374,14 +399,14 @@ public class SoneDownloader extends AbstractService {
                                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 });
+                                       logger.log(Level.WARNING, String.format("Downloaded reply for Sone %s with missing data! ID: %s, Post: %s, Time: %s, Text: %s", 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 });
+                                       logger.log(Level.WARNING, String.format("Downloaded reply for Sone %s with invalid time: %s", sone, replyTime));
                                        return null;
                                }
                        }
@@ -392,7 +417,7 @@ public class SoneDownloader extends AbstractService {
                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 });
+                       logger.log(Level.WARNING, String.format("Downloaded Sone %s has no post likes!", sone));
                } else {
                        for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
                                String postId = likedPostIdXml.getValue();
@@ -405,7 +430,7 @@ public class SoneDownloader extends AbstractService {
                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 });
+                       logger.log(Level.WARNING, String.format("Downloaded Sone %s has no reply likes!", sone));
                } else {
                        for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
                                String replyId = likedReplyIdXml.getValue();
@@ -413,6 +438,70 @@ public class SoneDownloader extends AbstractService {
                        }
                }
 
+               /* parse albums. */
+               SimpleXML albumsXml = soneXml.getNode("albums");
+               List<Album> topLevelAlbums = new ArrayList<Album>();
+               if (albumsXml != null) {
+                       for (SimpleXML albumXml : albumsXml.getNodes("album")) {
+                               String id = albumXml.getValue("id", null);
+                               String parentId = albumXml.getValue("parent", null);
+                               String title = albumXml.getValue("title", null);
+                               String description = albumXml.getValue("description", "");
+                               String albumImageId = albumXml.getValue("album-image", null);
+                               if ((id == null) || (title == null) || (description == null)) {
+                                       logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid album!", sone));
+                                       return null;
+                               }
+                               Album parent = null;
+                               if (parentId != null) {
+                                       parent = core.getAlbum(parentId, false);
+                                       if (parent == null) {
+                                               logger.log(Level.WARNING, String.format("Downloaded Sone %s has album with invalid parent!", sone));
+                                               return null;
+                                       }
+                               }
+                               Album album = core.getAlbum(id).setSone(sone).setTitle(title).setDescription(description);
+                               if (parent != null) {
+                                       parent.addAlbum(album);
+                               } else {
+                                       topLevelAlbums.add(album);
+                               }
+                               SimpleXML imagesXml = albumXml.getNode("images");
+                               if (imagesXml != null) {
+                                       for (SimpleXML imageXml : imagesXml.getNodes("image")) {
+                                               String imageId = imageXml.getValue("id", null);
+                                               String imageCreationTimeString = imageXml.getValue("creation-time", null);
+                                               String imageKey = imageXml.getValue("key", null);
+                                               String imageTitle = imageXml.getValue("title", null);
+                                               String imageDescription = imageXml.getValue("description", "");
+                                               String imageWidthString = imageXml.getValue("width", null);
+                                               String imageHeightString = imageXml.getValue("height", null);
+                                               if ((imageId == null) || (imageCreationTimeString == null) || (imageKey == null) || (imageTitle == null) || (imageWidthString == null) || (imageHeightString == null)) {
+                                                       logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid images!", sone));
+                                                       return null;
+                                               }
+                                               long creationTime = Numbers.safeParseLong(imageCreationTimeString, 0L);
+                                               int imageWidth = Numbers.safeParseInteger(imageWidthString, 0);
+                                               int imageHeight = Numbers.safeParseInteger(imageHeightString, 0);
+                                               if ((imageWidth < 1) || (imageHeight < 1)) {
+                                                       logger.log(Level.WARNING, String.format("Downloaded Sone %s contains image %s with invalid dimensions (%s, %s)!", sone, imageId, imageWidthString, imageHeightString));
+                                                       return null;
+                                               }
+                                               Image image = core.getImage(imageId).setSone(sone).setKey(imageKey).setCreationTime(creationTime);
+                                               image.setTitle(imageTitle).setDescription(imageDescription);
+                                               image.setWidth(imageWidth).setHeight(imageHeight);
+                                               album.addImage(image);
+                                       }
+                               }
+                               album.setAlbumImage(albumImageId);
+                       }
+               }
+
+               /* process avatar. */
+               if (avatarId != null) {
+                       profile.setAvatar(core.getImage(avatarId, false));
+               }
+
                /* okay, apparently everything was parsed correctly. Now import. */
                /* atomic setter operation on the Sone. */
                synchronized (sone) {
@@ -421,6 +510,7 @@ public class SoneDownloader extends AbstractService {
                        sone.setReplies(replies);
                        sone.setLikePostIds(likedPostIds);
                        sone.setLikeReplyIds(likedReplyIds);
+                       sone.setAlbums(topLevelAlbums);
                }
 
                return sone;