src/main/java/net/pterodactylus/sone/web/WebInterface.java

   1 /*
   2  * FreenetSone - WebInterface.java - Copyright © 2010 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sone.web;
  19
  20 import java.io.InputStream;
  21 import java.io.InputStreamReader;
  22 import java.io.Reader;
  23 import java.io.UnsupportedEncodingException;
  24 import java.net.URI;
  25 import java.net.URISyntaxException;
  26 import java.util.ArrayList;
  27 import java.util.Collection;
  28 import java.util.List;
  29 import java.util.logging.Level;
  30 import java.util.logging.Logger;
  31
  32 import net.pterodactylus.sone.core.Core;
  33 import net.pterodactylus.sone.data.Post;
  34 import net.pterodactylus.sone.data.Reply;
  35 import net.pterodactylus.sone.data.Sone;
  36 import net.pterodactylus.sone.freenet.L10nFilter;
  37 import net.pterodactylus.sone.freenet.wot.Identity;
  38 import net.pterodactylus.sone.main.SonePlugin;
  39 import net.pterodactylus.sone.template.CollectionAccessor;
  40 import net.pterodactylus.sone.template.CssClassNameFilter;
  41 import net.pterodactylus.sone.template.GetPagePlugin;
  42 import net.pterodactylus.sone.template.IdentityAccessor;
  43 import net.pterodactylus.sone.template.PostAccessor;
  44 import net.pterodactylus.sone.template.ReplyAccessor;
  45 import net.pterodactylus.sone.template.RequestChangeFilter;
  46 import net.pterodactylus.sone.template.SoneAccessor;
  47 import net.pterodactylus.sone.template.SubstringFilter;
  48 import net.pterodactylus.sone.web.ajax.CreateReplyAjaxPage;
  49 import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
  50 import net.pterodactylus.sone.web.ajax.DeleteReplyAjaxPage;
  51 import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
  52 import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
  53 import net.pterodactylus.sone.web.ajax.GetReplyAjaxPage;
  54 import net.pterodactylus.sone.web.ajax.GetSoneStatusPage;
  55 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
  56 import net.pterodactylus.sone.web.ajax.LikeAjaxPage;
  57 import net.pterodactylus.sone.web.ajax.UnfollowSoneAjaxPage;
  58 import net.pterodactylus.sone.web.ajax.UnlikeAjaxPage;
  59 import net.pterodactylus.sone.web.page.PageToadlet;
  60 import net.pterodactylus.sone.web.page.PageToadletFactory;
  61 import net.pterodactylus.sone.web.page.StaticPage;
  62 import net.pterodactylus.util.logging.Logging;
  63 import net.pterodactylus.util.template.DateFilter;
  64 import net.pterodactylus.util.template.DefaultTemplateFactory;
  65 import net.pterodactylus.util.template.MatchFilter;
  66 import net.pterodactylus.util.template.PaginationPlugin;
  67 import net.pterodactylus.util.template.ReflectionAccessor;
  68 import net.pterodactylus.util.template.Template;
  69 import net.pterodactylus.util.template.TemplateException;
  70 import net.pterodactylus.util.template.TemplateFactory;
  71 import net.pterodactylus.util.template.TemplateProvider;
  72 import net.pterodactylus.util.template.XmlFilter;
  73 import freenet.clients.http.SessionManager;
  74 import freenet.clients.http.ToadletContainer;
  75 import freenet.l10n.BaseL10n;
  76
  77 /**
  78  * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
  79  * references to l10n helpers.
  80  *
  81  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  82  */
  83 public class WebInterface {
  84
  85         /** The logger. */
  86         private static final Logger logger = Logging.getLogger(WebInterface.class);
  87
  88         /** The Sone plugin. */
  89         private final SonePlugin sonePlugin;
  90
  91         /** The registered toadlets. */
  92         private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
  93
  94         /** The form password. */
  95         private final String formPassword;
  96
  97         /**
  98          * Creates a new web interface.
  99          *
 100          * @param sonePlugin
 101          *            The Sone plugin
 102          */
 103         public WebInterface(SonePlugin sonePlugin) {
 104                 this.sonePlugin = sonePlugin;
 105                 formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
 106         }
 107
 108         //
 109         // ACCESSORS
 110         //
 111
 112         /**
 113          * Returns the Sone core used by the Sone plugin.
 114          *
 115          * @return The Sone core
 116          */
 117         public Core getCore() {
 118                 return sonePlugin.core();
 119         }
 120
 121         /**
 122          * Returns the l10n helper of the node.
 123          *
 124          * @return The node’s l10n helper
 125          */
 126         public BaseL10n getL10n() {
 127                 return sonePlugin.l10n().getBase();
 128         }
 129
 130         /**
 131          * Returns the session manager of the node.
 132          *
 133          * @return The node’s session manager
 134          */
 135         public SessionManager getSessionManager() {
 136                 try {
 137                         return sonePlugin.pluginRespirator().getSessionManager(new URI("/"));
 138                 } catch (URISyntaxException use1) {
 139                         logger.log(Level.SEVERE, "Could not get Session Manager!", use1);
 140                         return null;
 141                 }
 142         }
 143
 144         /**
 145          * Returns the node’s form password.
 146          *
 147          * @return The form password
 148          */
 149         public String getFormPassword() {
 150                 return formPassword;
 151         }
 152
 153         //
 154         // ACTIONS
 155         //
 156
 157         /**
 158          * Starts the web interface and registers all toadlets.
 159          */
 160         public void start() {
 161                 registerToadlets();
 162         }
 163
 164         /**
 165          * Stops the web interface and unregisters all toadlets.
 166          */
 167         public void stop() {
 168                 unregisterToadlets();
 169         }
 170
 171         //
 172         // PRIVATE METHODS
 173         //
 174
 175         /**
 176          * Register all toadlets.
 177          */
 178         private void registerToadlets() {
 179                 DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
 180                 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
 181                 templateFactory.addAccessor(Collection.class, new CollectionAccessor());
 182                 templateFactory.addAccessor(Sone.class, new SoneAccessor(getCore()));
 183                 templateFactory.addAccessor(Post.class, new PostAccessor(getCore()));
 184                 templateFactory.addAccessor(Reply.class, new ReplyAccessor(getCore()));
 185                 templateFactory.addAccessor(Identity.class, new IdentityAccessor(getCore()));
 186                 templateFactory.addFilter("date", new DateFilter());
 187                 templateFactory.addFilter("l10n", new L10nFilter(getL10n()));
 188                 templateFactory.addFilter("substring", new SubstringFilter());
 189                 templateFactory.addFilter("xml", new XmlFilter());
 190                 templateFactory.addFilter("change", new RequestChangeFilter());
 191                 templateFactory.addFilter("match", new MatchFilter());
 192                 templateFactory.addFilter("css", new CssClassNameFilter());
 193                 templateFactory.addPlugin("getpage", new GetPagePlugin());
 194                 templateFactory.addPlugin("paginate", new PaginationPlugin());
 195                 templateFactory.setTemplateProvider(new ClassPathTemplateProvider(templateFactory));
 196                 templateFactory.addTemplateObject("formPassword", formPassword);
 197
 198                 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
 199                 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
 200                 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
 201                 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
 202                 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
 203                 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
 204                 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
 205                 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
 206                 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
 207                 Template likePostTemplate = templateFactory.createTemplate(createReader("/templates/like.html"));
 208                 Template unlikePostTemplate = templateFactory.createTemplate(createReader("/templates/unlike.html"));
 209                 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
 210                 Template deleteReplyTemplate = templateFactory.createTemplate(createReader("/templates/deleteReply.html"));
 211                 Template followSoneTemplate = templateFactory.createTemplate(createReader("/templates/followSone.html"));
 212                 Template unfollowSoneTemplate = templateFactory.createTemplate(createReader("/templates/unfollowSone.html"));
 213                 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
 214                 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
 215                 Template wotPluginMissingTemplate = templateFactory.createTemplate(createReader("/templates/wotPluginMissing.html"));
 216                 Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html"));
 217                 Template optionsTemplate = templateFactory.createTemplate(createReader("/templates/options.html"));
 218                 Template aboutTemplate = templateFactory.createTemplate(createReader("/templates/about.html"));
 219                 Template replyTemplate = templateFactory.createTemplate(createReader("/templates/include/viewReply.html"));
 220
 221                 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
 222                 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
 223                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
 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 CreatePostPage(createPostTemplate, this)));
 227                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
 228                 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
 229                 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
 230                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikePage(likePostTemplate, this)));
 231                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikePage(unlikePostTemplate, this)));
 232                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
 233                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
 234                 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(followSoneTemplate, this)));
 235                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(unfollowSoneTemplate, this)));
 236                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
 237                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
 238                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout"));
 239                 pageToadlets.add(pageToadletFactory.createPageToadlet(new OptionsPage(optionsTemplate, this), "Options"));
 240                 pageToadlets.add(pageToadletFactory.createPageToadlet(new AboutPage(aboutTemplate, this, SonePlugin.VERSION), "About"));
 241                 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
 242                 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("wotPluginMissing.html", wotPluginMissingTemplate, "Page.WotPluginMissing.Title", this)));
 243                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
 244                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
 245                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
 246                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
 247                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetSoneStatusPage(this)));
 248                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyAjaxPage(this)));
 249                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetReplyAjaxPage(this, replyTemplate)));
 250                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostAjaxPage(this)));
 251                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyAjaxPage(this)));
 252                 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSoneAjaxPage(this)));
 253                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSoneAjaxPage(this)));
 254                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikeAjaxPage(this)));
 255                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikeAjaxPage(this)));
 256                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetLikesAjaxPage(this)));
 257
 258                 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
 259                 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
 260                 for (PageToadlet toadlet : pageToadlets) {
 261                         String menuName = toadlet.getMenuName();
 262                         if (menuName != null) {
 263                                 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
 264                         } else {
 265                                 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
 266                         }
 267                 }
 268         }
 269
 270         /**
 271          * Unregisters all toadlets.
 272          */
 273         private void unregisterToadlets() {
 274                 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
 275                 for (PageToadlet pageToadlet : pageToadlets) {
 276                         toadletContainer.unregister(pageToadlet);
 277                 }
 278                 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
 279         }
 280
 281         /**
 282          * Creates a {@link Reader} from the {@link InputStream} for the resource
 283          * with the given name.
 284          *
 285          * @param resourceName
 286          *            The name of the resource
 287          * @return A {@link Reader} for the resource
 288          */
 289         private Reader createReader(String resourceName) {
 290                 try {
 291                         return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
 292                 } catch (UnsupportedEncodingException uee1) {
 293                         return null;
 294                 }
 295         }
 296
 297         /**
 298          * Template provider implementation that uses
 299          * {@link WebInterface#createReader(String)} to load templates for
 300          * inclusion.
 301          *
 302          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 303          */
 304         private class ClassPathTemplateProvider implements TemplateProvider {
 305
 306                 /** The template factory. */
 307                 private final TemplateFactory templateFactory;
 308
 309                 /**
 310                  * Creates a new template provider that locates templates on the
 311                  * classpath.
 312                  *
 313                  * @param templateFactory
 314                  *            The template factory to create the templates
 315                  */
 316                 public ClassPathTemplateProvider(TemplateFactory templateFactory) {
 317                         this.templateFactory = templateFactory;
 318                 }
 319
 320                 /**
 321                  * {@inheritDoc}
 322                  */
 323                 @Override
 324                 @SuppressWarnings("synthetic-access")
 325                 public Template getTemplate(String templateName) {
 326                         Reader templateReader = createReader("/templates/" + templateName);
 327                         if (templateReader == null) {
 328                                 return null;
 329                         }
 330                         Template template = templateFactory.createTemplate(templateReader);
 331                         try {
 332                                 template.parse();
 333                         } catch (TemplateException te1) {
 334                                 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);
 335                         }
 336                         return template;
 337                 }
 338
 339         }
 340
 341 }