Changeset 11022 for trunk/src/bp-activity/bp-activity-functions.php

Timestamp:

08/22/2016 08:46:36 PM (8 years ago)

Author:

r-a-y

Message:

Load all notification-related code conditionally for each component.

If the notifications component isn't active, there is no need to load all
notification code.

See #6712.

File:

• trunk/src/bp-activity/bp-activity-functions.php (modified) (1 diff)

trunk/src/bp-activity/bp-activity-functions.php

@@ -3418 +3418 @@
 }
 
+/* Emails *********************************************************************/
+
+/**
+ * Send email and BP notifications when a user is mentioned in an update.
+ *
+ * @since 1.2.0
+ *
+ * @param int $activity_id      The ID of the activity update.
+ * @param int $receiver_user_id The ID of the user who is receiving the update.
+ */
+function bp_activity_at_message_notification( $activity_id, $receiver_user_id ) {
+    $notifications = BP_Core_Notification::get_all_for_user( $receiver_user_id, 'all' );
+
+    // Don't leave multiple notifications for the same activity item.
+    foreach( $notifications as $notification ) {
+        if ( $activity_id == $notification->item_id ) {
+            return;
+        }
+    }
+
+    $activity     = new BP_Activity_Activity( $activity_id );
+    $email_type   = 'activity-at-message';
+    $group_name   = '';
+    $message_link = bp_activity_get_permalink( $activity_id );
+    $poster_name  = bp_core_get_user_displayname( $activity->user_id );
+
+    remove_filter( 'bp_get_activity_content_body', 'convert_smilies' );
+    remove_filter( 'bp_get_activity_content_body', 'wpautop' );
+    remove_filter( 'bp_get_activity_content_body', 'bp_activity_truncate_entry', 5 );
+
+    /** This filter is documented in bp-activity/bp-activity-template.php */
+    $content = apply_filters( 'bp_get_activity_content_body', $activity->content );
+
+    add_filter( 'bp_get_activity_content_body', 'convert_smilies' );
+    add_filter( 'bp_get_activity_content_body', 'wpautop' );
+    add_filter( 'bp_get_activity_content_body', 'bp_activity_truncate_entry', 5 );
+
+    // Now email the user with the contents of the message (if they have enabled email notifications).
+    if ( 'no' != bp_get_user_meta( $receiver_user_id, 'notification_activity_new_mention', true ) ) {
+        if ( bp_is_active( 'groups' ) && bp_is_group() ) {
+            $email_type = 'groups-at-message';
+            $group_name = bp_get_current_group_name();
+        }
+
+        $unsubscribe_args = array(
+            'user_id'           => $receiver_user_id,
+            'notification_type' => $email_type,
+        );
+
+        $args = array(
+            'tokens' => array(
+                'activity'         => $activity,
+                'usermessage'      => wp_strip_all_tags( $content ),
+                'group.name'       => $group_name,
+                'mentioned.url'    => $message_link,
+                'poster.name'      => $poster_name,
+                'receiver-user.id' => $receiver_user_id,
+                'unsubscribe'      => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
+            ),
+        );
+
+        bp_send_email( $email_type, $receiver_user_id, $args );
+    }
+
+    /**
+     * Fires after the sending of an @mention email notification.
+     *
+     * @since 1.5.0
+     * @since 2.5.0 $subject, $message, $content arguments unset and deprecated.
+     *
+     * @param BP_Activity_Activity $activity         Activity Item object.
+     * @param string               $deprecated       Removed in 2.5; now an empty string.
+     * @param string               $deprecated       Removed in 2.5; now an empty string.
+     * @param string               $deprecated       Removed in 2.5; now an empty string.
+     * @param int                  $receiver_user_id The ID of the user who is receiving the update.
+     */
+    do_action( 'bp_activity_sent_mention_email', $activity, '', '', '', $receiver_user_id );
+}
+
+/**
+ * Send email and BP notifications when an activity item receives a comment.
+ *
+ * @since 1.2.0
+ * @since 2.5.0 Updated to use new email APIs.
+ *
+ * @param int   $comment_id   The comment id.
+ * @param int   $commenter_id The ID of the user who posted the comment.
+ * @param array $params       {@link bp_activity_new_comment()}.
+ */
+function bp_activity_new_comment_notification( $comment_id = 0, $commenter_id = 0, $params = array() ) {
+    $original_activity = new BP_Activity_Activity( $params['activity_id'] );
+    $poster_name       = bp_core_get_user_displayname( $commenter_id );
+    $thread_link       = bp_activity_get_permalink( $params['activity_id'] );
+
+    remove_filter( 'bp_get_activity_content_body', 'convert_smilies' );
+    remove_filter( 'bp_get_activity_content_body', 'wpautop' );
+    remove_filter( 'bp_get_activity_content_body', 'bp_activity_truncate_entry', 5 );
+
+    /** This filter is documented in bp-activity/bp-activity-template.php */
+    $content = apply_filters( 'bp_get_activity_content_body', $params['content'] );
+
+    add_filter( 'bp_get_activity_content_body', 'convert_smilies' );
+    add_filter( 'bp_get_activity_content_body', 'wpautop' );
+    add_filter( 'bp_get_activity_content_body', 'bp_activity_truncate_entry', 5 );
+
+    if ( $original_activity->user_id != $commenter_id ) {
+
+        // Send an email if the user hasn't opted-out.
+        if ( 'no' != bp_get_user_meta( $original_activity->user_id, 'notification_activity_new_reply', true ) ) {
+
+            $unsubscribe_args = array(
+                'user_id'           => $original_activity->user_id,
+                'notification_type' => 'activity-comment',
+            );
+
+            $args = array(
+                'tokens' => array(
+                    'comment.id'                => $comment_id,
+                    'commenter.id'              => $commenter_id,
+                    'usermessage'               => wp_strip_all_tags( $content ),
+                    'original_activity.user_id' => $original_activity->user_id,
+                    'poster.name'               => $poster_name,
+                    'thread.url'                => esc_url( $thread_link ),
+                    'unsubscribe'               => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
+                ),
+            );
+
+            bp_send_email( 'activity-comment', $original_activity->user_id, $args );
+        }
+
+        /**
+         * Fires at the point that notifications should be sent for activity comments.
+         *
+         * @since 2.6.0
+         *
+         * @param BP_Activity_Activity $original_activity The original activity.
+         * @param int                  $comment_id        ID for the newly received comment.
+         * @param int                  $commenter_id      ID of the user who made the comment.
+         * @param array                $params            Arguments used with the original activity comment.
+         */
+        do_action( 'bp_activity_sent_reply_to_update_notification', $original_activity, $comment_id, $commenter_id, $params );
+    }
+
+
+    /*
+     * If this is a reply to another comment, send an email notification to the
+     * author of the immediate parent comment.
+     */
+    if ( empty( $params['parent_id'] ) || ( $params['activity_id'] == $params['parent_id'] ) ) {
+        return;
+    }
+
+    $parent_comment = new BP_Activity_Activity( $params['parent_id'] );
+
+    if ( $parent_comment->user_id != $commenter_id && $original_activity->user_id != $parent_comment->user_id ) {
+
+        // Send an email if the user hasn't opted-out.
+        if ( 'no' != bp_get_user_meta( $parent_comment->user_id, 'notification_activity_new_reply', true ) ) {
+
+            $unsubscribe_args = array(
+                'user_id'           => $parent_comment->user_id,
+                'notification_type' => 'activity-comment-author',
+            );
+
+            $args = array(
+                'tokens' => array(
+                    'comment.id'             => $comment_id,
+                    'commenter.id'           => $commenter_id,
+                    'usermessage'            => wp_strip_all_tags( $content ),
+                    'parent-comment-user.id' => $parent_comment->user_id,
+                    'poster.name'            => $poster_name,
+                    'thread.url'             => esc_url( $thread_link ),
+                    'unsubscribe'            => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
+                ),
+            );
+
+            bp_send_email( 'activity-comment-author', $parent_comment->user_id, $args );
+        }
+
+        /**
+         * Fires at the point that notifications should be sent for comments on activity replies.
+         *
+         * @since 2.6.0
+         *
+         * @param BP_Activity_Activity $parent_comment The parent activity.
+         * @param int                  $comment_id     ID for the newly received comment.
+         * @param int                  $commenter_id   ID of the user who made the comment.
+         * @param array                $params         Arguments used with the original activity comment.
+         */
+        do_action( 'bp_activity_sent_reply_to_reply_notification', $parent_comment, $comment_id, $commenter_id, $params );
+    }
+}
+
+/**
+ * Helper method to map action arguments to function parameters.
+ *
+ * @since 1.9.0
+ *
+ * @param int   $comment_id ID of the comment being notified about.
+ * @param array $params     Parameters to use with notification.
+ */
+function bp_activity_new_comment_notification_helper( $comment_id, $params ) {
+    bp_activity_new_comment_notification( $comment_id, $params['user_id'], $params );
+}
+add_action( 'bp_activity_comment_posted', 'bp_activity_new_comment_notification_helper', 10, 2 );
 
 /** Embeds *******************************************************************/