/* * 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 * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ package net.pterodactylus.sone.core; import static java.lang.String.format; 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.SoneModificationDetector.LockableFingerprintProvider; 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; 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.annotations.VisibleForTesting; 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 freenet.client.async.ManifestElement; import freenet.keys.FreenetURI; /** * A Sone inserter is responsible for inserting a Sone if it has changed. * * @author David ‘Bombe’ Roden */ public class SoneInserter extends AbstractService { /** The logger. */ private static final Logger logger = Logging.getLogger(SoneInserter.class); /** The insertion delay (in seconds). */ private static final AtomicInteger insertionDelay = new AtomicInteger(60); /** The template factory used to create the templates. */ private static final TemplateContextFactory templateContextFactory = new TemplateContextFactory(); static { 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 event bus. */ private final EventBus eventBus; /** The Freenet interface. */ private final FreenetInterface freenetInterface; private final SoneModificationDetector soneModificationDetector; private final long delay; private final String soneId; /** * Creates a new Sone inserter. * * @param core * The core * @param eventBus * The event bus * @param freenetInterface * The freenet interface * @param soneId * The ID of the Sone to insert */ 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.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. * * @param insertionDelay * The insertion delay (in seconds) */ public static void setInsertionDelay(int insertionDelay) { SoneInserter.insertionDelay.set(insertionDelay); } /** * Returns the fingerprint of the last insert. * * @return The fingerprint of the last insert */ public String getLastInsertFingerprint() { return soneModificationDetector.getOriginalFingerprint(); } /** * Sets the fingerprint of the last insert. * * @param lastInsertFingerprint * The fingerprint of the last insert */ public void setLastInsertFingerprint(String lastInsertFingerprint) { soneModificationDetector.setFingerprint(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 soneModificationDetector.isModified(); } // // SERVICE METHODS // /** * {@inheritDoc} */ @Override protected void serviceRun() { while (!shouldStop()) { try { /* 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; } 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 = currentTimeMillis(); eventBus.post(new SoneInsertingEvent(sone)); FreenetURI finalUri = freenetInterface.insertDirectory(sone.getInsertUri(), insertInformation.generateManifestEntries(), "index.html"); eventBus.post(new SoneInsertedEvent(sone, 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 (insertInformation.getFingerprint().equals(sone.getFingerprint())) { logger.log(Level.FINE, String.format("Sone “%s” was not modified further, resetting counter…", sone)); soneModificationDetector.setFingerprint(insertInformation.getFingerprint()); core.touchConfiguration(); } } } } } catch (Throwable t1) { logger.log(Level.SEVERE, "SoneInserter threw an Exception!", t1); } } } static class SetInsertionDelay implements OptionWatcher { @Override public void optionChanged(Option 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 * on the {@link Sone} object for too long. * * @author David ‘Bombe’ Roden */ @VisibleForTesting class InsertInformation { private final String fingerprint; /** All properties of the Sone, copied for thread safety. */ private final Map soneProperties = new HashMap(); /** * Creates a new insert information container. * * @param sone * The sone to insert */ public InsertInformation(Sone sone) { this.fingerprint = sone.getFingerprint(); soneProperties.put("id", sone.getId()); soneProperties.put("name", sone.getName()); soneProperties.put("time", currentTimeMillis()); soneProperties.put("requestUri", sone.getRequestUri()); 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", FluentIterable.from(sone.getRootAlbum().getAlbums()).transformAndConcat(Album.FLATTENER).filter(NOT_EMPTY).toList()); } // // ACCESSORS // @VisibleForTesting String getFingerprint() { return fingerprint; } // // ACTIONS // /** * Generates all manifest entries required to insert this Sone. * * @return The manifest entries for the Sone insert */ public HashMap generateManifestEntries() { 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")); /* now, store the sone. */ manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml")); return manifestEntries; } // // PRIVATE METHODS // /** * 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) { InputStreamReader templateInputStreamReader = null; InputStream templateInputStream = null; Template template; try { 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(); 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(templateContext, writer); bucket = new StringBucket(writer.toString(), utf8Charset); 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(); } } } } }