Changeset 7832

Timestamp:

02/08/2014 06:26:52 PM (11 years ago)

Author:

boonebgorges

Message:

Improve logic for marking at-mention notifications as read

In previous iterations, at-mention notifications were marked as read in the
following cases:

• when a user visited his own activity page
• when a user visited his own mention page
• when a user visited a single-activity permalink page

When the new notifications component was introduced in BP 1.9, the old
notification functions were swapped out one-for-one with the new correlates.
However, this introduced a bug where a logged-out user visiting one of the
pages listed above would mark at-mention items as read for *all* users (due to
the user_id field being null, and the user_id WHERE clause being excluded from
the UPDATE query).

We take this bug as an opportunity to narrow the circumstances in which
at-mention notifications are marked as read. The new system:

• When a user visits his own mention page, mark all his at-mention notifications as read
• When a user visits the permalink page of a single activity item in which he is mentioned, mark that specific at-mention notification as read

Fixes #5384

Props SlothLoveChunk for an initial patch

Location:

branches/1.9

Files:

• bp-activity/bp-activity-notifications.php (modified) (2 diffs)
• tests/testcases/activity/notifications.php (added)

branches/1.9/bp-activity/bp-activity-notifications.php

@@ -337 +337 @@
 
 /**
- * Remove activity notifications when a user clicks on them.
+ * Mark at-mention notifications as read when users visit their Mentions page.
  *
  * @since BuddyPress (1.5)
@@ -344 +344 @@
  */
 function bp_activity_remove_screen_notifications() {
-    if ( bp_is_active( 'notifications' ) ) {
-        bp_notifications_mark_notifications_by_type( bp_loggedin_user_id(), buddypress()->activity->id, 'new_at_mention' );
-    }
-}
-add_action( 'bp_activity_screen_my_activity',               'bp_activity_remove_screen_notifications' );
-add_action( 'bp_activity_screen_single_activity_permalink', 'bp_activity_remove_screen_notifications' );
-add_action( 'bp_activity_screen_mentions',                  'bp_activity_remove_screen_notifications' );
-
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return;
+    }
+
+    // Only mark read if you're looking at your own mentions
+    if ( ! bp_is_my_profile() ) {
+        return;
+    }
+
+    bp_notifications_mark_notifications_by_type( bp_loggedin_user_id(), buddypress()->activity->id, 'new_at_mention' );
+}
+add_action( 'bp_activity_screen_mentions', 'bp_activity_remove_screen_notifications' );
+
+/**
+ * Mark at-mention notification as read when user visits the activity with the mention.
+ *
+ * @since BuddyPress (2.0.0)
+ */
+function bp_activity_remove_screen_notifications_single_activity_permalink( $activity ) {
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return;
+    }
+
+    if ( ! is_user_logged_in() ) {
+        return;
+    }
+
+    // Mark as read any notifications for the current user related to this
+    // activity item
+    bp_notifications_mark_notifications_by_item_id( bp_loggedin_user_id(), $activity->id, buddypress()->activity->id, 'new_at_mention' );
+}
+add_action( 'bp_activity_screen_single_activity_permalink', 'bp_activity_remove_screen_notifications_single_activity_permalink' );
+