src/main/java/net/pterodactylus/sone/core/SoneParser.java

   1 /*
   2  * Sone - SoneParser.java - Copyright © 2010–2013 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sone.core;
  19
  20 import java.io.InputStream;
  21 import java.net.MalformedURLException;
  22 import java.util.HashSet;
  23 import java.util.Map;
  24 import java.util.Set;
  25 import java.util.logging.Level;
  26 import java.util.logging.Logger;
  27
  28 import net.pterodactylus.sone.data.Album;
  29 import net.pterodactylus.sone.data.Client;
  30 import net.pterodactylus.sone.data.Image;
  31 import net.pterodactylus.sone.data.Post;
  32 import net.pterodactylus.sone.data.PostReply;
  33 import net.pterodactylus.sone.data.Profile;
  34 import net.pterodactylus.sone.data.Sone;
  35 import net.pterodactylus.sone.data.impl.DefaultSone;
  36 import net.pterodactylus.sone.database.ImageBuilder.ImageCreated;
  37 import net.pterodactylus.sone.database.PostBuilder;
  38 import net.pterodactylus.sone.database.PostBuilder.PostCreated;
  39 import net.pterodactylus.sone.database.PostReplyBuilder;
  40 import net.pterodactylus.sone.database.PostReplyBuilder.PostReplyCreated;
  41 import net.pterodactylus.sone.database.memory.MemoryDatabase;
  42 import net.pterodactylus.util.number.Numbers;
  43 import net.pterodactylus.util.xml.SimpleXML;
  44 import net.pterodactylus.util.xml.XML;
  45
  46 import freenet.keys.FreenetURI;
  47
  48 import com.google.common.base.Optional;
  49 import com.google.common.collect.Maps;
  50 import org.w3c.dom.Document;
  51
  52 /**
  53  * Parses the inserted XML representation of a {@link Sone} into a Sone.
  54  *
  55  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  56  */
  57 public class SoneParser {
  58
  59         private static final Logger logger = Logger.getLogger(SoneParser.class.getName());
  60         private static final int MAX_PROTOCOL_VERSION = 0;
  61         private final Core core;
  62
  63         public SoneParser(Core core) {
  64                 this.core = core;
  65         }
  66
  67         /**
  68          * Parses a Sone from the given input stream and creates a new Sone from the
  69          * parsed data.
  70          *
  71          * @param originalSone
  72          *              The Sone to update
  73          * @param soneInputStream
  74          *              The input stream to parse the Sone from
  75          * @return The parsed Sone
  76          * @throws SoneException
  77          *              if a parse error occurs, or the protocol is invalid
  78          */
  79         public Sone parseSone(Sone originalSone, InputStream soneInputStream) throws SoneException {
  80                 /* TODO - impose a size limit? */
  81
  82                 Document document;
  83                 /* XML parsing is not thread-safe. */
  84                 synchronized (this) {
  85                         document = XML.transformToDocument(soneInputStream);
  86                 }
  87                 if (document == null) {
  88                         /* TODO - mark Sone as bad. */
  89                         logger.log(Level.WARNING, String.format("Could not parse XML for Sone %s!", originalSone));
  90                         return null;
  91                 }
  92
  93                 Sone sone = new DefaultSone(new MemoryDatabase(null), originalSone.getId(), originalSone.isLocal());
  94
  95                 SimpleXML soneXml;
  96                 try {
  97                         soneXml = SimpleXML.fromDocument(document);
  98                 } catch (NullPointerException npe1) {
  99                         /* for some reason, invalid XML can cause NPEs. */
 100                         logger.log(Level.WARNING, String.format("XML for Sone %s can not be parsed!", sone), npe1);
 101                         return null;
 102                 }
 103
 104                 Integer protocolVersion = null;
 105                 String soneProtocolVersion = soneXml.getValue("protocol-version", null);
 106                 if (soneProtocolVersion != null) {
 107                         protocolVersion = Numbers.safeParseInteger(soneProtocolVersion);
 108                 }
 109                 if (protocolVersion == null) {
 110                         logger.log(Level.INFO, "No protocol version found, assuming 0.");
 111                         protocolVersion = 0;
 112                 }
 113
 114                 if (protocolVersion < 0) {
 115                         logger.log(Level.WARNING, String.format("Invalid protocol version: %d! Not parsing Sone.", protocolVersion));
 116                         return null;
 117                 }
 118
 119                 /* check for valid versions. */
 120                 if (protocolVersion > MAX_PROTOCOL_VERSION) {
 121                         logger.log(Level.WARNING, String.format("Unknown protocol version: %d! Not parsing Sone.", protocolVersion));
 122                         return null;
 123                 }
 124
 125                 String soneTime = soneXml.getValue("time", null);
 126                 if (soneTime == null) {
 127                         /* TODO - mark Sone as bad. */
 128                         logger.log(Level.WARNING, String.format("Downloaded time for Sone %s was null!", sone));
 129                         return null;
 130                 }
 131                 try {
 132                         sone.setTime(Long.parseLong(soneTime));
 133                 } catch (NumberFormatException nfe1) {
 134                         /* TODO - mark Sone as bad. */
 135                         logger.log(Level.WARNING, String.format("Downloaded Sone %s with invalid time: %s", sone, soneTime));
 136                         return null;
 137                 }
 138
 139                 SimpleXML clientXml = soneXml.getNode("client");
 140                 if (clientXml != null) {
 141                         String clientName = clientXml.getValue("name", null);
 142                         String clientVersion = clientXml.getValue("version", null);
 143                         if ((clientName == null) || (clientVersion == null)) {
 144                                 logger.log(Level.WARNING, String.format("Download Sone %s with client XML but missing name or version!", sone));
 145                                 return null;
 146                         }
 147                         sone.setClient(new Client(clientName, clientVersion));
 148                 }
 149
 150                 SimpleXML profileXml = soneXml.getNode("profile");
 151                 if (profileXml == null) {
 152                         /* TODO - mark Sone as bad. */
 153                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no profile!", sone));
 154                         return null;
 155                 }
 156
 157                 /* parse profile. */
 158                 String profileFirstName = profileXml.getValue("first-name", null);
 159                 String profileMiddleName = profileXml.getValue("middle-name", null);
 160                 String profileLastName = profileXml.getValue("last-name", null);
 161                 Integer profileBirthDay = Numbers.safeParseInteger(profileXml.getValue("birth-day", null));
 162                 Integer profileBirthMonth = Numbers.safeParseInteger(profileXml.getValue("birth-month", null));
 163                 Integer profileBirthYear = Numbers.safeParseInteger(profileXml.getValue("birth-year", null));
 164                 Profile profile = new Profile(sone).modify().setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName).update();
 165                 profile.modify().setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear).update();
 166                 /* avatar is processed after images are loaded. */
 167                 String avatarId = profileXml.getValue("avatar", null);
 168
 169                 /* parse profile fields. */
 170                 SimpleXML profileFieldsXml = profileXml.getNode("fields");
 171                 if (profileFieldsXml != null) {
 172                         for (SimpleXML fieldXml : profileFieldsXml.getNodes("field")) {
 173                                 String fieldName = fieldXml.getValue("field-name", null);
 174                                 String fieldValue = fieldXml.getValue("field-value", "");
 175                                 if (fieldName == null) {
 176                                         logger.log(Level.WARNING, String.format("Downloaded profile field for Sone %s with missing data! Name: %s, Value: %s", sone, fieldName, fieldValue));
 177                                         return null;
 178                                 }
 179                                 try {
 180                                         profile.addField(fieldName).setValue(fieldValue);
 181                                 } catch (IllegalArgumentException iae1) {
 182                                         logger.log(Level.WARNING, String.format("Duplicate field: %s", fieldName), iae1);
 183                                         return null;
 184                                 }
 185                         }
 186                 }
 187
 188                 /* parse posts. */
 189                 SimpleXML postsXml = soneXml.getNode("posts");
 190                 Set<Post> posts = new HashSet<Post>();
 191                 if (postsXml == null) {
 192                         /* TODO - mark Sone as bad. */
 193                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no posts!", sone));
 194                 } else {
 195                         for (SimpleXML postXml : postsXml.getNodes("post")) {
 196                                 String postId = postXml.getValue("id", null);
 197                                 String postRecipientId = postXml.getValue("recipient", null);
 198                                 String postTime = postXml.getValue("time", null);
 199                                 String postText = postXml.getValue("text", null);
 200                                 if ((postId == null) || (postTime == null) || (postText == null)) {
 201                                         /* TODO - mark Sone as bad. */
 202                                         logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", sone, postId, postTime, postText));
 203                                         return null;
 204                                 }
 205                                 try {
 206                                         PostBuilder postBuilder = sone.newPostBuilder();
 207                                         /* TODO - parse time correctly. */
 208                                         postBuilder.withId(postId).withTime(Long.parseLong(postTime)).withText(postText);
 209                                         if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
 210                                                 postBuilder.to(Optional.of(postRecipientId));
 211                                         }
 212                                         posts.add(postBuilder.build(Optional.<PostCreated>absent()));
 213                                 } catch (NumberFormatException nfe1) {
 214                                         /* TODO - mark Sone as bad. */
 215                                         logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with invalid time: %s", sone, postTime));
 216                                         return null;
 217                                 }
 218                         }
 219                 }
 220
 221                 /* parse replies. */
 222                 SimpleXML repliesXml = soneXml.getNode("replies");
 223                 Set<PostReply> replies = new HashSet<PostReply>();
 224                 if (repliesXml == null) {
 225                         /* TODO - mark Sone as bad. */
 226                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no replies!", sone));
 227                 } else {
 228                         for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
 229                                 String replyId = replyXml.getValue("id", null);
 230                                 String replyPostId = replyXml.getValue("post-id", null);
 231                                 String replyTime = replyXml.getValue("time", null);
 232                                 String replyText = replyXml.getValue("text", null);
 233                                 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
 234                                         /* TODO - mark Sone as bad. */
 235                                         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));
 236                                         return null;
 237                                 }
 238                                 try {
 239                                         /* TODO - parse time correctly. */
 240                                         PostReplyBuilder postReplyBuilder = sone.newPostReplyBuilder(replyPostId).withId(replyId).withTime(Long.parseLong(replyTime)).withText(replyText);
 241                                         replies.add(postReplyBuilder.build(Optional.<PostReplyCreated>absent()));
 242                                 } catch (NumberFormatException nfe1) {
 243                                         /* TODO - mark Sone as bad. */
 244                                         logger.log(Level.WARNING, String.format("Downloaded reply for Sone %s with invalid time: %s", sone, replyTime));
 245                                         return null;
 246                                 }
 247                         }
 248                 }
 249
 250                 /* parse liked post IDs. */
 251                 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
 252                 Set<String> likedPostIds = new HashSet<String>();
 253                 if (likePostIdsXml == null) {
 254                         /* TODO - mark Sone as bad. */
 255                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no post likes!", sone));
 256                 } else {
 257                         for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
 258                                 String postId = likedPostIdXml.getValue();
 259                                 likedPostIds.add(postId);
 260                         }
 261                 }
 262
 263                 /* parse liked reply IDs. */
 264                 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
 265                 Set<String> likedReplyIds = new HashSet<String>();
 266                 if (likeReplyIdsXml == null) {
 267                         /* TODO - mark Sone as bad. */
 268                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no reply likes!", sone));
 269                 } else {
 270                         for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
 271                                 String replyId = likedReplyIdXml.getValue();
 272                                 likedReplyIds.add(replyId);
 273                         }
 274                 }
 275
 276                 /* parse albums. */
 277                 SimpleXML albumsXml = soneXml.getNode("albums");
 278                 Map<String, Album> albums = Maps.newHashMap();
 279                 if (albumsXml != null) {
 280                         for (SimpleXML albumXml : albumsXml.getNodes("album")) {
 281                                 String id = albumXml.getValue("id", null);
 282                                 String parentId = albumXml.getValue("parent", null);
 283                                 String title = albumXml.getValue("title", null);
 284                                 String description = albumXml.getValue("description", "");
 285                                 String albumImageId = albumXml.getValue("album-image", null);
 286                                 if ((id == null) || (title == null) || (description == null)) {
 287                                         logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid album!", sone));
 288                                         return null;
 289                                 }
 290                                 Album parent = sone.getRootAlbum();
 291                                 if (parentId != null) {
 292                                         parent = albums.get(parentId);
 293                                         if (parent == null) {
 294                                                 logger.log(Level.WARNING, String.format("Downloaded Sone %s has album with invalid parent!", sone));
 295                                                 return null;
 296                                         }
 297                                 }
 298                                 Album album = parent.newAlbumBuilder().withId(id).build().modify().setTitle(title).setDescription(description).update();
 299                                 albums.put(album.getId(), album);
 300                                 SimpleXML imagesXml = albumXml.getNode("images");
 301                                 if (imagesXml != null) {
 302                                         for (SimpleXML imageXml : imagesXml.getNodes("image")) {
 303                                                 String imageId = imageXml.getValue("id", null);
 304                                                 String imageCreationTimeString = imageXml.getValue("creation-time", null);
 305                                                 String imageKey = imageXml.getValue("key", null);
 306                                                 String imageTitle = imageXml.getValue("title", null);
 307                                                 String imageDescription = imageXml.getValue("description", "");
 308                                                 String imageWidthString = imageXml.getValue("width", null);
 309                                                 String imageHeightString = imageXml.getValue("height", null);
 310                                                 if ((imageId == null) || (imageCreationTimeString == null) || (imageKey == null) || (imageTitle == null) || (imageWidthString == null) || (imageHeightString == null)) {
 311                                                         logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid images!", sone));
 312                                                         return null;
 313                                                 }
 314                                                 long creationTime = Numbers.safeParseLong(imageCreationTimeString, 0L);
 315                                                 int imageWidth = Numbers.safeParseInteger(imageWidthString, 0);
 316                                                 int imageHeight = Numbers.safeParseInteger(imageHeightString, 0);
 317                                                 if ((imageWidth < 1) || (imageHeight < 1)) {
 318                                                         logger.log(Level.WARNING, String.format("Downloaded Sone %s contains image %s with invalid dimensions (%s, %s)!", sone, imageId, imageWidthString, imageHeightString));
 319                                                         return null;
 320                                                 }
 321                                                 Image image = album.newImageBuilder().withId(imageId).at(imageKey).created(creationTime).sized(imageWidth, imageHeight).build(Optional.<ImageCreated>absent());
 322                                                 image = image.modify().setTitle(imageTitle).setDescription(imageDescription).update();
 323                                         }
 324                                 }
 325                                 album.modify().setAlbumImage(albumImageId).update();
 326                         }
 327                 }
 328
 329                 /* process avatar. */
 330                 if (avatarId != null) {
 331                         profile.setAvatar(core.getImage(avatarId).orNull());
 332                 }
 333
 334                 /* okay, apparently everything was parsed correctly. Now import. */
 335                 sone.setProfile(profile);
 336                 sone.setPosts(posts);
 337                 sone.setReplies(replies);
 338                 sone.setLikePostIds(likedPostIds);
 339                 sone.setLikeReplyIds(likedReplyIds);
 340
 341                 return sone;
 342         }
 343 }