2 * Sone - SoneInserter.java - Copyright © 2010–2012 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.HashMap;
24 import java.util.HashSet;
26 import java.util.logging.Level;
27 import java.util.logging.Logger;
29 import net.pterodactylus.sone.data.Post;
30 import net.pterodactylus.sone.data.Reply;
31 import net.pterodactylus.sone.data.Sone;
32 import net.pterodactylus.sone.data.Sone.SoneStatus;
33 import net.pterodactylus.sone.freenet.StringBucket;
34 import net.pterodactylus.sone.main.SonePlugin;
35 import net.pterodactylus.util.io.Closer;
36 import net.pterodactylus.util.logging.Logging;
37 import net.pterodactylus.util.service.AbstractService;
38 import net.pterodactylus.util.template.HtmlFilter;
39 import net.pterodactylus.util.template.ReflectionAccessor;
40 import net.pterodactylus.util.template.Template;
41 import net.pterodactylus.util.template.TemplateContext;
42 import net.pterodactylus.util.template.TemplateContextFactory;
43 import net.pterodactylus.util.template.TemplateException;
44 import net.pterodactylus.util.template.TemplateParser;
45 import net.pterodactylus.util.template.XmlFilter;
47 import com.google.common.collect.Ordering;
49 import freenet.client.async.ManifestElement;
50 import freenet.keys.FreenetURI;
53 * A Sone inserter is responsible for inserting a Sone if it has changed.
55 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
57 public class SoneInserter extends AbstractService {
60 private static final Logger logger = Logging.getLogger(SoneInserter.class);
62 /** The insertion delay (in seconds). */
63 private static volatile int insertionDelay = 60;
65 /** The template factory used to create the templates. */
66 private static final TemplateContextFactory templateContextFactory = new TemplateContextFactory();
69 templateContextFactory.addAccessor(Object.class, new ReflectionAccessor());
70 templateContextFactory.addFilter("xml", new XmlFilter());
71 templateContextFactory.addFilter("html", new HtmlFilter());
74 /** The UTF-8 charset. */
75 private static final Charset utf8Charset = Charset.forName("UTF-8");
78 private final Core core;
80 /** The Freenet interface. */
81 private final FreenetInterface freenetInterface;
83 /** The Sone to insert. */
84 private final Sone sone;
86 /** The insert listener manager. */
87 private SoneInsertListenerManager soneInsertListenerManager;
89 /** Whether a modification has been detected. */
90 private volatile boolean modified = false;
92 /** The fingerprint of the last insert. */
93 private volatile String lastInsertFingerprint;
96 * Creates a new Sone inserter.
100 * @param freenetInterface
101 * The freenet interface
105 public SoneInserter(Core core, FreenetInterface freenetInterface, Sone sone) {
106 super("Sone Inserter for “" + sone.getName() + "”", false);
108 this.freenetInterface = freenetInterface;
110 this.soneInsertListenerManager = new SoneInsertListenerManager(sone);
114 // LISTENER MANAGEMENT
118 * Adds a listener for Sone insert events.
120 * @param soneInsertListener
121 * The Sone insert listener
123 public void addSoneInsertListener(SoneInsertListener soneInsertListener) {
124 soneInsertListenerManager.addListener(soneInsertListener);
128 * Removes a listener for Sone insert events.
130 * @param soneInsertListener
131 * The Sone insert listener
133 public void removeSoneInsertListener(SoneInsertListener soneInsertListener) {
134 soneInsertListenerManager.removeListener(soneInsertListener);
142 * Changes the insertion delay, i.e. the time the Sone inserter waits after
143 * it has noticed a Sone modification before it starts the insert.
145 * @param insertionDelay
146 * The insertion delay (in seconds)
148 public static void setInsertionDelay(int insertionDelay) {
149 SoneInserter.insertionDelay = insertionDelay;
153 * Returns the fingerprint of the last insert.
155 * @return The fingerprint of the last insert
157 public String getLastInsertFingerprint() {
158 return lastInsertFingerprint;
162 * Sets the fingerprint of the last insert.
164 * @param lastInsertFingerprint
165 * The fingerprint of the last insert
167 public void setLastInsertFingerprint(String lastInsertFingerprint) {
168 this.lastInsertFingerprint = lastInsertFingerprint;
172 * Returns whether the Sone inserter has detected a modification of the
175 * @return {@code true} if the Sone has been modified, {@code false}
178 public boolean isModified() {
190 protected void serviceRun() {
191 long lastModificationTime = 0;
192 String lastInsertedFingerprint = lastInsertFingerprint;
193 String lastFingerprint = "";
194 while (!shouldStop()) { try {
195 /* check every seconds. */
198 /* don’t insert locked Sones. */
199 if (core.isLocked(sone)) {
200 /* trigger redetection when the Sone is unlocked. */
201 synchronized (sone) {
202 modified = !sone.getFingerprint().equals(lastInsertedFingerprint);
204 lastFingerprint = "";
205 lastModificationTime = 0;
209 InsertInformation insertInformation = null;
210 synchronized (sone) {
211 String fingerprint = sone.getFingerprint();
212 if (!fingerprint.equals(lastFingerprint)) {
213 if (fingerprint.equals(lastInsertedFingerprint)) {
215 lastModificationTime = 0;
216 logger.log(Level.FINE, String.format("Sone %s has been reverted to last insert state.", sone));
218 lastModificationTime = System.currentTimeMillis();
220 logger.log(Level.FINE, String.format("Sone %s has been modified, waiting %d seconds before inserting.", sone.getName(), insertionDelay));
222 lastFingerprint = fingerprint;
224 if (modified && (lastModificationTime > 0) && ((System.currentTimeMillis() - lastModificationTime) > (insertionDelay * 1000))) {
225 lastInsertedFingerprint = fingerprint;
226 insertInformation = new InsertInformation(sone);
230 if (insertInformation != null) {
231 logger.log(Level.INFO, String.format("Inserting Sone “%s”…", sone.getName()));
233 boolean success = false;
235 sone.setStatus(SoneStatus.inserting);
236 long insertTime = System.currentTimeMillis();
237 insertInformation.setTime(insertTime);
238 soneInsertListenerManager.fireInsertStarted();
239 FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri(), insertInformation.generateManifestEntries(), "index.html");
240 soneInsertListenerManager.fireInsertFinished(System.currentTimeMillis() - insertTime);
241 /* at this point we might already be stopped. */
243 /* if so, bail out, don’t change anything. */
246 sone.setTime(insertTime);
247 sone.setLatestEdition(finalUri.getEdition());
248 core.touchConfiguration();
250 logger.log(Level.INFO, String.format("Inserted Sone “%s” at %s.", sone.getName(), finalUri));
251 } catch (SoneException se1) {
252 soneInsertListenerManager.fireInsertAborted(se1);
253 logger.log(Level.WARNING, String.format("Could not insert Sone “%s”!", sone.getName()), se1);
255 sone.setStatus(SoneStatus.idle);
259 * reset modification counter if Sone has not been modified
260 * while it was inserted.
263 synchronized (sone) {
264 if (lastInsertedFingerprint.equals(sone.getFingerprint())) {
265 logger.log(Level.FINE, String.format("Sone “%s” was not modified further, resetting counter…", sone));
266 lastModificationTime = 0;
267 lastInsertFingerprint = lastInsertedFingerprint;
268 core.touchConfiguration();
274 } catch (Throwable t1) {
275 logger.log(Level.SEVERE, "SoneInserter threw an Exception!", t1);
280 * Container for information that are required to insert a Sone. This
281 * container merely exists to copy all relevant data without holding a lock
282 * on the {@link Sone} object for too long.
284 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
286 private class InsertInformation {
288 /** All properties of the Sone, copied for thread safety. */
289 private final Map<String, Object> soneProperties = new HashMap<String, Object>();
292 * Creates a new insert information container.
297 public InsertInformation(Sone sone) {
298 soneProperties.put("id", sone.getId());
299 soneProperties.put("name", sone.getName());
300 soneProperties.put("time", sone.getTime());
301 soneProperties.put("requestUri", sone.getRequestUri());
302 soneProperties.put("insertUri", sone.getInsertUri());
303 soneProperties.put("profile", sone.getProfile());
304 soneProperties.put("posts", Ordering.from(Post.TIME_COMPARATOR).sortedCopy(sone.getPosts()));
305 soneProperties.put("replies", Ordering.from(Reply.TIME_COMPARATOR).reverse().sortedCopy(sone.getReplies()));
306 soneProperties.put("likedPostIds", new HashSet<String>(sone.getLikedPostIds()));
307 soneProperties.put("likedReplyIds", new HashSet<String>(sone.getLikedReplyIds()));
308 soneProperties.put("albums", sone.getAllAlbums());
316 * Returns the insert URI of the Sone.
318 * @return The insert URI of the Sone
320 public FreenetURI getInsertUri() {
321 return (FreenetURI) soneProperties.get("insertUri");
325 * Sets the time of the Sone at the time of the insert.
328 * The time of the Sone
330 public void setTime(long time) {
331 soneProperties.put("time", time);
339 * Generates all manifest entries required to insert this Sone.
341 * @return The manifest entries for the Sone insert
343 public HashMap<String, Object> generateManifestEntries() {
344 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
346 /* first, create an index.html. */
347 manifestEntries.put("index.html", createManifestElement("index.html", "text/html; charset=utf-8", "/templates/insert/index.html"));
349 /* now, store the sone. */
350 manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml"));
352 return manifestEntries;
360 * Creates a new manifest element.
363 * The name of the file
365 * The content type of the file
366 * @param templateName
367 * The name of the template to render
368 * @return The manifest element
370 @SuppressWarnings("synthetic-access")
371 private ManifestElement createManifestElement(String name, String contentType, String templateName) {
372 InputStreamReader templateInputStreamReader = null;
375 templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset);
376 template = TemplateParser.parse(templateInputStreamReader);
377 } catch (TemplateException te1) {
378 logger.log(Level.SEVERE, String.format("Could not parse template “%s”!", templateName), te1);
381 Closer.close(templateInputStreamReader);
384 TemplateContext templateContext = templateContextFactory.createTemplateContext();
385 templateContext.set("core", core);
386 templateContext.set("currentSone", soneProperties);
387 templateContext.set("currentEdition", core.getUpdateChecker().getLatestEdition());
388 templateContext.set("version", SonePlugin.VERSION);
389 StringWriter writer = new StringWriter();
390 StringBucket bucket = null;
392 template.render(templateContext, writer);
393 bucket = new StringBucket(writer.toString(), utf8Charset);
394 return new ManifestElement(name, bucket, contentType, bucket.size());
395 } catch (TemplateException te1) {
396 logger.log(Level.SEVERE, String.format("Could not render template “%s”!", templateName), te1);
399 Closer.close(writer);
400 if (bucket != null) {