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.main.SonePlugin;
  33 import net.pterodactylus.sone.web.page.CSSPage;
  34 import net.pterodactylus.sone.web.page.PageToadlet;
  35 import net.pterodactylus.sone.web.page.PageToadletFactory;
  36 import net.pterodactylus.util.logging.Logging;
  37 import net.pterodactylus.util.service.AbstractService;
  38 import net.pterodactylus.util.template.Template;
  39 import net.pterodactylus.util.template.TemplateFactory;
  40 import freenet.clients.http.LinkEnabledCallback;
  41 import freenet.clients.http.SessionManager;
  42 import freenet.clients.http.ToadletContainer;
  43 import freenet.clients.http.ToadletContext;
  44 import freenet.l10n.BaseL10n;
  45
  46 /**
  47  * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
  48  * references to l10n helpers.
  49  *
  50  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  51  */
  52 public class WebInterface extends AbstractService {
  53
  54         /** The logger. */
  55         private static final Logger logger = Logging.getLogger(WebInterface.class);
  56
  57         /** The Sone plugin. */
  58         private final SonePlugin sonePlugin;
  59
  60         /** The registered toadlets. */
  61         private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
  62
  63         /**
  64          * Creates a new web interface.
  65          *
  66          * @param sonePlugin
  67          *            The Sone plugin
  68          */
  69         public WebInterface(SonePlugin sonePlugin) {
  70                 this.sonePlugin = sonePlugin;
  71         }
  72
  73         //
  74         // ACCESSORS
  75         //
  76
  77         /**
  78          * Returns the Sone core used by the Sone plugin.
  79          *
  80          * @return The Sone core
  81          */
  82         public Core core() {
  83                 return sonePlugin.core();
  84         }
  85
  86         /**
  87          * Returns the l10n helper of the node.
  88          *
  89          * @return The node’s l10n helper
  90          */
  91         public BaseL10n l10n() {
  92                 return sonePlugin.l10n().getBase();
  93         }
  94
  95         /**
  96          * Returns the session manager of the node.
  97          *
  98          * @return The node’s session manager
  99          */
 100         public SessionManager sessionManager() {
 101                 try {
 102                         return sonePlugin.pluginRespirator().getSessionManager(new URI("/"));
 103                 } catch (URISyntaxException use1) {
 104                         logger.log(Level.SEVERE, "Could not get Session Manager!", use1);
 105                         return null;
 106                 }
 107         }
 108
 109         //
 110         // SERVICE METHODS
 111         //
 112
 113         /**
 114          * {@inheritDoc}
 115          */
 116         @Override
 117         protected void serviceStart() {
 118                 registerToadlets();
 119         }
 120
 121         /**
 122          * {@inheritDoc}
 123          */
 124         @Override
 125         protected void serviceStop() {
 126                 unregisterToadlets();
 127         }
 128
 129         //
 130         // PRIVATE METHODS
 131         //
 132
 133         /**
 134          * Register all toadlets.
 135          */
 136         private void registerToadlets() {
 137                 TemplateFactory templateFactory = new SoneTemplateFactory(l10n());
 138
 139                 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
 140                 loginTemplate.set("formPassword", sonePlugin.pluginRespirator().getToadletContainer().getFormPassword());
 141
 142                 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
 143                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
 144                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CSSPage("css/", "/static/css/")));
 145
 146                 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
 147                 toadletContainer.getPageMaker().addNavigationCategory("/Sone/", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
 148                 for (PageToadlet toadlet : pageToadlets) {
 149                         String menuName = toadlet.getMenuName();
 150                         if (menuName != null) {
 151                                 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, new AlwaysEnabledCallback());
 152                         } else {
 153                                 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
 154                         }
 155                 }
 156         }
 157
 158         /**
 159          * Unregisters all toadlets.
 160          */
 161         private void unregisterToadlets() {
 162                 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
 163                 for (PageToadlet pageToadlet : pageToadlets) {
 164                         toadletContainer.unregister(pageToadlet);
 165                 }
 166                 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
 167         }
 168
 169         /**
 170          * Creates a {@link Reader} from the {@link InputStream} for the resource
 171          * with the given name.
 172          *
 173          * @param resourceName
 174          *            The name of the resource
 175          * @return A {@link Reader} for the resource
 176          */
 177         private Reader createReader(String resourceName) {
 178                 try {
 179                         return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
 180                 } catch (UnsupportedEncodingException uee1) {
 181                         return null;
 182                 }
 183         }
 184
 185         /**
 186          * {@link LinkEnabledCallback} implementation that always returns
 187          * {@code true} when {@link LinkEnabledCallback#isEnabled(ToadletContext)}
 188          * is called.
 189          *
 190          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 191          */
 192         public class AlwaysEnabledCallback implements LinkEnabledCallback {
 193
 194                 /**
 195                  * {@inheritDoc}
 196                  */
 197                 @Override
 198                 public boolean isEnabled(ToadletContext toadletContext) {
 199                         return true;
 200                 }
 201         }
 202
 203 }