Add more tests of sone inserter.
[Sone.git] / src / main / java / net / pterodactylus / sone / core / SoneInserter.java
index d9235fd..1e93aa6 100644 (file)
 
 package net.pterodactylus.sone.core;
 
-import static com.google.common.base.Optional.absent;
-import static com.google.common.base.Optional.of;
 import static com.google.common.base.Preconditions.checkArgument;
 import static java.lang.System.currentTimeMillis;
 import static net.pterodactylus.sone.data.Album.NOT_EMPTY;
 
+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.concurrent.atomic.AtomicInteger;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import net.pterodactylus.sone.core.Options.Option;
+import net.pterodactylus.sone.core.Options.OptionWatcher;
 import net.pterodactylus.sone.core.event.SoneInsertAbortedEvent;
 import net.pterodactylus.sone.core.event.SoneInsertedEvent;
 import net.pterodactylus.sone.core.event.SoneInsertingEvent;
@@ -54,7 +56,7 @@ import net.pterodactylus.util.template.TemplateException;
 import net.pterodactylus.util.template.TemplateParser;
 import net.pterodactylus.util.template.XmlFilter;
 
-import com.google.common.base.Optional;
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.FluentIterable;
 import com.google.common.collect.Ordering;
 import com.google.common.eventbus.EventBus;
@@ -73,7 +75,7 @@ public class SoneInserter extends AbstractService {
        private static final Logger logger = Logging.getLogger(SoneInserter.class);
 
        /** 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();
@@ -96,12 +98,11 @@ public class SoneInserter extends AbstractService {
        /** The Freenet interface. */
        private final FreenetInterface freenetInterface;
 
+       private final SoneModificationDetector soneModificationDetector;
+
        /** The Sone to insert. */
        private volatile Sone sone;
 
-       /** The fingerprint of the last insert. */
-       private volatile String lastInsertFingerprint;
-
        /**
         * Creates a new Sone inserter.
         *
@@ -115,11 +116,17 @@ public class SoneInserter extends AbstractService {
         *            The Sone to insert
         */
        public SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, Sone sone) {
+               this(core, eventBus, freenetInterface, sone, new SoneModificationDetector(core, sone, insertionDelay));
+       }
+
+       @VisibleForTesting
+       SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, Sone sone, SoneModificationDetector soneModificationDetector) {
                super("Sone Inserter for “" + sone.getName() + "”", false);
                this.core = core;
                this.eventBus = eventBus;
                this.freenetInterface = freenetInterface;
                this.sone = sone;
+               this.soneModificationDetector = soneModificationDetector;
        }
 
        //
@@ -134,11 +141,16 @@ public class SoneInserter extends AbstractService {
         * @return This Sone inserter
         */
        public SoneInserter setSone(Sone sone) {
-               checkArgument((this.sone == null) || sone.equals(this.sone), "Sone to insert can not be set to a different Sone");
+               checkArgument(sone.equals(this.sone), "Sone to insert can not be set to a different Sone");
                this.sone = sone;
                return this;
        }
 
+       @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.
@@ -147,7 +159,7 @@ public class SoneInserter extends AbstractService {
         *            The insertion delay (in seconds)
         */
        public static void setInsertionDelay(int insertionDelay) {
-               SoneInserter.insertionDelay = insertionDelay;
+               SoneInserter.insertionDelay.set(insertionDelay);
        }
 
        /**
@@ -156,7 +168,7 @@ public class SoneInserter extends AbstractService {
         * @return The fingerprint of the last insert
         */
        public String getLastInsertFingerprint() {
-               return lastInsertFingerprint;
+               return soneModificationDetector.getOriginalFingerprint();
        }
 
        /**
@@ -166,7 +178,7 @@ public class SoneInserter extends AbstractService {
         *            The fingerprint of the last insert
         */
        public void setLastInsertFingerprint(String lastInsertFingerprint) {
-               this.lastInsertFingerprint = lastInsertFingerprint;
+               soneModificationDetector.setFingerprint(lastInsertFingerprint);
        }
 
        /**
@@ -177,7 +189,7 @@ public class SoneInserter extends AbstractService {
         *         otherwise
         */
        public boolean isModified() {
-               return !lastInsertFingerprint.equals(sone.getFingerprint());
+               return soneModificationDetector.isModified();
        }
 
        //
@@ -189,43 +201,12 @@ public class SoneInserter extends AbstractService {
         */
        @Override
        protected void serviceRun() {
-               Optional<Long> lastModificationTime = absent();
-               String lastInsertedFingerprint = lastInsertFingerprint;
-               String lastFingerprint = "";
                while (!shouldStop()) {
                        try {
                                /* check every second. */
                                sleep(1000);
 
-                               /* don’t insert locked Sones. */
-                               Sone sone = this.sone;
-                               if (core.isLocked(sone)) {
-                                       /* trigger redetection when the Sone is unlocked. */
-                                       lastFingerprint = "";
-                                       lastModificationTime = absent();
-                                       continue;
-                               }
-
-                               boolean insertSoneNow = false;
-                               synchronized (sone) {
-                                       String fingerprint = sone.getFingerprint();
-                                       if (!fingerprint.equals(lastFingerprint)) {
-                                               if (fingerprint.equals(lastInsertedFingerprint)) {
-                                                       lastModificationTime = absent();
-                                                       logger.log(Level.FINE, String.format("Sone %s has been reverted to last insert state.", sone));
-                                               } else {
-                                                       lastModificationTime = of(currentTimeMillis());
-                                                       logger.log(Level.FINE, String.format("Sone %s has been modified, waiting %d seconds before inserting.", sone.getName(), insertionDelay));
-                                               }
-                                               lastFingerprint = fingerprint;
-                                       }
-                                       if (lastModificationTime.isPresent() && ((currentTimeMillis() - lastModificationTime.get()) > (insertionDelay * 1000))) {
-                                               lastInsertedFingerprint = fingerprint;
-                                               insertSoneNow = true;
-                                       }
-                               }
-
-                               if (insertSoneNow) {
+                               if (soneModificationDetector.isEligibleForInsert()) {
                                        InsertInformation insertInformation = new InsertInformation(sone);
                                        logger.log(Level.INFO, String.format("Inserting Sone “%s”…", sone.getName()));
 
@@ -233,7 +214,6 @@ public class SoneInserter extends AbstractService {
                                        try {
                                                sone.setStatus(SoneStatus.inserting);
                                                long insertTime = currentTimeMillis();
-                                               insertInformation.setTime(insertTime);
                                                eventBus.post(new SoneInsertingEvent(sone));
                                                FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri(), insertInformation.generateManifestEntries(), "index.html");
                                                eventBus.post(new SoneInsertedEvent(sone, currentTimeMillis() - insertTime));
@@ -262,8 +242,7 @@ public class SoneInserter extends AbstractService {
                                                synchronized (sone) {
                                                        if (insertInformation.getFingerprint().equals(sone.getFingerprint())) {
                                                                logger.log(Level.FINE, String.format("Sone “%s” was not modified further, resetting counter…", sone));
-                                                               lastModificationTime = absent();
-                                                               lastInsertFingerprint = insertInformation.getFingerprint();
+                                                               soneModificationDetector.setFingerprint(insertInformation.getFingerprint());
                                                                core.touchConfiguration();
                                                        }
                                                }
@@ -275,6 +254,15 @@ public class SoneInserter extends AbstractService {
                }
        }
 
+       static class SetInsertionDelay implements OptionWatcher<Integer> {
+
+               @Override
+               public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
+                       setInsertionDelay(newValue);
+               }
+
+       }
+
        /**
         * Container for information that are required to insert a Sone. This
         * container merely exists to copy all relevant data without holding a lock
@@ -282,7 +270,8 @@ public class SoneInserter extends AbstractService {
         *
         * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
         */
-       private class InsertInformation {
+       @VisibleForTesting
+       class InsertInformation {
 
                private final String fingerprint;
 
@@ -299,7 +288,7 @@ public class SoneInserter extends AbstractService {
                        this.fingerprint = sone.getFingerprint();
                        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());
@@ -314,7 +303,8 @@ public class SoneInserter extends AbstractService {
                // ACCESSORS
                //
 
-               private String getFingerprint() {
+               @VisibleForTesting
+               String getFingerprint() {
                        return fingerprint;
                }
 
@@ -327,16 +317,6 @@ public class SoneInserter extends AbstractService {
                        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);
-               }
-
                //
                // ACTIONS
                //
@@ -376,15 +356,18 @@ public class SoneInserter extends AbstractService {
                @SuppressWarnings("synthetic-access")
                private 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();