Insert a root album into all Sones to get rid of album manipulation in the Sone.
[Sone.git] / src / main / java / net / pterodactylus / sone / core / SoneInserter.java
index 05e3600..a1bb903 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * FreenetSone - SoneInserter.java - Copyright © 2010 David Roden
+ * Sone - SoneInserter.java - Copyright © 2010–2013 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 static com.google.common.base.Preconditions.checkArgument;
+import static net.pterodactylus.sone.data.Album.NOT_EMPTY;
+
 import java.io.InputStreamReader;
 import java.io.StringWriter;
 import java.nio.charset.Charset;
-import java.util.ArrayList;
-import java.util.Collection;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
-import java.util.Set;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import net.pterodactylus.sone.core.Core.SoneStatus;
+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.util.filter.Filter;
-import net.pterodactylus.util.filter.Filters;
+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.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 com.google.common.collect.FluentIterable;
+import com.google.common.collect.Ordering;
+import com.google.common.eventbus.EventBus;
+
 import freenet.client.async.ManifestElement;
 import freenet.keys.FreenetURI;
 
@@ -61,11 +72,12 @@ public class SoneInserter extends AbstractService {
        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());
-               templateFactory.addFilter("xml", new XmlFilter());
+               templateContextFactory.addAccessor(Object.class, new ReflectionAccessor());
+               templateContextFactory.addFilter("xml", new XmlFilter());
+               templateContextFactory.addFilter("html", new HtmlFilter());
        }
 
        /** The UTF-8 charset. */
@@ -74,25 +86,37 @@ public class SoneInserter extends AbstractService {
        /** 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;
+       private volatile Sone sone;
+
+       /** 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 eventBus
+        *            The event bus
         * @param freenetInterface
         *            The freenet interface
         * @param sone
         *            The Sone to insert
         */
-       public SoneInserter(Core core, FreenetInterface freenetInterface, Sone sone) {
+       public SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, Sone sone) {
                super("Sone Inserter for “" + sone.getName() + "”", false);
                this.core = core;
+               this.eventBus = eventBus;
                this.freenetInterface = freenetInterface;
                this.sone = sone;
        }
@@ -102,8 +126,21 @@ public class SoneInserter extends AbstractService {
        //
 
        /**
-        * Changes the insertion delay, i.e. the time the Sone inserter waits after
-        * it has noticed a Sone modification before it starts the insert.
+        * Sets the Sone to insert.
+        *
+        * @param sone
+        *              The Sone to insert
+        * @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");
+               this.sone = sone;
+               return this;
+       }
+
+       /**
+        * 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)
@@ -112,6 +149,36 @@ public class SoneInserter extends AbstractService {
                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;
+       }
+
        //
        // SERVICE METHODS
        //
@@ -121,55 +188,94 @@ public class SoneInserter extends AbstractService {
         */
        @Override
        protected void serviceRun() {
-               long modificationCounter = 0;
                long lastModificationTime = 0;
+               String lastInsertedFingerprint = lastInsertFingerprint;
+               String lastFingerprint = "";
+               Sone sone;
                while (!shouldStop()) {
-                       /* check every seconds. */
-                       sleep(1000);
-
-                       InsertInformation insertInformation = null;
-                       synchronized (sone) {
-                               if (sone.getModificationCounter() > modificationCounter) {
-                                       modificationCounter = sone.getModificationCounter();
-                                       lastModificationTime = System.currentTimeMillis();
-                                       sone.setTime(lastModificationTime);
-                                       logger.log(Level.FINE, "Sone %s has been modified, waiting %d seconds before inserting.", new Object[] { sone.getName(), insertionDelay });
-                               }
-                               if ((lastModificationTime > 0) && ((System.currentTimeMillis() - lastModificationTime) > (insertionDelay * 1000))) {
-                                       insertInformation = new InsertInformation(sone);
-                               }
-                       }
+                       try {
+                               /* check every seconds. */
+                               sleep(1000);
 
-                       if (insertInformation != null) {
-                               logger.log(Level.INFO, "Inserting Sone “%s”…", new Object[] { sone.getName() });
-
-                               boolean success = false;
-                               try {
-                                       core.setSoneStatus(sone, SoneStatus.inserting);
-                                       FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri().setKeyType("USK").setSuggestedEdition(0), insertInformation.generateManifestEntries(), "index.html");
-                                       sone.updateUris(finalUri.getEdition());
-                                       success = true;
-                                       logger.log(Level.INFO, "Inserted Sone “%s” at %s.", new Object[] { sone.getName(), finalUri });
-                               } catch (SoneException se1) {
-                                       logger.log(Level.WARNING, "Could not insert Sone “" + sone.getName() + "”!", se1);
-                               } finally {
-                                       core.setSoneStatus(sone, SoneStatus.idle);
+                               /* don’t insert locked Sones. */
+                               sone = this.sone;
+                               if (core.isLocked(sone)) {
+                                       /* trigger redetection when the Sone is unlocked. */
+                                       synchronized (sone) {
+                                               modified = !sone.getFingerprint().equals(lastInsertedFingerprint);
+                                       }
+                                       lastFingerprint = "";
+                                       lastModificationTime = 0;
+                                       continue;
                                }
 
-                               /*
-                                * reset modification counter if Sone has not been modified
-                                * while it was inserted.
-                                */
-                               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);
-                                                       modificationCounter = 0;
+                               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) {
+                                       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);
+                                               eventBus.post(new SoneInsertingEvent(sone));
+                                               FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri(), insertInformation.generateManifestEntries(), "index.html");
+                                               eventBus.post(new SoneInsertedEvent(sone, 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, String.format("Inserted Sone “%s” at %s.", sone.getName(), finalUri));
+                                       } catch (SoneException se1) {
+                                               eventBus.post(new SoneInsertAbortedEvent(sone, se1));
+                                               logger.log(Level.WARNING, String.format("Could not insert Sone “%s”!", sone.getName()), se1);
+                                       } finally {
+                                               sone.setStatus(SoneStatus.idle);
+                                       }
+
+                                       /*
+                                        * reset modification counter if Sone has not been modified
+                                        * while it was inserted.
+                                        */
+                                       if (success) {
+                                               synchronized (sone) {
+                                                       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);
                        }
                }
        }
@@ -199,11 +305,11 @@ public class SoneInserter extends AbstractService {
                        soneProperties.put("requestUri", sone.getRequestUri());
                        soneProperties.put("insertUri", sone.getInsertUri());
                        soneProperties.put("profile", sone.getProfile());
-                       soneProperties.put("posts", new ArrayList<Post>(sone.getPosts()));
-                       soneProperties.put("replies", new HashSet<Reply>(sone.getReplies()));
-                       soneProperties.put("blockedSoneIds", new HashSet<String>(sone.getBlockedSoneIds()));
+                       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<String>(sone.getLikedPostIds()));
-                       soneProperties.put("likeReplyIds", new HashSet<String>(sone.getLikedReplyIds()));
+                       soneProperties.put("likedReplyIds", new HashSet<String>(sone.getLikedReplyIds()));
+                       soneProperties.put("albums", FluentIterable.from(sone.getRootAlbum().getAlbums()).transformAndConcat(Album.FLATTENER).filter(NOT_EMPTY).toList());
                }
 
                //
@@ -219,6 +325,16 @@ 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
                //
@@ -257,39 +373,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);
                        }
-                       @SuppressWarnings("unchecked")
-                       final Set<String> blockedSoneIds = (Set<String>) soneProperties.get("blockedSoneIds");
-                       Collection<Sone> knownSones = Filters.filteredCollection(core.getKnownSones(), new Filter<Sone>() {
-
-                               /**
-                                * {@inheritDoc}
-                                */
-                               @Override
-                               public boolean filterObject(Sone object) {
-                                       return !blockedSoneIds.contains(object.getId()) && !object.getId().equals(soneProperties.get("id"));
-                               }
-                       });
 
-                       template.set("currentSone", soneProperties);
-                       template.set("knownSones", knownSones);
+                       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);