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.util.HashSet;
24 import java.util.logging.Level;
25 import java.util.logging.Logger;
27 import net.pterodactylus.sone.data.Post;
28 import net.pterodactylus.sone.data.Profile;
29 import net.pterodactylus.sone.data.Reply;
30 import net.pterodactylus.sone.data.Sone;
31 import net.pterodactylus.util.io.Closer;
32 import net.pterodactylus.util.logging.Logging;
33 import net.pterodactylus.util.service.AbstractService;
34 import net.pterodactylus.util.xml.SimpleXML;
35 import net.pterodactylus.util.xml.XML;
37 import org.w3c.dom.Document;
39 import freenet.client.FetchResult;
40 import freenet.support.api.Bucket;
43 * The Sone downloader is responsible for download Sones as they are updated.
45 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
47 public class SoneDownloader extends AbstractService {
50 private static final Logger logger = Logging.getLogger(SoneDownloader.class);
53 private final Core core;
55 /** The Freenet interface. */
56 private final FreenetInterface freenetInterface;
58 /** The sones to update. */
59 private final Set<Sone> sones = new HashSet<Sone>();
62 * Creates a new Sone downloader.
66 * @param freenetInterface
67 * The Freenet interface
69 public SoneDownloader(Core core, FreenetInterface freenetInterface) {
70 super("Sone Downloader");
72 this.freenetInterface = freenetInterface;
80 * Adds the given Sone to the set of Sones that will be watched for updates.
85 public void addSone(Sone sone) {
86 if (sones.add(sone)) {
87 freenetInterface.registerUsk(sone, this);
92 * Removes the given Sone from the downloader.
95 * The Sone to stop watching
97 public void removeSone(Sone sone) {
98 if (sones.remove(sone)) {
99 freenetInterface.unregisterUsk(sone);
104 * Fetches the updated Sone. This method is a callback method for
105 * {@link FreenetInterface#registerUsk(Sone, SoneDownloader)}.
110 public void fetchSone(Sone sone) {
111 logger.log(Level.FINE, "Starting fetch for Sone “%s” from %s…", new Object[] { sone, sone.getRequestUri().setMetaString(new String[] { "sone.xml" }) });
112 FetchResult fetchResult = freenetInterface.fetchUri(sone.getRequestUri().setMetaString(new String[] { "sone.xml" }));
113 logger.log(Level.FINEST, "Got %d bytes back.", fetchResult.size());
114 parseSone(sone, fetchResult);
117 public Sone parseSone(Sone sone, FetchResult fetchResult) {
118 logger.log(Level.FINEST, "Persing FetchResult (%d bytes, %s) for %s…", new Object[] { fetchResult.size(), fetchResult.getMimeType(), sone });
119 /* TODO - impose a size limit? */
120 InputStream xmlInputStream = null;
121 Bucket xmlBucket = null;
123 xmlBucket = fetchResult.asBucket();
124 xmlInputStream = xmlBucket.getInputStream();
125 Document document = XML.transformToDocument(xmlInputStream);
128 soneXml = SimpleXML.fromDocument(document);
129 } catch (NullPointerException npe1) {
130 /* for some reason, invalid XML can cause NPEs. */
131 logger.log(Level.WARNING, "XML for Sone " + sone + " can not be parsed!", npe1);
136 String soneId = soneXml.getValue("id", null);
137 if ((sone != null) && !sone.getId().equals(soneId)) {
138 /* TODO - mark Sone as bad. */
139 logger.log(Level.WARNING, "Downloaded ID for Sone %s (%s) does not match known ID (%s)!", new Object[] { sone, sone.getId(), soneId });
143 /* load Sone from core. */
145 sone = core.getSone(soneId);
148 String soneName = soneXml.getValue("name", null);
149 if (soneName == null) {
150 /* TODO - mark Sone as bad. */
151 logger.log(Level.WARNING, "Downloaded name for Sone %s was null!", new Object[] { sone });
155 SimpleXML profileXml = soneXml.getNode("profile");
156 if (profileXml == null) {
157 /* TODO - mark Sone as bad. */
158 logger.log(Level.WARNING, "Downloaded Sone %s has no profile!", new Object[] { sone });
163 String profileFirstName = profileXml.getValue("first-name", null);
164 String profileMiddleName = profileXml.getValue("middle-name", null);
165 String profileLastName = profileXml.getValue("last-name", null);
166 Profile profile = new Profile().setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
169 SimpleXML postsXml = soneXml.getNode("posts");
170 if (postsXml == null) {
171 /* TODO - mark Sone as bad. */
172 logger.log(Level.WARNING, "Downloaded Sone %s has no posts!", new Object[] { sone });
176 Set<Post> posts = new HashSet<Post>();
177 for (SimpleXML postXml : postsXml.getNodes("post")) {
178 String postId = postXml.getValue("id", null);
179 String postTime = postXml.getValue("time", null);
180 String postText = postXml.getValue("text", null);
181 if ((postId == null) || (postTime == null) || (postText == null)) {
182 /* TODO - mark Sone as bad. */
183 logger.log(Level.WARNING, "Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", new Object[] { sone, postId, postTime, postText });
187 posts.add(core.getPost(postId).setSone(sone).setTime(Long.parseLong(postTime)).setText(postText));
188 } catch (NumberFormatException nfe1) {
189 /* TODO - mark Sone as bad. */
190 logger.log(Level.WARNING, "Downloaded post for Sone %s with invalid time: %s", new Object[] { sone, postTime });
196 SimpleXML repliesXml = soneXml.getNode("replies");
197 if (repliesXml == null) {
198 /* TODO - mark Sone as bad. */
199 logger.log(Level.WARNING, "Downloaded Sone %s has no replies!", new Object[] { sone });
203 Set<Reply> replies = new HashSet<Reply>();
204 for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
205 String replyId = replyXml.getValue("id", null);
206 String replyPostId = replyXml.getValue("post-id", null);
207 String replyTime = replyXml.getValue("time", null);
208 String replyText = replyXml.getValue("text", null);
209 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
210 /* TODO - mark Sone as bad. */
211 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 });
215 replies.add(core.getReply(replyId).setSone(sone).setPost(core.getPost(replyPostId)).setTime(Long.parseLong(replyTime)).setText(replyText));
216 } catch (NumberFormatException nfe1) {
217 /* TODO - mark Sone as bad. */
218 logger.log(Level.WARNING, "Downloaded reply for Sone %s with invalid time: %s", new Object[] { sone, replyTime });
223 /* okay, apparently everything was parsed correctly. Now import. */
224 /* atomic setter operation on the Sone. */
225 synchronized (sone) {
226 sone.setProfile(profile);
227 sone.setPosts(posts);
228 sone.setReplies(replies);
229 sone.setModificationCounter(0);
231 } catch (IOException ioe1) {
232 logger.log(Level.WARNING, "Could not read XML file from " + sone + "!", ioe1);
235 if (xmlBucket != null) {
238 Closer.close(xmlInputStream);
251 protected void serviceStop() {
252 for (Sone sone : sones) {
253 freenetInterface.unregisterUsk(sone);