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