Add AJAX handler to return all notifications.
authorDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Fri, 25 Nov 2011 06:48:05 +0000 (07:48 +0100)
committerDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Fri, 25 Nov 2011 06:48:05 +0000 (07:48 +0100)
src/main/java/net/pterodactylus/sone/web/ajax/GetNotificationsAjaxPage.java [new file with mode: 0644]

diff --git a/src/main/java/net/pterodactylus/sone/web/ajax/GetNotificationsAjaxPage.java b/src/main/java/net/pterodactylus/sone/web/ajax/GetNotificationsAjaxPage.java
new file mode 100644 (file)
index 0000000..d0020ca
--- /dev/null
@@ -0,0 +1,153 @@
+/*
+ * Sone - GetNotificationsAjaxPage.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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.sone.web.ajax;
+
+import java.io.IOException;
+import java.io.StringWriter;
+import java.util.Collection;
+import java.util.List;
+
+import net.pterodactylus.sone.data.Sone;
+import net.pterodactylus.sone.main.SonePlugin;
+import net.pterodactylus.sone.notify.ListNotificationFilters;
+import net.pterodactylus.sone.web.WebInterface;
+import net.pterodactylus.sone.web.page.FreenetRequest;
+import net.pterodactylus.util.json.JsonArray;
+import net.pterodactylus.util.json.JsonObject;
+import net.pterodactylus.util.notify.Notification;
+import net.pterodactylus.util.notify.TemplateNotification;
+import net.pterodactylus.util.object.HashCode;
+import net.pterodactylus.util.template.TemplateContext;
+
+/**
+ * AJAX handler to return all current notifications.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public class GetNotificationsAjaxPage extends JsonPage {
+
+       /**
+        * Creates a new “get notifications” AJAX handler.
+        *
+        * @param webInterface
+        *            The Sone web interface
+        */
+       public GetNotificationsAjaxPage(WebInterface webInterface) {
+               super("getNotifications.ajax", webInterface);
+       }
+
+       //
+       // JSONPAGE METHODS
+       //
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       protected boolean needsFormPassword() {
+               return false;
+       }
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       protected boolean requiresLogin() {
+               return false;
+       }
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       protected JsonObject createJsonObject(FreenetRequest request) {
+               Sone currentSone = getCurrentSone(request.getToadletContext(), false);
+               Collection<Notification> notifications = webInterface.getNotifications().getNotifications();
+               List<Notification> filteredNotifications = ListNotificationFilters.filterNotifications(notifications, currentSone);
+               int notificationHash = HashCode.hashCode(filteredNotifications);
+               JsonArray jsonNotifications = new JsonArray();
+               for (Notification notification : filteredNotifications) {
+                       jsonNotifications.add(createJsonNotification(request, notification));
+               }
+               return createSuccessJsonObject().put("notificationHash", notificationHash).put("notifications", jsonNotifications).put("options", createJsonOptions(currentSone));
+       }
+
+       //
+       // PRIVATE METHODS
+       //
+
+       /**
+        * Creates a JSON object from the given notification.
+        *
+        * @param request
+        *            The request to load the session from
+        * @param notification
+        *            The notification to create a JSON object
+        * @return The JSON object
+        */
+       private JsonObject createJsonNotification(FreenetRequest request, Notification notification) {
+               JsonObject jsonNotification = new JsonObject();
+               jsonNotification.put("id", notification.getId());
+               StringWriter notificationWriter = new StringWriter();
+               try {
+                       if (notification instanceof TemplateNotification) {
+                               TemplateContext templateContext = webInterface.getTemplateContextFactory().createTemplateContext().mergeContext(((TemplateNotification) notification).getTemplateContext());
+                               templateContext.set("core", webInterface.getCore());
+                               templateContext.set("currentSone", webInterface.getCurrentSone(request.getToadletContext(), false));
+                               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());
+                               templateContext.set("notification", notification);
+                               ((TemplateNotification) notification).render(templateContext, notificationWriter);
+                       } else {
+                               notification.render(notificationWriter);
+                       }
+               } catch (IOException ioe1) {
+                       /* StringWriter never throws, ignore. */
+               }
+               jsonNotification.put("text", notificationWriter.toString());
+               jsonNotification.put("createdTime", notification.getCreatedTime());
+               jsonNotification.put("lastUpdatedTime", notification.getLastUpdatedTime());
+               jsonNotification.put("dismissable", notification.isDismissable());
+               return jsonNotification;
+       }
+
+       /**
+        * Creates a JSON object that contains all options that are currently in
+        * effect for the given Sone (or overall, if the given Sone is {@code null}
+        * ).
+        *
+        * @param currentSone
+        *            The current Sone (may be {@code null})
+        * @return The current options
+        */
+       private JsonObject createJsonOptions(Sone currentSone) {
+               JsonObject options = new JsonObject();
+               if (currentSone != null) {
+                       options.put("ShowNotification/NewSones", currentSone.getOptions().getBooleanOption("ShowNotification/NewSones").get());
+                       options.put("ShowNotification/NewPosts", currentSone.getOptions().getBooleanOption("ShowNotification/NewPosts").get());
+                       options.put("ShowNotification/NewReplies", currentSone.getOptions().getBooleanOption("ShowNotification/NewReplies").get());
+               }
+               return options;
+       }
+
+}