2 * Sone - SoneInserter.java - Copyright © 2010–2013 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 static com.google.common.base.Preconditions.checkArgument;
21 import static net.pterodactylus.sone.data.Album.NOT_EMPTY;
22 import static net.pterodactylus.sone.data.Sone.TO_FREENET_URI;
23 import static net.pterodactylus.sone.data.Sone.TO_INSERT_URI;
25 import java.io.InputStreamReader;
26 import java.io.StringWriter;
27 import java.nio.charset.Charset;
28 import java.util.HashMap;
29 import java.util.HashSet;
32 import java.util.logging.Level;
33 import java.util.logging.Logger;
35 import net.pterodactylus.sone.core.event.SoneInsertAbortedEvent;
36 import net.pterodactylus.sone.core.event.SoneInsertedEvent;
37 import net.pterodactylus.sone.core.event.SoneInsertingEvent;
38 import net.pterodactylus.sone.data.Album;
39 import net.pterodactylus.sone.data.Post;
40 import net.pterodactylus.sone.data.Reply;
41 import net.pterodactylus.sone.data.Sone;
42 import net.pterodactylus.sone.data.Sone.SoneStatus;
43 import net.pterodactylus.sone.freenet.StringBucket;
44 import net.pterodactylus.sone.main.SonePlugin;
45 import net.pterodactylus.util.io.Closer;
46 import net.pterodactylus.util.logging.Logging;
47 import net.pterodactylus.util.service.AbstractService;
48 import net.pterodactylus.util.template.HtmlFilter;
49 import net.pterodactylus.util.template.ReflectionAccessor;
50 import net.pterodactylus.util.template.Template;
51 import net.pterodactylus.util.template.TemplateContext;
52 import net.pterodactylus.util.template.TemplateContextFactory;
53 import net.pterodactylus.util.template.TemplateException;
54 import net.pterodactylus.util.template.TemplateParser;
55 import net.pterodactylus.util.template.XmlFilter;
57 import freenet.client.async.ManifestElement;
58 import freenet.keys.FreenetURI;
59 import freenet.support.api.Bucket;
61 import com.google.common.collect.FluentIterable;
62 import com.google.common.collect.Ordering;
63 import com.google.common.eventbus.EventBus;
66 * A Sone inserter is responsible for inserting a Sone if it has changed.
68 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
70 public class SoneInserter extends AbstractService {
73 private static final Logger logger = Logging.getLogger(SoneInserter.class);
75 /** The insertion delay (in seconds). */
76 private static volatile int insertionDelay = 60;
78 /** The template factory used to create the templates. */
79 private static final TemplateContextFactory templateContextFactory = new TemplateContextFactory();
82 templateContextFactory.addAccessor(Object.class, new ReflectionAccessor());
83 templateContextFactory.addFilter("xml", new XmlFilter());
84 templateContextFactory.addFilter("html", new HtmlFilter());
87 /** The UTF-8 charset. */
88 private static final Charset utf8Charset = Charset.forName("UTF-8");
91 private final Core core;
94 private final EventBus eventBus;
96 /** The Freenet interface. */
97 private final FreenetInterface freenetInterface;
99 /** The Sone to insert. */
100 private volatile Sone sone;
102 /** Whether a modification has been detected. */
103 private volatile boolean modified = false;
105 /** The fingerprint of the last insert. */
106 private volatile String lastInsertFingerprint;
109 * Creates a new Sone inserter.
115 * @param freenetInterface
116 * The freenet interface
120 public SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, Sone sone) {
121 super("Sone Inserter for “" + sone.getName() + "”", false);
123 this.eventBus = eventBus;
124 this.freenetInterface = freenetInterface;
133 * Sets the Sone to insert.
137 * @return This Sone inserter
139 public SoneInserter setSone(Sone sone) {
140 checkArgument((this.sone == null) || sone.equals(this.sone), "Sone to insert can not be set to a different Sone");
146 * Changes the insertion delay, i.e. the time the Sone inserter waits after it
147 * has noticed a Sone modification before it starts the insert.
149 * @param insertionDelay
150 * The insertion delay (in seconds)
152 public static void setInsertionDelay(int insertionDelay) {
153 SoneInserter.insertionDelay = insertionDelay;
157 * Returns the fingerprint of the last insert.
159 * @return The fingerprint of the last insert
161 public String getLastInsertFingerprint() {
162 return lastInsertFingerprint;
166 * Sets the fingerprint of the last insert.
168 * @param lastInsertFingerprint
169 * The fingerprint of the last insert
171 public void setLastInsertFingerprint(String lastInsertFingerprint) {
172 this.lastInsertFingerprint = lastInsertFingerprint;
176 * Returns whether the Sone inserter has detected a modification of the
179 * @return {@code true} if the Sone has been modified, {@code false}
182 public boolean isModified() {
191 protected void serviceRun() {
192 long lastModificationTime = 0;
193 String lastInsertedFingerprint = lastInsertFingerprint;
194 String lastFingerprint = "";
196 while (!shouldStop()) {
198 /* check every seconds. */
201 /* don’t insert locked Sones. */
203 if (core.isLocked(sone)) {
204 /* trigger redetection when the Sone is unlocked. */
205 synchronized (sone) {
206 modified = !sone.getFingerprint().equals(lastInsertedFingerprint);
208 lastFingerprint = "";
209 lastModificationTime = 0;
213 InsertInformation insertInformation = null;
214 synchronized (sone) {
215 String fingerprint = sone.getFingerprint();
216 if (!fingerprint.equals(lastFingerprint)) {
217 if (fingerprint.equals(lastInsertedFingerprint)) {
219 lastModificationTime = 0;
220 logger.log(Level.FINE, String.format("Sone %s has been reverted to last insert state.", sone));
222 lastModificationTime = System.currentTimeMillis();
224 logger.log(Level.FINE, String.format("Sone %s has been modified, waiting %d seconds before inserting.", sone.getName(), insertionDelay));
226 lastFingerprint = fingerprint;
228 if (modified && (lastModificationTime > 0) && ((System.currentTimeMillis() - lastModificationTime) > (insertionDelay * 1000))) {
229 lastInsertedFingerprint = fingerprint;
230 insertInformation = new InsertInformation(sone);
234 if (insertInformation != null) {
235 logger.log(Level.INFO, String.format("Inserting Sone “%s”…", sone.getName()));
237 boolean success = false;
239 sone.setStatus(SoneStatus.inserting);
240 long insertTime = System.currentTimeMillis();
241 insertInformation.setTime(insertTime);
242 eventBus.post(new SoneInsertingEvent(sone));
243 FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri(), insertInformation.generateManifestEntries(), "index.html");
244 eventBus.post(new SoneInsertedEvent(sone, System.currentTimeMillis() - insertTime));
245 /* at this point we might already be stopped. */
247 /* if so, bail out, don’t change anything. */
250 sone.setTime(insertTime);
251 sone.modify().setLatestEdition(finalUri.getEdition()).update();
252 core.touchConfiguration();
254 logger.log(Level.INFO, String.format("Inserted Sone “%s” at %s.", sone.getName(), finalUri));
255 } catch (SoneException se1) {
256 eventBus.post(new SoneInsertAbortedEvent(sone, se1));
257 logger.log(Level.WARNING, String.format("Could not insert Sone “%s”!", sone.getName()), se1);
259 insertInformation.freeBuckets();
260 sone.setStatus(SoneStatus.idle);
264 * reset modification counter if Sone has not been modified
265 * while it was inserted.
268 synchronized (sone) {
269 if (lastInsertedFingerprint.equals(sone.getFingerprint())) {
270 logger.log(Level.FINE, String.format("Sone “%s” was not modified further, resetting counter…", sone));
271 lastModificationTime = 0;
272 lastInsertFingerprint = lastInsertedFingerprint;
273 core.touchConfiguration();
279 } catch (Throwable t1) {
280 logger.log(Level.SEVERE, "SoneInserter threw an Exception!", t1);
286 * Container for information that are required to insert a Sone. This
287 * container merely exists to copy all relevant data without holding a lock
288 * on the {@link Sone} object for too long.
290 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
292 private class InsertInformation {
294 /** All properties of the Sone, copied for thread safety. */
295 private final Map<String, Object> soneProperties = new HashMap<String, Object>();
296 private final Set<Bucket> buckets = new HashSet<Bucket>();
299 * Creates a new insert information container.
304 public InsertInformation(Sone sone) {
305 soneProperties.put("id", sone.getId());
306 soneProperties.put("name", sone.getName());
307 soneProperties.put("time", sone.getTime());
308 soneProperties.put("requestUri", TO_FREENET_URI.apply(sone));
309 soneProperties.put("insertUri", TO_INSERT_URI.apply(sone));
310 soneProperties.put("profile", sone.getProfile());
311 soneProperties.put("posts", Ordering.from(Post.TIME_COMPARATOR).sortedCopy(sone.getPosts()));
312 soneProperties.put("replies", Ordering.from(Reply.TIME_COMPARATOR).reverse().sortedCopy(sone.getReplies()));
313 soneProperties.put("likedPostIds", new HashSet<String>(sone.getLikedPostIds()));
314 soneProperties.put("likedReplyIds", new HashSet<String>(sone.getLikedReplyIds()));
315 soneProperties.put("albums", FluentIterable.from(sone.getRootAlbum().getAlbums()).transformAndConcat(Album.FLATTENER).filter(NOT_EMPTY).toList());
323 * Returns the insert URI of the Sone.
325 * @return The insert URI of the Sone
327 public FreenetURI getInsertUri() {
328 return (FreenetURI) soneProperties.get("insertUri");
332 * Sets the time of the Sone at the time of the insert.
335 * The time of the Sone
337 public void setTime(long time) {
338 soneProperties.put("time", time);
346 * Generates all manifest entries required to insert this Sone.
348 * @return The manifest entries for the Sone insert
350 public HashMap<String, Object> generateManifestEntries() {
351 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
353 /* first, create an index.html. */
354 manifestEntries.put("index.html", createManifestElement("index.html", "text/html; charset=utf-8", "/templates/insert/index.html"));
356 /* now, store the sone. */
357 manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml"));
359 return manifestEntries;
362 public void freeBuckets() {
363 for (Bucket bucket : buckets) {
373 * Creates a new manifest element.
376 * The name of the file
378 * The content type of the file
379 * @param templateName
380 * The name of the template to render
381 * @return The manifest element
383 @SuppressWarnings("synthetic-access")
384 private ManifestElement createManifestElement(String name, String contentType, String templateName) {
385 InputStreamReader templateInputStreamReader = null;
388 templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset);
389 template = TemplateParser.parse(templateInputStreamReader);
390 } catch (TemplateException te1) {
391 logger.log(Level.SEVERE, String.format("Could not parse template “%s”!", templateName), te1);
394 Closer.close(templateInputStreamReader);
397 TemplateContext templateContext = templateContextFactory.createTemplateContext();
398 templateContext.set("core", core);
399 templateContext.set("currentSone", soneProperties);
400 templateContext.set("currentEdition", core.getUpdateChecker().getLatestEdition());
401 templateContext.set("version", SonePlugin.VERSION);
402 StringWriter writer = new StringWriter();
403 StringBucket bucket = null;
405 template.render(templateContext, writer);
406 bucket = new StringBucket(writer.toString(), utf8Charset);
407 return new ManifestElement(name, bucket, contentType, bucket.size());
408 } catch (TemplateException te1) {
409 logger.log(Level.SEVERE, String.format("Could not render template “%s”!", templateName), te1);
412 Closer.close(writer);