2 * FreenetSone - SoneInserter.java - Copyright © 2010 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 java.io.InputStreamReader;
21 import java.io.StringWriter;
22 import java.nio.charset.Charset;
23 import java.util.HashMap;
24 import java.util.logging.Level;
25 import java.util.logging.Logger;
27 import net.pterodactylus.sone.data.Sone;
28 import net.pterodactylus.sone.freenet.StringBucket;
29 import net.pterodactylus.util.logging.Logging;
30 import net.pterodactylus.util.service.AbstractService;
31 import net.pterodactylus.util.template.DefaultTemplateFactory;
32 import net.pterodactylus.util.template.ReflectionAccessor;
33 import net.pterodactylus.util.template.Template;
34 import freenet.client.async.ManifestElement;
35 import freenet.keys.FreenetURI;
38 * A Sone inserter is responsible for inserting a Sone if it has changed.
40 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
42 public class SoneInserter extends AbstractService {
45 private static final Logger logger = Logging.getLogger(SoneInserter.class);
47 /** The template factory used to create the templates. */
48 private static final DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
51 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
54 /** The UTF-8 charset. */
55 private static final Charset utf8Charset = Charset.forName("UTF-8");
57 /** The Freenet interface. */
58 private final FreenetInterface freenetInterface;
60 /** The Sone to insert. */
61 private final Sone sone;
64 * Creates a new Sone inserter.
66 * @param freenetInterface
67 * The freenet interface
71 public SoneInserter(FreenetInterface freenetInterface, Sone sone) {
72 super("Sone Inserter for “" + sone.getName() + "”");
73 this.freenetInterface = freenetInterface;
85 protected void serviceRun() {
86 long modificationCounter = 0;
87 while (!shouldStop()) {
88 InsertInformation insertInformation = null;
90 modificationCounter = sone.getModificationCounter();
91 if (modificationCounter > 0) {
92 insertInformation = new InsertInformation(sone.getRequestUri(), sone.getInsertUri());
95 if (insertInformation != null) {
96 logger.log(Level.INFO, "Inserting Sone “%s”…", new Object[] { sone.getName() });
98 boolean success = false;
100 FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri().setKeyType("USK").setDocName("Sone-" + sone.getName()).setSuggestedEdition(0), insertInformation.generateManifestEntries(), "index.html");
102 logger.log(Level.INFO, "Inserted Sone “%s” at %s.", new Object[] { sone.getName(), finalUri });
103 } catch (SoneException se1) {
104 logger.log(Level.WARNING, "Could not insert Sone “" + sone.getName() + "”!", se1);
108 * reset modification counter if Sone has not been modified
109 * while it was inserted.
112 synchronized (sone) {
113 if (sone.getModificationCounter() == modificationCounter) {
114 sone.setModificationCounter(0);
119 logger.log(Level.FINEST, "Waiting 60 seconds before checking Sone “" + sone.getName() + "” again.");
125 * Container for information that are required to insert a Sone. This
126 * container merely exists to copy all relevant data without holding a lock
127 * on the {@link Sone} object for too long.
129 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
131 private class InsertInformation {
133 /** The request URI of the Sone. */
134 private final FreenetURI requestUri;
136 /** The insert URI of the Sone. */
137 private final FreenetURI insertUri;
140 * Creates a new insert information container.
143 * The request URI of the Sone
145 * The insert URI of the Sone
147 public InsertInformation(FreenetURI requestUri, FreenetURI insertUri) {
148 this.requestUri = requestUri;
149 this.insertUri = insertUri;
157 * Returns the request URI of the Sone.
159 * @return The request URI of the Sone
161 @SuppressWarnings("unused")
162 public FreenetURI getRequestUri() {
167 * Returns the insert URI of the Sone.
169 * @return The insert URI of the Sone
171 public FreenetURI getInsertUri() {
180 * Generates all manifest entries required to insert this Sone.
182 * @return The manifest entries for the Sone insert
184 public HashMap<String, Object> generateManifestEntries() {
185 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
187 /* first, create an index.html. */
188 manifestEntries.put("index.html", createManifestElement("index.html", "text/html; charset=utf-8", "/templates/insert/index.html"));
190 /* now, store the sone. */
191 manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml"));
193 return manifestEntries;
201 * Creates a new manifest element.
204 * The name of the file
206 * The content type of the file
207 * @param templateName
208 * The name of the template to render
209 * @return The manifest element
211 @SuppressWarnings("synthetic-access")
212 private ManifestElement createManifestElement(String name, String contentType, String templateName) {
213 Template template = templateFactory.createTemplate(new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset));
214 template.set("currentSone", sone);
215 StringWriter writer = new StringWriter();
216 template.render(writer);
217 StringBucket bucket = new StringBucket(writer.toString(), utf8Charset);
218 return new ManifestElement(name, bucket, contentType, bucket.size());