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()).setIdentity(originalSone.getIdentity());
  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                 String soneRequestUri = soneXml.getValue("request-uri", null);
 151                 if (soneRequestUri != null) {
 152                         try {
 153                                 sone.setRequestUri(new FreenetURI(soneRequestUri));
 154                         } catch (MalformedURLException mue1) {
 155                                 /* TODO - mark Sone as bad. */
 156                                 logger.log(Level.WARNING, String.format("Downloaded Sone %s has invalid request URI: %s", sone, soneRequestUri), mue1);
 157                                 return null;
 158                         }
 159                 }
 160
 161                 if (originalSone.getInsertUri() != null) {
 162                         sone.setInsertUri(originalSone.getInsertUri());
 163                 }
 164
 165                 SimpleXML profileXml = soneXml.getNode("profile");
 166                 if (profileXml == null) {
 167                         /* TODO - mark Sone as bad. */
 168                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no profile!", sone));
 169                         return null;
 170                 }
 171
 172                 /* parse profile. */
 173                 String profileFirstName = profileXml.getValue("first-name", null);
 174                 String profileMiddleName = profileXml.getValue("middle-name", null);
 175                 String profileLastName = profileXml.getValue("last-name", null);
 176                 Integer profileBirthDay = Numbers.safeParseInteger(profileXml.getValue("birth-day", null));
 177                 Integer profileBirthMonth = Numbers.safeParseInteger(profileXml.getValue("birth-month", null));
 178                 Integer profileBirthYear = Numbers.safeParseInteger(profileXml.getValue("birth-year", null));
 179                 Profile profile = new Profile(sone).modify().setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName).update();
 180                 profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
 181                 /* avatar is processed after images are loaded. */
 182                 String avatarId = profileXml.getValue("avatar", null);
 183
 184                 /* parse profile fields. */
 185                 SimpleXML profileFieldsXml = profileXml.getNode("fields");
 186                 if (profileFieldsXml != null) {
 187                         for (SimpleXML fieldXml : profileFieldsXml.getNodes("field")) {
 188                                 String fieldName = fieldXml.getValue("field-name", null);
 189                                 String fieldValue = fieldXml.getValue("field-value", "");
 190                                 if (fieldName == null) {
 191                                         logger.log(Level.WARNING, String.format("Downloaded profile field for Sone %s with missing data! Name: %s, Value: %s", sone, fieldName, fieldValue));
 192                                         return null;
 193                                 }
 194                                 try {
 195                                         profile.addField(fieldName).setValue(fieldValue);
 196                                 } catch (IllegalArgumentException iae1) {
 197                                         logger.log(Level.WARNING, String.format("Duplicate field: %s", fieldName), iae1);
 198                                         return null;
 199                                 }
 200                         }
 201                 }
 202
 203                 /* parse posts. */
 204                 SimpleXML postsXml = soneXml.getNode("posts");
 205                 Set<Post> posts = new HashSet<Post>();
 206                 if (postsXml == null) {
 207                         /* TODO - mark Sone as bad. */
 208                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no posts!", sone));
 209                 } else {
 210                         for (SimpleXML postXml : postsXml.getNodes("post")) {
 211                                 String postId = postXml.getValue("id", null);
 212                                 String postRecipientId = postXml.getValue("recipient", null);
 213                                 String postTime = postXml.getValue("time", null);
 214                                 String postText = postXml.getValue("text", null);
 215                                 if ((postId == null) || (postTime == null) || (postText == null)) {
 216                                         /* TODO - mark Sone as bad. */
 217                                         logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", sone, postId, postTime, postText));
 218                                         return null;
 219                                 }
 220                                 try {
 221                                         PostBuilder postBuilder = sone.newPostBuilder();
 222                                         /* TODO - parse time correctly. */
 223                                         postBuilder.withId(postId).withTime(Long.parseLong(postTime)).withText(postText);
 224                                         if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
 225                                                 postBuilder.to(Optional.of(postRecipientId));
 226                                         }
 227                                         posts.add(postBuilder.build(Optional.<PostCreated>absent()));
 228                                 } catch (NumberFormatException nfe1) {
 229                                         /* TODO - mark Sone as bad. */
 230                                         logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with invalid time: %s", sone, postTime));
 231                                         return null;
 232                                 }
 233                         }
 234                 }
 235
 236                 /* parse replies. */
 237                 SimpleXML repliesXml = soneXml.getNode("replies");
 238                 Set<PostReply> replies = new HashSet<PostReply>();
 239                 if (repliesXml == null) {
 240                         /* TODO - mark Sone as bad. */
 241                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no replies!", sone));
 242                 } else {
 243                         for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
 244                                 String replyId = replyXml.getValue("id", null);
 245                                 String replyPostId = replyXml.getValue("post-id", null);
 246                                 String replyTime = replyXml.getValue("time", null);
 247                                 String replyText = replyXml.getValue("text", null);
 248                                 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
 249                                         /* TODO - mark Sone as bad. */
 250                                         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));
 251                                         return null;
 252                                 }
 253                                 try {
 254                                         /* TODO - parse time correctly. */
 255                                         PostReplyBuilder postReplyBuilder = sone.newPostReplyBuilder(replyPostId).withId(replyId).withTime(Long.parseLong(replyTime)).withText(replyText);
 256                                         replies.add(postReplyBuilder.build(Optional.<PostReplyCreated>absent()));
 257                                 } catch (NumberFormatException nfe1) {
 258                                         /* TODO - mark Sone as bad. */
 259                                         logger.log(Level.WARNING, String.format("Downloaded reply for Sone %s with invalid time: %s", sone, replyTime));
 260                                         return null;
 261                                 }
 262                         }
 263                 }
 264
 265                 /* parse liked post IDs. */
 266                 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
 267                 Set<String> likedPostIds = new HashSet<String>();
 268                 if (likePostIdsXml == null) {
 269                         /* TODO - mark Sone as bad. */
 270                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no post likes!", sone));
 271                 } else {
 272                         for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
 273                                 String postId = likedPostIdXml.getValue();
 274                                 likedPostIds.add(postId);
 275                         }
 276                 }
 277
 278                 /* parse liked reply IDs. */
 279                 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
 280                 Set<String> likedReplyIds = new HashSet<String>();
 281                 if (likeReplyIdsXml == null) {
 282                         /* TODO - mark Sone as bad. */
 283                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no reply likes!", sone));
 284                 } else {
 285                         for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
 286                                 String replyId = likedReplyIdXml.getValue();
 287                                 likedReplyIds.add(replyId);
 288                         }
 289                 }
 290
 291                 /* parse albums. */
 292                 SimpleXML albumsXml = soneXml.getNode("albums");
 293                 Map<String, Album> albums = Maps.newHashMap();
 294                 if (albumsXml != null) {
 295                         for (SimpleXML albumXml : albumsXml.getNodes("album")) {
 296                                 String id = albumXml.getValue("id", null);
 297                                 String parentId = albumXml.getValue("parent", null);
 298                                 String title = albumXml.getValue("title", null);
 299                                 String description = albumXml.getValue("description", "");
 300                                 String albumImageId = albumXml.getValue("album-image", null);
 301                                 if ((id == null) || (title == null) || (description == null)) {
 302                                         logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid album!", sone));
 303                                         return null;
 304                                 }
 305                                 Album parent = sone.getRootAlbum();
 306                                 if (parentId != null) {
 307                                         parent = albums.get(parentId);
 308                                         if (parent == null) {
 309                                                 logger.log(Level.WARNING, String.format("Downloaded Sone %s has album with invalid parent!", sone));
 310                                                 return null;
 311                                         }
 312                                 }
 313                                 Album album = parent.newAlbumBuilder().withId(id).build().modify().setTitle(title).setDescription(description).update();
 314                                 albums.put(album.getId(), album);
 315                                 SimpleXML imagesXml = albumXml.getNode("images");
 316                                 if (imagesXml != null) {
 317                                         for (SimpleXML imageXml : imagesXml.getNodes("image")) {
 318                                                 String imageId = imageXml.getValue("id", null);
 319                                                 String imageCreationTimeString = imageXml.getValue("creation-time", null);
 320                                                 String imageKey = imageXml.getValue("key", null);
 321                                                 String imageTitle = imageXml.getValue("title", null);
 322                                                 String imageDescription = imageXml.getValue("description", "");
 323                                                 String imageWidthString = imageXml.getValue("width", null);
 324                                                 String imageHeightString = imageXml.getValue("height", null);
 325                                                 if ((imageId == null) || (imageCreationTimeString == null) || (imageKey == null) || (imageTitle == null) || (imageWidthString == null) || (imageHeightString == null)) {
 326                                                         logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid images!", sone));
 327                                                         return null;
 328                                                 }
 329                                                 long creationTime = Numbers.safeParseLong(imageCreationTimeString, 0L);
 330                                                 int imageWidth = Numbers.safeParseInteger(imageWidthString, 0);
 331                                                 int imageHeight = Numbers.safeParseInteger(imageHeightString, 0);
 332                                                 if ((imageWidth < 1) || (imageHeight < 1)) {
 333                                                         logger.log(Level.WARNING, String.format("Downloaded Sone %s contains image %s with invalid dimensions (%s, %s)!", sone, imageId, imageWidthString, imageHeightString));
 334                                                         return null;
 335                                                 }
 336                                                 Image image = album.newImageBuilder().withId(imageId).at(imageKey).created(creationTime).sized(imageWidth, imageHeight).build(Optional.<ImageCreated>absent());
 337                                                 image = image.modify().setTitle(imageTitle).setDescription(imageDescription).update();
 338                                         }
 339                                 }
 340                                 album.modify().setAlbumImage(albumImageId).update();
 341                         }
 342                 }
 343
 344                 /* process avatar. */
 345                 if (avatarId != null) {
 346                         profile.setAvatar(core.getImage(avatarId).orNull());
 347                 }
 348
 349                 /* okay, apparently everything was parsed correctly. Now import. */
 350                 sone.setProfile(profile);
 351                 sone.setPosts(posts);
 352                 sone.setReplies(replies);
 353                 sone.setLikePostIds(likedPostIds);
 354                 sone.setLikeReplyIds(likedReplyIds);
 355
 356                 return sone;
 357         }
 358 }