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.template.SubstringFilter;
39 import net.pterodactylus.sone.web.page.PageToadlet;
40 import net.pterodactylus.sone.web.page.PageToadletFactory;
41 import net.pterodactylus.sone.web.page.StaticPage;
42 import net.pterodactylus.util.logging.Logging;
43 import net.pterodactylus.util.service.AbstractService;
44 import net.pterodactylus.util.template.DateFilter;
45 import net.pterodactylus.util.template.DefaultTemplateFactory;
46 import net.pterodactylus.util.template.ReflectionAccessor;
47 import net.pterodactylus.util.template.Template;
48 import net.pterodactylus.util.template.TemplateException;
49 import net.pterodactylus.util.template.TemplateFactory;
50 import net.pterodactylus.util.template.TemplateProvider;
51 import freenet.clients.http.LinkEnabledCallback;
52 import freenet.clients.http.SessionManager;
53 import freenet.clients.http.ToadletContainer;
54 import freenet.clients.http.ToadletContext;
55 import freenet.l10n.BaseL10n;
58 * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
59 * references to l10n helpers.
61 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
63 public class WebInterface extends AbstractService {
66 private static final Logger logger = Logging.getLogger(WebInterface.class);
68 /** The Sone plugin. */
69 private final SonePlugin sonePlugin;
71 /** The registered toadlets. */
72 private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
75 * Creates a new web interface.
80 public WebInterface(SonePlugin sonePlugin) {
81 super("Sone Web Interface");
82 this.sonePlugin = sonePlugin;
90 * Returns the Sone core used by the Sone plugin.
92 * @return The Sone core
95 return sonePlugin.core();
99 * Returns the l10n helper of the node.
101 * @return The node’s l10n helper
103 public BaseL10n l10n() {
104 return sonePlugin.l10n().getBase();
108 * Returns the session manager of the node.
110 * @return The node’s session manager
112 public SessionManager sessionManager() {
114 return sonePlugin.pluginRespirator().getSessionManager(new URI("/"));
115 } catch (URISyntaxException use1) {
116 logger.log(Level.SEVERE, "Could not get Session Manager!", use1);
129 protected void serviceStart() {
137 protected void serviceStop() {
138 unregisterToadlets();
146 * Register all toadlets.
148 private void registerToadlets() {
149 DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
150 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
151 templateFactory.addAccessor(Sone.class, new SoneAccessor(core()));
152 templateFactory.addAccessor(Post.class, new PostAccessor(core()));
153 templateFactory.addFilter("date", new DateFilter());
154 templateFactory.addFilter("l10n", new L10nFilter(l10n()));
155 templateFactory.addFilter("substring", new SubstringFilter());
156 templateFactory.setTemplateProvider(new ClassPathTemplateProvider(templateFactory));
157 templateFactory.addTemplateObject("formPassword", sonePlugin.pluginRespirator().getToadletContainer().getFormPassword());
159 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
160 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
161 Template addSoneTemplate = templateFactory.createTemplate(createReader("/templates/addSone.html"));
162 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
163 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
164 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
165 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
166 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
167 Template backupProfileTemplate = templateFactory.createTemplate(createReader("/templates/backup.xml"));
168 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
169 Template blockSoneTemplate = templateFactory.createTemplate(createReader("/templates/blockSone.html"));
170 Template unblockSoneTemplate = templateFactory.createTemplate(createReader("/templates/unblockSone.html"));
171 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
172 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
173 Template followSoneTemplate = templateFactory.createTemplate(createReader("/templates/followSone.html"));
174 Template unfollowSoneTemplate = templateFactory.createTemplate(createReader("/templates/unfollowSone.html"));
175 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
176 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
177 Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html"));
179 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
180 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
181 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
182 pageToadlets.add(pageToadletFactory.createPageToadlet(new AddSonePage(addSoneTemplate, this), "AddSone"));
183 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
184 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
185 pageToadlets.add(pageToadletFactory.createPageToadlet(new BackupProfilePage(backupProfileTemplate, this)));
186 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
187 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
188 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
189 pageToadlets.add(pageToadletFactory.createPageToadlet(new BlockSonePage(blockSoneTemplate, this)));
190 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnblockSonePage(unblockSoneTemplate, this)));
191 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
192 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
193 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(followSoneTemplate, this)));
194 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(unfollowSoneTemplate, this)));
195 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
196 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
197 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout"));
198 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
199 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
200 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
201 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
203 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
204 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
205 for (PageToadlet toadlet : pageToadlets) {
206 String menuName = toadlet.getMenuName();
207 if (menuName != null) {
208 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
210 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
216 * Unregisters all toadlets.
218 private void unregisterToadlets() {
219 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
220 for (PageToadlet pageToadlet : pageToadlets) {
221 toadletContainer.unregister(pageToadlet);
223 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
227 * Creates a {@link Reader} from the {@link InputStream} for the resource
228 * with the given name.
230 * @param resourceName
231 * The name of the resource
232 * @return A {@link Reader} for the resource
234 private Reader createReader(String resourceName) {
236 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
237 } catch (UnsupportedEncodingException uee1) {
243 * {@link LinkEnabledCallback} implementation that always returns
244 * {@code true} when {@link LinkEnabledCallback#isEnabled(ToadletContext)}
247 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
249 public class AlwaysEnabledCallback implements LinkEnabledCallback {
255 public boolean isEnabled(ToadletContext toadletContext) {
261 * Template provider implementation that uses
262 * {@link WebInterface#createReader(String)} to load templates for
265 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
267 private class ClassPathTemplateProvider implements TemplateProvider {
269 /** The template factory. */
270 private final TemplateFactory templateFactory;
273 * Creates a new template provider that locates templates on the
276 * @param templateFactory
277 * The template factory to create the templates
279 public ClassPathTemplateProvider(TemplateFactory templateFactory) {
280 this.templateFactory = templateFactory;
287 @SuppressWarnings("synthetic-access")
288 public Template getTemplate(String templateName) {
289 Reader templateReader = createReader("/templates/" + templateName);
290 if (templateReader == null) {
293 Template template = templateFactory.createTemplate(templateReader);
296 } catch (TemplateException te1) {
297 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);