2 * Sone - ListNotificationFilters.java - Copyright © 2010 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.notify;
20 import java.util.ArrayList;
21 import java.util.Collection;
22 import java.util.List;
24 import net.pterodactylus.sone.data.Post;
25 import net.pterodactylus.sone.data.PostReply;
26 import net.pterodactylus.sone.data.Reply;
27 import net.pterodactylus.sone.data.Sone;
28 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
29 import net.pterodactylus.sone.freenet.wot.Trust;
30 import net.pterodactylus.util.notify.Notification;
31 import net.pterodactylus.util.validation.Validation;
34 * Filter for {@link ListNotification}s.
36 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
38 public class ListNotificationFilters {
41 * Filters new-post and new-reply notifications in the given list of
42 * notifications. If {@code currentSone} is <code>null</code>, new-post and
43 * new-reply notifications are removed completely. If {@code currentSone} is
44 * not {@code null}, only posts that are posted by a friend Sone or the Sone
45 * itself, and replies that are replies to posts of friend Sones or the Sone
46 * itself will be retained in the notifications.
48 * @param notifications
49 * The notifications to filter
51 * The current Sone, or {@code null} if not logged in
52 * @return The filtered notifications
54 @SuppressWarnings("unchecked")
55 public static List<Notification> filterNotifications(Collection<? extends Notification> notifications, Sone currentSone) {
56 List<Notification> filteredNotifications = new ArrayList<Notification>();
57 for (Notification notification : notifications) {
58 if (notification.getId().equals("new-post-notification")) {
59 ListNotification<Post> filteredNotification = filterNewPostNotification((ListNotification<Post>) notification, currentSone, true);
60 if (filteredNotification != null) {
61 filteredNotifications.add(filteredNotification);
63 } else if (notification.getId().equals("new-reply-notification")) {
64 ListNotification<PostReply> filteredNotification = filterNewReplyNotification((ListNotification<PostReply>) notification, currentSone);
65 if (filteredNotification != null) {
66 filteredNotifications.add(filteredNotification);
68 } else if (notification.getId().equals("mention-notification")) {
69 ListNotification<Post> filteredNotification = filterNewPostNotification((ListNotification<Post>) notification, null, false);
70 if (filteredNotification != null) {
71 filteredNotifications.add(filteredNotification);
74 filteredNotifications.add(notification);
77 return filteredNotifications;
81 * Filters the new posts of the given notification. If {@code currentSone}
82 * is {@code null} and {@code soneRequired} is {@code true}, {@code null} is
83 * returned and the notification is subsequently removed. Otherwise only
84 * posts that are posted by friend Sones of the given Sone are retained; all
85 * other posts are removed.
87 * @param newPostNotification
88 * The new-post notification
90 * The current Sone, or {@code null} if not logged in
92 * Whether a non-{@code null} Sone in {@code currentSone} is
94 * @return The filtered new-post notification, or {@code null} if the
95 * notification should be removed
97 public static ListNotification<Post> filterNewPostNotification(ListNotification<Post> newPostNotification, Sone currentSone, boolean soneRequired) {
98 if (soneRequired && (currentSone == null)) {
101 List<Post> newPosts = new ArrayList<Post>();
102 for (Post post : newPostNotification.getElements()) {
103 if (isPostVisible(currentSone, post)) {
107 if (newPosts.isEmpty()) {
110 if (newPosts.size() == newPostNotification.getElements().size()) {
111 return newPostNotification;
113 ListNotification<Post> filteredNotification = new ListNotification<Post>(newPostNotification);
114 filteredNotification.setElements(newPosts);
115 filteredNotification.setLastUpdateTime(newPostNotification.getLastUpdatedTime());
116 return filteredNotification;
120 * Filters the new replies of the given notification. If {@code currentSone}
121 * is {@code null}, {@code null} is returned and the notification is
122 * subsequently removed. Otherwise only replies that are replies to posts
123 * that are posted by friend Sones of the given Sone are retained; all other
124 * replies are removed.
126 * @param newReplyNotification
127 * The new-reply notification
129 * The current Sone, or {@code null} if not logged in
130 * @return The filtered new-reply notification, or {@code null} if the
131 * notification should be removed
133 public static ListNotification<PostReply> filterNewReplyNotification(ListNotification<PostReply> newReplyNotification, Sone currentSone) {
134 if (currentSone == null) {
137 List<PostReply> newReplies = new ArrayList<PostReply>();
138 for (PostReply reply : newReplyNotification.getElements()) {
139 if (isReplyVisible(currentSone, reply)) {
140 newReplies.add(reply);
143 if (newReplies.isEmpty()) {
146 if (newReplies.size() == newReplyNotification.getElements().size()) {
147 return newReplyNotification;
149 ListNotification<PostReply> filteredNotification = new ListNotification<PostReply>(newReplyNotification);
150 filteredNotification.setElements(newReplies);
151 filteredNotification.setLastUpdateTime(newReplyNotification.getLastUpdatedTime());
152 return filteredNotification;
156 * Checks whether a post is visible to the given Sone. A post is not
157 * considered visible if one of the following statements is true:
159 * <li>The post does not have a Sone.</li>
160 * <li>The post’s {@link Post#getTime() time} is in the future.</li>
163 * If {@code post} is not {@code null} more checks are performed, and the
164 * post will be invisible if:
167 * <li>The Sone of the post is not the given Sone, the given Sone does not
168 * follow the post’s Sone, and the given Sone is not the recipient of the
170 * <li>The trust relationship between the two Sones can not be retrieved.</li>
171 * <li>The given Sone has explicitely assigned negative trust to the post’s
173 * <li>The given Sone has not explicitely assigned negative trust to the
174 * post’s Sone but the implicit trust is negative.</li>
176 * If none of these statements is true the post is considered visible.
179 * The Sone that checks for a post’s visibility (may be
180 * {@code null} to skip Sone-specific checks, such as trust)
182 * The post to check for visibility
183 * @return {@code true} if the post is considered visible, {@code false}
186 public static boolean isPostVisible(Sone sone, Post post) {
187 Validation.begin().isNotNull("Post", post).check();
188 Sone postSone = post.getSone();
189 if (postSone == null) {
193 Trust trust = postSone.getIdentity().getTrust((OwnIdentity) sone.getIdentity());
195 if ((trust.getExplicit() != null) && (trust.getExplicit() < 0)) {
198 if ((trust.getExplicit() == null) && (trust.getImplicit() != null) && (trust.getImplicit() < 0)) {
204 if ((!postSone.equals(sone)) && !sone.hasFriend(postSone.getId()) && !sone.equals(post.getRecipient())) {
208 if (post.getTime() > System.currentTimeMillis()) {
215 * Checks whether a reply is visible to the given Sone. A reply is not
216 * considered visible if one of the following statements is true:
218 * <li>The reply does not have a post.</li>
219 * <li>The reply’s post does not have a Sone.</li>
220 * <li>The Sone of the reply’s post is not the given Sone, the given Sone
221 * does not follow the reply’s post’s Sone, and the given Sone is not the
222 * recipient of the reply’s post.</li>
223 * <li>The trust relationship between the two Sones can not be retrieved.</li>
224 * <li>The given Sone has explicitely assigned negative trust to the post’s
226 * <li>The given Sone has not explicitely assigned negative trust to the
227 * reply’s post’s Sone but the implicit trust is negative.</li>
228 * <li>The reply’s post’s {@link Post#getTime() time} is in the future.</li>
229 * <li>The reply’s {@link Reply#getTime() time} is in the future.</li>
231 * If none of these statements is true the reply is considered visible.
234 * The Sone that checks for a post’s visibility (may be
235 * {@code null} to skip Sone-specific checks, such as trust)
237 * The reply to check for visibility
238 * @return {@code true} if the reply is considered visible, {@code false}
241 public static boolean isReplyVisible(Sone sone, PostReply reply) {
242 Validation.begin().isNotNull("Reply", reply).check();
243 Post post = reply.getPost();
247 if (!isPostVisible(sone, post)) {
250 if (reply.getTime() > System.currentTimeMillis()) {