2 * Sone - SoneInserter.java - Copyright Β© 2010β2020 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;
27 import java.nio.charset.Charset;
28 import java.util.HashMap;
29 import java.util.HashSet;
32 import java.util.concurrent.atomic.AtomicInteger;
33 import java.util.logging.Level;
34 import java.util.logging.Logger;
36 import com.codahale.metrics.*;
37 import com.google.common.base.*;
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.service.AbstractService;
50 import net.pterodactylus.util.template.HtmlFilter;
51 import net.pterodactylus.util.template.ReflectionAccessor;
52 import net.pterodactylus.util.template.Template;
53 import net.pterodactylus.util.template.TemplateContext;
54 import net.pterodactylus.util.template.TemplateContextFactory;
55 import net.pterodactylus.util.template.TemplateException;
56 import net.pterodactylus.util.template.TemplateParser;
57 import net.pterodactylus.util.template.XmlFilter;
59 import com.google.common.annotations.VisibleForTesting;
60 import com.google.common.collect.FluentIterable;
61 import com.google.common.collect.Ordering;
62 import com.google.common.eventbus.EventBus;
63 import com.google.common.eventbus.Subscribe;
65 import freenet.keys.FreenetURI;
66 import freenet.support.api.Bucket;
67 import freenet.support.api.ManifestElement;
68 import freenet.support.api.RandomAccessBucket;
69 import freenet.support.io.ArrayBucket;
72 * A Sone inserter is responsible for inserting a Sone if it has changed.
74 public class SoneInserter extends AbstractService {
77 private static final Logger logger = getLogger(SoneInserter.class.getName());
79 /** The insertion delay (in seconds). */
80 private static final AtomicInteger insertionDelay = new AtomicInteger(60);
82 /** The template factory used to create the templates. */
83 private static final TemplateContextFactory templateContextFactory = new TemplateContextFactory();
86 templateContextFactory.addAccessor(Object.class, new ReflectionAccessor());
87 templateContextFactory.addFilter("xml", new XmlFilter());
88 templateContextFactory.addFilter("html", new HtmlFilter());
91 /** The UTF-8 charset. */
92 private static final Charset utf8Charset = Charset.forName("UTF-8");
95 private final Core core;
98 private final EventBus eventBus;
100 /** The Freenet interface. */
101 private final FreenetInterface freenetInterface;
103 private final SoneModificationDetector soneModificationDetector;
104 private final SoneUriCreator soneUriCreator;
105 private final long delay;
106 private final String soneId;
107 private final Histogram soneInsertDurationHistogram;
108 private final Meter soneInsertErrorMeter;
111 * Creates a new Sone inserter.
117 * @param freenetInterface
118 * The freenet interface
120 * The ID of the Sone to insert
122 public SoneInserter(final Core core, EventBus eventBus, FreenetInterface freenetInterface, MetricRegistry metricRegistry, SoneUriCreator soneUriCreator, final String soneId) {
123 this(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, soneId, new SoneModificationDetector(new LockableFingerprintProvider() {
125 public boolean isLocked() {
126 Sone sone = core.getSone(soneId);
130 return core.isLocked(sone);
134 public String getFingerprint() {
135 Sone sone = core.getSone(soneId);
139 return sone.getFingerprint();
141 }, insertionDelay), 1000);
145 SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, MetricRegistry metricRegistry, SoneUriCreator soneUriCreator, String soneId, SoneModificationDetector soneModificationDetector, long delay) {
146 super("Sone Inserter for β" + soneId + "β", false);
148 this.eventBus = eventBus;
149 this.freenetInterface = freenetInterface;
150 this.soneInsertDurationHistogram = metricRegistry.histogram("sone.insert.duration", () -> new Histogram(new ExponentiallyDecayingReservoir(3000, 0)));
151 this.soneInsertErrorMeter = metricRegistry.meter("sone.insert.errors");
152 this.soneUriCreator = soneUriCreator;
153 this.soneId = soneId;
154 this.soneModificationDetector = soneModificationDetector;
163 static AtomicInteger getInsertionDelay() {
164 return insertionDelay;
168 * Changes the insertion delay, i.e. the time the Sone inserter waits after it
169 * has noticed a Sone modification before it starts the insert.
171 * @param insertionDelay
172 * The insertion delay (in seconds)
174 private static void setInsertionDelay(int insertionDelay) {
175 SoneInserter.insertionDelay.set(insertionDelay);
179 * Returns the fingerprint of the last insert.
181 * @return The fingerprint of the last insert
183 public String getLastInsertFingerprint() {
184 return soneModificationDetector.getLastInsertFingerprint();
188 * Sets the fingerprint of the last insert.
190 * @param lastInsertFingerprint
191 * The fingerprint of the last insert
193 public void setLastInsertFingerprint(String lastInsertFingerprint) {
194 soneModificationDetector.setFingerprint(lastInsertFingerprint);
198 * Returns whether the Sone inserter has detected a modification of the
201 * @return {@code true} if the Sone has been modified, {@code false}
204 public boolean isModified() {
205 return soneModificationDetector.isModified();
216 protected void serviceRun() {
217 while (!shouldStop()) {
219 /* check every second. */
222 if (soneModificationDetector.isEligibleForInsert()) {
223 Sone sone = core.getSone(soneId);
225 logger.log(Level.WARNING, format("Sone %s has disappeared, exiting inserter.", soneId));
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 Stopwatch stopwatch = Stopwatch.createStarted();
237 FreenetURI finalUri = freenetInterface.insertDirectory(soneUriCreator.getInsertUri(sone), insertInformation.generateManifestEntries(), "index.html");
239 soneInsertDurationHistogram.update(stopwatch.elapsed(MICROSECONDS));
240 eventBus.post(new SoneInsertedEvent(sone, stopwatch.elapsed(MILLISECONDS), insertInformation.getFingerprint()));
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 soneInsertErrorMeter.mark();
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("profile", sone.getProfile());
311 soneProperties.put("posts", Ordering.from(Post.NEWEST_FIRST).sortedCopy(sone.getPosts()));
312 soneProperties.put("replies", Ordering.from(Reply.TIME_COMPARATOR).reverse().sortedCopy(sone.getReplies()));
313 soneProperties.put("likedPostIds", new HashSet<>(sone.getLikedPostIds()));
314 soneProperties.put("likedReplyIds", new HashSet<>(sone.getLikedReplyIds()));
315 soneProperties.put("albums", FluentIterable.from(sone.getRootAlbum().getAlbums()).transformAndConcat(Album.FLATTENER).filter(NOT_EMPTY).toList());
316 manifestCreator = new ManifestCreator(core, soneProperties);
324 String getFingerprint() {
333 * Generates all manifest entries required to insert this Sone.
335 * @return The manifest entries for the Sone insert
337 public HashMap<String, Object> generateManifestEntries() {
338 HashMap<String, Object> manifestEntries = new HashMap<>();
340 /* first, create an index.html. */
341 manifestEntries.put("index.html", manifestCreator.createManifestElement(
342 "index.html", "text/html; charset=utf-8",
343 "/templates/insert/index.html"));
345 /* now, store the sone. */
346 manifestEntries.put("sone.xml", manifestCreator.createManifestElement(
347 "sone.xml", "text/xml; charset=utf-8",
348 "/templates/insert/sone.xml"));
350 return manifestEntries;
354 public void close() {
355 manifestCreator.close();
361 * Creates manifest elements for an insert by rendering a template.
364 static class ManifestCreator implements Closeable {
366 private final Core core;
367 private final Map<String, Object> soneProperties;
368 private final Set<Bucket> buckets = new HashSet<>();
370 ManifestCreator(Core core, Map<String, Object> soneProperties) {
372 this.soneProperties = soneProperties;
375 public ManifestElement createManifestElement(String name, String contentType, String templateName) {
377 try (InputStream templateInputStream = getClass().getResourceAsStream(templateName);
378 InputStreamReader templateInputStreamReader = new InputStreamReader(templateInputStream, utf8Charset)) {
379 template = TemplateParser.parse(templateInputStreamReader);
380 } catch (IOException | TemplateException e1) {
381 logger.log(Level.SEVERE, String.format("Could not parse template β%sβ!", templateName), e1);
385 TemplateContext templateContext = templateContextFactory.createTemplateContext();
386 templateContext.set("core", core);
387 templateContext.set("currentSone", soneProperties);
388 templateContext.set("currentEdition", core.getUpdateChecker().getLatestEdition());
389 templateContext.set("version", SonePlugin.getPluginVersion());
390 try (StringWriter writer = new StringWriter()) {
391 template.render(templateContext, writer);
392 RandomAccessBucket bucket = new ArrayBucket(writer.toString().getBytes(Charsets.UTF_8));
394 return new ManifestElement(name, bucket, contentType, bucket.size());
395 } catch (IOException | TemplateException e1) {
396 logger.log(Level.SEVERE, String.format("Could not render template β%sβ!", templateName), e1);
401 public void close() {
402 for (Bucket bucket : buckets) {