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.Reply;
34 import net.pterodactylus.sone.data.Sone;
35 import net.pterodactylus.sone.freenet.L10nFilter;
36 import net.pterodactylus.sone.main.SonePlugin;
37 import net.pterodactylus.sone.template.GetPagePlugin;
38 import net.pterodactylus.sone.template.PostAccessor;
39 import net.pterodactylus.sone.template.ReplyAccessor;
40 import net.pterodactylus.sone.template.RequestChangeFilter;
41 import net.pterodactylus.sone.template.SoneAccessor;
42 import net.pterodactylus.sone.template.SubstringFilter;
43 import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
44 import net.pterodactylus.sone.web.ajax.DeleteReplyAjaxPage;
45 import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
46 import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
47 import net.pterodactylus.sone.web.ajax.GetSoneStatusPage;
48 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
49 import net.pterodactylus.sone.web.ajax.LikeAjaxPage;
50 import net.pterodactylus.sone.web.ajax.UnfollowSoneAjaxPage;
51 import net.pterodactylus.sone.web.ajax.UnlikeAjaxPage;
52 import net.pterodactylus.sone.web.page.PageToadlet;
53 import net.pterodactylus.sone.web.page.PageToadletFactory;
54 import net.pterodactylus.sone.web.page.StaticPage;
55 import net.pterodactylus.util.logging.Logging;
56 import net.pterodactylus.util.service.AbstractService;
57 import net.pterodactylus.util.template.DateFilter;
58 import net.pterodactylus.util.template.DefaultTemplateFactory;
59 import net.pterodactylus.util.template.MatchFilter;
60 import net.pterodactylus.util.template.PaginationPlugin;
61 import net.pterodactylus.util.template.ReflectionAccessor;
62 import net.pterodactylus.util.template.Template;
63 import net.pterodactylus.util.template.TemplateException;
64 import net.pterodactylus.util.template.TemplateFactory;
65 import net.pterodactylus.util.template.TemplateProvider;
66 import net.pterodactylus.util.template.XmlFilter;
67 import freenet.clients.http.SessionManager;
68 import freenet.clients.http.ToadletContainer;
69 import freenet.l10n.BaseL10n;
72 * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
73 * references to l10n helpers.
75 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
77 public class WebInterface extends AbstractService {
80 private static final Logger logger = Logging.getLogger(WebInterface.class);
82 /** The Sone plugin. */
83 private final SonePlugin sonePlugin;
85 /** The registered toadlets. */
86 private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
88 /** The form password. */
89 private final String formPassword;
92 * Creates a new web interface.
97 public WebInterface(SonePlugin sonePlugin) {
98 super("Sone Web Interface", false);
99 this.sonePlugin = sonePlugin;
100 formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
108 * Returns the Sone core used by the Sone plugin.
110 * @return The Sone core
113 return sonePlugin.core();
117 * Returns the l10n helper of the node.
119 * @return The node’s l10n helper
121 public BaseL10n l10n() {
122 return sonePlugin.l10n().getBase();
126 * Returns the session manager of the node.
128 * @return The node’s session manager
130 public SessionManager sessionManager() {
132 return sonePlugin.pluginRespirator().getSessionManager(new URI("/"));
133 } catch (URISyntaxException use1) {
134 logger.log(Level.SEVERE, "Could not get Session Manager!", use1);
140 * Returns the node’s form password.
142 * @return The form password
144 public String formPassword() {
156 protected void serviceStart() {
164 protected void serviceStop() {
165 unregisterToadlets();
173 * Register all toadlets.
175 private void registerToadlets() {
176 DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
177 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
178 templateFactory.addAccessor(Sone.class, new SoneAccessor(core()));
179 templateFactory.addAccessor(Post.class, new PostAccessor(core()));
180 templateFactory.addAccessor(Reply.class, new ReplyAccessor(core()));
181 templateFactory.addFilter("date", new DateFilter());
182 templateFactory.addFilter("l10n", new L10nFilter(l10n()));
183 templateFactory.addFilter("substring", new SubstringFilter());
184 templateFactory.addFilter("xml", new XmlFilter());
185 templateFactory.addFilter("change", new RequestChangeFilter());
186 templateFactory.addFilter("match", new MatchFilter());
187 templateFactory.addPlugin("getpage", new GetPagePlugin());
188 templateFactory.addPlugin("paginate", new PaginationPlugin());
189 templateFactory.setTemplateProvider(new ClassPathTemplateProvider(templateFactory));
190 templateFactory.addTemplateObject("formPassword", formPassword);
192 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
193 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
194 Template addSoneTemplate = templateFactory.createTemplate(createReader("/templates/addSone.html"));
195 Template loadSoneTemplate = templateFactory.createTemplate(createReader("/templates/loadSone.html"));
196 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
197 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
198 Template importSoneTemplate = templateFactory.createTemplate(createReader("/templates/importSone.html"));
199 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
200 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
201 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
202 Template backupProfileTemplate = templateFactory.createTemplate(createReader("/templates/backup.xml"));
203 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
204 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
205 Template likePostTemplate = templateFactory.createTemplate(createReader("/templates/like.html"));
206 Template unlikePostTemplate = templateFactory.createTemplate(createReader("/templates/unlike.html"));
207 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
208 Template deleteReplyTemplate = templateFactory.createTemplate(createReader("/templates/deleteReply.html"));
209 Template followSoneTemplate = templateFactory.createTemplate(createReader("/templates/followSone.html"));
210 Template unfollowSoneTemplate = templateFactory.createTemplate(createReader("/templates/unfollowSone.html"));
211 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
212 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
213 Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html"));
214 Template optionsTemplate = templateFactory.createTemplate(createReader("/templates/options.html"));
215 Template aboutTemplate = templateFactory.createTemplate(createReader("/templates/about.html"));
216 Template helpTemplate = templateFactory.createTemplate(createReader("/templates/help.html"));
218 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
219 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
220 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
221 pageToadlets.add(pageToadletFactory.createPageToadlet(new ImportSonePage(importSoneTemplate, this), "ImportSone"));
222 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoadSonePage(loadSoneTemplate, this)));
223 pageToadlets.add(pageToadletFactory.createPageToadlet(new AddSonePage(addSoneTemplate, this)));
224 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
225 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
226 pageToadlets.add(pageToadletFactory.createPageToadlet(new BackupProfilePage(backupProfileTemplate, this)));
227 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
228 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
229 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
230 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
231 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikePage(likePostTemplate, this)));
232 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikePage(unlikePostTemplate, this)));
233 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
234 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
235 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(followSoneTemplate, this)));
236 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(unfollowSoneTemplate, this)));
237 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
238 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
239 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout"));
240 pageToadlets.add(pageToadletFactory.createPageToadlet(new OptionsPage(optionsTemplate, this), "Options"));
241 pageToadlets.add(pageToadletFactory.createPageToadlet(new AboutPage(aboutTemplate, this, SonePlugin.VERSION), "About"));
242 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("help.html", helpTemplate, "Page.Help.Title", this), "Help"));
243 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
244 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
245 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
246 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
247 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
248 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetSoneStatusPage(this)));
249 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostAjaxPage(this)));
250 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyAjaxPage(this)));
251 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSoneAjaxPage(this)));
252 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSoneAjaxPage(this)));
253 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikeAjaxPage(this)));
254 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikeAjaxPage(this)));
255 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetLikesAjaxPage(this)));
257 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
258 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
259 for (PageToadlet toadlet : pageToadlets) {
260 String menuName = toadlet.getMenuName();
261 if (menuName != null) {
262 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
264 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
270 * Unregisters all toadlets.
272 private void unregisterToadlets() {
273 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
274 for (PageToadlet pageToadlet : pageToadlets) {
275 toadletContainer.unregister(pageToadlet);
277 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
281 * Creates a {@link Reader} from the {@link InputStream} for the resource
282 * with the given name.
284 * @param resourceName
285 * The name of the resource
286 * @return A {@link Reader} for the resource
288 private Reader createReader(String resourceName) {
290 return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
291 } catch (UnsupportedEncodingException uee1) {
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);