/*
- * shortener - TemplatePage.java - Copyright © 2010 David Roden
+ * Sone - StaticTemplatePage.java - Copyright © 2011 David Roden
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
package net.pterodactylus.sone.web.page;
-import java.io.StringWriter;
-import java.util.Collection;
-import java.util.Collections;
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.OutputStreamWriter;
import java.util.logging.Level;
import java.util.logging.Logger;
-import net.pterodactylus.sone.web.page.Page.Request.Method;
+import net.pterodactylus.util.io.Closer;
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;
/**
- * Base class for all {@link Page}s that are rendered with {@link Template}s.
+ * A template page is a single page that is created from a {@link Template} but
+ * does not necessarily return HTML.
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
-public class TemplatePage implements Page, LinkEnabledCallback {
+public class TemplatePage implements Page {
/** The logger. */
private static final Logger logger = Logging.getLogger(TemplatePage.class);
- /** The path of the page. */
+ /** The path of this page. */
private final String path;
+ /** The content type of this page. */
+ private final String contentType;
+
/** The template context factory. */
private final TemplateContextFactory templateContextFactory;
/** The template to render. */
private final Template template;
- /** Where to redirect for invalid form passwords. */
- private final String invalidFormPasswordRedirectTarget;
-
/**
* Creates a new template page.
*
* @param path
* The path of the page
+ * @param contentType
+ * The content type of the page
* @param templateContextFactory
* The template context factory
* @param template
* The template to render
- * @param invalidFormPasswordRedirectTarget
- * The target to redirect to if a POST request does not contain
- * the correct form password
*/
- public TemplatePage(String path, TemplateContextFactory templateContextFactory, Template template, String invalidFormPasswordRedirectTarget) {
+ public TemplatePage(String path, String contentType, TemplateContextFactory templateContextFactory, Template template) {
this.path = path;
+ this.contentType = contentType;
this.templateContextFactory = templateContextFactory;
this.template = template;
- this.invalidFormPasswordRedirectTarget = invalidFormPasswordRedirectTarget;
}
/**
}
/**
- * 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
public Response handleRequest(Request request) {
- String redirectTarget = getRedirectTarget(request);
- if (redirectTarget != null) {
- return new RedirectResponse(redirectTarget);
- }
-
- 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(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());
+ ByteArrayOutputStream responseOutputStream = new ByteArrayOutputStream();
+ OutputStreamWriter responseWriter = null;
try {
- 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());
+ responseWriter = new OutputStreamWriter(responseOutputStream, "UTF-8");
+ TemplateContext templateContext = templateContextFactory.createTemplateContext();
+ templateContext.set("request", request);
+ template.render(templateContext, responseWriter);
+ } catch (IOException ioe1) {
+ logger.log(Level.WARNING, "Could not render template for path “" + path + "”!", ioe1);
+ } finally {
+ Closer.close(responseWriter);
+ Closer.close(responseOutputStream);
}
-
- StringWriter stringWriter = new StringWriter();
- template.render(templateContext, stringWriter);
- pageNode.content.addChild("%", stringWriter.toString());
-
- postProcess(request, templateContext);
-
- 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<String> getStyleSheets() {
- return Collections.emptySet();
- }
-
- /**
- * 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 templateContext
- * The template context to set variables in
- * @throws RedirectException
- * if the processing page wants to redirect after processing
- */
- 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. */
- }
-
- /**
- * 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
- */
- protected String getRedirectTarget(Page.Request request) {
- 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, TemplateContext)}
- * method call.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
- */
- public static 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;
- }
-
+ ByteArrayInputStream responseInputStream = new ByteArrayInputStream(responseOutputStream.toByteArray());
+ /* no need to close a ByteArrayInputStream. */
+ return new Response(200, "OK", contentType, null, responseInputStream);
}
}