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.Album;
40 import net.pterodactylus.sone.data.Post;
41 import net.pterodactylus.sone.data.Reply;
42 import net.pterodactylus.sone.data.Sone;
43 import net.pterodactylus.sone.freenet.L10nFilter;
44 import net.pterodactylus.sone.freenet.wot.Identity;
45 import net.pterodactylus.sone.main.SonePlugin;
46 import net.pterodactylus.sone.notify.ListNotification;
47 import net.pterodactylus.sone.template.AlbumAccessor;
48 import net.pterodactylus.sone.template.CollectionAccessor;
49 import net.pterodactylus.sone.template.CssClassNameFilter;
50 import net.pterodactylus.sone.template.GetPagePlugin;
51 import net.pterodactylus.sone.template.IdentityAccessor;
52 import net.pterodactylus.sone.template.NotificationManagerAccessor;
53 import net.pterodactylus.sone.template.PostAccessor;
54 import net.pterodactylus.sone.template.ReplyAccessor;
55 import net.pterodactylus.sone.template.RequestChangeFilter;
56 import net.pterodactylus.sone.template.SoneAccessor;
57 import net.pterodactylus.sone.template.SubstringFilter;
58 import net.pterodactylus.sone.web.ajax.CreatePostAjaxPage;
59 import net.pterodactylus.sone.web.ajax.CreateReplyAjaxPage;
60 import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
61 import net.pterodactylus.sone.web.ajax.DeleteReplyAjaxPage;
62 import net.pterodactylus.sone.web.ajax.DismissNotificationAjaxPage;
63 import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
64 import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
65 import net.pterodactylus.sone.web.ajax.GetPostAjaxPage;
66 import net.pterodactylus.sone.web.ajax.GetReplyAjaxPage;
67 import net.pterodactylus.sone.web.ajax.GetStatusAjaxPage;
68 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
69 import net.pterodactylus.sone.web.ajax.LikeAjaxPage;
70 import net.pterodactylus.sone.web.ajax.LockSoneAjaxPage;
71 import net.pterodactylus.sone.web.ajax.MarkPostAsKnownPage;
72 import net.pterodactylus.sone.web.ajax.MarkReplyAsKnownPage;
73 import net.pterodactylus.sone.web.ajax.UnfollowSoneAjaxPage;
74 import net.pterodactylus.sone.web.ajax.UnlikeAjaxPage;
75 import net.pterodactylus.sone.web.ajax.UnlockSoneAjaxPage;
76 import net.pterodactylus.sone.web.page.PageToadlet;
77 import net.pterodactylus.sone.web.page.PageToadletFactory;
78 import net.pterodactylus.sone.web.page.StaticPage;
79 import net.pterodactylus.util.logging.Logging;
80 import net.pterodactylus.util.notify.Notification;
81 import net.pterodactylus.util.notify.NotificationManager;
82 import net.pterodactylus.util.notify.TemplateNotification;
83 import net.pterodactylus.util.template.DateFilter;
84 import net.pterodactylus.util.template.DefaultTemplateFactory;
85 import net.pterodactylus.util.template.MatchFilter;
86 import net.pterodactylus.util.template.PaginationPlugin;
87 import net.pterodactylus.util.template.ReflectionAccessor;
88 import net.pterodactylus.util.template.Template;
89 import net.pterodactylus.util.template.TemplateException;
90 import net.pterodactylus.util.template.TemplateFactory;
91 import net.pterodactylus.util.template.TemplateProvider;
92 import net.pterodactylus.util.template.XmlFilter;
93 import net.pterodactylus.util.thread.Ticker;
94 import net.pterodactylus.util.version.Version;
95 import freenet.clients.http.SessionManager;
96 import freenet.clients.http.SessionManager.Session;
97 import freenet.clients.http.ToadletContainer;
98 import freenet.clients.http.ToadletContext;
99 import freenet.l10n.BaseL10n;
102 * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
103 * references to l10n helpers.
105 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
107 public class WebInterface implements CoreListener {
110 private static final Logger logger = Logging.getLogger(WebInterface.class);
112 /** The notification manager. */
113 private final NotificationManager notificationManager = new NotificationManager();
115 /** The Sone plugin. */
116 private final SonePlugin sonePlugin;
118 /** The registered toadlets. */
119 private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
121 /** The form password. */
122 private final String formPassword;
124 /** The template factory. */
125 private DefaultTemplateFactory templateFactory;
127 /** The “new Sone” notification. */
128 private final ListNotification<Sone> newSoneNotification;
130 /** The “new post” notification. */
131 private final ListNotification<Post> newPostNotification;
133 /** The “new reply” notification. */
134 private final ListNotification<Reply> newReplyNotification;
136 /** The “rescuing Sone” notification. */
137 private final ListNotification<Sone> rescuingSonesNotification;
139 /** The “Sone rescued” notification. */
140 private final ListNotification<Sone> sonesRescuedNotification;
142 /** Sone locked notification ticker objects. */
143 private final Map<Sone, Object> lockedSonesTickerObjects = Collections.synchronizedMap(new HashMap<Sone, Object>());
145 /** The “Sone locked” notification. */
146 private final ListNotification<Sone> lockedSonesNotification;
148 /** The “new version” notification. */
149 private final TemplateNotification newVersionNotification;
152 * Creates a new web interface.
157 public WebInterface(SonePlugin sonePlugin) {
158 this.sonePlugin = sonePlugin;
159 formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
161 templateFactory = new DefaultTemplateFactory();
162 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
163 templateFactory.addAccessor(Collection.class, new CollectionAccessor());
164 templateFactory.addAccessor(Sone.class, new SoneAccessor(getCore()));
165 templateFactory.addAccessor(Post.class, new PostAccessor(getCore(), templateFactory));
166 templateFactory.addAccessor(Reply.class, new ReplyAccessor(getCore(), templateFactory));
167 templateFactory.addAccessor(Album.class, new AlbumAccessor());
168 templateFactory.addAccessor(Identity.class, new IdentityAccessor(getCore()));
169 templateFactory.addAccessor(NotificationManager.class, new NotificationManagerAccessor());
170 templateFactory.addFilter("date", new DateFilter());
171 templateFactory.addFilter("l10n", new L10nFilter(getL10n()));
172 templateFactory.addFilter("substring", new SubstringFilter());
173 templateFactory.addFilter("xml", new XmlFilter());
174 templateFactory.addFilter("change", new RequestChangeFilter());
175 templateFactory.addFilter("match", new MatchFilter());
176 templateFactory.addFilter("css", new CssClassNameFilter());
177 templateFactory.addPlugin("getpage", new GetPagePlugin());
178 templateFactory.addPlugin("paginate", new PaginationPlugin());
179 templateFactory.setTemplateProvider(new ClassPathTemplateProvider(templateFactory));
180 templateFactory.addTemplateObject("formPassword", formPassword);
182 /* create notifications. */
183 Template newSoneNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/newSoneNotification.html"));
184 newSoneNotification = new ListNotification<Sone>("new-sone-notification", "sones", newSoneNotificationTemplate);
186 Template newPostNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/newPostNotification.html"));
187 newPostNotification = new ListNotification<Post>("new-post-notification", "posts", newPostNotificationTemplate);
189 Template newReplyNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/newReplyNotification.html"));
190 newReplyNotification = new ListNotification<Reply>("new-replies-notification", "replies", newReplyNotificationTemplate);
192 Template rescuingSonesTemplate = templateFactory.createTemplate(createReader("/templates/notify/rescuingSonesNotification.html"));
193 rescuingSonesNotification = new ListNotification<Sone>("sones-being-rescued-notification", "sones", rescuingSonesTemplate);
195 Template sonesRescuedTemplate = templateFactory.createTemplate(createReader("/templates/notify/sonesRescuedNotification.html"));
196 sonesRescuedNotification = new ListNotification<Sone>("sones-rescued-notification", "sones", sonesRescuedTemplate);
198 Template lockedSonesTemplate = templateFactory.createTemplate(createReader("/templates/notify/lockedSonesNotification.html"));
199 lockedSonesNotification = new ListNotification<Sone>("sones-locked-notification", "sones", lockedSonesTemplate);
201 Template newVersionTemplate = templateFactory.createTemplate(createReader("/templates/notify/newVersionNotification.html"));
202 newVersionNotification = new TemplateNotification("new-version-notification", newVersionTemplate);
210 * Returns the Sone core used by the Sone plugin.
212 * @return The Sone core
214 public Core getCore() {
215 return sonePlugin.core();
219 * Returns the current session, creating a new session if there is no
222 * @param toadletContenxt
223 * The toadlet context
224 * @return The current session, or {@code null} if there is no current
227 public Session getCurrentSession(ToadletContext toadletContenxt) {
228 return getCurrentSession(toadletContenxt, true);
232 * Returns the current session, creating a new session if there is no
233 * current session and {@code create} is {@code true}.
235 * @param toadletContenxt
236 * The toadlet context
238 * {@code true} to create a new session if there is no current
239 * session, {@code false} otherwise
240 * @return The current session, or {@code null} if there is no current
243 public Session getCurrentSession(ToadletContext toadletContenxt, boolean create) {
244 Session session = getSessionManager().useSession(toadletContenxt);
245 if (create && (session == null)) {
246 session = getSessionManager().createSession(UUID.randomUUID().toString(), toadletContenxt);
252 * Returns the currently logged in Sone.
254 * @param toadletContext
255 * The toadlet context
256 * @return The currently logged in Sone, or {@code null} if no Sone is
257 * currently logged in
259 public Sone getCurrentSone(ToadletContext toadletContext) {
260 return getCurrentSone(toadletContext, true);
264 * Returns the currently logged in Sone.
266 * @param toadletContext
267 * The toadlet context
269 * {@code true} to create a new session if no session exists,
270 * {@code false} to not create a new session
271 * @return The currently logged in Sone, or {@code null} if no Sone is
272 * currently logged in
274 public Sone getCurrentSone(ToadletContext toadletContext, boolean create) {
275 return getCurrentSone(getCurrentSession(toadletContext, create));
279 * Returns the currently logged in Sone.
283 * @return The currently logged in Sone, or {@code null} if no Sone is
284 * currently logged in
286 public Sone getCurrentSone(Session session) {
287 if (session == null) {
290 String soneId = (String) session.getAttribute("Sone.CurrentSone");
291 if (soneId == null) {
294 return getCore().getLocalSone(soneId, false);
298 * Sets the currently logged in Sone.
300 * @param toadletContext
301 * The toadlet context
303 * The Sone to set as currently logged in
305 public void setCurrentSone(ToadletContext toadletContext, Sone sone) {
306 Session session = getCurrentSession(toadletContext);
308 session.removeAttribute("Sone.CurrentSone");
310 session.setAttribute("Sone.CurrentSone", sone.getId());
315 * Returns the notification manager.
317 * @return The notification manager
319 public NotificationManager getNotifications() {
320 return notificationManager;
324 * Returns the l10n helper of the node.
326 * @return The node’s l10n helper
328 public BaseL10n getL10n() {
329 return sonePlugin.l10n().getBase();
333 * Returns the session manager of the node.
335 * @return The node’s session manager
337 public SessionManager getSessionManager() {
338 return sonePlugin.pluginRespirator().getSessionManager("Sone");
342 * Returns the node’s form password.
344 * @return The form password
346 public String getFormPassword() {
351 * Returns the posts that have been announced as new in the
352 * {@link #newPostNotification}.
354 * @return The new posts
356 public Set<Post> getNewPosts() {
357 return new HashSet<Post>(newPostNotification.getElements());
361 * Returns the replies that have been announced as new in the
362 * {@link #newReplyNotification}.
364 * @return The new replies
366 public Set<Reply> getNewReplies() {
367 return new HashSet<Reply>(newReplyNotification.getElements());
371 * Sets whether the current start of the plugin is the first start. It is
372 * considered a first start if the configuration file does not exist.
375 * {@code true} if no configuration file existed when Sone was
376 * loaded, {@code false} otherwise
378 public void setFirstStart(boolean firstStart) {
380 Template firstStartNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/firstStartNotification.html"));
381 Notification firstStartNotification = new TemplateNotification("first-start-notification", firstStartNotificationTemplate);
382 notificationManager.addNotification(firstStartNotification);
387 * Sets whether Sone was started with a fresh configuration file.
390 * {@code true} if Sone was started with a fresh configuration,
391 * {@code false} if the existing configuration could be read
393 public void setNewConfig(boolean newConfig) {
394 if (newConfig && !hasFirstStartNotification()) {
395 Template configNotReadNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/configNotReadNotification.html"));
396 Notification configNotReadNotification = new TemplateNotification("config-not-read-notification", configNotReadNotificationTemplate);
397 notificationManager.addNotification(configNotReadNotification);
406 * Returns whether the first start notification is currently displayed.
408 * @return {@code true} if the first-start notification is currently
409 * displayed, {@code false} otherwise
411 private boolean hasFirstStartNotification() {
412 return notificationManager.getNotification("first-start-notification") != null;
420 * Starts the web interface and registers all toadlets.
422 public void start() {
425 /* notification templates. */
426 Template startupNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/startupNotification.html"));
428 final TemplateNotification startupNotification = new TemplateNotification("startup-notification", startupNotificationTemplate);
429 notificationManager.addNotification(startupNotification);
431 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (120 * 1000), new Runnable() {
435 startupNotification.dismiss();
437 }, "Sone Startup Notification Remover");
439 Template wotMissingNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/wotMissingNotification.html"));
440 final TemplateNotification wotMissingNotification = new TemplateNotification("wot-missing-notification", wotMissingNotificationTemplate);
441 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (15 * 1000), new Runnable() {
444 @SuppressWarnings("synthetic-access")
446 if (getCore().getIdentityManager().isConnected()) {
447 wotMissingNotification.dismiss();
449 notificationManager.addNotification(wotMissingNotification);
451 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (15 * 1000), this, "Sone WoT Connector Checker");
454 }, "Sone WoT Connector Checker");
458 * Stops the web interface and unregisters all toadlets.
461 unregisterToadlets();
462 Ticker.getInstance().stop();
470 * Register all toadlets.
472 private void registerToadlets() {
473 Template emptyTemplate = templateFactory.createTemplate(new StringReader(""));
474 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
475 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
476 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
477 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
478 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
479 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
480 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
481 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
482 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
483 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
484 Template deleteReplyTemplate = templateFactory.createTemplate(createReader("/templates/deleteReply.html"));
485 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
486 Template imageBrowserTemplate = templateFactory.createTemplate(createReader("/templates/imageBrowser.html"));
487 Template createAlbumTemplate = templateFactory.createTemplate(createReader("/templates/createAlbum.html"));
488 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
489 Template optionsTemplate = templateFactory.createTemplate(createReader("/templates/options.html"));
490 Template aboutTemplate = templateFactory.createTemplate(createReader("/templates/about.html"));
491 Template postTemplate = templateFactory.createTemplate(createReader("/templates/include/viewPost.html"));
492 Template replyTemplate = templateFactory.createTemplate(createReader("/templates/include/viewReply.html"));
494 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
495 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
496 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
497 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
498 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
499 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
500 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
501 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
502 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
503 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikePage(emptyTemplate, this)));
504 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikePage(emptyTemplate, this)));
505 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
506 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
507 pageToadlets.add(pageToadletFactory.createPageToadlet(new LockSonePage(emptyTemplate, this)));
508 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlockSonePage(emptyTemplate, this)));
509 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(emptyTemplate, this)));
510 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(emptyTemplate, this)));
511 pageToadlets.add(pageToadletFactory.createPageToadlet(new ImageBrowserPage(imageBrowserTemplate, this), "ImageBrowser"));
512 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateAlbumPage(createAlbumTemplate, this)));
513 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
514 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
515 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(emptyTemplate, this), "Logout"));
516 pageToadlets.add(pageToadletFactory.createPageToadlet(new OptionsPage(optionsTemplate, this), "Options"));
517 pageToadlets.add(pageToadletFactory.createPageToadlet(new AboutPage(aboutTemplate, this, SonePlugin.VERSION), "About"));
518 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
519 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationPage(emptyTemplate, this)));
520 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
521 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
522 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
523 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
524 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetStatusAjaxPage(this)));
525 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationAjaxPage(this)));
526 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostAjaxPage(this)));
527 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyAjaxPage(this)));
528 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetReplyAjaxPage(this, replyTemplate)));
529 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetPostAjaxPage(this, postTemplate)));
530 pageToadlets.add(pageToadletFactory.createPageToadlet(new MarkPostAsKnownPage(this)));
531 pageToadlets.add(pageToadletFactory.createPageToadlet(new MarkReplyAsKnownPage(this)));
532 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostAjaxPage(this)));
533 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyAjaxPage(this)));
534 pageToadlets.add(pageToadletFactory.createPageToadlet(new LockSoneAjaxPage(this)));
535 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlockSoneAjaxPage(this)));
536 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSoneAjaxPage(this)));
537 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSoneAjaxPage(this)));
538 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikeAjaxPage(this)));
539 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikeAjaxPage(this)));
540 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetLikesAjaxPage(this)));
542 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
543 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
544 for (PageToadlet toadlet : pageToadlets) {
545 String menuName = toadlet.getMenuName();
546 if (menuName != null) {
547 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
549 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
555 * Unregisters all toadlets.
557 private void unregisterToadlets() {
558 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
559 for (PageToadlet pageToadlet : pageToadlets) {
560 toadletContainer.unregister(pageToadlet);
562 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
566 * Creates a {@link Reader} from the {@link InputStream} for the resource
567 * with the given name.
569 * @param resourceName
570 * The name of the resource
571 * @return A {@link Reader} for the resource
573 private Reader createReader(String resourceName) {
575 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
576 } catch (UnsupportedEncodingException uee1) {
582 // CORELISTENER METHODS
589 public void rescuingSone(Sone sone) {
590 rescuingSonesNotification.add(sone);
591 notificationManager.addNotification(rescuingSonesNotification);
598 public void rescuedSone(Sone sone) {
599 rescuingSonesNotification.remove(sone);
600 sonesRescuedNotification.add(sone);
601 notificationManager.addNotification(sonesRescuedNotification);
608 public void newSoneFound(Sone sone) {
609 newSoneNotification.add(sone);
610 if (!hasFirstStartNotification()) {
611 notificationManager.addNotification(newSoneNotification);
619 public void newPostFound(Post post) {
620 newPostNotification.add(post);
621 if (!hasFirstStartNotification()) {
622 notificationManager.addNotification(newPostNotification);
624 getCore().markPostKnown(post);
632 public void newReplyFound(Reply reply) {
633 if (reply.getPost().getSone() == null) {
636 newReplyNotification.add(reply);
637 if (!hasFirstStartNotification()) {
638 notificationManager.addNotification(newReplyNotification);
640 getCore().markReplyKnown(reply);
648 public void markSoneKnown(Sone sone) {
649 newSoneNotification.remove(sone);
656 public void markPostKnown(Post post) {
657 newPostNotification.remove(post);
664 public void markReplyKnown(Reply reply) {
665 newReplyNotification.remove(reply);
672 public void postRemoved(Post post) {
673 newPostNotification.remove(post);
680 public void replyRemoved(Reply reply) {
681 newReplyNotification.remove(reply);
688 public void soneLocked(final Sone sone) {
689 Object tickerObject = Ticker.getInstance().registerEvent(System.currentTimeMillis() + (5 * 60) * 1000, new Runnable() {
692 @SuppressWarnings("synthetic-access")
694 lockedSonesNotification.add(sone);
695 lockedSonesTickerObjects.remove(sone);
696 notificationManager.addNotification(lockedSonesNotification);
698 }, "Sone Locked Notification");
699 lockedSonesTickerObjects.put(sone, tickerObject);
706 public void soneUnlocked(Sone sone) {
707 lockedSonesNotification.remove(sone);
708 Ticker.getInstance().deregisterEvent(lockedSonesTickerObjects.remove(sone));
715 public void updateFound(Version version, long releaseTime) {
716 newVersionNotification.set("version", version);
717 newVersionNotification.set("releaseTime", releaseTime);
718 notificationManager.addNotification(newVersionNotification);
722 * Template provider implementation that uses
723 * {@link WebInterface#createReader(String)} to load templates for
726 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
728 private class ClassPathTemplateProvider implements TemplateProvider {
730 /** The template factory. */
731 @SuppressWarnings("hiding")
732 private final TemplateFactory templateFactory;
735 * Creates a new template provider that locates templates on the
738 * @param templateFactory
739 * The template factory to create the templates
741 public ClassPathTemplateProvider(TemplateFactory templateFactory) {
742 this.templateFactory = templateFactory;
749 @SuppressWarnings("synthetic-access")
750 public Template getTemplate(String templateName) {
751 Reader templateReader = createReader("/templates/" + templateName);
752 if (templateReader == null) {
755 Template template = templateFactory.createTemplate(templateReader);
758 } catch (TemplateException te1) {
759 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);