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