X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fcore%2FSoneInserter.java;h=9f1f164819ea516bdc67b9922084b05bbeada4b3;hp=e8c828cb640b3aa588344bfb212e0bf12f85f3c9;hb=2b47186b72e30460a6710f95a76e4a99c305909a;hpb=7615a45cbc702122ab8bfe8d6a5c4932b90c4427 diff --git a/src/main/java/net/pterodactylus/sone/core/SoneInserter.java b/src/main/java/net/pterodactylus/sone/core/SoneInserter.java index e8c828c..9f1f164 100644 --- a/src/main/java/net/pterodactylus/sone/core/SoneInserter.java +++ b/src/main/java/net/pterodactylus/sone/core/SoneInserter.java @@ -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 @@ -17,33 +17,52 @@ 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.ArrayList; -import java.util.Collection; import java.util.HashMap; import java.util.HashSet; import java.util.Map; -import java.util.Set; +import java.util.concurrent.atomic.AtomicInteger; import java.util.logging.Level; import java.util.logging.Logger; -import net.pterodactylus.sone.core.Core.SoneStatus; +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.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.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; @@ -57,12 +76,16 @@ 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 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. */ @@ -71,27 +94,109 @@ 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 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 sone - * The Sone to insert + * @param soneId + * The ID of the Sone to insert */ - public SoneInserter(Core core, FreenetInterface freenetInterface, Sone sone) { - super("Sone Inserter for “" + sone.getName() + "”"); + 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.sone = sone; + 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(); } // @@ -103,57 +208,74 @@ 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); - } - restartNow = false; - InsertInformation insertInformation = null; - synchronized (sone) { - modificationCounter = sone.getModificationCounter(); - if (modificationCounter > 0) { - sone.setTime(System.currentTimeMillis()); - insertInformation = new InsertInformation(sone); - } - } - 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").setDocName("Sone-" + sone.getName()).setSuggestedEdition(0), insertInformation.generateManifestEntries(), "index.html"); - sone.updateUris(finalUri); - 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); - } + 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 (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; + /* + * 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 @@ -161,7 +283,10 @@ public class SoneInserter extends AbstractService { * * @author David ‘Bombe’ Roden */ - private class InsertInformation { + @VisibleForTesting + class InsertInformation { + + private final String fingerprint; /** All properties of the Sone, copied for thread safety. */ private final Map soneProperties = new HashMap(); @@ -173,29 +298,26 @@ public class SoneInserter extends AbstractService { * 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", sone.getTime()); + soneProperties.put("time", currentTimeMillis()); soneProperties.put("requestUri", sone.getRequestUri()); - soneProperties.put("insertUri", sone.getInsertUri()); soneProperties.put("profile", sone.getProfile()); - soneProperties.put("posts", new ArrayList(sone.getPosts())); - soneProperties.put("replies", new HashSet(sone.getReplies())); - soneProperties.put("friends", new HashSet(sone.getFriends())); - soneProperties.put("blockedSoneIds", new HashSet(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(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 // - /** - * Returns the insert URI of the Sone. - * - * @return The insert URI of the Sone - */ - public FreenetURI getInsertUri() { - return (FreenetURI) soneProperties.get("insertUri"); + @VisibleForTesting + String getFingerprint() { + return fingerprint; } // @@ -236,39 +358,34 @@ 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; + InputStream templateInputStream = null; + Template template; try { - template.parse(); + templateInputStream = getClass().getResourceAsStream(templateName); + templateInputStreamReader = new InputStreamReader(templateInputStream, 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); + Closer.close(templateInputStream); } - @SuppressWarnings("unchecked") - final Set blockedSoneIds = (Set) soneProperties.get("blockedSoneIds"); - Collection knownSones = Filters.filteredCollection(core.getKnownSones(), new Filter() { - - /** - * {@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);