src/main/java/net/pterodactylus/sone/notify/ListNotificationFilters.java

   1 /*
   2  * Sone - ListNotificationFilters.java - Copyright © 2010 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.notify;
  19
  20 import java.util.ArrayList;
  21 import java.util.Collection;
  22 import java.util.List;
  23
  24 import net.pterodactylus.sone.data.Post;
  25 import net.pterodactylus.sone.data.Reply;
  26 import net.pterodactylus.sone.data.Sone;
  27 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
  28 import net.pterodactylus.sone.freenet.wot.Trust;
  29 import net.pterodactylus.util.notify.Notification;
  30 import net.pterodactylus.util.validation.Validation;
  31
  32 /**
  33  * Filter for {@link ListNotification}s.
  34  *
  35  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  36  */
  37 public class ListNotificationFilters {
  38
  39         /**
  40          * Filters new-post and new-reply notifications in the given list of
  41          * notifications. If {@code currentSone} is <code>null</code>, new-post and
  42          * new-reply notifications are removed completely. If {@code currentSone} is
  43          * not {@code null}, only posts that are posted by a friend Sone or the Sone
  44          * itself, and replies that are replies to posts of friend Sones or the Sone
  45          * itself will be retained in the notifications.
  46          *
  47          * @param notifications
  48          *            The notifications to filter
  49          * @param currentSone
  50          *            The current Sone, or {@code null} if not logged in
  51          * @return The filtered notifications
  52          */
  53         @SuppressWarnings("unchecked")
  54         public static List<Notification> filterNotifications(Collection<? extends Notification> notifications, Sone currentSone) {
  55                 List<Notification> filteredNotifications = new ArrayList<Notification>();
  56                 for (Notification notification : notifications) {
  57                         if (notification.getId().equals("new-post-notification")) {
  58                                 ListNotification<Post> filteredNotification = filterNewPostNotification((ListNotification<Post>) notification, currentSone, true);
  59                                 if (filteredNotification != null) {
  60                                         filteredNotifications.add(filteredNotification);
  61                                 }
  62                         } else if (notification.getId().equals("new-reply-notification")) {
  63                                 ListNotification<Reply> filteredNotification = filterNewReplyNotification((ListNotification<Reply>) notification, currentSone);
  64                                 if (filteredNotification != null) {
  65                                         filteredNotifications.add(filteredNotification);
  66                                 }
  67                         } else if (notification.getId().equals("mention-notification")) {
  68                                 ListNotification<Post> filteredNotification = filterNewPostNotification((ListNotification<Post>) notification, null, false);
  69                                 if (filteredNotification != null) {
  70                                         filteredNotifications.add(filteredNotification);
  71                                 }
  72                         } else {
  73                                 filteredNotifications.add(notification);
  74                         }
  75                 }
  76                 return filteredNotifications;
  77         }
  78
  79         /**
  80          * Filters the new posts of the given notification. If {@code currentSone}
  81          * is {@code null} and {@code soneRequired} is {@code true}, {@code null} is
  82          * returned and the notification is subsequently removed. Otherwise only
  83          * posts that are posted by friend Sones of the given Sone are retained; all
  84          * other posts are removed.
  85          *
  86          * @param newPostNotification
  87          *            The new-post notification
  88          * @param currentSone
  89          *            The current Sone, or {@code null} if not logged in
  90          * @param soneRequired
  91          *            Whether a non-{@code null} Sone in {@code currentSone} is
  92          *            required
  93          * @return The filtered new-post notification, or {@code null} if the
  94          *         notification should be removed
  95          */
  96         public static ListNotification<Post> filterNewPostNotification(ListNotification<Post> newPostNotification, Sone currentSone, boolean soneRequired) {
  97                 if (soneRequired && (currentSone == null)) {
  98                         return null;
  99                 }
 100                 List<Post> newPosts = new ArrayList<Post>();
 101                 for (Post post : newPostNotification.getElements()) {
 102                         if (isPostVisible(currentSone, post)) {
 103                                 newPosts.add(post);
 104                         }
 105                 }
 106                 if (newPosts.isEmpty()) {
 107                         return null;
 108                 }
 109                 if (newPosts.size() == newPostNotification.getElements().size()) {
 110                         return newPostNotification;
 111                 }
 112                 ListNotification<Post> filteredNotification = new ListNotification<Post>(newPostNotification);
 113                 filteredNotification.setElements(newPosts);
 114                 filteredNotification.setLastUpdateTime(newPostNotification.getLastUpdatedTime());
 115                 return filteredNotification;
 116         }
 117
 118         /**
 119          * Filters the new replies of the given notification. If {@code currentSone}
 120          * is {@code null}, {@code null} is returned and the notification is
 121          * subsequently removed. Otherwise only replies that are replies to posts
 122          * that are posted by friend Sones of the given Sone are retained; all other
 123          * replies are removed.
 124          *
 125          * @param newReplyNotification
 126          *            The new-reply notification
 127          * @param currentSone
 128          *            The current Sone, or {@code null} if not logged in
 129          * @return The filtered new-reply notification, or {@code null} if the
 130          *         notification should be removed
 131          */
 132         public static ListNotification<Reply> filterNewReplyNotification(ListNotification<Reply> newReplyNotification, Sone currentSone) {
 133                 if (currentSone == null) {
 134                         return null;
 135                 }
 136                 List<Reply> newReplies = new ArrayList<Reply>();
 137                 for (Reply reply : newReplyNotification.getElements()) {
 138                         if (isReplyVisible(currentSone, reply)) {
 139                                 newReplies.add(reply);
 140                         }
 141                 }
 142                 if (newReplies.isEmpty()) {
 143                         return null;
 144                 }
 145                 if (newReplies.size() == newReplyNotification.getElements().size()) {
 146                         return newReplyNotification;
 147                 }
 148                 ListNotification<Reply> filteredNotification = new ListNotification<Reply>(newReplyNotification);
 149                 filteredNotification.setElements(newReplies);
 150                 filteredNotification.setLastUpdateTime(newReplyNotification.getLastUpdatedTime());
 151                 return filteredNotification;
 152         }
 153
 154         /**
 155          * Checks whether a post is visible to the given Sone. A post is not
 156          * considered visible if one of the following statements is true:
 157          * <ul>
 158          * <li>The post does not have a Sone.</li>
 159          * <li>The post’s {@link Post#getTime() time} is in the future.</li>
 160          * </ul>
 161          * <p>
 162          * If {@code post} is not {@code null} more checks are performed, and the
 163          * post will be invisible if:
 164          * </p>
 165          * <ul>
 166          * <li>The Sone of the post is not the given Sone, the given Sone does not
 167          * follow the post’s Sone, and the given Sone is not the recipient of the
 168          * post.</li>
 169          * <li>The trust relationship between the two Sones can not be retrieved.</li>
 170          * <li>The given Sone has explicitely assigned negative trust to the post’s
 171          * Sone.</li>
 172          * <li>The given Sone has not explicitely assigned negative trust to the
 173          * post’s Sone but the implicit trust is negative.</li>
 174          * </ul>
 175          * If none of these statements is true the post is considered visible.
 176          *
 177          * @param sone
 178          *            The Sone that checks for a post’s visibility (may be
 179          *            {@code null} to skip Sone-specific checks, such as trust)
 180          * @param post
 181          *            The post to check for visibility
 182          * @return {@code true} if the post is considered visible, {@code false}
 183          *         otherwise
 184          */
 185         public static boolean isPostVisible(Sone sone, Post post) {
 186                 Validation.begin().isNotNull("Post", post).check();
 187                 Sone postSone = post.getSone();
 188                 if (postSone == null) {
 189                         return false;
 190                 }
 191                 if (sone != null) {
 192                         Trust trust = postSone.getIdentity().getTrust((OwnIdentity) sone.getIdentity());
 193                         if (trust != null) {
 194                                 if ((trust.getExplicit() != null) && (trust.getExplicit() < 0)) {
 195                                         return false;
 196                                 }
 197                                 if ((trust.getExplicit() == null) && (trust.getImplicit() != null) && (trust.getImplicit() < 0)) {
 198                                         return false;
 199                                 }
 200                         } else {
 201                                 return false;
 202                         }
 203                         if ((!postSone.equals(sone)) && !sone.hasFriend(postSone.getId()) && !sone.equals(post.getRecipient())) {
 204                                 return false;
 205                         }
 206                 }
 207                 if (post.getTime() > System.currentTimeMillis()) {
 208                         return false;
 209                 }
 210                 return true;
 211         }
 212
 213         /**
 214          * Checks whether a reply is visible to the given Sone. A reply is not
 215          * considered visible if one of the following statements is true:
 216          * <ul>
 217          * <li>The reply does not have a post.</li>
 218          * <li>The reply’s post does not have a Sone.</li>
 219          * <li>The Sone of the reply’s post is not the given Sone, the given Sone
 220          * does not follow the reply’s post’s Sone, and the given Sone is not the
 221          * recipient of the reply’s post.</li>
 222          * <li>The trust relationship between the two Sones can not be retrieved.</li>
 223          * <li>The given Sone has explicitely assigned negative trust to the post’s
 224          * Sone.</li>
 225          * <li>The given Sone has not explicitely assigned negative trust to the
 226          * reply’s post’s Sone but the implicit trust is negative.</li>
 227          * <li>The reply’s post’s {@link Post#getTime() time} is in the future.</li>
 228          * <li>The reply’s {@link Reply#getTime() time} is in the future.</li>
 229          * </ul>
 230          * If none of these statements is true the reply is considered visible.
 231          *
 232          * @param sone
 233          *            The Sone that checks for a post’s visibility (may be
 234          *            {@code null} to skip Sone-specific checks, such as trust)
 235          * @param reply
 236          *            The reply to check for visibility
 237          * @return {@code true} if the reply is considered visible, {@code false}
 238          *         otherwise
 239          */
 240         public static boolean isReplyVisible(Sone sone, Reply reply) {
 241                 Validation.begin().isNotNull("Reply", reply).check();
 242                 Post post = reply.getPost();
 243                 if (post == null) {
 244                         return false;
 245                 }
 246                 if (!isPostVisible(sone, post)) {
 247                         return false;
 248                 }
 249                 if (reply.getTime() > System.currentTimeMillis()) {
 250                         return false;
 251                 }
 252                 return true;
 253         }
 254
 255 }