src/main/java/net/pterodactylus/sone/web/WebInterface.java

   1 /*
   2  * FreenetSone - WebInterface.java - Copyright © 2010 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.web;
  19
  20 import java.io.InputStream;
  21 import java.io.InputStreamReader;
  22 import java.io.Reader;
  23 import java.io.UnsupportedEncodingException;
  24 import java.util.ArrayList;
  25 import java.util.Collection;
  26 import java.util.Collections;
  27 import java.util.HashMap;
  28 import java.util.HashSet;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.Set;
  32 import java.util.UUID;
  33 import java.util.logging.Level;
  34 import java.util.logging.Logger;
  35
  36 import net.pterodactylus.sone.core.Core;
  37 import net.pterodactylus.sone.core.CoreListener;
  38 import net.pterodactylus.sone.data.Post;
  39 import net.pterodactylus.sone.data.Reply;
  40 import net.pterodactylus.sone.data.Sone;
  41 import net.pterodactylus.sone.freenet.L10nFilter;
  42 import net.pterodactylus.sone.freenet.wot.Identity;
  43 import net.pterodactylus.sone.freenet.wot.Trust;
  44 import net.pterodactylus.sone.main.SonePlugin;
  45 import net.pterodactylus.sone.notify.ListNotification;
  46 import net.pterodactylus.sone.template.CollectionAccessor;
  47 import net.pterodactylus.sone.template.CssClassNameFilter;
  48 import net.pterodactylus.sone.template.GetPagePlugin;
  49 import net.pterodactylus.sone.template.IdentityAccessor;
  50 import net.pterodactylus.sone.template.NotificationManagerAccessor;
  51 import net.pterodactylus.sone.template.PostAccessor;
  52 import net.pterodactylus.sone.template.ReplyAccessor;
  53 import net.pterodactylus.sone.template.RequestChangeFilter;
  54 import net.pterodactylus.sone.template.SoneAccessor;
  55 import net.pterodactylus.sone.template.SubstringFilter;
  56 import net.pterodactylus.sone.template.TrustAccessor;
  57 import net.pterodactylus.sone.web.ajax.CreatePostAjaxPage;
  58 import net.pterodactylus.sone.web.ajax.CreateReplyAjaxPage;
  59 import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
  60 import net.pterodactylus.sone.web.ajax.DeleteReplyAjaxPage;
  61 import net.pterodactylus.sone.web.ajax.DismissNotificationAjaxPage;
  62 import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
  63 import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
  64 import net.pterodactylus.sone.web.ajax.GetPostAjaxPage;
  65 import net.pterodactylus.sone.web.ajax.GetReplyAjaxPage;
  66 import net.pterodactylus.sone.web.ajax.GetStatusAjaxPage;
  67 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
  68 import net.pterodactylus.sone.web.ajax.LikeAjaxPage;
  69 import net.pterodactylus.sone.web.ajax.LockSoneAjaxPage;
  70 import net.pterodactylus.sone.web.ajax.MarkPostAsKnownPage;
  71 import net.pterodactylus.sone.web.ajax.MarkReplyAsKnownPage;
  72 import net.pterodactylus.sone.web.ajax.UnfollowSoneAjaxPage;
  73 import net.pterodactylus.sone.web.ajax.UnlikeAjaxPage;
  74 import net.pterodactylus.sone.web.ajax.UnlockSoneAjaxPage;
  75 import net.pterodactylus.sone.web.page.PageToadlet;
  76 import net.pterodactylus.sone.web.page.PageToadletFactory;
  77 import net.pterodactylus.sone.web.page.StaticPage;
  78 import net.pterodactylus.util.logging.Logging;
  79 import net.pterodactylus.util.notify.Notification;
  80 import net.pterodactylus.util.notify.NotificationManager;
  81 import net.pterodactylus.util.notify.TemplateNotification;
  82 import net.pterodactylus.util.template.DateFilter;
  83 import net.pterodactylus.util.template.DefaultTemplateFactory;
  84 import net.pterodactylus.util.template.MatchFilter;
  85 import net.pterodactylus.util.template.PaginationPlugin;
  86 import net.pterodactylus.util.template.ReflectionAccessor;
  87 import net.pterodactylus.util.template.Template;
  88 import net.pterodactylus.util.template.TemplateException;
  89 import net.pterodactylus.util.template.TemplateFactory;
  90 import net.pterodactylus.util.template.TemplateProvider;
  91 import net.pterodactylus.util.template.XmlFilter;
  92 import net.pterodactylus.util.thread.Ticker;
  93 import freenet.clients.http.SessionManager;
  94 import freenet.clients.http.SessionManager.Session;
  95 import freenet.clients.http.ToadletContainer;
  96 import freenet.clients.http.ToadletContext;
  97 import freenet.l10n.BaseL10n;
  98
  99 /**
 100  * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
 101  * references to l10n helpers.
 102  *
 103  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 104  */
 105 public class WebInterface implements CoreListener {
 106
 107         /** The logger. */
 108         private static final Logger logger = Logging.getLogger(WebInterface.class);
 109
 110         /** The notification manager. */
 111         private final NotificationManager notificationManager = new NotificationManager();
 112
 113         /** The Sone plugin. */
 114         private final SonePlugin sonePlugin;
 115
 116         /** The registered toadlets. */
 117         private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
 118
 119         /** The form password. */
 120         private final String formPassword;
 121
 122         /** The template factory. */
 123         private DefaultTemplateFactory templateFactory;
 124
 125         /** The “new Sone” notification. */
 126         private final ListNotification<Sone> newSoneNotification;
 127
 128         /** The “new post” notification. */
 129         private final ListNotification<Post> newPostNotification;
 130
 131         /** The “new reply” notification. */
 132         private final ListNotification<Reply> newReplyNotification;
 133
 134         /** The “rescuing Sone” notification. */
 135         private final ListNotification<Sone> rescuingSonesNotification;
 136
 137         /** The “Sone rescued” notification. */
 138         private final ListNotification<Sone> sonesRescuedNotification;
 139
 140         /** Sone locked notification ticker objects. */
 141         private final Map<Sone, Object> lockedSonesTickerObjects = Collections.synchronizedMap(new HashMap<Sone, Object>());
 142
 143         /** The “Sone locked” notification. */
 144         private final ListNotification<Sone> lockedSonesNotification;
 145
 146         /**
 147          * Creates a new web interface.
 148          *
 149          * @param sonePlugin
 150          *            The Sone plugin
 151          */
 152         public WebInterface(SonePlugin sonePlugin) {
 153                 this.sonePlugin = sonePlugin;
 154                 formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
 155
 156                 templateFactory = new DefaultTemplateFactory();
 157                 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
 158                 templateFactory.addAccessor(Collection.class, new CollectionAccessor());
 159                 templateFactory.addAccessor(Sone.class, new SoneAccessor(getCore()));
 160                 templateFactory.addAccessor(Post.class, new PostAccessor(getCore(), templateFactory));
 161                 templateFactory.addAccessor(Reply.class, new ReplyAccessor(getCore(), templateFactory));
 162                 templateFactory.addAccessor(Identity.class, new IdentityAccessor(getCore()));
 163                 templateFactory.addAccessor(NotificationManager.class, new NotificationManagerAccessor());
 164                 templateFactory.addAccessor(Trust.class, new TrustAccessor());
 165                 templateFactory.addFilter("date", new DateFilter());
 166                 templateFactory.addFilter("l10n", new L10nFilter(getL10n()));
 167                 templateFactory.addFilter("substring", new SubstringFilter());
 168                 templateFactory.addFilter("xml", new XmlFilter());
 169                 templateFactory.addFilter("change", new RequestChangeFilter());
 170                 templateFactory.addFilter("match", new MatchFilter());
 171                 templateFactory.addFilter("css", new CssClassNameFilter());
 172                 templateFactory.addPlugin("getpage", new GetPagePlugin());
 173                 templateFactory.addPlugin("paginate", new PaginationPlugin());
 174                 templateFactory.setTemplateProvider(new ClassPathTemplateProvider(templateFactory));
 175                 templateFactory.addTemplateObject("formPassword", formPassword);
 176
 177                 /* create notifications. */
 178                 Template newSoneNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/newSoneNotification.html"));
 179                 newSoneNotification = new ListNotification<Sone>("new-sone-notification", "sones", newSoneNotificationTemplate);
 180
 181                 Template newPostNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/newPostNotification.html"));
 182                 newPostNotification = new ListNotification<Post>("new-post-notification", "posts", newPostNotificationTemplate);
 183
 184                 Template newReplyNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/newReplyNotification.html"));
 185                 newReplyNotification = new ListNotification<Reply>("new-replies-notification", "replies", newReplyNotificationTemplate);
 186
 187                 Template rescuingSonesTemplate = templateFactory.createTemplate(createReader("/templates/notify/rescuingSonesNotification.html"));
 188                 rescuingSonesNotification = new ListNotification<Sone>("sones-being-rescued-notification", "sones", rescuingSonesTemplate);
 189
 190                 Template sonesRescuedTemplate = templateFactory.createTemplate(createReader("/templates/notify/sonesRescuedNotification.html"));
 191                 sonesRescuedNotification = new ListNotification<Sone>("sones-rescued-notification", "sones", sonesRescuedTemplate);
 192
 193                 Template lockedSonesTemplate = templateFactory.createTemplate(createReader("/templates/notify/lockedSonesNotification.html"));
 194                 lockedSonesNotification = new ListNotification<Sone>("sones-locked-notification", "sones", lockedSonesTemplate);
 195         }
 196
 197         //
 198         // ACCESSORS
 199         //
 200
 201         /**
 202          * Returns the Sone core used by the Sone plugin.
 203          *
 204          * @return The Sone core
 205          */
 206         public Core getCore() {
 207                 return sonePlugin.core();
 208         }
 209
 210         /**
 211          * Returns the current session, creating a new session if there is no
 212          * current session.
 213          *
 214          * @param toadletContenxt
 215          *            The toadlet context
 216          * @return The current session, or {@code null} if there is no current
 217          *         session
 218          */
 219         public Session getCurrentSession(ToadletContext toadletContenxt) {
 220                 return getCurrentSession(toadletContenxt, true);
 221         }
 222
 223         /**
 224          * Returns the current session, creating a new session if there is no
 225          * current session and {@code create} is {@code true}.
 226          *
 227          * @param toadletContenxt
 228          *            The toadlet context
 229          * @param create
 230          *            {@code true} to create a new session if there is no current
 231          *            session, {@code false} otherwise
 232          * @return The current session, or {@code null} if there is no current
 233          *         session
 234          */
 235         public Session getCurrentSession(ToadletContext toadletContenxt, boolean create) {
 236                 Session session = getSessionManager().useSession(toadletContenxt);
 237                 if (create && (session == null)) {
 238                         session = getSessionManager().createSession(UUID.randomUUID().toString(), toadletContenxt);
 239                 }
 240                 return session;
 241         }
 242
 243         /**
 244          * Returns the currently logged in Sone.
 245          *
 246          * @param toadletContext
 247          *            The toadlet context
 248          * @return The currently logged in Sone, or {@code null} if no Sone is
 249          *         currently logged in
 250          */
 251         public Sone getCurrentSone(ToadletContext toadletContext) {
 252                 return getCurrentSone(toadletContext, true);
 253         }
 254
 255         /**
 256          * Returns the currently logged in Sone.
 257          *
 258          * @param toadletContext
 259          *            The toadlet context
 260          * @param create
 261          *            {@code true} to create a new session if no session exists,
 262          *            {@code false} to not create a new session
 263          * @return The currently logged in Sone, or {@code null} if no Sone is
 264          *         currently logged in
 265          */
 266         public Sone getCurrentSone(ToadletContext toadletContext, boolean create) {
 267                 return getCurrentSone(getCurrentSession(toadletContext, create));
 268         }
 269
 270         /**
 271          * Returns the currently logged in Sone.
 272          *
 273          * @param session
 274          *            The session
 275          * @return The currently logged in Sone, or {@code null} if no Sone is
 276          *         currently logged in
 277          */
 278         public Sone getCurrentSone(Session session) {
 279                 if (session == null) {
 280                         return null;
 281                 }
 282                 String soneId = (String) session.getAttribute("Sone.CurrentSone");
 283                 if (soneId == null) {
 284                         return null;
 285                 }
 286                 return getCore().getLocalSone(soneId, false);
 287         }
 288
 289         /**
 290          * Sets the currently logged in Sone.
 291          *
 292          * @param toadletContext
 293          *            The toadlet context
 294          * @param sone
 295          *            The Sone to set as currently logged in
 296          */
 297         public void setCurrentSone(ToadletContext toadletContext, Sone sone) {
 298                 Session session = getCurrentSession(toadletContext);
 299                 if (sone == null) {
 300                         session.removeAttribute("Sone.CurrentSone");
 301                 } else {
 302                         session.setAttribute("Sone.CurrentSone", sone.getId());
 303                 }
 304         }
 305
 306         /**
 307          * Returns the notification manager.
 308          *
 309          * @return The notification manager
 310          */
 311         public NotificationManager getNotifications() {
 312                 return notificationManager;
 313         }
 314
 315         /**
 316          * Returns the l10n helper of the node.
 317          *
 318          * @return The node’s l10n helper
 319          */
 320         public BaseL10n getL10n() {
 321                 return sonePlugin.l10n().getBase();
 322         }
 323
 324         /**
 325          * Returns the session manager of the node.
 326          *
 327          * @return The node’s session manager
 328          */
 329         public SessionManager getSessionManager() {
 330                 return sonePlugin.pluginRespirator().getSessionManager("Sone");
 331         }
 332
 333         /**
 334          * Returns the node’s form password.
 335          *
 336          * @return The form password
 337          */
 338         public String getFormPassword() {
 339                 return formPassword;
 340         }
 341
 342         /**
 343          * Returns the posts that have been announced as new in the
 344          * {@link #newPostNotification}.
 345          *
 346          * @return The new posts
 347          */
 348         public Set<Post> getNewPosts() {
 349                 return new HashSet<Post>(newPostNotification.getElements());
 350         }
 351
 352         /**
 353          * Returns the replies that have been announced as new in the
 354          * {@link #newReplyNotification}.
 355          *
 356          * @return The new replies
 357          */
 358         public Set<Reply> getNewReplies() {
 359                 return new HashSet<Reply>(newReplyNotification.getElements());
 360         }
 361
 362         /**
 363          * Sets whether the current start of the plugin is the first start. It is
 364          * considered a first start if the configuration file does not exist.
 365          *
 366          * @param firstStart
 367          *            {@code true} if no configuration file existed when Sone was
 368          *            loaded, {@code false} otherwise
 369          */
 370         public void setFirstStart(boolean firstStart) {
 371                 if (firstStart) {
 372                         Template firstStartNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/firstStartNotification.html"));
 373                         Notification firstStartNotification = new TemplateNotification("first-start-notification", firstStartNotificationTemplate);
 374                         notificationManager.addNotification(firstStartNotification);
 375                 }
 376         }
 377
 378         /**
 379          * Sets whether Sone was started with a fresh configuration file.
 380          *
 381          * @param newConfig
 382          *            {@code true} if Sone was started with a fresh configuration,
 383          *            {@code false} if the existing configuration could be read
 384          */
 385         public void setNewConfig(boolean newConfig) {
 386                 if (newConfig && !hasFirstStartNotification()) {
 387                         Template configNotReadNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/configNotReadNotification.html"));
 388                         Notification configNotReadNotification = new TemplateNotification("config-not-read-notification", configNotReadNotificationTemplate);
 389                         notificationManager.addNotification(configNotReadNotification);
 390                 }
 391         }
 392
 393         //
 394         // PRIVATE ACCESSORS
 395         //
 396
 397         /**
 398          * Returns whether the first start notification is currently displayed.
 399          *
 400          * @return {@code true} if the first-start notification is currently
 401          *         displayed, {@code false} otherwise
 402          */
 403         private boolean hasFirstStartNotification() {
 404                 return notificationManager.getNotification("first-start-notification") != null;
 405         }
 406
 407         //
 408         // ACTIONS
 409         //
 410
 411         /**
 412          * Starts the web interface and registers all toadlets.
 413          */
 414         public void start() {
 415                 registerToadlets();
 416
 417                 /* notification templates. */
 418                 Template startupNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/startupNotification.html"));
 419
 420                 final TemplateNotification startupNotification = new TemplateNotification("startup-notification", startupNotificationTemplate);
 421                 notificationManager.addNotification(startupNotification);
 422
 423                 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (120 * 1000), new Runnable() {
 424
 425                         @Override
 426                         public void run() {
 427                                 startupNotification.dismiss();
 428                         }
 429                 }, "Sone Startup Notification Remover");
 430
 431                 Template wotMissingNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/wotMissingNotification.html"));
 432                 final TemplateNotification wotMissingNotification = new TemplateNotification("wot-missing-notification", wotMissingNotificationTemplate);
 433                 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (15 * 1000), new Runnable() {
 434
 435                         @Override
 436                         @SuppressWarnings("synthetic-access")
 437                         public void run() {
 438                                 if (getCore().getIdentityManager().isConnected()) {
 439                                         wotMissingNotification.dismiss();
 440                                 } else {
 441                                         notificationManager.addNotification(wotMissingNotification);
 442                                 }
 443                                 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (15 * 1000), this, "Sone WoT Connector Checker");
 444                         }
 445
 446                 }, "Sone WoT Connector Checker");
 447         }
 448
 449         /**
 450          * Stops the web interface and unregisters all toadlets.
 451          */
 452         public void stop() {
 453                 unregisterToadlets();
 454                 Ticker.getInstance().stop();
 455         }
 456
 457         //
 458         // PRIVATE METHODS
 459         //
 460
 461         /**
 462          * Register all toadlets.
 463          */
 464         private void registerToadlets() {
 465                 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
 466                 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
 467                 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
 468                 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
 469                 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
 470                 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
 471                 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
 472                 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
 473                 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
 474                 Template likePostTemplate = templateFactory.createTemplate(createReader("/templates/like.html"));
 475                 Template unlikePostTemplate = templateFactory.createTemplate(createReader("/templates/unlike.html"));
 476                 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
 477                 Template deleteReplyTemplate = templateFactory.createTemplate(createReader("/templates/deleteReply.html"));
 478                 Template lockSoneTemplate = templateFactory.createTemplate(createReader("/templates/lockSone.html"));
 479                 Template unlockSoneTemplate = templateFactory.createTemplate(createReader("/templates/unlockSone.html"));
 480                 Template followSoneTemplate = templateFactory.createTemplate(createReader("/templates/followSone.html"));
 481                 Template unfollowSoneTemplate = templateFactory.createTemplate(createReader("/templates/unfollowSone.html"));
 482                 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
 483                 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
 484                 Template dismissNotificationTemplate = templateFactory.createTemplate(createReader("/templates/dismissNotification.html"));
 485                 Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html"));
 486                 Template optionsTemplate = templateFactory.createTemplate(createReader("/templates/options.html"));
 487                 Template aboutTemplate = templateFactory.createTemplate(createReader("/templates/about.html"));
 488                 Template postTemplate = templateFactory.createTemplate(createReader("/templates/include/viewPost.html"));
 489                 Template replyTemplate = templateFactory.createTemplate(createReader("/templates/include/viewReply.html"));
 490
 491                 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
 492                 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
 493                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
 494                 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
 495                 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
 496                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
 497                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
 498                 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
 499                 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
 500                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikePage(likePostTemplate, this)));
 501                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikePage(unlikePostTemplate, this)));
 502                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
 503                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
 504                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LockSonePage(lockSoneTemplate, this)));
 505                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlockSonePage(unlockSoneTemplate, this)));
 506                 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(followSoneTemplate, this)));
 507                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(unfollowSoneTemplate, this)));
 508                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
 509                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
 510                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout"));
 511                 pageToadlets.add(pageToadletFactory.createPageToadlet(new OptionsPage(optionsTemplate, this), "Options"));
 512                 pageToadlets.add(pageToadletFactory.createPageToadlet(new AboutPage(aboutTemplate, this, SonePlugin.VERSION), "About"));
 513                 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
 514                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationPage(dismissNotificationTemplate, this)));
 515                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
 516                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
 517                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
 518                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
 519                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetStatusAjaxPage(this)));
 520                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationAjaxPage(this)));
 521                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostAjaxPage(this)));
 522                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyAjaxPage(this)));
 523                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetReplyAjaxPage(this, replyTemplate)));
 524                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetPostAjaxPage(this, postTemplate)));
 525                 pageToadlets.add(pageToadletFactory.createPageToadlet(new MarkPostAsKnownPage(this)));
 526                 pageToadlets.add(pageToadletFactory.createPageToadlet(new MarkReplyAsKnownPage(this)));
 527                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostAjaxPage(this)));
 528                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyAjaxPage(this)));
 529                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LockSoneAjaxPage(this)));
 530                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlockSoneAjaxPage(this)));
 531                 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSoneAjaxPage(this)));
 532                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSoneAjaxPage(this)));
 533                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikeAjaxPage(this)));
 534                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikeAjaxPage(this)));
 535                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetLikesAjaxPage(this)));
 536
 537                 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
 538                 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
 539                 for (PageToadlet toadlet : pageToadlets) {
 540                         String menuName = toadlet.getMenuName();
 541                         if (menuName != null) {
 542                                 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
 543                         } else {
 544                                 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
 545                         }
 546                 }
 547         }
 548
 549         /**
 550          * Unregisters all toadlets.
 551          */
 552         private void unregisterToadlets() {
 553                 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
 554                 for (PageToadlet pageToadlet : pageToadlets) {
 555                         toadletContainer.unregister(pageToadlet);
 556                 }
 557                 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
 558         }
 559
 560         /**
 561          * Creates a {@link Reader} from the {@link InputStream} for the resource
 562          * with the given name.
 563          *
 564          * @param resourceName
 565          *            The name of the resource
 566          * @return A {@link Reader} for the resource
 567          */
 568         private Reader createReader(String resourceName) {
 569                 try {
 570                         return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
 571                 } catch (UnsupportedEncodingException uee1) {
 572                         return null;
 573                 }
 574         }
 575
 576         //
 577         // CORELISTENER METHODS
 578         //
 579
 580         /**
 581          * {@inheritDoc}
 582          */
 583         @Override
 584         public void rescuingSone(Sone sone) {
 585                 rescuingSonesNotification.add(sone);
 586                 notificationManager.addNotification(rescuingSonesNotification);
 587         }
 588
 589         /**
 590          * {@inheritDoc}
 591          */
 592         @Override
 593         public void rescuedSone(Sone sone) {
 594                 rescuingSonesNotification.remove(sone);
 595                 sonesRescuedNotification.add(sone);
 596                 notificationManager.addNotification(sonesRescuedNotification);
 597         }
 598
 599         /**
 600          * {@inheritDoc}
 601          */
 602         @Override
 603         public void newSoneFound(Sone sone) {
 604                 newSoneNotification.add(sone);
 605                 if (!hasFirstStartNotification()) {
 606                         notificationManager.addNotification(newSoneNotification);
 607                 }
 608         }
 609
 610         /**
 611          * {@inheritDoc}
 612          */
 613         @Override
 614         public void newPostFound(Post post) {
 615                 newPostNotification.add(post);
 616                 if (!hasFirstStartNotification()) {
 617                         notificationManager.addNotification(newPostNotification);
 618                 } else {
 619                         getCore().markPostKnown(post);
 620                 }
 621         }
 622
 623         /**
 624          * {@inheritDoc}
 625          */
 626         @Override
 627         public void newReplyFound(Reply reply) {
 628                 if (reply.getPost().getSone() == null) {
 629                         return;
 630                 }
 631                 newReplyNotification.add(reply);
 632                 if (!hasFirstStartNotification()) {
 633                         notificationManager.addNotification(newReplyNotification);
 634                 } else {
 635                         getCore().markReplyKnown(reply);
 636                 }
 637         }
 638
 639         /**
 640          * {@inheritDoc}
 641          */
 642         @Override
 643         public void markSoneKnown(Sone sone) {
 644                 newSoneNotification.remove(sone);
 645         }
 646
 647         /**
 648          * {@inheritDoc}
 649          */
 650         @Override
 651         public void markPostKnown(Post post) {
 652                 newPostNotification.remove(post);
 653         }
 654
 655         /**
 656          * {@inheritDoc}
 657          */
 658         @Override
 659         public void markReplyKnown(Reply reply) {
 660                 newReplyNotification.remove(reply);
 661         }
 662
 663         /**
 664          * {@inheritDoc}
 665          */
 666         @Override
 667         public void postRemoved(Post post) {
 668                 newPostNotification.remove(post);
 669         }
 670
 671         /**
 672          * {@inheritDoc}
 673          */
 674         @Override
 675         public void replyRemoved(Reply reply) {
 676                 newReplyNotification.remove(reply);
 677         }
 678
 679         /**
 680          * {@inheritDoc}
 681          */
 682         @Override
 683         public void soneLocked(final Sone sone) {
 684                 Object tickerObject = Ticker.getInstance().registerEvent(System.currentTimeMillis() + (5 * 60) * 1000, new Runnable() {
 685
 686                         @Override
 687                         @SuppressWarnings("synthetic-access")
 688                         public void run() {
 689                                 lockedSonesNotification.add(sone);
 690                                 lockedSonesTickerObjects.remove(sone);
 691                                 notificationManager.addNotification(lockedSonesNotification);
 692                         }
 693                 }, "Sone Locked Notification");
 694                 lockedSonesTickerObjects.put(sone, tickerObject);
 695         }
 696
 697         /**
 698          * {@inheritDoc}
 699          */
 700         @Override
 701         public void soneUnlocked(Sone sone) {
 702                 lockedSonesNotification.remove(sone);
 703                 Ticker.getInstance().deregisterEvent(lockedSonesTickerObjects.remove(sone));
 704         }
 705
 706         /**
 707          * Template provider implementation that uses
 708          * {@link WebInterface#createReader(String)} to load templates for
 709          * inclusion.
 710          *
 711          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 712          */
 713         private class ClassPathTemplateProvider implements TemplateProvider {
 714
 715                 /** The template factory. */
 716                 @SuppressWarnings("hiding")
 717                 private final TemplateFactory templateFactory;
 718
 719                 /**
 720                  * Creates a new template provider that locates templates on the
 721                  * classpath.
 722                  *
 723                  * @param templateFactory
 724                  *            The template factory to create the templates
 725                  */
 726                 public ClassPathTemplateProvider(TemplateFactory templateFactory) {
 727                         this.templateFactory = templateFactory;
 728                 }
 729
 730                 /**
 731                  * {@inheritDoc}
 732                  */
 733                 @Override
 734                 @SuppressWarnings("synthetic-access")
 735                 public Template getTemplate(String templateName) {
 736                         Reader templateReader = createReader("/templates/" + templateName);
 737                         if (templateReader == null) {
 738                                 return null;
 739                         }
 740                         Template template = templateFactory.createTemplate(templateReader);
 741                         try {
 742                                 template.parse();
 743                         } catch (TemplateException te1) {
 744                                 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);
 745                         }
 746                         return template;
 747                 }
 748
 749         }
 750
 751 }