Changeset 13636

Timestamp:

11/07/2023 10:41:34 PM (20 months ago)

Author:

imath

Message:

Improve the favorites management using the WP Meta API

• Introduce bp_activity_register_user_favorites_meta() to register the user meta and define sanitization callback.
• Introduce bp_activity_sanitize_user_favorites_meta() to do the sanitization job.
• Improve Ajax callbacks about favoriting/unfavoriting activities in template packs.

Props emaralive, dcavins

Fixes #9021
Closes ​https://github.com/buddypress/buddypress/pull/189

Location:

trunk

Files:

• src/bp-activity/bp-activity-filters.php (modified) (1 diff)
• src/bp-activity/bp-activity-functions.php (modified) (6 diffs)
• src/bp-templates/bp-legacy/buddypress-functions.php (modified) (2 diffs)
• src/bp-templates/bp-nouveau/includes/activity/ajax.php (modified) (2 diffs)
• tests/phpunit/testcases/activity/functions.php (modified) (1 diff)

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

@@ -104 +104 @@
 add_filter( 'bp_get_activity_content',      'bp_activity_truncate_entry', 5 );
 
-add_filter( 'bp_get_total_favorite_count_for_user', 'bp_core_number_format' );
-add_filter( 'bp_get_total_mention_count_for_user',  'bp_core_number_format' );
+add_filter( 'bp_activity_get_user_favorites',       'bp_activity_sanitize_user_favorites_meta' );
+add_filter( 'bp_get_total_favorite_count_for_user', 'bp_core_number_format'                    );
+add_filter( 'bp_get_total_mention_count_for_user',  'bp_core_number_format'                    );
 
 add_filter( 'bp_activity_get_embed_excerpt', 'bp_activity_embed_excerpt_onclick_location_filter', 9 );

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

@@ -1015 +1015 @@
 
 /**
+ * Sanitize callback for the User's favorites meta.
+ *
+ * @since 12.0.0
+ *
+ * @param array $value The list of favorited activity IDs.
+ * @return array The sanitized list of favorited activity IDs.
+ */
+function bp_activity_sanitize_user_favorites_meta( $value = array() ) {
+    return array_filter( wp_parse_id_list( $value ) );
+}
+
+/**
+ * Use WordPress Meta API to deal with favorites meta properties and sanitization.
+ *
+ * @since 12.0.0
+ */
+function bp_activity_register_user_favorites_meta() {
+    register_meta(
+        'user',
+        'bp_favorite_activities',
+        array(
+            'single'            => true,
+            'type'              => 'array',
+            'description'       => __( 'The list of Activity IDs a user favorited.', 'buddypress' ),
+            'show_in_rest'      => false, // We're not showing this meta into the WP users REST endpoint.
+            'sanitize_callback' => 'bp_activity_sanitize_user_favorites_meta',
+            'default'           => array(),
+        )
+    );
+}
+add_action( 'bp_init', 'bp_activity_register_user_favorites_meta' );
+
+/**
  * Get a users favorite activity stream items.
  *
@@ -1052 +1085 @@
  */
 function bp_activity_add_user_favorite( $activity_id, $user_id = 0 ) {
+    // Cast as an integer to make sure we're only saving integers into the user's meta.
+    if ( ! empty( $activity_id ) ) {
+        $activity_id = (int) $activity_id;
+    } else {
+        $activity_id = 0;
+    }
+
+    if ( ! $activity_id ) {
+        return false;
+    }
 
     // Fallback to logged in user if no user_id is passed.
@@ -1058 +1101 @@
     }
 
-    $my_favs = bp_get_user_meta( $user_id, 'bp_favorite_activities', true );
-    if ( empty( $my_favs ) || ! is_array( $my_favs ) ) {
-        $my_favs = array();
-    }
+    // Get user's existing favorites.
+    $my_favs = bp_activity_get_user_favorites( $user_id );
 
     // Bail if the user has already favorited this activity item.
-    if ( in_array( $activity_id, $my_favs ) ) {
+    if ( in_array( $activity_id, $my_favs, true ) ) {
         return false;
     }
@@ -1072 +1113 @@
 
     // Update the total number of users who have favorited this activity.
-    $fav_count = bp_activity_get_meta( $activity_id, 'favorite_count' );
-    $fav_count = !empty( $fav_count ) ? (int) $fav_count + 1 : 1;
+    $fav_count = (int) bp_activity_get_meta( $activity_id, 'favorite_count' );
+    if ( ! empty( $fav_count ) ) {
+        $fav_count += 1;
+    } else {
+        $fav_count = 1;
+    }
 
     // Update user meta.
@@ -1127 +1172 @@
     }
 
-    $my_favs = bp_get_user_meta( $user_id, 'bp_favorite_activities', true );
-    $my_favs = array_flip( (array) $my_favs );
+    $my_favs = bp_activity_get_user_favorites( $user_id );
+    $my_favs = array_flip( $my_favs );
 
     // Bail if the user has not previously favorited the item.
@@ -1136 +1181 @@
 
     // Remove the fav from the user's favs.
-    unset( $my_favs[$activity_id] );
+    unset( $my_favs[ $activity_id ] );
     $my_favs = array_unique( array_flip( $my_favs ) );
 

trunk/src/bp-templates/bp-legacy/buddypress-functions.php

@@ -1278 +1278 @@
     $activity_id   = (int) $_POST['id'];
     $activity_item = new BP_Activity_Activity( $activity_id );
-    if ( ! bp_activity_user_can_read( $activity_item, bp_loggedin_user_id() ) ) {
-        return;
-    }
-
-    if ( bp_activity_add_user_favorite( $_POST['id'] ) )
-        _e( 'Remove Favorite', 'buddypress' );
-    else
-        _e( 'Favorite', 'buddypress' );
+    if ( empty( $activity_item->id ) || ! bp_activity_user_can_read( $activity_item, bp_loggedin_user_id() ) ) {
+        return;
+    }
+
+    if ( bp_activity_add_user_favorite( $activity_id ) ) {
+        esc_html_e( 'Remove Favorite', 'buddypress' );
+    } else {
+        esc_html_e( 'Favorite', 'buddypress' );
+    }
 
     exit;
@@ -1312 +1313 @@
     }
 
-    if ( bp_activity_remove_user_favorite( $_POST['id'] ) )
-        _e( 'Favorite', 'buddypress' );
-    else
-        _e( 'Remove Favorite', 'buddypress' );
+    $activity_id = (int) $_POST['id'];
+
+    if ( bp_activity_remove_user_favorite( $activity_id ) ) {
+        esc_html_e( 'Favorite', 'buddypress' );
+    } else {
+        esc_html_e( 'Remove Favorite', 'buddypress' );
+    }
 
     exit;

trunk/src/bp-templates/bp-nouveau/includes/activity/ajax.php

@@ -104 +104 @@
     $activity_id   = (int) $_POST['id'];
     $activity_item = new BP_Activity_Activity( $activity_id );
-    if ( ! bp_activity_user_can_read( $activity_item, bp_loggedin_user_id() ) ) {
-        wp_send_json_error();
-    }
-
-    if ( bp_activity_add_user_favorite( $_POST['id'] ) ) {
+    if ( empty( $activity_item->id ) || ! bp_activity_user_can_read( $activity_item, bp_loggedin_user_id() ) ) {
+        wp_send_json_error();
+    }
+
+    if ( bp_activity_add_user_favorite( $activity_id ) ) {
         $response = array( 'content' => __( 'Remove Favorite', 'buddypress' ) );
 
@@ -150 +150 @@
     }
 
-    if ( bp_activity_remove_user_favorite( $_POST['id'] ) ) {
+    $activity_id = (int) $_POST['id'];
+
+    if ( bp_activity_remove_user_favorite( $activity_id ) ) {
         $response = array( 'content' => __( 'Mark as Favorite', 'buddypress' ) );
 

trunk/tests/phpunit/testcases/activity/functions.php

@@ -1467 +1467 @@
 
     /**
+     * @group favorites
+     * @group bp_activity_add_user_favorite
+     */
+    public function test_add_user_favorite_not_an_activity_id() {
+        $u1 = self::factory()->user->create();
+        $a = self::factory()->activity->create();
+
+        // bp_activity_add_user_favorite() requires a logged-in user.
+        $current_user = bp_loggedin_user_id();
+        $this->set_current_user( $u1 );
+
+        // Only favorite for user 1
+        bp_activity_add_user_favorite( $a, $u1 );
+        $user_favorites = array( $a );
+        $this->assertEquals( $user_favorites, bp_activity_get_user_favorites( $u1 ) );
+
+        // Adds something that is not an activity id.
+        bp_activity_add_user_favorite( 'not_an_activity_id', $u1 );
+
+        // The above shouldn't be added.
+        $this->assertEquals( $user_favorites, bp_activity_get_user_favorites( $u1 ) );
+        $this->assertEquals( 1, bp_activity_get_meta( $a, 'favorite_count' ) );
+
+        $this->set_current_user( $current_user );
+    }
+
+    /**
      * @group bp_activity_post_update
      */