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.HashMap;
25 import java.util.HashSet;
27 import java.util.logging.Level;
28 import java.util.logging.Logger;
30 import net.pterodactylus.sone.core.Core.SoneStatus;
31 import net.pterodactylus.sone.data.Post;
32 import net.pterodactylus.sone.data.Reply;
33 import net.pterodactylus.sone.data.Sone;
34 import net.pterodactylus.sone.freenet.StringBucket;
35 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
36 import net.pterodactylus.util.io.Closer;
37 import net.pterodactylus.util.logging.Logging;
38 import net.pterodactylus.util.service.AbstractService;
39 import net.pterodactylus.util.template.DefaultTemplateFactory;
40 import net.pterodactylus.util.template.ReflectionAccessor;
41 import net.pterodactylus.util.template.Template;
42 import net.pterodactylus.util.template.TemplateException;
43 import net.pterodactylus.util.template.XmlFilter;
44 import freenet.client.async.ManifestElement;
45 import freenet.keys.FreenetURI;
48 * A Sone inserter is responsible for inserting a Sone if it has changed.
50 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
52 public class SoneInserter extends AbstractService {
55 private static final Logger logger = Logging.getLogger(SoneInserter.class);
57 /** The insertion delay (in seconds). */
58 private static volatile int insertionDelay = 60;
60 /** The template factory used to create the templates. */
61 private static final DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
64 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
65 templateFactory.addFilter("xml", new XmlFilter());
68 /** The UTF-8 charset. */
69 private static final Charset utf8Charset = Charset.forName("UTF-8");
72 private final Core core;
74 /** The Freenet interface. */
75 private final FreenetInterface freenetInterface;
77 /** The Sone to insert. */
78 private final Sone sone;
81 * Creates a new Sone inserter.
85 * @param freenetInterface
86 * The freenet interface
90 public SoneInserter(Core core, FreenetInterface freenetInterface, Sone sone) {
91 super("Sone Inserter for “" + sone.getName() + "”", false);
93 this.freenetInterface = freenetInterface;
102 * Changes the insertion delay, i.e. the time the Sone inserter waits after
103 * it has noticed a Sone modification before it starts the insert.
105 * @param insertionDelay
106 * The insertion delay (in seconds)
108 public static void setInsertionDelay(int insertionDelay) {
109 SoneInserter.insertionDelay = insertionDelay;
120 protected void serviceRun() {
121 long modificationCounter = 0;
122 long lastModificationTime = 0;
123 while (!shouldStop()) {
124 /* check every seconds. */
127 InsertInformation insertInformation = null;
128 synchronized (sone) {
129 if (sone.getModificationCounter() > modificationCounter) {
130 modificationCounter = sone.getModificationCounter();
131 lastModificationTime = System.currentTimeMillis();
132 sone.setTime(lastModificationTime);
133 logger.log(Level.FINE, "Sone %s has been modified, waiting %d seconds before inserting.", new Object[] { sone.getName(), insertionDelay });
135 if ((lastModificationTime > 0) && ((System.currentTimeMillis() - lastModificationTime) > (insertionDelay * 1000))) {
136 insertInformation = new InsertInformation(sone);
140 if (insertInformation != null) {
141 logger.log(Level.INFO, "Inserting Sone “%s”…", new Object[] { sone.getName() });
143 boolean success = false;
145 core.setSoneStatus(sone, SoneStatus.inserting);
146 FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri().setKeyType("USK").setSuggestedEdition(0), insertInformation.generateManifestEntries(), "index.html");
147 sone.updateUris(finalUri.getEdition());
148 /* TODO - better encapsulation? */
149 core.getIdentityManager().setProperty((OwnIdentity) sone.getIdentity(), "Sone.LatestEdition", String.valueOf(finalUri.getEdition()));
151 logger.log(Level.INFO, "Inserted Sone “%s” at %s.", new Object[] { sone.getName(), finalUri });
152 } catch (SoneException se1) {
153 logger.log(Level.WARNING, "Could not insert Sone “" + sone.getName() + "”!", se1);
155 core.setSoneStatus(sone, SoneStatus.idle);
159 * reset modification counter if Sone has not been modified
160 * while it was inserted.
163 synchronized (sone) {
164 if (sone.getModificationCounter() == modificationCounter) {
165 logger.log(Level.FINE, "Sone “%s” was not modified further, resetting counter…", new Object[] { sone });
166 sone.setModificationCounter(0);
167 modificationCounter = 0;
168 lastModificationTime = 0;
177 * Container for information that are required to insert a Sone. This
178 * container merely exists to copy all relevant data without holding a lock
179 * on the {@link Sone} object for too long.
181 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
183 private class InsertInformation {
185 /** All properties of the Sone, copied for thread safety. */
186 private final Map<String, Object> soneProperties = new HashMap<String, Object>();
189 * Creates a new insert information container.
194 public InsertInformation(Sone sone) {
195 soneProperties.put("id", sone.getId());
196 soneProperties.put("name", sone.getName());
197 soneProperties.put("time", sone.getTime());
198 soneProperties.put("requestUri", sone.getRequestUri());
199 soneProperties.put("insertUri", sone.getInsertUri());
200 soneProperties.put("profile", sone.getProfile());
201 soneProperties.put("posts", new ArrayList<Post>(sone.getPosts()));
202 soneProperties.put("replies", new HashSet<Reply>(sone.getReplies()));
203 soneProperties.put("likedPostIds", new HashSet<String>(sone.getLikedPostIds()));
204 soneProperties.put("likeReplyIds", new HashSet<String>(sone.getLikedReplyIds()));
212 * Returns the insert URI of the Sone.
214 * @return The insert URI of the Sone
216 public FreenetURI getInsertUri() {
217 return (FreenetURI) soneProperties.get("insertUri");
225 * Generates all manifest entries required to insert this Sone.
227 * @return The manifest entries for the Sone insert
229 public HashMap<String, Object> generateManifestEntries() {
230 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
232 /* first, create an index.html. */
233 manifestEntries.put("index.html", createManifestElement("index.html", "text/html; charset=utf-8", "/templates/insert/index.html"));
235 /* now, store the sone. */
236 manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml"));
238 return manifestEntries;
246 * Creates a new manifest element.
249 * The name of the file
251 * The content type of the file
252 * @param templateName
253 * The name of the template to render
254 * @return The manifest element
256 @SuppressWarnings("synthetic-access")
257 private ManifestElement createManifestElement(String name, String contentType, String templateName) {
258 InputStreamReader templateInputStreamReader;
259 Template template = templateFactory.createTemplate(templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset));
262 } catch (TemplateException te1) {
263 logger.log(Level.SEVERE, "Could not parse template “" + templateName + "”!", te1);
266 Closer.close(templateInputStreamReader);
269 template.set("currentSone", soneProperties);
270 StringWriter writer = new StringWriter();
271 StringBucket bucket = null;
273 template.render(writer);
274 bucket = new StringBucket(writer.toString(), utf8Charset);
275 return new ManifestElement(name, bucket, contentType, bucket.size());
276 } catch (TemplateException te1) {
277 logger.log(Level.SEVERE, "Could not render template “" + templateName + "”!", te1);
280 Closer.close(writer);
281 if (bucket != null) {