2 * FreenetSone - WebInterface.java - Copyright © 2010 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.InputStream;
21 import java.io.InputStreamReader;
22 import java.io.Reader;
23 import java.io.UnsupportedEncodingException;
25 import java.net.URISyntaxException;
26 import java.util.ArrayList;
27 import java.util.Collection;
28 import java.util.List;
29 import java.util.logging.Level;
30 import java.util.logging.Logger;
32 import net.pterodactylus.sone.core.Core;
33 import net.pterodactylus.sone.data.Post;
34 import net.pterodactylus.sone.data.Reply;
35 import net.pterodactylus.sone.data.Sone;
36 import net.pterodactylus.sone.freenet.L10nFilter;
37 import net.pterodactylus.sone.freenet.wot.Identity;
38 import net.pterodactylus.sone.main.SonePlugin;
39 import net.pterodactylus.sone.template.CollectionAccessor;
40 import net.pterodactylus.sone.template.CssClassNameFilter;
41 import net.pterodactylus.sone.template.GetPagePlugin;
42 import net.pterodactylus.sone.template.IdentityAccessor;
43 import net.pterodactylus.sone.template.NotificationAccessor;
44 import net.pterodactylus.sone.template.NotificationManagerAccessor;
45 import net.pterodactylus.sone.template.PostAccessor;
46 import net.pterodactylus.sone.template.ReplyAccessor;
47 import net.pterodactylus.sone.template.RequestChangeFilter;
48 import net.pterodactylus.sone.template.SoneAccessor;
49 import net.pterodactylus.sone.template.SubstringFilter;
50 import net.pterodactylus.sone.web.ajax.CreateReplyAjaxPage;
51 import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
52 import net.pterodactylus.sone.web.ajax.DeleteReplyAjaxPage;
53 import net.pterodactylus.sone.web.ajax.DismissNotificationAjaxPage;
54 import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
55 import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
56 import net.pterodactylus.sone.web.ajax.GetReplyAjaxPage;
57 import net.pterodactylus.sone.web.ajax.GetSoneStatusPage;
58 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
59 import net.pterodactylus.sone.web.ajax.LikeAjaxPage;
60 import net.pterodactylus.sone.web.ajax.UnfollowSoneAjaxPage;
61 import net.pterodactylus.sone.web.ajax.UnlikeAjaxPage;
62 import net.pterodactylus.sone.web.page.PageToadlet;
63 import net.pterodactylus.sone.web.page.PageToadletFactory;
64 import net.pterodactylus.sone.web.page.StaticPage;
65 import net.pterodactylus.util.logging.Logging;
66 import net.pterodactylus.util.notify.Notification;
67 import net.pterodactylus.util.notify.NotificationManager;
68 import net.pterodactylus.util.notify.TemplateNotification;
69 import net.pterodactylus.util.template.DateFilter;
70 import net.pterodactylus.util.template.DefaultTemplateFactory;
71 import net.pterodactylus.util.template.MatchFilter;
72 import net.pterodactylus.util.template.PaginationPlugin;
73 import net.pterodactylus.util.template.ReflectionAccessor;
74 import net.pterodactylus.util.template.Template;
75 import net.pterodactylus.util.template.TemplateException;
76 import net.pterodactylus.util.template.TemplateFactory;
77 import net.pterodactylus.util.template.TemplateProvider;
78 import net.pterodactylus.util.template.XmlFilter;
79 import net.pterodactylus.util.thread.Ticker;
80 import freenet.clients.http.SessionManager;
81 import freenet.clients.http.ToadletContainer;
82 import freenet.l10n.BaseL10n;
85 * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
86 * references to l10n helpers.
88 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
90 public class WebInterface {
93 private static final Logger logger = Logging.getLogger(WebInterface.class);
95 /** The Sone plugin. */
96 private final SonePlugin sonePlugin;
98 /** The registered toadlets. */
99 private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
101 /** The form password. */
102 private final String formPassword;
104 /** The template factory. */
105 private DefaultTemplateFactory templateFactory;
108 * Creates a new web interface.
113 public WebInterface(SonePlugin sonePlugin) {
114 this.sonePlugin = sonePlugin;
115 formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
117 templateFactory = new DefaultTemplateFactory();
118 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
119 templateFactory.addAccessor(Collection.class, new CollectionAccessor());
120 templateFactory.addAccessor(Sone.class, new SoneAccessor(getCore()));
121 templateFactory.addAccessor(Post.class, new PostAccessor(getCore()));
122 templateFactory.addAccessor(Reply.class, new ReplyAccessor(getCore()));
123 templateFactory.addAccessor(Identity.class, new IdentityAccessor(getCore()));
124 templateFactory.addAccessor(Notification.class, new NotificationAccessor());
125 templateFactory.addAccessor(NotificationManager.class, new NotificationManagerAccessor());
126 templateFactory.addFilter("date", new DateFilter());
127 templateFactory.addFilter("l10n", new L10nFilter(getL10n()));
128 templateFactory.addFilter("substring", new SubstringFilter());
129 templateFactory.addFilter("xml", new XmlFilter());
130 templateFactory.addFilter("change", new RequestChangeFilter());
131 templateFactory.addFilter("match", new MatchFilter());
132 templateFactory.addFilter("css", new CssClassNameFilter());
133 templateFactory.addPlugin("getpage", new GetPagePlugin());
134 templateFactory.addPlugin("paginate", new PaginationPlugin());
135 templateFactory.setTemplateProvider(new ClassPathTemplateProvider(templateFactory));
136 templateFactory.addTemplateObject("formPassword", formPassword);
144 * Returns the Sone core used by the Sone plugin.
146 * @return The Sone core
148 public Core getCore() {
149 return sonePlugin.core();
153 * Returns the l10n helper of the node.
155 * @return The node’s l10n helper
157 public BaseL10n getL10n() {
158 return sonePlugin.l10n().getBase();
162 * Returns the session manager of the node.
164 * @return The node’s session manager
166 public SessionManager getSessionManager() {
168 return sonePlugin.pluginRespirator().getSessionManager(new URI("/"));
169 } catch (URISyntaxException use1) {
170 logger.log(Level.SEVERE, "Could not get Session Manager!", use1);
176 * Returns the node’s form password.
178 * @return The form password
180 public String getFormPassword() {
189 * Starts the web interface and registers all toadlets.
191 public void start() {
194 /* notification templates. */
195 Template startupNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/startupNotification.html"));
197 final TemplateNotification startupNotification = new TemplateNotification(startupNotificationTemplate);
198 getCore().getNotifications().addNotification(startupNotification);
200 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (120 * 1000), new Runnable() {
204 getCore().getNotifications().removeNotification(startupNotification);
206 }, "Sone Startup Notification Remover");
210 * Stops the web interface and unregisters all toadlets.
213 unregisterToadlets();
221 * Register all toadlets.
223 private void registerToadlets() {
224 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
225 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
226 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
227 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
228 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
229 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
230 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
231 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
232 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
233 Template likePostTemplate = templateFactory.createTemplate(createReader("/templates/like.html"));
234 Template unlikePostTemplate = templateFactory.createTemplate(createReader("/templates/unlike.html"));
235 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
236 Template deleteReplyTemplate = templateFactory.createTemplate(createReader("/templates/deleteReply.html"));
237 Template followSoneTemplate = templateFactory.createTemplate(createReader("/templates/followSone.html"));
238 Template unfollowSoneTemplate = templateFactory.createTemplate(createReader("/templates/unfollowSone.html"));
239 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
240 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
241 Template wotPluginMissingTemplate = templateFactory.createTemplate(createReader("/templates/wotPluginMissing.html"));
242 Template dismissNotificationTemplate = templateFactory.createTemplate(createReader("/templates/dismissNotification.html"));
243 Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html"));
244 Template optionsTemplate = templateFactory.createTemplate(createReader("/templates/options.html"));
245 Template aboutTemplate = templateFactory.createTemplate(createReader("/templates/about.html"));
246 Template replyTemplate = templateFactory.createTemplate(createReader("/templates/include/viewReply.html"));
248 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
249 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
250 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
251 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
252 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
253 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
254 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
255 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
256 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
257 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikePage(likePostTemplate, this)));
258 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikePage(unlikePostTemplate, this)));
259 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
260 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
261 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(followSoneTemplate, this)));
262 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(unfollowSoneTemplate, this)));
263 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
264 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
265 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout"));
266 pageToadlets.add(pageToadletFactory.createPageToadlet(new OptionsPage(optionsTemplate, this), "Options"));
267 pageToadlets.add(pageToadletFactory.createPageToadlet(new AboutPage(aboutTemplate, this, SonePlugin.VERSION), "About"));
268 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
269 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("wotPluginMissing.html", wotPluginMissingTemplate, "Page.WotPluginMissing.Title", this)));
270 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationPage(dismissNotificationTemplate, this)));
271 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
272 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
273 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
274 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
275 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationAjaxPage(this)));
276 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetSoneStatusPage(this)));
277 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyAjaxPage(this)));
278 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetReplyAjaxPage(this, replyTemplate)));
279 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostAjaxPage(this)));
280 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyAjaxPage(this)));
281 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSoneAjaxPage(this)));
282 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSoneAjaxPage(this)));
283 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikeAjaxPage(this)));
284 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikeAjaxPage(this)));
285 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetLikesAjaxPage(this)));
287 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
288 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
289 for (PageToadlet toadlet : pageToadlets) {
290 String menuName = toadlet.getMenuName();
291 if (menuName != null) {
292 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
294 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
300 * Unregisters all toadlets.
302 private void unregisterToadlets() {
303 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
304 for (PageToadlet pageToadlet : pageToadlets) {
305 toadletContainer.unregister(pageToadlet);
307 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
311 * Creates a {@link Reader} from the {@link InputStream} for the resource
312 * with the given name.
314 * @param resourceName
315 * The name of the resource
316 * @return A {@link Reader} for the resource
318 private Reader createReader(String resourceName) {
320 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
321 } catch (UnsupportedEncodingException uee1) {
327 * Template provider implementation that uses
328 * {@link WebInterface#createReader(String)} to load templates for
331 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
333 private class ClassPathTemplateProvider implements TemplateProvider {
335 /** The template factory. */
336 @SuppressWarnings("hiding")
337 private final TemplateFactory templateFactory;
340 * Creates a new template provider that locates templates on the
343 * @param templateFactory
344 * The template factory to create the templates
346 public ClassPathTemplateProvider(TemplateFactory templateFactory) {
347 this.templateFactory = templateFactory;
354 @SuppressWarnings("synthetic-access")
355 public Template getTemplate(String templateName) {
356 Reader templateReader = createReader("/templates/" + templateName);
357 if (templateReader == null) {
360 Template template = templateFactory.createTemplate(templateReader);
363 } catch (TemplateException te1) {
364 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);