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.PostAccessor;
44 import net.pterodactylus.sone.template.ReplyAccessor;
45 import net.pterodactylus.sone.template.RequestChangeFilter;
46 import net.pterodactylus.sone.template.SoneAccessor;
47 import net.pterodactylus.sone.template.SubstringFilter;
48 import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
49 import net.pterodactylus.sone.web.ajax.DeleteReplyAjaxPage;
50 import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
51 import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
52 import net.pterodactylus.sone.web.ajax.GetSoneStatusPage;
53 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
54 import net.pterodactylus.sone.web.ajax.LikeAjaxPage;
55 import net.pterodactylus.sone.web.ajax.UnfollowSoneAjaxPage;
56 import net.pterodactylus.sone.web.ajax.UnlikeAjaxPage;
57 import net.pterodactylus.sone.web.page.PageToadlet;
58 import net.pterodactylus.sone.web.page.PageToadletFactory;
59 import net.pterodactylus.sone.web.page.StaticPage;
60 import net.pterodactylus.util.logging.Logging;
61 import net.pterodactylus.util.template.DateFilter;
62 import net.pterodactylus.util.template.DefaultTemplateFactory;
63 import net.pterodactylus.util.template.MatchFilter;
64 import net.pterodactylus.util.template.PaginationPlugin;
65 import net.pterodactylus.util.template.ReflectionAccessor;
66 import net.pterodactylus.util.template.Template;
67 import net.pterodactylus.util.template.TemplateException;
68 import net.pterodactylus.util.template.TemplateFactory;
69 import net.pterodactylus.util.template.TemplateProvider;
70 import net.pterodactylus.util.template.XmlFilter;
71 import freenet.clients.http.SessionManager;
72 import freenet.clients.http.ToadletContainer;
73 import freenet.l10n.BaseL10n;
76 * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
77 * references to l10n helpers.
79 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
81 public class WebInterface {
84 private static final Logger logger = Logging.getLogger(WebInterface.class);
86 /** The Sone plugin. */
87 private final SonePlugin sonePlugin;
89 /** The registered toadlets. */
90 private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
92 /** The form password. */
93 private final String formPassword;
96 * Creates a new web interface.
101 public WebInterface(SonePlugin sonePlugin) {
102 this.sonePlugin = sonePlugin;
103 formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
111 * Returns the Sone core used by the Sone plugin.
113 * @return The Sone core
115 public Core getCore() {
116 return sonePlugin.core();
120 * Returns the l10n helper of the node.
122 * @return The node’s l10n helper
124 public BaseL10n getL10n() {
125 return sonePlugin.l10n().getBase();
129 * Returns the session manager of the node.
131 * @return The node’s session manager
133 public SessionManager getSessionManager() {
135 return sonePlugin.pluginRespirator().getSessionManager(new URI("/"));
136 } catch (URISyntaxException use1) {
137 logger.log(Level.SEVERE, "Could not get Session Manager!", use1);
143 * Returns the node’s form password.
145 * @return The form password
147 public String getFormPassword() {
156 * Starts the web interface and registers all toadlets.
158 public void start() {
163 * Stops the web interface and unregisters all toadlets.
166 unregisterToadlets();
174 * Register all toadlets.
176 private void registerToadlets() {
177 DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
178 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
179 templateFactory.addAccessor(Collection.class, new CollectionAccessor());
180 templateFactory.addAccessor(Sone.class, new SoneAccessor(getCore()));
181 templateFactory.addAccessor(Post.class, new PostAccessor(getCore()));
182 templateFactory.addAccessor(Reply.class, new ReplyAccessor(getCore()));
183 templateFactory.addAccessor(Identity.class, new IdentityAccessor(getCore()));
184 templateFactory.addFilter("date", new DateFilter());
185 templateFactory.addFilter("l10n", new L10nFilter(getL10n()));
186 templateFactory.addFilter("substring", new SubstringFilter());
187 templateFactory.addFilter("xml", new XmlFilter());
188 templateFactory.addFilter("change", new RequestChangeFilter());
189 templateFactory.addFilter("match", new MatchFilter());
190 templateFactory.addFilter("css", new CssClassNameFilter());
191 templateFactory.addPlugin("getpage", new GetPagePlugin());
192 templateFactory.addPlugin("paginate", new PaginationPlugin());
193 templateFactory.setTemplateProvider(new ClassPathTemplateProvider(templateFactory));
194 templateFactory.addTemplateObject("formPassword", formPassword);
196 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
197 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
198 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
199 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
200 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
201 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
202 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
203 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
204 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
205 Template likePostTemplate = templateFactory.createTemplate(createReader("/templates/like.html"));
206 Template unlikePostTemplate = templateFactory.createTemplate(createReader("/templates/unlike.html"));
207 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
208 Template deleteReplyTemplate = templateFactory.createTemplate(createReader("/templates/deleteReply.html"));
209 Template followSoneTemplate = templateFactory.createTemplate(createReader("/templates/followSone.html"));
210 Template unfollowSoneTemplate = templateFactory.createTemplate(createReader("/templates/unfollowSone.html"));
211 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
212 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
213 Template wotPluginMissingTemplate = templateFactory.createTemplate(createReader("/templates/wotPluginMissing.html"));
214 Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html"));
215 Template optionsTemplate = templateFactory.createTemplate(createReader("/templates/options.html"));
216 Template aboutTemplate = templateFactory.createTemplate(createReader("/templates/about.html"));
218 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
219 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
220 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
221 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
222 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
223 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
224 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
225 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
226 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
227 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikePage(likePostTemplate, this)));
228 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikePage(unlikePostTemplate, this)));
229 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
230 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
231 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(followSoneTemplate, this)));
232 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(unfollowSoneTemplate, this)));
233 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
234 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
235 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout"));
236 pageToadlets.add(pageToadletFactory.createPageToadlet(new OptionsPage(optionsTemplate, this), "Options"));
237 pageToadlets.add(pageToadletFactory.createPageToadlet(new AboutPage(aboutTemplate, this, SonePlugin.VERSION), "About"));
238 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
239 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("wotPluginMissing.html", wotPluginMissingTemplate, "Page.WotPluginMissing.Title", this)));
240 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
241 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
242 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
243 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
244 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetSoneStatusPage(this)));
245 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostAjaxPage(this)));
246 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyAjaxPage(this)));
247 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSoneAjaxPage(this)));
248 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSoneAjaxPage(this)));
249 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikeAjaxPage(this)));
250 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikeAjaxPage(this)));
251 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetLikesAjaxPage(this)));
253 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
254 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
255 for (PageToadlet toadlet : pageToadlets) {
256 String menuName = toadlet.getMenuName();
257 if (menuName != null) {
258 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
260 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
266 * Unregisters all toadlets.
268 private void unregisterToadlets() {
269 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
270 for (PageToadlet pageToadlet : pageToadlets) {
271 toadletContainer.unregister(pageToadlet);
273 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
277 * Creates a {@link Reader} from the {@link InputStream} for the resource
278 * with the given name.
280 * @param resourceName
281 * The name of the resource
282 * @return A {@link Reader} for the resource
284 private Reader createReader(String resourceName) {
286 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
287 } catch (UnsupportedEncodingException uee1) {
293 * Template provider implementation that uses
294 * {@link WebInterface#createReader(String)} to load templates for
297 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
299 private class ClassPathTemplateProvider implements TemplateProvider {
301 /** The template factory. */
302 private final TemplateFactory templateFactory;
305 * Creates a new template provider that locates templates on the
308 * @param templateFactory
309 * The template factory to create the templates
311 public ClassPathTemplateProvider(TemplateFactory templateFactory) {
312 this.templateFactory = templateFactory;
319 @SuppressWarnings("synthetic-access")
320 public Template getTemplate(String templateName) {
321 Reader templateReader = createReader("/templates/" + templateName);
322 if (templateReader == null) {
325 Template template = templateFactory.createTemplate(templateReader);
328 } catch (TemplateException te1) {
329 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);