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.ArrayList;
24 import java.util.Collection;
25 import java.util.HashMap;
26 import java.util.HashSet;
29 import java.util.logging.Level;
30 import java.util.logging.Logger;
32 import net.pterodactylus.sone.core.Core.SoneStatus;
33 import net.pterodactylus.sone.data.Post;
34 import net.pterodactylus.sone.data.Reply;
35 import net.pterodactylus.sone.data.Sone;
36 import net.pterodactylus.sone.freenet.StringBucket;
37 import net.pterodactylus.util.filter.Filter;
38 import net.pterodactylus.util.filter.Filters;
39 import net.pterodactylus.util.io.Closer;
40 import net.pterodactylus.util.logging.Logging;
41 import net.pterodactylus.util.service.AbstractService;
42 import net.pterodactylus.util.template.DefaultTemplateFactory;
43 import net.pterodactylus.util.template.ReflectionAccessor;
44 import net.pterodactylus.util.template.Template;
45 import net.pterodactylus.util.template.TemplateException;
46 import net.pterodactylus.util.template.XmlFilter;
47 import freenet.client.async.ManifestElement;
48 import freenet.keys.FreenetURI;
51 * A Sone inserter is responsible for inserting a Sone if it has changed.
53 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
55 public class SoneInserter extends AbstractService {
58 private static final Logger logger = Logging.getLogger(SoneInserter.class);
60 /** The template factory used to create the templates. */
61 private static final DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
64 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
65 templateFactory.addFilter("xml", new XmlFilter());
68 /** The UTF-8 charset. */
69 private static final Charset utf8Charset = Charset.forName("UTF-8");
72 private final Core core;
74 /** The Freenet interface. */
75 private final FreenetInterface freenetInterface;
77 /** The Sone to insert. */
78 private final Sone sone;
81 * Creates a new Sone inserter.
85 * @param freenetInterface
86 * The freenet interface
90 public SoneInserter(Core core, FreenetInterface freenetInterface, Sone sone) {
91 super("Sone Inserter for “" + sone.getName() + "”", false);
93 this.freenetInterface = freenetInterface;
105 protected void serviceRun() {
106 long modificationCounter = 0;
107 long lastModificationTime = 0;
108 while (!shouldStop()) {
109 /* check every seconds. */
112 InsertInformation insertInformation = null;
113 synchronized (sone) {
114 if (sone.getModificationCounter() > modificationCounter) {
115 modificationCounter = sone.getModificationCounter();
116 lastModificationTime = System.currentTimeMillis();
117 sone.setTime(lastModificationTime);
118 logger.log(Level.FINE, "Sone %s has been modified, waiting 60 seconds before inserting.", new Object[] { sone.getName() });
120 if ((lastModificationTime > 0) && ((System.currentTimeMillis() - lastModificationTime) > (60 * 1000))) {
121 insertInformation = new InsertInformation(sone);
125 if (insertInformation != null) {
126 logger.log(Level.INFO, "Inserting Sone “%s”…", new Object[] { sone.getName() });
128 boolean success = false;
130 core.setSoneStatus(sone, SoneStatus.inserting);
131 FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri().setKeyType("USK").setSuggestedEdition(0), insertInformation.generateManifestEntries(), "index.html");
132 sone.updateUris(finalUri);
134 logger.log(Level.INFO, "Inserted Sone “%s” at %s.", new Object[] { sone.getName(), finalUri });
135 } catch (SoneException se1) {
136 logger.log(Level.WARNING, "Could not insert Sone “" + sone.getName() + "”!", se1);
138 core.setSoneStatus(sone, SoneStatus.idle);
142 * reset modification counter if Sone has not been modified
143 * while it was inserted.
146 synchronized (sone) {
147 if (sone.getModificationCounter() == modificationCounter) {
148 logger.log(Level.FINE, "Sone “%s” was not modified further, resetting counter…", new Object[] { sone });
149 sone.setModificationCounter(0);
150 modificationCounter = 0;
151 lastModificationTime = 0;
160 * Container for information that are required to insert a Sone. This
161 * container merely exists to copy all relevant data without holding a lock
162 * on the {@link Sone} object for too long.
164 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
166 private class InsertInformation {
168 /** All properties of the Sone, copied for thread safety. */
169 private final Map<String, Object> soneProperties = new HashMap<String, Object>();
172 * Creates a new insert information container.
177 public InsertInformation(Sone sone) {
178 soneProperties.put("id", sone.getId());
179 soneProperties.put("name", sone.getName());
180 soneProperties.put("time", sone.getTime());
181 soneProperties.put("requestUri", sone.getRequestUri());
182 soneProperties.put("insertUri", sone.getInsertUri());
183 soneProperties.put("profile", sone.getProfile());
184 soneProperties.put("posts", new ArrayList<Post>(sone.getPosts()));
185 soneProperties.put("replies", new HashSet<Reply>(sone.getReplies()));
186 soneProperties.put("blockedSoneIds", new HashSet<String>(sone.getBlockedSoneIds()));
187 soneProperties.put("likedPostIds", new HashSet<String>(sone.getLikedPostIds()));
188 soneProperties.put("likeReplyIds", new HashSet<String>(sone.getLikedReplyIds()));
196 * Returns the insert URI of the Sone.
198 * @return The insert URI of the Sone
200 public FreenetURI getInsertUri() {
201 return (FreenetURI) soneProperties.get("insertUri");
209 * Generates all manifest entries required to insert this Sone.
211 * @return The manifest entries for the Sone insert
213 public HashMap<String, Object> generateManifestEntries() {
214 HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
216 /* first, create an index.html. */
217 manifestEntries.put("index.html", createManifestElement("index.html", "text/html; charset=utf-8", "/templates/insert/index.html"));
219 /* now, store the sone. */
220 manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml"));
222 return manifestEntries;
230 * Creates a new manifest element.
233 * The name of the file
235 * The content type of the file
236 * @param templateName
237 * The name of the template to render
238 * @return The manifest element
240 @SuppressWarnings("synthetic-access")
241 private ManifestElement createManifestElement(String name, String contentType, String templateName) {
242 InputStreamReader templateInputStreamReader;
243 Template template = templateFactory.createTemplate(templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset));
246 } catch (TemplateException te1) {
247 logger.log(Level.SEVERE, "Could not parse template “" + templateName + "”!", te1);
250 Closer.close(templateInputStreamReader);
252 @SuppressWarnings("unchecked")
253 final Set<String> blockedSoneIds = (Set<String>) soneProperties.get("blockedSoneIds");
254 Collection<Sone> knownSones = Filters.filteredCollection(core.getKnownSones(), new Filter<Sone>() {
260 public boolean filterObject(Sone object) {
261 return !blockedSoneIds.contains(object.getId()) && !object.getId().equals(soneProperties.get("id"));
265 template.set("currentSone", soneProperties);
266 template.set("knownSones", knownSones);
267 StringWriter writer = new StringWriter();
268 StringBucket bucket = null;
270 template.render(writer);
271 bucket = new StringBucket(writer.toString(), utf8Charset);
272 return new ManifestElement(name, bucket, contentType, bucket.size());
273 } catch (TemplateException te1) {
274 logger.log(Level.SEVERE, "Could not render template “" + templateName + "”!", te1);
277 Closer.close(writer);
278 if (bucket != null) {