X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fweb%2Fpage%2FTemplatePage.java;h=e6ee539c5935b6c5c138731e8a812d6ca4d09e8a;hb=f4ea1e1b3526175e255831c975d6eea813589f25;hp=7e478e7250ca7fea451e971a0fbef6a18008a195;hpb=b2bc9337f91c303e2700f001c785e8b14a9990ec;p=Sone.git diff --git a/src/main/java/net/pterodactylus/sone/web/page/TemplatePage.java b/src/main/java/net/pterodactylus/sone/web/page/TemplatePage.java index 7e478e7..e6ee539 100644 --- a/src/main/java/net/pterodactylus/sone/web/page/TemplatePage.java +++ b/src/main/java/net/pterodactylus/sone/web/page/TemplatePage.java @@ -20,8 +20,14 @@ package net.pterodactylus.sone.web.page; import java.io.StringWriter; import java.util.Collection; import java.util.Collections; +import java.util.logging.Level; +import java.util.logging.Logger; +import net.pterodactylus.sone.web.page.Page.Request.Method; +import net.pterodactylus.util.logging.Logging; +import net.pterodactylus.util.template.DataProvider; import net.pterodactylus.util.template.Template; +import freenet.clients.http.LinkEnabledCallback; import freenet.clients.http.PageMaker; import freenet.clients.http.PageNode; import freenet.clients.http.ToadletContext; @@ -29,10 +35,13 @@ import freenet.l10n.BaseL10n; /** * Base class for all {@link Page}s that are rendered with {@link Template}s. - * + * * @author David ‘Bombe’ Roden */ -public class TemplatePage implements Page { +public class TemplatePage implements Page, LinkEnabledCallback { + + /** The logger. */ + private static final Logger logger = Logging.getLogger(TemplatePage.class); /** The path of the page. */ private final String path; @@ -46,9 +55,12 @@ public class TemplatePage implements Page { /** The l10n key for the page title. */ private final String pageTitleKey; + /** Where to redirect for invalid form passwords. */ + private final String invalidFormPasswordRedirectTarget; + /** * Creates a new template page. - * + * * @param path * The path of the page * @param template @@ -57,12 +69,16 @@ public class TemplatePage implements Page { * The L10n handler * @param pageTitleKey * The l10n key of the title page + * @param invalidFormPasswordRedirectTarget + * The target to redirect to if a POST request does not contain + * the correct form password */ - public TemplatePage(String path, Template template, BaseL10n l10n, String pageTitleKey) { + public TemplatePage(String path, Template template, BaseL10n l10n, String pageTitleKey, String invalidFormPasswordRedirectTarget) { this.path = path; this.template = template; this.l10n = l10n; this.pageTitleKey = pageTitleKey; + this.invalidFormPasswordRedirectTarget = invalidFormPasswordRedirectTarget; } /** @@ -84,24 +100,46 @@ public class TemplatePage implements Page { } ToadletContext toadletContext = request.getToadletContext(); + if (request.getMethod() == Method.POST) { + /* require form password. */ + String formPassword = request.getHttpRequest().getPartAsStringFailsafe("formPassword", 32); + if (!formPassword.equals(toadletContext.getContainer().getFormPassword())) { + return new RedirectResponse(invalidFormPasswordRedirectTarget); + } + } PageMaker pageMaker = toadletContext.getPageMaker(); PageNode pageNode = pageMaker.getPageNode(l10n.getString(pageTitleKey), toadletContext); for (String styleSheet : getStyleSheets()) { pageNode.addCustomStyleSheet(styleSheet); } + String shortcutIcon = getShortcutIcon(); + if (shortcutIcon != null) { + pageNode.addForwardLink("icon", shortcutIcon); + } + + DataProvider dataProvider = template.createDataProvider(); + try { + long start = System.nanoTime(); + processTemplate(request, dataProvider); + long finish = System.nanoTime(); + logger.log(Level.FINEST, "Template was rendered in " + ((finish - start) / 1000) / 1000.0 + "ms."); + } catch (RedirectException re1) { + return new RedirectResponse(re1.getTarget()); + } - processTemplate(request, template); StringWriter stringWriter = new StringWriter(); - template.render(stringWriter); + template.render(dataProvider, stringWriter); pageNode.content.addChild("%", stringWriter.toString()); + postProcess(request, dataProvider); + return new Response(200, "OK", "text/html", pageNode.outer.generate()); } /** * Can be overridden to return a custom set of style sheets that are to be * included in the page’s header. - * + * * @return Additional style sheets to load */ protected Collection getStyleSheets() { @@ -109,22 +147,50 @@ public class TemplatePage implements Page { } /** + * Returns the name of the shortcut icon to include in the page’s header. + * + * @return The URL of the shortcut icon, or {@code null} for no icon + */ + protected String getShortcutIcon() { + return null; + } + + /** * Can be overridden when extending classes need to set variables in the * template before it is rendered. - * + * * @param request * The request that is rendered - * @param template - * The template to set variables in + * @param dataProvider + * The data provider to set variables in + * @throws RedirectException + * if the processing page wants to redirect after processing */ - protected void processTemplate(Request request, Template template) { + protected void processTemplate(Request request, DataProvider dataProvider) throws RedirectException { + /* do nothing. */ + } + + /** + * This method will be called after + * {@link #processTemplate(net.pterodactylus.sone.web.page.Page.Request, DataProvider)} + * has processed the template and the template was rendered. This method + * will not be called if + * {@link #processTemplate(net.pterodactylus.sone.web.page.Page.Request, DataProvider)} + * throws a {@link RedirectException}! + * + * @param request + * The request being processed + * @param dataProvider + * The data provider that supplied the rendered data + */ + protected void postProcess(Request request, DataProvider dataProvider) { /* do nothing. */ } /** * Can be overridden to redirect the user to a different page, in case a log * in is required, or something else is wrong. - * + * * @param request * The request that is processed * @return The URL to redirect to, or {@code null} to not redirect @@ -133,4 +199,50 @@ public class TemplatePage implements Page { return null; } + // + // INTERFACE LinkEnabledCallback + // + + /** + * {@inheritDoc} + */ + @Override + public boolean isEnabled(ToadletContext toadletContext) { + return true; + } + + /** + * Exception that can be thrown to signal that a subclassed {@link Page} + * wants to redirect the user during the + * {@link TemplatePage#processTemplate(net.pterodactylus.sone.web.page.Page.Request, DataProvider)} + * method call. + * + * @author David ‘Bombe’ Roden + */ + public class RedirectException extends Exception { + + /** The target to redirect to. */ + private final String target; + + /** + * Creates a new redirect exception. + * + * @param target + * The target of the redirect + */ + public RedirectException(String target) { + this.target = target; + } + + /** + * Returns the target to redirect to. + * + * @return The target to redirect to + */ + public String getTarget() { + return target; + } + + } + }