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.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.service.AbstractService;
36 import net.pterodactylus.util.xml.SimpleXML;
37 import net.pterodactylus.util.xml.XML;
39 import org.w3c.dom.Document;
41 import freenet.client.FetchResult;
42 import freenet.keys.FreenetURI;
43 import freenet.support.api.Bucket;
46 * The Sone downloader is responsible for download Sones as they are updated.
48 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
50 public class SoneDownloader extends AbstractService {
53 private static final Logger logger = Logging.getLogger(SoneDownloader.class);
56 private final Core core;
58 /** The Freenet interface. */
59 private final FreenetInterface freenetInterface;
61 /** The sones to update. */
62 private final Set<Sone> sones = new HashSet<Sone>();
65 * Creates a new Sone downloader.
69 * @param freenetInterface
70 * The Freenet interface
72 public SoneDownloader(Core core, FreenetInterface freenetInterface) {
73 super("Sone Downloader", false);
75 this.freenetInterface = freenetInterface;
83 * Adds the given Sone to the set of Sones that will be watched for updates.
88 public void addSone(Sone sone) {
89 if (sones.add(sone)) {
90 freenetInterface.registerUsk(sone, this);
95 * Removes the given Sone from the downloader.
98 * The Sone to stop watching
100 public void removeSone(Sone sone) {
101 if (sones.remove(sone)) {
102 freenetInterface.unregisterUsk(sone);
107 * Fetches the updated Sone. This method is a callback method for
108 * {@link FreenetInterface#registerUsk(Sone, SoneDownloader)}.
113 public void fetchSone(Sone sone) {
114 if (core.getSoneStatus(sone) == SoneStatus.downloading) {
117 logger.log(Level.FINE, "Starting fetch for Sone “%s” from %s…", new Object[] { sone, sone.getRequestUri().setMetaString(new String[] { "sone.xml" }) });
118 FreenetURI requestUri = sone.getRequestUri().setMetaString(new String[] { "sone.xml" });
119 core.setSoneStatus(sone, SoneStatus.downloading);
121 FetchResult fetchResult = freenetInterface.fetchUri(requestUri);
122 if (fetchResult == null) {
123 /* TODO - mark Sone as bad. */
126 logger.log(Level.FINEST, "Got %d bytes back.", fetchResult.size());
127 Sone parsedSone = parseSone(sone, fetchResult, requestUri);
128 if (parsedSone != null) {
129 core.addSone(parsedSone);
132 core.setSoneStatus(sone, (sone.getTime() == 0) ? SoneStatus.unknown : SoneStatus.idle);
137 * Parses a Sone from a fetch result.
139 * @param originalSone
140 * The sone to parse, or {@code null} if the Sone is yet unknown
145 * @return The parsed Sone, or {@code null} if the Sone could not be parsed
147 public Sone parseSone(Sone originalSone, FetchResult fetchResult, FreenetURI requestUri) {
148 logger.log(Level.FINEST, "Persing FetchResult (%d bytes, %s) for %s…", new Object[] { fetchResult.size(), fetchResult.getMimeType(), originalSone });
149 /* TODO - impose a size limit? */
150 InputStream xmlInputStream = null;
151 Bucket xmlBucket = null;
154 xmlBucket = fetchResult.asBucket();
155 xmlInputStream = xmlBucket.getInputStream();
157 /* XML parsing is not thread-safe. */
158 synchronized (this) {
159 document = XML.transformToDocument(xmlInputStream);
161 if (document == null) {
162 /* TODO - mark Sone as bad. */
163 logger.log(Level.WARNING, "Could not parse XML for Sone %s at %s!", new Object[] { originalSone, requestUri });
168 soneXml = SimpleXML.fromDocument(document);
169 } catch (NullPointerException npe1) {
170 /* for some reason, invalid XML can cause NPEs. */
171 logger.log(Level.WARNING, "XML for Sone " + originalSone + " can not be parsed!", npe1);
176 String soneId = soneXml.getValue("id", null);
177 if ((originalSone != null) && !originalSone.getId().equals(soneId)) {
178 /* TODO - mark Sone as bad. */
179 logger.log(Level.WARNING, "Downloaded ID for Sone %s (%s) does not match known ID (%s)!", new Object[] { originalSone, originalSone.getId(), soneId });
183 /* load Sone from core. */
186 sone = core.getSone(soneId).setRequestUri(requestUri.setMetaString(new String[] {}));
189 String soneName = soneXml.getValue("name", null);
190 if (soneName == null) {
191 /* TODO - mark Sone as bad. */
192 logger.log(Level.WARNING, "Downloaded name for Sone %s was null!", new Object[] { sone });
195 sone.setName(soneName);
197 String soneTime = soneXml.getValue("time", null);
198 if (soneTime == null) {
199 /* TODO - mark Sone as bad. */
200 logger.log(Level.WARNING, "Downloaded time for Sone %s was null!", new Object[] { sone });
204 sone.setTime(Long.parseLong(soneTime));
205 } catch (NumberFormatException nfe1) {
206 /* TODO - mark Sone as bad. */
207 logger.log(Level.WARNING, "Downloaded Sone %s with invalid time: %s", new Object[] { sone, soneTime });
211 SimpleXML profileXml = soneXml.getNode("profile");
212 if (profileXml == null) {
213 /* TODO - mark Sone as bad. */
214 logger.log(Level.WARNING, "Downloaded Sone %s has no profile!", new Object[] { sone });
219 String profileFirstName = profileXml.getValue("first-name", null);
220 String profileMiddleName = profileXml.getValue("middle-name", null);
221 String profileLastName = profileXml.getValue("last-name", null);
222 Profile profile = new Profile().setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
225 SimpleXML postsXml = soneXml.getNode("posts");
226 Set<Post> posts = new HashSet<Post>();
227 if (postsXml == null) {
228 /* TODO - mark Sone as bad. */
229 logger.log(Level.WARNING, "Downloaded Sone %s has no posts!", new Object[] { sone });
231 for (SimpleXML postXml : postsXml.getNodes("post")) {
232 String postId = postXml.getValue("id", null);
233 String postTime = postXml.getValue("time", null);
234 String postText = postXml.getValue("text", null);
235 if ((postId == null) || (postTime == null) || (postText == null)) {
236 /* TODO - mark Sone as bad. */
237 logger.log(Level.WARNING, "Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", new Object[] { sone, postId, postTime, postText });
241 posts.add(core.getPost(postId).setSone(sone).setTime(Long.parseLong(postTime)).setText(postText));
242 } catch (NumberFormatException nfe1) {
243 /* TODO - mark Sone as bad. */
244 logger.log(Level.WARNING, "Downloaded post for Sone %s with invalid time: %s", new Object[] { sone, postTime });
251 SimpleXML repliesXml = soneXml.getNode("replies");
252 Set<Reply> replies = new HashSet<Reply>();
253 if (repliesXml == null) {
254 /* TODO - mark Sone as bad. */
255 logger.log(Level.WARNING, "Downloaded Sone %s has no replies!", new Object[] { sone });
257 for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
258 String replyId = replyXml.getValue("id", null);
259 String replyPostId = replyXml.getValue("post-id", null);
260 String replyTime = replyXml.getValue("time", null);
261 String replyText = replyXml.getValue("text", null);
262 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
263 /* TODO - mark Sone as bad. */
264 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 });
268 replies.add(core.getReply(replyId).setSone(sone).setPost(core.getPost(replyPostId)).setTime(Long.parseLong(replyTime)).setText(replyText));
269 } catch (NumberFormatException nfe1) {
270 /* TODO - mark Sone as bad. */
271 logger.log(Level.WARNING, "Downloaded reply for Sone %s with invalid time: %s", new Object[] { sone, replyTime });
277 /* parse liked post IDs. */
278 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
279 Set<String> likedPostIds = new HashSet<String>();
280 if (likePostIdsXml == null) {
281 /* TODO - mark Sone as bad. */
282 logger.log(Level.WARNING, "Downloaded Sone %s has no post likes!", new Object[] { sone });
284 for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
285 String postId = likedPostIdXml.getValue();
286 likedPostIds.add(postId);
290 /* parse liked reply IDs. */
291 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
292 Set<String> likedReplyIds = new HashSet<String>();
293 if (likeReplyIdsXml == null) {
294 /* TODO - mark Sone as bad. */
295 logger.log(Level.WARNING, "Downloaded Sone %s has no reply likes!", new Object[] { sone });
297 for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
298 String replyId = likedReplyIdXml.getValue();
299 likedReplyIds.add(replyId);
303 /* parse known Sones. */
304 SimpleXML knownSonesXml = soneXml.getNode("known-sones");
305 Set<Sone> knownSones = new HashSet<Sone>();
306 if (knownSonesXml == null) {
307 /* TODO - mark Sone as bad. */
308 logger.log(Level.WARNING, "Downloaded Sone %s has no known Sones!", new Object[] { sone });
310 for (SimpleXML knownSoneXml : knownSonesXml.getNodes("known-sone")) {
311 String knownSoneId = knownSoneXml.getValue("sone-id", null);
312 String knownSoneKey = knownSoneXml.getValue("sone-key", null);
313 String knownSoneName = knownSoneXml.getValue("sone-name", null);
314 if ((knownSoneId == null) || (knownSoneKey == null) || (knownSoneName == null)) {
315 /* TODO - mark Sone as bad. */
316 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 });
320 knownSones.add(core.getSone(knownSoneId).setRequestUri(new FreenetURI(knownSoneKey)).setName(knownSoneName));
321 } catch (MalformedURLException mue1) {
322 /* TODO - mark Sone as bad. */
323 logger.log(Level.WARNING, "Downloaded known Sone for Sone %s with invalid key: %s", new Object[] { sone, knownSoneKey });
329 /* okay, apparently everything was parsed correctly. Now import. */
330 /* atomic setter operation on the Sone. */
331 synchronized (sone) {
332 sone.setProfile(profile);
333 sone.setPosts(posts);
334 sone.setReplies(replies);
335 sone.setLikePostIds(likedPostIds);
336 sone.setModificationCounter(0);
339 /* add all known Sones to core for downloading. */
340 for (Sone knownSone : knownSones) {
341 core.addSone(knownSone);
344 } catch (IOException ioe1) {
345 logger.log(Level.WARNING, "Could not read XML file from " + originalSone + "!", ioe1);
348 if (xmlBucket != null) {
351 Closer.close(xmlInputStream);
364 protected void serviceStop() {
365 for (Sone sone : sones) {
366 freenetInterface.unregisterUsk(sone);