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 freenet.clients.http.LinkEnabledCallback;
import freenet.clients.http.PageMaker;
/**
* Base class for all {@link Page}s that are rendered with {@link Template}s.
- *
+ *
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
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. */
- private final Template template;
+ protected final Template template;
/** The L10n handler. */
private final BaseL10n l10n;
/** 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
* 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;
}
/**
}
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);
+ }
+
+ try {
+ long start = System.nanoTime();
+ processTemplate(request, template);
+ 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());
+ }
+
+ postProcess(request, template);
- processTemplate(request, template);
StringWriter stringWriter = new StringWriter();
template.render(stringWriter);
pageNode.content.addChild("%", stringWriter.toString());
/**
* 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() {
}
/**
+ * 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
+ * @throws RedirectException
+ * if the processing page wants to redirect after processing
+ */
+ protected void processTemplate(Request request, Template template) throws RedirectException {
+ /* do nothing. */
+ }
+
+ /**
+ * This method will be called after
+ * {@link #processTemplate(net.pterodactylus.sone.web.page.Page.Request, Template)}
+ * 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, Template)}
+ * throws a {@link RedirectException}!
+ *
+ * @param request
+ * The request being processed
+ * @param template
+ * The template that was rendered
*/
- protected void processTemplate(Request request, Template template) {
+ protected void postProcess(Request request, Template template) {
/* 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
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, Template)}
+ * method call.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+ 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;
+ }
+
+ }
+
}