🚚 Rename file containing annotations
[Sone.git] / src / main / java / net / pterodactylus / sone / web / page / FreenetTemplatePage.java
index e7d6e28..c4b1813 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * 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
@@ -17,6 +17,9 @@
 
 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;
@@ -28,7 +31,7 @@ import java.util.Map.Entry;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-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;
@@ -45,13 +48,11 @@ import freenet.support.HTMLNode;
 /**
  * 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 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;
@@ -61,26 +62,15 @@ public class FreenetTemplatePage implements FreenetPage, LinkEnabledCallback {
 
        /** 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;
        }
@@ -100,6 +90,7 @@ public class FreenetTemplatePage implements FreenetPage, LinkEnabledCallback {
         *            The request to serve
         * @return The title of the page
         */
+       @SuppressWarnings("static-method")
        protected String getPageTitle(FreenetRequest request) {
                return null;
        }
@@ -116,7 +107,7 @@ public class FreenetTemplatePage implements FreenetPage, LinkEnabledCallback {
         * {@inheritDoc}
         */
        @Override
-       public Response handleRequest(FreenetRequest request, Response response) throws IOException {
+       public final Response handleRequest(FreenetRequest request, Response response) throws IOException {
                String redirectTarget = getRedirectTarget(request);
                if (redirectTarget != null) {
                        return new RedirectResponse(redirectTarget);
@@ -155,7 +146,7 @@ public class FreenetTemplatePage implements FreenetPage, LinkEnabledCallback {
                        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());
                }
@@ -175,6 +166,7 @@ public class FreenetTemplatePage implements FreenetPage, LinkEnabledCallback {
         *
         * @return Additional style sheets to load
         */
+       @SuppressWarnings("static-method")
        protected Collection<String> getStyleSheets() {
                return Collections.emptySet();
        }
@@ -184,6 +176,7 @@ public class FreenetTemplatePage implements FreenetPage, LinkEnabledCallback {
         *
         * @return The URL of the shortcut icon, or {@code null} for no icon
         */
+       @SuppressWarnings("static-method")
        protected String getShortcutIcon() {
                return null;
        }
@@ -227,6 +220,7 @@ public class FreenetTemplatePage implements FreenetPage, LinkEnabledCallback {
         *            The request that is processed
         * @return The URL to redirect to, or {@code null} to not redirect
         */
+       @SuppressWarnings("static-method")
        protected String getRedirectTarget(FreenetRequest request) {
                return null;
        }
@@ -238,6 +232,7 @@ public class FreenetTemplatePage implements FreenetPage, LinkEnabledCallback {
         *            The request for which to return the link nodes
         * @return All link nodes that should be added to the HTML head
         */
+       @SuppressWarnings("static-method")
        protected List<Map<String, String>> getAdditionalLinkNodes(FreenetRequest request) {
                return Collections.emptyList();
        }
@@ -249,6 +244,7 @@ public class FreenetTemplatePage implements FreenetPage, LinkEnabledCallback {
         * @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;
        }
@@ -278,8 +274,6 @@ public class FreenetTemplatePage implements FreenetPage, LinkEnabledCallback {
         * wants to redirect the user during the
         * {@link FreenetTemplatePage#processTemplate(FreenetRequest, TemplateContext)}
         * method call.
-        *
-        * @author <a href="mailto:bombe@pterodactylus.net">David â€˜Bombe’ Roden</a>
         */
        public static class RedirectException extends Exception {
 
@@ -305,6 +299,11 @@ public class FreenetTemplatePage implements FreenetPage, LinkEnabledCallback {
                        return target;
                }
 
+               @Override
+               public String toString() {
+                       return format("RedirectException{target='%s'}", target);
+               }
+
        }
 
 }