src/main/java/net/pterodactylus/sone/web/SoneTemplatePage.java

   1 /*
   2  * Freetalk - FreetalkTemplatePage.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.util.Arrays;
  21 import java.util.Collection;
  22
  23 import net.pterodactylus.sone.data.Sone;
  24 import net.pterodactylus.sone.main.SonePlugin;
  25 import net.pterodactylus.sone.web.page.Page;
  26 import net.pterodactylus.sone.web.page.TemplatePage;
  27 import net.pterodactylus.util.template.Template;
  28 import freenet.clients.http.SessionManager.Session;
  29 import freenet.clients.http.ToadletContext;
  30
  31 /**
  32  * Base page for the Freetalk web interface.
  33  *
  34  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  35  */
  36 public class SoneTemplatePage extends TemplatePage {
  37
  38         /** The Sone core. */
  39         protected final WebInterface webInterface;
  40
  41         /** Whether to require a login. */
  42         private final boolean requireLogin;
  43
  44         /**
  45          * Creates a new template page for Freetalk that does not require the user
  46          * to be logged in.
  47          *
  48          * @param path
  49          *            The path of the page
  50          * @param template
  51          *            The template to render
  52          * @param pageTitleKey
  53          *            The l10n key of the page title
  54          * @param webInterface
  55          *            The Sone web interface
  56          */
  57         public SoneTemplatePage(String path, Template template, String pageTitleKey, WebInterface webInterface) {
  58                 this(path, template, pageTitleKey, webInterface, false);
  59         }
  60
  61         /**
  62          * Creates a new template page for Freetalk.
  63          *
  64          * @param path
  65          *            The path of the page
  66          * @param template
  67          *            The template to render
  68          * @param pageTitleKey
  69          *            The l10n key of the page title
  70          * @param webInterface
  71          *            The Sone web interface
  72          * @param requireLogin
  73          *            Whether this page requires a login
  74          */
  75         public SoneTemplatePage(String path, Template template, String pageTitleKey, WebInterface webInterface, boolean requireLogin) {
  76                 super(path, template, webInterface.getL10n(), pageTitleKey, "noPermission.html");
  77                 this.webInterface = webInterface;
  78                 this.requireLogin = requireLogin;
  79                 template.set("webInterface", webInterface);
  80         }
  81
  82         //
  83         // PROTECTED METHODS
  84         //
  85
  86         /**
  87          * Returns the current session, creating a new session if there is no
  88          * current session.
  89          *
  90          * @param toadletContenxt
  91          *            The toadlet context
  92          * @return The current session, or {@code null} if there is no current
  93          *         session
  94          */
  95         protected Session getCurrentSession(ToadletContext toadletContenxt) {
  96                 return webInterface.getCurrentSession(toadletContenxt);
  97         }
  98
  99         /**
 100          * Returns the current session, creating a new session if there is no
 101          * current session and {@code create} is {@code true}.
 102          *
 103          * @param toadletContenxt
 104          *            The toadlet context
 105          * @param create
 106          *            {@code true} to create a new session if there is no current
 107          *            session, {@code false} otherwise
 108          * @return The current session, or {@code null} if there is no current
 109          *         session
 110          */
 111         protected Session getCurrentSession(ToadletContext toadletContenxt, boolean create) {
 112                 return webInterface.getCurrentSession(toadletContenxt, create);
 113         }
 114
 115         /**
 116          * Returns the currently logged in Sone.
 117          *
 118          * @param toadletContext
 119          *            The toadlet context
 120          * @return The currently logged in Sone, or {@code null} if no Sone is
 121          *         currently logged in
 122          */
 123         protected Sone getCurrentSone(ToadletContext toadletContext) {
 124                 return webInterface.getCurrentSone(toadletContext);
 125         }
 126
 127         /**
 128          * Returns the currently logged in Sone.
 129          *
 130          * @param toadletContext
 131          *            The toadlet context
 132          * @param create
 133          *            {@code true} to create a new session if no session exists,
 134          *            {@code false} to not create a new session
 135          * @return The currently logged in Sone, or {@code null} if no Sone is
 136          *         currently logged in
 137          */
 138         protected Sone getCurrentSone(ToadletContext toadletContext, boolean create) {
 139                 return webInterface.getCurrentSone(toadletContext, create);
 140         }
 141
 142         /**
 143          * Sets the currently logged in Sone.
 144          *
 145          * @param toadletContext
 146          *            The toadlet context
 147          * @param sone
 148          *            The Sone to set as currently logged in
 149          */
 150         protected void setCurrentSone(ToadletContext toadletContext, Sone sone) {
 151                 webInterface.setCurrentSone(toadletContext, sone);
 152         }
 153
 154         //
 155         // TEMPLATEPAGE METHODS
 156         //
 157
 158         /**
 159          * {@inheritDoc}
 160          */
 161         @Override
 162         protected Collection<String> getStyleSheets() {
 163                 return Arrays.asList("css/sone.css");
 164         }
 165
 166         /**
 167          * {@inheritDoc}
 168          */
 169         @Override
 170         protected String getShortcutIcon() {
 171                 return "images/icon.png";
 172         }
 173
 174         /**
 175          * Returns whether this page requires the user to log in.
 176          *
 177          * @return {@code true} if the user is required to be logged in to use this
 178          *         page, {@code false} otherwise
 179          */
 180         protected boolean requiresLogin() {
 181                 return requireLogin;
 182         }
 183
 184         /**
 185          * {@inheritDoc}
 186          */
 187         @Override
 188         protected void processTemplate(Request request, Template template) throws RedirectException {
 189                 super.processTemplate(request, template);
 190                 template.set("currentSone", getCurrentSone(request.getToadletContext(), false));
 191                 template.set("request", request);
 192                 template.set("currentVersion", SonePlugin.VERSION);
 193                 template.set("hasLatestVersion", webInterface.getCore().getUpdateChecker().hasLatestVersion());
 194                 template.set("latestVersion", webInterface.getCore().getUpdateChecker().getLatestVersion());
 195                 template.set("latestVersionTime", webInterface.getCore().getUpdateChecker().getLatestVersionDate());
 196         }
 197
 198         /**
 199          * {@inheritDoc}
 200          */
 201         @Override
 202         protected String getRedirectTarget(Page.Request request) {
 203                 if (requiresLogin() && (getCurrentSone(request.getToadletContext(), false) == null)) {
 204                         return "login.html";
 205                 }
 206                 return null;
 207         }
 208
 209         /**
 210          * {@inheritDoc}
 211          */
 212         @Override
 213         public boolean isEnabled(ToadletContext toadletContext) {
 214                 if (requiresLogin()) {
 215                         return getCurrentSone(toadletContext, false) != null;
 216                 }
 217                 return true;
 218         }
 219
 220 }