Add plugins to template factory.
[Sone.git] / src / main / java / net / pterodactylus / sone / core / SoneInserter.java
1 /*
2  * FreenetSone - SoneInserter.java - Copyright © 2010 David Roden
3  *
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.
8  *
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.
13  *
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/>.
16  */
17
18 package net.pterodactylus.sone.core;
19
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;
27 import java.util.Map;
28 import java.util.Set;
29 import java.util.logging.Level;
30 import java.util.logging.Logger;
31
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;
49
50 /**
51  * A Sone inserter is responsible for inserting a Sone if it has changed.
52  *
53  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
54  */
55 public class SoneInserter extends AbstractService {
56
57         /** The logger. */
58         private static final Logger logger = Logging.getLogger(SoneInserter.class);
59
60         /** The template factory used to create the templates. */
61         private static final DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
62
63         static {
64                 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
65                 templateFactory.addFilter("xml", new XmlFilter());
66         }
67
68         /** The UTF-8 charset. */
69         private static final Charset utf8Charset = Charset.forName("UTF-8");
70
71         /** The core. */
72         private final Core core;
73
74         /** The Freenet interface. */
75         private final FreenetInterface freenetInterface;
76
77         /** The Sone to insert. */
78         private final Sone sone;
79
80         /**
81          * Creates a new Sone inserter.
82          *
83          * @param core
84          *            The core
85          * @param freenetInterface
86          *            The freenet interface
87          * @param sone
88          *            The Sone to insert
89          */
90         public SoneInserter(Core core, FreenetInterface freenetInterface, Sone sone) {
91                 super("Sone Inserter for “" + sone.getName() + "”", false);
92                 this.core = core;
93                 this.freenetInterface = freenetInterface;
94                 this.sone = sone;
95         }
96
97         //
98         // SERVICE METHODS
99         //
100
101         /**
102          * {@inheritDoc}
103          */
104         @Override
105         protected void serviceRun() {
106                 long modificationCounter = 0;
107                 boolean restartNow = true;
108                 while (!shouldStop()) {
109                         if (!restartNow) {
110                                 logger.log(Level.FINEST, "Waiting 60 seconds before checking Sone “" + sone.getName() + "”.");
111                                 sleep(60 * 1000);
112                         }
113                         restartNow = false;
114                         InsertInformation insertInformation = null;
115                         synchronized (sone) {
116                                 modificationCounter = sone.getModificationCounter();
117                                 if (modificationCounter > 0) {
118                                         sone.setTime(System.currentTimeMillis());
119                                         insertInformation = new InsertInformation(sone);
120                                 }
121                         }
122                         if (insertInformation != null) {
123                                 logger.log(Level.INFO, "Inserting Sone “%s”…", new Object[] { sone.getName() });
124
125                                 boolean success = false;
126                                 try {
127                                         core.setSoneStatus(sone, SoneStatus.inserting);
128                                         FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri().setKeyType("USK").setDocName("Sone-" + sone.getName()).setSuggestedEdition(0), insertInformation.generateManifestEntries(), "index.html");
129                                         sone.updateUris(finalUri);
130                                         success = true;
131                                         logger.log(Level.INFO, "Inserted Sone “%s” at %s.", new Object[] { sone.getName(), finalUri });
132                                 } catch (SoneException se1) {
133                                         logger.log(Level.WARNING, "Could not insert Sone “" + sone.getName() + "”!", se1);
134                                 } finally {
135                                         core.setSoneStatus(sone, SoneStatus.idle);
136                                 }
137
138                                 /*
139                                  * reset modification counter if Sone has not been modified
140                                  * while it was inserted.
141                                  */
142                                 if (success) {
143                                         synchronized (sone) {
144                                                 if (sone.getModificationCounter() == modificationCounter) {
145                                                         logger.log(Level.FINE, "Sone “%s” was not modified further, resetting counter…", new Object[] { sone });
146                                                         sone.setModificationCounter(0);
147                                                 } else {
148                                                         logger.log(Level.FINE, "Sone “%s” was modified since the insert started, starting another insert…", new Object[] { sone });
149                                                         restartNow = true;
150                                                 }
151                                         }
152                                 }
153                         }
154                 }
155         }
156
157         /**
158          * Container for information that are required to insert a Sone. This
159          * container merely exists to copy all relevant data without holding a lock
160          * on the {@link Sone} object for too long.
161          *
162          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
163          */
164         private class InsertInformation {
165
166                 /** All properties of the Sone, copied for thread safety. */
167                 private final Map<String, Object> soneProperties = new HashMap<String, Object>();
168
169                 /**
170                  * Creates a new insert information container.
171                  *
172                  * @param sone
173                  *            The sone to insert
174                  */
175                 public InsertInformation(Sone sone) {
176                         soneProperties.put("id", sone.getId());
177                         soneProperties.put("name", sone.getName());
178                         soneProperties.put("time", sone.getTime());
179                         soneProperties.put("requestUri", sone.getRequestUri());
180                         soneProperties.put("insertUri", sone.getInsertUri());
181                         soneProperties.put("profile", sone.getProfile());
182                         soneProperties.put("posts", new ArrayList<Post>(sone.getPosts()));
183                         soneProperties.put("replies", new HashSet<Reply>(sone.getReplies()));
184                         soneProperties.put("friends", new HashSet<Sone>(sone.getFriends()));
185                         soneProperties.put("blockedSoneIds", new HashSet<String>(sone.getBlockedSoneIds()));
186                 }
187
188                 //
189                 // ACCESSORS
190                 //
191
192                 /**
193                  * Returns the insert URI of the Sone.
194                  *
195                  * @return The insert URI of the Sone
196                  */
197                 public FreenetURI getInsertUri() {
198                         return (FreenetURI) soneProperties.get("insertUri");
199                 }
200
201                 //
202                 // ACTIONS
203                 //
204
205                 /**
206                  * Generates all manifest entries required to insert this Sone.
207                  *
208                  * @return The manifest entries for the Sone insert
209                  */
210                 public HashMap<String, Object> generateManifestEntries() {
211                         HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
212
213                         /* first, create an index.html. */
214                         manifestEntries.put("index.html", createManifestElement("index.html", "text/html; charset=utf-8", "/templates/insert/index.html"));
215
216                         /* now, store the sone. */
217                         manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml"));
218
219                         return manifestEntries;
220                 }
221
222                 //
223                 // PRIVATE METHODS
224                 //
225
226                 /**
227                  * Creates a new manifest element.
228                  *
229                  * @param name
230                  *            The name of the file
231                  * @param contentType
232                  *            The content type of the file
233                  * @param templateName
234                  *            The name of the template to render
235                  * @return The manifest element
236                  */
237                 @SuppressWarnings("synthetic-access")
238                 private ManifestElement createManifestElement(String name, String contentType, String templateName) {
239                         InputStreamReader templateInputStreamReader;
240                         Template template = templateFactory.createTemplate(templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset));
241                         try {
242                                 template.parse();
243                         } catch (TemplateException te1) {
244                                 logger.log(Level.SEVERE, "Could not parse template “" + templateName + "”!", te1);
245                                 return null;
246                         } finally {
247                                 Closer.close(templateInputStreamReader);
248                         }
249                         @SuppressWarnings("unchecked")
250                         final Set<String> blockedSoneIds = (Set<String>) soneProperties.get("blockedSoneIds");
251                         Collection<Sone> knownSones = Filters.filteredCollection(core.getKnownSones(), new Filter<Sone>() {
252
253                                 /**
254                                  * {@inheritDoc}
255                                  */
256                                 @Override
257                                 public boolean filterObject(Sone object) {
258                                         return !blockedSoneIds.contains(object.getId()) && !object.getId().equals(soneProperties.get("id"));
259                                 }
260                         });
261
262                         template.set("currentSone", soneProperties);
263                         template.set("knownSones", knownSones);
264                         StringWriter writer = new StringWriter();
265                         StringBucket bucket = null;
266                         try {
267                                 template.render(writer);
268                                 bucket = new StringBucket(writer.toString(), utf8Charset);
269                                 return new ManifestElement(name, bucket, contentType, bucket.size());
270                         } catch (TemplateException te1) {
271                                 logger.log(Level.SEVERE, "Could not render template “" + templateName + "”!", te1);
272                                 return null;
273                         } finally {
274                                 Closer.close(writer);
275                                 if (bucket != null) {
276                                         bucket.free();
277                                 }
278                         }
279                 }
280
281         }
282
283 }