Changeset 13383

Timestamp:

12/14/2022 09:42:06 PM (2 years ago)

Author:

imath

Message:

Improve consistency between private message status & notification

A private message can have a status set to read or unread by the user. When the Notifications component is active, a notification is generated each time a message is sent. When the user opens this message, 2 actions are performed:

1. Set the message status as read.
2. Mark the notification about this message as read.

When opening a message, even if the message has a read status, we still need to check if there's an existing notification about it as notifications can be marked unread from the user's notifications screen. If it's the case, then we need to make sure to mark this unread notification as read 🤪.

Props niftythree

Closes ​https://github.com/buddypress/buddypress/pull/43
See #8778 (trunk)

Location:

trunk/src/bp-messages

Files:

• actions/view.php (modified) (1 diff)
• bp-messages-notifications.php (modified) (2 diffs)

trunk/src/bp-messages/actions/view.php

@@ -54 +54 @@
      */
     if ( bp_is_my_profile() ) {
+        // This is marking the messages as read inside the BP Messages component's recipient table.
         messages_mark_thread_read( $thread_id );
     }

trunk/src/bp-messages/bp-messages-notifications.php

@@ -262 +262 @@
  * @param int $user_id   ID of the user who read the thread.
  * @param int $num_rows  The number of affected rows by the "mark read" update query.
+ * @return bool True on success. False otherwise.
  */
 function bp_messages_mark_notification_on_mark_thread( $thread_id, $user_id = 0, $num_rows = 0 ) {
+    $unread_messages = array();
+
     if ( ! $num_rows ) {
-        return;
+        /**
+         * The thread might have been marked read, but a notification about the thread might also have been
+         * marked back as unread from the BP Notifications screen. We then need to check a notification exists
+         * about `new_message` action before checking found message ids are part of the thread.
+         *
+         * @see https://buddypress.trac.wordpress.org/ticket/8778
+         */
+        $notifications = bp_notifications_get_all_notifications_for_user( $user_id );
+        if ( $notifications ) {
+            $unread_messages = wp_filter_object_list(
+                $notifications,
+                array(
+                    'component_action' => 'new_message',
+                    'is_new'           => 1,
+                ),
+                'and',
+                'item_id'
+            );
+
+            $num_rows = count( $unread_messages );
+            if ( $num_rows ) {
+                $unread_messages = array_map( 'intval', $unread_messages );
+            } else {
+                return false;
+            }
+        }
     }
 
@@ -271 +299 @@
     $message_ids     = wp_list_pluck( $thread_messages, 'id' );
 
-    bp_notifications_mark_notifications_by_item_ids( $user_id, $message_ids, 'messages', 'new_message', false );
+    if ( $unread_messages && ! array_intersect( $message_ids, $unread_messages ) ) {
+        return false;
+    }
+
+    return bp_notifications_mark_notifications_by_item_ids( $user_id, $message_ids, 'messages', 'new_message', false );
 }
 add_action( 'messages_thread_mark_as_read', 'bp_messages_mark_notification_on_mark_thread', 10, 3 );