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.List;
28 import java.util.logging.Level;
29 import java.util.logging.Logger;
31 import net.pterodactylus.sone.core.Core;
32 import net.pterodactylus.sone.data.Post;
33 import net.pterodactylus.sone.data.Sone;
34 import net.pterodactylus.sone.freenet.L10nFilter;
35 import net.pterodactylus.sone.main.SonePlugin;
36 import net.pterodactylus.sone.template.PostAccessor;
37 import net.pterodactylus.sone.template.SoneAccessor;
38 import net.pterodactylus.sone.web.page.PageToadlet;
39 import net.pterodactylus.sone.web.page.PageToadletFactory;
40 import net.pterodactylus.sone.web.page.StaticPage;
41 import net.pterodactylus.util.logging.Logging;
42 import net.pterodactylus.util.service.AbstractService;
43 import net.pterodactylus.util.template.DateFilter;
44 import net.pterodactylus.util.template.DefaultTemplateFactory;
45 import net.pterodactylus.util.template.ReflectionAccessor;
46 import net.pterodactylus.util.template.Template;
47 import net.pterodactylus.util.template.TemplateException;
48 import net.pterodactylus.util.template.TemplateFactory;
49 import net.pterodactylus.util.template.TemplateProvider;
50 import freenet.clients.http.LinkEnabledCallback;
51 import freenet.clients.http.SessionManager;
52 import freenet.clients.http.ToadletContainer;
53 import freenet.clients.http.ToadletContext;
54 import freenet.l10n.BaseL10n;
57 * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
58 * references to l10n helpers.
60 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
62 public class WebInterface extends AbstractService {
65 private static final Logger logger = Logging.getLogger(WebInterface.class);
67 /** The Sone plugin. */
68 private final SonePlugin sonePlugin;
70 /** The registered toadlets. */
71 private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
74 * Creates a new web interface.
79 public WebInterface(SonePlugin sonePlugin) {
80 super("Sone Web Interface");
81 this.sonePlugin = sonePlugin;
89 * Returns the Sone core used by the Sone plugin.
91 * @return The Sone core
94 return sonePlugin.core();
98 * Returns the l10n helper of the node.
100 * @return The node’s l10n helper
102 public BaseL10n l10n() {
103 return sonePlugin.l10n().getBase();
107 * Returns the session manager of the node.
109 * @return The node’s session manager
111 public SessionManager sessionManager() {
113 return sonePlugin.pluginRespirator().getSessionManager(new URI("/"));
114 } catch (URISyntaxException use1) {
115 logger.log(Level.SEVERE, "Could not get Session Manager!", use1);
128 protected void serviceStart() {
136 protected void serviceStop() {
137 unregisterToadlets();
145 * Register all toadlets.
147 private void registerToadlets() {
148 DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
149 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
150 templateFactory.addAccessor(Sone.class, new SoneAccessor());
151 templateFactory.addAccessor(Post.class, new PostAccessor(core()));
152 templateFactory.addFilter("date", new DateFilter());
153 templateFactory.addFilter("l10n", new L10nFilter(l10n()));
154 templateFactory.setTemplateProvider(new ClassPathTemplateProvider(templateFactory));
156 String formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
158 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
159 loginTemplate.set("formPassword", formPassword);
161 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
162 indexTemplate.set("formPassword", formPassword);
164 Template addSoneTemplate = templateFactory.createTemplate(createReader("/templates/addSone.html"));
165 addSoneTemplate.set("formPassword", formPassword);
167 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
168 knownSonesTemplate.set("formPassword", formPassword);
170 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
171 createSoneTemplate.set("formPassword", formPassword);
173 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
174 createPostTemplate.set("formPassword", formPassword);
176 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
177 createReplyTemplate.set("formPassword", formPassword);
179 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
180 editProfileTemplate.set("formPassword", formPassword);
182 Template backupProfileTemplate = templateFactory.createTemplate(createReader("/templates/backup.xml"));
183 backupProfileTemplate.set("formPassword", formPassword);
185 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
186 viewSoneTemplate.set("formPassword", formPassword);
188 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
189 viewPostTemplate.set("formPassword", formPassword);
191 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
192 deletePostTemplate.set("formPassword", formPassword);
194 Template followSoneTemplate = templateFactory.createTemplate(createReader("/templates/followSone.html"));
195 followSoneTemplate.set("formPassword", formPassword);
197 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
198 deleteSoneTemplate.set("formPassword", formPassword);
200 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
202 Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html"));
204 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
205 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
206 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
207 pageToadlets.add(pageToadletFactory.createPageToadlet(new AddSonePage(addSoneTemplate, this), "AddSone"));
208 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
209 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
210 pageToadlets.add(pageToadletFactory.createPageToadlet(new BackupProfilePage(backupProfileTemplate, this)));
211 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
212 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
213 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
214 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
215 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
216 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(followSoneTemplate, this)));
217 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
218 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
219 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout"));
220 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
221 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
222 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
223 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
225 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
226 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
227 for (PageToadlet toadlet : pageToadlets) {
228 String menuName = toadlet.getMenuName();
229 if (menuName != null) {
230 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
232 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
238 * Unregisters all toadlets.
240 private void unregisterToadlets() {
241 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
242 for (PageToadlet pageToadlet : pageToadlets) {
243 toadletContainer.unregister(pageToadlet);
245 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
249 * Creates a {@link Reader} from the {@link InputStream} for the resource
250 * with the given name.
252 * @param resourceName
253 * The name of the resource
254 * @return A {@link Reader} for the resource
256 private Reader createReader(String resourceName) {
258 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
259 } catch (UnsupportedEncodingException uee1) {
265 * {@link LinkEnabledCallback} implementation that always returns
266 * {@code true} when {@link LinkEnabledCallback#isEnabled(ToadletContext)}
269 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
271 public class AlwaysEnabledCallback implements LinkEnabledCallback {
277 public boolean isEnabled(ToadletContext toadletContext) {
283 * Template provider implementation that uses
284 * {@link WebInterface#createReader(String)} to load templates for
287 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
289 private class ClassPathTemplateProvider implements TemplateProvider {
291 /** The template factory. */
292 private final TemplateFactory templateFactory;
295 * Creates a new template provider that locates templates on the
298 * @param templateFactory
299 * The template factory to create the templates
301 public ClassPathTemplateProvider(TemplateFactory templateFactory) {
302 this.templateFactory = templateFactory;
309 @SuppressWarnings("synthetic-access")
310 public Template getTemplate(String templateName) {
311 Reader templateReader = createReader("/templates/" + templateName);
312 if (templateReader == null) {
315 Template template = templateFactory.createTemplate(templateReader);
318 } catch (TemplateException te1) {
319 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);