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