This resolves #254.
<dependency>
<groupId>net.pterodactylus</groupId>
<artifactId>utils</artifactId>
- <version>0.11.3</version>
+ <version>0.11.4-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>junit</groupId>
elements.clear();
}
+ //
+ // OBJECT METHODS
+ //
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public int hashCode() {
+ int hashCode = super.hashCode();
+ for (T element : elements) {
+ hashCode ^= element.hashCode();
+ }
+ return hashCode;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public boolean equals(Object object) {
+ if (!(object instanceof ListNotification)) {
+ return false;
+ }
+ ListNotification<?> listNotification = (ListNotification<?>) object;
+ if (!super.equals(listNotification)) {
+ return false;
+ }
+ if (!key.equals(listNotification.key)) {
+ return false;
+ }
+ if (elements.size() != listNotification.elements.size()) {
+ return false;
+ }
+ for (int index = 0; index < elements.size(); ++index) {
+ if (!elements.get(index).equals(listNotification.elements.get(index))) {
+ return false;
+ }
+ }
+ return true;
+ }
+
}
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 net.pterodactylus.util.template.TemplateContext;
import freenet.clients.http.SessionManager.Session;
templateContext.set("latestEdition", webInterface.getCore().getUpdateChecker().getLatestEdition());
templateContext.set("latestVersion", webInterface.getCore().getUpdateChecker().getLatestVersion());
templateContext.set("latestVersionTime", webInterface.getCore().getUpdateChecker().getLatestVersionDate());
- templateContext.set("notifications", ListNotificationFilters.filterNotifications(webInterface.getNotifications().getNotifications(), currentSone));
+ List<Notification> notifications = ListNotificationFilters.filterNotifications(webInterface.getNotifications().getNotifications(), currentSone);
+ templateContext.set("notifications", notifications);
+ templateContext.set("notificationHash", HashCode.hashCode(notifications));
}
/**
import net.pterodactylus.sone.web.ajax.EditProfileFieldAjaxPage;
import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
-import net.pterodactylus.sone.web.ajax.GetNotificationAjaxPage;
+import net.pterodactylus.sone.web.ajax.GetNotificationsAjaxPage;
import net.pterodactylus.sone.web.ajax.GetPostAjaxPage;
import net.pterodactylus.sone.web.ajax.GetReplyAjaxPage;
import net.pterodactylus.sone.web.ajax.GetStatusAjaxPage;
pageToadlets.add(pageToadletFactory.createPageToadlet(new GetImagePage(this)));
pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
pageToadlets.add(pageToadletFactory.createPageToadlet(new GetStatusAjaxPage(this)));
- pageToadlets.add(pageToadletFactory.createPageToadlet(new GetNotificationAjaxPage(this)));
+ pageToadlets.add(pageToadletFactory.createPageToadlet(new GetNotificationsAjaxPage(this)));
pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationAjaxPage(this)));
pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostAjaxPage(this)));
pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyAjaxPage(this)));
+++ /dev/null
-/*
- * Sone - GetNotificationAjaxPage.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
- * 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 net.pterodactylus.sone.data.Post;
-import net.pterodactylus.sone.data.PostReply;
-import net.pterodactylus.sone.data.Sone;
-import net.pterodactylus.sone.main.SonePlugin;
-import net.pterodactylus.sone.notify.ListNotification;
-import net.pterodactylus.sone.notify.ListNotificationFilters;
-import net.pterodactylus.sone.web.WebInterface;
-import net.pterodactylus.sone.web.page.FreenetRequest;
-import net.pterodactylus.util.json.JsonObject;
-import net.pterodactylus.util.notify.Notification;
-import net.pterodactylus.util.notify.TemplateNotification;
-import net.pterodactylus.util.template.TemplateContext;
-
-/**
- * The “get notification” AJAX handler returns a number of rendered
- * notifications.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
- */
-public class GetNotificationAjaxPage extends JsonPage {
-
- /**
- * Creates a new “get notification” AJAX page.
- *
- * @param webInterface
- * The Sone web interface
- */
- public GetNotificationAjaxPage(WebInterface webInterface) {
- super("getNotification.ajax", webInterface);
- }
-
- //
- // JSONPAGE METHODS
- //
-
- /**
- * {@inheritDoc}
- */
- @Override
- protected boolean needsFormPassword() {
- return false;
- }
-
- /**
- * {@inheritDoc}
- */
- @Override
- protected boolean requiresLogin() {
- return false;
- }
-
- /**
- * {@inheritDoc}
- */
- @Override
- @SuppressWarnings("unchecked")
- protected JsonObject createJsonObject(FreenetRequest request) {
- String[] notificationIds = request.getHttpRequest().getParam("notifications").split(",");
- JsonObject jsonNotifications = new JsonObject();
- Sone currentSone = getCurrentSone(request.getToadletContext(), false);
- for (String notificationId : notificationIds) {
- Notification notification = webInterface.getNotifications().getNotification(notificationId);
- if (notification == null) {
- // TODO - show error
- continue;
- }
- if ("new-post-notification".equals(notificationId)) {
- notification = ListNotificationFilters.filterNewPostNotification((ListNotification<Post>) notification, currentSone, false);
- } else if ("new-reply-notification".equals(notificationId)) {
- notification = ListNotificationFilters.filterNewReplyNotification((ListNotification<PostReply>) notification, currentSone);
- } else if ("mention-notification".equals(notificationId)) {
- notification = ListNotificationFilters.filterNewPostNotification((ListNotification<Post>) notification, currentSone, false);
- }
- if (notification == null) {
- // TODO - show error
- continue;
- }
- jsonNotifications.put(notificationId, createJsonNotification(request, notification));
- }
- return createSuccessJsonObject().put("notifications", jsonNotifications);
- }
-
- //
- // 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;
- }
-
-}
--- /dev/null
+/*
+ * 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;
+ }
+
+}
import net.pterodactylus.util.json.JsonArray;
import net.pterodactylus.util.json.JsonObject;
import net.pterodactylus.util.notify.Notification;
+import net.pterodactylus.util.object.HashCode;
/**
* The “get status” AJAX handler returns all information that is necessary to
}
/* load notifications. */
List<Notification> notifications = ListNotificationFilters.filterNotifications(webInterface.getNotifications().getNotifications(), currentSone);
- Collections.sort(notifications, Notification.LAST_UPDATED_TIME_SORTER);
- JsonArray jsonNotificationInformations = new JsonArray();
- for (Notification notification : notifications) {
- jsonNotificationInformations.add(createJsonNotificationInformation(notification));
- }
+ int notificationHash = HashCode.hashCode(notifications);
/* load new posts. */
Set<Post> newPosts = webInterface.getNewPosts();
if (currentSone != null) {
jsonReply.put("postSone", reply.getPost().getSone().getId());
jsonReplies.add(jsonReply);
}
- return createSuccessJsonObject().put("loggedIn", currentSone != null).put("options", createJsonOptions(currentSone)).put("sones", jsonSones).put("notifications", jsonNotificationInformations).put("newPosts", jsonPosts).put("newReplies", jsonReplies);
+ return createSuccessJsonObject().put("loggedIn", currentSone != null).put("options", createJsonOptions(currentSone)).put("sones", jsonSones).put("notificationHash", notificationHash).put("newPosts", jsonPosts).put("newReplies", jsonReplies);
}
/**
}
/**
- * Creates a JSON object that only contains the ID and the last-updated time
- * of the given notification.
- *
- * @see Notification#getId()
- * @see Notification#getLastUpdatedTime()
- * @param notification
- * The notification
- * @return A JSON object containing the notification ID and last-updated
- * time
- */
- private JsonObject createJsonNotificationInformation(Notification notification) {
- JsonObject jsonNotification = new JsonObject();
- jsonNotification.put("id", notification.getId());
- jsonNotification.put("lastUpdatedTime", notification.getLastUpdatedTime());
- 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}
* ).
}
/**
+ * Returns the notification hash. This hash is used in {@link #getStatus()} to
+ * determine whether the notifications changed and need to be reloaded.
+ */
+function getNotificationHash() {
+ return $("#sone #notification-area #notification-hash").text();
+}
+
+/**
+ * Sets the notification hash.
+ *
+ * @param notificationHash
+ * The new notification hash
+ */
+function setNotificationHash(notificationHash) {
+ $("#sone #notification-area #notification-hash").text(notificationHash);
+}
+
+/**
* Retrieves element IDs from notification elements.
*
* @param notification
if (!notLoggedIn) {
showOfflineMarker(!online);
}
+ if (data.notificationHash != getNotificationHash()) {
+ console.log("Old hash: ", getNotificationHash(), ", new hash: ", data.notificationHash);
+ requestNotifications();
+ }
+ /* process new posts. */
+ $.each(data.newPosts, function(index, value) {
+ loadNewPost(value.id, value.sone, value.recipient, value.time);
+ });
+ /* process new replies. */
+ $.each(data.newReplies, function(index, value) {
+ loadNewReply(value.id, value.sone, value.post, value.postSone);
+ });
+ /* do it again in 5 seconds. */
+ setTimeout(getStatus, 5000);
+ } else {
+ /* data.success was false, wait 30 seconds. */
+ setTimeout(getStatus, 30000);
+ }
+ }, function() {
+ statusRequestQueued = false;
+ ajaxError();
+ });
+}
+
+function requestNotifications() {
+ ajaxGet("getNotifications.ajax", {}, function(data, textStatus) {
+ if (data && data.success) {
/* search for removed notifications. */
$("#sone #notification-area .notification").each(function() {
notificationId = $(this).attr("id");
}
});
/* process notifications. */
- notificationIds = [];
$.each(data.notifications, function(index, value) {
oldNotification = getNotification(value.id);
- if ((oldNotification.length == 0) || (value.lastUpdatedTime > getNotificationLastUpdatedTime(oldNotification))) {
- notificationIds.push(value.id);
+ notification = ajaxifyNotification(createNotification(value.id, value.lastUpdatedTime, value.text, value.dismissable)).hide();
+ if (oldNotification.length != 0) {
+ if ((oldNotification.find(".short-text").length > 0) && (notification.find(".short-text").length > 0)) {
+ opened = oldNotification.is(":visible") && oldNotification.find(".short-text").hasClass("hidden");
+ notification.find(".short-text").toggleClass("hidden", opened);
+ notification.find(".text").toggleClass("hidden", !opened);
+ }
+ checkForRemovedSones(oldNotification, notification);
+ checkForRemovedPosts(oldNotification, notification);
+ checkForRemovedReplies(oldNotification, notification);
+ oldNotification.replaceWith(notification.show());
+ } else {
+ $("#sone #notification-area").append(notification);
+ if (value.id.substring(0, 5) != "local") {
+ notification.slideDown();
+ setActivity();
+ }
}
});
- if (notificationIds.length > 0) {
- loadNotifications(notificationIds);
- }
- /* process new posts. */
- $.each(data.newPosts, function(index, value) {
- loadNewPost(value.id, value.sone, value.recipient, value.time);
- });
- /* process new replies. */
- $.each(data.newReplies, function(index, value) {
- loadNewReply(value.id, value.sone, value.post, value.postSone);
- });
- /* do it again in 5 seconds. */
- setTimeout(getStatus, 5000);
- } else {
- /* data.success was false, wait 30 seconds. */
- setTimeout(getStatus, 30000);
+ setNotificationHash(data.notificationHash);
}
- }, function() {
- statusRequestQueued = false;
- ajaxError();
- });
-}
-
-/**
- * Requests multiple notifications from Sone and displays them.
- *
- * @param notificationIds
- * Array of IDs of the notifications to load
- */
-function loadNotifications(notificationIds) {
- ajaxGet("getNotification.ajax", {"notifications": notificationIds.join(",")}, function(data, textStatus) {
- if (!data || !data.success) {
- // TODO - show error
- return;
- }
- $.each(data.notifications, function(index, value) {
- oldNotification = getNotification(value.id);
- notification = ajaxifyNotification(createNotification(value.id, value.lastUpdatedTime, value.text, value.dismissable)).hide();
- if (oldNotification.length != 0) {
- if ((oldNotification.find(".short-text").length > 0) && (notification.find(".short-text").length > 0)) {
- opened = oldNotification.is(":visible") && oldNotification.find(".short-text").hasClass("hidden");
- notification.find(".short-text").toggleClass("hidden", opened);
- notification.find(".text").toggleClass("hidden", !opened);
- }
- checkForRemovedSones(oldNotification, notification);
- checkForRemovedPosts(oldNotification, notification);
- checkForRemovedReplies(oldNotification, notification);
- oldNotification.replaceWith(notification.show());
- } else {
- $("#sone #notification-area").append(notification);
- if (value.id.substring(0, 5) != "local") {
- notification.slideDown();
- setActivity();
- }
- }
- });
});
}
<div id="notification-area">
+ <div id="notification-hash" class="hidden"><% notificationHash|html></div>
+
<form id="notification-dismiss-template" class="hidden dismiss" action="dismissNotification.html" method="post">
<input type="hidden" name="formPassword" value="<% formPassword|html>" />
<input type="hidden" name="returnPage" value="<% request.uri|html>" />