Fix ALL the logging!
[Sone.git] / src / main / java / net / pterodactylus / sone / web / SoneTemplatePage.java
index 2b697ce..b0d31d2 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Freetalk - FreetalkTemplatePage.java - Copyright © 2010 David Roden
+ * Sone - SoneTemplatePage.java - Copyright © 2010 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;
 
+import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
 
 import net.pterodactylus.sone.data.Sone;
-import net.pterodactylus.sone.web.page.Page;
-import net.pterodactylus.sone.web.page.TemplatePage;
+import net.pterodactylus.sone.main.SonePlugin;
+import net.pterodactylus.sone.notify.ListNotificationFilters;
+import net.pterodactylus.sone.web.page.FreenetRequest;
+import net.pterodactylus.sone.web.page.FreenetTemplatePage;
+import net.pterodactylus.util.collection.ListBuilder;
+import net.pterodactylus.util.collection.MapBuilder;
+import net.pterodactylus.util.notify.Notification;
+import net.pterodactylus.util.object.HashCode;
 import net.pterodactylus.util.template.Template;
-import freenet.clients.http.RedirectException;
+import net.pterodactylus.util.template.TemplateContext;
 import freenet.clients.http.SessionManager.Session;
+import freenet.clients.http.ToadletContext;
+import freenet.support.api.HTTPRequest;
 
 /**
- * Base page for the Freetalk web interface.
+ * Base page for the Sone web interface.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class SoneTemplatePage extends TemplatePage {
+public class SoneTemplatePage extends FreenetTemplatePage {
 
        /** The Sone core. */
        protected final WebInterface webInterface;
 
+       /** The page title l10n key. */
+       private final String pageTitleKey;
+
+       /** Whether to require a login. */
+       private final boolean requireLogin;
+
+       /**
+        * Creates a new template page for Sone that does not require the user to be
+        * logged in.
+        *
+        * @param path
+        *            The path of the page
+        * @param template
+        *            The template to render
+        * @param webInterface
+        *            The Sone web interface
+        */
+       public SoneTemplatePage(String path, Template template, WebInterface webInterface) {
+               this(path, template, null, webInterface, false);
+       }
+
        /**
-        * Creates a new template page for Freetalk.
+        * Creates a new template page for Sone that does not require the user to be
+        * logged in.
         *
         * @param path
         *            The path of the page
@@ -50,9 +85,44 @@ public class SoneTemplatePage extends TemplatePage {
         *            The Sone web interface
         */
        public SoneTemplatePage(String path, Template template, String pageTitleKey, WebInterface webInterface) {
-               super(path, template, webInterface.l10n(), pageTitleKey);
+               this(path, template, pageTitleKey, webInterface, false);
+       }
+
+       /**
+        * Creates a new template page for Sone.
+        *
+        * @param path
+        *            The path of the page
+        * @param template
+        *            The template to render
+        * @param webInterface
+        *            The Sone web interface
+        * @param requireLogin
+        *            Whether this page requires a login
+        */
+       public SoneTemplatePage(String path, Template template, WebInterface webInterface, boolean requireLogin) {
+               this(path, template, null, webInterface, requireLogin);
+       }
+
+       /**
+        * Creates a new template page for Sone.
+        *
+        * @param path
+        *            The path of the page
+        * @param template
+        *            The template to render
+        * @param pageTitleKey
+        *            The l10n key of the page title
+        * @param webInterface
+        *            The Sone web interface
+        * @param requireLogin
+        *            Whether this page requires a login
+        */
+       public SoneTemplatePage(String path, Template template, String pageTitleKey, WebInterface webInterface, boolean requireLogin) {
+               super(path, webInterface.getTemplateContextFactory(), template, "noPermission.html");
+               this.pageTitleKey = pageTitleKey;
                this.webInterface = webInterface;
-               template.set("webInterface", webInterface);
+               this.requireLogin = requireLogin;
        }
 
        //
@@ -60,24 +130,71 @@ public class SoneTemplatePage extends TemplatePage {
        //
 
        /**
+        * Returns the current session, creating a new session if there is no
+        * current session.
+        *
+        * @param toadletContenxt
+        *            The toadlet context
+        * @return The current session, or {@code null} if there is no current
+        *         session
+        */
+       protected Session getCurrentSession(ToadletContext toadletContenxt) {
+               return webInterface.getCurrentSession(toadletContenxt);
+       }
+
+       /**
+        * Returns the current session, creating a new session if there is no
+        * current session and {@code create} is {@code true}.
+        *
+        * @param toadletContenxt
+        *            The toadlet context
+        * @param create
+        *            {@code true} to create a new session if there is no current
+        *            session, {@code false} otherwise
+        * @return The current session, or {@code null} if there is no current
+        *         session
+        */
+       protected Session getCurrentSession(ToadletContext toadletContenxt, boolean create) {
+               return webInterface.getCurrentSession(toadletContenxt, create);
+       }
+
+       /**
         * Returns the currently logged in Sone.
         *
-        * @param request
-        *            The request to extract the session information from
+        * @param toadletContext
+        *            The toadlet context
         * @return The currently logged in Sone, or {@code null} if no Sone is
         *         currently logged in
         */
-       protected Sone getCurrentSone(Request request) {
-               try {
-                       Session session = webInterface.sessionManager().useSession(request.getToadletContext());
-                       if (session == null) {
-                               return null;
-                       }
-                       return (Sone) session.getAttribute("Sone.CurrentSone");
-               } catch (RedirectException re1) {
-                       /* okay, no current session, return null. */
-                       return null;
-               }
+       protected Sone getCurrentSone(ToadletContext toadletContext) {
+               return webInterface.getCurrentSone(toadletContext);
+       }
+
+       /**
+        * Returns the currently logged in Sone.
+        *
+        * @param toadletContext
+        *            The toadlet context
+        * @param create
+        *            {@code true} to create a new session if no session exists,
+        *            {@code false} to not create a new session
+        * @return The currently logged in Sone, or {@code null} if no Sone is
+        *         currently logged in
+        */
+       protected Sone getCurrentSone(ToadletContext toadletContext, boolean create) {
+               return webInterface.getCurrentSone(toadletContext, create);
+       }
+
+       /**
+        * Sets the currently logged in Sone.
+        *
+        * @param toadletContext
+        *            The toadlet context
+        * @param sone
+        *            The Sone to set as currently logged in
+        */
+       protected void setCurrentSone(ToadletContext toadletContext, Sone sone) {
+               webInterface.setCurrentSone(toadletContext, sone);
        }
 
        //
@@ -88,29 +205,119 @@ public class SoneTemplatePage extends TemplatePage {
         * {@inheritDoc}
         */
        @Override
+       protected String getPageTitle(FreenetRequest request) {
+               if (pageTitleKey != null) {
+                       return webInterface.getL10n().getString(pageTitleKey);
+               }
+               return "";
+       }
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       protected List<Map<String, String>> getAdditionalLinkNodes(FreenetRequest request) {
+               return new ListBuilder<Map<String, String>>().add(new MapBuilder<String, String>().put("rel", "search").put("type", "application/opensearchdescription+xml").put("title", "Sone").put("href", "http://" + request.getHttpRequest().getHeader("host") + "/Sone/OpenSearch.xml").get()).get();
+       }
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
        protected Collection<String> getStyleSheets() {
                return Arrays.asList("css/sone.css");
        }
 
        /**
+        * {@inheritDoc}
+        */
+       @Override
+       protected String getShortcutIcon() {
+               return "images/icon.png";
+       }
+
+       /**
         * Returns whether this page requires the user to log in.
         *
         * @return {@code true} if the user is required to be logged in to use this
         *         page, {@code false} otherwise
         */
        protected boolean requiresLogin() {
-               return false;
+               return requireLogin;
        }
 
        /**
         * {@inheritDoc}
         */
        @Override
-       protected String getRedirectTarget(Page.Request request) {
-               if (requiresLogin() && (getCurrentSone(request) == null)) {
-                       return "login.html";
+       protected void processTemplate(FreenetRequest request, TemplateContext templateContext) throws RedirectException {
+               super.processTemplate(request, templateContext);
+               Sone currentSone = getCurrentSone(request.getToadletContext(), false);
+               templateContext.set("core", webInterface.getCore());
+               templateContext.set("currentSone", currentSone);
+               templateContext.set("localSones", webInterface.getCore().getLocalSones());
+               templateContext.set("request", request);
+               templateContext.set("currentVersion", SonePlugin.VERSION);
+               templateContext.set("hasLatestVersion", webInterface.getCore().getUpdateChecker().hasLatestVersion());
+               templateContext.set("latestEdition", webInterface.getCore().getUpdateChecker().getLatestEdition());
+               templateContext.set("latestVersion", webInterface.getCore().getUpdateChecker().getLatestVersion());
+               templateContext.set("latestVersionTime", webInterface.getCore().getUpdateChecker().getLatestVersionDate());
+               List<Notification> notifications = ListNotificationFilters.filterNotifications(webInterface.getNotifications().getNotifications(), currentSone);
+               Collections.sort(notifications, Notification.CREATED_TIME_SORTER);
+               templateContext.set("notifications", notifications);
+               templateContext.set("notificationHash", HashCode.hashCode(notifications));
+       }
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       protected String getRedirectTarget(FreenetRequest request) {
+               if (requiresLogin() && (getCurrentSone(request.getToadletContext(), false) == null)) {
+                       HTTPRequest httpRequest = request.getHttpRequest();
+                       String originalUrl = httpRequest.getPath();
+                       if (httpRequest.hasParameters()) {
+                               StringBuilder requestParameters = new StringBuilder();
+                               for (String parameterName : httpRequest.getParameterNames()) {
+                                       if (requestParameters.length() > 0) {
+                                               requestParameters.append("%26");
+                                       }
+                                       String[] parameterValues = httpRequest.getMultipleParam(parameterName);
+                                       for (String parameterValue : parameterValues) {
+                                               try {
+                                                       requestParameters.append(URLEncoder.encode(parameterName, "UTF-8")).append("%3d").append(URLEncoder.encode(parameterValue, "UTF-8"));
+                                               } catch (UnsupportedEncodingException uee1) {
+                                                       /* A JVM without UTF-8? I don’t think so. */
+                                               }
+                                       }
+                               }
+                               originalUrl += "?" + requestParameters.toString();
+                       }
+                       return "login.html?target=" + originalUrl;
                }
                return null;
        }
 
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       protected boolean isFullAccessOnly() {
+               return webInterface.getCore().getPreferences().isRequireFullAccess();
+       }
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       public boolean isEnabled(ToadletContext toadletContext) {
+               if (webInterface.getCore().getPreferences().isRequireFullAccess() && !toadletContext.isAllowedFullAccess()) {
+                       return false;
+               }
+               if (requiresLogin()) {
+                       return getCurrentSone(toadletContext, false) != null;
+               }
+               return true;
+       }
+
 }