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