Changeset 7621

Timestamp:

11/30/2013 04:44:58 AM (11 years ago)

Author:

johnjamesjacoby

Message:

Refactor Messages component's approach to Notifications integration:

• Introduce helper functions for handling the adding/marking/deleting of notifications. Hook these new functions into their respective actions rather than have them hardcoded and interspersed amongst the first-class code.
• See #5266.

Location:

trunk/bp-messages

Files:

• bp-messages-functions.php (modified) (2 diffs)
• bp-messages-notifications.php (modified) (3 diffs)
• bp-messages-template.php (modified) (1 diff)

trunk/bp-messages/bp-messages-functions.php

@@ -115 +115 @@
 
     if ( $message->send() ) {
-
-        // Send screen notifications to the recipients
-        foreach ( (array) $message->recipients as $recipient ) {
-            bp_core_add_notification( $message->id, $recipient->user_id, 'messages', 'new_message', $message->sender_id );
-        }
-
-        // Send email notifications to the recipients
-        messages_notification_new_message( array( 'message_id' => $message->id, 'sender_id' => $message->sender_id, 'subject' => $message->subject, 'content' => $message->message, 'recipients' => $message->recipients, 'thread_id' => $message->thread_id) );
-
         do_action_ref_array( 'messages_message_sent', array( &$message ) );
 
@@ -224 +215 @@
     return BP_Messages_Thread::is_valid( $thread_id );
 }
-
-/**
- * Format the BuddyBar/Toolbar notifications for the Messages component
- *
- * @package BuddyPress
- *
- * @param string $action The kind of notification being rendered
- * @param int $item_id The primary item id
- * @param int $secondary_item_id The secondary item id
- * @param int $total_items The total number of messaging-related notifications waiting for the user
- * @param string $format 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar
- */
-function messages_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {
-
-    if ( 'new_message' == $action ) {
-        $link  = trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() . '/inbox' );
-        $title = __( 'Inbox', 'buddypress' );
-
-        if ( (int) $total_items > 1 ) {
-            $text   = sprintf( __('You have %d new messages', 'buddypress' ), (int) $total_items );
-            $filter = 'bp_messages_multiple_new_message_notification';
-        } else {
-            if ( !empty( $secondary_item_id ) ) {
-                $text = sprintf( __('You have %d new message from %s', 'buddypress' ), (int) $total_items, bp_core_get_user_displayname( $secondary_item_id ) );
-            } else {
-                $text = sprintf( __('You have %d new message',         'buddypress' ), (int) $total_items );
-            }
-            $filter = 'bp_messages_single_new_message_notification';
-        }
-    }
-
-    if ( 'string' == $format ) {
-        $return = apply_filters( $filter, '<a href="' . $link . '" title="' . $title . '">' . $text . '</a>', (int) $total_items, $text, $link, $item_id, $secondary_item_id );
-    } else {
-        $return = apply_filters( $filter, array(
-            'text' => $text,
-            'link' => $link
-        ), $link, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
-    }
-
-    do_action( 'messages_format_notifications', $action, $item_id, $secondary_item_id, $total_items );
-
-    return $return;
-}

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

@@ -8 +8 @@
  */
 
-
 // Exit if accessed directly
 if ( !defined( 'ABSPATH' ) ) exit;
 
+/** Email *********************************************************************/
+
+/**
+ * Email message recipients to alert them of a new unread private message
+ *
+ * @since BuddyPress (1.0)
+ * @param array $args
+ */
 function messages_notification_new_message( $args = array() ) {
+
+    // Cast possible $message object as an array
+    if ( is_object( $args ) ) {
+        $args = (array) $args;
+    }
 
     // These should be extracted below
     $recipients    = array();
     $email_subject = $email_content = '';
+    $sender_id     = 0;
 
+    // Barf
     extract( $args );
 
+    // Get the sender display name
     $sender_name = bp_core_get_user_displayname( $sender_id );
 
@@ -25 +40 @@
     if ( ! empty( $recipients ) ) {
 
-        foreach( $recipients as $recipient ) {
+        foreach ( $recipients as $recipient ) {
 
-            if ( $sender_id == $recipient->user_id || 'no' == bp_get_user_meta( $recipient->user_id, 'notification_messages_new_message', true ) )
+            if ( $sender_id == $recipient->user_id || 'no' == bp_get_user_meta( $recipient->user_id, 'notification_messages_new_message', true ) ) {
                 continue;
+            }
 
             // User data and links
-            $ud            = get_userdata( $recipient->user_id );
+            $ud = get_userdata( $recipient->user_id );
 
             // Bail if user cannot be found
-            if ( empty( $ud ) )
+            if ( empty( $ud ) ) {
                 continue;
+            }
 
             $message_link  = bp_core_get_user_domain( $recipient->user_id ) . bp_get_messages_slug() .'/';
@@ -78 +95 @@
     do_action( 'bp_messages_sent_notification_email', $recipients, $email_subject, $email_content, $args );
 }
+add_action( 'messages_message_sent', 'messages_notification_new_message', 10 );
+
+/** Notifications *************************************************************/
+
+/**
+ * Format the BuddyBar/Toolbar notifications for the Messages component
+ *
+ * @since BuddyPress (1.0)
+ * @param string $action The kind of notification being rendered
+ * @param int $item_id The primary item id
+ * @param int $secondary_item_id The secondary item id
+ * @param int $total_items The total number of messaging-related notifications waiting for the user
+ * @param string $format 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar
+ */
+function messages_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {
+
+    if ( 'new_message' === $action ) {
+        $link  = trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() . '/inbox' );
+        $title = __( 'Inbox', 'buddypress' );
+
+        if ( (int) $total_items > 1 ) {
+            $text   = sprintf( __('You have %d new messages', 'buddypress' ), (int) $total_items );
+            $filter = 'bp_messages_multiple_new_message_notification';
+        } else {
+            if ( !empty( $secondary_item_id ) ) {
+                $text = sprintf( __('You have %d new message from %s', 'buddypress' ), (int) $total_items, bp_core_get_user_displayname( $secondary_item_id ) );
+            } else {
+                $text = sprintf( __('You have %d new message',         'buddypress' ), (int) $total_items );
+            }
+            $filter = 'bp_messages_single_new_message_notification';
+        }
+    }
+
+    if ( 'string' === $format ) {
+        $return = apply_filters( $filter, '<a href="' . esc_url( $link ) . '" title="' . esc_attr( $title ) . '">' . esc_html( $text ) . '</a>', (int) $total_items, $text, $link, $item_id, $secondary_item_id );
+    } else {
+        $return = apply_filters( $filter, array(
+            'text' => $text,
+            'link' => $link
+        ), $link, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
+    }
+
+    do_action( 'messages_format_notifications', $action, $item_id, $secondary_item_id, $total_items );
+
+    return $return;
+}
+
+/**
+ * Send notifications to message recipients
+ *
+ * @since BuddyPress (1.9.0)
+ * @param obj $message
+ */
+function bp_messages_message_sent_add_notification( $message ) {
+    if ( bp_is_active( 'notifications' ) && ! empty( $message->recipients ) ) {
+        foreach ( (array) $message->recipients as $recipient ) {
+            bp_notifications_add_notification( array(
+                'user_id'           => $recipient->user_id,
+                'item_id'           => $message->id,
+                'secondary_item_id' => $message->sender_id,
+                'component_name'    => buddypress()->messages->id,
+                'component_action'  => 'new_message',
+                'date_notified'     => bp_core_current_time(),
+                'is_new'            => 1,
+            ) );
+        }
+    }
+}
+add_action( 'messages_message_sent', 'bp_messages_message_sent_add_notification', 10 );
+
+/**
+ * Mark new message notifications when member views their inbox.
+ *
+ * @since BuddyPress (1.9.0)
+ */
+function bp_messages_screen_inbox_mark_notifications() {
+    if ( bp_is_active( 'notifications' ) ) {
+        bp_notifications_mark_notifications_by_type( bp_loggedin_user_id(), buddypress()->messages->id, 'new_message' );
+    }
+}
+add_action( 'messages_screen_inbox', 'bp_messages_screen_inbox_mark_notifications', 10 );
+
+/**
+ * Mark new message notification when member reads a message thread directly.
+ *
+ * @since BuddyPress (1.9.0)
+ */
+function bp_messages_screen_conversation_mark_notifications() {
+    if ( bp_is_active( 'notifications' ) ) {
+        bp_notifications_mark_notifications_by_item_id( bp_loggedin_user_id(), (int) bp_action_variable( 0 ), buddypress()->messages->id, 'new_message' );
+    }
+}
+add_action( 'messages_screen_conversation', 'bp_messages_screen_inbox_mark_notifications', 10 );

trunk/bp-messages/bp-messages-template.php

@@ -185 +185 @@
         wp_redirect( bp_displayed_user_id() );
     } else {
-        if ( bp_is_current_action( 'inbox' ) ) {
-            bp_core_mark_notifications_by_type( bp_loggedin_user_id(), $bp->messages->id, 'new_message' );
-        }
-
         if ( bp_is_current_action( 'sentbox' ) ) {
             $box = 'sentbox';