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.ajax.GetSoneStatusPage;
40 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
41 import net.pterodactylus.sone.web.page.PageToadlet;
42 import net.pterodactylus.sone.web.page.PageToadletFactory;
43 import net.pterodactylus.sone.web.page.StaticPage;
44 import net.pterodactylus.util.logging.Logging;
45 import net.pterodactylus.util.service.AbstractService;
46 import net.pterodactylus.util.template.DateFilter;
47 import net.pterodactylus.util.template.DefaultTemplateFactory;
48 import net.pterodactylus.util.template.ReflectionAccessor;
49 import net.pterodactylus.util.template.Template;
50 import net.pterodactylus.util.template.TemplateException;
51 import net.pterodactylus.util.template.TemplateFactory;
52 import net.pterodactylus.util.template.TemplateProvider;
53 import net.pterodactylus.util.template.XmlFilter;
54 import freenet.clients.http.SessionManager;
55 import freenet.clients.http.ToadletContainer;
56 import freenet.l10n.BaseL10n;
59 * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
60 * references to l10n helpers.
62 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
64 public class WebInterface extends AbstractService {
67 private static final Logger logger = Logging.getLogger(WebInterface.class);
69 /** The Sone plugin. */
70 private final SonePlugin sonePlugin;
72 /** The registered toadlets. */
73 private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
76 * Creates a new web interface.
81 public WebInterface(SonePlugin sonePlugin) {
82 super("Sone Web Interface", false);
83 this.sonePlugin = sonePlugin;
91 * Returns the Sone core used by the Sone plugin.
93 * @return The Sone core
96 return sonePlugin.core();
100 * Returns the l10n helper of the node.
102 * @return The node’s l10n helper
104 public BaseL10n l10n() {
105 return sonePlugin.l10n().getBase();
109 * Returns the session manager of the node.
111 * @return The node’s session manager
113 public SessionManager sessionManager() {
115 return sonePlugin.pluginRespirator().getSessionManager(new URI("/"));
116 } catch (URISyntaxException use1) {
117 logger.log(Level.SEVERE, "Could not get Session Manager!", use1);
130 protected void serviceStart() {
138 protected void serviceStop() {
139 unregisterToadlets();
147 * Register all toadlets.
149 private void registerToadlets() {
150 DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
151 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
152 templateFactory.addAccessor(Sone.class, new SoneAccessor(core()));
153 templateFactory.addAccessor(Post.class, new PostAccessor(core()));
154 templateFactory.addFilter("date", new DateFilter());
155 templateFactory.addFilter("l10n", new L10nFilter(l10n()));
156 templateFactory.addFilter("substring", new SubstringFilter());
157 templateFactory.addFilter("xml", new XmlFilter());
158 templateFactory.setTemplateProvider(new ClassPathTemplateProvider(templateFactory));
159 templateFactory.addTemplateObject("formPassword", sonePlugin.pluginRespirator().getToadletContainer().getFormPassword());
161 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
162 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
163 Template addSoneTemplate = templateFactory.createTemplate(createReader("/templates/addSone.html"));
164 Template loadSoneTemplate = templateFactory.createTemplate(createReader("/templates/loadSone.html"));
165 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
166 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
167 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
168 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
169 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
170 Template backupProfileTemplate = templateFactory.createTemplate(createReader("/templates/backup.xml"));
171 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
172 Template blockSoneTemplate = templateFactory.createTemplate(createReader("/templates/blockSone.html"));
173 Template unblockSoneTemplate = templateFactory.createTemplate(createReader("/templates/unblockSone.html"));
174 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
175 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
176 Template deleteReplyTemplate = templateFactory.createTemplate(createReader("/templates/deleteReply.html"));
177 Template followSoneTemplate = templateFactory.createTemplate(createReader("/templates/followSone.html"));
178 Template unfollowSoneTemplate = templateFactory.createTemplate(createReader("/templates/unfollowSone.html"));
179 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
180 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
181 Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html"));
183 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
184 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
185 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
186 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoadSonePage(loadSoneTemplate, this)));
187 pageToadlets.add(pageToadletFactory.createPageToadlet(new AddSonePage(addSoneTemplate, this)));
188 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
189 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
190 pageToadlets.add(pageToadletFactory.createPageToadlet(new BackupProfilePage(backupProfileTemplate, this)));
191 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
192 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
193 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
194 pageToadlets.add(pageToadletFactory.createPageToadlet(new BlockSonePage(blockSoneTemplate, this)));
195 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnblockSonePage(unblockSoneTemplate, this)));
196 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
197 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
198 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
199 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(followSoneTemplate, this)));
200 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(unfollowSoneTemplate, this)));
201 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
202 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
203 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout"));
204 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
205 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
206 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
207 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
208 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
209 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetSoneStatusPage(core())));
211 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
212 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
213 for (PageToadlet toadlet : pageToadlets) {
214 String menuName = toadlet.getMenuName();
215 if (menuName != null) {
216 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
218 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
224 * Unregisters all toadlets.
226 private void unregisterToadlets() {
227 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
228 for (PageToadlet pageToadlet : pageToadlets) {
229 toadletContainer.unregister(pageToadlet);
231 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
235 * Creates a {@link Reader} from the {@link InputStream} for the resource
236 * with the given name.
238 * @param resourceName
239 * The name of the resource
240 * @return A {@link Reader} for the resource
242 private Reader createReader(String resourceName) {
244 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
245 } catch (UnsupportedEncodingException uee1) {
251 * Template provider implementation that uses
252 * {@link WebInterface#createReader(String)} to load templates for
255 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
257 private class ClassPathTemplateProvider implements TemplateProvider {
259 /** The template factory. */
260 private final TemplateFactory templateFactory;
263 * Creates a new template provider that locates templates on the
266 * @param templateFactory
267 * The template factory to create the templates
269 public ClassPathTemplateProvider(TemplateFactory templateFactory) {
270 this.templateFactory = templateFactory;
277 @SuppressWarnings("synthetic-access")
278 public Template getTemplate(String templateName) {
279 Reader templateReader = createReader("/templates/" + templateName);
280 if (templateReader == null) {
283 Template template = templateFactory.createTemplate(templateReader);
286 } catch (TemplateException te1) {
287 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);