Fix ALL the logging!
[Sone.git] / src / main / java / net / pterodactylus / sone / core / SoneInserter.java
index 5730b55..9f45e2e 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * FreenetSone - SoneInserter.java - Copyright © 2010 David Roden
+ * Sone - SoneInserter.java - Copyright © 2010 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
@@ -20,19 +20,33 @@ package net.pterodactylus.sone.core;
 import java.io.InputStreamReader;
 import java.io.StringWriter;
 import java.nio.charset.Charset;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import net.pterodactylus.sone.data.Post;
+import net.pterodactylus.sone.data.PostReply;
+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.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.DefaultTemplateFactory;
+import net.pterodactylus.util.template.HtmlFilter;
 import net.pterodactylus.util.template.ReflectionAccessor;
 import net.pterodactylus.util.template.Template;
+import net.pterodactylus.util.template.TemplateContext;
+import net.pterodactylus.util.template.TemplateContextFactory;
 import net.pterodactylus.util.template.TemplateException;
+import net.pterodactylus.util.template.TemplateParser;
+import net.pterodactylus.util.template.XmlFilter;
 import freenet.client.async.ManifestElement;
 import freenet.keys.FreenetURI;
 
@@ -46,34 +60,124 @@ public class SoneInserter extends AbstractService {
        /** The logger. */
        private static final Logger logger = Logging.getLogger(SoneInserter.class);
 
+       /** The insertion delay (in seconds). */
+       private static volatile int insertionDelay = 60;
+
        /** The template factory used to create the templates. */
-       private static final DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
+       private static final TemplateContextFactory templateContextFactory = new TemplateContextFactory();
 
        static {
-               templateFactory.addAccessor(Object.class, new ReflectionAccessor());
+               templateContextFactory.addAccessor(Object.class, new ReflectionAccessor());
+               templateContextFactory.addFilter("xml", new XmlFilter());
+               templateContextFactory.addFilter("html", new HtmlFilter());
        }
 
        /** The UTF-8 charset. */
        private static final Charset utf8Charset = Charset.forName("UTF-8");
 
+       /** The core. */
+       private final Core core;
+
        /** 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;
+
        /**
         * Creates a new Sone inserter.
         *
+        * @param core
+        *            The core
         * @param freenetInterface
         *            The freenet interface
         * @param sone
         *            The Sone to insert
         */
-       public SoneInserter(FreenetInterface freenetInterface, Sone sone) {
-               super("Sone Inserter for “" + sone.getName() + "”");
+       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
+       //
+
+       /**
+        * Adds a listener for Sone insert events.
+        *
+        * @param soneInsertListener
+        *            The Sone insert listener
+        */
+       public void addSoneInsertListener(SoneInsertListener soneInsertListener) {
+               soneInsertListenerManager.addListener(soneInsertListener);
+       }
+
+       /**
+        * Removes a listener for Sone insert events.
+        *
+        * @param soneInsertListener
+        *            The Sone insert listener
+        */
+       public void removeSoneInsertListener(SoneInsertListener soneInsertListener) {
+               soneInsertListenerManager.removeListener(soneInsertListener);
+       }
+
+       //
+       // ACCESSORS
+       //
+
+       /**
+        * 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;
+       }
+
+       /**
+        * Returns the fingerprint of the last insert.
+        *
+        * @return The fingerprint of the last insert
+        */
+       public String getLastInsertFingerprint() {
+               return lastInsertFingerprint;
+       }
+
+       /**
+        * Sets the fingerprint of the last insert.
+        *
+        * @param lastInsertFingerprint
+        *            The fingerprint of the last insert
+        */
+       public void setLastInsertFingerprint(String lastInsertFingerprint) {
+               this.lastInsertFingerprint = lastInsertFingerprint;
+       }
+
+       /**
+        * Returns whether the Sone inserter has detected a modification of the
+        * Sone.
+        *
+        * @return {@code true} if the Sone has been modified, {@code false}
+        *         otherwise
+        */
+       public boolean isModified() {
+               return modified;
        }
 
        //
@@ -85,31 +189,71 @@ public class SoneInserter extends AbstractService {
         */
        @Override
        protected void serviceRun() {
-               long modificationCounter = 0;
-               boolean restartNow = true;
-               while (!shouldStop()) {
-                       if (!restartNow) {
-                               logger.log(Level.FINEST, "Waiting 60 seconds before checking Sone “" + sone.getName() + "”.");
-                               sleep(60 * 1000);
+               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);
+                               }
+                               lastFingerprint = "";
+                               lastModificationTime = 0;
+                               continue;
                        }
-                       restartNow = false;
+
                        InsertInformation insertInformation = null;
                        synchronized (sone) {
-                               modificationCounter = sone.getModificationCounter();
-                               if (modificationCounter > 0) {
-                                       insertInformation = new InsertInformation(sone.getRequestUri(), sone.getInsertUri());
+                               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) {
-                               logger.log(Level.INFO, "Inserting Sone “%s”…", new Object[] { sone.getName() });
+                               logger.log(Level.INFO, String.format("Inserting Sone “%s”…", sone.getName()));
 
                                boolean success = false;
                                try {
-                                       FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri().setKeyType("USK").setDocName("Sone-" + sone.getName()).setSuggestedEdition(0), insertInformation.generateManifestEntries(), "index.html");
+                                       sone.setStatus(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;
+                                       }
+                                       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 });
+                                       logger.log(Level.INFO, String.format("Inserted Sone “%s” at %s.", sone.getName(), finalUri));
                                } catch (SoneException se1) {
-                                       logger.log(Level.WARNING, "Could not insert Sone “" + sone.getName() + "”!", se1);
+                                       soneInsertListenerManager.fireInsertAborted(se1);
+                                       logger.log(Level.WARNING, String.format("Could not insert Sone “%s”!", sone.getName()), se1);
+                               } finally {
+                                       sone.setStatus(SoneStatus.idle);
                                }
 
                                /*
@@ -118,17 +262,19 @@ public class SoneInserter extends AbstractService {
                                 */
                                if (success) {
                                        synchronized (sone) {
-                                               if (sone.getModificationCounter() == modificationCounter) {
-                                                       logger.log(Level.FINE, "Sone “%s” was not modified further, resetting counter…", new Object[] { sone });
-                                                       sone.setModificationCounter(0);
-                                               } else {
-                                                       logger.log(Level.FINE, "Sone “%s” was modified since the insert started, starting another insert…", new Object[] { sone });
-                                                       restartNow = true;
+                                               if (lastInsertedFingerprint.equals(sone.getFingerprint())) {
+                                                       logger.log(Level.FINE, String.format("Sone “%s” was not modified further, resetting counter…", sone));
+                                                       lastModificationTime = 0;
+                                                       lastInsertFingerprint = lastInsertedFingerprint;
+                                                       core.touchConfiguration();
+                                                       modified = false;
                                                }
                                        }
                                }
                        }
-               }
+               } catch (Throwable t1) {
+                       logger.log(Level.SEVERE, "SoneInserter threw an Exception!", t1);
+               }}
        }
 
        /**
@@ -140,23 +286,27 @@ public class SoneInserter extends AbstractService {
         */
        private class InsertInformation {
 
-               /** The request URI of the Sone. */
-               private final FreenetURI requestUri;
-
-               /** The insert URI of the Sone. */
-               private final FreenetURI insertUri;
+               /** All properties of the Sone, copied for thread safety. */
+               private final Map<String, Object> soneProperties = new HashMap<String, Object>();
 
                /**
                 * Creates a new insert information container.
                 *
-                * @param requestUri
-                *            The request URI of the Sone
-                * @param insertUri
-                *            The insert URI of the Sone
+                * @param sone
+                *            The sone to insert
                 */
-               public InsertInformation(FreenetURI requestUri, FreenetURI insertUri) {
-                       this.requestUri = requestUri;
-                       this.insertUri = insertUri;
+               public InsertInformation(Sone sone) {
+                       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("profile", sone.getProfile());
+                       soneProperties.put("posts", new ListBuilder<Post>(new ArrayList<Post>(sone.getPosts())).sort(Post.TIME_COMPARATOR).get());
+                       soneProperties.put("replies", new ListBuilder<PostReply>(new ArrayList<PostReply>(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.getAllAlbums());
                }
 
                //
@@ -164,22 +314,22 @@ public class SoneInserter extends AbstractService {
                //
 
                /**
-                * Returns the request URI of the Sone.
+                * Returns the insert URI of the Sone.
                 *
-                * @return The request URI of the Sone
+                * @return The insert URI of the Sone
                 */
-               @SuppressWarnings("unused")
-               public FreenetURI getRequestUri() {
-                       return requestUri;
+               public FreenetURI getInsertUri() {
+                       return (FreenetURI) soneProperties.get("insertUri");
                }
 
                /**
-                * Returns the insert URI of the Sone.
+                * Sets the time of the Sone at the time of the insert.
                 *
-                * @return The insert URI of the Sone
+                * @param time
+                *            The time of the Sone
                 */
-               public FreenetURI getInsertUri() {
-                       return insertUri;
+               public void setTime(long time) {
+                       soneProperties.put("time", time);
                }
 
                //
@@ -220,25 +370,31 @@ public class SoneInserter extends AbstractService {
                 */
                @SuppressWarnings("synthetic-access")
                private ManifestElement createManifestElement(String name, String contentType, String templateName) {
-                       InputStreamReader templateInputStreamReader;
-                       Template template = templateFactory.createTemplate(templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset));
+                       InputStreamReader templateInputStreamReader = null;
+                       Template template;
                        try {
-                               template.parse();
+                               templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset);
+                               template = TemplateParser.parse(templateInputStreamReader);
                        } catch (TemplateException te1) {
-                               logger.log(Level.SEVERE, "Could not parse template “" + templateName + "”!", te1);
+                               logger.log(Level.SEVERE, String.format("Could not parse template “%s”!", templateName), te1);
                                return null;
                        } finally {
                                Closer.close(templateInputStreamReader);
                        }
-                       template.set("currentSone", sone);
+
+                       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 {
-                               template.render(writer);
+                               template.render(templateContext, writer);
                                bucket = new StringBucket(writer.toString(), utf8Charset);
                                return new ManifestElement(name, bucket, contentType, bucket.size());
                        } catch (TemplateException te1) {
-                               logger.log(Level.SEVERE, "Could not render template “" + templateName + "”!", te1);
+                               logger.log(Level.SEVERE, String.format("Could not render template “%s”!", templateName), te1);
                                return null;
                        } finally {
                                Closer.close(writer);