X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fcore%2FSoneInserter.java;h=45c617cd6afcda882dcd15db452d40c1cc7a94de;hp=48241aa43dab584591125cbe9513511bbbaae99f;hb=3a7092e48f27cba6286946442783f539ad73a911;hpb=99888ce13cc17d49f5e217ab6f2c9ad5ef168792 diff --git a/src/main/java/net/pterodactylus/sone/core/SoneInserter.java b/src/main/java/net/pterodactylus/sone/core/SoneInserter.java index 48241aa..45c617c 100644 --- a/src/main/java/net/pterodactylus/sone/core/SoneInserter.java +++ b/src/main/java/net/pterodactylus/sone/core/SoneInserter.java @@ -17,26 +17,36 @@ package net.pterodactylus.sone.core; +import static java.lang.String.format; +import static java.lang.System.currentTimeMillis; +import static java.util.logging.Logger.getLogger; +import static net.pterodactylus.sone.data.Album.NOT_EMPTY; + +import java.io.Closeable; +import java.io.InputStream; import java.io.InputStreamReader; import java.io.StringWriter; import java.nio.charset.Charset; 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.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.Album; import net.pterodactylus.sone.data.Post; import net.pterodactylus.sone.data.Reply; import net.pterodactylus.sone.data.Sone; import net.pterodactylus.sone.data.Sone.SoneStatus; -import net.pterodactylus.sone.freenet.StringBucket; import net.pterodactylus.sone.main.SonePlugin; 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; @@ -47,11 +57,19 @@ import net.pterodactylus.util.template.TemplateException; import net.pterodactylus.util.template.TemplateParser; import net.pterodactylus.util.template.XmlFilter; +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Charsets; +import com.google.common.base.Optional; +import com.google.common.collect.FluentIterable; import com.google.common.collect.Ordering; import com.google.common.eventbus.EventBus; +import com.google.common.eventbus.Subscribe; -import freenet.client.async.ManifestElement; 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. @@ -61,10 +79,10 @@ import freenet.keys.FreenetURI; 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(); @@ -87,14 +105,9 @@ public class SoneInserter extends AbstractService { /** The Freenet interface. */ private final FreenetInterface freenetInterface; - /** The Sone to insert. */ - private final Sone sone; - - /** 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 long delay; + private final String soneId; /** * Creates a new Sone inserter. @@ -105,30 +118,60 @@ public class SoneInserter extends AbstractService { * 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, EventBus eventBus, FreenetInterface freenetInterface, Sone sone) { - super("Sone Inserter for “" + sone.getName() + "”", false); + public SoneInserter(final Core core, EventBus eventBus, FreenetInterface freenetInterface, final String soneId) { + this(core, eventBus, freenetInterface, soneId, new SoneModificationDetector(new LockableFingerprintProvider() { + @Override + public boolean isLocked() { + final Optional sone = core.getSone(soneId); + if (!sone.isPresent()) { + return false; + } + return core.isLocked(sone.get()); + } + + @Override + public String getFingerprint() { + final Optional sone = core.getSone(soneId); + if (!sone.isPresent()) { + return null; + } + return sone.get().getFingerprint(); + } + }, insertionDelay), 1000); + } + + @VisibleForTesting + SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, String soneId, SoneModificationDetector soneModificationDetector, long delay) { + super("Sone Inserter for “" + soneId + "”", false); this.core = core; this.eventBus = eventBus; this.freenetInterface = freenetInterface; - this.sone = sone; + 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); } /** @@ -137,7 +180,7 @@ public class SoneInserter extends AbstractService { * @return The fingerprint of the last insert */ public String getLastInsertFingerprint() { - return lastInsertFingerprint; + return soneModificationDetector.getOriginalFingerprint(); } /** @@ -147,7 +190,7 @@ public class SoneInserter extends AbstractService { * The fingerprint of the last insert */ public void setLastInsertFingerprint(String lastInsertFingerprint) { - this.lastInsertFingerprint = lastInsertFingerprint; + soneModificationDetector.setFingerprint(lastInsertFingerprint); } /** @@ -158,7 +201,7 @@ public class SoneInserter extends AbstractService { * otherwise */ public boolean isModified() { - return modified; + return soneModificationDetector.isModified(); } // @@ -170,57 +213,28 @@ public class SoneInserter extends AbstractService { */ @Override protected void serviceRun() { - long lastModificationTime = 0; - String lastInsertedFingerprint = lastInsertFingerprint; - 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(lastInsertedFingerprint); + /* check every second. */ + sleep(delay); + + if (soneModificationDetector.isEligibleForInsert()) { + Optional soneOptional = core.getSone(soneId); + if (!soneOptional.isPresent()) { + logger.log(Level.WARNING, format("Sone %s has disappeared, exiting inserter.", soneId)); + return; } - lastFingerprint = ""; - lastModificationTime = 0; - continue; - } - - InsertInformation insertInformation = null; - synchronized (sone) { - String fingerprint = sone.getFingerprint(); - if (!fingerprint.equals(lastFingerprint)) { - if (fingerprint.equals(lastInsertedFingerprint)) { - modified = false; - lastModificationTime = 0; - logger.log(Level.FINE, String.format("Sone %s has been reverted to last insert state.", sone)); - } else { - lastModificationTime = System.currentTimeMillis(); - modified = true; - logger.log(Level.FINE, String.format("Sone %s has been modified, waiting %d seconds before inserting.", sone.getName(), insertionDelay)); - } - lastFingerprint = fingerprint; - } - if (modified && (lastModificationTime > 0) && ((System.currentTimeMillis() - lastModificationTime) > (insertionDelay * 1000))) { - lastInsertedFingerprint = fingerprint; - insertInformation = new InsertInformation(sone); - } - } - - if (insertInformation != null) { + Sone sone = soneOptional.get(); + 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 = System.currentTimeMillis(); - insertInformation.setTime(insertTime); + long insertTime = currentTimeMillis(); eventBus.post(new SoneInsertingEvent(sone)); - FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri(), insertInformation.generateManifestEntries(), "index.html"); - eventBus.post(new SoneInsertedEvent(sone, System.currentTimeMillis() - insertTime)); + FreenetURI finalUri = freenetInterface.insertDirectory(sone.getInsertUri(), insertInformation.generateManifestEntries(), "index.html"); + eventBus.post(new SoneInsertedEvent(sone, currentTimeMillis() - insertTime, insertInformation.getFingerprint())); /* at this point we might already be stopped. */ if (shouldStop()) { /* if so, bail out, don’t change anything. */ @@ -235,6 +249,7 @@ public class SoneInserter extends AbstractService { 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); } @@ -244,12 +259,10 @@ public class SoneInserter extends AbstractService { */ if (success) { synchronized (sone) { - if (lastInsertedFingerprint.equals(sone.getFingerprint())) { + if (insertInformation.getFingerprint().equals(sone.getFingerprint())) { logger.log(Level.FINE, String.format("Sone “%s” was not modified further, resetting counter…", sone)); - lastModificationTime = 0; - lastInsertFingerprint = lastInsertedFingerprint; + soneModificationDetector.setFingerprint(insertInformation.getFingerprint()); core.touchConfiguration(); - modified = false; } } } @@ -260,6 +273,11 @@ public class SoneInserter extends AbstractService { } } + @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 @@ -267,10 +285,13 @@ public class SoneInserter extends AbstractService { * * @author David ‘Bombe’ Roden */ - private class InsertInformation { + @VisibleForTesting + class InsertInformation implements Closeable { /** All properties of the Sone, copied for thread safety. */ private final Map soneProperties = new HashMap(); + private final String fingerprint; + private final ManifestCreator manifestCreator; /** * Creates a new insert information container. @@ -279,40 +300,28 @@ public class SoneInserter extends AbstractService { * The sone to insert */ public InsertInformation(Sone sone) { + this.fingerprint = sone.getFingerprint(); + Map soneProperties = new HashMap(); soneProperties.put("id", sone.getId()); soneProperties.put("name", sone.getName()); - soneProperties.put("time", sone.getTime()); + soneProperties.put("time", currentTimeMillis()); soneProperties.put("requestUri", sone.getRequestUri()); - soneProperties.put("insertUri", sone.getInsertUri()); soneProperties.put("profile", sone.getProfile()); soneProperties.put("posts", Ordering.from(Post.TIME_COMPARATOR).sortedCopy(sone.getPosts())); soneProperties.put("replies", Ordering.from(Reply.TIME_COMPARATOR).reverse().sortedCopy(sone.getReplies())); soneProperties.put("likedPostIds", new HashSet(sone.getLikedPostIds())); soneProperties.put("likedReplyIds", new HashSet(sone.getLikedReplyIds())); - soneProperties.put("albums", sone.getAllAlbums()); + soneProperties.put("albums", FluentIterable.from(sone.getRootAlbum().getAlbums()).transformAndConcat(Album.FLATTENER).filter(NOT_EMPTY).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; } // @@ -328,41 +337,56 @@ public class SoneInserter extends AbstractService { HashMap 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) { + } + + /** + * Creates manifest elements for an insert by rendering a template. + * + * @author David ‘Bombe’ Roden + */ + @VisibleForTesting + static class ManifestCreator implements Closeable { + + private final Core core; + private final Map soneProperties; + private final Set buckets = new HashSet(); + + ManifestCreator(Core core, Map soneProperties) { + this.core = core; + this.soneProperties = soneProperties; + } + + public ManifestElement createManifestElement(String name, String contentType, String templateName) { InputStreamReader templateInputStreamReader = null; + InputStream templateInputStream = null; Template template; try { - templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset); + templateInputStream = getClass().getResourceAsStream(templateName); + templateInputStreamReader = new InputStreamReader(templateInputStream, utf8Charset); template = TemplateParser.parse(templateInputStreamReader); } catch (TemplateException te1) { logger.log(Level.SEVERE, String.format("Could not parse template “%s”!", templateName), te1); return null; } finally { Closer.close(templateInputStreamReader); + Closer.close(templateInputStream); } TemplateContext templateContext = templateContextFactory.createTemplateContext(); @@ -371,19 +395,22 @@ public class SoneInserter extends AbstractService { templateContext.set("currentEdition", core.getUpdateChecker().getLatestEdition()); templateContext.set("version", SonePlugin.VERSION); StringWriter writer = new StringWriter(); - StringBucket bucket = null; try { 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, String.format("Could not render template “%s”!", templateName), te1); return null; } finally { Closer.close(writer); - if (bucket != null) { - bucket.free(); - } + } + } + + public void close() { + for (Bucket bucket : buckets) { + bucket.free(); } }