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

   1 /*
   2  * Sone - SoneDownloader.java - Copyright © 2010 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.IOException;
  21 import java.io.InputStream;
  22 import java.net.MalformedURLException;
  23 import java.util.HashSet;
  24 import java.util.Set;
  25 import java.util.logging.Level;
  26 import java.util.logging.Logger;
  27
  28 import net.pterodactylus.sone.core.Core.SoneStatus;
  29 import net.pterodactylus.sone.data.Post;
  30 import net.pterodactylus.sone.data.Profile;
  31 import net.pterodactylus.sone.data.Reply;
  32 import net.pterodactylus.sone.data.Sone;
  33 import net.pterodactylus.util.collection.Pair;
  34 import net.pterodactylus.util.io.Closer;
  35 import net.pterodactylus.util.logging.Logging;
  36 import net.pterodactylus.util.number.Numbers;
  37 import net.pterodactylus.util.service.AbstractService;
  38 import net.pterodactylus.util.xml.SimpleXML;
  39 import net.pterodactylus.util.xml.XML;
  40
  41 import org.w3c.dom.Document;
  42
  43 import freenet.client.FetchResult;
  44 import freenet.keys.FreenetURI;
  45 import freenet.support.api.Bucket;
  46
  47 /**
  48  * The Sone downloader is responsible for download Sones as they are updated.
  49  *
  50  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  51  */
  52 public class SoneDownloader extends AbstractService {
  53
  54         /** The logger. */
  55         private static final Logger logger = Logging.getLogger(SoneDownloader.class);
  56
  57         /** The core. */
  58         private final Core core;
  59
  60         /** The Freenet interface. */
  61         private final FreenetInterface freenetInterface;
  62
  63         /** The sones to update. */
  64         private final Set<Sone> sones = new HashSet<Sone>();
  65
  66         /**
  67          * Creates a new Sone downloader.
  68          *
  69          * @param core
  70          *            The core
  71          * @param freenetInterface
  72          *            The Freenet interface
  73          */
  74         public SoneDownloader(Core core, FreenetInterface freenetInterface) {
  75                 super("Sone Downloader", false);
  76                 this.core = core;
  77                 this.freenetInterface = freenetInterface;
  78         }
  79
  80         //
  81         // ACTIONS
  82         //
  83
  84         /**
  85          * Adds the given Sone to the set of Sones that will be watched for updates.
  86          *
  87          * @param sone
  88          *            The Sone to add
  89          */
  90         public void addSone(Sone sone) {
  91                 if (sones.add(sone)) {
  92                         freenetInterface.registerUsk(sone, this);
  93                 }
  94         }
  95
  96         /**
  97          * Removes the given Sone from the downloader.
  98          *
  99          * @param sone
 100          *            The Sone to stop watching
 101          */
 102         public void removeSone(Sone sone) {
 103                 if (sones.remove(sone)) {
 104                         freenetInterface.unregisterUsk(sone);
 105                 }
 106         }
 107
 108         /**
 109          * Fetches the updated Sone. This method is a callback method for
 110          * {@link FreenetInterface#registerUsk(Sone, SoneDownloader)}.
 111          *
 112          * @param sone
 113          *            The Sone to fetch
 114          */
 115         public void fetchSone(Sone sone) {
 116                 if (core.getSoneStatus(sone) == SoneStatus.downloading) {
 117                         return;
 118                 }
 119                 logger.log(Level.FINE, "Starting fetch for Sone “%s” from %s…", new Object[] { sone, sone.getRequestUri().setMetaString(new String[] { "sone.xml" }) });
 120                 FreenetURI requestUri = sone.getRequestUri().setMetaString(new String[] { "sone.xml" });
 121                 core.setSoneStatus(sone, SoneStatus.downloading);
 122                 try {
 123                         Pair<FreenetURI, FetchResult> fetchResults = freenetInterface.fetchUri(requestUri);
 124                         if (fetchResults == null) {
 125                                 /* TODO - mark Sone as bad. */
 126                                 return;
 127                         }
 128                         logger.log(Level.FINEST, "Got %d bytes back.", fetchResults.getRight().size());
 129                         Sone parsedSone = parseSone(sone, fetchResults.getRight(), fetchResults.getLeft());
 130                         if (parsedSone != null) {
 131                                 core.updateSone(parsedSone);
 132                         }
 133                 } finally {
 134                         core.setSoneStatus(sone, (sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
 135                 }
 136         }
 137
 138         /**
 139          * Parses a Sone from a fetch result.
 140          *
 141          * @param originalSone
 142          *            The sone to parse, or {@code null} if the Sone is yet unknown
 143          * @param fetchResult
 144          *            The fetch result
 145          * @param requestUri
 146          *            The requested URI
 147          * @return The parsed Sone, or {@code null} if the Sone could not be parsed
 148          */
 149         public Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
 150                 logger.log(Level.FINEST, "Persing FetchResult (%d bytes, %s) for %s…", new Object[] { fetchResult.size(), fetchResult.getMimeType(), originalSone });
 151                 Bucket soneBucket = fetchResult.asBucket();
 152                 InputStream soneInputStream = null;
 153                 try {
 154                         soneInputStream = soneBucket.getInputStream();
 155                         Sone parsedSone = parseSone(originalSone, soneInputStream);
 156                         if (parsedSone != null) {
 157                                 parsedSone.setRequestUri(requestUri.setMetaString(new String[0]));
 158                         }
 159                         return parsedSone;
 160                 } catch (IOException ioe1) {
 161                         logger.log(Level.WARNING, "Could not parse Sone from " + requestUri + "!", ioe1);
 162                 } finally {
 163                         Closer.close(soneInputStream);
 164                         soneBucket.free();
 165                 }
 166                 return null;
 167         }
 168
 169         /**
 170          * Parses a Sone from the given input stream and updates the given Sone, or
 171          * creates a new Sone.
 172          *
 173          * @param sone
 174          *            The Sone to update
 175          * @param soneInputStream
 176          *            The input stream to parse the Sone from
 177          * @return The parsed Sone
 178          */
 179         public Sone parseSone(Sone sone, InputStream soneInputStream) {
 180                 /* TODO - impose a size limit? */
 181
 182                 Document document;
 183                 /* XML parsing is not thread-safe. */
 184                 synchronized (this) {
 185                         document = XML.transformToDocument(soneInputStream);
 186                 }
 187                 if (document == null) {
 188                         /* TODO - mark Sone as bad. */
 189                         logger.log(Level.WARNING, "Could not parse XML for Sone %s!", new Object[] { sone });
 190                         return null;
 191                 }
 192                 SimpleXML soneXml;
 193                 try {
 194                         soneXml = SimpleXML.fromDocument(document);
 195                 } catch (NullPointerException npe1) {
 196                         /* for some reason, invalid XML can cause NPEs. */
 197                         logger.log(Level.WARNING, "XML for Sone " + sone + " can not be parsed!", npe1);
 198                         return null;
 199                 }
 200
 201                 String soneTime = soneXml.getValue("time", null);
 202                 if (soneTime == null) {
 203                         /* TODO - mark Sone as bad. */
 204                         logger.log(Level.WARNING, "Downloaded time for Sone %s was null!", new Object[] { sone });
 205                         return null;
 206                 }
 207                 try {
 208                         sone.setTime(Long.parseLong(soneTime));
 209                 } catch (NumberFormatException nfe1) {
 210                         /* TODO - mark Sone as bad. */
 211                         logger.log(Level.WARNING, "Downloaded Sone %s with invalid time: %s", new Object[] { sone, soneTime });
 212                         return null;
 213                 }
 214
 215                 String soneRequestUri = soneXml.getValue("request-uri", null);
 216                 if (soneRequestUri != null) {
 217                         try {
 218                                 sone.setRequestUri(new FreenetURI(soneRequestUri));
 219                         } catch (MalformedURLException mue1) {
 220                                 /* TODO - mark Sone as bad. */
 221                                 logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid request URI: " + soneRequestUri, mue1);
 222                                 return null;
 223                         }
 224                 }
 225
 226                 String soneInsertUri = soneXml.getValue("insert-uri", null);
 227                 if ((soneInsertUri != null) && (sone.getInsertUri() == null)) {
 228                         try {
 229                                 sone.setInsertUri(new FreenetURI(soneInsertUri));
 230                                 sone.setLatestEdition(Math.max(sone.getRequestUri().getSuggestedEdition(), sone.getInsertUri().getSuggestedEdition()));
 231                         } catch (MalformedURLException mue1) {
 232                                 /* TODO - mark Sone as bad. */
 233                                 logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid insert URI: " + soneInsertUri, mue1);
 234                                 return null;
 235                         }
 236                 }
 237
 238                 SimpleXML profileXml = soneXml.getNode("profile");
 239                 if (profileXml == null) {
 240                         /* TODO - mark Sone as bad. */
 241                         logger.log(Level.WARNING, "Downloaded Sone %s has no profile!", new Object[] { sone });
 242                         return null;
 243                 }
 244
 245                 /* parse profile. */
 246                 String profileFirstName = profileXml.getValue("first-name", null);
 247                 String profileMiddleName = profileXml.getValue("middle-name", null);
 248                 String profileLastName = profileXml.getValue("last-name", null);
 249                 Integer profileBirthDay = Numbers.safeParseInteger(profileXml.getValue("birth-day", null));
 250                 Integer profileBirthMonth = Numbers.safeParseInteger(profileXml.getValue("birth-month", null));
 251                 Integer profileBirthYear = Numbers.safeParseInteger(profileXml.getValue("birth-year", null));
 252                 Profile profile = new Profile().setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
 253                 profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
 254
 255                 /* parse posts. */
 256                 SimpleXML postsXml = soneXml.getNode("posts");
 257                 Set<Post> posts = new HashSet<Post>();
 258                 if (postsXml == null) {
 259                         /* TODO - mark Sone as bad. */
 260                         logger.log(Level.WARNING, "Downloaded Sone %s has no posts!", new Object[] { sone });
 261                 } else {
 262                         for (SimpleXML postXml : postsXml.getNodes("post")) {
 263                                 String postId = postXml.getValue("id", null);
 264                                 String postTime = postXml.getValue("time", null);
 265                                 String postText = postXml.getValue("text", null);
 266                                 if ((postId == null) || (postTime == null) || (postText == null)) {
 267                                         /* TODO - mark Sone as bad. */
 268                                         logger.log(Level.WARNING, "Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", new Object[] { sone, postId, postTime, postText });
 269                                         return null;
 270                                 }
 271                                 try {
 272                                         posts.add(core.getPost(postId).setSone(sone).setTime(Long.parseLong(postTime)).setText(postText));
 273                                 } catch (NumberFormatException nfe1) {
 274                                         /* TODO - mark Sone as bad. */
 275                                         logger.log(Level.WARNING, "Downloaded post for Sone %s with invalid time: %s", new Object[] { sone, postTime });
 276                                         return null;
 277                                 }
 278                         }
 279                 }
 280
 281                 /* parse replies. */
 282                 SimpleXML repliesXml = soneXml.getNode("replies");
 283                 Set<Reply> replies = new HashSet<Reply>();
 284                 if (repliesXml == null) {
 285                         /* TODO - mark Sone as bad. */
 286                         logger.log(Level.WARNING, "Downloaded Sone %s has no replies!", new Object[] { sone });
 287                 } else {
 288                         for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
 289                                 String replyId = replyXml.getValue("id", null);
 290                                 String replyPostId = replyXml.getValue("post-id", null);
 291                                 String replyTime = replyXml.getValue("time", null);
 292                                 String replyText = replyXml.getValue("text", null);
 293                                 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
 294                                         /* TODO - mark Sone as bad. */
 295                                         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 });
 296                                         return null;
 297                                 }
 298                                 try {
 299                                         replies.add(core.getReply(replyId).setSone(sone).setPost(core.getPost(replyPostId)).setTime(Long.parseLong(replyTime)).setText(replyText));
 300                                 } catch (NumberFormatException nfe1) {
 301                                         /* TODO - mark Sone as bad. */
 302                                         logger.log(Level.WARNING, "Downloaded reply for Sone %s with invalid time: %s", new Object[] { sone, replyTime });
 303                                         return null;
 304                                 }
 305                         }
 306                 }
 307
 308                 /* parse liked post IDs. */
 309                 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
 310                 Set<String> likedPostIds = new HashSet<String>();
 311                 if (likePostIdsXml == null) {
 312                         /* TODO - mark Sone as bad. */
 313                         logger.log(Level.WARNING, "Downloaded Sone %s has no post likes!", new Object[] { sone });
 314                 } else {
 315                         for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
 316                                 String postId = likedPostIdXml.getValue();
 317                                 likedPostIds.add(postId);
 318                         }
 319                 }
 320
 321                 /* parse liked reply IDs. */
 322                 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
 323                 Set<String> likedReplyIds = new HashSet<String>();
 324                 if (likeReplyIdsXml == null) {
 325                         /* TODO - mark Sone as bad. */
 326                         logger.log(Level.WARNING, "Downloaded Sone %s has no reply likes!", new Object[] { sone });
 327                 } else {
 328                         for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
 329                                 String replyId = likedReplyIdXml.getValue();
 330                                 likedReplyIds.add(replyId);
 331                         }
 332                 }
 333
 334                 /* okay, apparently everything was parsed correctly. Now import. */
 335                 /* atomic setter operation on the Sone. */
 336                 synchronized (sone) {
 337                         sone.setProfile(profile);
 338                         sone.setPosts(posts);
 339                         sone.setReplies(replies);
 340                         sone.setLikePostIds(likedPostIds);
 341                         sone.setModificationCounter(0);
 342                 }
 343
 344                 return sone;
 345         }
 346
 347         //
 348         // SERVICE METHODS
 349         //
 350
 351         /**
 352          * {@inheritDoc}
 353          */
 354         @Override
 355         protected void serviceStop() {
 356                 for (Sone sone : sones) {
 357                         freenetInterface.unregisterUsk(sone);
 358                 }
 359         }
 360
 361 }