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