Changeset 4738

Timestamp:

07/20/2011 11:29:25 PM (13 years ago)

Author:

boonebgorges

Message:

Fixes at-mentions so that they are turned into links in contexts other than activity updates. Fixes #3363. Deprecates groups_at_mention_notification() in favor of bp_activity_at_message_notification(). Reconfigures at-mention notification so that BP notifications and email notifications are receieved for a wider variety of activity item types.

Location:

trunk

Files:

• bp-activity/bp-activity-filters.php (modified) (3 diffs)
• bp-activity/bp-activity-notifications.php (modified) (2 diffs)
• bp-core/deprecated/1.3.php (modified) (1 diff)
• bp-groups/bp-groups-notifications.php (modified) (1 diff)

trunk/bp-activity/bp-activity-filters.php

@@ -72 +72 @@
 add_filter( 'bp_get_activity_feed_item_description', 'bp_activity_make_nofollow_filter' );
 
-add_filter( 'bp_get_activity_parent_content', 'bp_create_excerpt' );
+add_filter( 'pre_comment_content',                   'bp_activity_at_name_filter' ); 
+add_filter( 'group_forum_topic_text_before_save',    'bp_activity_at_name_filter' ); 
+add_filter( 'group_forum_post_text_before_save',     'bp_activity_at_name_filter' ); 
+
+add_filter( 'bp_get_activity_parent_content',        'bp_create_excerpt' );
 
 function bp_activity_filter_kses( $content ) {
@@ -102 +106 @@
 
 /**
- * bp_activity_at_name_filter()
- *
- * Finds and links @-mentioned users in activity updates
+ * Finds and links @-mentioned users in the contents of activity items
  *
  * @package BuddyPress Activity
  *
  * @param string $content The activity content
+ * @param int $activity_id When $adjust_mention_count is true, you must provide an $activity_id, 
+ *   which will be added to the list of the user's unread mentions
  */
-function bp_activity_at_name_filter( $activity ) {
-    // Only run this function once for a given activity item
-    remove_filter( 'bp_activity_after_save', 'bp_activity_at_name_filter' );
-
-    $content = $activity->content;
-
+function bp_activity_at_name_filter( $content, $activity_id = 0 ) {
     $usernames = bp_activity_find_mentions( $content );
 
@@ -127 +126 @@
             continue;
 
-        // Increase the number of new @ mentions for the user
-        bp_activity_adjust_mention_count( $activity->id, 'add' );
+        // If an activity_id is provided, we can send email and BP notifications
+        if ( $activity_id ) {
+            bp_activity_at_message_notification( $activity_id, $user_id );
+        }
 
         $content = preg_replace( '/(@' . $username . '\b)/', "<a href='" . bp_core_get_user_domain( $user_id ) . "' rel='nofollow'>@$username</a>", $content );
     }
 
-    // Resave the activity item with the linked usernames
-    $activity->content = $content;
+    // Adjust the activity count for this item  
+    if ( $activity_id )
+        bp_activity_adjust_mention_count( $activity_id, 'add' );
+
+    return $content;
+} 
+
+/**
+ * Catch mentions in saved activity items
+ *
+ * @package BuddyPress
+ * @since 1.3
+ *
+ * @param obj $activity
+ */
+function bp_activity_at_name_filter_updates( $activity ) {
+    // Only run this function once for a given activity item
+    remove_filter( 'bp_activity_after_save', 'bp_activity_at_name_filter_updates' );
+    
+    // Run the content through the linking filter, making sure to increment mention count
+    $activity->content = bp_activity_at_name_filter( $activity->content, $activity->id );
+    
+    // Resave the activity with the new content
     $activity->save();
 }
-add_filter( 'bp_activity_after_save', 'bp_activity_at_name_filter' );
+add_filter( 'bp_activity_after_save', 'bp_activity_at_name_filter_updates' );
 
 function bp_activity_make_nofollow_filter( $text ) {

trunk/bp-activity/bp-activity-notifications.php

@@ -9 +9 @@
  * @param int $activity_id The id of the activity update
  */
-function bp_activity_at_message_notification( $content, $poster_user_id, $activity_id ) {
+function bp_activity_at_message_notification( $activity_id, $receiver_user_id ) {
     global $bp;
 
-    /* Scan for @username strings in an activity update. Notify each user. */
-    $pattern = '/[@]+([A-Za-z0-9-_\.@]+)/';
-    preg_match_all( $pattern, $content, $usernames );
+    $activity = new BP_Activity_Activity( $activity_id );
 
-    /* Make sure there's only one instance of each username */
-    if ( !$usernames = array_unique( $usernames[1] ) )
-        return false;
+    $subject = '';
+    $message = '';
+    
+    // Add the BP notification
+    bp_core_add_notification( $activity_id, $receiver_user_id, 'activity', 'new_at_mention', $activity->user_id );
+            
+    // 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 ) ) {
+        $poster_name = bp_core_get_user_displayname( $activity->user_id );
 
-    foreach( (array)$usernames as $username ) {
-        if ( bp_is_username_compatibility_mode() )
-            $receiver_user_id = bp_core_get_userid( $username );
-        else
-            $receiver_user_id = bp_core_get_userid_from_nicename( $username );
+        $message_link = bp_activity_get_permalink( $activity_id );
+        $settings_link = bp_core_get_user_domain( $receiver_user_id ) . bp_get_settings_slug() . '/notifications/';
 
-        if ( empty( $receiver_user_id ) )
-            continue;
+        $poster_name = stripslashes( $poster_name );
+        $content = bp_activity_filter_kses( strip_tags( stripslashes( $activity->content ) ) );
 
-        bp_core_add_notification( $activity_id, $receiver_user_id, 'activity', 'new_at_mention', $poster_user_id );
+        // Set up and send the message
+        $ud       = bp_core_get_core_userdata( $receiver_user_id );
+        $to       = $ud->user_email;
+        $sitename = wp_specialchars_decode( get_blog_option( bp_get_root_blog_id(), 'blogname' ), ENT_QUOTES );
+        $subject  = '[' . $sitename . '] ' . sprintf( __( '%s mentioned you in an update', 'buddypress' ), $poster_name );
 
-        $subject = '';
-        $message = '';
+        if ( bp_is_active( 'groups' ) && bp_is_group() ) {
+            $message = sprintf( __(
+'%1$s mentioned you in the group "%2$s":
 
-        // 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 ) ) {
-            $poster_name = bp_core_get_user_displayname( $poster_user_id );
+"%3$s"
 
-            $message_link = bp_activity_get_permalink( $activity_id );
-            $settings_link = bp_core_get_user_domain( $receiver_user_id ) . bp_get_settings_slug() . '/notifications/';
+To view and respond to the message, log in and visit: %4$s
 
-            $poster_name = stripslashes( $poster_name );
-            $content = bp_activity_filter_kses( stripslashes($content) );
-
-            // Set up and send the message
-            $ud       = bp_core_get_core_userdata( $receiver_user_id );
-            $to       = $ud->user_email;
-            $sitename = wp_specialchars_decode( get_blog_option( bp_get_root_blog_id(), 'blogname' ), ENT_QUOTES );
-            $subject  = '[' . $sitename . '] ' . sprintf( __( '%s mentioned you in an update', 'buddypress' ), $poster_name );
-
-$message = sprintf( __(
+---------------------
+', 'buddypress' ), $poster_name, bp_get_current_group_name(), $content, $message_link );
+        } else {
+            $message = sprintf( __(
 '%1$s mentioned you in an update:
 
@@ -59 +56 @@
 ---------------------
 ', 'buddypress' ), $poster_name, $content, $message_link );
+        }
 
-            $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );
+        $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );
 
-            /* Send the message */
-            $to = apply_filters( 'bp_activity_at_message_notification_to', $to );
-            $subject = apply_filters( 'bp_activity_at_message_notification_subject', $subject, $poster_name );
-            $message = apply_filters( 'bp_activity_at_message_notification_message', $message, $poster_name, $content, $message_link, $settings_link );
+        /* Send the message */
+        $to      = apply_filters( 'bp_activity_at_message_notification_to', $to );
+        $subject = apply_filters( 'bp_activity_at_message_notification_subject', $subject, $poster_name );
+        $message = apply_filters( 'bp_activity_at_message_notification_message', $message, $poster_name, $content, $message_link, $settings_link );
 
-            wp_mail( $to, $subject, $message );
-        }
-        
-        do_action( 'bp_activity_sent_mention_email', $usernames, $subject, $message, $content, $poster_user_id, $activity_id );
+        wp_mail( $to, $subject, $message );
     }
+    
+    do_action( 'bp_activity_sent_mention_email', $activity, $subject, $message, $content );
 }
-add_action( 'bp_activity_posted_update', 'bp_activity_at_message_notification', 10, 3 );
 
 function bp_activity_new_comment_notification( $comment_id, $commenter_id, $params ) {

trunk/bp-core/deprecated/1.3.php

@@ -250 +250 @@
 }
 
+/**
+ * Send an email and a BP notification on receipt of an @-mention in a group
+ *
+ * @deprecated 1.3
+ * @deprecated Deprecated in favor of the more general bp_activity_at_message_notification()
+ */
+function groups_at_message_notification( $content, $poster_user_id, $group_id, $activity_id ) {
+    global $bp;
+    
+    _deprecated_function( __FUNCTION__, '1.3', 'bp_activity_at_message_notification()' );
+
+    /* Scan for @username strings in an activity update. Notify each user. */
+    $pattern = '/[@]+([A-Za-z0-9-_\.@]+)/';
+    preg_match_all( $pattern, $content, $usernames );
+
+    /* Make sure there's only one instance of each username */
+    if ( !$usernames = array_unique( $usernames[1] ) )
+        return false;
+
+    $group = new BP_Groups_Group( $group_id );
+
+    foreach( (array)$usernames as $username ) {
+        if ( !$receiver_user_id = bp_core_get_userid( $username ) )
+            continue;
+
+        /* Check the user is a member of the group before sending the update. */
+        if ( !groups_is_user_member( $receiver_user_id, $group_id ) )
+            continue;
+
+        // 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 ) ) {
+            $poster_name = bp_core_get_user_displayname( $poster_user_id );
+
+            $message_link = bp_activity_get_permalink( $activity_id );
+            $settings_link = bp_core_get_user_domain( $receiver_user_id ) . bp_get_settings_slug() . '/notifications/';
+
+            $poster_name = stripslashes( $poster_name );
+            $content = bp_groups_filter_kses( stripslashes( $content ) );
+
+            // Set up and send the message
+            $ud = bp_core_get_core_userdata( $receiver_user_id );
+            $to = $ud->user_email;
+            $sitename = wp_specialchars_decode( get_blog_option( bp_get_root_blog_id(), 'blogname' ), ENT_QUOTES );
+            $subject  = '[' . $sitename . '] ' . sprintf( __( '%1$s mentioned you in the group "%2$s"', 'buddypress' ), $poster_name, $group->name );
+
+$message = sprintf( __(
+'%1$s mentioned you in the group "%2$s":
+
+"%3$s"
+
+To view and respond to the message, log in and visit: %4$s
+
+---------------------
+', 'buddypress' ), $poster_name, $group->name, $content, $message_link );
+
+            $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );
+
+            /* Send the message */
+            $to = apply_filters( 'groups_at_message_notification_to', $to );
+            $subject = apply_filters( 'groups_at_message_notification_subject', $subject, $group, $poster_name );
+            $message = apply_filters( 'groups_at_message_notification_message', $message, $group, $poster_name, $content, $message_link, $settings_link );
+
+            wp_mail( $to, $subject, $message );
+        }
+    }
+
+    do_action( 'bp_groups_sent_mention_email', $usernames, $subject, $message, $content, $poster_user_id, $group_id, $activity_id );
+}
 
 /** Theme *********************************************************************/

trunk/bp-groups/bp-groups-notifications.php

@@ -250 +250 @@
 }
 
-function groups_at_message_notification( $content, $poster_user_id, $group_id, $activity_id ) {
-    global $bp;
-
-    /* Scan for @username strings in an activity update. Notify each user. */
-    $pattern = '/[@]+([A-Za-z0-9-_\.@]+)/';
-    preg_match_all( $pattern, $content, $usernames );
-
-    /* Make sure there's only one instance of each username */
-    if ( !$usernames = array_unique( $usernames[1] ) )
-        return false;
-
-    $group = new BP_Groups_Group( $group_id );
-
-    foreach( (array)$usernames as $username ) {
-        if ( !$receiver_user_id = bp_core_get_userid( $username ) )
-            continue;
-
-        /* Check the user is a member of the group before sending the update. */
-        if ( !groups_is_user_member( $receiver_user_id, $group_id ) )
-            continue;
-
-        // Now email the user with the contents of the message (if they have enabled email notifications)
-        if ( 'no' != bp_get_user_meta( $user_id, 'notification_activity_new_mention', true ) ) {
-            $poster_name = bp_core_get_user_displayname( $poster_user_id );
-
-            $message_link = bp_activity_get_permalink( $activity_id );
-            $settings_link = bp_core_get_user_domain( $receiver_user_id ) . bp_get_settings_slug() . '/notifications/';
-
-            $poster_name = stripslashes( $poster_name );
-            $content = bp_groups_filter_kses( stripslashes( $content ) );
-
-            // Set up and send the message
-            $ud = bp_core_get_core_userdata( $receiver_user_id );
-            $to = $ud->user_email;
-            $sitename = wp_specialchars_decode( get_blog_option( bp_get_root_blog_id(), 'blogname' ), ENT_QUOTES );
-            $subject  = '[' . $sitename . '] ' . sprintf( __( '%1$s mentioned you in the group "%2$s"', 'buddypress' ), $poster_name, $group->name );
-
-$message = sprintf( __(
-'%1$s mentioned you in the group "%2$s":
-
-"%3$s"
-
-To view and respond to the message, log in and visit: %4$s
-
----------------------
-', 'buddypress' ), $poster_name, $group->name, $content, $message_link );
-
-            $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );
-
-            /* Send the message */
-            $to = apply_filters( 'groups_at_message_notification_to', $to );
-            $subject = apply_filters( 'groups_at_message_notification_subject', $subject, $group, $poster_name );
-            $message = apply_filters( 'groups_at_message_notification_message', $message, $group, $poster_name, $content, $message_link, $settings_link );
-
-            wp_mail( $to, $subject, $message );
-        }
-    }
-
-    do_action( 'bp_groups_sent_mention_email', $usernames, $subject, $message, $content, $poster_user_id, $group_id, $activity_id );
-}
-add_action( 'bp_groups_posted_update', 'groups_at_message_notification', 10, 4 );
-
-
 ?>