/*
- * Sone - FreenetTemplatePage.java - Copyright © 2010 David Roden
+ * Sone - FreenetTemplatePage.java - Copyright © 2010–2019 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 static java.lang.String.format;
+import static java.util.logging.Logger.getLogger;
+
+import java.io.IOException;
import java.io.StringWriter;
+import java.net.URI;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
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.sone.main.Loaders;
import net.pterodactylus.util.template.Template;
import net.pterodactylus.util.template.TemplateContext;
import net.pterodactylus.util.template.TemplateContextFactory;
+import net.pterodactylus.util.web.Method;
+import net.pterodactylus.util.web.Page;
+import net.pterodactylus.util.web.RedirectResponse;
+import net.pterodactylus.util.web.Response;
import freenet.clients.http.LinkEnabledCallback;
import freenet.clients.http.PageMaker;
import freenet.clients.http.PageNode;
/**
* Base class for all {@link Page}s that are rendered with {@link Template}s and
* fit into Freenet’s web interface.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
-public class FreenetTemplatePage implements Page, LinkEnabledCallback {
+public class FreenetTemplatePage implements FreenetPage, LinkEnabledCallback {
/** The logger. */
- private static final Logger logger = Logging.getLogger(FreenetTemplatePage.class);
+ private static final Logger logger = getLogger(FreenetTemplatePage.class.getName());
/** The path of the page. */
private final String path;
/** The template to render. */
private final Template template;
+ private final Loaders loaders;
/** 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 invalidFormPasswordRedirectTarget
- * The target to redirect to if a POST request does not contain
- * the correct form password
- */
- public FreenetTemplatePage(String path, TemplateContextFactory templateContextFactory, Template template, String invalidFormPasswordRedirectTarget) {
+ public FreenetTemplatePage(String path, TemplateContextFactory templateContextFactory, Loaders loaders, Template template, String invalidFormPasswordRedirectTarget) {
this.path = path;
this.templateContextFactory = templateContextFactory;
+ this.loaders = loaders;
this.template = template;
this.invalidFormPasswordRedirectTarget = invalidFormPasswordRedirectTarget;
}
* The request to serve
* @return The title of the page
*/
- protected String getPageTitle(Request request) {
+ @SuppressWarnings("static-method")
+ protected String getPageTitle(FreenetRequest request) {
return null;
}
* {@inheritDoc}
*/
@Override
- public Response handleRequest(Request request) {
+ public boolean isPrefixPage() {
+ return false;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public final Response handleRequest(FreenetRequest request, Response response) throws IOException {
String redirectTarget = getRedirectTarget(request);
if (redirectTarget != null) {
return new RedirectResponse(redirectTarget);
}
+ if (isFullAccessOnly() && !request.getToadletContext().isAllowedFullAccess()) {
+ return response.setStatusCode(401).setStatusText("Not authorized").setContentType("text/html");
+ }
ToadletContext toadletContext = request.getToadletContext();
if (request.getMethod() == Method.POST) {
/* require form password. */
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.");
+ logger.log(Level.FINEST, format("Template was rendered in %.2fms.", (finish - start) / 1000000.0));
} catch (RedirectException re1) {
return new RedirectResponse(re1.getTarget());
}
postProcess(request, templateContext);
- return new Response(200, "OK", "text/html", pageNode.outer.generate());
+ return response.setStatusCode(200).setStatusText("OK").setContentType("text/html").write(pageNode.outer.generate());
}
/**
*
* @return Additional style sheets to load
*/
+ @SuppressWarnings("static-method")
protected Collection<String> getStyleSheets() {
return Collections.emptySet();
}
*
* @return The URL of the shortcut icon, or {@code null} for no icon
*/
+ @SuppressWarnings("static-method")
protected String getShortcutIcon() {
return null;
}
* @throws RedirectException
* if the processing page wants to redirect after processing
*/
- protected void processTemplate(Request request, TemplateContext templateContext) throws RedirectException {
+ protected void processTemplate(FreenetRequest 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)}
+ * {@link #processTemplate(FreenetRequest, TemplateContext)} has processed
+ * the template and the template was rendered. This method will not be
+ * called if {@link #processTemplate(FreenetRequest, TemplateContext)}
* throws a {@link RedirectException}!
*
* @param request
* @param templateContext
* The template context that supplied the rendered data
*/
- protected void postProcess(Request request, TemplateContext templateContext) {
+ protected void postProcess(FreenetRequest request, TemplateContext templateContext) {
/* do nothing. */
}
* The request that is processed
* @return The URL to redirect to, or {@code null} to not redirect
*/
- protected String getRedirectTarget(Page.Request request) {
+ @SuppressWarnings("static-method")
+ protected String getRedirectTarget(FreenetRequest request) {
return null;
}
* The request for which to return the link nodes
* @return All link nodes that should be added to the HTML head
*/
- protected List<Map<String, String>> getAdditionalLinkNodes(Request request) {
+ @SuppressWarnings("static-method")
+ protected List<Map<String, String>> getAdditionalLinkNodes(FreenetRequest request) {
return Collections.emptyList();
}
+ /**
+ * Returns whether this page should only be allowed for requests from hosts
+ * with full access.
+ *
+ * @return {@code true} if this page should only be allowed for hosts with
+ * full access, {@code false} to allow this page for any host
+ */
+ @SuppressWarnings("static-method")
+ protected boolean isFullAccessOnly() {
+ return false;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public boolean isLinkExcepted(URI link) {
+ return false;
+ }
+
//
// INTERFACE LinkEnabledCallback
//
*/
@Override
public boolean isEnabled(ToadletContext toadletContext) {
- return true;
+ return !isFullAccessOnly();
}
/**
* Exception that can be thrown to signal that a subclassed {@link Page}
* wants to redirect the user during the
- * {@link FreenetTemplatePage#processTemplate(net.pterodactylus.sone.web.page.Page.Request, TemplateContext)}
+ * {@link FreenetTemplatePage#processTemplate(FreenetRequest, TemplateContext)}
* method call.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public static class RedirectException extends Exception {
return target;
}
+ @Override
+ public String toString() {
+ return format("RedirectException{target='%s'}", target);
+ }
+
}
}
projects / Sone.git / blobdiff