X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fcore%2FSoneInserter.java;h=0abebc3a1556e8710f69c145cfbd8a525239af4c;hp=afd406f657ba37ed5f007cae1b8c17dcea815af8;hb=64740709990291688170ebd1f192af5eb9090618;hpb=2a49578518a57b76c7b6eb8c438d664c57b19819 diff --git a/src/main/java/net/pterodactylus/sone/core/SoneInserter.java b/src/main/java/net/pterodactylus/sone/core/SoneInserter.java index afd406f..fcbe1b5 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–2020 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,61 +17,192 @@ package net.pterodactylus.sone.core; -import java.io.InputStreamReader; -import java.io.StringWriter; +import static java.lang.String.format; +import static java.lang.System.currentTimeMillis; +import static java.util.concurrent.TimeUnit.*; +import static java.util.logging.Logger.getLogger; +import static java.util.stream.Collectors.toList; +import static net.pterodactylus.sone.data.PostKt.newestPostFirst; +import static net.pterodactylus.sone.data.ReplyKt.newestReplyFirst; + +import java.io.*; import java.nio.charset.Charset; 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 com.codahale.metrics.*; +import com.google.common.base.*; +import net.pterodactylus.sone.core.SoneModificationDetector.LockableFingerprintProvider; +import net.pterodactylus.sone.core.event.InsertionDelayChangedEvent; +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.AlbumKt; import net.pterodactylus.sone.data.Sone; -import net.pterodactylus.sone.freenet.StringBucket; -import net.pterodactylus.util.logging.Logging; +import net.pterodactylus.sone.data.Sone.SoneStatus; +import net.pterodactylus.sone.data.SoneKt; +import net.pterodactylus.sone.main.SonePlugin; 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 freenet.client.async.ManifestElement; +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.collect.Ordering; +import com.google.common.eventbus.EventBus; +import com.google.common.eventbus.Subscribe; + import freenet.keys.FreenetURI; +import freenet.support.api.Bucket; +import freenet.support.api.ManifestElement; +import freenet.support.api.RandomAccessBucket; +import freenet.support.io.ArrayBucket; /** * 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); + private static final Logger logger = getLogger(SoneInserter.class.getName()); + + /** 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()); + 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; - /** The Sone to insert. */ - private final Sone sone; + private final SoneModificationDetector soneModificationDetector; + private final SoneUriCreator soneUriCreator; + private final long delay; + private final String soneId; + private final Histogram soneInsertDurationHistogram; + private final Meter soneInsertErrorMeter; /** * 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(FreenetInterface freenetInterface, Sone sone) { - super("Sone Inserter for “" + sone.getName() + "”"); + public SoneInserter(final Core core, EventBus eventBus, FreenetInterface freenetInterface, MetricRegistry metricRegistry, SoneUriCreator soneUriCreator, final String soneId) { + this(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, soneId, new SoneModificationDetector(new LockableFingerprintProvider() { + @Override + public boolean isLocked() { + Sone sone = core.getSone(soneId); + if (sone == null) { + return false; + } + return core.isLocked(sone); + } + + @Override + public String getFingerprint() { + Sone sone = core.getSone(soneId); + if (sone == null) { + return null; + } + return sone.getFingerprint(); + } + }, insertionDelay), 1000); + } + + @VisibleForTesting + SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, MetricRegistry metricRegistry, SoneUriCreator soneUriCreator, 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.soneInsertDurationHistogram = metricRegistry.histogram("sone.insert.duration", () -> new Histogram(new ExponentiallyDecayingReservoir(3000, 0))); + this.soneInsertErrorMeter = metricRegistry.meter("sone.insert.errors"); + this.soneUriCreator = soneUriCreator; + 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) + */ + private 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.getLastInsertFingerprint(); + } + + /** + * 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(); } // @@ -83,93 +214,115 @@ public class SoneInserter extends AbstractService { */ @Override protected void serviceRun() { - long modificationCounter = 0; while (!shouldStop()) { - InsertInformation insertInformation = null; - synchronized (sone) { - modificationCounter = sone.getModificationCounter(); - if (modificationCounter > 0) { - insertInformation = new InsertInformation(sone.getRequestUri(), sone.getInsertUri()); - } - } - if (insertInformation != null) { - logger.log(Level.INFO, "Inserting Sone “%s”…", new Object[] { sone.getName() }); - - boolean success = false; - try { - FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri().setKeyType("USK").setDocName("Sone-" + sone.getName()).setSuggestedEdition(0), insertInformation.generateManifestEntries(), "index.html"); - 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); - } + try { + /* check every second. */ + sleep(delay); + + if (soneModificationDetector.isEligibleForInsert()) { + Sone sone = core.getSone(soneId); + if (sone == null) { + logger.log(Level.WARNING, format("Sone %s has disappeared, exiting inserter.", soneId)); + return; + } + 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)); + Stopwatch stopwatch = Stopwatch.createStarted(); + FreenetURI finalUri = freenetInterface.insertDirectory(soneUriCreator.getInsertUri(sone), insertInformation.generateManifestEntries(), "index.html"); + stopwatch.stop(); + soneInsertDurationHistogram.update(stopwatch.elapsed(MICROSECONDS)); + eventBus.post(new SoneInsertedEvent(sone, stopwatch.elapsed(MILLISECONDS), insertInformation.getFingerprint())); + /* 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) { + soneInsertErrorMeter.mark(); + eventBus.post(new SoneInsertAbortedEvent(sone, se1)); + logger.log(Level.WARNING, String.format("Could not insert Sone “%s”!", sone.getName()), se1); + } finally { + insertInformation.close(); + 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) { - sone.setModificationCounter(0); + /* + * 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); } - logger.log(Level.FINEST, "Waiting 60 seconds before checking Sone “" + sone.getName() + "” again."); - sleep(60 * 1000); } } + @Subscribe + public void insertionDelayChanged(InsertionDelayChangedEvent insertionDelayChangedEvent) { + setInsertionDelay(insertionDelayChangedEvent.getInsertionDelay()); + } + /** * 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 */ - private class InsertInformation { + @VisibleForTesting + class InsertInformation implements Closeable { - /** 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 soneProperties = new HashMap<>(); + private final String fingerprint; + private final ManifestCreator manifestCreator; /** * 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) { + this.fingerprint = sone.getFingerprint(); + Map soneProperties = new HashMap<>(); + soneProperties.put("id", sone.getId()); + soneProperties.put("name", sone.getName()); + soneProperties.put("time", currentTimeMillis()); + soneProperties.put("profile", sone.getProfile()); + soneProperties.put("posts", Ordering.from(newestPostFirst()).sortedCopy(sone.getPosts())); + soneProperties.put("replies", Ordering.from(newestReplyFirst()).sortedCopy(sone.getReplies())); + soneProperties.put("likedPostIds", new HashSet<>(sone.getLikedPostIds())); + soneProperties.put("likedReplyIds", new HashSet<>(sone.getLikedReplyIds())); + soneProperties.put("albums", SoneKt.getAllAlbums(sone).stream().filter(AlbumKt.notEmpty()::invoke).collect(toList())); + manifestCreator = new ManifestCreator(core, soneProperties); } // // ACCESSORS // - /** - * Returns the request URI of the Sone. - * - * @return The request URI of the Sone - */ - @SuppressWarnings("unused") - public FreenetURI getRequestUri() { - return requestUri; - } - - /** - * Returns the insert URI of the Sone. - * - * @return The insert URI of the Sone - */ - public FreenetURI getInsertUri() { - return insertUri; + @VisibleForTesting + String getFingerprint() { + return fingerprint; } // @@ -182,37 +335,73 @@ public class SoneInserter extends AbstractService { * @return The manifest entries for the Sone insert */ public HashMap generateManifestEntries() { - HashMap manifestEntries = new HashMap(); + 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")); + manifestEntries.put("index.html", manifestCreator.createManifestElement( + "index.html", "text/html; charset=utf-8", + "/templates/insert/index.html")); + + /* now, store the sone. */ + manifestEntries.put("sone.xml", manifestCreator.createManifestElement( + "sone.xml", "text/xml; charset=utf-8", + "/templates/insert/sone.xml")); return manifestEntries; } - // - // PRIVATE METHODS - // + @Override + public void close() { + manifestCreator.close(); + } - /** - * 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) { - Template template = templateFactory.createTemplate(new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset)); - template.set("currentSone", sone); - StringWriter writer = new StringWriter(); - template.render(writer); - StringBucket bucket = new StringBucket(writer.toString(), utf8Charset); - return new ManifestElement(name, bucket, contentType, bucket.size()); + } + + /** + * Creates manifest elements for an insert by rendering a template. + */ + @VisibleForTesting + static class ManifestCreator implements Closeable { + + private final Core core; + private final Map soneProperties; + private final Set buckets = new HashSet<>(); + + ManifestCreator(Core core, Map soneProperties) { + this.core = core; + this.soneProperties = soneProperties; + } + + public ManifestElement createManifestElement(String name, String contentType, String templateName) { + Template template; + try (InputStream templateInputStream = getClass().getResourceAsStream(templateName); + InputStreamReader templateInputStreamReader = new InputStreamReader(templateInputStream, utf8Charset)) { + template = TemplateParser.parse(templateInputStreamReader); + } catch (IOException | TemplateException e1) { + logger.log(Level.SEVERE, String.format("Could not parse template “%s”!", templateName), e1); + return null; + } + + TemplateContext templateContext = templateContextFactory.createTemplateContext(); + templateContext.set("core", core); + templateContext.set("currentSone", soneProperties); + templateContext.set("currentEdition", core.getUpdateChecker().getLatestEdition()); + templateContext.set("version", SonePlugin.getPluginVersion()); + try (StringWriter writer = new StringWriter()) { + template.render(templateContext, writer); + RandomAccessBucket bucket = new ArrayBucket(writer.toString().getBytes(Charsets.UTF_8)); + buckets.add(bucket); + return new ManifestElement(name, bucket, contentType, bucket.size()); + } catch (IOException | TemplateException e1) { + logger.log(Level.SEVERE, String.format("Could not render template “%s”!", templateName), e1); + return null; + } + } + + public void close() { + for (Bucket bucket : buckets) { + bucket.free(); + } } }