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

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