2 * FreenetSone - SoneInserter.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.InputStreamReader;
21 import java.io.StringWriter;
22 import java.nio.charset.Charset;
23 import java.util.ArrayList;
24 import java.util.Collection;
25 import java.util.HashMap;
26 import java.util.HashSet;
28 import java.util.logging.Level;
29 import java.util.logging.Logger;
31 import net.pterodactylus.sone.core.Core.SoneStatus;
32 import net.pterodactylus.sone.data.Post;
33 import net.pterodactylus.sone.data.Reply;
34 import net.pterodactylus.sone.data.Sone;
35 import net.pterodactylus.sone.freenet.StringBucket;
36 import net.pterodactylus.util.filter.Filter;
37 import net.pterodactylus.util.filter.Filters;
38 import net.pterodactylus.util.io.Closer;
39 import net.pterodactylus.util.logging.Logging;
40 import net.pterodactylus.util.service.AbstractService;
41 import net.pterodactylus.util.template.DefaultTemplateFactory;
42 import net.pterodactylus.util.template.ReflectionAccessor;
43 import net.pterodactylus.util.template.Template;
44 import net.pterodactylus.util.template.TemplateException;
45 import net.pterodactylus.util.template.XmlFilter;
46 import freenet.client.async.ManifestElement;
47 import freenet.keys.FreenetURI;
50 * A Sone inserter is responsible for inserting a Sone if it has changed.
52 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
54 public class SoneInserter extends AbstractService {
57 private static final Logger logger = Logging.getLogger(SoneInserter.class);
59 /** The template factory used to create the templates. */
60 private static final DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
63 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
64 templateFactory.addFilter("xml", new XmlFilter());
67 /** The UTF-8 charset. */
68 private static final Charset utf8Charset = Charset.forName("UTF-8");
71 private final Core core;
73 /** The Freenet interface. */
74 private final FreenetInterface freenetInterface;
76 /** The Sone to insert. */
77 private final Sone sone;
80 * Creates a new Sone inserter.
84 * @param freenetInterface
85 * The freenet interface
89 public SoneInserter(Core core, FreenetInterface freenetInterface, Sone sone) {
90 super("Sone Inserter for “" + sone.getName() + "”");
92 this.freenetInterface = freenetInterface;
104 protected void serviceRun() {
105 long modificationCounter = 0;
106 boolean restartNow = true;
107 while (!shouldStop()) {
109 logger.log(Level.FINEST, "Waiting 60 seconds before checking Sone “" + sone.getName() + "”.");
113 InsertInformation insertInformation = null;
114 synchronized (sone) {
115 modificationCounter = sone.getModificationCounter();
116 if (modificationCounter > 0) {
117 sone.setTime(System.currentTimeMillis());
118 insertInformation = new InsertInformation(sone);
121 if (insertInformation != null) {
122 logger.log(Level.INFO, "Inserting Sone “%s”…", new Object[] { sone.getName() });
124 boolean success = false;
126 core.setSoneStatus(sone, SoneStatus.inserting);
127 FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri().setKeyType("USK").setDocName("Sone-" + sone.getName()).setSuggestedEdition(0), insertInformation.generateManifestEntries(), "index.html");
128 sone.updateUris(finalUri);
130 logger.log(Level.INFO, "Inserted Sone “%s” at %s.", new Object[] { sone.getName(), finalUri });
131 } catch (SoneException se1) {
132 logger.log(Level.WARNING, "Could not insert Sone “" + sone.getName() + "”!", se1);
134 core.setSoneStatus(sone, SoneStatus.idle);
138 * reset modification counter if Sone has not been modified
139 * while it was inserted.
142 synchronized (sone) {
143 if (sone.getModificationCounter() == modificationCounter) {
144 logger.log(Level.FINE, "Sone “%s” was not modified further, resetting counter…", new Object[] { sone });
145 sone.setModificationCounter(0);
147 logger.log(Level.FINE, "Sone “%s” was modified since the insert started, starting another insert…", new Object[] { sone });
157 * Container for information that are required to insert a Sone. This
158 * container merely exists to copy all relevant data without holding a lock
159 * on the {@link Sone} object for too long.
161 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
163 private class InsertInformation {
165 /** All properties of the Sone, copied for thread safety. */
166 private final Map<String, Object> soneProperties = new HashMap<String, Object>();
169 * Creates a new insert information container.
174 public InsertInformation(Sone sone) {
175 soneProperties.put("id", sone.getId());
176 soneProperties.put("name", sone.getName());
177 soneProperties.put("time", sone.getTime());
178 soneProperties.put("requestUri", sone.getRequestUri());
179 soneProperties.put("insertUri", sone.getInsertUri());
180 soneProperties.put("profile", sone.getProfile());
181 soneProperties.put("posts", new ArrayList<Post>(sone.getPosts()));
182 soneProperties.put("replies", new HashSet<Reply>(sone.getReplies()));
183 soneProperties.put("friends", new HashSet<Sone>(sone.getFriends()));
184 soneProperties.put("blockedSoneIds", new HashSet<String>(sone.getBlockedSoneIds()));
192 * Returns the insert URI of the Sone.
194 * @return The insert URI of the Sone
196 public FreenetURI getInsertUri() {
197 return (FreenetURI) soneProperties.get("insertUri");
205 * Generates all manifest entries required to insert this Sone.
207 * @return The manifest entries for the Sone insert
209 public HashMap<String, Object> generateManifestEntries() {
210 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
212 /* first, create an index.html. */
213 manifestEntries.put("index.html", createManifestElement("index.html", "text/html; charset=utf-8", "/templates/insert/index.html"));
215 /* now, store the sone. */
216 manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml"));
218 return manifestEntries;
226 * Creates a new manifest element.
229 * The name of the file
231 * The content type of the file
232 * @param templateName
233 * The name of the template to render
234 * @return The manifest element
236 @SuppressWarnings("synthetic-access")
237 private ManifestElement createManifestElement(String name, String contentType, String templateName) {
238 InputStreamReader templateInputStreamReader;
239 Template template = templateFactory.createTemplate(templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset));
242 } catch (TemplateException te1) {
243 logger.log(Level.SEVERE, "Could not parse template “" + templateName + "”!", te1);
246 Closer.close(templateInputStreamReader);
248 Collection<Sone> knownSones = Filters.filteredCollection(core.getKnownSones(), new Filter<Sone>() {
254 public boolean filterObject(Sone object) {
255 return !soneProperties.containsKey(object.getId()) && !object.getId().equals(soneProperties.get("id"));
259 template.set("currentSone", soneProperties);
260 template.set("knownSones", knownSones);
261 StringWriter writer = new StringWriter();
262 StringBucket bucket = null;
264 template.render(writer);
265 bucket = new StringBucket(writer.toString(), utf8Charset);
266 return new ManifestElement(name, bucket, contentType, bucket.size());
267 } catch (TemplateException te1) {
268 logger.log(Level.SEVERE, "Could not render template “" + templateName + "”!", te1);
271 Closer.close(writer);
272 if (bucket != null) {