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