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());
 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
 158                 String formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
 159
 160                 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
 161                 loginTemplate.set("formPassword", formPassword);
 162
 163                 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
 164                 indexTemplate.set("formPassword", formPassword);
 165
 166                 Template addSoneTemplate = templateFactory.createTemplate(createReader("/templates/addSone.html"));
 167                 addSoneTemplate.set("formPassword", formPassword);
 168
 169                 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
 170                 knownSonesTemplate.set("formPassword", formPassword);
 171
 172                 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
 173                 createSoneTemplate.set("formPassword", formPassword);
 174
 175                 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
 176                 createPostTemplate.set("formPassword", formPassword);
 177
 178                 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
 179                 createReplyTemplate.set("formPassword", formPassword);
 180
 181                 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
 182                 editProfileTemplate.set("formPassword", formPassword);
 183
 184                 Template backupProfileTemplate = templateFactory.createTemplate(createReader("/templates/backup.xml"));
 185                 backupProfileTemplate.set("formPassword", formPassword);
 186
 187                 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
 188                 viewSoneTemplate.set("formPassword", formPassword);
 189
 190                 Template blockSoneTemplate = templateFactory.createTemplate(createReader("/templates/blockSone.html"));
 191                 blockSoneTemplate.set("formPassword", formPassword);
 192
 193                 Template unblockSoneTemplate = templateFactory.createTemplate(createReader("/templates/unblockSone.html"));
 194                 unblockSoneTemplate.set("formPassword", formPassword);
 195
 196                 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
 197                 viewPostTemplate.set("formPassword", formPassword);
 198
 199                 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
 200                 deletePostTemplate.set("formPassword", formPassword);
 201
 202                 Template followSoneTemplate = templateFactory.createTemplate(createReader("/templates/followSone.html"));
 203                 followSoneTemplate.set("formPassword", formPassword);
 204
 205                 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
 206                 deleteSoneTemplate.set("formPassword", formPassword);
 207
 208                 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
 209
 210                 Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html"));
 211
 212                 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
 213                 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
 214                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
 215                 pageToadlets.add(pageToadletFactory.createPageToadlet(new AddSonePage(addSoneTemplate, this), "AddSone"));
 216                 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
 217                 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
 218                 pageToadlets.add(pageToadletFactory.createPageToadlet(new BackupProfilePage(backupProfileTemplate, this)));
 219                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
 220                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
 221                 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
 222                 pageToadlets.add(pageToadletFactory.createPageToadlet(new BlockSonePage(blockSoneTemplate, this)));
 223                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnblockSonePage(unblockSoneTemplate, this)));
 224                 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
 225                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
 226                 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(followSoneTemplate, this)));
 227                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
 228                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
 229                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout"));
 230                 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
 231                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
 232                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
 233                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
 234
 235                 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
 236                 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
 237                 for (PageToadlet toadlet : pageToadlets) {
 238                         String menuName = toadlet.getMenuName();
 239                         if (menuName != null) {
 240                                 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
 241                         } else {
 242                                 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
 243                         }
 244                 }
 245         }
 246
 247         /**
 248          * Unregisters all toadlets.
 249          */
 250         private void unregisterToadlets() {
 251                 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
 252                 for (PageToadlet pageToadlet : pageToadlets) {
 253                         toadletContainer.unregister(pageToadlet);
 254                 }
 255                 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
 256         }
 257
 258         /**
 259          * Creates a {@link Reader} from the {@link InputStream} for the resource
 260          * with the given name.
 261          *
 262          * @param resourceName
 263          *            The name of the resource
 264          * @return A {@link Reader} for the resource
 265          */
 266         private Reader createReader(String resourceName) {
 267                 try {
 268                         return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
 269                 } catch (UnsupportedEncodingException uee1) {
 270                         return null;
 271                 }
 272         }
 273
 274         /**
 275          * {@link LinkEnabledCallback} implementation that always returns
 276          * {@code true} when {@link LinkEnabledCallback#isEnabled(ToadletContext)}
 277          * is called.
 278          *
 279          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 280          */
 281         public class AlwaysEnabledCallback implements LinkEnabledCallback {
 282
 283                 /**
 284                  * {@inheritDoc}
 285                  */
 286                 @Override
 287                 public boolean isEnabled(ToadletContext toadletContext) {
 288                         return true;
 289                 }
 290         }
 291
 292         /**
 293          * Template provider implementation that uses
 294          * {@link WebInterface#createReader(String)} to load templates for
 295          * inclusion.
 296          *
 297          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 298          */
 299         private class ClassPathTemplateProvider implements TemplateProvider {
 300
 301                 /** The template factory. */
 302                 private final TemplateFactory templateFactory;
 303
 304                 /**
 305                  * Creates a new template provider that locates templates on the
 306                  * classpath.
 307                  *
 308                  * @param templateFactory
 309                  *            The template factory to create the templates
 310                  */
 311                 public ClassPathTemplateProvider(TemplateFactory templateFactory) {
 312                         this.templateFactory = templateFactory;
 313                 }
 314
 315                 /**
 316                  * {@inheritDoc}
 317                  */
 318                 @Override
 319                 @SuppressWarnings("synthetic-access")
 320                 public Template getTemplate(String templateName) {
 321                         Reader templateReader = createReader("/templates/" + templateName);
 322                         if (templateReader == null) {
 323                                 return null;
 324                         }
 325                         Template template = templateFactory.createTemplate(templateReader);
 326                         try {
 327                                 template.parse();
 328                         } catch (TemplateException te1) {
 329                                 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);
 330                         }
 331                         return template;
 332                 }
 333
 334         }
 335 }