Changeset 6649

Timestamp:

12/18/2012 12:18:32 AM (12 years ago)

Author:

r-a-y

Message:

Only fire the activity save hooks once. Fixes #3980.

Previously, bp_activity_at_name_filter_updates() would run the
BP_Activity_Activity::save() method again. So basically, all activity save
hooks would run twice; this caused problems for plugins that hooked into
any activity save hook as their code would run twice.

This commit changes the logic of how @mention activity items are linked and
sent so the activity save hooks are only run once.

bp_activity_at_name_filter_updates() now runs before an activity item is
saved and detects if @mentions are found. If @mentions exists, we add a
hook to send the emails after the activity item is saved -
bp_activity_at_name_send_emails().

Hat-tip boonebgorges for feedback.

For a full list of changes, view:
​https://buddypress.trac.wordpress.org/ticket/3980#comment:11

Location:

trunk/bp-activity

Files:

• bp-activity-filters.php (modified) (3 diffs)
• bp-activity-functions.php (modified) (3 diffs)

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

@@ -90 +90 @@
 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( 'the_content',               'bp_activity_at_name_filter' );
+add_filter( 'the_content',                           'bp_activity_at_name_filter' );
 
 add_filter( 'bp_get_activity_parent_content',        'bp_create_excerpt' );
@@ -100 +100 @@
 
 // At-name filter
-add_action( 'bp_activity_after_save', 'bp_activity_at_name_filter_updates' );
+add_action( 'bp_activity_before_save', 'bp_activity_at_name_filter_updates' );
 
 // Activity stream moderation
@@ -195 +195 @@
 
 /**
- * Finds and links @-mentioned users in the contents of activity items
+ * Finds and links @-mentioned users in the contents of a given item.
  *
  * @since BuddyPress (1.2)
  *
- * @param string $content The activity content
- * @param int $activity_id The activity id
+ * @param string $content The contents of a given item.
+ * @param int $activity_id The activity id. Deprecated.
  *
  * @uses bp_activity_find_mentions()
- * @uses bp_is_username_compatibility_mode()
- * @uses bp_core_get_userid_from_nicename()
+ * @uses bp_core_get_user_domain()
+ *
+ * @return string $content Content filtered for mentions
+ */
+function bp_activity_at_name_filter( $content, $activity_id = 0 ) {
+
+    // Try to find mentions
+    $usernames = bp_activity_find_mentions( $content );
+
+    // No mentions? Stop now!
+    if ( empty( $usernames ) )
+        return $content;
+
+    // Linkify the mentions with the username
+    foreach( (array) $usernames as $user_id => $username ) {
+        $content = preg_replace( '/(@' . $username . '\b)/', "<a href='" . bp_core_get_user_domain( $user_id ) . "' rel='nofollow'>@$username</a>", $content );
+    }
+
+    // Return the content
+    return $content;
+}
+
+/**
+ * Catch mentions in activity items before they are saved into the database.
+ *
+ * If mentions are found, replace @mention text with user links and add our
+ * hook to send mentions after the activity item is saved.
+ *
+ * @since BuddyPress (1.5)
+ *
+ * @param obj $activity
+ *
+ * @uses bp_activity_find_mentions()
+ */
+function bp_activity_at_name_filter_updates( $activity ) {
+    // If activity was marked as spam, stop the rest of this function.
+    if ( ! empty( $activity->is_spam ) )
+        return;
+
+    // Try to find mentions
+    $usernames = bp_activity_find_mentions( $activity->content );
+
+    // We have mentions!
+    if ( ! empty( $usernames ) ) {
+        // Replace @mention text with userlinks
+        foreach( (array) $usernames as $user_id => $username ) {
+            $activity->content = preg_replace( '/(@' . $username . '\b)/', "<a href='" . bp_core_get_user_domain( $user_id ) . "' rel='nofollow'>@$username</a>", $activity->content );
+        }
+
+        // Add our hook to send @mention emails after the activity item is saved
+        add_action( 'bp_activity_after_save', 'bp_activity_at_name_send_emails' );
+
+        // temporary variable to avoid having to run bp_activity_find_mentions() again
+        buddypress()->activity->mentioned_users = $usernames;
+    }
+}
+
+/**
+ * Sends emails and BP notifications for @-mentioned users in the contents of
+ * an activity item.
+ *
+ * @since BuddyPress (1.7)
+ *
+ * @param obj $activity The BP_Activity_Activity object
+ *
  * @uses bp_activity_at_message_notification()
- * @uses bp_core_get_user_domain()
- * @uses bp_activity_adjust_mention_count()
- *
- * @return string $content Content filtered for mentions
- */
-function bp_activity_at_name_filter( $content, $activity_id = 0 ) {
-    if ( $activity_id & bp_is_active( 'activity' ) ) {
-        $activity = new BP_Activity_Activity( $activity_id );
-
-        // If this activity has been marked as spam, don't do anything. This prevents @notifications being sent.
-        if ( !empty( $activity ) && $activity->is_spam )
-            return $content;
-    }
-
-    $usernames = bp_activity_find_mentions( $content );
-    foreach( (array) $usernames as $username ) {
-        if ( bp_is_username_compatibility_mode() )
-            $user_id = username_exists( $username );
-        else
-            $user_id = bp_core_get_userid_from_nicename( $username );
-
-        if ( empty( $user_id ) )
-            continue;
-
-        // If an activity_id is provided, we can send email and BP notifications
-        if ( $activity_id && apply_filters( 'bp_activity_at_name_do_notifications', true ) ) {
-            bp_activity_at_message_notification( $activity_id, $user_id );
+ * @uses bp_activity_update_mention_count_for_user()
+ */
+function bp_activity_at_name_send_emails( $activity ) {
+    // If our temporary variable doesn't exist, stop now.
+    if ( empty( buddypress()->activity->mentioned_users ) )
+        return;
+
+    // Grab our temporary variable from bp_activity_at_name_filter_updates()
+    $usernames = buddypress()->activity->mentioned_users;
+
+    // Get rid of temporary variable
+    unset( buddypress()->activity->mentioned_users );
+
+    // Send @mentions and setup BP notifications
+    foreach( (array) $usernames as $user_id => $username ) {
+        // If you want to disable notifications, you can use this filter to stop email sending
+        if ( apply_filters( 'bp_activity_at_name_do_notifications', true, $usernames ) ) {
+            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 );
-    }
-
-    // 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
- *
- * @since BuddyPress (1.5)
- *
- * @param obj $activity
- *
- * @uses remove_filter() To remove the 'bp_activity_at_name_filter_updates' hook.
- * @uses bp_activity_at_name_filter()
- * @uses BP_Activity_Activity::save() {@link BP_Activity_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();
+        // Updates mention count for the user
+        bp_activity_update_mention_count_for_user( $user_id, $activity->id );
+    }
 }
 

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

@@ -29 +29 @@
 
 /**
- * Searches through the content of an activity item to locate usernames, designated by an @ sign
+ * Searches through the content of an activity item to locate usernames,
+ * designated by an @ sign.
  *
  * @since BuddyPress (1.5)
  *
- * @param string $content The content of the activity, usually found in $activity->content
- *
- * @return bool|array $usernames Array of the found usernames that match existing users. False if no matches
+ * @param string $content The content of the activity, usually found in $activity->content.
+ * @return mixed Associative array with user ID as key and username as value. Boolean false if no mentions found.
  */
 function bp_activity_find_mentions( $content ) {
@@ -45 +45 @@
         return false;
 
-    return $usernames;
+    $mentioned_users = array();
+
+    // We've found some mentions! Check to see if users exist
+    foreach( (array) $usernames as $key => $username ) {
+        if ( bp_is_username_compatibility_mode() ) {
+            $user_id = username_exists( $username );
+        } else {
+            $user_id = bp_core_get_userid_from_nicename( $username );
+        }
+
+        // user ID exists, so let's add it to our array
+        if ( ! empty( $user_id ) ) {
+            $mentioned_users[$user_id] = $username;
+        }
+    }
+
+    if ( empty( $mentioned_users ) )
+        return false;
+
+    return $mentioned_users;
 }
 
@@ -62 +81 @@
 
 /**
- * Adjusts new mention count for mentioned users when activity items are deleted or created
+ * Adjusts mention count for mentioned users in activity items.
+ *
+ * This function is useful if you only have the activity ID handy and you
+ * haven't parsed an activity item for @mentions yet.
+ *
+ * Currently, only used in {@link bp_activity_delete()}.
  *
  * @since BuddyPress (1.5)
  *
+ * @param int $activity_id The unique id for the activity item
+ * @param string $action Can be 'delete' or 'add'. Defaults to 'add'.
+ *
+ * @uses bp_activity_find_mentions()
+ * @uses bp_activity_update_mention_count_for_user()
+ */
+function bp_activity_adjust_mention_count( $activity_id = 0, $action = 'add' ) {
+    if ( empty( $activity_id ) )
+        return false;
+
+    // Get activity object
+    $activity = new BP_Activity_Activity( (int) $activity_id );
+
+    // Try to find mentions
+    $usernames = bp_activity_find_mentions( strip_tags( $activity->content ) );
+
+    // Still empty? Stop now
+    if ( empty( $usernames ) )
+        return false;
+
+    // Increment mention count foreach mentioned user
+    foreach( (array) $usernames as $user_id => $username ) {
+        bp_activity_update_mention_count_for_user( $user_id, $activity_id, $action );
+    }
+}
+
+/**
+ * Updates the mention count for the user in question.
+ *
+ * This function should be used when you've already parsed your activity item
+ * for @mentions.
+ *
+ * @since BuddyPress (1.7)
+ *
+ * @param int $user_id The user ID
  * @param int $activity_id The unique id for the activity item
  * @param string $action Can be 'delete' or 'add'. Defaults to 'add'
  *
- * @uses BP_Activity_Activity() {@link BP_Activity_Activity}
- * @uses bp_activity_find_mentions()
- * @uses bp_is_username_compatibility_mode()
- * @uses bp_core_get_userid_from_nicename()
  * @uses bp_get_user_meta()
  * @uses bp_update_user_meta()
- */
-function bp_activity_adjust_mention_count( $activity_id, $action = 'add' ) {
-    $activity = new BP_Activity_Activity( $activity_id );
-
-    if ( $usernames = bp_activity_find_mentions( strip_tags( $activity->content ) ) ) {
-        foreach( (array) $usernames as $username ) {
-            if ( bp_is_username_compatibility_mode() )
-                $user_id = username_exists( $username );
-            else
-                $user_id = bp_core_get_userid_from_nicename( $username );
-
-            if ( empty( $user_id ) )
-                continue;
-
-            // Adjust the mention list and count for the member
-            $new_mention_count = (int)bp_get_user_meta( $user_id, 'bp_new_mention_count', true );
-            if ( !$new_mentions = bp_get_user_meta( $user_id, 'bp_new_mentions', true ) )
-                $new_mentions = array();
-
-            switch ( $action ) {
-                case 'delete' :
-                    $key = array_search( $activity_id, $new_mentions );
-                    if ( $key !== false ) {
-                        unset( $new_mentions[$key] );
-                    }
-                    break;
-
-                case 'add' :
-                default :
-                    if ( !in_array( $activity_id, $new_mentions ) ) {
-                        $new_mentions[] = (int) $activity_id;
-                    }
-                    break;
+ * @return bool
+ */
+function bp_activity_update_mention_count_for_user( $user_id, $activity_id, $action = 'add' ) {
+    if ( empty( $user_id ) || empty( $activity_id ) )
+        return false;
+
+    // Adjust the mention list and count for the member
+    $new_mention_count = (int) bp_get_user_meta( $user_id, 'bp_new_mention_count', true );
+    if ( !$new_mentions = bp_get_user_meta( $user_id, 'bp_new_mentions', true ) )
+        $new_mentions = array();
+
+    switch ( $action ) {
+        case 'delete' :
+            $key = array_search( $activity_id, $new_mentions );
+
+            if ( $key !== false ) {
+                unset( $new_mentions[$key] );
             }
 
-            // Get an updated mention count
-            $new_mention_count = count( $new_mentions );
-
-            // Resave the user_meta
-            bp_update_user_meta( $user_id, 'bp_new_mention_count', $new_mention_count );
-            bp_update_user_meta( $user_id, 'bp_new_mentions', $new_mentions );
-        }
-    }
+            break;
+
+        case 'add' :
+        default :
+            if ( !in_array( $activity_id, $new_mentions ) ) {
+                $new_mentions[] = (int) $activity_id;
+            }
+
+            break;
+    }
+
+    // Get an updated mention count
+    $new_mention_count = count( $new_mentions );
+
+    // Resave the user_meta
+    bp_update_user_meta( $user_id, 'bp_new_mention_count', $new_mention_count );
+    bp_update_user_meta( $user_id, 'bp_new_mentions',      $new_mentions );
+
+    return true;
 }