2 * Sone - SoneInserter.java - Copyright © 2010–2013 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.core;
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;
24 import java.io.InputStreamReader;
25 import java.io.StringWriter;
26 import java.nio.charset.Charset;
27 import java.util.HashMap;
28 import java.util.HashSet;
30 import java.util.concurrent.atomic.AtomicInteger;
31 import java.util.logging.Level;
32 import java.util.logging.Logger;
34 import net.pterodactylus.sone.core.event.SoneInsertAbortedEvent;
35 import net.pterodactylus.sone.core.event.SoneInsertedEvent;
36 import net.pterodactylus.sone.core.event.SoneInsertingEvent;
37 import net.pterodactylus.sone.data.Album;
38 import net.pterodactylus.sone.data.Post;
39 import net.pterodactylus.sone.data.Reply;
40 import net.pterodactylus.sone.data.Sone;
41 import net.pterodactylus.sone.data.Sone.SoneStatus;
42 import net.pterodactylus.sone.freenet.StringBucket;
43 import net.pterodactylus.sone.main.SonePlugin;
44 import net.pterodactylus.util.io.Closer;
45 import net.pterodactylus.util.logging.Logging;
46 import net.pterodactylus.util.service.AbstractService;
47 import net.pterodactylus.util.template.HtmlFilter;
48 import net.pterodactylus.util.template.ReflectionAccessor;
49 import net.pterodactylus.util.template.Template;
50 import net.pterodactylus.util.template.TemplateContext;
51 import net.pterodactylus.util.template.TemplateContextFactory;
52 import net.pterodactylus.util.template.TemplateException;
53 import net.pterodactylus.util.template.TemplateParser;
54 import net.pterodactylus.util.template.XmlFilter;
56 import com.google.common.collect.FluentIterable;
57 import com.google.common.collect.Ordering;
58 import com.google.common.eventbus.EventBus;
60 import freenet.client.async.ManifestElement;
61 import freenet.keys.FreenetURI;
64 * A Sone inserter is responsible for inserting a Sone if it has changed.
66 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
68 public class SoneInserter extends AbstractService {
71 private static final Logger logger = Logging.getLogger(SoneInserter.class);
73 /** The insertion delay (in seconds). */
74 private static final AtomicInteger insertionDelay = new AtomicInteger(60);
76 /** The template factory used to create the templates. */
77 private static final TemplateContextFactory templateContextFactory = new TemplateContextFactory();
80 templateContextFactory.addAccessor(Object.class, new ReflectionAccessor());
81 templateContextFactory.addFilter("xml", new XmlFilter());
82 templateContextFactory.addFilter("html", new HtmlFilter());
85 /** The UTF-8 charset. */
86 private static final Charset utf8Charset = Charset.forName("UTF-8");
89 private final Core core;
92 private final EventBus eventBus;
94 /** The Freenet interface. */
95 private final FreenetInterface freenetInterface;
97 private final SoneModificationDetector soneModificationDetector;
99 /** The Sone to insert. */
100 private volatile Sone sone;
103 * Creates a new Sone inserter.
109 * @param freenetInterface
110 * The freenet interface
114 public SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, Sone sone) {
115 super("Sone Inserter for “" + sone.getName() + "”", false);
117 this.eventBus = eventBus;
118 this.freenetInterface = freenetInterface;
120 this.soneModificationDetector = new SoneModificationDetector(core, sone, insertionDelay);
128 * Sets the Sone to insert.
132 * @return This Sone inserter
134 public SoneInserter setSone(Sone sone) {
135 checkArgument((this.sone == null) || sone.equals(this.sone), "Sone to insert can not be set to a different Sone");
141 * Changes the insertion delay, i.e. the time the Sone inserter waits after it
142 * has noticed a Sone modification before it starts the insert.
144 * @param insertionDelay
145 * The insertion delay (in seconds)
147 public static void setInsertionDelay(int insertionDelay) {
148 SoneInserter.insertionDelay.set(insertionDelay);
152 * Returns the fingerprint of the last insert.
154 * @return The fingerprint of the last insert
156 public String getLastInsertFingerprint() {
157 return soneModificationDetector.getOriginalFingerprint();
161 * Sets the fingerprint of the last insert.
163 * @param lastInsertFingerprint
164 * The fingerprint of the last insert
166 public void setLastInsertFingerprint(String lastInsertFingerprint) {
167 soneModificationDetector.setFingerprint(lastInsertFingerprint);
171 * Returns whether the Sone inserter has detected a modification of the
174 * @return {@code true} if the Sone has been modified, {@code false}
177 public boolean isModified() {
178 return soneModificationDetector.isModified();
189 protected void serviceRun() {
190 while (!shouldStop()) {
192 /* check every second. */
195 if (soneModificationDetector.isEligibleForInsert()) {
196 InsertInformation insertInformation = new InsertInformation(sone);
197 logger.log(Level.INFO, String.format("Inserting Sone “%s”…", sone.getName()));
199 boolean success = false;
201 sone.setStatus(SoneStatus.inserting);
202 long insertTime = currentTimeMillis();
203 insertInformation.setTime(insertTime);
204 eventBus.post(new SoneInsertingEvent(sone));
205 FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri(), insertInformation.generateManifestEntries(), "index.html");
206 eventBus.post(new SoneInsertedEvent(sone, currentTimeMillis() - insertTime));
207 /* at this point we might already be stopped. */
209 /* if so, bail out, don’t change anything. */
212 sone.setTime(insertTime);
213 sone.setLatestEdition(finalUri.getEdition());
214 core.touchConfiguration();
216 logger.log(Level.INFO, String.format("Inserted Sone “%s” at %s.", sone.getName(), finalUri));
217 } catch (SoneException se1) {
218 eventBus.post(new SoneInsertAbortedEvent(sone, se1));
219 logger.log(Level.WARNING, String.format("Could not insert Sone “%s”!", sone.getName()), se1);
221 sone.setStatus(SoneStatus.idle);
225 * reset modification counter if Sone has not been modified
226 * while it was inserted.
229 synchronized (sone) {
230 if (insertInformation.getFingerprint().equals(sone.getFingerprint())) {
231 logger.log(Level.FINE, String.format("Sone “%s” was not modified further, resetting counter…", sone));
232 soneModificationDetector.setFingerprint(insertInformation.getFingerprint());
233 core.touchConfiguration();
238 } catch (Throwable t1) {
239 logger.log(Level.SEVERE, "SoneInserter threw an Exception!", t1);
245 * Container for information that are required to insert a Sone. This
246 * container merely exists to copy all relevant data without holding a lock
247 * on the {@link Sone} object for too long.
249 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
251 private class InsertInformation {
253 private final String fingerprint;
255 /** All properties of the Sone, copied for thread safety. */
256 private final Map<String, Object> soneProperties = new HashMap<String, Object>();
259 * Creates a new insert information container.
264 public InsertInformation(Sone sone) {
265 this.fingerprint = sone.getFingerprint();
266 soneProperties.put("id", sone.getId());
267 soneProperties.put("name", sone.getName());
268 soneProperties.put("time", sone.getTime());
269 soneProperties.put("requestUri", sone.getRequestUri());
270 soneProperties.put("insertUri", sone.getInsertUri());
271 soneProperties.put("profile", sone.getProfile());
272 soneProperties.put("posts", Ordering.from(Post.TIME_COMPARATOR).sortedCopy(sone.getPosts()));
273 soneProperties.put("replies", Ordering.from(Reply.TIME_COMPARATOR).reverse().sortedCopy(sone.getReplies()));
274 soneProperties.put("likedPostIds", new HashSet<String>(sone.getLikedPostIds()));
275 soneProperties.put("likedReplyIds", new HashSet<String>(sone.getLikedReplyIds()));
276 soneProperties.put("albums", FluentIterable.from(sone.getRootAlbum().getAlbums()).transformAndConcat(Album.FLATTENER).filter(NOT_EMPTY).toList());
283 private String getFingerprint() {
288 * Returns the insert URI of the Sone.
290 * @return The insert URI of the Sone
292 public FreenetURI getInsertUri() {
293 return (FreenetURI) soneProperties.get("insertUri");
297 * Sets the time of the Sone at the time of the insert.
300 * The time of the Sone
302 public void setTime(long time) {
303 soneProperties.put("time", time);
311 * Generates all manifest entries required to insert this Sone.
313 * @return The manifest entries for the Sone insert
315 public HashMap<String, Object> generateManifestEntries() {
316 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
318 /* first, create an index.html. */
319 manifestEntries.put("index.html", createManifestElement("index.html", "text/html; charset=utf-8", "/templates/insert/index.html"));
321 /* now, store the sone. */
322 manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml"));
324 return manifestEntries;
332 * Creates a new manifest element.
335 * The name of the file
337 * The content type of the file
338 * @param templateName
339 * The name of the template to render
340 * @return The manifest element
342 @SuppressWarnings("synthetic-access")
343 private ManifestElement createManifestElement(String name, String contentType, String templateName) {
344 InputStreamReader templateInputStreamReader = null;
347 templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset);
348 template = TemplateParser.parse(templateInputStreamReader);
349 } catch (TemplateException te1) {
350 logger.log(Level.SEVERE, String.format("Could not parse template “%s”!", templateName), te1);
353 Closer.close(templateInputStreamReader);
356 TemplateContext templateContext = templateContextFactory.createTemplateContext();
357 templateContext.set("core", core);
358 templateContext.set("currentSone", soneProperties);
359 templateContext.set("currentEdition", core.getUpdateChecker().getLatestEdition());
360 templateContext.set("version", SonePlugin.VERSION);
361 StringWriter writer = new StringWriter();
362 StringBucket bucket = null;
364 template.render(templateContext, writer);
365 bucket = new StringBucket(writer.toString(), utf8Charset);
366 return new ManifestElement(name, bucket, contentType, bucket.size());
367 } catch (TemplateException te1) {
368 logger.log(Level.SEVERE, String.format("Could not render template “%s”!", templateName), te1);
371 Closer.close(writer);
372 if (bucket != null) {