2 * Sone - SoneDownloader.java - Copyright © 2010–2013 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.core;
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;
26 import java.util.logging.Level;
27 import java.util.logging.Logger;
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.sone.data.SoneImpl;
39 import net.pterodactylus.sone.database.PostBuilder;
40 import net.pterodactylus.sone.database.PostReplyBuilder;
41 import net.pterodactylus.util.io.Closer;
42 import net.pterodactylus.util.logging.Logging;
43 import net.pterodactylus.util.number.Numbers;
44 import net.pterodactylus.util.service.AbstractService;
45 import net.pterodactylus.util.xml.SimpleXML;
46 import net.pterodactylus.util.xml.XML;
48 import com.google.common.annotations.VisibleForTesting;
49 import org.w3c.dom.Document;
51 import freenet.client.FetchResult;
52 import freenet.keys.FreenetURI;
53 import freenet.support.api.Bucket;
56 * The Sone downloader is responsible for download Sones as they are updated.
58 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
60 public class SoneDownloader extends AbstractService {
63 private static final Logger logger = Logging.getLogger(SoneDownloader.class);
65 /** The maximum protocol version. */
66 private static final int MAX_PROTOCOL_VERSION = 0;
69 private final Core core;
71 /** The Freenet interface. */
72 private final FreenetInterface freenetInterface;
74 /** The sones to update. */
75 private final Set<Sone> sones = new HashSet<Sone>();
78 * Creates a new Sone downloader.
82 * @param freenetInterface
83 * The Freenet interface
85 public SoneDownloader(Core core, FreenetInterface freenetInterface) {
86 super("Sone Downloader", false);
88 this.freenetInterface = freenetInterface;
96 * Adds the given Sone to the set of Sones that will be watched for updates.
101 public void addSone(Sone sone) {
102 if (!sones.add(sone)) {
103 freenetInterface.unregisterUsk(sone);
105 freenetInterface.registerUsk(sone, this);
109 * Fetches the updated Sone. This method is a callback method for
110 * {@link FreenetInterface#registerUsk(Sone, SoneDownloader)}.
115 public void fetchSone(Sone sone) {
116 fetchSone(sone, sone.getRequestUri().sskForUSK());
120 * Fetches the updated Sone. This method can be used to fetch a Sone from a
126 * The URI to fetch the Sone from
128 public void fetchSone(Sone sone, FreenetURI soneUri) {
129 fetchSone(sone, soneUri, false);
133 * Fetches the Sone from the given URI.
138 * The URI of the Sone to fetch
140 * {@code true} to only fetch and parse the Sone, {@code false}
141 * to {@link Core#updateSone(Sone) update} it in the core
142 * @return The downloaded Sone, or {@code null} if the Sone could not be
145 public Sone fetchSone(Sone sone, FreenetURI soneUri, boolean fetchOnly) {
146 logger.log(Level.FINE, String.format("Starting fetch for Sone “%s” from %s…", sone, soneUri));
147 FreenetURI requestUri = soneUri.setMetaString(new String[] { "sone.xml" });
148 sone.setStatus(SoneStatus.downloading);
150 Fetched fetchResults = freenetInterface.fetchUri(requestUri);
151 if (fetchResults == null) {
152 /* TODO - mark Sone as bad. */
155 logger.log(Level.FINEST, String.format("Got %d bytes back.", fetchResults.getFetchResult().size()));
156 Sone parsedSone = parseSone(sone, fetchResults.getFetchResult(), fetchResults.getFreenetUri());
157 if (parsedSone != null) {
159 parsedSone.setStatus((parsedSone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
160 core.updateSone(parsedSone);
166 sone.setStatus((sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
171 * Parses a Sone from a fetch result.
173 * @param originalSone
174 * The sone to parse, or {@code null} if the Sone is yet unknown
179 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
181 private Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
182 logger.log(Level.FINEST, String.format("Parsing FetchResult (%d bytes, %s) for %s…", fetchResult.size(), fetchResult.getMimeType(), originalSone));
183 Bucket soneBucket = fetchResult.asBucket();
184 InputStream soneInputStream = null;
186 soneInputStream = soneBucket.getInputStream();
187 Sone parsedSone = parseSone(originalSone, soneInputStream);
188 if (parsedSone != null) {
189 parsedSone.setLatestEdition(requestUri.getEdition());
190 if (requestUri.getKeyType().equals("USK")) {
191 parsedSone.setRequestUri(requestUri.setMetaString(new String[0]));
193 parsedSone.setRequestUri(requestUri.setKeyType("USK").setDocName("Sone").setMetaString(new String[0]));
197 } catch (Exception e1) {
198 logger.log(Level.WARNING, String.format("Could not parse Sone from %s!", requestUri), e1);
200 Closer.close(soneInputStream);
207 * Parses a Sone from the given input stream and creates a new Sone from the
210 * @param originalSone
212 * @param soneInputStream
213 * The input stream to parse the Sone from
214 * @return The parsed Sone
215 * @throws SoneException
216 * if a parse error occurs, or the protocol is invalid
219 protected Sone parseSone(Sone originalSone, InputStream soneInputStream) throws SoneException {
220 /* TODO - impose a size limit? */
223 /* XML parsing is not thread-safe. */
224 synchronized (this) {
225 document = XML.transformToDocument(soneInputStream);
227 if (document == null) {
228 /* TODO - mark Sone as bad. */
229 logger.log(Level.WARNING, String.format("Could not parse XML for Sone %s!", originalSone));
233 Sone sone = new SoneImpl(originalSone.getId(), originalSone.isLocal()).setIdentity(originalSone.getIdentity());
237 soneXml = SimpleXML.fromDocument(document);
238 } catch (NullPointerException npe1) {
239 /* for some reason, invalid XML can cause NPEs. */
240 logger.log(Level.WARNING, String.format("XML for Sone %s can not be parsed!", sone), npe1);
244 Integer protocolVersion = null;
245 String soneProtocolVersion = soneXml.getValue("protocol-version", null);
246 if (soneProtocolVersion != null) {
247 protocolVersion = Numbers.safeParseInteger(soneProtocolVersion);
249 if (protocolVersion == null) {
250 logger.log(Level.INFO, "No protocol version found, assuming 0.");
254 if (protocolVersion < 0) {
255 logger.log(Level.WARNING, String.format("Invalid protocol version: %d! Not parsing Sone.", protocolVersion));
259 /* check for valid versions. */
260 if (protocolVersion > MAX_PROTOCOL_VERSION) {
261 logger.log(Level.WARNING, String.format("Unknown protocol version: %d! Not parsing Sone.", protocolVersion));
265 String soneTime = soneXml.getValue("time", null);
266 if (soneTime == null) {
267 /* TODO - mark Sone as bad. */
268 logger.log(Level.WARNING, String.format("Downloaded time for Sone %s was null!", sone));
272 sone.setTime(Long.parseLong(soneTime));
273 } catch (NumberFormatException nfe1) {
274 /* TODO - mark Sone as bad. */
275 logger.log(Level.WARNING, String.format("Downloaded Sone %s with invalid time: %s", sone, soneTime));
279 SimpleXML clientXml = soneXml.getNode("client");
280 if (clientXml != null) {
281 String clientName = clientXml.getValue("name", null);
282 String clientVersion = clientXml.getValue("version", null);
283 if ((clientName == null) || (clientVersion == null)) {
284 logger.log(Level.WARNING, String.format("Download Sone %s with client XML but missing name or version!", sone));
287 sone.setClient(new Client(clientName, clientVersion));
290 String soneRequestUri = soneXml.getValue("request-uri", null);
291 if (soneRequestUri != null) {
293 sone.setRequestUri(new FreenetURI(soneRequestUri));
294 } catch (MalformedURLException mue1) {
295 /* TODO - mark Sone as bad. */
296 logger.log(Level.WARNING, String.format("Downloaded Sone %s has invalid request URI: %s", sone, soneRequestUri), mue1);
301 if (originalSone.getInsertUri() != null) {
302 sone.setInsertUri(originalSone.getInsertUri());
305 SimpleXML profileXml = soneXml.getNode("profile");
306 if (profileXml == null) {
307 /* TODO - mark Sone as bad. */
308 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no profile!", sone));
313 String profileFirstName = profileXml.getValue("first-name", null);
314 String profileMiddleName = profileXml.getValue("middle-name", null);
315 String profileLastName = profileXml.getValue("last-name", null);
316 Integer profileBirthDay = Numbers.safeParseInteger(profileXml.getValue("birth-day", null));
317 Integer profileBirthMonth = Numbers.safeParseInteger(profileXml.getValue("birth-month", null));
318 Integer profileBirthYear = Numbers.safeParseInteger(profileXml.getValue("birth-year", null));
319 Profile profile = new Profile(sone).setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
320 profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
321 /* avatar is processed after images are loaded. */
322 String avatarId = profileXml.getValue("avatar", null);
324 /* parse profile fields. */
325 SimpleXML profileFieldsXml = profileXml.getNode("fields");
326 if (profileFieldsXml != null) {
327 for (SimpleXML fieldXml : profileFieldsXml.getNodes("field")) {
328 String fieldName = fieldXml.getValue("field-name", null);
329 String fieldValue = fieldXml.getValue("field-value", "");
330 if (fieldName == null) {
331 logger.log(Level.WARNING, String.format("Downloaded profile field for Sone %s with missing data! Name: %s, Value: %s", sone, fieldName, fieldValue));
335 profile.addField(fieldName.trim()).setValue(fieldValue);
336 } catch (IllegalArgumentException iae1) {
337 logger.log(Level.WARNING, String.format("Duplicate field: %s", fieldName), iae1);
344 SimpleXML postsXml = soneXml.getNode("posts");
345 Set<Post> posts = new HashSet<Post>();
346 if (postsXml == null) {
347 /* TODO - mark Sone as bad. */
348 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no posts!", sone));
350 for (SimpleXML postXml : postsXml.getNodes("post")) {
351 String postId = postXml.getValue("id", null);
352 String postRecipientId = postXml.getValue("recipient", null);
353 String postTime = postXml.getValue("time", null);
354 String postText = postXml.getValue("text", null);
355 if ((postId == null) || (postTime == null) || (postText == null)) {
356 /* TODO - mark Sone as bad. */
357 logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", sone, postId, postTime, postText));
361 PostBuilder postBuilder = core.postBuilder();
362 /* TODO - parse time correctly. */
363 postBuilder.withId(postId).from(sone.getId()).withTime(Long.parseLong(postTime)).withText(postText);
364 if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
365 postBuilder.to(postRecipientId);
367 posts.add(postBuilder.build());
368 } catch (NumberFormatException nfe1) {
369 /* TODO - mark Sone as bad. */
370 logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with invalid time: %s", sone, postTime));
377 SimpleXML repliesXml = soneXml.getNode("replies");
378 Set<PostReply> replies = new HashSet<PostReply>();
379 if (repliesXml == null) {
380 /* TODO - mark Sone as bad. */
381 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no replies!", sone));
383 for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
384 String replyId = replyXml.getValue("id", null);
385 String replyPostId = replyXml.getValue("post-id", null);
386 String replyTime = replyXml.getValue("time", null);
387 String replyText = replyXml.getValue("text", null);
388 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
389 /* TODO - mark Sone as bad. */
390 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));
394 PostReplyBuilder postReplyBuilder = core.postReplyBuilder();
395 /* TODO - parse time correctly. */
396 postReplyBuilder.withId(replyId).from(sone.getId()).to(replyPostId).withTime(Long.parseLong(replyTime)).withText(replyText);
397 replies.add(postReplyBuilder.build());
398 } catch (NumberFormatException nfe1) {
399 /* TODO - mark Sone as bad. */
400 logger.log(Level.WARNING, String.format("Downloaded reply for Sone %s with invalid time: %s", sone, replyTime));
406 /* parse liked post IDs. */
407 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
408 Set<String> likedPostIds = new HashSet<String>();
409 if (likePostIdsXml == null) {
410 /* TODO - mark Sone as bad. */
411 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no post likes!", sone));
413 for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
414 String postId = likedPostIdXml.getValue();
415 likedPostIds.add(postId);
419 /* parse liked reply IDs. */
420 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
421 Set<String> likedReplyIds = new HashSet<String>();
422 if (likeReplyIdsXml == null) {
423 /* TODO - mark Sone as bad. */
424 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no reply likes!", sone));
426 for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
427 String replyId = likedReplyIdXml.getValue();
428 likedReplyIds.add(replyId);
433 SimpleXML albumsXml = soneXml.getNode("albums");
434 List<Album> topLevelAlbums = new ArrayList<Album>();
435 if (albumsXml != null) {
436 for (SimpleXML albumXml : albumsXml.getNodes("album")) {
437 String id = albumXml.getValue("id", null);
438 String parentId = albumXml.getValue("parent", null);
439 String title = albumXml.getValue("title", null);
440 String description = albumXml.getValue("description", "");
441 String albumImageId = albumXml.getValue("album-image", null);
442 if ((id == null) || (title == null)) {
443 logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid album!", sone));
447 if (parentId != null) {
448 parent = core.getAlbum(parentId, false);
449 if (parent == null) {
450 logger.log(Level.WARNING, String.format("Downloaded Sone %s has album with invalid parent!", sone));
454 Album album = core.getAlbum(id).setSone(sone).modify().setTitle(title).setDescription(description).update();
455 if (parent != null) {
456 parent.addAlbum(album);
458 topLevelAlbums.add(album);
460 SimpleXML imagesXml = albumXml.getNode("images");
461 if (imagesXml != null) {
462 for (SimpleXML imageXml : imagesXml.getNodes("image")) {
463 String imageId = imageXml.getValue("id", null);
464 String imageCreationTimeString = imageXml.getValue("creation-time", null);
465 String imageKey = imageXml.getValue("key", null);
466 String imageTitle = imageXml.getValue("title", null);
467 String imageDescription = imageXml.getValue("description", "");
468 String imageWidthString = imageXml.getValue("width", null);
469 String imageHeightString = imageXml.getValue("height", null);
470 if ((imageId == null) || (imageCreationTimeString == null) || (imageKey == null) || (imageTitle == null) || (imageWidthString == null) || (imageHeightString == null)) {
471 logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid images!", sone));
474 long creationTime = Numbers.safeParseLong(imageCreationTimeString, 0L);
475 int imageWidth = Numbers.safeParseInteger(imageWidthString, 0);
476 int imageHeight = Numbers.safeParseInteger(imageHeightString, 0);
477 if ((imageWidth < 1) || (imageHeight < 1)) {
478 logger.log(Level.WARNING, String.format("Downloaded Sone %s contains image %s with invalid dimensions (%s, %s)!", sone, imageId, imageWidthString, imageHeightString));
481 Image image = core.getImage(imageId).modify().setSone(sone).setKey(imageKey).setCreationTime(creationTime).update();
482 image = image.modify().setTitle(imageTitle).setDescription(imageDescription).update();
483 image = image.modify().setWidth(imageWidth).setHeight(imageHeight).update();
484 album.addImage(image);
487 album.modify().setAlbumImage(albumImageId).update();
491 /* process avatar. */
492 if (avatarId != null) {
493 profile.setAvatar(core.getImage(avatarId, false));
496 /* okay, apparently everything was parsed correctly. Now import. */
497 /* atomic setter operation on the Sone. */
498 synchronized (sone) {
499 sone.setProfile(profile);
500 sone.setPosts(posts);
501 sone.setReplies(replies);
502 sone.setLikePostIds(likedPostIds);
503 sone.setLikeReplyIds(likedReplyIds);
504 for (Album album : topLevelAlbums) {
505 sone.getRootAlbum().addAlbum(album);
520 protected void serviceStop() {
521 for (Sone sone : sones) {
522 freenetInterface.unregisterUsk(sone);
526 public class FetchSoneWithUri implements Runnable {
528 private final Sone sone;
530 public FetchSoneWithUri(Sone sone) {
536 fetchSone(sone, sone.getRequestUri());
541 public class FetchSone implements Runnable {
543 private final Sone sone;
545 public FetchSone(Sone sone) {