core/SoneInserter.java

   1 /*
   2  * Sone - SoneInserter.java - Copyright © 2010–2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.core;
  19
  20 import static com.google.common.base.Preconditions.checkArgument;
  21 import static java.lang.System.currentTimeMillis;
  22 import static net.pterodactylus.sone.data.Album.NOT_EMPTY;
  23
  24 import java.io.InputStream;
  25 import java.io.InputStreamReader;
  26 import java.io.StringWriter;
  27 import java.nio.charset.Charset;
  28 import java.util.HashMap;
  29 import java.util.HashSet;
  30 import java.util.Map;
  31 import java.util.concurrent.atomic.AtomicInteger;
  32 import java.util.logging.Level;
  33 import java.util.logging.Logger;
  34
  35 import net.pterodactylus.sone.core.event.SoneInsertAbortedEvent;
  36 import net.pterodactylus.sone.core.event.SoneInsertedEvent;
  37 import net.pterodactylus.sone.core.event.SoneInsertingEvent;
  38 import net.pterodactylus.sone.data.Album;
  39 import net.pterodactylus.sone.data.Post;
  40 import net.pterodactylus.sone.data.Reply;
  41 import net.pterodactylus.sone.data.Sone;
  42 import net.pterodactylus.sone.data.Sone.SoneStatus;
  43 import net.pterodactylus.sone.freenet.StringBucket;
  44 import net.pterodactylus.sone.main.SonePlugin;
  45 import net.pterodactylus.util.io.Closer;
  46 import net.pterodactylus.util.logging.Logging;
  47 import net.pterodactylus.util.service.AbstractService;
  48 import net.pterodactylus.util.template.HtmlFilter;
  49 import net.pterodactylus.util.template.ReflectionAccessor;
  50 import net.pterodactylus.util.template.Template;
  51 import net.pterodactylus.util.template.TemplateContext;
  52 import net.pterodactylus.util.template.TemplateContextFactory;
  53 import net.pterodactylus.util.template.TemplateException;
  54 import net.pterodactylus.util.template.TemplateParser;
  55 import net.pterodactylus.util.template.XmlFilter;
  56
  57 import com.google.common.collect.FluentIterable;
  58 import com.google.common.collect.Ordering;
  59 import com.google.common.eventbus.EventBus;
  60
  61 import freenet.client.async.ManifestElement;
  62 import freenet.keys.FreenetURI;
  63
  64 /**
  65  * A Sone inserter is responsible for inserting a Sone if it has changed.
  66  *
  67  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  68  */
  69 public class SoneInserter extends AbstractService {
  70
  71         /** The logger. */
  72         private static final Logger logger = Logging.getLogger(SoneInserter.class);
  73
  74         /** The insertion delay (in seconds). */
  75         private static final AtomicInteger insertionDelay = new AtomicInteger(60);
  76
  77         /** The template factory used to create the templates. */
  78         private static final TemplateContextFactory templateContextFactory = new TemplateContextFactory();
  79
  80         static {
  81                 templateContextFactory.addAccessor(Object.class, new ReflectionAccessor());
  82                 templateContextFactory.addFilter("xml", new XmlFilter());
  83                 templateContextFactory.addFilter("html", new HtmlFilter());
  84         }
  85
  86         /** The UTF-8 charset. */
  87         private static final Charset utf8Charset = Charset.forName("UTF-8");
  88
  89         /** The core. */
  90         private final Core core;
  91
  92         /** The event bus. */
  93         private final EventBus eventBus;
  94
  95         /** The Freenet interface. */
  96         private final FreenetInterface freenetInterface;
  97
  98         private final SoneModificationDetector soneModificationDetector;
  99
 100         /** The Sone to insert. */
 101         private volatile Sone sone;
 102
 103         /**
 104          * Creates a new Sone inserter.
 105          *
 106          * @param core
 107          *            The core
 108          * @param eventBus
 109          *            The event bus
 110          * @param freenetInterface
 111          *            The freenet interface
 112          * @param sone
 113          *            The Sone to insert
 114          */
 115         public SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, Sone sone) {
 116                 super("Sone Inserter for “" + sone.getName() + "”", false);
 117                 this.core = core;
 118                 this.eventBus = eventBus;
 119                 this.freenetInterface = freenetInterface;
 120                 this.sone = sone;
 121                 this.soneModificationDetector = new SoneModificationDetector(core, sone, insertionDelay);
 122         }
 123
 124         //
 125         // ACCESSORS
 126         //
 127
 128         /**
 129          * Sets the Sone to insert.
 130          *
 131          * @param sone
 132          *              The Sone to insert
 133          * @return This Sone inserter
 134          */
 135         public SoneInserter setSone(Sone sone) {
 136                 checkArgument((this.sone == null) || sone.equals(this.sone), "Sone to insert can not be set to a different Sone");
 137                 this.sone = sone;
 138                 return this;
 139         }
 140
 141         /**
 142          * Changes the insertion delay, i.e. the time the Sone inserter waits after it
 143          * has noticed a Sone modification before it starts the insert.
 144          *
 145          * @param insertionDelay
 146          *            The insertion delay (in seconds)
 147          */
 148         public static void setInsertionDelay(int insertionDelay) {
 149                 SoneInserter.insertionDelay.set(insertionDelay);
 150         }
 151
 152         /**
 153          * Returns the fingerprint of the last insert.
 154          *
 155          * @return The fingerprint of the last insert
 156          */
 157         public String getLastInsertFingerprint() {
 158                 return soneModificationDetector.getOriginalFingerprint();
 159         }
 160
 161         /**
 162          * Sets the fingerprint of the last insert.
 163          *
 164          * @param lastInsertFingerprint
 165          *            The fingerprint of the last insert
 166          */
 167         public void setLastInsertFingerprint(String lastInsertFingerprint) {
 168                 soneModificationDetector.setFingerprint(lastInsertFingerprint);
 169         }
 170
 171         /**
 172          * Returns whether the Sone inserter has detected a modification of the
 173          * Sone.
 174          *
 175          * @return {@code true} if the Sone has been modified, {@code false}
 176          *         otherwise
 177          */
 178         public boolean isModified() {
 179                 return soneModificationDetector.isModified();
 180         }
 181
 182         //
 183         // SERVICE METHODS
 184         //
 185
 186         /**
 187          * {@inheritDoc}
 188          */
 189         @Override
 190         protected void serviceRun() {
 191                 while (!shouldStop()) {
 192                         try {
 193                                 /* check every second. */
 194                                 sleep(1000);
 195
 196                                 if (soneModificationDetector.isEligibleForInsert()) {
 197                                         InsertInformation insertInformation = new InsertInformation(sone);
 198                                         logger.log(Level.INFO, String.format("Inserting Sone “%s”…", sone.getName()));
 199
 200                                         boolean success = false;
 201                                         try {
 202                                                 sone.setStatus(SoneStatus.inserting);
 203                                                 long insertTime = currentTimeMillis();
 204                                                 insertInformation.setTime(insertTime);
 205                                                 eventBus.post(new SoneInsertingEvent(sone));
 206                                                 FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri(), insertInformation.generateManifestEntries(), "index.html");
 207                                                 eventBus.post(new SoneInsertedEvent(sone, currentTimeMillis() - insertTime));
 208                                                 /* at this point we might already be stopped. */
 209                                                 if (shouldStop()) {
 210                                                         /* if so, bail out, don’t change anything. */
 211                                                         break;
 212                                                 }
 213                                                 sone.setTime(insertTime);
 214                                                 sone.setLatestEdition(finalUri.getEdition());
 215                                                 core.touchConfiguration();
 216                                                 success = true;
 217                                                 logger.log(Level.INFO, String.format("Inserted Sone “%s” at %s.", sone.getName(), finalUri));
 218                                         } catch (SoneException se1) {
 219                                                 eventBus.post(new SoneInsertAbortedEvent(sone, se1));
 220                                                 logger.log(Level.WARNING, String.format("Could not insert Sone “%s”!", sone.getName()), se1);
 221                                         } finally {
 222                                                 sone.setStatus(SoneStatus.idle);
 223                                         }
 224
 225                                         /*
 226                                          * reset modification counter if Sone has not been modified
 227                                          * while it was inserted.
 228                                          */
 229                                         if (success) {
 230                                                 synchronized (sone) {
 231                                                         if (insertInformation.getFingerprint().equals(sone.getFingerprint())) {
 232                                                                 logger.log(Level.FINE, String.format("Sone “%s” was not modified further, resetting counter…", sone));
 233                                                                 soneModificationDetector.setFingerprint(insertInformation.getFingerprint());
 234                                                                 core.touchConfiguration();
 235                                                         }
 236                                                 }
 237                                         }
 238                                 }
 239                         } catch (Throwable t1) {
 240                                 logger.log(Level.SEVERE, "SoneInserter threw an Exception!", t1);
 241                         }
 242                 }
 243         }
 244
 245         /**
 246          * Container for information that are required to insert a Sone. This
 247          * container merely exists to copy all relevant data without holding a lock
 248          * on the {@link Sone} object for too long.
 249          *
 250          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 251          */
 252         private class InsertInformation {
 253
 254                 private final String fingerprint;
 255
 256                 /** All properties of the Sone, copied for thread safety. */
 257                 private final Map<String, Object> soneProperties = new HashMap<String, Object>();
 258
 259                 /**
 260                  * Creates a new insert information container.
 261                  *
 262                  * @param sone
 263                  *            The sone to insert
 264                  */
 265                 public InsertInformation(Sone sone) {
 266                         this.fingerprint = sone.getFingerprint();
 267                         soneProperties.put("id", sone.getId());
 268                         soneProperties.put("name", sone.getName());
 269                         soneProperties.put("time", sone.getTime());
 270                         soneProperties.put("requestUri", sone.getRequestUri());
 271                         soneProperties.put("insertUri", sone.getInsertUri());
 272                         soneProperties.put("profile", sone.getProfile());
 273                         soneProperties.put("posts", Ordering.from(Post.TIME_COMPARATOR).sortedCopy(sone.getPosts()));
 274                         soneProperties.put("replies", Ordering.from(Reply.TIME_COMPARATOR).reverse().sortedCopy(sone.getReplies()));
 275                         soneProperties.put("likedPostIds", new HashSet<String>(sone.getLikedPostIds()));
 276                         soneProperties.put("likedReplyIds", new HashSet<String>(sone.getLikedReplyIds()));
 277                         soneProperties.put("albums", FluentIterable.from(sone.getRootAlbum().getAlbums()).transformAndConcat(Album.FLATTENER).filter(NOT_EMPTY).toList());
 278                 }
 279
 280                 //
 281                 // ACCESSORS
 282                 //
 283
 284                 private String getFingerprint() {
 285                         return fingerprint;
 286                 }
 287
 288                 /**
 289                  * Returns the insert URI of the Sone.
 290                  *
 291                  * @return The insert URI of the Sone
 292                  */
 293                 public FreenetURI getInsertUri() {
 294                         return (FreenetURI) soneProperties.get("insertUri");
 295                 }
 296
 297                 /**
 298                  * Sets the time of the Sone at the time of the insert.
 299                  *
 300                  * @param time
 301                  *            The time of the Sone
 302                  */
 303                 public void setTime(long time) {
 304                         soneProperties.put("time", time);
 305                 }
 306
 307                 //
 308                 // ACTIONS
 309                 //
 310
 311                 /**
 312                  * Generates all manifest entries required to insert this Sone.
 313                  *
 314                  * @return The manifest entries for the Sone insert
 315                  */
 316                 public HashMap<String, Object> generateManifestEntries() {
 317                         HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
 318
 319                         /* first, create an index.html. */
 320                         manifestEntries.put("index.html", createManifestElement("index.html", "text/html; charset=utf-8", "/templates/insert/index.html"));
 321
 322                         /* now, store the sone. */
 323                         manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml"));
 324
 325                         return manifestEntries;
 326                 }
 327
 328                 //
 329                 // PRIVATE METHODS
 330                 //
 331
 332                 /**
 333                  * Creates a new manifest element.
 334                  *
 335                  * @param name
 336                  *            The name of the file
 337                  * @param contentType
 338                  *            The content type of the file
 339                  * @param templateName
 340                  *            The name of the template to render
 341                  * @return The manifest element
 342                  */
 343                 @SuppressWarnings("synthetic-access")
 344                 private ManifestElement createManifestElement(String name, String contentType, String templateName) {
 345                         InputStreamReader templateInputStreamReader = null;
 346                         InputStream templateInputStream = null;
 347                         Template template;
 348                         try {
 349                                 templateInputStream = getClass().getResourceAsStream(templateName);
 350                                 templateInputStreamReader = new InputStreamReader(templateInputStream, utf8Charset);
 351                                 template = TemplateParser.parse(templateInputStreamReader);
 352                         } catch (TemplateException te1) {
 353                                 logger.log(Level.SEVERE, String.format("Could not parse template “%s”!", templateName), te1);
 354                                 return null;
 355                         } finally {
 356                                 Closer.close(templateInputStreamReader);
 357                                 Closer.close(templateInputStream);
 358                         }
 359
 360                         TemplateContext templateContext = templateContextFactory.createTemplateContext();
 361                         templateContext.set("core", core);
 362                         templateContext.set("currentSone", soneProperties);
 363                         templateContext.set("currentEdition", core.getUpdateChecker().getLatestEdition());
 364                         templateContext.set("version", SonePlugin.VERSION);
 365                         StringWriter writer = new StringWriter();
 366                         StringBucket bucket = null;
 367                         try {
 368                                 template.render(templateContext, writer);
 369                                 bucket = new StringBucket(writer.toString(), utf8Charset);
 370                                 return new ManifestElement(name, bucket, contentType, bucket.size());
 371                         } catch (TemplateException te1) {
 372                                 logger.log(Level.SEVERE, String.format("Could not render template “%s”!", templateName), te1);
 373                                 return null;
 374                         } finally {
 375                                 Closer.close(writer);
 376                                 if (bucket != null) {
 377                                         bucket.free();
 378                                 }
 379                         }
 380                 }
 381
 382         }
 383
 384 }