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

   1 /*
   2  * Sone - SoneDownloader.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.ArrayList;
  23 import java.util.HashSet;
  24 import java.util.List;
  25 import java.util.Set;
  26 import java.util.logging.Level;
  27 import java.util.logging.Logger;
  28
  29 import net.pterodactylus.sone.core.FreenetInterface.Fetched;
  30 import net.pterodactylus.sone.data.Album;
  31 import net.pterodactylus.sone.data.Client;
  32 import net.pterodactylus.sone.data.Image;
  33 import net.pterodactylus.sone.data.Post;
  34 import net.pterodactylus.sone.data.PostReply;
  35 import net.pterodactylus.sone.data.Profile;
  36 import net.pterodactylus.sone.data.Sone;
  37 import net.pterodactylus.sone.data.Sone.SoneStatus;
  38 import net.pterodactylus.util.io.Closer;
  39 import net.pterodactylus.util.logging.Logging;
  40 import net.pterodactylus.util.service.AbstractService;
  41 import net.pterodactylus.util.xml.SimpleXML;
  42 import net.pterodactylus.util.xml.XML;
  43
  44 import org.w3c.dom.Document;
  45
  46 import com.google.common.base.Optional;
  47 import com.google.common.primitives.Ints;
  48 import com.google.common.primitives.Longs;
  49
  50 import freenet.client.FetchResult;
  51 import freenet.keys.FreenetURI;
  52 import freenet.support.api.Bucket;
  53
  54 /**
  55  * The Sone downloader is responsible for download Sones as they are updated.
  56  *
  57  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  58  */
  59 public class SoneDownloader extends AbstractService {
  60
  61         /** The logger. */
  62         private static final Logger logger = Logging.getLogger(SoneDownloader.class);
  63
  64         /** The maximum protocol version. */
  65         private static final int MAX_PROTOCOL_VERSION = 0;
  66
  67         /** The core. */
  68         private final Core core;
  69
  70         /** The Freenet interface. */
  71         private final FreenetInterface freenetInterface;
  72
  73         /** The sones to update. */
  74         private final Set<Sone> sones = new HashSet<Sone>();
  75
  76         /**
  77          * Creates a new Sone downloader.
  78          *
  79          * @param core
  80          *            The core
  81          * @param freenetInterface
  82          *            The Freenet interface
  83          */
  84         public SoneDownloader(Core core, FreenetInterface freenetInterface) {
  85                 super("Sone Downloader", false);
  86                 this.core = core;
  87                 this.freenetInterface = freenetInterface;
  88         }
  89
  90         //
  91         // ACTIONS
  92         //
  93
  94         /**
  95          * Adds the given Sone to the set of Sones that will be watched for updates.
  96          *
  97          * @param sone
  98          *            The Sone to add
  99          */
 100         public void addSone(Sone sone) {
 101                 if (!sones.add(sone)) {
 102                         freenetInterface.unregisterUsk(sone);
 103                 }
 104                 freenetInterface.registerUsk(sone, this);
 105         }
 106
 107         /**
 108          * Removes the given Sone from the downloader.
 109          *
 110          * @param sone
 111          *            The Sone to stop watching
 112          */
 113         public void removeSone(Sone sone) {
 114                 if (sones.remove(sone)) {
 115                         freenetInterface.unregisterUsk(sone);
 116                 }
 117         }
 118
 119         /**
 120          * Fetches the updated Sone. This method is a callback method for
 121          * {@link FreenetInterface#registerUsk(Sone, SoneDownloader)}.
 122          *
 123          * @param sone
 124          *            The Sone to fetch
 125          */
 126         public void fetchSone(Sone sone) {
 127                 fetchSone(sone, sone.getRequestUri().sskForUSK());
 128         }
 129
 130         /**
 131          * Fetches the updated Sone. This method can be used to fetch a Sone from a
 132          * specific URI.
 133          *
 134          * @param sone
 135          *            The Sone to fetch
 136          * @param soneUri
 137          *            The URI to fetch the Sone from
 138          */
 139         public void fetchSone(Sone sone, FreenetURI soneUri) {
 140                 fetchSone(sone, soneUri, false);
 141         }
 142
 143         /**
 144          * Fetches the Sone from the given URI.
 145          *
 146          * @param sone
 147          *            The Sone to fetch
 148          * @param soneUri
 149          *            The URI of the Sone to fetch
 150          * @param fetchOnly
 151          *            {@code true} to only fetch and parse the Sone, {@code false}
 152          *            to {@link Core#updateSone(Sone) update} it in the core
 153          * @return The downloaded Sone, or {@code null} if the Sone could not be
 154          *         downloaded
 155          */
 156         public Sone fetchSone(Sone sone, FreenetURI soneUri, boolean fetchOnly) {
 157                 logger.log(Level.FINE, String.format("Starting fetch for Sone “%s” from %s…", sone, soneUri));
 158                 FreenetURI requestUri = soneUri.setMetaString(new String[] { "sone.xml" });
 159                 sone.setStatus(SoneStatus.downloading);
 160                 try {
 161                         Fetched fetchResults = freenetInterface.fetchUri(requestUri);
 162                         if (fetchResults == null) {
 163                                 /* TODO - mark Sone as bad. */
 164                                 return null;
 165                         }
 166                         logger.log(Level.FINEST, String.format("Got %d bytes back.", fetchResults.getFetchResult().size()));
 167                         Sone parsedSone = parseSone(sone, fetchResults.getFetchResult(), fetchResults.getFreenetUri());
 168                         if (parsedSone != null) {
 169                                 if (!fetchOnly) {
 170                                         core.updateSone(parsedSone);
 171                                         addSone(parsedSone);
 172                                 }
 173                         }
 174                         return parsedSone;
 175                 } finally {
 176                         sone.setStatus((sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
 177                 }
 178         }
 179
 180         /**
 181          * Parses a Sone from a fetch result.
 182          *
 183          * @param originalSone
 184          *            The sone to parse, or {@code null} if the Sone is yet unknown
 185          * @param fetchResult
 186          *            The fetch result
 187          * @param requestUri
 188          *            The requested URI
 189          * @return The parsed Sone, or {@code null} if the Sone could not be parsed
 190          */
 191         public Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
 192                 logger.log(Level.FINEST, String.format("Parsing FetchResult (%d bytes, %s) for %s…", fetchResult.size(), fetchResult.getMimeType(), originalSone));
 193                 Bucket soneBucket = fetchResult.asBucket();
 194                 InputStream soneInputStream = null;
 195                 try {
 196                         soneInputStream = soneBucket.getInputStream();
 197                         Sone parsedSone = parseSone(originalSone, soneInputStream);
 198                         if (parsedSone != null) {
 199                                 parsedSone.setLatestEdition(requestUri.getEdition());
 200                                 if (requestUri.getKeyType().equals("USK")) {
 201                                         parsedSone.setRequestUri(requestUri.setMetaString(new String[0]));
 202                                 } else {
 203                                         parsedSone.setRequestUri(requestUri.setKeyType("USK").setDocName("Sone").setMetaString(new String[0]));
 204                                 }
 205                         }
 206                         return parsedSone;
 207                 } catch (Exception e1) {
 208                         logger.log(Level.WARNING, String.format("Could not parse Sone from %s!", requestUri), e1);
 209                 } finally {
 210                         Closer.close(soneInputStream);
 211                         soneBucket.free();
 212                 }
 213                 return null;
 214         }
 215
 216         /**
 217          * Parses a Sone from the given input stream and creates a new Sone from the
 218          * parsed data.
 219          *
 220          * @param originalSone
 221          *            The Sone to update
 222          * @param soneInputStream
 223          *            The input stream to parse the Sone from
 224          * @return The parsed Sone
 225          * @throws SoneException
 226          *             if a parse error occurs, or the protocol is invalid
 227          */
 228         public Sone parseSone(Sone originalSone, InputStream soneInputStream) throws SoneException {
 229                 /* TODO - impose a size limit? */
 230
 231                 Document document;
 232                 /* XML parsing is not thread-safe. */
 233                 synchronized (this) {
 234                         document = XML.transformToDocument(soneInputStream);
 235                 }
 236                 if (document == null) {
 237                         /* TODO - mark Sone as bad. */
 238                         logger.log(Level.WARNING, String.format("Could not parse XML for Sone %s!", originalSone));
 239                         return null;
 240                 }
 241
 242                 Sone sone = new Sone(originalSone.getId(), false).setIdentity(originalSone.getIdentity());
 243
 244                 SimpleXML soneXml;
 245                 try {
 246                         soneXml = SimpleXML.fromDocument(document);
 247                 } catch (NullPointerException npe1) {
 248                         /* for some reason, invalid XML can cause NPEs. */
 249                         logger.log(Level.WARNING, String.format("XML for Sone %s can not be parsed!", sone), npe1);
 250                         return null;
 251                 }
 252
 253                 Integer protocolVersion = null;
 254                 String soneProtocolVersion = soneXml.getValue("protocol-version", null);
 255                 if (soneProtocolVersion != null) {
 256                         protocolVersion = Optional.fromNullable(Ints.tryParse(soneProtocolVersion)).or(0);
 257                 }
 258                 if (protocolVersion == null) {
 259                         logger.log(Level.INFO, "No protocol version found, assuming 0.");
 260                         protocolVersion = 0;
 261                 }
 262
 263                 if (protocolVersion < 0) {
 264                         logger.log(Level.WARNING, String.format("Invalid protocol version: %d! Not parsing Sone.", protocolVersion));
 265                         return null;
 266                 }
 267
 268                 /* check for valid versions. */
 269                 if (protocolVersion > MAX_PROTOCOL_VERSION) {
 270                         logger.log(Level.WARNING, String.format("Unknown protocol version: %d! Not parsing Sone.", protocolVersion));
 271                         return null;
 272                 }
 273
 274                 String soneTime = soneXml.getValue("time", null);
 275                 if (soneTime == null) {
 276                         /* TODO - mark Sone as bad. */
 277                         logger.log(Level.WARNING, String.format("Downloaded time for Sone %s was null!", sone));
 278                         return null;
 279                 }
 280                 try {
 281                         sone.setTime(Long.parseLong(soneTime));
 282                 } catch (NumberFormatException nfe1) {
 283                         /* TODO - mark Sone as bad. */
 284                         logger.log(Level.WARNING, String.format("Downloaded Sone %s with invalid time: %s", sone, soneTime));
 285                         return null;
 286                 }
 287
 288                 SimpleXML clientXml = soneXml.getNode("client");
 289                 if (clientXml != null) {
 290                         String clientName = clientXml.getValue("name", null);
 291                         String clientVersion = clientXml.getValue("version", null);
 292                         if ((clientName == null) || (clientVersion == null)) {
 293                                 logger.log(Level.WARNING, String.format("Download Sone %s with client XML but missing name or version!", sone));
 294                                 return null;
 295                         }
 296                         sone.setClient(new Client(clientName, clientVersion));
 297                 }
 298
 299                 String soneRequestUri = soneXml.getValue("request-uri", null);
 300                 if (soneRequestUri != null) {
 301                         try {
 302                                 sone.setRequestUri(new FreenetURI(soneRequestUri));
 303                         } catch (MalformedURLException mue1) {
 304                                 /* TODO - mark Sone as bad. */
 305                                 logger.log(Level.WARNING, String.format("Downloaded Sone %s has invalid request URI: %s", sone, soneRequestUri), mue1);
 306                                 return null;
 307                         }
 308                 }
 309
 310                 String soneInsertUri = soneXml.getValue("insert-uri", null);
 311                 if ((soneInsertUri != null) && (sone.getInsertUri() == null)) {
 312                         try {
 313                                 sone.setInsertUri(new FreenetURI(soneInsertUri));
 314                                 sone.setLatestEdition(Math.max(sone.getRequestUri().getEdition(), sone.getInsertUri().getEdition()));
 315                         } catch (MalformedURLException mue1) {
 316                                 /* TODO - mark Sone as bad. */
 317                                 logger.log(Level.WARNING, String.format("Downloaded Sone %s has invalid insert URI: %s", sone, soneInsertUri), mue1);
 318                                 return null;
 319                         }
 320                 }
 321
 322                 SimpleXML profileXml = soneXml.getNode("profile");
 323                 if (profileXml == null) {
 324                         /* TODO - mark Sone as bad. */
 325                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no profile!", sone));
 326                         return null;
 327                 }
 328
 329                 /* parse profile. */
 330                 String profileFirstName = profileXml.getValue("first-name", null);
 331                 String profileMiddleName = profileXml.getValue("middle-name", null);
 332                 String profileLastName = profileXml.getValue("last-name", null);
 333                 Integer profileBirthDay = Ints.tryParse(profileXml.getValue("birth-day", null));
 334                 Integer profileBirthMonth = Ints.tryParse(profileXml.getValue("birth-month", null));
 335                 Integer profileBirthYear = Ints.tryParse(profileXml.getValue("birth-year", null));
 336                 Profile profile = new Profile(sone).setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
 337                 profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
 338                 /* avatar is processed after images are loaded. */
 339                 String avatarId = profileXml.getValue("avatar", null);
 340
 341                 /* parse profile fields. */
 342                 SimpleXML profileFieldsXml = profileXml.getNode("fields");
 343                 if (profileFieldsXml != null) {
 344                         for (SimpleXML fieldXml : profileFieldsXml.getNodes("field")) {
 345                                 String fieldName = fieldXml.getValue("field-name", null);
 346                                 String fieldValue = fieldXml.getValue("field-value", "");
 347                                 if (fieldName == null) {
 348                                         logger.log(Level.WARNING, String.format("Downloaded profile field for Sone %s with missing data! Name: %s, Value: %s", sone, fieldName, fieldValue));
 349                                         return null;
 350                                 }
 351                                 try {
 352                                         profile.addField(fieldName).setValue(fieldValue);
 353                                 } catch (IllegalArgumentException iae1) {
 354                                         logger.log(Level.WARNING, String.format("Duplicate field: %s", fieldName), iae1);
 355                                         return null;
 356                                 }
 357                         }
 358                 }
 359
 360                 /* parse posts. */
 361                 SimpleXML postsXml = soneXml.getNode("posts");
 362                 Set<Post> posts = new HashSet<Post>();
 363                 if (postsXml == null) {
 364                         /* TODO - mark Sone as bad. */
 365                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no posts!", sone));
 366                 } else {
 367                         for (SimpleXML postXml : postsXml.getNodes("post")) {
 368                                 String postId = postXml.getValue("id", null);
 369                                 String postRecipientId = postXml.getValue("recipient", null);
 370                                 String postTime = postXml.getValue("time", null);
 371                                 String postText = postXml.getValue("text", null);
 372                                 if ((postId == null) || (postTime == null) || (postText == null)) {
 373                                         /* TODO - mark Sone as bad. */
 374                                         logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", sone, postId, postTime, postText));
 375                                         return null;
 376                                 }
 377                                 try {
 378                                         Post post = core.getPost(postId).setSone(sone).setTime(Long.parseLong(postTime)).setText(postText);
 379                                         if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
 380                                                 post.setRecipient(core.getSone(postRecipientId));
 381                                         }
 382                                         posts.add(post);
 383                                 } catch (NumberFormatException nfe1) {
 384                                         /* TODO - mark Sone as bad. */
 385                                         logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with invalid time: %s", sone, postTime));
 386                                         return null;
 387                                 }
 388                         }
 389                 }
 390
 391                 /* parse replies. */
 392                 SimpleXML repliesXml = soneXml.getNode("replies");
 393                 Set<PostReply> replies = new HashSet<PostReply>();
 394                 if (repliesXml == null) {
 395                         /* TODO - mark Sone as bad. */
 396                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no replies!", sone));
 397                 } else {
 398                         for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
 399                                 String replyId = replyXml.getValue("id", null);
 400                                 String replyPostId = replyXml.getValue("post-id", null);
 401                                 String replyTime = replyXml.getValue("time", null);
 402                                 String replyText = replyXml.getValue("text", null);
 403                                 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
 404                                         /* TODO - mark Sone as bad. */
 405                                         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));
 406                                         return null;
 407                                 }
 408                                 try {
 409                                         replies.add(core.getPostReply(replyId, true).setSone(sone).setPost(core.getPost(replyPostId)).setTime(Long.parseLong(replyTime)).setText(replyText));
 410                                 } catch (NumberFormatException nfe1) {
 411                                         /* TODO - mark Sone as bad. */
 412                                         logger.log(Level.WARNING, String.format("Downloaded reply for Sone %s with invalid time: %s", sone, replyTime));
 413                                         return null;
 414                                 }
 415                         }
 416                 }
 417
 418                 /* parse liked post IDs. */
 419                 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
 420                 Set<String> likedPostIds = new HashSet<String>();
 421                 if (likePostIdsXml == null) {
 422                         /* TODO - mark Sone as bad. */
 423                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no post likes!", sone));
 424                 } else {
 425                         for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
 426                                 String postId = likedPostIdXml.getValue();
 427                                 likedPostIds.add(postId);
 428                         }
 429                 }
 430
 431                 /* parse liked reply IDs. */
 432                 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
 433                 Set<String> likedReplyIds = new HashSet<String>();
 434                 if (likeReplyIdsXml == null) {
 435                         /* TODO - mark Sone as bad. */
 436                         logger.log(Level.WARNING, String.format("Downloaded Sone %s has no reply likes!", sone));
 437                 } else {
 438                         for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
 439                                 String replyId = likedReplyIdXml.getValue();
 440                                 likedReplyIds.add(replyId);
 441                         }
 442                 }
 443
 444                 /* parse albums. */
 445                 SimpleXML albumsXml = soneXml.getNode("albums");
 446                 List<Album> topLevelAlbums = new ArrayList<Album>();
 447                 if (albumsXml != null) {
 448                         for (SimpleXML albumXml : albumsXml.getNodes("album")) {
 449                                 String id = albumXml.getValue("id", null);
 450                                 String parentId = albumXml.getValue("parent", null);
 451                                 String title = albumXml.getValue("title", null);
 452                                 String description = albumXml.getValue("description", "");
 453                                 String albumImageId = albumXml.getValue("album-image", null);
 454                                 if ((id == null) || (title == null) || (description == null)) {
 455                                         logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid album!", sone));
 456                                         return null;
 457                                 }
 458                                 Album parent = null;
 459                                 if (parentId != null) {
 460                                         parent = core.getAlbum(parentId, false);
 461                                         if (parent == null) {
 462                                                 logger.log(Level.WARNING, String.format("Downloaded Sone %s has album with invalid parent!", sone));
 463                                                 return null;
 464                                         }
 465                                 }
 466                                 Album album = core.getAlbum(id).setSone(sone).setTitle(title).setDescription(description);
 467                                 if (parent != null) {
 468                                         parent.addAlbum(album);
 469                                 } else {
 470                                         topLevelAlbums.add(album);
 471                                 }
 472                                 SimpleXML imagesXml = albumXml.getNode("images");
 473                                 if (imagesXml != null) {
 474                                         for (SimpleXML imageXml : imagesXml.getNodes("image")) {
 475                                                 String imageId = imageXml.getValue("id", null);
 476                                                 String imageCreationTimeString = imageXml.getValue("creation-time", null);
 477                                                 String imageKey = imageXml.getValue("key", null);
 478                                                 String imageTitle = imageXml.getValue("title", null);
 479                                                 String imageDescription = imageXml.getValue("description", "");
 480                                                 String imageWidthString = imageXml.getValue("width", null);
 481                                                 String imageHeightString = imageXml.getValue("height", null);
 482                                                 if ((imageId == null) || (imageCreationTimeString == null) || (imageKey == null) || (imageTitle == null) || (imageWidthString == null) || (imageHeightString == null)) {
 483                                                         logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid images!", sone));
 484                                                         return null;
 485                                                 }
 486                                                 long creationTime = Optional.fromNullable(Longs.tryParse(imageCreationTimeString)).or(0L);
 487                                                 int imageWidth = Optional.fromNullable(Ints.tryParse(imageWidthString)).or(0);
 488                                                 int imageHeight = Optional.fromNullable(Ints.tryParse(imageHeightString)).or(0);
 489                                                 if ((imageWidth < 1) || (imageHeight < 1)) {
 490                                                         logger.log(Level.WARNING, String.format("Downloaded Sone %s contains image %s with invalid dimensions (%s, %s)!", sone, imageId, imageWidthString, imageHeightString));
 491                                                         return null;
 492                                                 }
 493                                                 Image image = core.getImage(imageId).setSone(sone).setKey(imageKey).setCreationTime(creationTime);
 494                                                 image.setTitle(imageTitle).setDescription(imageDescription);
 495                                                 image.setWidth(imageWidth).setHeight(imageHeight);
 496                                                 album.addImage(image);
 497                                         }
 498                                 }
 499                                 album.setAlbumImage(albumImageId);
 500                         }
 501                 }
 502
 503                 /* process avatar. */
 504                 if (avatarId != null) {
 505                         profile.setAvatar(core.getImage(avatarId, false));
 506                 }
 507
 508                 /* okay, apparently everything was parsed correctly. Now import. */
 509                 /* atomic setter operation on the Sone. */
 510                 synchronized (sone) {
 511                         sone.setProfile(profile);
 512                         sone.setPosts(posts);
 513                         sone.setReplies(replies);
 514                         sone.setLikePostIds(likedPostIds);
 515                         sone.setLikeReplyIds(likedReplyIds);
 516                         sone.setAlbums(topLevelAlbums);
 517                 }
 518
 519                 return sone;
 520         }
 521
 522         //
 523         // SERVICE METHODS
 524         //
 525
 526         /**
 527          * {@inheritDoc}
 528          */
 529         @Override
 530         protected void serviceStop() {
 531                 for (Sone sone : sones) {
 532                         freenetInterface.unregisterUsk(sone);
 533                 }
 534         }
 535
 536 }