src/main/java/net/pterodactylus/sone/web/page/TemplatePage.java

   1 /*
   2  * shortener - TemplatePage.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.page;
  19
  20 import java.io.StringWriter;
  21 import java.util.Collection;
  22 import java.util.Collections;
  23
  24 import net.pterodactylus.util.template.Template;
  25 import freenet.clients.http.LinkEnabledCallback;
  26 import freenet.clients.http.PageMaker;
  27 import freenet.clients.http.PageNode;
  28 import freenet.clients.http.ToadletContext;
  29 import freenet.l10n.BaseL10n;
  30
  31 /**
  32  * Base class for all {@link Page}s that are rendered with {@link Template}s.
  33  *
  34  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  35  */
  36 public class TemplatePage implements Page, LinkEnabledCallback {
  37
  38         /** The path of the page. */
  39         private final String path;
  40
  41         /** The template to render. */
  42         private final Template template;
  43
  44         /** The L10n handler. */
  45         private final BaseL10n l10n;
  46
  47         /** The l10n key for the page title. */
  48         private final String pageTitleKey;
  49
  50         /**
  51          * Creates a new template page.
  52          *
  53          * @param path
  54          *            The path of the page
  55          * @param template
  56          *            The template to render
  57          * @param l10n
  58          *            The L10n handler
  59          * @param pageTitleKey
  60          *            The l10n key of the title page
  61          */
  62         public TemplatePage(String path, Template template, BaseL10n l10n, String pageTitleKey) {
  63                 this.path = path;
  64                 this.template = template;
  65                 this.l10n = l10n;
  66                 this.pageTitleKey = pageTitleKey;
  67         }
  68
  69         /**
  70          * {@inheritDoc}
  71          */
  72         @Override
  73         public String getPath() {
  74                 return path;
  75         }
  76
  77         /**
  78          * {@inheritDoc}
  79          */
  80         @Override
  81         public Response handleRequest(Request request) {
  82                 String redirectTarget = getRedirectTarget(request);
  83                 if (redirectTarget != null) {
  84                         return new RedirectResponse(redirectTarget);
  85                 }
  86
  87                 ToadletContext toadletContext = request.getToadletContext();
  88                 PageMaker pageMaker = toadletContext.getPageMaker();
  89                 PageNode pageNode = pageMaker.getPageNode(l10n.getString(pageTitleKey), toadletContext);
  90                 for (String styleSheet : getStyleSheets()) {
  91                         pageNode.addCustomStyleSheet(styleSheet);
  92                 }
  93
  94                 try {
  95                         processTemplate(request, template);
  96                 } catch (RedirectException re1) {
  97                         return new RedirectResponse(re1.getTarget());
  98                 }
  99
 100                 StringWriter stringWriter = new StringWriter();
 101                 template.render(stringWriter);
 102                 pageNode.content.addChild("%", stringWriter.toString());
 103
 104                 return new Response(200, "OK", "text/html", pageNode.outer.generate());
 105         }
 106
 107         /**
 108          * Can be overridden to return a custom set of style sheets that are to be
 109          * included in the page’s header.
 110          *
 111          * @return Additional style sheets to load
 112          */
 113         protected Collection<String> getStyleSheets() {
 114                 return Collections.emptySet();
 115         }
 116
 117         /**
 118          * Can be overridden when extending classes need to set variables in the
 119          * template before it is rendered.
 120          *
 121          * @param request
 122          *            The request that is rendered
 123          * @param template
 124          *            The template to set variables in
 125          * @throws RedirectException
 126          *             if the processing page wants to redirect after processing
 127          */
 128         protected void processTemplate(Request request, Template template) throws RedirectException {
 129                 /* do nothing. */
 130         }
 131
 132         /**
 133          * Can be overridden to redirect the user to a different page, in case a log
 134          * in is required, or something else is wrong.
 135          *
 136          * @param request
 137          *            The request that is processed
 138          * @return The URL to redirect to, or {@code null} to not redirect
 139          */
 140         protected String getRedirectTarget(Page.Request request) {
 141                 return null;
 142         }
 143
 144         //
 145         // INTERFACE LinkEnabledCallback
 146         //
 147
 148         /**
 149          * {@inheritDoc}
 150          */
 151         @Override
 152         public boolean isEnabled(ToadletContext toadletContext) {
 153                 return true;
 154         }
 155
 156         /**
 157          * Exception that can be thrown to signal that a subclassed {@link Page}
 158          * wants to redirect the user during the
 159          * {@link TemplatePage#processTemplate(net.pterodactylus.sone.web.page.Page.Request, Template)}
 160          * method call.
 161          *
 162          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 163          */
 164         public class RedirectException extends Exception {
 165
 166                 /** The target to redirect to. */
 167                 private final String target;
 168
 169                 /**
 170                  * Creates a new redirect exception.
 171                  *
 172                  * @param target
 173                  *            The target of the redirect
 174                  */
 175                 public RedirectException(String target) {
 176                         this.target = target;
 177                 }
 178
 179                 /**
 180                  * Returns the target to redirect to.
 181                  *
 182                  * @return The target to redirect to
 183                  */
 184                 public String getTarget() {
 185                         return target;
 186                 }
 187
 188         }
 189
 190 }