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 org.w3c.dom.Document;
50 import freenet.client.FetchResult;
51 import freenet.keys.FreenetURI;
52 import freenet.support.api.Bucket;
55 * The Sone downloader is responsible for download Sones as they are updated.
57 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
59 public class SoneDownloader extends AbstractService {
62 private static final Logger logger = Logging.getLogger(SoneDownloader.class);
64 /** The maximum protocol version. */
65 private static final int MAX_PROTOCOL_VERSION = 0;
68 private final Core core;
70 /** The Freenet interface. */
71 private final FreenetInterface freenetInterface;
73 /** The sones to update. */
74 private final Set<Sone> sones = new HashSet<Sone>();
77 * Creates a new Sone downloader.
81 * @param freenetInterface
82 * The Freenet interface
84 public SoneDownloader(Core core, FreenetInterface freenetInterface) {
85 super("Sone Downloader", false);
87 this.freenetInterface = freenetInterface;
95 * Adds the given Sone to the set of Sones that will be watched for updates.
100 public void addSone(Sone sone) {
101 if (!sones.add(sone)) {
102 freenetInterface.unregisterUsk(sone);
104 freenetInterface.registerUsk(sone, this);
108 * Removes the given Sone from the downloader.
111 * The Sone to stop watching
113 public void removeSone(Sone sone) {
114 if (sones.remove(sone)) {
115 freenetInterface.unregisterUsk(sone);
120 * Fetches the updated Sone. This method is a callback method for
121 * {@link FreenetInterface#registerUsk(Sone, SoneDownloader)}.
126 public void fetchSone(Sone sone) {
127 fetchSone(sone, sone.getRequestUri().sskForUSK());
131 * Fetches the updated Sone. This method can be used to fetch a Sone from a
137 * The URI to fetch the Sone from
139 public void fetchSone(Sone sone, FreenetURI soneUri) {
140 fetchSone(sone, soneUri, false);
144 * Fetches the Sone from the given URI.
149 * The URI of the Sone to fetch
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
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);
161 Fetched fetchResults = freenetInterface.fetchUri(requestUri);
162 if (fetchResults == null) {
163 /* TODO - mark Sone as bad. */
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) {
170 parsedSone.setStatus((parsedSone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
171 core.updateSone(parsedSone);
177 sone.setStatus((sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
182 * Parses a Sone from a fetch result.
184 * @param originalSone
185 * The sone to parse, or {@code null} if the Sone is yet unknown
190 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
192 public Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
193 logger.log(Level.FINEST, String.format("Parsing FetchResult (%d bytes, %s) for %s…", fetchResult.size(), fetchResult.getMimeType(), originalSone));
194 Bucket soneBucket = fetchResult.asBucket();
195 InputStream soneInputStream = null;
197 soneInputStream = soneBucket.getInputStream();
198 Sone parsedSone = parseSone(originalSone, soneInputStream);
199 if (parsedSone != null) {
200 parsedSone.setLatestEdition(requestUri.getEdition());
201 if (requestUri.getKeyType().equals("USK")) {
202 parsedSone.setRequestUri(requestUri.setMetaString(new String[0]));
204 parsedSone.setRequestUri(requestUri.setKeyType("USK").setDocName("Sone").setMetaString(new String[0]));
208 } catch (Exception e1) {
209 logger.log(Level.WARNING, String.format("Could not parse Sone from %s!", requestUri), e1);
211 Closer.close(soneInputStream);
218 * Parses a Sone from the given input stream and creates a new Sone from the
221 * @param originalSone
223 * @param soneInputStream
224 * The input stream to parse the Sone from
225 * @return The parsed Sone
226 * @throws SoneException
227 * if a parse error occurs, or the protocol is invalid
229 public Sone parseSone(Sone originalSone, InputStream soneInputStream) throws SoneException {
230 /* TODO - impose a size limit? */
233 /* XML parsing is not thread-safe. */
234 synchronized (this) {
235 document = XML.transformToDocument(soneInputStream);
237 if (document == null) {
238 /* TODO - mark Sone as bad. */
239 logger.log(Level.WARNING, String.format("Could not parse XML for Sone %s!", originalSone));
243 Sone sone = new SoneImpl(originalSone.getId(), originalSone.isLocal()).setIdentity(originalSone.getIdentity());
247 soneXml = SimpleXML.fromDocument(document);
248 } catch (NullPointerException npe1) {
249 /* for some reason, invalid XML can cause NPEs. */
250 logger.log(Level.WARNING, String.format("XML for Sone %s can not be parsed!", sone), npe1);
254 Integer protocolVersion = null;
255 String soneProtocolVersion = soneXml.getValue("protocol-version", null);
256 if (soneProtocolVersion != null) {
257 protocolVersion = Numbers.safeParseInteger(soneProtocolVersion);
259 if (protocolVersion == null) {
260 logger.log(Level.INFO, "No protocol version found, assuming 0.");
264 if (protocolVersion < 0) {
265 logger.log(Level.WARNING, String.format("Invalid protocol version: %d! Not parsing Sone.", protocolVersion));
269 /* check for valid versions. */
270 if (protocolVersion > MAX_PROTOCOL_VERSION) {
271 logger.log(Level.WARNING, String.format("Unknown protocol version: %d! Not parsing Sone.", protocolVersion));
275 String soneTime = soneXml.getValue("time", null);
276 if (soneTime == null) {
277 /* TODO - mark Sone as bad. */
278 logger.log(Level.WARNING, String.format("Downloaded time for Sone %s was null!", sone));
282 sone.setTime(Long.parseLong(soneTime));
283 } catch (NumberFormatException nfe1) {
284 /* TODO - mark Sone as bad. */
285 logger.log(Level.WARNING, String.format("Downloaded Sone %s with invalid time: %s", sone, soneTime));
289 SimpleXML clientXml = soneXml.getNode("client");
290 if (clientXml != null) {
291 String clientName = clientXml.getValue("name", null);
292 String clientVersion = clientXml.getValue("version", null);
293 if ((clientName == null) || (clientVersion == null)) {
294 logger.log(Level.WARNING, String.format("Download Sone %s with client XML but missing name or version!", sone));
297 sone.setClient(new Client(clientName, clientVersion));
300 String soneRequestUri = soneXml.getValue("request-uri", null);
301 if (soneRequestUri != null) {
303 sone.setRequestUri(new FreenetURI(soneRequestUri));
304 } catch (MalformedURLException mue1) {
305 /* TODO - mark Sone as bad. */
306 logger.log(Level.WARNING, String.format("Downloaded Sone %s has invalid request URI: %s", sone, soneRequestUri), mue1);
311 String soneInsertUri = soneXml.getValue("insert-uri", null);
312 if ((soneInsertUri != null) && (sone.getInsertUri() == null)) {
314 sone.setInsertUri(new FreenetURI(soneInsertUri));
315 sone.setLatestEdition(Math.max(sone.getRequestUri().getEdition(), sone.getInsertUri().getEdition()));
316 } catch (MalformedURLException mue1) {
317 /* TODO - mark Sone as bad. */
318 logger.log(Level.WARNING, String.format("Downloaded Sone %s has invalid insert URI: %s", sone, soneInsertUri), mue1);
323 SimpleXML profileXml = soneXml.getNode("profile");
324 if (profileXml == null) {
325 /* TODO - mark Sone as bad. */
326 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no profile!", sone));
331 String profileFirstName = profileXml.getValue("first-name", null);
332 String profileMiddleName = profileXml.getValue("middle-name", null);
333 String profileLastName = profileXml.getValue("last-name", null);
334 Integer profileBirthDay = Numbers.safeParseInteger(profileXml.getValue("birth-day", null));
335 Integer profileBirthMonth = Numbers.safeParseInteger(profileXml.getValue("birth-month", null));
336 Integer profileBirthYear = Numbers.safeParseInteger(profileXml.getValue("birth-year", null));
337 Profile profile = new Profile(sone).setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
338 profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
339 /* avatar is processed after images are loaded. */
340 String avatarId = profileXml.getValue("avatar", null);
342 /* parse profile fields. */
343 SimpleXML profileFieldsXml = profileXml.getNode("fields");
344 if (profileFieldsXml != null) {
345 for (SimpleXML fieldXml : profileFieldsXml.getNodes("field")) {
346 String fieldName = fieldXml.getValue("field-name", null);
347 String fieldValue = fieldXml.getValue("field-value", "");
348 if (fieldName == null) {
349 logger.log(Level.WARNING, String.format("Downloaded profile field for Sone %s with missing data! Name: %s, Value: %s", sone, fieldName, fieldValue));
353 profile.addField(fieldName).setValue(fieldValue);
354 } catch (IllegalArgumentException iae1) {
355 logger.log(Level.WARNING, String.format("Duplicate field: %s", fieldName), iae1);
362 SimpleXML postsXml = soneXml.getNode("posts");
363 Set<Post> posts = new HashSet<Post>();
364 if (postsXml == null) {
365 /* TODO - mark Sone as bad. */
366 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no posts!", sone));
368 for (SimpleXML postXml : postsXml.getNodes("post")) {
369 String postId = postXml.getValue("id", null);
370 String postRecipientId = postXml.getValue("recipient", null);
371 String postTime = postXml.getValue("time", null);
372 String postText = postXml.getValue("text", null);
373 if ((postId == null) || (postTime == null) || (postText == null)) {
374 /* TODO - mark Sone as bad. */
375 logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", sone, postId, postTime, postText));
379 PostBuilder postBuilder = core.postBuilder();
380 /* TODO - parse time correctly. */
381 postBuilder.withId(postId).from(sone.getId()).withTime(Long.parseLong(postTime)).withText(postText);
382 if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
383 postBuilder.to(postRecipientId);
385 posts.add(postBuilder.build());
386 } catch (NumberFormatException nfe1) {
387 /* TODO - mark Sone as bad. */
388 logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with invalid time: %s", sone, postTime));
395 SimpleXML repliesXml = soneXml.getNode("replies");
396 Set<PostReply> replies = new HashSet<PostReply>();
397 if (repliesXml == null) {
398 /* TODO - mark Sone as bad. */
399 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no replies!", sone));
401 for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
402 String replyId = replyXml.getValue("id", null);
403 String replyPostId = replyXml.getValue("post-id", null);
404 String replyTime = replyXml.getValue("time", null);
405 String replyText = replyXml.getValue("text", null);
406 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
407 /* TODO - mark Sone as bad. */
408 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));
412 PostReplyBuilder postReplyBuilder = core.postReplyBuilder();
413 /* TODO - parse time correctly. */
414 postReplyBuilder.withId(replyId).from(sone.getId()).to(replyPostId).withTime(Long.parseLong(replyTime)).withText(replyText);
415 replies.add(postReplyBuilder.build());
416 } catch (NumberFormatException nfe1) {
417 /* TODO - mark Sone as bad. */
418 logger.log(Level.WARNING, String.format("Downloaded reply for Sone %s with invalid time: %s", sone, replyTime));
424 /* parse liked post IDs. */
425 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
426 Set<String> likedPostIds = new HashSet<String>();
427 if (likePostIdsXml == null) {
428 /* TODO - mark Sone as bad. */
429 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no post likes!", sone));
431 for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
432 String postId = likedPostIdXml.getValue();
433 likedPostIds.add(postId);
437 /* parse liked reply IDs. */
438 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
439 Set<String> likedReplyIds = new HashSet<String>();
440 if (likeReplyIdsXml == null) {
441 /* TODO - mark Sone as bad. */
442 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no reply likes!", sone));
444 for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
445 String replyId = likedReplyIdXml.getValue();
446 likedReplyIds.add(replyId);
451 SimpleXML albumsXml = soneXml.getNode("albums");
452 List<Album> topLevelAlbums = new ArrayList<Album>();
453 if (albumsXml != null) {
454 for (SimpleXML albumXml : albumsXml.getNodes("album")) {
455 String id = albumXml.getValue("id", null);
456 String parentId = albumXml.getValue("parent", null);
457 String title = albumXml.getValue("title", null);
458 String description = albumXml.getValue("description", "");
459 String albumImageId = albumXml.getValue("album-image", null);
460 if ((id == null) || (title == null) || (description == null)) {
461 logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid album!", sone));
465 if (parentId != null) {
466 parent = core.getAlbum(parentId, false);
467 if (parent == null) {
468 logger.log(Level.WARNING, String.format("Downloaded Sone %s has album with invalid parent!", sone));
472 Album album = core.getAlbum(id).setSone(sone).modify().setTitle(title).setDescription(description).update();
473 if (parent != null) {
474 parent.addAlbum(album);
476 topLevelAlbums.add(album);
478 SimpleXML imagesXml = albumXml.getNode("images");
479 if (imagesXml != null) {
480 for (SimpleXML imageXml : imagesXml.getNodes("image")) {
481 String imageId = imageXml.getValue("id", null);
482 String imageCreationTimeString = imageXml.getValue("creation-time", null);
483 String imageKey = imageXml.getValue("key", null);
484 String imageTitle = imageXml.getValue("title", null);
485 String imageDescription = imageXml.getValue("description", "");
486 String imageWidthString = imageXml.getValue("width", null);
487 String imageHeightString = imageXml.getValue("height", null);
488 if ((imageId == null) || (imageCreationTimeString == null) || (imageKey == null) || (imageTitle == null) || (imageWidthString == null) || (imageHeightString == null)) {
489 logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid images!", sone));
492 long creationTime = Numbers.safeParseLong(imageCreationTimeString, 0L);
493 int imageWidth = Numbers.safeParseInteger(imageWidthString, 0);
494 int imageHeight = Numbers.safeParseInteger(imageHeightString, 0);
495 if ((imageWidth < 1) || (imageHeight < 1)) {
496 logger.log(Level.WARNING, String.format("Downloaded Sone %s contains image %s with invalid dimensions (%s, %s)!", sone, imageId, imageWidthString, imageHeightString));
499 Image image = core.getImage(imageId).modify().setSone(sone).setKey(imageKey).setCreationTime(creationTime).update();
500 image = image.modify().setTitle(imageTitle).setDescription(imageDescription).update();
501 image = image.modify().setWidth(imageWidth).setHeight(imageHeight).update();
502 album.addImage(image);
505 album.modify().setAlbumImage(albumImageId).update();
509 /* process avatar. */
510 if (avatarId != null) {
511 profile.setAvatar(core.getImage(avatarId, false));
514 /* okay, apparently everything was parsed correctly. Now import. */
515 /* atomic setter operation on the Sone. */
516 synchronized (sone) {
517 sone.setProfile(profile);
518 sone.setPosts(posts);
519 sone.setReplies(replies);
520 sone.setLikePostIds(likedPostIds);
521 sone.setLikeReplyIds(likedReplyIds);
522 for (Album album : topLevelAlbums) {
523 sone.getRootAlbum().addAlbum(album);
538 protected void serviceStop() {
539 for (Sone sone : sones) {
540 freenetInterface.unregisterUsk(sone);