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.GetPagePlugin;
37 import net.pterodactylus.sone.template.PostAccessor;
38 import net.pterodactylus.sone.template.RequestChangeFilter;
39 import net.pterodactylus.sone.template.SoneAccessor;
40 import net.pterodactylus.sone.template.SubstringFilter;
41 import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
42 import net.pterodactylus.sone.web.ajax.GetSoneStatusPage;
43 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
44 import net.pterodactylus.sone.web.page.PageToadlet;
45 import net.pterodactylus.sone.web.page.PageToadletFactory;
46 import net.pterodactylus.sone.web.page.StaticPage;
47 import net.pterodactylus.util.logging.Logging;
48 import net.pterodactylus.util.service.AbstractService;
49 import net.pterodactylus.util.template.DateFilter;
50 import net.pterodactylus.util.template.DefaultTemplateFactory;
51 import net.pterodactylus.util.template.PaginationPlugin;
52 import net.pterodactylus.util.template.ReflectionAccessor;
53 import net.pterodactylus.util.template.Template;
54 import net.pterodactylus.util.template.TemplateException;
55 import net.pterodactylus.util.template.TemplateFactory;
56 import net.pterodactylus.util.template.TemplateProvider;
57 import net.pterodactylus.util.template.XmlFilter;
58 import freenet.clients.http.SessionManager;
59 import freenet.clients.http.ToadletContainer;
60 import freenet.l10n.BaseL10n;
63 * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
64 * references to l10n helpers.
66 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
68 public class WebInterface extends AbstractService {
71 private static final Logger logger = Logging.getLogger(WebInterface.class);
73 /** The Sone plugin. */
74 private final SonePlugin sonePlugin;
76 /** The registered toadlets. */
77 private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
79 /** The form password. */
80 private final String formPassword;
83 * Creates a new web interface.
88 public WebInterface(SonePlugin sonePlugin) {
89 super("Sone Web Interface", false);
90 this.sonePlugin = sonePlugin;
91 formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
99 * Returns the Sone core used by the Sone plugin.
101 * @return The Sone core
104 return sonePlugin.core();
108 * Returns the l10n helper of the node.
110 * @return The node’s l10n helper
112 public BaseL10n l10n() {
113 return sonePlugin.l10n().getBase();
117 * Returns the session manager of the node.
119 * @return The node’s session manager
121 public SessionManager sessionManager() {
123 return sonePlugin.pluginRespirator().getSessionManager(new URI("/"));
124 } catch (URISyntaxException use1) {
125 logger.log(Level.SEVERE, "Could not get Session Manager!", use1);
131 * Returns the node’s form password.
133 * @return The form password
135 public String formPassword() {
147 protected void serviceStart() {
155 protected void serviceStop() {
156 unregisterToadlets();
164 * Register all toadlets.
166 private void registerToadlets() {
167 DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
168 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
169 templateFactory.addAccessor(Sone.class, new SoneAccessor(core()));
170 templateFactory.addAccessor(Post.class, new PostAccessor(core()));
171 templateFactory.addFilter("date", new DateFilter());
172 templateFactory.addFilter("l10n", new L10nFilter(l10n()));
173 templateFactory.addFilter("substring", new SubstringFilter());
174 templateFactory.addFilter("xml", new XmlFilter());
175 templateFactory.addFilter("change", new RequestChangeFilter());
176 templateFactory.addPlugin("getpage", new GetPagePlugin());
177 templateFactory.addPlugin("paginate", new PaginationPlugin());
178 templateFactory.setTemplateProvider(new ClassPathTemplateProvider(templateFactory));
179 templateFactory.addTemplateObject("formPassword", formPassword);
181 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
182 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
183 Template addSoneTemplate = templateFactory.createTemplate(createReader("/templates/addSone.html"));
184 Template loadSoneTemplate = templateFactory.createTemplate(createReader("/templates/loadSone.html"));
185 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
186 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
187 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
188 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
189 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
190 Template backupProfileTemplate = templateFactory.createTemplate(createReader("/templates/backup.xml"));
191 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
192 Template blockSoneTemplate = templateFactory.createTemplate(createReader("/templates/blockSone.html"));
193 Template unblockSoneTemplate = templateFactory.createTemplate(createReader("/templates/unblockSone.html"));
194 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
195 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
196 Template deleteReplyTemplate = templateFactory.createTemplate(createReader("/templates/deleteReply.html"));
197 Template followSoneTemplate = templateFactory.createTemplate(createReader("/templates/followSone.html"));
198 Template unfollowSoneTemplate = templateFactory.createTemplate(createReader("/templates/unfollowSone.html"));
199 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
200 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
201 Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html"));
203 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
204 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
205 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
206 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoadSonePage(loadSoneTemplate, this)));
207 pageToadlets.add(pageToadletFactory.createPageToadlet(new AddSonePage(addSoneTemplate, this)));
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 BlockSonePage(blockSoneTemplate, this)));
215 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnblockSonePage(unblockSoneTemplate, this)));
216 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
217 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
218 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
219 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(followSoneTemplate, this)));
220 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(unfollowSoneTemplate, this)));
221 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
222 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
223 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout"));
224 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
225 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
226 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
227 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
228 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
229 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetSoneStatusPage(this)));
230 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostAjaxPage(this)));
232 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
233 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
234 for (PageToadlet toadlet : pageToadlets) {
235 String menuName = toadlet.getMenuName();
236 if (menuName != null) {
237 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
239 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
245 * Unregisters all toadlets.
247 private void unregisterToadlets() {
248 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
249 for (PageToadlet pageToadlet : pageToadlets) {
250 toadletContainer.unregister(pageToadlet);
252 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
256 * Creates a {@link Reader} from the {@link InputStream} for the resource
257 * with the given name.
259 * @param resourceName
260 * The name of the resource
261 * @return A {@link Reader} for the resource
263 private Reader createReader(String resourceName) {
265 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
266 } catch (UnsupportedEncodingException uee1) {
272 * Template provider implementation that uses
273 * {@link WebInterface#createReader(String)} to load templates for
276 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
278 private class ClassPathTemplateProvider implements TemplateProvider {
280 /** The template factory. */
281 private final TemplateFactory templateFactory;
284 * Creates a new template provider that locates templates on the
287 * @param templateFactory
288 * The template factory to create the templates
290 public ClassPathTemplateProvider(TemplateFactory templateFactory) {
291 this.templateFactory = templateFactory;
298 @SuppressWarnings("synthetic-access")
299 public Template getTemplate(String templateName) {
300 Reader templateReader = createReader("/templates/" + templateName);
301 if (templateReader == null) {
304 Template template = templateFactory.createTemplate(templateReader);
307 } catch (TemplateException te1) {
308 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);