X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fweb%2Fpage%2FTemplatePage.java;h=a6636e257c6410cee09fbbe2825f5203c615ac61;hb=d94313422b920eb75f8d5a7db90099e23c7a63e0;hp=e483aa3390f0e9bec08713322e0cccd881dbb586;hpb=d81f7f8bb8c1721ae003dfbf5fe79105ec0e9a90;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 e483aa3..a6636e2 100644 --- a/src/main/java/net/pterodactylus/sone/web/page/TemplatePage.java +++ b/src/main/java/net/pterodactylus/sone/web/page/TemplatePage.java @@ -20,13 +20,18 @@ 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.Template; +import net.pterodactylus.util.template.TemplateContext; +import net.pterodactylus.util.template.TemplateContextFactory; import freenet.clients.http.LinkEnabledCallback; import freenet.clients.http.PageMaker; import freenet.clients.http.PageNode; import freenet.clients.http.ToadletContext; -import freenet.l10n.BaseL10n; /** * Base class for all {@link Page}s that are rendered with {@link Template}s. @@ -35,35 +40,39 @@ import freenet.l10n.BaseL10n; */ 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; - /** The template to render. */ - protected final Template template; + /** The template context factory. */ + private final TemplateContextFactory templateContextFactory; - /** The L10n handler. */ - private final BaseL10n l10n; + /** The template to render. */ + private final Template template; - /** 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 templateContextFactory + * The template context factory * @param template * The template to render - * @param l10n - * 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, TemplateContextFactory templateContextFactory, Template template, String invalidFormPasswordRedirectTarget) { this.path = path; + this.templateContextFactory = templateContextFactory; this.template = template; - this.l10n = l10n; - this.pageTitleKey = pageTitleKey; + this.invalidFormPasswordRedirectTarget = invalidFormPasswordRedirectTarget; } /** @@ -75,6 +84,17 @@ public class TemplatePage implements Page, LinkEnabledCallback { } /** + * Returns the title of the page. + * + * @param request + * The request to serve + * @return The title of the page + */ + protected String getPageTitle(Request request) { + return null; + } + + /** * {@inheritDoc} */ @Override @@ -85,22 +105,40 @@ public class TemplatePage implements Page, LinkEnabledCallback { } 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); + PageNode pageNode = pageMaker.getPageNode(getPageTitle(request), toadletContext); for (String styleSheet : getStyleSheets()) { pageNode.addCustomStyleSheet(styleSheet); } + String shortcutIcon = getShortcutIcon(); + if (shortcutIcon != null) { + pageNode.addForwardLink("icon", shortcutIcon); + } + TemplateContext templateContext = templateContextFactory.createTemplateContext(); + templateContext.mergeContext(template.getInitialContext()); try { - processTemplate(request, template); + long start = System.nanoTime(); + processTemplate(request, templateContext); + 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()); } StringWriter stringWriter = new StringWriter(); - template.render(stringWriter); + template.render(templateContext, stringWriter); pageNode.content.addChild("%", stringWriter.toString()); + postProcess(request, templateContext); + return new Response(200, "OK", "text/html", pageNode.outer.generate()); } @@ -115,17 +153,43 @@ public class TemplatePage implements Page, LinkEnabledCallback { } /** + * 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 templateContext + * The template context to set variables in * @throws RedirectException * if the processing page wants to redirect after processing */ - protected void processTemplate(Request request, Template template) throws RedirectException { + protected void processTemplate(Request request, TemplateContext templateContext) throws RedirectException { + /* do nothing. */ + } + + /** + * This method will be called after + * {@link #processTemplate(net.pterodactylus.sone.web.page.Page.Request, TemplateContext)} + * 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, TemplateContext)} + * throws a {@link RedirectException}! + * + * @param request + * The request being processed + * @param templateContext + * The template context that supplied the rendered data + */ + protected void postProcess(Request request, TemplateContext templateContext) { /* do nothing. */ } @@ -156,12 +220,12 @@ public class TemplatePage implements Page, LinkEnabledCallback { /** * 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, Template)} + * {@link TemplatePage#processTemplate(net.pterodactylus.sone.web.page.Page.Request, TemplateContext)} * method call. * * @author David ‘Bombe’ Roden */ - public class RedirectException extends Exception { + public static class RedirectException extends Exception { /** The target to redirect to. */ private final String target;