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.main.SonePlugin;
32 import net.pterodactylus.sone.web.page.CSSPage;
33 import net.pterodactylus.sone.web.page.PageToadlet;
34 import net.pterodactylus.sone.web.page.PageToadletFactory;
35 import net.pterodactylus.util.logging.Logging;
36 import net.pterodactylus.util.service.AbstractService;
37 import net.pterodactylus.util.template.Template;
38 import net.pterodactylus.util.template.TemplateFactory;
39 import freenet.clients.http.LinkEnabledCallback;
40 import freenet.clients.http.SessionManager;
41 import freenet.clients.http.ToadletContainer;
42 import freenet.clients.http.ToadletContext;
43 import freenet.l10n.BaseL10n;
46 * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
47 * references to l10n helpers.
49 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
51 public class WebInterface extends AbstractService {
54 private static final Logger logger = Logging.getLogger(WebInterface.class);
56 /** The Sone plugin. */
57 private final SonePlugin sonePlugin;
59 /** The registered toadlets. */
60 private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
63 * Creates a new web interface.
68 public WebInterface(SonePlugin sonePlugin) {
69 this.sonePlugin = sonePlugin;
77 * Returns the l10n helper of the node.
79 * @return The node’s l10n helper
81 public BaseL10n l10n() {
82 return sonePlugin.l10n().getBase();
86 * Returns the session manager of the node.
88 * @return The node’s session manager
90 public SessionManager sessionManager() {
92 return sonePlugin.pluginRespirator().getSessionManager(new URI("/"));
93 } catch (URISyntaxException use1) {
94 logger.log(Level.SEVERE, "Could not get Session Manager!", use1);
107 protected void serviceStart() {
115 protected void serviceStop() {
116 unregisterToadlets();
124 * Register all toadlets.
126 private void registerToadlets() {
127 TemplateFactory templateFactory = new SoneTemplateFactory(l10n());
129 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
130 loginTemplate.set("formPassword", sonePlugin.pluginRespirator().getToadletContainer().getFormPassword());
132 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
133 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
134 pageToadlets.add(pageToadletFactory.createPageToadlet(new CSSPage("css/", "/static/css/")));
136 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
137 toadletContainer.getPageMaker().addNavigationCategory("/Sone/", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
138 for (PageToadlet toadlet : pageToadlets) {
139 String menuName = toadlet.getMenuName();
140 if (menuName != null) {
141 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, new AlwaysEnabledCallback());
143 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
149 * Unregisters all toadlets.
151 private void unregisterToadlets() {
152 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
153 for (PageToadlet pageToadlet : pageToadlets) {
154 toadletContainer.unregister(pageToadlet);
156 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
160 * Creates a {@link Reader} from the {@link InputStream} for the resource
161 * with the given name.
163 * @param resourceName
164 * The name of the resource
165 * @return A {@link Reader} for the resource
167 private Reader createReader(String resourceName) {
169 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
170 } catch (UnsupportedEncodingException uee1) {
176 * {@link LinkEnabledCallback} implementation that always returns
177 * {@code true} when {@link LinkEnabledCallback#isEnabled(ToadletContext)}
180 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
182 public class AlwaysEnabledCallback implements LinkEnabledCallback {
188 public boolean isEnabled(ToadletContext toadletContext) {