2 * Sone - WebInterface.java - Copyright © 2010–2012 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.web;
20 import java.io.IOException;
21 import java.io.InputStream;
22 import java.io.InputStreamReader;
23 import java.io.Reader;
24 import java.io.StringReader;
25 import java.io.UnsupportedEncodingException;
26 import java.util.ArrayList;
27 import java.util.Collection;
28 import java.util.Collections;
29 import java.util.HashMap;
30 import java.util.HashSet;
31 import java.util.List;
34 import java.util.UUID;
35 import java.util.logging.Level;
36 import java.util.logging.Logger;
38 import net.pterodactylus.sone.core.Core;
39 import net.pterodactylus.sone.core.CoreListener;
40 import net.pterodactylus.sone.data.Album;
41 import net.pterodactylus.sone.data.Image;
42 import net.pterodactylus.sone.data.Post;
43 import net.pterodactylus.sone.data.PostReply;
44 import net.pterodactylus.sone.data.Profile;
45 import net.pterodactylus.sone.data.Reply;
46 import net.pterodactylus.sone.data.Sone;
47 import net.pterodactylus.sone.freenet.L10nFilter;
48 import net.pterodactylus.sone.freenet.wot.Identity;
49 import net.pterodactylus.sone.freenet.wot.Trust;
50 import net.pterodactylus.sone.main.SonePlugin;
51 import net.pterodactylus.sone.notify.ListNotification;
52 import net.pterodactylus.sone.template.AlbumAccessor;
53 import net.pterodactylus.sone.template.CollectionAccessor;
54 import net.pterodactylus.sone.template.CssClassNameFilter;
55 import net.pterodactylus.sone.template.HttpRequestAccessor;
56 import net.pterodactylus.sone.template.IdentityAccessor;
57 import net.pterodactylus.sone.template.ImageAccessor;
58 import net.pterodactylus.sone.template.ImageLinkFilter;
59 import net.pterodactylus.sone.template.JavascriptFilter;
60 import net.pterodactylus.sone.template.ParserFilter;
61 import net.pterodactylus.sone.template.PostAccessor;
62 import net.pterodactylus.sone.template.ProfileAccessor;
63 import net.pterodactylus.sone.template.ReplyAccessor;
64 import net.pterodactylus.sone.template.ReplyGroupFilter;
65 import net.pterodactylus.sone.template.RequestChangeFilter;
66 import net.pterodactylus.sone.template.SoneAccessor;
67 import net.pterodactylus.sone.template.SubstringFilter;
68 import net.pterodactylus.sone.template.TrustAccessor;
69 import net.pterodactylus.sone.template.UniqueElementFilter;
70 import net.pterodactylus.sone.template.UnknownDateFilter;
71 import net.pterodactylus.sone.text.Part;
72 import net.pterodactylus.sone.text.SonePart;
73 import net.pterodactylus.sone.text.SoneTextParser;
74 import net.pterodactylus.sone.web.ajax.BookmarkAjaxPage;
75 import net.pterodactylus.sone.web.ajax.CreatePostAjaxPage;
76 import net.pterodactylus.sone.web.ajax.CreateReplyAjaxPage;
77 import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
78 import net.pterodactylus.sone.web.ajax.DeleteProfileFieldAjaxPage;
79 import net.pterodactylus.sone.web.ajax.DeleteReplyAjaxPage;
80 import net.pterodactylus.sone.web.ajax.DismissNotificationAjaxPage;
81 import net.pterodactylus.sone.web.ajax.DistrustAjaxPage;
82 import net.pterodactylus.sone.web.ajax.EditAlbumAjaxPage;
83 import net.pterodactylus.sone.web.ajax.EditImageAjaxPage;
84 import net.pterodactylus.sone.web.ajax.EditProfileFieldAjaxPage;
85 import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
86 import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
87 import net.pterodactylus.sone.web.ajax.GetNotificationsAjaxPage;
88 import net.pterodactylus.sone.web.ajax.GetPostAjaxPage;
89 import net.pterodactylus.sone.web.ajax.GetReplyAjaxPage;
90 import net.pterodactylus.sone.web.ajax.GetStatusAjaxPage;
91 import net.pterodactylus.sone.web.ajax.GetTimesAjaxPage;
92 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
93 import net.pterodactylus.sone.web.ajax.LikeAjaxPage;
94 import net.pterodactylus.sone.web.ajax.LockSoneAjaxPage;
95 import net.pterodactylus.sone.web.ajax.MarkAsKnownAjaxPage;
96 import net.pterodactylus.sone.web.ajax.MoveProfileFieldAjaxPage;
97 import net.pterodactylus.sone.web.ajax.TrustAjaxPage;
98 import net.pterodactylus.sone.web.ajax.UnbookmarkAjaxPage;
99 import net.pterodactylus.sone.web.ajax.UnfollowSoneAjaxPage;
100 import net.pterodactylus.sone.web.ajax.UnlikeAjaxPage;
101 import net.pterodactylus.sone.web.ajax.UnlockSoneAjaxPage;
102 import net.pterodactylus.sone.web.ajax.UntrustAjaxPage;
103 import net.pterodactylus.sone.web.page.FreenetRequest;
104 import net.pterodactylus.sone.web.page.PageToadlet;
105 import net.pterodactylus.sone.web.page.PageToadletFactory;
106 import net.pterodactylus.util.cache.Cache;
107 import net.pterodactylus.util.cache.CacheException;
108 import net.pterodactylus.util.cache.CacheItem;
109 import net.pterodactylus.util.cache.DefaultCacheItem;
110 import net.pterodactylus.util.cache.MemoryCache;
111 import net.pterodactylus.util.cache.ValueRetriever;
112 import net.pterodactylus.util.collection.SetBuilder;
113 import net.pterodactylus.util.filter.Filters;
114 import net.pterodactylus.util.logging.Logging;
115 import net.pterodactylus.util.notify.Notification;
116 import net.pterodactylus.util.notify.NotificationManager;
117 import net.pterodactylus.util.notify.TemplateNotification;
118 import net.pterodactylus.util.template.CollectionSortFilter;
119 import net.pterodactylus.util.template.ContainsFilter;
120 import net.pterodactylus.util.template.DateFilter;
121 import net.pterodactylus.util.template.FormatFilter;
122 import net.pterodactylus.util.template.HtmlFilter;
123 import net.pterodactylus.util.template.MatchFilter;
124 import net.pterodactylus.util.template.ModFilter;
125 import net.pterodactylus.util.template.Provider;
126 import net.pterodactylus.util.template.ReflectionAccessor;
127 import net.pterodactylus.util.template.ReplaceFilter;
128 import net.pterodactylus.util.template.StoreFilter;
129 import net.pterodactylus.util.template.Template;
130 import net.pterodactylus.util.template.TemplateContext;
131 import net.pterodactylus.util.template.TemplateContextFactory;
132 import net.pterodactylus.util.template.TemplateException;
133 import net.pterodactylus.util.template.TemplateParser;
134 import net.pterodactylus.util.template.XmlFilter;
135 import net.pterodactylus.util.thread.Ticker;
136 import net.pterodactylus.util.version.Version;
137 import net.pterodactylus.util.web.RedirectPage;
138 import net.pterodactylus.util.web.StaticPage;
139 import net.pterodactylus.util.web.TemplatePage;
140 import freenet.clients.http.SessionManager;
141 import freenet.clients.http.SessionManager.Session;
142 import freenet.clients.http.ToadletContainer;
143 import freenet.clients.http.ToadletContext;
144 import freenet.l10n.BaseL10n;
145 import freenet.support.api.HTTPRequest;
148 * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
149 * references to l10n helpers.
151 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
153 public class WebInterface implements CoreListener {
156 private static final Logger logger = Logging.getLogger(WebInterface.class);
158 /** The notification manager. */
159 private final NotificationManager notificationManager = new NotificationManager();
161 /** The Sone plugin. */
162 private final SonePlugin sonePlugin;
164 /** The registered toadlets. */
165 private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
167 /** The form password. */
168 private final String formPassword;
170 /** The template context factory. */
171 private final TemplateContextFactory templateContextFactory;
173 /** The Sone text parser. */
174 private final SoneTextParser soneTextParser;
176 /** The parser filter. */
177 private final ParserFilter parserFilter;
179 /** The “new Sone” notification. */
180 private final ListNotification<Sone> newSoneNotification;
182 /** The “new post” notification. */
183 private final ListNotification<Post> newPostNotification;
185 /** The “new reply” notification. */
186 private final ListNotification<PostReply> newReplyNotification;
188 /** The invisible “local post” notification. */
189 private final ListNotification<Post> localPostNotification;
191 /** The invisible “local reply” notification. */
192 private final ListNotification<PostReply> localReplyNotification;
194 /** The “you have been mentioned” notification. */
195 private final ListNotification<Post> mentionNotification;
197 /** Notifications for sone inserts. */
198 private final Map<Sone, TemplateNotification> soneInsertNotifications = new HashMap<Sone, TemplateNotification>();
200 /** Sone locked notification ticker objects. */
201 private final Map<Sone, Object> lockedSonesTickerObjects = Collections.synchronizedMap(new HashMap<Sone, Object>());
203 /** The “Sone locked” notification. */
204 private final ListNotification<Sone> lockedSonesNotification;
206 /** The “new version” notification. */
207 private final TemplateNotification newVersionNotification;
209 /** The “inserting images” notification. */
210 private final ListNotification<Image> insertingImagesNotification;
212 /** The “inserted images” notification. */
213 private final ListNotification<Image> insertedImagesNotification;
215 /** The “image insert failed” notification. */
216 private final ListNotification<Image> imageInsertFailedNotification;
219 * Creates a new web interface.
224 @SuppressWarnings("synthetic-access")
225 public WebInterface(SonePlugin sonePlugin) {
226 this.sonePlugin = sonePlugin;
227 formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
228 soneTextParser = new SoneTextParser(getCore(), getCore());
230 templateContextFactory = new TemplateContextFactory();
231 templateContextFactory.addAccessor(Object.class, new ReflectionAccessor());
232 templateContextFactory.addAccessor(Collection.class, new CollectionAccessor());
233 templateContextFactory.addAccessor(Sone.class, new SoneAccessor(getCore()));
234 templateContextFactory.addAccessor(Post.class, new PostAccessor(getCore()));
235 templateContextFactory.addAccessor(Reply.class, new ReplyAccessor(getCore()));
236 templateContextFactory.addAccessor(Album.class, new AlbumAccessor());
237 templateContextFactory.addAccessor(Image.class, new ImageAccessor());
238 templateContextFactory.addAccessor(Identity.class, new IdentityAccessor(getCore()));
239 templateContextFactory.addAccessor(Trust.class, new TrustAccessor());
240 templateContextFactory.addAccessor(HTTPRequest.class, new HttpRequestAccessor());
241 templateContextFactory.addAccessor(Profile.class, new ProfileAccessor(getCore()));
242 templateContextFactory.addFilter("date", new DateFilter());
243 templateContextFactory.addFilter("html", new HtmlFilter());
244 templateContextFactory.addFilter("replace", new ReplaceFilter());
245 templateContextFactory.addFilter("store", new StoreFilter());
246 templateContextFactory.addFilter("l10n", new L10nFilter(this));
247 templateContextFactory.addFilter("substring", new SubstringFilter());
248 templateContextFactory.addFilter("xml", new XmlFilter());
249 templateContextFactory.addFilter("change", new RequestChangeFilter());
250 templateContextFactory.addFilter("match", new MatchFilter());
251 templateContextFactory.addFilter("css", new CssClassNameFilter());
252 templateContextFactory.addFilter("js", new JavascriptFilter());
253 templateContextFactory.addFilter("parse", parserFilter = new ParserFilter(getCore(), templateContextFactory, soneTextParser));
254 templateContextFactory.addFilter("unknown", new UnknownDateFilter(getL10n(), "View.Sone.Text.UnknownDate"));
255 templateContextFactory.addFilter("format", new FormatFilter());
256 templateContextFactory.addFilter("sort", new CollectionSortFilter());
257 templateContextFactory.addFilter("image-link", new ImageLinkFilter(getCore(), templateContextFactory));
258 templateContextFactory.addFilter("replyGroup", new ReplyGroupFilter());
259 templateContextFactory.addFilter("in", new ContainsFilter());
260 templateContextFactory.addFilter("unique", new UniqueElementFilter());
261 templateContextFactory.addFilter("mod", new ModFilter());
262 templateContextFactory.addProvider(Provider.TEMPLATE_CONTEXT_PROVIDER);
263 templateContextFactory.addProvider(new ClassPathTemplateProvider());
264 templateContextFactory.addTemplateObject("webInterface", this);
265 templateContextFactory.addTemplateObject("formPassword", formPassword);
267 /* create notifications. */
268 Template newSoneNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newSoneNotification.html"));
269 newSoneNotification = new ListNotification<Sone>("new-sone-notification", "sones", newSoneNotificationTemplate, false);
271 Template newPostNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newPostNotification.html"));
272 newPostNotification = new ListNotification<Post>("new-post-notification", "posts", newPostNotificationTemplate, false);
274 Template localPostNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newPostNotification.html"));
275 localPostNotification = new ListNotification<Post>("local-post-notification", "posts", localPostNotificationTemplate, false);
277 Template newReplyNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newReplyNotification.html"));
278 newReplyNotification = new ListNotification<PostReply>("new-reply-notification", "replies", newReplyNotificationTemplate, false);
280 Template localReplyNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newReplyNotification.html"));
281 localReplyNotification = new ListNotification<PostReply>("local-reply-notification", "replies", localReplyNotificationTemplate, false);
283 Template mentionNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/mentionNotification.html"));
284 mentionNotification = new ListNotification<Post>("mention-notification", "posts", mentionNotificationTemplate, false);
286 Template lockedSonesTemplate = TemplateParser.parse(createReader("/templates/notify/lockedSonesNotification.html"));
287 lockedSonesNotification = new ListNotification<Sone>("sones-locked-notification", "sones", lockedSonesTemplate);
289 Template newVersionTemplate = TemplateParser.parse(createReader("/templates/notify/newVersionNotification.html"));
290 newVersionNotification = new TemplateNotification("new-version-notification", newVersionTemplate);
292 Template insertingImagesTemplate = TemplateParser.parse(createReader("/templates/notify/inserting-images-notification.html"));
293 insertingImagesNotification = new ListNotification<Image>("inserting-images-notification", "images", insertingImagesTemplate);
295 Template insertedImagesTemplate = TemplateParser.parse(createReader("/templates/notify/inserted-images-notification.html"));
296 insertedImagesNotification = new ListNotification<Image>("inserted-images-notification", "images", insertedImagesTemplate);
298 Template imageInsertFailedTemplate = TemplateParser.parse(createReader("/templates/notify/image-insert-failed-notification.html"));
299 imageInsertFailedNotification = new ListNotification<Image>("image-insert-failed-notification", "images", imageInsertFailedTemplate);
307 * Returns the Sone core used by the Sone plugin.
309 * @return The Sone core
311 public Core getCore() {
312 return sonePlugin.core();
316 * Returns the template context factory of the web interface.
318 * @return The template context factory
320 public TemplateContextFactory getTemplateContextFactory() {
321 return templateContextFactory;
325 * Returns the current session, creating a new session if there is no
328 * @param toadletContenxt
329 * The toadlet context
330 * @return The current session, or {@code null} if there is no current
333 public Session getCurrentSession(ToadletContext toadletContenxt) {
334 return getCurrentSession(toadletContenxt, true);
338 * Returns the current session, creating a new session if there is no
339 * current session and {@code create} is {@code true}.
341 * @param toadletContenxt
342 * The toadlet context
344 * {@code true} to create a new session if there is no current
345 * session, {@code false} otherwise
346 * @return The current session, or {@code null} if there is no current
349 public Session getCurrentSession(ToadletContext toadletContenxt, boolean create) {
350 Session session = getSessionManager().useSession(toadletContenxt);
351 if (create && (session == null)) {
352 session = getSessionManager().createSession(UUID.randomUUID().toString(), toadletContenxt);
358 * Returns the currently logged in Sone.
360 * @param toadletContext
361 * The toadlet context
362 * @return The currently logged in Sone, or {@code null} if no Sone is
363 * currently logged in
365 public Sone getCurrentSone(ToadletContext toadletContext) {
366 return getCurrentSone(toadletContext, true);
370 * Returns the currently logged in Sone.
372 * @param toadletContext
373 * The toadlet context
375 * {@code true} to create a new session if no session exists,
376 * {@code false} to not create a new session
377 * @return The currently logged in Sone, or {@code null} if no Sone is
378 * currently logged in
380 public Sone getCurrentSone(ToadletContext toadletContext, boolean create) {
381 Set<Sone> localSones = getCore().getLocalSones();
382 if (localSones.size() == 1) {
383 return localSones.iterator().next();
385 return getCurrentSone(getCurrentSession(toadletContext, create));
389 * Returns the currently logged in Sone.
393 * @return The currently logged in Sone, or {@code null} if no Sone is
394 * currently logged in
396 public Sone getCurrentSone(Session session) {
397 if (session == null) {
400 String soneId = (String) session.getAttribute("Sone.CurrentSone");
401 if (soneId == null) {
404 return getCore().getLocalSone(soneId, false);
408 * Sets the currently logged in Sone.
410 * @param toadletContext
411 * The toadlet context
413 * The Sone to set as currently logged in
415 public void setCurrentSone(ToadletContext toadletContext, Sone sone) {
416 Session session = getCurrentSession(toadletContext);
418 session.removeAttribute("Sone.CurrentSone");
420 session.setAttribute("Sone.CurrentSone", sone.getId());
425 * Returns the notification manager.
427 * @return The notification manager
429 public NotificationManager getNotifications() {
430 return notificationManager;
434 * Returns the l10n helper of the node.
436 * @return The node’s l10n helper
438 public BaseL10n getL10n() {
439 return sonePlugin.l10n().getBase();
443 * Returns the session manager of the node.
445 * @return The node’s session manager
447 public SessionManager getSessionManager() {
448 return sonePlugin.pluginRespirator().getSessionManager("Sone");
452 * Returns the node’s form password.
454 * @return The form password
456 public String getFormPassword() {
461 * Returns the posts that have been announced as new in the
462 * {@link #newPostNotification}.
464 * @return The new posts
466 public Set<Post> getNewPosts() {
467 return new SetBuilder<Post>().addAll(newPostNotification.getElements()).addAll(localPostNotification.getElements()).get();
471 * Returns the replies that have been announced as new in the
472 * {@link #newReplyNotification}.
474 * @return The new replies
476 public Set<PostReply> getNewReplies() {
477 return new SetBuilder<PostReply>().addAll(newReplyNotification.getElements()).addAll(localReplyNotification.getElements()).get();
481 * Sets whether the current start of the plugin is the first start. It is
482 * considered a first start if the configuration file does not exist.
485 * {@code true} if no configuration file existed when Sone was
486 * loaded, {@code false} otherwise
488 public void setFirstStart(boolean firstStart) {
490 Template firstStartNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/firstStartNotification.html"));
491 Notification firstStartNotification = new TemplateNotification("first-start-notification", firstStartNotificationTemplate);
492 notificationManager.addNotification(firstStartNotification);
497 * Sets whether Sone was started with a fresh configuration file.
500 * {@code true} if Sone was started with a fresh configuration,
501 * {@code false} if the existing configuration could be read
503 public void setNewConfig(boolean newConfig) {
504 if (newConfig && !hasFirstStartNotification()) {
505 Template configNotReadNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/configNotReadNotification.html"));
506 Notification configNotReadNotification = new TemplateNotification("config-not-read-notification", configNotReadNotificationTemplate);
507 notificationManager.addNotification(configNotReadNotification);
516 * Returns whether the first start notification is currently displayed.
518 * @return {@code true} if the first-start notification is currently
519 * displayed, {@code false} otherwise
521 private boolean hasFirstStartNotification() {
522 return notificationManager.getNotification("first-start-notification") != null;
530 * Starts the web interface and registers all toadlets.
532 public void start() {
535 /* notification templates. */
536 Template startupNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/startupNotification.html"));
538 final TemplateNotification startupNotification = new TemplateNotification("startup-notification", startupNotificationTemplate);
539 notificationManager.addNotification(startupNotification);
541 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (120 * 1000), new Runnable() {
545 startupNotification.dismiss();
547 }, "Sone Startup Notification Remover");
549 Template wotMissingNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/wotMissingNotification.html"));
550 final TemplateNotification wotMissingNotification = new TemplateNotification("wot-missing-notification", wotMissingNotificationTemplate);
551 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (15 * 1000), new Runnable() {
554 @SuppressWarnings("synthetic-access")
556 if (getCore().getIdentityManager().isConnected()) {
557 wotMissingNotification.dismiss();
559 notificationManager.addNotification(wotMissingNotification);
561 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (15 * 1000), this, "Sone WoT Connector Checker");
564 }, "Sone WoT Connector Checker");
568 * Stops the web interface and unregisters all toadlets.
571 unregisterToadlets();
572 Ticker.getInstance().stop();
580 * Register all toadlets.
582 private void registerToadlets() {
583 Template emptyTemplate = TemplateParser.parse(new StringReader(""));
584 Template loginTemplate = TemplateParser.parse(createReader("/templates/login.html"));
585 Template indexTemplate = TemplateParser.parse(createReader("/templates/index.html"));
586 Template newTemplate = TemplateParser.parse(createReader("/templates/new.html"));
587 Template knownSonesTemplate = TemplateParser.parse(createReader("/templates/knownSones.html"));
588 Template createSoneTemplate = TemplateParser.parse(createReader("/templates/createSone.html"));
589 Template createPostTemplate = TemplateParser.parse(createReader("/templates/createPost.html"));
590 Template createReplyTemplate = TemplateParser.parse(createReader("/templates/createReply.html"));
591 Template bookmarksTemplate = TemplateParser.parse(createReader("/templates/bookmarks.html"));
592 Template searchTemplate = TemplateParser.parse(createReader("/templates/search.html"));
593 Template editProfileTemplate = TemplateParser.parse(createReader("/templates/editProfile.html"));
594 Template editProfileFieldTemplate = TemplateParser.parse(createReader("/templates/editProfileField.html"));
595 Template deleteProfileFieldTemplate = TemplateParser.parse(createReader("/templates/deleteProfileField.html"));
596 Template viewSoneTemplate = TemplateParser.parse(createReader("/templates/viewSone.html"));
597 Template viewPostTemplate = TemplateParser.parse(createReader("/templates/viewPost.html"));
598 Template deletePostTemplate = TemplateParser.parse(createReader("/templates/deletePost.html"));
599 Template deleteReplyTemplate = TemplateParser.parse(createReader("/templates/deleteReply.html"));
600 Template deleteSoneTemplate = TemplateParser.parse(createReader("/templates/deleteSone.html"));
601 Template imageBrowserTemplate = TemplateParser.parse(createReader("/templates/imageBrowser.html"));
602 Template createAlbumTemplate = TemplateParser.parse(createReader("/templates/createAlbum.html"));
603 Template deleteAlbumTemplate = TemplateParser.parse(createReader("/templates/deleteAlbum.html"));
604 Template deleteImageTemplate = TemplateParser.parse(createReader("/templates/deleteImage.html"));
605 Template noPermissionTemplate = TemplateParser.parse(createReader("/templates/noPermission.html"));
606 Template optionsTemplate = TemplateParser.parse(createReader("/templates/options.html"));
607 Template rescueTemplate = TemplateParser.parse(createReader("/templates/rescue.html"));
608 Template aboutTemplate = TemplateParser.parse(createReader("/templates/about.html"));
609 Template invalidTemplate = TemplateParser.parse(createReader("/templates/invalid.html"));
610 Template postTemplate = TemplateParser.parse(createReader("/templates/include/viewPost.html"));
611 Template replyTemplate = TemplateParser.parse(createReader("/templates/include/viewReply.html"));
612 Template openSearchTemplate = TemplateParser.parse(createReader("/templates/xml/OpenSearch.xml"));
614 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
615 pageToadlets.add(pageToadletFactory.createPageToadlet(new RedirectPage<FreenetRequest>("", "index.html")));
616 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
617 pageToadlets.add(pageToadletFactory.createPageToadlet(new NewPage(newTemplate, this), "New"));
618 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
619 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
620 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
621 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfileFieldPage(editProfileFieldTemplate, this)));
622 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteProfileFieldPage(deleteProfileFieldTemplate, this)));
623 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
624 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
625 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
626 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
627 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikePage(emptyTemplate, this)));
628 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikePage(emptyTemplate, this)));
629 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
630 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
631 pageToadlets.add(pageToadletFactory.createPageToadlet(new LockSonePage(emptyTemplate, this)));
632 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlockSonePage(emptyTemplate, this)));
633 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(emptyTemplate, this)));
634 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(emptyTemplate, this)));
635 pageToadlets.add(pageToadletFactory.createPageToadlet(new ImageBrowserPage(imageBrowserTemplate, this), "ImageBrowser"));
636 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateAlbumPage(createAlbumTemplate, this)));
637 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditAlbumPage(emptyTemplate, this)));
638 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteAlbumPage(deleteAlbumTemplate, this)));
639 pageToadlets.add(pageToadletFactory.createPageToadlet(new UploadImagePage(invalidTemplate, this)));
640 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditImagePage(emptyTemplate, this)));
641 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteImagePage(deleteImageTemplate, this)));
642 pageToadlets.add(pageToadletFactory.createPageToadlet(new TrustPage(emptyTemplate, this)));
643 pageToadlets.add(pageToadletFactory.createPageToadlet(new DistrustPage(emptyTemplate, this)));
644 pageToadlets.add(pageToadletFactory.createPageToadlet(new UntrustPage(emptyTemplate, this)));
645 pageToadlets.add(pageToadletFactory.createPageToadlet(new MarkAsKnownPage(emptyTemplate, this)));
646 pageToadlets.add(pageToadletFactory.createPageToadlet(new BookmarkPage(emptyTemplate, this)));
647 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnbookmarkPage(emptyTemplate, this)));
648 pageToadlets.add(pageToadletFactory.createPageToadlet(new BookmarksPage(bookmarksTemplate, this), "Bookmarks"));
649 pageToadlets.add(pageToadletFactory.createPageToadlet(new SearchPage(searchTemplate, this)));
650 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
651 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
652 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(emptyTemplate, this), "Logout"));
653 pageToadlets.add(pageToadletFactory.createPageToadlet(new OptionsPage(optionsTemplate, this), "Options"));
654 pageToadlets.add(pageToadletFactory.createPageToadlet(new RescuePage(rescueTemplate, this), "Rescue"));
655 pageToadlets.add(pageToadletFactory.createPageToadlet(new AboutPage(aboutTemplate, this, SonePlugin.VERSION), "About"));
656 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
657 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationPage(emptyTemplate, this)));
658 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("invalid.html", invalidTemplate, "Page.Invalid.Title", this)));
659 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage<FreenetRequest>("css/", "/static/css/", "text/css")));
660 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage<FreenetRequest>("javascript/", "/static/javascript/", "text/javascript")));
661 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage<FreenetRequest>("images/", "/static/images/", "image/png")));
662 pageToadlets.add(pageToadletFactory.createPageToadlet(new TemplatePage<FreenetRequest>("OpenSearch.xml", "application/opensearchdescription+xml", templateContextFactory, openSearchTemplate)));
663 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetImagePage(this)));
664 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
665 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetStatusAjaxPage(this)));
666 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetNotificationsAjaxPage(this)));
667 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationAjaxPage(this)));
668 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostAjaxPage(this)));
669 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyAjaxPage(this)));
670 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetReplyAjaxPage(this, replyTemplate)));
671 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetPostAjaxPage(this, postTemplate)));
672 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTimesAjaxPage(this)));
673 pageToadlets.add(pageToadletFactory.createPageToadlet(new MarkAsKnownAjaxPage(this)));
674 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostAjaxPage(this)));
675 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyAjaxPage(this)));
676 pageToadlets.add(pageToadletFactory.createPageToadlet(new LockSoneAjaxPage(this)));
677 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlockSoneAjaxPage(this)));
678 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSoneAjaxPage(this)));
679 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSoneAjaxPage(this)));
680 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditAlbumAjaxPage(this)));
681 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditImageAjaxPage(this, parserFilter)));
682 pageToadlets.add(pageToadletFactory.createPageToadlet(new TrustAjaxPage(this)));
683 pageToadlets.add(pageToadletFactory.createPageToadlet(new DistrustAjaxPage(this)));
684 pageToadlets.add(pageToadletFactory.createPageToadlet(new UntrustAjaxPage(this)));
685 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikeAjaxPage(this)));
686 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikeAjaxPage(this)));
687 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetLikesAjaxPage(this)));
688 pageToadlets.add(pageToadletFactory.createPageToadlet(new BookmarkAjaxPage(this)));
689 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnbookmarkAjaxPage(this)));
690 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfileFieldAjaxPage(this)));
691 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteProfileFieldAjaxPage(this)));
692 pageToadlets.add(pageToadletFactory.createPageToadlet(new MoveProfileFieldAjaxPage(this)));
694 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
695 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Sone.Name", "Navigation.Menu.Sone.Tooltip", sonePlugin);
696 for (PageToadlet toadlet : pageToadlets) {
697 String menuName = toadlet.getMenuName();
698 if (menuName != null) {
699 toadletContainer.register(toadlet, "Navigation.Menu.Sone.Name", toadlet.path(), true, "Navigation.Menu.Sone.Item." + menuName + ".Name", "Navigation.Menu.Sone.Item." + menuName + ".Tooltip", false, toadlet);
701 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
707 * Unregisters all toadlets.
709 private void unregisterToadlets() {
710 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
711 for (PageToadlet pageToadlet : pageToadlets) {
712 toadletContainer.unregister(pageToadlet);
714 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Sone.Name");
718 * Creates a {@link Reader} from the {@link InputStream} for the resource
719 * with the given name.
721 * @param resourceName
722 * The name of the resource
723 * @return A {@link Reader} for the resource
725 private Reader createReader(String resourceName) {
727 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
728 } catch (UnsupportedEncodingException uee1) {
734 * Returns all {@link Core#isLocalSone(Sone) local Sone}s that are
735 * referenced by {@link SonePart}s in the given text (after parsing it using
736 * {@link SoneTextParser}).
740 * @return All mentioned local Sones
742 private Set<Sone> getMentionedSones(String text) {
743 /* we need no context to find mentioned Sones. */
744 Set<Sone> mentionedSones = new HashSet<Sone>();
746 for (Part part : soneTextParser.parse(null, new StringReader(text))) {
747 if (part instanceof SonePart) {
748 mentionedSones.add(((SonePart) part).getSone());
751 } catch (IOException ioe1) {
752 logger.log(Level.WARNING, "Could not parse post text: " + text, ioe1);
754 return Filters.filteredSet(mentionedSones, Sone.LOCAL_SONE_FILTER);
758 * Returns the Sone insert notification for the given Sone. If no
759 * notification for the given Sone exists, a new notification is created and
763 * The Sone to get the insert notification for
764 * @return The Sone insert notification
766 private TemplateNotification getSoneInsertNotification(Sone sone) {
767 synchronized (soneInsertNotifications) {
768 TemplateNotification templateNotification = soneInsertNotifications.get(sone);
769 if (templateNotification == null) {
770 templateNotification = new TemplateNotification(TemplateParser.parse(createReader("/templates/notify/soneInsertNotification.html")));
771 templateNotification.set("insertSone", sone);
772 soneInsertNotifications.put(sone, templateNotification);
774 return templateNotification;
779 // CORELISTENER METHODS
786 public void newSoneFound(Sone sone) {
787 newSoneNotification.add(sone);
788 if (!hasFirstStartNotification()) {
789 notificationManager.addNotification(newSoneNotification);
797 public void newPostFound(Post post) {
798 boolean isLocal = getCore().isLocalSone(post.getSone());
800 localPostNotification.add(post);
802 newPostNotification.add(post);
804 if (!hasFirstStartNotification()) {
805 notificationManager.addNotification(isLocal ? localPostNotification : newPostNotification);
806 if (!getMentionedSones(post.getText()).isEmpty() && !isLocal) {
807 mentionNotification.add(post);
808 notificationManager.addNotification(mentionNotification);
811 getCore().markPostKnown(post);
819 public void newReplyFound(PostReply reply) {
820 boolean isLocal = getCore().isLocalSone(reply.getSone());
822 localReplyNotification.add(reply);
824 newReplyNotification.add(reply);
826 if (!hasFirstStartNotification()) {
827 notificationManager.addNotification(isLocal ? localReplyNotification : newReplyNotification);
828 if (!getMentionedSones(reply.getText()).isEmpty() && !isLocal && (reply.getPost().getSone() != null) && (reply.getTime() <= System.currentTimeMillis())) {
829 mentionNotification.add(reply.getPost());
830 notificationManager.addNotification(mentionNotification);
833 getCore().markReplyKnown(reply);
841 public void markSoneKnown(Sone sone) {
842 newSoneNotification.remove(sone);
849 public void markPostKnown(Post post) {
850 newPostNotification.remove(post);
851 localPostNotification.remove(post);
852 mentionNotification.remove(post);
859 public void markReplyKnown(PostReply reply) {
860 newReplyNotification.remove(reply);
861 localReplyNotification.remove(reply);
862 mentionNotification.remove(reply.getPost());
869 public void soneRemoved(Sone sone) {
870 newSoneNotification.remove(sone);
877 public void postRemoved(Post post) {
878 newPostNotification.remove(post);
879 localPostNotification.remove(post);
880 mentionNotification.remove(post);
887 public void replyRemoved(PostReply reply) {
888 newReplyNotification.remove(reply);
889 localReplyNotification.remove(reply);
890 if (!getMentionedSones(reply.getText()).isEmpty()) {
891 boolean isMentioned = false;
892 for (PostReply existingReply : getCore().getReplies(reply.getPost())) {
893 isMentioned |= !reply.isKnown() && !getMentionedSones(existingReply.getText()).isEmpty();
896 mentionNotification.remove(reply.getPost());
905 public void soneLocked(final Sone sone) {
906 Object tickerObject = Ticker.getInstance().registerEvent(System.currentTimeMillis() + (5 * 60) * 1000, new Runnable() {
909 @SuppressWarnings("synthetic-access")
911 lockedSonesNotification.add(sone);
912 lockedSonesTickerObjects.remove(sone);
913 notificationManager.addNotification(lockedSonesNotification);
915 }, "Sone Locked Notification");
916 lockedSonesTickerObjects.put(sone, tickerObject);
923 public void soneUnlocked(Sone sone) {
924 lockedSonesNotification.remove(sone);
925 Ticker.getInstance().deregisterEvent(lockedSonesTickerObjects.remove(sone));
932 public void soneInserting(Sone sone) {
933 TemplateNotification soneInsertNotification = getSoneInsertNotification(sone);
934 soneInsertNotification.set("soneStatus", "inserting");
935 if (sone.getOptions().getBooleanOption("EnableSoneInsertNotifications").get()) {
936 notificationManager.addNotification(soneInsertNotification);
944 public void soneInserted(Sone sone, long insertDuration) {
945 TemplateNotification soneInsertNotification = getSoneInsertNotification(sone);
946 soneInsertNotification.set("soneStatus", "inserted");
947 soneInsertNotification.set("insertDuration", insertDuration / 1000);
948 if (sone.getOptions().getBooleanOption("EnableSoneInsertNotifications").get()) {
949 notificationManager.addNotification(soneInsertNotification);
957 public void soneInsertAborted(Sone sone, Throwable cause) {
958 TemplateNotification soneInsertNotification = getSoneInsertNotification(sone);
959 soneInsertNotification.set("soneStatus", "insert-aborted");
960 soneInsertNotification.set("insert-error", cause);
961 if (sone.getOptions().getBooleanOption("EnableSoneInsertNotifications").get()) {
962 notificationManager.addNotification(soneInsertNotification);
970 public void updateFound(Version version, long releaseTime, long latestEdition) {
971 newVersionNotification.getTemplateContext().set("latestVersion", version);
972 newVersionNotification.getTemplateContext().set("latestEdition", latestEdition);
973 newVersionNotification.getTemplateContext().set("releaseTime", releaseTime);
974 notificationManager.addNotification(newVersionNotification);
981 public void imageInsertStarted(Image image) {
982 insertingImagesNotification.add(image);
983 notificationManager.addNotification(insertingImagesNotification);
990 public void imageInsertAborted(Image image) {
991 insertingImagesNotification.remove(image);
998 public void imageInsertFinished(Image image) {
999 insertingImagesNotification.remove(image);
1000 insertedImagesNotification.add(image);
1001 notificationManager.addNotification(insertedImagesNotification);
1008 public void imageInsertFailed(Image image, Throwable cause) {
1009 insertingImagesNotification.remove(image);
1010 imageInsertFailedNotification.add(image);
1011 notificationManager.addNotification(imageInsertFailedNotification);
1015 * Template provider implementation that uses
1016 * {@link WebInterface#createReader(String)} to load templates for
1019 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
1021 private class ClassPathTemplateProvider implements Provider {
1023 /** Cache for templates. */
1024 private final Cache<String, Template> templateCache = new MemoryCache<String, Template>(new ValueRetriever<String, Template>() {
1027 @SuppressWarnings("synthetic-access")
1028 public CacheItem<Template> retrieve(String key) throws CacheException {
1029 Template template = findTemplate(key);
1030 if (template != null) {
1031 return new DefaultCacheItem<Template>(template);
1041 @SuppressWarnings("synthetic-access")
1042 public Template getTemplate(TemplateContext templateContext, String templateName) {
1044 return templateCache.get(templateName);
1045 } catch (CacheException ce1) {
1046 logger.log(Level.WARNING, "Could not get template for " + templateName + "!", ce1);
1052 * Locates a template in the class path.
1054 * @param templateName
1055 * The name of the template to load
1056 * @return The loaded template, or {@code null} if no template could be
1059 @SuppressWarnings("synthetic-access")
1060 private Template findTemplate(String templateName) {
1061 Reader templateReader = createReader("/templates/" + templateName);
1062 if (templateReader == null) {
1065 Template template = null;
1067 template = TemplateParser.parse(templateReader);
1068 } catch (TemplateException te1) {
1069 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);