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));
158 String formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
160 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
161 loginTemplate.set("formPassword", formPassword);
163 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
164 indexTemplate.set("formPassword", formPassword);
166 Template addSoneTemplate = templateFactory.createTemplate(createReader("/templates/addSone.html"));
167 addSoneTemplate.set("formPassword", formPassword);
169 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
170 knownSonesTemplate.set("formPassword", formPassword);
172 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
173 createSoneTemplate.set("formPassword", formPassword);
175 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
176 createPostTemplate.set("formPassword", formPassword);
178 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
179 createReplyTemplate.set("formPassword", formPassword);
181 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
182 editProfileTemplate.set("formPassword", formPassword);
184 Template backupProfileTemplate = templateFactory.createTemplate(createReader("/templates/backup.xml"));
185 backupProfileTemplate.set("formPassword", formPassword);
187 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
188 viewSoneTemplate.set("formPassword", formPassword);
190 Template blockSoneTemplate = templateFactory.createTemplate(createReader("/templates/blockSone.html"));
191 blockSoneTemplate.set("formPassword", formPassword);
193 Template unblockSoneTemplate = templateFactory.createTemplate(createReader("/templates/unblockSone.html"));
194 unblockSoneTemplate.set("formPassword", formPassword);
196 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
197 viewPostTemplate.set("formPassword", formPassword);
199 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
200 deletePostTemplate.set("formPassword", formPassword);
202 Template followSoneTemplate = templateFactory.createTemplate(createReader("/templates/followSone.html"));
203 followSoneTemplate.set("formPassword", formPassword);
205 Template unfollowSoneTemplate = templateFactory.createTemplate(createReader("/templates/unfollowSone.html"));
206 unfollowSoneTemplate.set("formPassword", formPassword);
208 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
209 deleteSoneTemplate.set("formPassword", formPassword);
211 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
213 Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html"));
215 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
216 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
217 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
218 pageToadlets.add(pageToadletFactory.createPageToadlet(new AddSonePage(addSoneTemplate, this), "AddSone"));
219 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
220 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
221 pageToadlets.add(pageToadletFactory.createPageToadlet(new BackupProfilePage(backupProfileTemplate, this)));
222 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
223 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
224 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
225 pageToadlets.add(pageToadletFactory.createPageToadlet(new BlockSonePage(blockSoneTemplate, this)));
226 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnblockSonePage(unblockSoneTemplate, this)));
227 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
228 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
229 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(followSoneTemplate, this)));
230 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(unfollowSoneTemplate, this)));
231 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
232 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
233 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout"));
234 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
235 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
236 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
237 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
239 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
240 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
241 for (PageToadlet toadlet : pageToadlets) {
242 String menuName = toadlet.getMenuName();
243 if (menuName != null) {
244 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
246 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
252 * Unregisters all toadlets.
254 private void unregisterToadlets() {
255 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
256 for (PageToadlet pageToadlet : pageToadlets) {
257 toadletContainer.unregister(pageToadlet);
259 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
263 * Creates a {@link Reader} from the {@link InputStream} for the resource
264 * with the given name.
266 * @param resourceName
267 * The name of the resource
268 * @return A {@link Reader} for the resource
270 private Reader createReader(String resourceName) {
272 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
273 } catch (UnsupportedEncodingException uee1) {
279 * {@link LinkEnabledCallback} implementation that always returns
280 * {@code true} when {@link LinkEnabledCallback#isEnabled(ToadletContext)}
283 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
285 public class AlwaysEnabledCallback implements LinkEnabledCallback {
291 public boolean isEnabled(ToadletContext toadletContext) {
297 * Template provider implementation that uses
298 * {@link WebInterface#createReader(String)} to load templates for
301 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
303 private class ClassPathTemplateProvider implements TemplateProvider {
305 /** The template factory. */
306 private final TemplateFactory templateFactory;
309 * Creates a new template provider that locates templates on the
312 * @param templateFactory
313 * The template factory to create the templates
315 public ClassPathTemplateProvider(TemplateFactory templateFactory) {
316 this.templateFactory = templateFactory;
323 @SuppressWarnings("synthetic-access")
324 public Template getTemplate(String templateName) {
325 Reader templateReader = createReader("/templates/" + templateName);
326 if (templateReader == null) {
329 Template template = templateFactory.createTemplate(templateReader);
332 } catch (TemplateException te1) {
333 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);