2 * Sone - WebInterface.java - Copyright © 2010–2012 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.web;
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;
34 import java.util.UUID;
35 import java.util.logging.Level;
36 import java.util.logging.Logger;
38 import net.pterodactylus.sone.core.Core;
39 import net.pterodactylus.sone.core.CoreListener;
40 import net.pterodactylus.sone.core.event.NewPostFoundEvent;
41 import net.pterodactylus.sone.core.event.NewSoneFoundEvent;
42 import net.pterodactylus.sone.data.Album;
43 import net.pterodactylus.sone.data.Image;
44 import net.pterodactylus.sone.data.Post;
45 import net.pterodactylus.sone.data.PostReply;
46 import net.pterodactylus.sone.data.Profile;
47 import net.pterodactylus.sone.data.Reply;
48 import net.pterodactylus.sone.data.Sone;
49 import net.pterodactylus.sone.freenet.L10nFilter;
50 import net.pterodactylus.sone.freenet.wot.Identity;
51 import net.pterodactylus.sone.freenet.wot.Trust;
52 import net.pterodactylus.sone.main.SonePlugin;
53 import net.pterodactylus.sone.notify.ListNotification;
54 import net.pterodactylus.sone.template.AlbumAccessor;
55 import net.pterodactylus.sone.template.CollectionAccessor;
56 import net.pterodactylus.sone.template.CssClassNameFilter;
57 import net.pterodactylus.sone.template.HttpRequestAccessor;
58 import net.pterodactylus.sone.template.IdentityAccessor;
59 import net.pterodactylus.sone.template.ImageAccessor;
60 import net.pterodactylus.sone.template.ImageLinkFilter;
61 import net.pterodactylus.sone.template.JavascriptFilter;
62 import net.pterodactylus.sone.template.ParserFilter;
63 import net.pterodactylus.sone.template.PostAccessor;
64 import net.pterodactylus.sone.template.ProfileAccessor;
65 import net.pterodactylus.sone.template.ReplyAccessor;
66 import net.pterodactylus.sone.template.ReplyGroupFilter;
67 import net.pterodactylus.sone.template.RequestChangeFilter;
68 import net.pterodactylus.sone.template.SoneAccessor;
69 import net.pterodactylus.sone.template.SubstringFilter;
70 import net.pterodactylus.sone.template.TrustAccessor;
71 import net.pterodactylus.sone.template.UniqueElementFilter;
72 import net.pterodactylus.sone.template.UnknownDateFilter;
73 import net.pterodactylus.sone.text.Part;
74 import net.pterodactylus.sone.text.SonePart;
75 import net.pterodactylus.sone.text.SoneTextParser;
76 import net.pterodactylus.sone.web.ajax.BookmarkAjaxPage;
77 import net.pterodactylus.sone.web.ajax.CreatePostAjaxPage;
78 import net.pterodactylus.sone.web.ajax.CreateReplyAjaxPage;
79 import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
80 import net.pterodactylus.sone.web.ajax.DeleteProfileFieldAjaxPage;
81 import net.pterodactylus.sone.web.ajax.DeleteReplyAjaxPage;
82 import net.pterodactylus.sone.web.ajax.DismissNotificationAjaxPage;
83 import net.pterodactylus.sone.web.ajax.DistrustAjaxPage;
84 import net.pterodactylus.sone.web.ajax.EditAlbumAjaxPage;
85 import net.pterodactylus.sone.web.ajax.EditImageAjaxPage;
86 import net.pterodactylus.sone.web.ajax.EditProfileFieldAjaxPage;
87 import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
88 import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
89 import net.pterodactylus.sone.web.ajax.GetNotificationsAjaxPage;
90 import net.pterodactylus.sone.web.ajax.GetPostAjaxPage;
91 import net.pterodactylus.sone.web.ajax.GetReplyAjaxPage;
92 import net.pterodactylus.sone.web.ajax.GetStatusAjaxPage;
93 import net.pterodactylus.sone.web.ajax.GetTimesAjaxPage;
94 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
95 import net.pterodactylus.sone.web.ajax.LikeAjaxPage;
96 import net.pterodactylus.sone.web.ajax.LockSoneAjaxPage;
97 import net.pterodactylus.sone.web.ajax.MarkAsKnownAjaxPage;
98 import net.pterodactylus.sone.web.ajax.MoveProfileFieldAjaxPage;
99 import net.pterodactylus.sone.web.ajax.TrustAjaxPage;
100 import net.pterodactylus.sone.web.ajax.UnbookmarkAjaxPage;
101 import net.pterodactylus.sone.web.ajax.UnfollowSoneAjaxPage;
102 import net.pterodactylus.sone.web.ajax.UnlikeAjaxPage;
103 import net.pterodactylus.sone.web.ajax.UnlockSoneAjaxPage;
104 import net.pterodactylus.sone.web.ajax.UntrustAjaxPage;
105 import net.pterodactylus.sone.web.page.FreenetRequest;
106 import net.pterodactylus.sone.web.page.PageToadlet;
107 import net.pterodactylus.sone.web.page.PageToadletFactory;
108 import net.pterodactylus.util.logging.Logging;
109 import net.pterodactylus.util.notify.Notification;
110 import net.pterodactylus.util.notify.NotificationManager;
111 import net.pterodactylus.util.notify.TemplateNotification;
112 import net.pterodactylus.util.template.ClassPathTemplateProvider;
113 import net.pterodactylus.util.template.CollectionSortFilter;
114 import net.pterodactylus.util.template.ContainsFilter;
115 import net.pterodactylus.util.template.DateFilter;
116 import net.pterodactylus.util.template.FormatFilter;
117 import net.pterodactylus.util.template.HtmlFilter;
118 import net.pterodactylus.util.template.MatchFilter;
119 import net.pterodactylus.util.template.ModFilter;
120 import net.pterodactylus.util.template.PaginationFilter;
121 import net.pterodactylus.util.template.ReflectionAccessor;
122 import net.pterodactylus.util.template.ReplaceFilter;
123 import net.pterodactylus.util.template.StoreFilter;
124 import net.pterodactylus.util.template.Template;
125 import net.pterodactylus.util.template.TemplateContextFactory;
126 import net.pterodactylus.util.template.TemplateParser;
127 import net.pterodactylus.util.template.TemplateProvider;
128 import net.pterodactylus.util.template.XmlFilter;
129 import net.pterodactylus.util.thread.Ticker;
130 import net.pterodactylus.util.version.Version;
131 import net.pterodactylus.util.web.RedirectPage;
132 import net.pterodactylus.util.web.StaticPage;
133 import net.pterodactylus.util.web.TemplatePage;
135 import com.google.common.collect.Collections2;
136 import com.google.common.collect.ImmutableSet;
137 import com.google.common.eventbus.Subscribe;
138 import com.google.inject.Inject;
140 import freenet.clients.http.SessionManager;
141 import freenet.clients.http.SessionManager.Session;
142 import freenet.clients.http.ToadletContainer;
143 import freenet.clients.http.ToadletContext;
144 import freenet.l10n.BaseL10n;
145 import freenet.support.api.HTTPRequest;
148 * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
149 * references to l10n helpers.
151 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
153 public class WebInterface implements CoreListener {
156 private static final Logger logger = Logging.getLogger(WebInterface.class);
158 /** The notification manager. */
159 private final NotificationManager notificationManager = new NotificationManager();
161 /** The Sone plugin. */
162 private final SonePlugin sonePlugin;
164 /** The registered toadlets. */
165 private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
167 /** The form password. */
168 private final String formPassword;
170 /** The template context factory. */
171 private final TemplateContextFactory templateContextFactory;
173 /** The Sone text parser. */
174 private final SoneTextParser soneTextParser;
176 /** The parser filter. */
177 private final ParserFilter parserFilter;
179 /** The “new Sone” notification. */
180 private final ListNotification<Sone> newSoneNotification;
182 /** The “new post” notification. */
183 private final ListNotification<Post> newPostNotification;
185 /** The “new reply” notification. */
186 private final ListNotification<PostReply> newReplyNotification;
188 /** The invisible “local post” notification. */
189 private final ListNotification<Post> localPostNotification;
191 /** The invisible “local reply” notification. */
192 private final ListNotification<PostReply> localReplyNotification;
194 /** The “you have been mentioned” notification. */
195 private final ListNotification<Post> mentionNotification;
197 /** Notifications for sone inserts. */
198 private final Map<Sone, TemplateNotification> soneInsertNotifications = new HashMap<Sone, TemplateNotification>();
200 /** Sone locked notification ticker objects. */
201 private final Map<Sone, Object> lockedSonesTickerObjects = Collections.synchronizedMap(new HashMap<Sone, Object>());
203 /** The “Sone locked” notification. */
204 private final ListNotification<Sone> lockedSonesNotification;
206 /** The “new version” notification. */
207 private final TemplateNotification newVersionNotification;
209 /** The “inserting images” notification. */
210 private final ListNotification<Image> insertingImagesNotification;
212 /** The “inserted images” notification. */
213 private final ListNotification<Image> insertedImagesNotification;
215 /** The “image insert failed” notification. */
216 private final ListNotification<Image> imageInsertFailedNotification;
219 * Creates a new web interface.
225 public WebInterface(SonePlugin sonePlugin) {
226 this.sonePlugin = sonePlugin;
227 formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
228 soneTextParser = new SoneTextParser(getCore(), getCore());
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(this));
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.addFilter("paginate", new PaginationFilter());
263 templateContextFactory.addProvider(TemplateProvider.TEMPLATE_CONTEXT_PROVIDER);
264 templateContextFactory.addProvider(new ClassPathTemplateProvider(WebInterface.class, "/templates/"));
265 templateContextFactory.addTemplateObject("webInterface", this);
266 templateContextFactory.addTemplateObject("formPassword", formPassword);
268 /* create notifications. */
269 Template newSoneNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newSoneNotification.html"));
270 newSoneNotification = new ListNotification<Sone>("new-sone-notification", "sones", newSoneNotificationTemplate, false);
272 Template newPostNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newPostNotification.html"));
273 newPostNotification = new ListNotification<Post>("new-post-notification", "posts", newPostNotificationTemplate, false);
275 Template localPostNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newPostNotification.html"));
276 localPostNotification = new ListNotification<Post>("local-post-notification", "posts", localPostNotificationTemplate, false);
278 Template newReplyNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newReplyNotification.html"));
279 newReplyNotification = new ListNotification<PostReply>("new-reply-notification", "replies", newReplyNotificationTemplate, false);
281 Template localReplyNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newReplyNotification.html"));
282 localReplyNotification = new ListNotification<PostReply>("local-reply-notification", "replies", localReplyNotificationTemplate, false);
284 Template mentionNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/mentionNotification.html"));
285 mentionNotification = new ListNotification<Post>("mention-notification", "posts", mentionNotificationTemplate, false);
287 Template lockedSonesTemplate = TemplateParser.parse(createReader("/templates/notify/lockedSonesNotification.html"));
288 lockedSonesNotification = new ListNotification<Sone>("sones-locked-notification", "sones", lockedSonesTemplate);
290 Template newVersionTemplate = TemplateParser.parse(createReader("/templates/notify/newVersionNotification.html"));
291 newVersionNotification = new TemplateNotification("new-version-notification", newVersionTemplate);
293 Template insertingImagesTemplate = TemplateParser.parse(createReader("/templates/notify/inserting-images-notification.html"));
294 insertingImagesNotification = new ListNotification<Image>("inserting-images-notification", "images", insertingImagesTemplate);
296 Template insertedImagesTemplate = TemplateParser.parse(createReader("/templates/notify/inserted-images-notification.html"));
297 insertedImagesNotification = new ListNotification<Image>("inserted-images-notification", "images", insertedImagesTemplate);
299 Template imageInsertFailedTemplate = TemplateParser.parse(createReader("/templates/notify/image-insert-failed-notification.html"));
300 imageInsertFailedNotification = new ListNotification<Image>("image-insert-failed-notification", "images", imageInsertFailedTemplate);
308 * Returns the Sone core used by the Sone plugin.
310 * @return The Sone core
312 public Core getCore() {
313 return sonePlugin.core();
317 * Returns the template context factory of the web interface.
319 * @return The template context factory
321 public TemplateContextFactory getTemplateContextFactory() {
322 return templateContextFactory;
326 * Returns the current session, creating a new session if there is no
329 * @param toadletContenxt
330 * The toadlet context
331 * @return The current session, or {@code null} if there is no current
334 public Session getCurrentSession(ToadletContext toadletContenxt) {
335 return getCurrentSession(toadletContenxt, true);
339 * Returns the current session, creating a new session if there is no
340 * current session and {@code create} is {@code true}.
342 * @param toadletContenxt
343 * The toadlet context
345 * {@code true} to create a new session if there is no current
346 * session, {@code false} otherwise
347 * @return The current session, or {@code null} if there is no current
350 public Session getCurrentSession(ToadletContext toadletContenxt, boolean create) {
351 Session session = getSessionManager().useSession(toadletContenxt);
352 if (create && (session == null)) {
353 session = getSessionManager().createSession(UUID.randomUUID().toString(), toadletContenxt);
359 * Returns the currently logged in Sone.
361 * @param toadletContext
362 * The toadlet context
363 * @return The currently logged in Sone, or {@code null} if no Sone is
364 * currently logged in
366 public Sone getCurrentSone(ToadletContext toadletContext) {
367 return getCurrentSone(toadletContext, true);
371 * Returns the currently logged in Sone.
373 * @param toadletContext
374 * The toadlet context
376 * {@code true} to create a new session if no session exists,
377 * {@code false} to not create a new session
378 * @return The currently logged in Sone, or {@code null} if no Sone is
379 * currently logged in
381 public Sone getCurrentSone(ToadletContext toadletContext, boolean create) {
382 Collection<Sone> localSones = getCore().getLocalSones();
383 if (localSones.size() == 1) {
384 return localSones.iterator().next();
386 return getCurrentSone(getCurrentSession(toadletContext, create));
390 * Returns the currently logged in Sone.
394 * @return The currently logged in Sone, or {@code null} if no Sone is
395 * currently logged in
397 public Sone getCurrentSone(Session session) {
398 if (session == null) {
401 String soneId = (String) session.getAttribute("Sone.CurrentSone");
402 if (soneId == null) {
405 return getCore().getLocalSone(soneId, false);
409 * Sets the currently logged in Sone.
411 * @param toadletContext
412 * The toadlet context
414 * The Sone to set as currently logged in
416 public void setCurrentSone(ToadletContext toadletContext, Sone sone) {
417 Session session = getCurrentSession(toadletContext);
419 session.removeAttribute("Sone.CurrentSone");
421 session.setAttribute("Sone.CurrentSone", sone.getId());
426 * Returns the notification manager.
428 * @return The notification manager
430 public NotificationManager getNotifications() {
431 return notificationManager;
435 * Returns the l10n helper of the node.
437 * @return The node’s l10n helper
439 public BaseL10n getL10n() {
440 return sonePlugin.l10n().getBase();
444 * Returns the session manager of the node.
446 * @return The node’s session manager
448 public SessionManager getSessionManager() {
449 return sonePlugin.pluginRespirator().getSessionManager("Sone");
453 * Returns the node’s form password.
455 * @return The form password
457 public String getFormPassword() {
462 * Returns the posts that have been announced as new in the
463 * {@link #newPostNotification}.
465 * @return The new posts
467 public Set<Post> getNewPosts() {
468 return ImmutableSet.<Post> builder().addAll(newPostNotification.getElements()).addAll(localPostNotification.getElements()).build();
472 * Returns the replies that have been announced as new in the
473 * {@link #newReplyNotification}.
475 * @return The new replies
477 public Set<PostReply> getNewReplies() {
478 return ImmutableSet.<PostReply> builder().addAll(newReplyNotification.getElements()).addAll(localReplyNotification.getElements()).build();
482 * Sets whether the current start of the plugin is the first start. It is
483 * considered a first start if the configuration file does not exist.
486 * {@code true} if no configuration file existed when Sone was
487 * loaded, {@code false} otherwise
489 public void setFirstStart(boolean firstStart) {
491 Template firstStartNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/firstStartNotification.html"));
492 Notification firstStartNotification = new TemplateNotification("first-start-notification", firstStartNotificationTemplate);
493 notificationManager.addNotification(firstStartNotification);
498 * Sets whether Sone was started with a fresh configuration file.
501 * {@code true} if Sone was started with a fresh configuration,
502 * {@code false} if the existing configuration could be read
504 public void setNewConfig(boolean newConfig) {
505 if (newConfig && !hasFirstStartNotification()) {
506 Template configNotReadNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/configNotReadNotification.html"));
507 Notification configNotReadNotification = new TemplateNotification("config-not-read-notification", configNotReadNotificationTemplate);
508 notificationManager.addNotification(configNotReadNotification);
517 * Returns whether the first start notification is currently displayed.
519 * @return {@code true} if the first-start notification is currently
520 * displayed, {@code false} otherwise
522 private boolean hasFirstStartNotification() {
523 return notificationManager.getNotification("first-start-notification") != null;
531 * Starts the web interface and registers all toadlets.
533 public void start() {
536 /* notification templates. */
537 Template startupNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/startupNotification.html"));
539 final TemplateNotification startupNotification = new TemplateNotification("startup-notification", startupNotificationTemplate);
540 notificationManager.addNotification(startupNotification);
542 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (120 * 1000), new Runnable() {
546 startupNotification.dismiss();
548 }, "Sone Startup Notification Remover");
550 Template wotMissingNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/wotMissingNotification.html"));
551 final TemplateNotification wotMissingNotification = new TemplateNotification("wot-missing-notification", wotMissingNotificationTemplate);
552 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (15 * 1000), new Runnable() {
555 @SuppressWarnings("synthetic-access")
557 if (getCore().getIdentityManager().isConnected()) {
558 wotMissingNotification.dismiss();
560 notificationManager.addNotification(wotMissingNotification);
562 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (15 * 1000), this, "Sone WoT Connector Checker");
565 }, "Sone WoT Connector Checker");
569 * Stops the web interface and unregisters all toadlets.
572 unregisterToadlets();
573 Ticker.getInstance().stop();
581 * Register all toadlets.
583 private void registerToadlets() {
584 Template emptyTemplate = TemplateParser.parse(new StringReader(""));
585 Template loginTemplate = TemplateParser.parse(createReader("/templates/login.html"));
586 Template indexTemplate = TemplateParser.parse(createReader("/templates/index.html"));
587 Template newTemplate = TemplateParser.parse(createReader("/templates/new.html"));
588 Template knownSonesTemplate = TemplateParser.parse(createReader("/templates/knownSones.html"));
589 Template createSoneTemplate = TemplateParser.parse(createReader("/templates/createSone.html"));
590 Template createPostTemplate = TemplateParser.parse(createReader("/templates/createPost.html"));
591 Template createReplyTemplate = TemplateParser.parse(createReader("/templates/createReply.html"));
592 Template bookmarksTemplate = TemplateParser.parse(createReader("/templates/bookmarks.html"));
593 Template searchTemplate = TemplateParser.parse(createReader("/templates/search.html"));
594 Template editProfileTemplate = TemplateParser.parse(createReader("/templates/editProfile.html"));
595 Template editProfileFieldTemplate = TemplateParser.parse(createReader("/templates/editProfileField.html"));
596 Template deleteProfileFieldTemplate = TemplateParser.parse(createReader("/templates/deleteProfileField.html"));
597 Template viewSoneTemplate = TemplateParser.parse(createReader("/templates/viewSone.html"));
598 Template viewPostTemplate = TemplateParser.parse(createReader("/templates/viewPost.html"));
599 Template deletePostTemplate = TemplateParser.parse(createReader("/templates/deletePost.html"));
600 Template deleteReplyTemplate = TemplateParser.parse(createReader("/templates/deleteReply.html"));
601 Template deleteSoneTemplate = TemplateParser.parse(createReader("/templates/deleteSone.html"));
602 Template imageBrowserTemplate = TemplateParser.parse(createReader("/templates/imageBrowser.html"));
603 Template createAlbumTemplate = TemplateParser.parse(createReader("/templates/createAlbum.html"));
604 Template deleteAlbumTemplate = TemplateParser.parse(createReader("/templates/deleteAlbum.html"));
605 Template deleteImageTemplate = TemplateParser.parse(createReader("/templates/deleteImage.html"));
606 Template noPermissionTemplate = TemplateParser.parse(createReader("/templates/noPermission.html"));
607 Template optionsTemplate = TemplateParser.parse(createReader("/templates/options.html"));
608 Template rescueTemplate = TemplateParser.parse(createReader("/templates/rescue.html"));
609 Template aboutTemplate = TemplateParser.parse(createReader("/templates/about.html"));
610 Template invalidTemplate = TemplateParser.parse(createReader("/templates/invalid.html"));
611 Template postTemplate = TemplateParser.parse(createReader("/templates/include/viewPost.html"));
612 Template replyTemplate = TemplateParser.parse(createReader("/templates/include/viewReply.html"));
613 Template openSearchTemplate = TemplateParser.parse(createReader("/templates/xml/OpenSearch.xml"));
615 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
616 pageToadlets.add(pageToadletFactory.createPageToadlet(new RedirectPage<FreenetRequest>("", "index.html")));
617 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
618 pageToadlets.add(pageToadletFactory.createPageToadlet(new NewPage(newTemplate, this), "New"));
619 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
620 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
621 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
622 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfileFieldPage(editProfileFieldTemplate, this)));
623 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteProfileFieldPage(deleteProfileFieldTemplate, this)));
624 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
625 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
626 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
627 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
628 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikePage(emptyTemplate, this)));
629 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikePage(emptyTemplate, this)));
630 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
631 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
632 pageToadlets.add(pageToadletFactory.createPageToadlet(new LockSonePage(emptyTemplate, this)));
633 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlockSonePage(emptyTemplate, this)));
634 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(emptyTemplate, this)));
635 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(emptyTemplate, this)));
636 pageToadlets.add(pageToadletFactory.createPageToadlet(new ImageBrowserPage(imageBrowserTemplate, this), "ImageBrowser"));
637 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateAlbumPage(createAlbumTemplate, this)));
638 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditAlbumPage(emptyTemplate, this)));
639 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteAlbumPage(deleteAlbumTemplate, this)));
640 pageToadlets.add(pageToadletFactory.createPageToadlet(new UploadImagePage(invalidTemplate, this)));
641 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditImagePage(emptyTemplate, this)));
642 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteImagePage(deleteImageTemplate, this)));
643 pageToadlets.add(pageToadletFactory.createPageToadlet(new TrustPage(emptyTemplate, this)));
644 pageToadlets.add(pageToadletFactory.createPageToadlet(new DistrustPage(emptyTemplate, this)));
645 pageToadlets.add(pageToadletFactory.createPageToadlet(new UntrustPage(emptyTemplate, this)));
646 pageToadlets.add(pageToadletFactory.createPageToadlet(new MarkAsKnownPage(emptyTemplate, this)));
647 pageToadlets.add(pageToadletFactory.createPageToadlet(new BookmarkPage(emptyTemplate, this)));
648 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnbookmarkPage(emptyTemplate, this)));
649 pageToadlets.add(pageToadletFactory.createPageToadlet(new BookmarksPage(bookmarksTemplate, this), "Bookmarks"));
650 pageToadlets.add(pageToadletFactory.createPageToadlet(new SearchPage(searchTemplate, this)));
651 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
652 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
653 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(emptyTemplate, this), "Logout"));
654 pageToadlets.add(pageToadletFactory.createPageToadlet(new OptionsPage(optionsTemplate, this), "Options"));
655 pageToadlets.add(pageToadletFactory.createPageToadlet(new RescuePage(rescueTemplate, this), "Rescue"));
656 pageToadlets.add(pageToadletFactory.createPageToadlet(new AboutPage(aboutTemplate, this, SonePlugin.VERSION), "About"));
657 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
658 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationPage(emptyTemplate, this)));
659 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("invalid.html", invalidTemplate, "Page.Invalid.Title", this)));
660 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage<FreenetRequest>("css/", "/static/css/", "text/css")));
661 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage<FreenetRequest>("javascript/", "/static/javascript/", "text/javascript")));
662 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage<FreenetRequest>("images/", "/static/images/", "image/png")));
663 pageToadlets.add(pageToadletFactory.createPageToadlet(new TemplatePage<FreenetRequest>("OpenSearch.xml", "application/opensearchdescription+xml", templateContextFactory, openSearchTemplate)));
664 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetImagePage(this)));
665 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
666 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetStatusAjaxPage(this)));
667 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetNotificationsAjaxPage(this)));
668 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationAjaxPage(this)));
669 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostAjaxPage(this)));
670 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyAjaxPage(this)));
671 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetReplyAjaxPage(this, replyTemplate)));
672 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetPostAjaxPage(this, postTemplate)));
673 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTimesAjaxPage(this)));
674 pageToadlets.add(pageToadletFactory.createPageToadlet(new MarkAsKnownAjaxPage(this)));
675 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostAjaxPage(this)));
676 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyAjaxPage(this)));
677 pageToadlets.add(pageToadletFactory.createPageToadlet(new LockSoneAjaxPage(this)));
678 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlockSoneAjaxPage(this)));
679 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSoneAjaxPage(this)));
680 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSoneAjaxPage(this)));
681 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditAlbumAjaxPage(this)));
682 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditImageAjaxPage(this, parserFilter)));
683 pageToadlets.add(pageToadletFactory.createPageToadlet(new TrustAjaxPage(this)));
684 pageToadlets.add(pageToadletFactory.createPageToadlet(new DistrustAjaxPage(this)));
685 pageToadlets.add(pageToadletFactory.createPageToadlet(new UntrustAjaxPage(this)));
686 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikeAjaxPage(this)));
687 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikeAjaxPage(this)));
688 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetLikesAjaxPage(this)));
689 pageToadlets.add(pageToadletFactory.createPageToadlet(new BookmarkAjaxPage(this)));
690 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnbookmarkAjaxPage(this)));
691 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfileFieldAjaxPage(this)));
692 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteProfileFieldAjaxPage(this)));
693 pageToadlets.add(pageToadletFactory.createPageToadlet(new MoveProfileFieldAjaxPage(this)));
695 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
696 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Sone.Name", "Navigation.Menu.Sone.Tooltip", sonePlugin);
697 for (PageToadlet toadlet : pageToadlets) {
698 String menuName = toadlet.getMenuName();
699 if (menuName != null) {
700 toadletContainer.register(toadlet, "Navigation.Menu.Sone.Name", toadlet.path(), true, "Navigation.Menu.Sone.Item." + menuName + ".Name", "Navigation.Menu.Sone.Item." + menuName + ".Tooltip", false, toadlet);
702 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
708 * Unregisters all toadlets.
710 private void unregisterToadlets() {
711 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
712 for (PageToadlet pageToadlet : pageToadlets) {
713 toadletContainer.unregister(pageToadlet);
715 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Sone.Name");
719 * Creates a {@link Reader} from the {@link InputStream} for the resource
720 * with the given name.
722 * @param resourceName
723 * The name of the resource
724 * @return A {@link Reader} for the resource
726 private Reader createReader(String resourceName) {
728 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
729 } catch (UnsupportedEncodingException uee1) {
735 * Returns all {@link Sone#isLocal() local Sone}s that are referenced by
736 * {@link SonePart}s in the given text (after parsing it using
737 * {@link SoneTextParser}).
741 * @return All mentioned local Sones
743 private Collection<Sone> getMentionedSones(String text) {
744 /* we need no context to find mentioned Sones. */
745 Set<Sone> mentionedSones = new HashSet<Sone>();
747 for (Part part : soneTextParser.parse(null, new StringReader(text))) {
748 if (part instanceof SonePart) {
749 mentionedSones.add(((SonePart) part).getSone());
752 } catch (IOException ioe1) {
753 logger.log(Level.WARNING, String.format("Could not parse post text: %s", text), ioe1);
755 return Collections2.filter(mentionedSones, Sone.LOCAL_SONE_FILTER);
759 * Returns the Sone insert notification for the given Sone. If no
760 * notification for the given Sone exists, a new notification is created and
764 * The Sone to get the insert notification for
765 * @return The Sone insert notification
767 private TemplateNotification getSoneInsertNotification(Sone sone) {
768 synchronized (soneInsertNotifications) {
769 TemplateNotification templateNotification = soneInsertNotifications.get(sone);
770 if (templateNotification == null) {
771 templateNotification = new TemplateNotification(TemplateParser.parse(createReader("/templates/notify/soneInsertNotification.html")));
772 templateNotification.set("insertSone", sone);
773 soneInsertNotifications.put(sone, templateNotification);
775 return templateNotification;
787 public void newSoneFound(NewSoneFoundEvent newSoneFoundEvent) {
788 newSoneNotification.add(newSoneFoundEvent.sone());
789 if (!hasFirstStartNotification()) {
790 notificationManager.addNotification(newSoneNotification);
798 public void newPostFound(NewPostFoundEvent newPostFoundEvent) {
799 Post post = newPostFoundEvent.post();
800 boolean isLocal = post.getSone().isLocal();
802 localPostNotification.add(post);
804 newPostNotification.add(post);
806 if (!hasFirstStartNotification()) {
807 notificationManager.addNotification(isLocal ? localPostNotification : newPostNotification);
808 if (!getMentionedSones(post.getText()).isEmpty() && !isLocal) {
809 mentionNotification.add(post);
810 notificationManager.addNotification(mentionNotification);
813 getCore().markPostKnown(post);
818 // CORELISTENER METHODS
825 public void newReplyFound(PostReply reply) {
826 boolean isLocal = reply.getSone().isLocal();
828 localReplyNotification.add(reply);
830 newReplyNotification.add(reply);
832 if (!hasFirstStartNotification()) {
833 notificationManager.addNotification(isLocal ? localReplyNotification : newReplyNotification);
834 if (!getMentionedSones(reply.getText()).isEmpty() && !isLocal && (reply.getPost().getSone() != null) && (reply.getTime() <= System.currentTimeMillis())) {
835 mentionNotification.add(reply.getPost());
836 notificationManager.addNotification(mentionNotification);
839 getCore().markReplyKnown(reply);
847 public void markSoneKnown(Sone sone) {
848 newSoneNotification.remove(sone);
855 public void markPostKnown(Post post) {
856 newPostNotification.remove(post);
857 localPostNotification.remove(post);
858 mentionNotification.remove(post);
865 public void markReplyKnown(PostReply reply) {
866 newReplyNotification.remove(reply);
867 localReplyNotification.remove(reply);
868 mentionNotification.remove(reply.getPost());
875 public void soneRemoved(Sone sone) {
876 newSoneNotification.remove(sone);
883 public void postRemoved(Post post) {
884 newPostNotification.remove(post);
885 localPostNotification.remove(post);
886 mentionNotification.remove(post);
893 public void replyRemoved(PostReply reply) {
894 newReplyNotification.remove(reply);
895 localReplyNotification.remove(reply);
896 if (!getMentionedSones(reply.getText()).isEmpty()) {
897 boolean isMentioned = false;
898 for (PostReply existingReply : getCore().getReplies(reply.getPost())) {
899 isMentioned |= !reply.isKnown() && !getMentionedSones(existingReply.getText()).isEmpty();
902 mentionNotification.remove(reply.getPost());
911 public void soneLocked(final Sone sone) {
912 Object tickerObject = Ticker.getInstance().registerEvent(System.currentTimeMillis() + (5 * 60) * 1000, new Runnable() {
915 @SuppressWarnings("synthetic-access")
917 lockedSonesNotification.add(sone);
918 lockedSonesTickerObjects.remove(sone);
919 notificationManager.addNotification(lockedSonesNotification);
921 }, "Sone Locked Notification");
922 lockedSonesTickerObjects.put(sone, tickerObject);
929 public void soneUnlocked(Sone sone) {
930 lockedSonesNotification.remove(sone);
931 Ticker.getInstance().deregisterEvent(lockedSonesTickerObjects.remove(sone));
938 public void soneInserting(Sone sone) {
939 TemplateNotification soneInsertNotification = getSoneInsertNotification(sone);
940 soneInsertNotification.set("soneStatus", "inserting");
941 if (sone.getOptions().getBooleanOption("EnableSoneInsertNotifications").get()) {
942 notificationManager.addNotification(soneInsertNotification);
950 public void soneInserted(Sone sone, long insertDuration) {
951 TemplateNotification soneInsertNotification = getSoneInsertNotification(sone);
952 soneInsertNotification.set("soneStatus", "inserted");
953 soneInsertNotification.set("insertDuration", insertDuration / 1000);
954 if (sone.getOptions().getBooleanOption("EnableSoneInsertNotifications").get()) {
955 notificationManager.addNotification(soneInsertNotification);
963 public void soneInsertAborted(Sone sone, Throwable cause) {
964 TemplateNotification soneInsertNotification = getSoneInsertNotification(sone);
965 soneInsertNotification.set("soneStatus", "insert-aborted");
966 soneInsertNotification.set("insert-error", cause);
967 if (sone.getOptions().getBooleanOption("EnableSoneInsertNotifications").get()) {
968 notificationManager.addNotification(soneInsertNotification);
976 public void updateFound(Version version, long releaseTime, long latestEdition) {
977 newVersionNotification.getTemplateContext().set("latestVersion", version);
978 newVersionNotification.getTemplateContext().set("latestEdition", latestEdition);
979 newVersionNotification.getTemplateContext().set("releaseTime", releaseTime);
980 notificationManager.addNotification(newVersionNotification);
987 public void imageInsertStarted(Image image) {
988 insertingImagesNotification.add(image);
989 notificationManager.addNotification(insertingImagesNotification);
996 public void imageInsertAborted(Image image) {
997 insertingImagesNotification.remove(image);
1004 public void imageInsertFinished(Image image) {
1005 insertingImagesNotification.remove(image);
1006 insertedImagesNotification.add(image);
1007 notificationManager.addNotification(insertedImagesNotification);
1014 public void imageInsertFailed(Image image, Throwable cause) {
1015 insertingImagesNotification.remove(image);
1016 imageInsertFailedNotification.add(image);
1017 notificationManager.addNotification(imageInsertFailedNotification);