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