2 * Sone - SoneInserter.java - Copyright © 2010–2019 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.concurrent.TimeUnit.*;
23 import static java.util.logging.Logger.getLogger;
24 import static net.pterodactylus.sone.data.Album.NOT_EMPTY;
26 import java.io.Closeable;
27 import java.io.InputStream;
28 import java.io.InputStreamReader;
29 import java.io.StringWriter;
30 import java.nio.charset.Charset;
31 import java.util.HashMap;
32 import java.util.HashSet;
35 import java.util.concurrent.*;
36 import java.util.concurrent.atomic.AtomicInteger;
37 import java.util.logging.Level;
38 import java.util.logging.Logger;
40 import com.codahale.metrics.*;
41 import com.google.common.base.*;
42 import net.pterodactylus.sone.core.SoneModificationDetector.LockableFingerprintProvider;
43 import net.pterodactylus.sone.core.event.InsertionDelayChangedEvent;
44 import net.pterodactylus.sone.core.event.SoneInsertAbortedEvent;
45 import net.pterodactylus.sone.core.event.SoneInsertedEvent;
46 import net.pterodactylus.sone.core.event.SoneInsertingEvent;
47 import net.pterodactylus.sone.data.Album;
48 import net.pterodactylus.sone.data.Post;
49 import net.pterodactylus.sone.data.Reply;
50 import net.pterodactylus.sone.data.Sone;
51 import net.pterodactylus.sone.data.Sone.SoneStatus;
52 import net.pterodactylus.sone.main.SonePlugin;
53 import net.pterodactylus.util.io.Closer;
54 import net.pterodactylus.util.service.AbstractService;
55 import net.pterodactylus.util.template.HtmlFilter;
56 import net.pterodactylus.util.template.ReflectionAccessor;
57 import net.pterodactylus.util.template.Template;
58 import net.pterodactylus.util.template.TemplateContext;
59 import net.pterodactylus.util.template.TemplateContextFactory;
60 import net.pterodactylus.util.template.TemplateException;
61 import net.pterodactylus.util.template.TemplateParser;
62 import net.pterodactylus.util.template.XmlFilter;
64 import com.google.common.annotations.VisibleForTesting;
65 import com.google.common.collect.FluentIterable;
66 import com.google.common.collect.Ordering;
67 import com.google.common.eventbus.EventBus;
68 import com.google.common.eventbus.Subscribe;
70 import freenet.keys.FreenetURI;
71 import freenet.support.api.Bucket;
72 import freenet.support.api.ManifestElement;
73 import freenet.support.api.RandomAccessBucket;
74 import freenet.support.io.ArrayBucket;
77 * A Sone inserter is responsible for inserting a Sone if it has changed.
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;
111 private final Histogram soneInsertDurationHistogram;
114 * Creates a new Sone inserter.
120 * @param freenetInterface
121 * The freenet interface
123 * The ID of the Sone to insert
125 public SoneInserter(final Core core, EventBus eventBus, FreenetInterface freenetInterface, MetricRegistry metricRegistry, final String soneId) {
126 this(core, eventBus, freenetInterface, metricRegistry, soneId, new SoneModificationDetector(new LockableFingerprintProvider() {
128 public boolean isLocked() {
129 Sone sone = core.getSone(soneId);
133 return core.isLocked(sone);
137 public String getFingerprint() {
138 Sone sone = core.getSone(soneId);
142 return sone.getFingerprint();
144 }, insertionDelay), 1000);
148 SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, MetricRegistry metricRegistry, String soneId, SoneModificationDetector soneModificationDetector, long delay) {
149 super("Sone Inserter for “" + soneId + "”", false);
151 this.eventBus = eventBus;
152 this.freenetInterface = freenetInterface;
153 this.soneInsertDurationHistogram = metricRegistry.histogram("sone.insert.duration");
154 this.soneId = soneId;
155 this.soneModificationDetector = soneModificationDetector;
164 static AtomicInteger getInsertionDelay() {
165 return insertionDelay;
169 * Changes the insertion delay, i.e. the time the Sone inserter waits after it
170 * has noticed a Sone modification before it starts the insert.
172 * @param insertionDelay
173 * The insertion delay (in seconds)
175 private static void setInsertionDelay(int insertionDelay) {
176 SoneInserter.insertionDelay.set(insertionDelay);
180 * Returns the fingerprint of the last insert.
182 * @return The fingerprint of the last insert
184 public String getLastInsertFingerprint() {
185 return soneModificationDetector.getLastInsertFingerprint();
189 * Sets the fingerprint of the last insert.
191 * @param lastInsertFingerprint
192 * The fingerprint of the last insert
194 public void setLastInsertFingerprint(String lastInsertFingerprint) {
195 soneModificationDetector.setFingerprint(lastInsertFingerprint);
199 * Returns whether the Sone inserter has detected a modification of the
202 * @return {@code true} if the Sone has been modified, {@code false}
205 public boolean isModified() {
206 return soneModificationDetector.isModified();
217 protected void serviceRun() {
218 while (!shouldStop()) {
220 /* check every second. */
223 if (soneModificationDetector.isEligibleForInsert()) {
224 Sone sone = core.getSone(soneId);
226 logger.log(Level.WARNING, format("Sone %s has disappeared, exiting inserter.", soneId));
229 InsertInformation insertInformation = new InsertInformation(sone);
230 logger.log(Level.INFO, String.format("Inserting Sone “%s”…", sone.getName()));
232 boolean success = false;
234 sone.setStatus(SoneStatus.inserting);
235 long insertTime = currentTimeMillis();
236 eventBus.post(new SoneInsertingEvent(sone));
237 Stopwatch stopwatch = Stopwatch.createStarted();
238 FreenetURI finalUri = freenetInterface.insertDirectory(sone.getInsertUri(), insertInformation.generateManifestEntries(), "index.html");
240 soneInsertDurationHistogram.update(stopwatch.elapsed(MICROSECONDS));
241 eventBus.post(new SoneInsertedEvent(sone, stopwatch.elapsed(MILLISECONDS), insertInformation.getFingerprint()));
242 /* at this point we might already be stopped. */
244 /* if so, bail out, don’t change anything. */
247 sone.setTime(insertTime);
248 sone.setLatestEdition(finalUri.getEdition());
249 core.touchConfiguration();
251 logger.log(Level.INFO, String.format("Inserted Sone “%s” at %s.", sone.getName(), finalUri));
252 } catch (SoneException se1) {
253 eventBus.post(new SoneInsertAbortedEvent(sone, se1));
254 logger.log(Level.WARNING, String.format("Could not insert Sone “%s”!", sone.getName()), se1);
256 insertInformation.close();
257 sone.setStatus(SoneStatus.idle);
261 * reset modification counter if Sone has not been modified
262 * while it was inserted.
265 synchronized (sone) {
266 if (insertInformation.getFingerprint().equals(sone.getFingerprint())) {
267 logger.log(Level.FINE, String.format("Sone “%s” was not modified further, resetting counter…", sone));
268 soneModificationDetector.setFingerprint(insertInformation.getFingerprint());
269 core.touchConfiguration();
274 } catch (Throwable t1) {
275 logger.log(Level.SEVERE, "SoneInserter threw an Exception!", t1);
281 public void insertionDelayChanged(InsertionDelayChangedEvent insertionDelayChangedEvent) {
282 setInsertionDelay(insertionDelayChangedEvent.getInsertionDelay());
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.
291 class InsertInformation implements Closeable {
293 /** All properties of the Sone, copied for thread safety. */
294 private final Map<String, Object> soneProperties = new HashMap<>();
295 private final String fingerprint;
296 private final ManifestCreator manifestCreator;
299 * Creates a new insert information container.
304 public InsertInformation(Sone sone) {
305 this.fingerprint = sone.getFingerprint();
306 Map<String, Object> soneProperties = new HashMap<>();
307 soneProperties.put("id", sone.getId());
308 soneProperties.put("name", sone.getName());
309 soneProperties.put("time", currentTimeMillis());
310 soneProperties.put("requestUri", sone.getRequestUri());
311 soneProperties.put("profile", sone.getProfile());
312 soneProperties.put("posts", Ordering.from(Post.NEWEST_FIRST).sortedCopy(sone.getPosts()));
313 soneProperties.put("replies", Ordering.from(Reply.TIME_COMPARATOR).reverse().sortedCopy(sone.getReplies()));
314 soneProperties.put("likedPostIds", new HashSet<>(sone.getLikedPostIds()));
315 soneProperties.put("likedReplyIds", new HashSet<>(sone.getLikedReplyIds()));
316 soneProperties.put("albums", FluentIterable.from(sone.getRootAlbum().getAlbums()).transformAndConcat(Album.FLATTENER).filter(NOT_EMPTY).toList());
317 manifestCreator = new ManifestCreator(core, soneProperties);
325 String getFingerprint() {
334 * Generates all manifest entries required to insert this Sone.
336 * @return The manifest entries for the Sone insert
338 public HashMap<String, Object> generateManifestEntries() {
339 HashMap<String, Object> manifestEntries = new HashMap<>();
341 /* first, create an index.html. */
342 manifestEntries.put("index.html", manifestCreator.createManifestElement(
343 "index.html", "text/html; charset=utf-8",
344 "/templates/insert/index.html"));
346 /* now, store the sone. */
347 manifestEntries.put("sone.xml", manifestCreator.createManifestElement(
348 "sone.xml", "text/xml; charset=utf-8",
349 "/templates/insert/sone.xml"));
351 return manifestEntries;
355 public void close() {
356 manifestCreator.close();
362 * Creates manifest elements for an insert by rendering a template.
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<>();
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) {