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