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