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 import java.util.UUID;
  23
  24 import net.pterodactylus.sone.data.Sone;
  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 getCurrentSession(toadletContenxt, true);
  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                 Session session = webInterface.getSessionManager().useSession(toadletContenxt);
 113                 if (create && (session == null)) {
 114                         session = webInterface.getSessionManager().createSession(UUID.randomUUID().toString(), toadletContenxt);
 115                 }
 116                 return session;
 117         }
 118
 119         /**
 120          * Returns the currently logged in Sone.
 121          *
 122          * @param toadletContext
 123          *            The toadlet context
 124          * @return The currently logged in Sone, or {@code null} if no Sone is
 125          *         currently logged in
 126          */
 127         protected Sone getCurrentSone(ToadletContext toadletContext) {
 128                 Session session = getCurrentSession(toadletContext);
 129                 if (session == null) {
 130                         return null;
 131                 }
 132                 String soneId = (String) session.getAttribute("Sone.CurrentSone");
 133                 if (soneId == null) {
 134                         return null;
 135                 }
 136                 return webInterface.getCore().getLocalSone(soneId, false);
 137         }
 138
 139         /**
 140          * Sets the currently logged in Sone.
 141          *
 142          * @param toadletContext
 143          *            The toadlet context
 144          * @param sone
 145          *            The Sone to set as currently logged in
 146          */
 147         protected void setCurrentSone(ToadletContext toadletContext, Sone sone) {
 148                 Session session = getCurrentSession(toadletContext);
 149                 if (sone == null) {
 150                         session.removeAttribute("Sone.CurrentSone");
 151                 } else {
 152                         session.setAttribute("Sone.CurrentSone", sone.getId());
 153                 }
 154         }
 155
 156         //
 157         // TEMPLATEPAGE METHODS
 158         //
 159
 160         /**
 161          * {@inheritDoc}
 162          */
 163         @Override
 164         protected Collection<String> getStyleSheets() {
 165                 return Arrays.asList("css/sone.css");
 166         }
 167
 168         /**
 169          * {@inheritDoc}
 170          */
 171         @Override
 172         protected String getShortcutIcon() {
 173                 return "images/icon.png";
 174         }
 175
 176         /**
 177          * Returns whether this page requires the user to log in.
 178          *
 179          * @return {@code true} if the user is required to be logged in to use this
 180          *         page, {@code false} otherwise
 181          */
 182         protected boolean requiresLogin() {
 183                 return requireLogin;
 184         }
 185
 186         /**
 187          * {@inheritDoc}
 188          */
 189         @Override
 190         protected void processTemplate(Request request, Template template) throws RedirectException {
 191                 super.processTemplate(request, template);
 192                 template.set("currentSone", getCurrentSone(request.getToadletContext()));
 193                 template.set("request", request);
 194         }
 195
 196         /**
 197          * {@inheritDoc}
 198          */
 199         @Override
 200         protected String getRedirectTarget(Page.Request request) {
 201                 if (requiresLogin() && (getCurrentSone(request.getToadletContext()) == null)) {
 202                         return "login.html";
 203                 }
 204                 return null;
 205         }
 206
 207         /**
 208          * {@inheritDoc}
 209          */
 210         @Override
 211         public boolean isEnabled(ToadletContext toadletContext) {
 212                 if (requiresLogin()) {
 213                         return getCurrentSone(toadletContext) != null;
 214                 }
 215                 return true;
 216         }
 217
 218 }