2 * Sone - SoneInserter.java - Copyright © 2010–2016 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 java.lang.String.format;
21 import static java.lang.System.currentTimeMillis;
22 import static java.util.logging.Logger.getLogger;
23 import static net.pterodactylus.sone.data.Album.NOT_EMPTY;
25 import java.io.Closeable;
26 import java.io.InputStream;
27 import java.io.InputStreamReader;
28 import java.io.StringWriter;
29 import java.nio.charset.Charset;
30 import java.util.HashMap;
31 import java.util.HashSet;
34 import java.util.concurrent.atomic.AtomicInteger;
35 import java.util.logging.Level;
36 import java.util.logging.Logger;
38 import net.pterodactylus.sone.core.SoneModificationDetector.LockableFingerprintProvider;
39 import net.pterodactylus.sone.core.event.InsertionDelayChangedEvent;
40 import net.pterodactylus.sone.core.event.SoneInsertAbortedEvent;
41 import net.pterodactylus.sone.core.event.SoneInsertedEvent;
42 import net.pterodactylus.sone.core.event.SoneInsertingEvent;
43 import net.pterodactylus.sone.data.Album;
44 import net.pterodactylus.sone.data.Post;
45 import net.pterodactylus.sone.data.Reply;
46 import net.pterodactylus.sone.data.Sone;
47 import net.pterodactylus.sone.data.Sone.SoneStatus;
48 import net.pterodactylus.sone.main.SonePlugin;
49 import net.pterodactylus.util.io.Closer;
50 import net.pterodactylus.util.service.AbstractService;
51 import net.pterodactylus.util.template.HtmlFilter;
52 import net.pterodactylus.util.template.ReflectionAccessor;
53 import net.pterodactylus.util.template.Template;
54 import net.pterodactylus.util.template.TemplateContext;
55 import net.pterodactylus.util.template.TemplateContextFactory;
56 import net.pterodactylus.util.template.TemplateException;
57 import net.pterodactylus.util.template.TemplateParser;
58 import net.pterodactylus.util.template.XmlFilter;
60 import com.google.common.annotations.VisibleForTesting;
61 import com.google.common.base.Charsets;
62 import com.google.common.base.Optional;
63 import com.google.common.collect.FluentIterable;
64 import com.google.common.collect.Ordering;
65 import com.google.common.eventbus.EventBus;
66 import com.google.common.eventbus.Subscribe;
68 import freenet.keys.FreenetURI;
69 import freenet.support.api.Bucket;
70 import freenet.support.api.ManifestElement;
71 import freenet.support.api.RandomAccessBucket;
72 import freenet.support.io.ArrayBucket;
75 * A Sone inserter is responsible for inserting a Sone if it has changed.
77 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
79 public class SoneInserter extends AbstractService {
82 private static final Logger logger = getLogger(SoneInserter.class.getName());
84 /** The insertion delay (in seconds). */
85 private static final AtomicInteger insertionDelay = new AtomicInteger(60);
87 /** The template factory used to create the templates. */
88 private static final TemplateContextFactory templateContextFactory = new TemplateContextFactory();
91 templateContextFactory.addAccessor(Object.class, new ReflectionAccessor());
92 templateContextFactory.addFilter("xml", new XmlFilter());
93 templateContextFactory.addFilter("html", new HtmlFilter());
96 /** The UTF-8 charset. */
97 private static final Charset utf8Charset = Charset.forName("UTF-8");
100 private final Core core;
102 /** The event bus. */
103 private final EventBus eventBus;
105 /** The Freenet interface. */
106 private final FreenetInterface freenetInterface;
108 private final SoneModificationDetector soneModificationDetector;
109 private final long delay;
110 private final String soneId;
113 * Creates a new Sone inserter.
119 * @param freenetInterface
120 * The freenet interface
122 * The ID of the Sone to insert
124 public SoneInserter(final Core core, EventBus eventBus, FreenetInterface freenetInterface, final String soneId) {
125 this(core, eventBus, freenetInterface, soneId, new SoneModificationDetector(new LockableFingerprintProvider() {
127 public boolean isLocked() {
128 final Optional<Sone> sone = core.getSone(soneId);
129 if (!sone.isPresent()) {
132 return core.isLocked(sone.get());
136 public String getFingerprint() {
137 final Optional<Sone> sone = core.getSone(soneId);
138 if (!sone.isPresent()) {
141 return sone.get().getFingerprint();
143 }, insertionDelay), 1000);
147 SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, String soneId, SoneModificationDetector soneModificationDetector, long delay) {
148 super("Sone Inserter for “" + soneId + "”", false);
150 this.eventBus = eventBus;
151 this.freenetInterface = freenetInterface;
152 this.soneId = soneId;
153 this.soneModificationDetector = soneModificationDetector;
162 static AtomicInteger getInsertionDelay() {
163 return insertionDelay;
167 * Changes the insertion delay, i.e. the time the Sone inserter waits after it
168 * has noticed a Sone modification before it starts the insert.
170 * @param insertionDelay
171 * The insertion delay (in seconds)
173 private static void setInsertionDelay(int insertionDelay) {
174 SoneInserter.insertionDelay.set(insertionDelay);
178 * Returns the fingerprint of the last insert.
180 * @return The fingerprint of the last insert
182 public String getLastInsertFingerprint() {
183 return soneModificationDetector.getLastInsertFingerprint();
187 * Sets the fingerprint of the last insert.
189 * @param lastInsertFingerprint
190 * The fingerprint of the last insert
192 public void setLastInsertFingerprint(String lastInsertFingerprint) {
193 soneModificationDetector.setFingerprint(lastInsertFingerprint);
197 * Returns whether the Sone inserter has detected a modification of the
200 * @return {@code true} if the Sone has been modified, {@code false}
203 public boolean isModified() {
204 return soneModificationDetector.isModified();
215 protected void serviceRun() {
216 while (!shouldStop()) {
218 /* check every second. */
221 if (soneModificationDetector.isEligibleForInsert()) {
222 Optional<Sone> soneOptional = core.getSone(soneId);
223 if (!soneOptional.isPresent()) {
224 logger.log(Level.WARNING, format("Sone %s has disappeared, exiting inserter.", soneId));
227 Sone sone = soneOptional.get();
228 InsertInformation insertInformation = new InsertInformation(sone);
229 logger.log(Level.INFO, String.format("Inserting Sone “%s”…", sone.getName()));
231 boolean success = false;
233 sone.setStatus(SoneStatus.inserting);
234 long insertTime = currentTimeMillis();
235 eventBus.post(new SoneInsertingEvent(sone));
236 FreenetURI finalUri = freenetInterface.insertDirectory(sone.getInsertUri(), insertInformation.generateManifestEntries(), "index.html");
237 eventBus.post(new SoneInsertedEvent(sone, currentTimeMillis() - insertTime, insertInformation.getFingerprint()));
238 /* at this point we might already be stopped. */
240 /* if so, bail out, don’t change anything. */
243 sone.setTime(insertTime);
244 sone.setLatestEdition(finalUri.getEdition());
245 core.touchConfiguration();
247 logger.log(Level.INFO, String.format("Inserted Sone “%s” at %s.", sone.getName(), finalUri));
248 } catch (SoneException se1) {
249 eventBus.post(new SoneInsertAbortedEvent(sone, se1));
250 logger.log(Level.WARNING, String.format("Could not insert Sone “%s”!", sone.getName()), se1);
252 insertInformation.close();
253 sone.setStatus(SoneStatus.idle);
257 * reset modification counter if Sone has not been modified
258 * while it was inserted.
261 synchronized (sone) {
262 if (insertInformation.getFingerprint().equals(sone.getFingerprint())) {
263 logger.log(Level.FINE, String.format("Sone “%s” was not modified further, resetting counter…", sone));
264 soneModificationDetector.setFingerprint(insertInformation.getFingerprint());
265 core.touchConfiguration();
270 } catch (Throwable t1) {
271 logger.log(Level.SEVERE, "SoneInserter threw an Exception!", t1);
277 public void insertionDelayChanged(InsertionDelayChangedEvent insertionDelayChangedEvent) {
278 setInsertionDelay(insertionDelayChangedEvent.getInsertionDelay());
282 * Container for information that are required to insert a Sone. This
283 * container merely exists to copy all relevant data without holding a lock
284 * on the {@link Sone} object for too long.
286 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
289 class InsertInformation implements Closeable {
291 /** All properties of the Sone, copied for thread safety. */
292 private final Map<String, Object> soneProperties = new HashMap<String, Object>();
293 private final String fingerprint;
294 private final ManifestCreator manifestCreator;
297 * Creates a new insert information container.
302 public InsertInformation(Sone sone) {
303 this.fingerprint = sone.getFingerprint();
304 Map<String, Object> soneProperties = new HashMap<String, Object>();
305 soneProperties.put("id", sone.getId());
306 soneProperties.put("name", sone.getName());
307 soneProperties.put("time", currentTimeMillis());
308 soneProperties.put("requestUri", sone.getRequestUri());
309 soneProperties.put("profile", sone.getProfile());
310 soneProperties.put("posts", Ordering.from(Post.TIME_COMPARATOR).sortedCopy(sone.getPosts()));
311 soneProperties.put("replies", Ordering.from(Reply.TIME_COMPARATOR).reverse().sortedCopy(sone.getReplies()));
312 soneProperties.put("likedPostIds", new HashSet<String>(sone.getLikedPostIds()));
313 soneProperties.put("likedReplyIds", new HashSet<String>(sone.getLikedReplyIds()));
314 soneProperties.put("albums", FluentIterable.from(sone.getRootAlbum().getAlbums()).transformAndConcat(Album.FLATTENER).filter(NOT_EMPTY).toList());
315 manifestCreator = new ManifestCreator(core, soneProperties);
323 String getFingerprint() {
332 * Generates all manifest entries required to insert this Sone.
334 * @return The manifest entries for the Sone insert
336 public HashMap<String, Object> generateManifestEntries() {
337 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
339 /* first, create an index.html. */
340 manifestEntries.put("index.html", manifestCreator.createManifestElement(
341 "index.html", "text/html; charset=utf-8",
342 "/templates/insert/index.html"));
344 /* now, store the sone. */
345 manifestEntries.put("sone.xml", manifestCreator.createManifestElement(
346 "sone.xml", "text/xml; charset=utf-8",
347 "/templates/insert/sone.xml"));
349 return manifestEntries;
353 public void close() {
354 manifestCreator.close();
360 * Creates manifest elements for an insert by rendering a template.
362 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
365 static class ManifestCreator implements Closeable {
367 private final Core core;
368 private final Map<String, Object> soneProperties;
369 private final Set<Bucket> buckets = new HashSet<Bucket>();
371 ManifestCreator(Core core, Map<String, Object> soneProperties) {
373 this.soneProperties = soneProperties;
376 public ManifestElement createManifestElement(String name, String contentType, String templateName) {
377 InputStreamReader templateInputStreamReader = null;
378 InputStream templateInputStream = null;
381 templateInputStream = getClass().getResourceAsStream(templateName);
382 templateInputStreamReader = new InputStreamReader(templateInputStream, utf8Charset);
383 template = TemplateParser.parse(templateInputStreamReader);
384 } catch (TemplateException te1) {
385 logger.log(Level.SEVERE, String.format("Could not parse template “%s”!", templateName), te1);
388 Closer.close(templateInputStreamReader);
389 Closer.close(templateInputStream);
392 TemplateContext templateContext = templateContextFactory.createTemplateContext();
393 templateContext.set("core", core);
394 templateContext.set("currentSone", soneProperties);
395 templateContext.set("currentEdition", core.getUpdateChecker().getLatestEdition());
396 templateContext.set("version", SonePlugin.getPluginVersion());
397 StringWriter writer = new StringWriter();
399 template.render(templateContext, writer);
400 RandomAccessBucket bucket = new ArrayBucket(writer.toString().getBytes(Charsets.UTF_8));
402 return new ManifestElement(name, bucket, contentType, bucket.size());
403 } catch (TemplateException te1) {
404 logger.log(Level.SEVERE, String.format("Could not render template “%s”!", templateName), te1);
407 Closer.close(writer);
411 public void close() {
412 for (Bucket bucket : buckets) {