2 * Sone - SoneDownloader.java - Copyright © 2010 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.IOException;
21 import java.io.InputStream;
22 import java.net.MalformedURLException;
23 import java.util.HashSet;
25 import java.util.logging.Level;
26 import java.util.logging.Logger;
28 import net.pterodactylus.sone.core.Core.Preferences;
29 import net.pterodactylus.sone.core.Core.SoneStatus;
30 import net.pterodactylus.sone.data.Client;
31 import net.pterodactylus.sone.data.Post;
32 import net.pterodactylus.sone.data.Profile;
33 import net.pterodactylus.sone.data.Reply;
34 import net.pterodactylus.sone.data.Sone;
35 import net.pterodactylus.util.collection.Pair;
36 import net.pterodactylus.util.io.Closer;
37 import net.pterodactylus.util.logging.Logging;
38 import net.pterodactylus.util.number.Numbers;
39 import net.pterodactylus.util.service.AbstractService;
40 import net.pterodactylus.util.xml.SimpleXML;
41 import net.pterodactylus.util.xml.XML;
43 import org.w3c.dom.Document;
45 import freenet.client.FetchResult;
46 import freenet.keys.FreenetURI;
47 import freenet.support.api.Bucket;
50 * The Sone downloader is responsible for download Sones as they are updated.
52 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
54 public class SoneDownloader extends AbstractService {
57 private static final Logger logger = Logging.getLogger(SoneDownloader.class);
59 /** The maximum protocol version. */
60 private static final int MAX_PROTOCOL_VERSION = 0;
63 private final Core core;
65 /** The Freenet interface. */
66 private final FreenetInterface freenetInterface;
68 /** The sones to update. */
69 private final Set<Sone> sones = new HashSet<Sone>();
72 * Creates a new Sone downloader.
76 * @param freenetInterface
77 * The Freenet interface
79 public SoneDownloader(Core core, FreenetInterface freenetInterface) {
80 super("Sone Downloader", false);
82 this.freenetInterface = freenetInterface;
90 * Adds the given Sone to the set of Sones that will be watched for updates.
95 public void addSone(Sone sone) {
96 if (!sones.add(sone)) {
97 freenetInterface.unregisterUsk(sone);
99 freenetInterface.registerUsk(sone, this);
103 * Removes the given Sone from the downloader.
106 * The Sone to stop watching
108 public void removeSone(Sone sone) {
109 if (sones.remove(sone)) {
110 freenetInterface.unregisterUsk(sone);
115 * Fetches the updated Sone. This method is a callback method for
116 * {@link FreenetInterface#registerUsk(Sone, SoneDownloader)}.
121 public void fetchSone(Sone sone) {
122 fetchSone(sone, sone.getRequestUri().sskForUSK());
126 * Fetches the updated Sone. This method can be used to fetch a Sone from a
127 * specific URI (which happens when {@link Preferences#isSoneRescueMode()
128 * „Sone rescue mode“} is active).
133 * The URI to fetch the Sone from
135 public void fetchSone(Sone sone, FreenetURI soneUri) {
136 logger.log(Level.FINE, "Starting fetch for Sone “%s” from %s…", new Object[] { sone, soneUri });
137 FreenetURI requestUri = soneUri.setMetaString(new String[] { "sone.xml" });
138 core.setSoneStatus(sone, SoneStatus.downloading);
140 Pair<FreenetURI, FetchResult> fetchResults = freenetInterface.fetchUri(requestUri);
141 if (fetchResults == null) {
142 /* TODO - mark Sone as bad. */
145 logger.log(Level.FINEST, "Got %d bytes back.", fetchResults.getRight().size());
146 Sone parsedSone = parseSone(sone, fetchResults.getRight(), fetchResults.getLeft());
147 if (parsedSone != null) {
149 core.updateSone(parsedSone);
152 core.setSoneStatus(sone, (sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
157 * Parses a Sone from a fetch result.
159 * @param originalSone
160 * The sone to parse, or {@code null} if the Sone is yet unknown
165 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
167 public Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
168 logger.log(Level.FINEST, "Parsing FetchResult (%d bytes, %s) for %s…", new Object[] { fetchResult.size(), fetchResult.getMimeType(), originalSone });
169 Bucket soneBucket = fetchResult.asBucket();
170 InputStream soneInputStream = null;
172 soneInputStream = soneBucket.getInputStream();
173 Sone parsedSone = parseSone(originalSone, soneInputStream);
174 if (parsedSone != null) {
175 parsedSone.setLatestEdition(requestUri.getEdition());
176 if (requestUri.getKeyType().equals("USK")) {
177 parsedSone.setRequestUri(requestUri.setMetaString(new String[0]));
179 parsedSone.setRequestUri(requestUri.setKeyType("USK").setDocName("Sone").setMetaString(new String[0]));
183 } catch (IOException ioe1) {
184 logger.log(Level.WARNING, "Could not parse Sone from " + requestUri + "!", ioe1);
186 Closer.close(soneInputStream);
193 * Parses a Sone from the given input stream and creates a new Sone from the
196 * @param originalSone
198 * @param soneInputStream
199 * The input stream to parse the Sone from
200 * @return The parsed Sone
202 public Sone parseSone(Sone originalSone, InputStream soneInputStream) {
203 /* TODO - impose a size limit? */
206 /* XML parsing is not thread-safe. */
207 synchronized (this) {
208 document = XML.transformToDocument(soneInputStream);
210 if (document == null) {
211 /* TODO - mark Sone as bad. */
212 logger.log(Level.WARNING, "Could not parse XML for Sone %s!", new Object[] { originalSone });
216 Sone sone = new Sone(originalSone.getId()).setIdentity(originalSone.getIdentity());
220 soneXml = SimpleXML.fromDocument(document);
221 } catch (NullPointerException npe1) {
222 /* for some reason, invalid XML can cause NPEs. */
223 logger.log(Level.WARNING, "XML for Sone " + sone + " can not be parsed!", npe1);
227 Integer protocolVersion = null;
228 String soneProtocolVersion = soneXml.getValue("protocol-version", null);
229 if (soneProtocolVersion != null) {
230 protocolVersion = Numbers.safeParseInteger(soneProtocolVersion);
232 if (protocolVersion == null) {
233 logger.log(Level.INFO, "No protocol version found, assuming 0.");
237 if (protocolVersion < 0) {
238 logger.log(Level.WARNING, "Invalid protocol version: " + protocolVersion + "! Not parsing Sone.");
242 /* check for valid versions. */
243 if (protocolVersion > MAX_PROTOCOL_VERSION) {
244 logger.log(Level.WARNING, "Unknown protocol version: " + protocolVersion + "! Not parsing Sone.");
248 String soneTime = soneXml.getValue("time", null);
249 if (soneTime == null) {
250 /* TODO - mark Sone as bad. */
251 logger.log(Level.WARNING, "Downloaded time for Sone %s was null!", new Object[] { sone });
255 sone.setTime(Long.parseLong(soneTime));
256 } catch (NumberFormatException nfe1) {
257 /* TODO - mark Sone as bad. */
258 logger.log(Level.WARNING, "Downloaded Sone %s with invalid time: %s", new Object[] { sone, soneTime });
262 SimpleXML clientXml = soneXml.getNode("client");
263 if (clientXml != null) {
264 String clientName = clientXml.getValue("name", null);
265 String clientVersion = clientXml.getValue("version", null);
266 if ((clientName == null) || (clientVersion == null)) {
267 logger.log(Level.WARNING, "Download Sone %s with client XML but missing name or version!", sone);
270 sone.setClient(new Client(clientName, clientVersion));
273 String soneRequestUri = soneXml.getValue("request-uri", null);
274 if (soneRequestUri != null) {
276 sone.setRequestUri(new FreenetURI(soneRequestUri));
277 } catch (MalformedURLException mue1) {
278 /* TODO - mark Sone as bad. */
279 logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid request URI: " + soneRequestUri, mue1);
284 String soneInsertUri = soneXml.getValue("insert-uri", null);
285 if ((soneInsertUri != null) && (sone.getInsertUri() == null)) {
287 sone.setInsertUri(new FreenetURI(soneInsertUri));
288 sone.setLatestEdition(Math.max(sone.getRequestUri().getEdition(), sone.getInsertUri().getEdition()));
289 } catch (MalformedURLException mue1) {
290 /* TODO - mark Sone as bad. */
291 logger.log(Level.WARNING, "Downloaded Sone " + sone + " has invalid insert URI: " + soneInsertUri, mue1);
296 SimpleXML profileXml = soneXml.getNode("profile");
297 if (profileXml == null) {
298 /* TODO - mark Sone as bad. */
299 logger.log(Level.WARNING, "Downloaded Sone %s has no profile!", new Object[] { sone });
304 String profileFirstName = profileXml.getValue("first-name", null);
305 String profileMiddleName = profileXml.getValue("middle-name", null);
306 String profileLastName = profileXml.getValue("last-name", null);
307 Integer profileBirthDay = Numbers.safeParseInteger(profileXml.getValue("birth-day", null));
308 Integer profileBirthMonth = Numbers.safeParseInteger(profileXml.getValue("birth-month", null));
309 Integer profileBirthYear = Numbers.safeParseInteger(profileXml.getValue("birth-year", null));
310 Profile profile = new Profile().setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
311 profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
313 /* parse profile fields. */
314 SimpleXML profileFieldsXml = profileXml.getNode("fields");
315 if (profileFieldsXml != null) {
316 for (SimpleXML fieldXml : profileFieldsXml.getNodes("field")) {
317 String fieldName = fieldXml.getValue("field-name", null);
318 String fieldValue = fieldXml.getValue("field-value", null);
319 if ((fieldName == null) || (fieldValue == null)) {
320 logger.log(Level.WARNING, "Downloaded profile field for Sone %s with missing data! Name: %s, Value: %s", new Object[] { sone, fieldName, fieldValue });
324 profile.addField(fieldName).setValue(fieldValue);
325 } catch (IllegalArgumentException iae1) {
326 logger.log(Level.WARNING, "Duplicate field: " + fieldName, iae1);
333 SimpleXML postsXml = soneXml.getNode("posts");
334 Set<Post> posts = new HashSet<Post>();
335 if (postsXml == null) {
336 /* TODO - mark Sone as bad. */
337 logger.log(Level.WARNING, "Downloaded Sone %s has no posts!", new Object[] { sone });
339 for (SimpleXML postXml : postsXml.getNodes("post")) {
340 String postId = postXml.getValue("id", null);
341 String postRecipientId = postXml.getValue("recipient", null);
342 String postTime = postXml.getValue("time", null);
343 String postText = postXml.getValue("text", null);
344 if ((postId == null) || (postTime == null) || (postText == null)) {
345 /* TODO - mark Sone as bad. */
346 logger.log(Level.WARNING, "Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", new Object[] { sone, postId, postTime, postText });
350 Post post = core.getPost(postId).setSone(sone).setTime(Long.parseLong(postTime)).setText(postText);
351 if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
352 post.setRecipient(core.getSone(postRecipientId));
355 } catch (NumberFormatException nfe1) {
356 /* TODO - mark Sone as bad. */
357 logger.log(Level.WARNING, "Downloaded post for Sone %s with invalid time: %s", new Object[] { sone, postTime });
364 SimpleXML repliesXml = soneXml.getNode("replies");
365 Set<Reply> replies = new HashSet<Reply>();
366 if (repliesXml == null) {
367 /* TODO - mark Sone as bad. */
368 logger.log(Level.WARNING, "Downloaded Sone %s has no replies!", new Object[] { sone });
370 for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
371 String replyId = replyXml.getValue("id", null);
372 String replyPostId = replyXml.getValue("post-id", null);
373 String replyTime = replyXml.getValue("time", null);
374 String replyText = replyXml.getValue("text", null);
375 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
376 /* TODO - mark Sone as bad. */
377 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 });
381 replies.add(core.getReply(replyId).setSone(sone).setPost(core.getPost(replyPostId)).setTime(Long.parseLong(replyTime)).setText(replyText));
382 } catch (NumberFormatException nfe1) {
383 /* TODO - mark Sone as bad. */
384 logger.log(Level.WARNING, "Downloaded reply for Sone %s with invalid time: %s", new Object[] { sone, replyTime });
390 /* parse liked post IDs. */
391 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
392 Set<String> likedPostIds = new HashSet<String>();
393 if (likePostIdsXml == null) {
394 /* TODO - mark Sone as bad. */
395 logger.log(Level.WARNING, "Downloaded Sone %s has no post likes!", new Object[] { sone });
397 for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
398 String postId = likedPostIdXml.getValue();
399 likedPostIds.add(postId);
403 /* parse liked reply IDs. */
404 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
405 Set<String> likedReplyIds = new HashSet<String>();
406 if (likeReplyIdsXml == null) {
407 /* TODO - mark Sone as bad. */
408 logger.log(Level.WARNING, "Downloaded Sone %s has no reply likes!", new Object[] { sone });
410 for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
411 String replyId = likedReplyIdXml.getValue();
412 likedReplyIds.add(replyId);
416 /* okay, apparently everything was parsed correctly. Now import. */
417 /* atomic setter operation on the Sone. */
418 synchronized (sone) {
419 sone.setProfile(profile);
420 sone.setPosts(posts);
421 sone.setReplies(replies);
422 sone.setLikePostIds(likedPostIds);
423 sone.setLikeReplyIds(likedReplyIds);
437 protected void serviceStop() {
438 for (Sone sone : sones) {
439 freenetInterface.unregisterUsk(sone);