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