/*
- * Sone - SoneInserter.java - Copyright © 2010 David Roden
+ * Sone - SoneInserter.java - Copyright © 2010–2020 David Roden
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
package net.pterodactylus.sone.core;
-import java.io.InputStreamReader;
-import java.io.StringWriter;
+import static java.lang.String.format;
+import static java.lang.System.currentTimeMillis;
+import static java.util.concurrent.TimeUnit.*;
+import static java.util.logging.Logger.getLogger;
+import static java.util.stream.Collectors.toList;
+import static net.pterodactylus.sone.data.PostKt.newestPostFirst;
+import static net.pterodactylus.sone.data.ReplyKt.newestReplyFirst;
+
+import java.io.*;
import java.nio.charset.Charset;
-import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.atomic.AtomicInteger;
import java.util.logging.Level;
import java.util.logging.Logger;
-import net.pterodactylus.sone.core.Core.SoneStatus;
-import net.pterodactylus.sone.data.Post;
-import net.pterodactylus.sone.data.Reply;
+import com.codahale.metrics.*;
+import com.google.common.base.*;
+import net.pterodactylus.sone.core.SoneModificationDetector.LockableFingerprintProvider;
+import net.pterodactylus.sone.core.event.InsertionDelayChangedEvent;
+import net.pterodactylus.sone.core.event.SoneInsertAbortedEvent;
+import net.pterodactylus.sone.core.event.SoneInsertedEvent;
+import net.pterodactylus.sone.core.event.SoneInsertingEvent;
+import net.pterodactylus.sone.data.AlbumKt;
import net.pterodactylus.sone.data.Sone;
-import net.pterodactylus.sone.freenet.StringBucket;
+import net.pterodactylus.sone.data.Sone.SoneStatus;
+import net.pterodactylus.sone.data.SoneKt;
import net.pterodactylus.sone.main.SonePlugin;
-import net.pterodactylus.util.collection.ListBuilder;
-import net.pterodactylus.util.collection.ReverseComparator;
-import net.pterodactylus.util.io.Closer;
-import net.pterodactylus.util.logging.Logging;
import net.pterodactylus.util.service.AbstractService;
import net.pterodactylus.util.template.HtmlFilter;
import net.pterodactylus.util.template.ReflectionAccessor;
import net.pterodactylus.util.template.TemplateException;
import net.pterodactylus.util.template.TemplateParser;
import net.pterodactylus.util.template.XmlFilter;
-import freenet.client.async.ManifestElement;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.collect.Ordering;
+import com.google.common.eventbus.EventBus;
+import com.google.common.eventbus.Subscribe;
+
import freenet.keys.FreenetURI;
+import freenet.support.api.Bucket;
+import freenet.support.api.ManifestElement;
+import freenet.support.api.RandomAccessBucket;
+import freenet.support.io.ArrayBucket;
/**
* A Sone inserter is responsible for inserting a Sone if it has changed.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public class SoneInserter extends AbstractService {
/** The logger. */
- private static final Logger logger = Logging.getLogger(SoneInserter.class);
+ private static final Logger logger = getLogger(SoneInserter.class.getName());
/** The insertion delay (in seconds). */
- private static volatile int insertionDelay = 60;
+ private static final AtomicInteger insertionDelay = new AtomicInteger(60);
/** The template factory used to create the templates. */
private static final TemplateContextFactory templateContextFactory = new TemplateContextFactory();
/** The core. */
private final Core core;
+ /** The event bus. */
+ private final EventBus eventBus;
+
/** The Freenet interface. */
private final FreenetInterface freenetInterface;
- /** The Sone to insert. */
- private final Sone sone;
-
- /** The insert listener manager. */
- private SoneInsertListenerManager soneInsertListenerManager;
-
- /** Whether a modification has been detected. */
- private volatile boolean modified = false;
-
- /** The fingerprint of the last insert. */
- private volatile String lastInsertFingerprint;
+ private final SoneModificationDetector soneModificationDetector;
+ private final SoneUriCreator soneUriCreator;
+ private final long delay;
+ private final String soneId;
+ private final Histogram soneInsertDurationHistogram;
+ private final Meter soneInsertErrorMeter;
/**
* Creates a new Sone inserter.
*
* @param core
* The core
+ * @param eventBus
+ * The event bus
* @param freenetInterface
* The freenet interface
- * @param sone
- * The Sone to insert
+ * @param soneId
+ * The ID of the Sone to insert
*/
- public SoneInserter(Core core, FreenetInterface freenetInterface, Sone sone) {
- super("Sone Inserter for “" + sone.getName() + "”", false);
- this.core = core;
- this.freenetInterface = freenetInterface;
- this.sone = sone;
- this.soneInsertListenerManager = new SoneInsertListenerManager(sone);
- }
-
- //
- // LISTENER MANAGEMENT
- //
+ public SoneInserter(final Core core, EventBus eventBus, FreenetInterface freenetInterface, MetricRegistry metricRegistry, SoneUriCreator soneUriCreator, final String soneId) {
+ this(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, soneId, new SoneModificationDetector(new LockableFingerprintProvider() {
+ @Override
+ public boolean isLocked() {
+ Sone sone = core.getSone(soneId);
+ if (sone == null) {
+ return false;
+ }
+ return core.isLocked(sone);
+ }
- /**
- * Adds a listener for Sone insert events.
- *
- * @param soneInsertListener
- * The Sone insert listener
- */
- public void addSoneInsertListener(SoneInsertListener soneInsertListener) {
- soneInsertListenerManager.addListener(soneInsertListener);
+ @Override
+ public String getFingerprint() {
+ Sone sone = core.getSone(soneId);
+ if (sone == null) {
+ return null;
+ }
+ return sone.getFingerprint();
+ }
+ }, insertionDelay), 1000);
}
- /**
- * Removes a listener for Sone insert events.
- *
- * @param soneInsertListener
- * The Sone insert listener
- */
- public void removeSoneInsertListener(SoneInsertListener soneInsertListener) {
- soneInsertListenerManager.removeListener(soneInsertListener);
+ @VisibleForTesting
+ SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, MetricRegistry metricRegistry, SoneUriCreator soneUriCreator, String soneId, SoneModificationDetector soneModificationDetector, long delay) {
+ super("Sone Inserter for “" + soneId + "”", false);
+ this.core = core;
+ this.eventBus = eventBus;
+ this.freenetInterface = freenetInterface;
+ this.soneInsertDurationHistogram = metricRegistry.histogram("sone.insert.duration", () -> new Histogram(new ExponentiallyDecayingReservoir(3000, 0)));
+ this.soneInsertErrorMeter = metricRegistry.meter("sone.insert.errors");
+ this.soneUriCreator = soneUriCreator;
+ this.soneId = soneId;
+ this.soneModificationDetector = soneModificationDetector;
+ this.delay = delay;
}
//
// ACCESSORS
//
+ @VisibleForTesting
+ static AtomicInteger getInsertionDelay() {
+ return insertionDelay;
+ }
+
/**
- * Changes the insertion delay, i.e. the time the Sone inserter waits after
- * it has noticed a Sone modification before it starts the insert.
+ * Changes the insertion delay, i.e. the time the Sone inserter waits after it
+ * has noticed a Sone modification before it starts the insert.
*
* @param insertionDelay
* The insertion delay (in seconds)
*/
- public static void setInsertionDelay(int insertionDelay) {
- SoneInserter.insertionDelay = insertionDelay;
+ private static void setInsertionDelay(int insertionDelay) {
+ SoneInserter.insertionDelay.set(insertionDelay);
}
/**
* @return The fingerprint of the last insert
*/
public String getLastInsertFingerprint() {
- return lastInsertFingerprint;
+ return soneModificationDetector.getLastInsertFingerprint();
}
/**
* The fingerprint of the last insert
*/
public void setLastInsertFingerprint(String lastInsertFingerprint) {
- this.lastInsertFingerprint = lastInsertFingerprint;
+ soneModificationDetector.setFingerprint(lastInsertFingerprint);
}
/**
* otherwise
*/
public boolean isModified() {
- return modified;
+ return soneModificationDetector.isModified();
}
//
*/
@Override
protected void serviceRun() {
- long lastModificationTime = 0;
- String lastFingerprint = "";
- while (!shouldStop()) { try {
- /* check every seconds. */
- sleep(1000);
-
- /* don’t insert locked Sones. */
- if (core.isLocked(sone)) {
- /* trigger redetection when the Sone is unlocked. */
- synchronized (sone) {
- modified = !sone.getFingerprint().equals(lastInsertFingerprint);
- }
- lastFingerprint = "";
- lastModificationTime = 0;
- continue;
- }
-
- InsertInformation insertInformation = null;
- synchronized (sone) {
- String fingerprint = sone.getFingerprint();
- if (!fingerprint.equals(lastFingerprint)) {
- if (fingerprint.equals(lastInsertFingerprint)) {
- modified = false;
- lastModificationTime = 0;
- logger.log(Level.FINE, "Sone %s has been reverted to last insert state.", sone);
- } else {
- lastModificationTime = System.currentTimeMillis();
- modified = true;
- logger.log(Level.FINE, "Sone %s has been modified, waiting %d seconds before inserting.", new Object[] { sone.getName(), insertionDelay });
+ while (!shouldStop()) {
+ try {
+ /* check every second. */
+ sleep(delay);
+
+ if (soneModificationDetector.isEligibleForInsert()) {
+ Sone sone = core.getSone(soneId);
+ if (sone == null) {
+ logger.log(Level.WARNING, format("Sone %s has disappeared, exiting inserter.", soneId));
+ return;
}
- lastFingerprint = fingerprint;
- }
- if (modified && (lastModificationTime > 0) && ((System.currentTimeMillis() - lastModificationTime) > (insertionDelay * 1000))) {
- lastInsertFingerprint = fingerprint;
- insertInformation = new InsertInformation(sone);
- }
- }
-
- if (insertInformation != null) {
- logger.log(Level.INFO, "Inserting Sone “%s”…", new Object[] { sone.getName() });
-
- boolean success = false;
- try {
- core.setSoneStatus(sone, SoneStatus.inserting);
- long insertTime = System.currentTimeMillis();
- insertInformation.setTime(insertTime);
- soneInsertListenerManager.fireInsertStarted();
- FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri(), insertInformation.generateManifestEntries(), "index.html");
- soneInsertListenerManager.fireInsertFinished(System.currentTimeMillis() - insertTime);
- /* at this point we might already be stopped. */
- if (shouldStop()) {
- /* if so, bail out, don’t change anything. */
- break;
+ InsertInformation insertInformation = new InsertInformation(sone);
+ logger.log(Level.INFO, String.format("Inserting Sone “%s”…", sone.getName()));
+
+ boolean success = false;
+ try {
+ sone.setStatus(SoneStatus.inserting);
+ long insertTime = currentTimeMillis();
+ eventBus.post(new SoneInsertingEvent(sone));
+ Stopwatch stopwatch = Stopwatch.createStarted();
+ FreenetURI finalUri = freenetInterface.insertDirectory(soneUriCreator.getInsertUri(sone), insertInformation.generateManifestEntries(), "index.html");
+ stopwatch.stop();
+ soneInsertDurationHistogram.update(stopwatch.elapsed(MICROSECONDS));
+ eventBus.post(new SoneInsertedEvent(sone, stopwatch.elapsed(MILLISECONDS), insertInformation.getFingerprint()));
+ /* at this point we might already be stopped. */
+ if (shouldStop()) {
+ /* if so, bail out, don’t change anything. */
+ break;
+ }
+ sone.setTime(insertTime);
+ sone.setLatestEdition(finalUri.getEdition());
+ core.touchConfiguration();
+ success = true;
+ logger.log(Level.INFO, String.format("Inserted Sone “%s” at %s.", sone.getName(), finalUri));
+ } catch (SoneException se1) {
+ soneInsertErrorMeter.mark();
+ eventBus.post(new SoneInsertAbortedEvent(sone, se1));
+ logger.log(Level.WARNING, String.format("Could not insert Sone “%s”!", sone.getName()), se1);
+ } finally {
+ insertInformation.close();
+ sone.setStatus(SoneStatus.idle);
}
- sone.setTime(insertTime);
- sone.setLatestEdition(finalUri.getEdition());
- core.touchConfiguration();
- success = true;
- logger.log(Level.INFO, "Inserted Sone “%s” at %s.", new Object[] { sone.getName(), finalUri });
- } catch (SoneException se1) {
- soneInsertListenerManager.fireInsertAborted(se1);
- logger.log(Level.WARNING, "Could not insert Sone “" + sone.getName() + "”!", se1);
- } finally {
- core.setSoneStatus(sone, SoneStatus.idle);
- }
- /*
- * reset modification counter if Sone has not been modified
- * while it was inserted.
- */
- if (success) {
- synchronized (sone) {
- if (lastInsertFingerprint.equals(sone.getFingerprint())) {
- logger.log(Level.FINE, "Sone “%s” was not modified further, resetting counter…", new Object[] { sone });
- lastModificationTime = 0;
- modified = false;
+ /*
+ * reset modification counter if Sone has not been modified
+ * while it was inserted.
+ */
+ if (success) {
+ synchronized (sone) {
+ if (insertInformation.getFingerprint().equals(sone.getFingerprint())) {
+ logger.log(Level.FINE, String.format("Sone “%s” was not modified further, resetting counter…", sone));
+ soneModificationDetector.setFingerprint(insertInformation.getFingerprint());
+ core.touchConfiguration();
+ }
}
}
}
+ } catch (Throwable t1) {
+ logger.log(Level.SEVERE, "SoneInserter threw an Exception!", t1);
}
- } catch (Throwable t1) {
- logger.log(Level.SEVERE, "SoneInserter threw an Exception!", t1);
- }}
+ }
+ }
+
+ @Subscribe
+ public void insertionDelayChanged(InsertionDelayChangedEvent insertionDelayChangedEvent) {
+ setInsertionDelay(insertionDelayChangedEvent.getInsertionDelay());
}
/**
* Container for information that are required to insert a Sone. This
* container merely exists to copy all relevant data without holding a lock
* on the {@link Sone} object for too long.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
- private class InsertInformation {
+ @VisibleForTesting
+ class InsertInformation implements Closeable {
/** All properties of the Sone, copied for thread safety. */
- private final Map<String, Object> soneProperties = new HashMap<String, Object>();
+ private final Map<String, Object> soneProperties = new HashMap<>();
+ private final String fingerprint;
+ private final ManifestCreator manifestCreator;
/**
* Creates a new insert information container.
* The sone to insert
*/
public InsertInformation(Sone sone) {
+ this.fingerprint = sone.getFingerprint();
+ Map<String, Object> soneProperties = new HashMap<>();
soneProperties.put("id", sone.getId());
soneProperties.put("name", sone.getName());
- soneProperties.put("time", sone.getTime());
- soneProperties.put("requestUri", sone.getRequestUri());
- soneProperties.put("insertUri", sone.getInsertUri());
+ soneProperties.put("time", currentTimeMillis());
soneProperties.put("profile", sone.getProfile());
- soneProperties.put("posts", new ListBuilder<Post>(new ArrayList<Post>(sone.getPosts())).sort(Post.TIME_COMPARATOR).get());
- soneProperties.put("replies", new ListBuilder<Reply>(new ArrayList<Reply>(sone.getReplies())).sort(new ReverseComparator<Reply>(Reply.TIME_COMPARATOR)).get());
- soneProperties.put("likedPostIds", new HashSet<String>(sone.getLikedPostIds()));
- soneProperties.put("likedReplyIds", new HashSet<String>(sone.getLikedReplyIds()));
- soneProperties.put("albums", Sone.flattenAlbums(sone.getAlbums()));
+ soneProperties.put("posts", Ordering.from(newestPostFirst()).sortedCopy(sone.getPosts()));
+ soneProperties.put("replies", Ordering.from(newestReplyFirst()).sortedCopy(sone.getReplies()));
+ soneProperties.put("likedPostIds", new HashSet<>(sone.getLikedPostIds()));
+ soneProperties.put("likedReplyIds", new HashSet<>(sone.getLikedReplyIds()));
+ soneProperties.put("albums", SoneKt.getAllAlbums(sone).stream().filter(AlbumKt.notEmpty()::invoke).collect(toList()));
+ manifestCreator = new ManifestCreator(core, soneProperties);
}
//
// ACCESSORS
//
- /**
- * Returns the insert URI of the Sone.
- *
- * @return The insert URI of the Sone
- */
- public FreenetURI getInsertUri() {
- return (FreenetURI) soneProperties.get("insertUri");
- }
-
- /**
- * Sets the time of the Sone at the time of the insert.
- *
- * @param time
- * The time of the Sone
- */
- public void setTime(long time) {
- soneProperties.put("time", time);
+ @VisibleForTesting
+ String getFingerprint() {
+ return fingerprint;
}
//
* @return The manifest entries for the Sone insert
*/
public HashMap<String, Object> generateManifestEntries() {
- HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
+ HashMap<String, Object> manifestEntries = new HashMap<>();
/* first, create an index.html. */
- manifestEntries.put("index.html", createManifestElement("index.html", "text/html; charset=utf-8", "/templates/insert/index.html"));
+ manifestEntries.put("index.html", manifestCreator.createManifestElement(
+ "index.html", "text/html; charset=utf-8",
+ "/templates/insert/index.html"));
/* now, store the sone. */
- manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml"));
+ manifestEntries.put("sone.xml", manifestCreator.createManifestElement(
+ "sone.xml", "text/xml; charset=utf-8",
+ "/templates/insert/sone.xml"));
return manifestEntries;
}
- //
- // PRIVATE METHODS
- //
+ @Override
+ public void close() {
+ manifestCreator.close();
+ }
- /**
- * Creates a new manifest element.
- *
- * @param name
- * The name of the file
- * @param contentType
- * The content type of the file
- * @param templateName
- * The name of the template to render
- * @return The manifest element
- */
- @SuppressWarnings("synthetic-access")
- private ManifestElement createManifestElement(String name, String contentType, String templateName) {
- InputStreamReader templateInputStreamReader = null;
+ }
+
+ /**
+ * Creates manifest elements for an insert by rendering a template.
+ */
+ @VisibleForTesting
+ static class ManifestCreator implements Closeable {
+
+ private final Core core;
+ private final Map<String, Object> soneProperties;
+ private final Set<Bucket> buckets = new HashSet<>();
+
+ ManifestCreator(Core core, Map<String, Object> soneProperties) {
+ this.core = core;
+ this.soneProperties = soneProperties;
+ }
+
+ public ManifestElement createManifestElement(String name, String contentType, String templateName) {
Template template;
- try {
- templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset);
+ try (InputStream templateInputStream = getClass().getResourceAsStream(templateName);
+ InputStreamReader templateInputStreamReader = new InputStreamReader(templateInputStream, utf8Charset)) {
template = TemplateParser.parse(templateInputStreamReader);
- } catch (TemplateException te1) {
- logger.log(Level.SEVERE, "Could not parse template “" + templateName + "”!", te1);
+ } catch (IOException | TemplateException e1) {
+ logger.log(Level.SEVERE, String.format("Could not parse template “%s”!", templateName), e1);
return null;
- } finally {
- Closer.close(templateInputStreamReader);
}
TemplateContext templateContext = templateContextFactory.createTemplateContext();
templateContext.set("core", core);
templateContext.set("currentSone", soneProperties);
templateContext.set("currentEdition", core.getUpdateChecker().getLatestEdition());
- templateContext.set("version", SonePlugin.VERSION);
- StringWriter writer = new StringWriter();
- StringBucket bucket = null;
- try {
+ templateContext.set("version", SonePlugin.getPluginVersion());
+ try (StringWriter writer = new StringWriter()) {
template.render(templateContext, writer);
- bucket = new StringBucket(writer.toString(), utf8Charset);
+ RandomAccessBucket bucket = new ArrayBucket(writer.toString().getBytes(Charsets.UTF_8));
+ buckets.add(bucket);
return new ManifestElement(name, bucket, contentType, bucket.size());
- } catch (TemplateException te1) {
- logger.log(Level.SEVERE, "Could not render template “" + templateName + "”!", te1);
+ } catch (IOException | TemplateException e1) {
+ logger.log(Level.SEVERE, String.format("Could not render template “%s”!", templateName), e1);
return null;
- } finally {
- Closer.close(writer);
- if (bucket != null) {
- bucket.free();
- }
+ }
+ }
+
+ public void close() {
+ for (Bucket bucket : buckets) {
+ bucket.free();
}
}
projects / Sone.git / blobdiff