2 * FreenetSone - WebInterface.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.web;
20 import java.io.InputStream;
21 import java.io.InputStreamReader;
22 import java.io.Reader;
23 import java.io.StringReader;
24 import java.io.UnsupportedEncodingException;
25 import java.util.ArrayList;
26 import java.util.Collection;
27 import java.util.Collections;
28 import java.util.HashMap;
29 import java.util.HashSet;
30 import java.util.List;
33 import java.util.UUID;
34 import java.util.logging.Level;
35 import java.util.logging.Logger;
37 import net.pterodactylus.sone.core.Core;
38 import net.pterodactylus.sone.core.CoreListener;
39 import net.pterodactylus.sone.data.Post;
40 import net.pterodactylus.sone.data.Reply;
41 import net.pterodactylus.sone.data.Sone;
42 import net.pterodactylus.sone.freenet.L10nFilter;
43 import net.pterodactylus.sone.freenet.wot.Identity;
44 import net.pterodactylus.sone.freenet.wot.Trust;
45 import net.pterodactylus.sone.main.SonePlugin;
46 import net.pterodactylus.sone.notify.ListNotification;
47 import net.pterodactylus.sone.template.CollectionAccessor;
48 import net.pterodactylus.sone.template.CssClassNameFilter;
49 import net.pterodactylus.sone.template.GetPagePlugin;
50 import net.pterodactylus.sone.template.IdentityAccessor;
51 import net.pterodactylus.sone.template.JavascriptFilter;
52 import net.pterodactylus.sone.template.NotificationManagerAccessor;
53 import net.pterodactylus.sone.template.ParserFilter;
54 import net.pterodactylus.sone.template.PostAccessor;
55 import net.pterodactylus.sone.template.ReplyAccessor;
56 import net.pterodactylus.sone.template.RequestChangeFilter;
57 import net.pterodactylus.sone.template.SoneAccessor;
58 import net.pterodactylus.sone.template.SubstringFilter;
59 import net.pterodactylus.sone.template.TrustAccessor;
60 import net.pterodactylus.sone.template.UnknownDateFilter;
61 import net.pterodactylus.sone.web.ajax.CreatePostAjaxPage;
62 import net.pterodactylus.sone.web.ajax.CreateReplyAjaxPage;
63 import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
64 import net.pterodactylus.sone.web.ajax.DeleteProfileFieldAjaxPage;
65 import net.pterodactylus.sone.web.ajax.DeleteReplyAjaxPage;
66 import net.pterodactylus.sone.web.ajax.DismissNotificationAjaxPage;
67 import net.pterodactylus.sone.web.ajax.DistrustAjaxPage;
68 import net.pterodactylus.sone.web.ajax.EditProfileFieldAjaxPage;
69 import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
70 import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
71 import net.pterodactylus.sone.web.ajax.GetPostAjaxPage;
72 import net.pterodactylus.sone.web.ajax.GetReplyAjaxPage;
73 import net.pterodactylus.sone.web.ajax.GetStatusAjaxPage;
74 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
75 import net.pterodactylus.sone.web.ajax.LikeAjaxPage;
76 import net.pterodactylus.sone.web.ajax.LockSoneAjaxPage;
77 import net.pterodactylus.sone.web.ajax.MarkAsKnownAjaxPage;
78 import net.pterodactylus.sone.web.ajax.MoveProfileFieldAjaxPage;
79 import net.pterodactylus.sone.web.ajax.TrustAjaxPage;
80 import net.pterodactylus.sone.web.ajax.UnfollowSoneAjaxPage;
81 import net.pterodactylus.sone.web.ajax.UnlikeAjaxPage;
82 import net.pterodactylus.sone.web.ajax.UnlockSoneAjaxPage;
83 import net.pterodactylus.sone.web.ajax.UntrustAjaxPage;
84 import net.pterodactylus.sone.web.page.PageToadlet;
85 import net.pterodactylus.sone.web.page.PageToadletFactory;
86 import net.pterodactylus.sone.web.page.StaticPage;
87 import net.pterodactylus.util.cache.Cache;
88 import net.pterodactylus.util.cache.CacheException;
89 import net.pterodactylus.util.cache.CacheItem;
90 import net.pterodactylus.util.cache.DefaultCacheItem;
91 import net.pterodactylus.util.cache.MemoryCache;
92 import net.pterodactylus.util.cache.ValueRetriever;
93 import net.pterodactylus.util.logging.Logging;
94 import net.pterodactylus.util.notify.Notification;
95 import net.pterodactylus.util.notify.NotificationManager;
96 import net.pterodactylus.util.notify.TemplateNotification;
97 import net.pterodactylus.util.template.DateFilter;
98 import net.pterodactylus.util.template.FormatFilter;
99 import net.pterodactylus.util.template.HtmlFilter;
100 import net.pterodactylus.util.template.MatchFilter;
101 import net.pterodactylus.util.template.PaginationPlugin;
102 import net.pterodactylus.util.template.Provider;
103 import net.pterodactylus.util.template.ReflectionAccessor;
104 import net.pterodactylus.util.template.ReplaceFilter;
105 import net.pterodactylus.util.template.StoreFilter;
106 import net.pterodactylus.util.template.Template;
107 import net.pterodactylus.util.template.TemplateContext;
108 import net.pterodactylus.util.template.TemplateContextFactory;
109 import net.pterodactylus.util.template.TemplateException;
110 import net.pterodactylus.util.template.TemplateParser;
111 import net.pterodactylus.util.template.XmlFilter;
112 import net.pterodactylus.util.thread.Ticker;
113 import net.pterodactylus.util.version.Version;
114 import freenet.clients.http.SessionManager;
115 import freenet.clients.http.SessionManager.Session;
116 import freenet.clients.http.ToadletContainer;
117 import freenet.clients.http.ToadletContext;
118 import freenet.l10n.BaseL10n;
121 * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
122 * references to l10n helpers.
124 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
126 public class WebInterface implements CoreListener {
129 private static final Logger logger = Logging.getLogger(WebInterface.class);
131 /** The notification manager. */
132 private final NotificationManager notificationManager = new NotificationManager();
134 /** The Sone plugin. */
135 private final SonePlugin sonePlugin;
137 /** The registered toadlets. */
138 private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
140 /** The form password. */
141 private final String formPassword;
143 /** The template context factory. */
144 private final TemplateContextFactory templateContextFactory;
146 /** The “new Sone” notification. */
147 private final ListNotification<Sone> newSoneNotification;
149 /** The “new post” notification. */
150 private final ListNotification<Post> newPostNotification;
152 /** The “new reply” notification. */
153 private final ListNotification<Reply> newReplyNotification;
155 /** The “rescuing Sone” notification. */
156 private final ListNotification<Sone> rescuingSonesNotification;
158 /** The “Sone rescued” notification. */
159 private final ListNotification<Sone> sonesRescuedNotification;
161 /** Sone locked notification ticker objects. */
162 private final Map<Sone, Object> lockedSonesTickerObjects = Collections.synchronizedMap(new HashMap<Sone, Object>());
164 /** The “Sone locked” notification. */
165 private final ListNotification<Sone> lockedSonesNotification;
167 /** The “new version” notification. */
168 private final TemplateNotification newVersionNotification;
171 * Creates a new web interface.
176 @SuppressWarnings("synthetic-access")
177 public WebInterface(SonePlugin sonePlugin) {
178 this.sonePlugin = sonePlugin;
179 formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
181 templateContextFactory = new TemplateContextFactory();
182 templateContextFactory.addAccessor(Object.class, new ReflectionAccessor());
183 templateContextFactory.addAccessor(Collection.class, new CollectionAccessor());
184 templateContextFactory.addAccessor(Sone.class, new SoneAccessor(getCore()));
185 templateContextFactory.addAccessor(Post.class, new PostAccessor(getCore()));
186 templateContextFactory.addAccessor(Reply.class, new ReplyAccessor(getCore()));
187 templateContextFactory.addAccessor(Identity.class, new IdentityAccessor(getCore()));
188 templateContextFactory.addAccessor(NotificationManager.class, new NotificationManagerAccessor());
189 templateContextFactory.addAccessor(Trust.class, new TrustAccessor());
190 templateContextFactory.addFilter("date", new DateFilter());
191 templateContextFactory.addFilter("html", new HtmlFilter());
192 templateContextFactory.addFilter("replace", new ReplaceFilter());
193 templateContextFactory.addFilter("store", new StoreFilter());
194 templateContextFactory.addFilter("l10n", new L10nFilter(getL10n()));
195 templateContextFactory.addFilter("substring", new SubstringFilter());
196 templateContextFactory.addFilter("xml", new XmlFilter());
197 templateContextFactory.addFilter("change", new RequestChangeFilter());
198 templateContextFactory.addFilter("match", new MatchFilter());
199 templateContextFactory.addFilter("css", new CssClassNameFilter());
200 templateContextFactory.addFilter("js", new JavascriptFilter());
201 templateContextFactory.addFilter("parse", new ParserFilter(getCore(), templateContextFactory));
202 templateContextFactory.addFilter("unknown", new UnknownDateFilter(getL10n(), "View.Sone.Text.UnknownDate"));
203 templateContextFactory.addFilter("format", new FormatFilter());
204 templateContextFactory.addPlugin("getpage", new GetPagePlugin());
205 templateContextFactory.addPlugin("paginate", new PaginationPlugin());
206 templateContextFactory.addProvider(Provider.TEMPLATE_CONTEXT_PROVIDER);
207 templateContextFactory.addProvider(new ClassPathTemplateProvider());
208 templateContextFactory.addTemplateObject("formPassword", formPassword);
210 /* create notifications. */
211 Template newSoneNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newSoneNotification.html"));
212 newSoneNotification = new ListNotification<Sone>("new-sone-notification", "sones", newSoneNotificationTemplate);
214 Template newPostNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newPostNotification.html"));
215 newPostNotification = new ListNotification<Post>("new-post-notification", "posts", newPostNotificationTemplate);
217 Template newReplyNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newReplyNotification.html"));
218 newReplyNotification = new ListNotification<Reply>("new-replies-notification", "replies", newReplyNotificationTemplate);
220 Template rescuingSonesTemplate = TemplateParser.parse(createReader("/templates/notify/rescuingSonesNotification.html"));
221 rescuingSonesNotification = new ListNotification<Sone>("sones-being-rescued-notification", "sones", rescuingSonesTemplate);
223 Template sonesRescuedTemplate = TemplateParser.parse(createReader("/templates/notify/sonesRescuedNotification.html"));
224 sonesRescuedNotification = new ListNotification<Sone>("sones-rescued-notification", "sones", sonesRescuedTemplate);
226 Template lockedSonesTemplate = TemplateParser.parse(createReader("/templates/notify/lockedSonesNotification.html"));
227 lockedSonesNotification = new ListNotification<Sone>("sones-locked-notification", "sones", lockedSonesTemplate);
229 Template newVersionTemplate = TemplateParser.parse(createReader("/templates/notify/newVersionNotification.html"));
230 newVersionNotification = new TemplateNotification("new-version-notification", newVersionTemplate);
238 * Returns the Sone core used by the Sone plugin.
240 * @return The Sone core
242 public Core getCore() {
243 return sonePlugin.core();
247 * Returns the template context factory of the web interface.
249 * @return The template context factory
251 public TemplateContextFactory getTemplateContextFactory() {
252 return templateContextFactory;
256 * Returns the current session, creating a new session if there is no
259 * @param toadletContenxt
260 * The toadlet context
261 * @return The current session, or {@code null} if there is no current
264 public Session getCurrentSession(ToadletContext toadletContenxt) {
265 return getCurrentSession(toadletContenxt, true);
269 * Returns the current session, creating a new session if there is no
270 * current session and {@code create} is {@code true}.
272 * @param toadletContenxt
273 * The toadlet context
275 * {@code true} to create a new session if there is no current
276 * session, {@code false} otherwise
277 * @return The current session, or {@code null} if there is no current
280 public Session getCurrentSession(ToadletContext toadletContenxt, boolean create) {
281 Session session = getSessionManager().useSession(toadletContenxt);
282 if (create && (session == null)) {
283 session = getSessionManager().createSession(UUID.randomUUID().toString(), toadletContenxt);
289 * Returns the currently logged in Sone.
291 * @param toadletContext
292 * The toadlet context
293 * @return The currently logged in Sone, or {@code null} if no Sone is
294 * currently logged in
296 public Sone getCurrentSone(ToadletContext toadletContext) {
297 return getCurrentSone(toadletContext, true);
301 * Returns the currently logged in Sone.
303 * @param toadletContext
304 * The toadlet context
306 * {@code true} to create a new session if no session exists,
307 * {@code false} to not create a new session
308 * @return The currently logged in Sone, or {@code null} if no Sone is
309 * currently logged in
311 public Sone getCurrentSone(ToadletContext toadletContext, boolean create) {
312 Set<Sone> localSones = getCore().getLocalSones();
313 if (localSones.size() == 1) {
314 return localSones.iterator().next();
316 return getCurrentSone(getCurrentSession(toadletContext, create));
320 * Returns the currently logged in Sone.
324 * @return The currently logged in Sone, or {@code null} if no Sone is
325 * currently logged in
327 public Sone getCurrentSone(Session session) {
328 if (session == null) {
331 String soneId = (String) session.getAttribute("Sone.CurrentSone");
332 if (soneId == null) {
335 return getCore().getLocalSone(soneId, false);
339 * Sets the currently logged in Sone.
341 * @param toadletContext
342 * The toadlet context
344 * The Sone to set as currently logged in
346 public void setCurrentSone(ToadletContext toadletContext, Sone sone) {
347 Session session = getCurrentSession(toadletContext);
349 session.removeAttribute("Sone.CurrentSone");
351 session.setAttribute("Sone.CurrentSone", sone.getId());
356 * Returns the notification manager.
358 * @return The notification manager
360 public NotificationManager getNotifications() {
361 return notificationManager;
365 * Returns the l10n helper of the node.
367 * @return The node’s l10n helper
369 public BaseL10n getL10n() {
370 return sonePlugin.l10n().getBase();
374 * Returns the session manager of the node.
376 * @return The node’s session manager
378 public SessionManager getSessionManager() {
379 return sonePlugin.pluginRespirator().getSessionManager("Sone");
383 * Returns the node’s form password.
385 * @return The form password
387 public String getFormPassword() {
392 * Returns the posts that have been announced as new in the
393 * {@link #newPostNotification}.
395 * @return The new posts
397 public Set<Post> getNewPosts() {
398 return new HashSet<Post>(newPostNotification.getElements());
402 * Returns the replies that have been announced as new in the
403 * {@link #newReplyNotification}.
405 * @return The new replies
407 public Set<Reply> getNewReplies() {
408 return new HashSet<Reply>(newReplyNotification.getElements());
412 * Sets whether the current start of the plugin is the first start. It is
413 * considered a first start if the configuration file does not exist.
416 * {@code true} if no configuration file existed when Sone was
417 * loaded, {@code false} otherwise
419 public void setFirstStart(boolean firstStart) {
421 Template firstStartNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/firstStartNotification.html"));
422 Notification firstStartNotification = new TemplateNotification("first-start-notification", firstStartNotificationTemplate);
423 notificationManager.addNotification(firstStartNotification);
428 * Sets whether Sone was started with a fresh configuration file.
431 * {@code true} if Sone was started with a fresh configuration,
432 * {@code false} if the existing configuration could be read
434 public void setNewConfig(boolean newConfig) {
435 if (newConfig && !hasFirstStartNotification()) {
436 Template configNotReadNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/configNotReadNotification.html"));
437 Notification configNotReadNotification = new TemplateNotification("config-not-read-notification", configNotReadNotificationTemplate);
438 notificationManager.addNotification(configNotReadNotification);
447 * Returns whether the first start notification is currently displayed.
449 * @return {@code true} if the first-start notification is currently
450 * displayed, {@code false} otherwise
452 private boolean hasFirstStartNotification() {
453 return notificationManager.getNotification("first-start-notification") != null;
461 * Starts the web interface and registers all toadlets.
463 public void start() {
466 /* notification templates. */
467 Template startupNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/startupNotification.html"));
469 final TemplateNotification startupNotification = new TemplateNotification("startup-notification", startupNotificationTemplate);
470 notificationManager.addNotification(startupNotification);
472 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (120 * 1000), new Runnable() {
476 startupNotification.dismiss();
478 }, "Sone Startup Notification Remover");
480 Template wotMissingNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/wotMissingNotification.html"));
481 final TemplateNotification wotMissingNotification = new TemplateNotification("wot-missing-notification", wotMissingNotificationTemplate);
482 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (15 * 1000), new Runnable() {
485 @SuppressWarnings("synthetic-access")
487 if (getCore().getIdentityManager().isConnected()) {
488 wotMissingNotification.dismiss();
490 notificationManager.addNotification(wotMissingNotification);
492 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (15 * 1000), this, "Sone WoT Connector Checker");
495 }, "Sone WoT Connector Checker");
499 * Stops the web interface and unregisters all toadlets.
502 unregisterToadlets();
503 Ticker.getInstance().stop();
511 * Register all toadlets.
513 private void registerToadlets() {
514 Template emptyTemplate = TemplateParser.parse(new StringReader(""));
515 Template loginTemplate = TemplateParser.parse(createReader("/templates/login.html"));
516 Template indexTemplate = TemplateParser.parse(createReader("/templates/index.html"));
517 Template knownSonesTemplate = TemplateParser.parse(createReader("/templates/knownSones.html"));
518 Template createSoneTemplate = TemplateParser.parse(createReader("/templates/createSone.html"));
519 Template createPostTemplate = TemplateParser.parse(createReader("/templates/createPost.html"));
520 Template createReplyTemplate = TemplateParser.parse(createReader("/templates/createReply.html"));
521 Template editProfileTemplate = TemplateParser.parse(createReader("/templates/editProfile.html"));
522 Template editProfileFieldTemplate = TemplateParser.parse(createReader("/templates/editProfileField.html"));
523 Template deleteProfileFieldTemplate = TemplateParser.parse(createReader("/templates/deleteProfileField.html"));
524 Template viewSoneTemplate = TemplateParser.parse(createReader("/templates/viewSone.html"));
525 Template viewPostTemplate = TemplateParser.parse(createReader("/templates/viewPost.html"));
526 Template deletePostTemplate = TemplateParser.parse(createReader("/templates/deletePost.html"));
527 Template deleteReplyTemplate = TemplateParser.parse(createReader("/templates/deleteReply.html"));
528 Template deleteSoneTemplate = TemplateParser.parse(createReader("/templates/deleteSone.html"));
529 Template noPermissionTemplate = TemplateParser.parse(createReader("/templates/noPermission.html"));
530 Template optionsTemplate = TemplateParser.parse(createReader("/templates/options.html"));
531 Template aboutTemplate = TemplateParser.parse(createReader("/templates/about.html"));
532 Template invalidTemplate = TemplateParser.parse(createReader("/templates/invalid.html"));
533 Template postTemplate = TemplateParser.parse(createReader("/templates/include/viewPost.html"));
534 Template replyTemplate = TemplateParser.parse(createReader("/templates/include/viewReply.html"));
536 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
537 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
538 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
539 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
540 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
541 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfileFieldPage(editProfileFieldTemplate, this)));
542 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteProfileFieldPage(deleteProfileFieldTemplate, this)));
543 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
544 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
545 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
546 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
547 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikePage(emptyTemplate, this)));
548 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikePage(emptyTemplate, this)));
549 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
550 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
551 pageToadlets.add(pageToadletFactory.createPageToadlet(new LockSonePage(emptyTemplate, this)));
552 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlockSonePage(emptyTemplate, this)));
553 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(emptyTemplate, this)));
554 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(emptyTemplate, this)));
555 pageToadlets.add(pageToadletFactory.createPageToadlet(new TrustPage(emptyTemplate, this)));
556 pageToadlets.add(pageToadletFactory.createPageToadlet(new DistrustPage(emptyTemplate, this)));
557 pageToadlets.add(pageToadletFactory.createPageToadlet(new UntrustPage(emptyTemplate, this)));
558 pageToadlets.add(pageToadletFactory.createPageToadlet(new MarkAsKnownPage(emptyTemplate, this)));
559 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
560 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
561 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(emptyTemplate, this), "Logout"));
562 pageToadlets.add(pageToadletFactory.createPageToadlet(new OptionsPage(optionsTemplate, this), "Options"));
563 pageToadlets.add(pageToadletFactory.createPageToadlet(new AboutPage(aboutTemplate, this, SonePlugin.VERSION), "About"));
564 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
565 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationPage(emptyTemplate, this)));
566 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("invalid.html", invalidTemplate, "Page.Invalid.Title", this)));
567 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
568 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
569 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
570 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
571 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetStatusAjaxPage(this)));
572 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationAjaxPage(this)));
573 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostAjaxPage(this)));
574 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyAjaxPage(this)));
575 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetReplyAjaxPage(this, replyTemplate)));
576 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetPostAjaxPage(this, postTemplate)));
577 pageToadlets.add(pageToadletFactory.createPageToadlet(new MarkAsKnownAjaxPage(this)));
578 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostAjaxPage(this)));
579 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyAjaxPage(this)));
580 pageToadlets.add(pageToadletFactory.createPageToadlet(new LockSoneAjaxPage(this)));
581 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlockSoneAjaxPage(this)));
582 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSoneAjaxPage(this)));
583 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSoneAjaxPage(this)));
584 pageToadlets.add(pageToadletFactory.createPageToadlet(new TrustAjaxPage(this)));
585 pageToadlets.add(pageToadletFactory.createPageToadlet(new DistrustAjaxPage(this)));
586 pageToadlets.add(pageToadletFactory.createPageToadlet(new UntrustAjaxPage(this)));
587 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikeAjaxPage(this)));
588 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikeAjaxPage(this)));
589 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetLikesAjaxPage(this)));
590 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfileFieldAjaxPage(this)));
591 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteProfileFieldAjaxPage(this)));
592 pageToadlets.add(pageToadletFactory.createPageToadlet(new MoveProfileFieldAjaxPage(this)));
594 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
595 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
596 for (PageToadlet toadlet : pageToadlets) {
597 String menuName = toadlet.getMenuName();
598 if (menuName != null) {
599 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
601 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
607 * Unregisters all toadlets.
609 private void unregisterToadlets() {
610 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
611 for (PageToadlet pageToadlet : pageToadlets) {
612 toadletContainer.unregister(pageToadlet);
614 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
618 * Creates a {@link Reader} from the {@link InputStream} for the resource
619 * with the given name.
621 * @param resourceName
622 * The name of the resource
623 * @return A {@link Reader} for the resource
625 private Reader createReader(String resourceName) {
627 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
628 } catch (UnsupportedEncodingException uee1) {
629 System.out.println(" fail.");
635 // CORELISTENER METHODS
642 public void rescuingSone(Sone sone) {
643 rescuingSonesNotification.add(sone);
644 notificationManager.addNotification(rescuingSonesNotification);
651 public void rescuedSone(Sone sone) {
652 rescuingSonesNotification.remove(sone);
653 sonesRescuedNotification.add(sone);
654 notificationManager.addNotification(sonesRescuedNotification);
661 public void newSoneFound(Sone sone) {
662 newSoneNotification.add(sone);
663 if (!hasFirstStartNotification()) {
664 notificationManager.addNotification(newSoneNotification);
672 public void newPostFound(Post post) {
673 newPostNotification.add(post);
674 if (!hasFirstStartNotification()) {
675 notificationManager.addNotification(newPostNotification);
677 getCore().markPostKnown(post);
685 public void newReplyFound(Reply reply) {
686 if (reply.getPost().getSone() == null) {
689 newReplyNotification.add(reply);
690 if (!hasFirstStartNotification()) {
691 notificationManager.addNotification(newReplyNotification);
693 getCore().markReplyKnown(reply);
701 public void markSoneKnown(Sone sone) {
702 newSoneNotification.remove(sone);
709 public void markPostKnown(Post post) {
710 newPostNotification.remove(post);
717 public void markReplyKnown(Reply reply) {
718 newReplyNotification.remove(reply);
725 public void postRemoved(Post post) {
726 newPostNotification.remove(post);
733 public void replyRemoved(Reply reply) {
734 newReplyNotification.remove(reply);
741 public void soneLocked(final Sone sone) {
742 Object tickerObject = Ticker.getInstance().registerEvent(System.currentTimeMillis() + (5 * 60) * 1000, new Runnable() {
745 @SuppressWarnings("synthetic-access")
747 lockedSonesNotification.add(sone);
748 lockedSonesTickerObjects.remove(sone);
749 notificationManager.addNotification(lockedSonesNotification);
751 }, "Sone Locked Notification");
752 lockedSonesTickerObjects.put(sone, tickerObject);
759 public void soneUnlocked(Sone sone) {
760 lockedSonesNotification.remove(sone);
761 Ticker.getInstance().deregisterEvent(lockedSonesTickerObjects.remove(sone));
768 public void updateFound(Version version, long releaseTime, long latestEdition) {
769 newVersionNotification.getTemplateContext().set("latestVersion", version);
770 newVersionNotification.getTemplateContext().set("latestEdition", latestEdition);
771 newVersionNotification.getTemplateContext().set("releaseTime", releaseTime);
772 notificationManager.addNotification(newVersionNotification);
776 * Template provider implementation that uses
777 * {@link WebInterface#createReader(String)} to load templates for
780 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
782 private class ClassPathTemplateProvider implements Provider {
784 /** Cache for templates. */
785 private final Cache<String, Template> templateCache = new MemoryCache<String, Template>(new ValueRetriever<String, Template>() {
788 @SuppressWarnings("synthetic-access")
789 public CacheItem<Template> retrieve(String key) throws CacheException {
790 Template template = findTemplate(key);
791 if (template != null) {
792 return new DefaultCacheItem<Template>(template);
802 @SuppressWarnings("synthetic-access")
803 public Template getTemplate(TemplateContext templateContext, String templateName) {
805 return templateCache.get(templateName);
806 } catch (CacheException ce1) {
807 logger.log(Level.WARNING, "Could not get template for " + templateName + "!", ce1);
813 * Locates a template in the class path.
815 * @param templateName
816 * The name of the template to load
817 * @return The loaded template, or {@code null} if no template could be
820 @SuppressWarnings("synthetic-access")
821 private Template findTemplate(String templateName) {
822 Reader templateReader = createReader("/templates/" + templateName);
823 if (templateReader == null) {
826 Template template = null;
828 template = TemplateParser.parse(templateReader);
829 } catch (TemplateException te1) {
830 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);