Use better notification ID.
[Sone.git] / src / main / java / net / pterodactylus / sone / notify / ListNotificationFilters.java
index 62a7d61..37cff6f 100644 (file)
@@ -24,7 +24,10 @@ import java.util.List;
 import net.pterodactylus.sone.data.Post;
 import net.pterodactylus.sone.data.Reply;
 import net.pterodactylus.sone.data.Sone;
+import net.pterodactylus.sone.freenet.wot.OwnIdentity;
+import net.pterodactylus.sone.freenet.wot.Trust;
 import net.pterodactylus.util.notify.Notification;
+import net.pterodactylus.util.validation.Validation;
 
 /**
  * Filter for {@link ListNotification}s.
@@ -35,12 +38,11 @@ public class ListNotificationFilters {
 
        /**
         * Filters new-post and new-reply notifications in the given list of
-        * notifications. If {@code currentSone} is <code>null</code>, nothing is
-        * filtered and the given list is returned.
-        * If {@code currentSone} is not {@code null}, only posts that are posted by
-        * a friend Sone or the Sone itself, and replies that are replies to posts
-        * of friend Sones or the Sone itself will be retained
-        * in the notifications.
+        * notifications. If {@code currentSone} is <code>null</code>, new-post and
+        * new-reply notifications are removed completely. If {@code currentSone} is
+        * not {@code null}, only posts that are posted by a friend Sone or the Sone
+        * itself, and replies that are replies to posts of friend Sones or the Sone
+        * itself will be retained in the notifications.
         *
         * @param notifications
         *            The notifications to filter
@@ -48,83 +50,185 @@ public class ListNotificationFilters {
         *            The current Sone, or {@code null} if not logged in
         * @return The filtered notifications
         */
-       public static List<Notification> filterNotifications(List<Notification> notifications, Sone currentSone) {
-               if (currentSone == null) {
-                       return notifications;
-               }
-               ListNotification<Post> newPostNotification = getNotification(notifications, "new-post-notification", Post.class);
-               System.out.println("Found new-post-notification with " + ((newPostNotification != null) ? newPostNotification.getElements().size() : -1) + " posts.");
-               if (newPostNotification != null) {
-                       List<Post> newPosts = new ArrayList<Post>();
-                       for (Post post : newPostNotification.getElements()) {
-                               System.out.println("Checking Post: " + post);
-                               if (currentSone.hasFriend(post.getSone().getId()) || currentSone.equals(post.getSone())) {
-                                       System.out.println("  CS.hF: " + currentSone.hasFriend(post.getSone().getId()));
-                                       System.out.println("  CS.e:" + currentSone.equals(post.getSone()));
-                                       newPosts.add(post);
+       @SuppressWarnings("unchecked")
+       public static List<Notification> filterNotifications(Collection<? extends Notification> notifications, Sone currentSone) {
+               List<Notification> filteredNotifications = new ArrayList<Notification>();
+               for (Notification notification : notifications) {
+                       if (notification.getId().equals("new-post-notification")) {
+                               ListNotification<Post> filteredNotification = filterNewPostNotification((ListNotification<Post>) notification, currentSone);
+                               if (filteredNotification != null) {
+                                       filteredNotifications.add(filteredNotification);
+                               }
+                       } else if (notification.getId().equals("new-reply-notification")) {
+                               ListNotification<Reply> filteredNotification = filterNewReplyNotification((ListNotification<Reply>) notification, currentSone);
+                               if (filteredNotification != null) {
+                                       filteredNotifications.add(filteredNotification);
                                }
-                       }
-                       int notificationIndex = notifications.indexOf(newPostNotification);
-                       if (newPosts.isEmpty()) {
-                               System.out.println("Removing notification.");
-                               notifications.remove(notificationIndex);
                        } else {
-                               System.out.println("Replacing Notification.");
-                               newPostNotification = new ListNotification<Post>(newPostNotification);
-                               newPostNotification.setElements(newPosts);
-                               notifications.set(notificationIndex, newPostNotification);
+                               filteredNotifications.add(notification);
                        }
                }
-               ListNotification<Reply> newReplyNotification = getNotification(notifications, "new-replies-notification", Reply.class);
-               System.out.println("Found new-reply-notification with " + ((newReplyNotification != null) ? newReplyNotification.getElements().size() : -1) + " replies.");
-               if (newReplyNotification != null) {
-                       List<Reply> newReplies = new ArrayList<Reply>();
-                       for (Reply reply : newReplyNotification.getElements()) {
-                               System.out.println("Checking Reply: " + reply);
-                               if (currentSone.hasFriend(reply.getPost().getSone().getId()) || currentSone.equals(reply.getPost().getSone())) {
-                                       System.out.println("  CS.hF: " + currentSone.hasFriend(reply.getPost().getSone().getId()));
-                                       System.out.println("  CS.e: " + currentSone.equals(reply.getPost().getSone()));
-                                       newReplies.add(reply);
-                               }
+               return filteredNotifications;
+       }
+
+       /**
+        * Filters the new posts of the given notification. If {@code currentSone}
+        * is {@code null}, {@code null} is returned and the notification is
+        * subsequently removed. Otherwise only posts that are posted by friend
+        * Sones of the given Sone are retained; all other posts are removed.
+        *
+        * @param newPostNotification
+        *            The new-post notification
+        * @param currentSone
+        *            The current Sone, or {@code null} if not logged in
+        * @return The filtered new-post notification, or {@code null} if the
+        *         notification should be removed
+        */
+       public static ListNotification<Post> filterNewPostNotification(ListNotification<Post> newPostNotification, Sone currentSone) {
+               if (currentSone == null) {
+                       return null;
+               }
+               List<Post> newPosts = new ArrayList<Post>();
+               for (Post post : newPostNotification.getElements()) {
+                       if (isPostVisible(currentSone, post)) {
+                               newPosts.add(post);
                        }
-                       int notificationIndex = notifications.indexOf(newReplyNotification);
-                       if (newReplies.isEmpty()) {
-                               System.out.println("Removing Notification.");
-                               notifications.remove(notificationIndex);
-                       } else {
-                               System.out.println("Replacing Notification.");
-                               newReplyNotification = new ListNotification<Reply>(newReplyNotification);
-                               newReplyNotification.setElements(newReplies);
-                               notifications.set(notificationIndex, newReplyNotification);
+               }
+               if (newPosts.isEmpty()) {
+                       return null;
+               }
+               if (newPosts.size() == newPostNotification.getElements().size()) {
+                       return newPostNotification;
+               }
+               ListNotification<Post> filteredNotification = new ListNotification<Post>(newPostNotification);
+               filteredNotification.setElements(newPosts);
+               return filteredNotification;
+       }
+
+       /**
+        * Filters the new replies of the given notification. If {@code currentSone}
+        * is {@code null}, {@code null} is returned and the notification is
+        * subsequently removed. Otherwise only replies that are replies to posts
+        * that are posted by friend Sones of the given Sone are retained; all other
+        * replies are removed.
+        *
+        * @param newReplyNotification
+        *            The new-reply notification
+        * @param currentSone
+        *            The current Sone, or {@code null} if not logged in
+        * @return The filtered new-reply notification, or {@code null} if the
+        *         notification should be removed
+        */
+       public static ListNotification<Reply> filterNewReplyNotification(ListNotification<Reply> newReplyNotification, Sone currentSone) {
+               if (currentSone == null) {
+                       return null;
+               }
+               List<Reply> newReplies = new ArrayList<Reply>();
+               for (Reply reply : newReplyNotification.getElements()) {
+                       if (isReplyVisible(currentSone, reply)) {
+                               newReplies.add(reply);
                        }
                }
-               return notifications;
+               if (newReplies.isEmpty()) {
+                       return null;
+               }
+               if (newReplies.size() == newReplyNotification.getElements().size()) {
+                       return newReplyNotification;
+               }
+               ListNotification<Reply> filteredNotification = new ListNotification<Reply>(newReplyNotification);
+               filteredNotification.setElements(newReplies);
+               return filteredNotification;
        }
 
        /**
-        * Finds the notification with the given ID in the list of notifications and
-        * returns it.
+        * Checks whether a post is visible to the given Sone. A post is not
+        * considered visible if one of the following statements is true:
+        * <ul>
+        * <li>The post does not have a Sone.</li>
+        * <li>The Sone of the post is not the given Sone, the given Sone does not
+        * follow the post’s Sone, and the given Sone is not the recipient of the
+        * post.</li>
+        * <li>The trust relationship between the two Sones can not be retrieved.</li>
+        * <li>The given Sone has explicitely assigned negative trust to the post’s
+        * Sone.</li>
+        * <li>The given Sone has not explicitely assigned negative trust to the
+        * post’s Sone but the implicit trust is negative.</li>
+        * <li>The post’s {@link Post#getTime() time} is in the future.</li>
+        * </ul>
+        * If none of these statements is true the post is considered visible.
         *
-        * @param <T>
-        *            The type of the item in the notification
-        * @param notifications
-        *            The notification to search
-        * @param notificationId
-        *            The ID of the requested notification
-        * @param notificationElementClass
-        *            The class of the notification item
-        * @return The requested notification, or {@code null} if no notification
-        *         with the given ID could be found
+        * @param sone
+        *            The Sone that checks for a post’s visibility
+        * @param post
+        *            The post to check for visibility
+        * @return {@code true} if the post is considered visible, {@code false}
+        *         otherwise
         */
-       @SuppressWarnings("unchecked")
-       private static <T> ListNotification<T> getNotification(Collection<? extends Notification> notifications, String notificationId, Class<T> notificationElementClass) {
-               for (Notification notification : notifications) {
-                       if (!notificationId.equals(notification.getId())) {
-                               continue;
+       public static boolean isPostVisible(Sone sone, Post post) {
+               Validation.begin().isNotNull("Sone", sone).isNotNull("Post", post).check().isNotNull("Sone’s Identity", sone.getIdentity()).check().isInstanceOf("Sone’s Identity", sone.getIdentity(), OwnIdentity.class).check();
+               Sone postSone = post.getSone();
+               if (postSone == null) {
+                       return false;
+               }
+               Trust trust = postSone.getIdentity().getTrust((OwnIdentity) sone.getIdentity());
+               if (trust != null) {
+                       if ((trust.getExplicit() != null) && (trust.getExplicit() < 0)) {
+                               return false;
                        }
-                       return (ListNotification<T>) notification;
+                       if ((trust.getExplicit() == null) && (trust.getImplicit() != null) && (trust.getImplicit() < 0)) {
+                               return false;
+                       }
+               } else {
+                       return false;
+               }
+               if ((!postSone.equals(sone)) && !sone.hasFriend(postSone.getId()) && !sone.equals(post.getRecipient())) {
+                       return false;
+               }
+               if (post.getTime() > System.currentTimeMillis()) {
+                       return false;
+               }
+               return true;
+       }
+
+       /**
+        * Checks whether a reply is visible to the given Sone. A reply is not
+        * considered visible if one of the following statements is true:
+        * <ul>
+        * <li>The reply does not have a post.</li>
+        * <li>The reply’s post does not have a Sone.</li>
+        * <li>The Sone of the reply’s post is not the given Sone, the given Sone
+        * does not follow the reply’s post’s Sone, and the given Sone is not the
+        * recipient of the reply’s post.</li>
+        * <li>The trust relationship between the two Sones can not be retrieved.</li>
+        * <li>The given Sone has explicitely assigned negative trust to the post’s
+        * Sone.</li>
+        * <li>The given Sone has not explicitely assigned negative trust to the
+        * reply’s post’s Sone but the implicit trust is negative.</li>
+        * <li>The reply’s post’s {@link Post#getTime() time} is in the future.</li>
+        * <li>The reply’s {@link Reply#getTime() time} is in the future.</li>
+        * </ul>
+        * If none of these statements is true the reply is considered visible.
+        *
+        * @param sone
+        *            The Sone that checks for a post’s visibility
+        * @param reply
+        *            The reply to check for visibility
+        * @return {@code true} if the reply is considered visible, {@code false}
+        *         otherwise
+        */
+       public static boolean isReplyVisible(Sone sone, Reply reply) {
+               Validation.begin().isNotNull("Sone", sone).isNotNull("Reply", reply).check().isNotNull("Sone’s Identity", sone.getIdentity()).check().isInstanceOf("Sone’s Identity", sone.getIdentity(), OwnIdentity.class).check();
+               Post post = reply.getPost();
+               if (post == null) {
+                       return false;
+               }
+               if (!isPostVisible(sone, post)) {
+                       return false;
+               }
+               if (reply.getTime() > System.currentTimeMillis()) {
+                       return false;
                }
-               return null;
+               return true;
        }
 
 }