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.Collection;
24 import java.util.HashMap;
25 import java.util.logging.Level;
26 import java.util.logging.Logger;
28 import net.pterodactylus.sone.data.Sone;
29 import net.pterodactylus.sone.freenet.StringBucket;
30 import net.pterodactylus.util.filter.Filter;
31 import net.pterodactylus.util.filter.Filters;
32 import net.pterodactylus.util.io.Closer;
33 import net.pterodactylus.util.logging.Logging;
34 import net.pterodactylus.util.service.AbstractService;
35 import net.pterodactylus.util.template.DefaultTemplateFactory;
36 import net.pterodactylus.util.template.ReflectionAccessor;
37 import net.pterodactylus.util.template.Template;
38 import net.pterodactylus.util.template.TemplateException;
39 import net.pterodactylus.util.template.XmlFilter;
40 import freenet.client.async.ManifestElement;
41 import freenet.keys.FreenetURI;
44 * A Sone inserter is responsible for inserting a Sone if it has changed.
46 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
48 public class SoneInserter extends AbstractService {
51 private static final Logger logger = Logging.getLogger(SoneInserter.class);
53 /** The template factory used to create the templates. */
54 private static final DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
57 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
58 templateFactory.addFilter("xml", new XmlFilter());
61 /** The UTF-8 charset. */
62 private static final Charset utf8Charset = Charset.forName("UTF-8");
65 private final Core core;
67 /** The Freenet interface. */
68 private final FreenetInterface freenetInterface;
70 /** The Sone to insert. */
71 private final Sone sone;
74 * Creates a new Sone inserter.
78 * @param freenetInterface
79 * The freenet interface
83 public SoneInserter(Core core, FreenetInterface freenetInterface, Sone sone) {
84 super("Sone Inserter for “" + sone.getName() + "”");
86 this.freenetInterface = freenetInterface;
98 protected void serviceRun() {
99 long modificationCounter = 0;
100 boolean restartNow = true;
101 while (!shouldStop()) {
103 logger.log(Level.FINEST, "Waiting 60 seconds before checking Sone “" + sone.getName() + "”.");
107 InsertInformation insertInformation = null;
108 synchronized (sone) {
109 modificationCounter = sone.getModificationCounter();
110 if (modificationCounter > 0) {
111 sone.setTime(System.currentTimeMillis());
112 insertInformation = new InsertInformation(sone.getRequestUri(), sone.getInsertUri());
115 if (insertInformation != null) {
116 logger.log(Level.INFO, "Inserting Sone “%s”…", new Object[] { sone.getName() });
118 boolean success = false;
120 FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri().setKeyType("USK").setDocName("Sone-" + sone.getName()).setSuggestedEdition(0), insertInformation.generateManifestEntries(), "index.html");
121 sone.updateUris(finalUri);
123 logger.log(Level.INFO, "Inserted Sone “%s” at %s.", new Object[] { sone.getName(), finalUri });
124 } catch (SoneException se1) {
125 logger.log(Level.WARNING, "Could not insert Sone “" + sone.getName() + "”!", se1);
129 * reset modification counter if Sone has not been modified
130 * while it was inserted.
133 synchronized (sone) {
134 if (sone.getModificationCounter() == modificationCounter) {
135 logger.log(Level.FINE, "Sone “%s” was not modified further, resetting counter…", new Object[] { sone });
136 sone.setModificationCounter(0);
138 logger.log(Level.FINE, "Sone “%s” was modified since the insert started, starting another insert…", new Object[] { sone });
148 * Container for information that are required to insert a Sone. This
149 * container merely exists to copy all relevant data without holding a lock
150 * on the {@link Sone} object for too long.
152 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
154 private class InsertInformation {
156 /** The request URI of the Sone. */
157 private final FreenetURI requestUri;
159 /** The insert URI of the Sone. */
160 private final FreenetURI insertUri;
163 * Creates a new insert information container.
166 * The request URI of the Sone
168 * The insert URI of the Sone
170 public InsertInformation(FreenetURI requestUri, FreenetURI insertUri) {
171 this.requestUri = requestUri;
172 this.insertUri = insertUri;
180 * Returns the request URI of the Sone.
182 * @return The request URI of the Sone
184 @SuppressWarnings("unused")
185 public FreenetURI getRequestUri() {
190 * Returns the insert URI of the Sone.
192 * @return The insert URI of the Sone
194 public FreenetURI getInsertUri() {
203 * Generates all manifest entries required to insert this Sone.
205 * @return The manifest entries for the Sone insert
207 public HashMap<String, Object> generateManifestEntries() {
208 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
210 /* first, create an index.html. */
211 manifestEntries.put("index.html", createManifestElement("index.html", "text/html; charset=utf-8", "/templates/insert/index.html"));
213 /* now, store the sone. */
214 manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml"));
216 return manifestEntries;
224 * Creates a new manifest element.
227 * The name of the file
229 * The content type of the file
230 * @param templateName
231 * The name of the template to render
232 * @return The manifest element
234 @SuppressWarnings("synthetic-access")
235 private ManifestElement createManifestElement(String name, String contentType, String templateName) {
236 InputStreamReader templateInputStreamReader;
237 Template template = templateFactory.createTemplate(templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset));
240 } catch (TemplateException te1) {
241 logger.log(Level.SEVERE, "Could not parse template “" + templateName + "”!", te1);
244 Closer.close(templateInputStreamReader);
246 Collection<Sone> knownSones = Filters.filteredCollection(core.getKnownSones(), new Filter<Sone>() {
252 public boolean filterObject(Sone object) {
253 return !sone.isSoneBlocked(object.getId()) && !object.equals(sone);
257 template.set("currentSone", sone);
258 template.set("knownSones", knownSones);
259 StringWriter writer = new StringWriter();
260 StringBucket bucket = null;
262 template.render(writer);
263 bucket = new StringBucket(writer.toString(), utf8Charset);
264 return new ManifestElement(name, bucket, contentType, bucket.size());
265 } catch (TemplateException te1) {
266 logger.log(Level.SEVERE, "Could not render template “" + templateName + "”!", te1);
269 Closer.close(writer);
270 if (bucket != null) {