Changeset 7854

Timestamp:

02/11/2014 08:22:05 PM (11 years ago)

Author:

boonebgorges

Message:

Migrate activity meta functions to the WP metadata API.

See #4551

Props boonebgorges, johnjamesjacoby

Location:

trunk

Files:

• bp-activity/bp-activity-cache.php (modified) (2 diffs)
• bp-activity/bp-activity-classes.php (modified) (1 diff)
• bp-activity/bp-activity-functions.php (modified) (5 diffs)
• bp-activity/bp-activity-loader.php (modified) (2 diffs)
• bp-core/deprecated/2.0.php (added)
• bp-loader.php (modified) (1 diff)
• tests/testcases/activity/cache.php (added)

trunk/bp-activity/bp-activity-cache.php

@@ -31 +31 @@
         'object_type'      => $bp->activity->id,
         'object_column'    => 'activity_id',
+        'cache_group'      => 'activity_meta',
         'meta_table'       => $bp->activity->table_name_meta,
         'cache_key_prefix' => 'bp_activity_meta'
@@ -36 +37 @@
 
     bp_update_meta_cache( $cache_args );
-}
-
-/**
- * Clear the cache for all metadata of a given activity.
- *
- * @param int $activity_id
- */
-function bp_activity_clear_meta_cache_for_activity( $activity_id ) {
-    global $wp_object_cache;
-
-    if ( is_object( $wp_object_cache ) && ! empty( $wp_object_cache->cache['bp'] ) ) {
-        foreach ( $wp_object_cache->cache['bp'] as $ckey => $cvalue ) {
-            if ( 0 === strpos( $ckey, 'bp_activity_meta_' . $activity_id ) ) {
-                wp_cache_delete( $ckey, 'bp' );
-            }
-        }
-    }
 }
 

trunk/bp-activity/bp-activity-classes.php

@@ -825 +825 @@
      */
     public static function delete_activity_meta_entries( $activity_ids = array() ) {
-        global $bp, $wpdb;
-
-        $activity_ids = implode( ',', wp_parse_id_list( $activity_ids ) );
-
-        foreach ( (array) $activity_ids as $activity_id ) {
-            bp_activity_clear_meta_cache_for_activity( $activity_id );
-        }
-
-        return $wpdb->query( "DELETE FROM {$bp->activity->table_name_meta} WHERE activity_id IN ({$activity_ids})" );
+        $activity_ids = wp_parse_id_list( $activity_ids );
+
+        foreach ( $activity_ids as $activity_id ) {
+            bp_activity_delete_meta( $activity_id );
+        }
+
+        return true;
     }
 

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

@@ -557 +557 @@
     global $wpdb, $bp;
 
-    // Return false if any of the above values are not set
-    if ( !is_numeric( $activity_id ) )
-        return false;
-
-    // Sanitize key
+    // Legacy - Return false if any of the above values are not set
+    if ( ! is_numeric( $activity_id ) ) {
+        return false;
+    }
+
+    // Legacy - Sanitize key
     $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
 
-    if ( is_array( $meta_value ) || is_object( $meta_value ) )
-        $meta_value = serialize( $meta_value );
-
-    // Trim off whitespace
+    // Legacy - Trim off whitespace
     $meta_value = trim( $meta_value );
 
-    // Delete all for activity_id
-    if ( empty( $meta_key ) )
-        $retval = $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->activity->table_name_meta} WHERE activity_id = %d", $activity_id ) );
-
-    // Delete only when all match
-    else if ( $meta_value )
-        $retval = $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->activity->table_name_meta} WHERE activity_id = %d AND meta_key = %s AND meta_value = %s", $activity_id, $meta_key, $meta_value ) );
-
-    // Delete only when activity_id and meta_key match
-    else
-        $retval = $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->activity->table_name_meta} WHERE activity_id = %d AND meta_key = %s", $activity_id, $meta_key ) );
-
-    // Delete cache entry
-    if ( $meta_key ) {
-        wp_cache_delete( 'bp_activity_meta_' . $activity_id . '_' . $meta_key, 'bp' );
+    // Legacy - if no meta_key is passed, delete all for the item
+    if ( empty( $meta_key ) ) {
+        $all_meta = bp_activity_get_meta( $activity_id );
+        $keys     = ! empty( $all_meta ) ? wp_list_pluck( $all_meta, 'meta_key' ) : array();
     } else {
-        bp_activity_clear_meta_cache_for_activity( $activity_id );
-    }
-
-    // Success
-    if ( !is_wp_error( $retval ) )
-        return true;
-
-    // Fail
-    else
-        return false;
+        $keys = array( $meta_key );
+    }
+
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    foreach ( $keys as $key ) {
+        $retval = delete_metadata( 'activity', $activity_id, $key, $meta_value );
+    }
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    return $retval;
 }
 
@@ -603 +590 @@
  * @since BuddyPress (1.2)
  *
- * @global object $wpdb WordPress database access object.
- * @global object $bp BuddyPress global settings.
- * @uses wp_cache_get()
- * @uses wp_cache_set()
  * @uses apply_filters() To call the 'bp_activity_get_meta' hook.
  *
@@ -615 +598 @@
  * @return mixed The meta value(s) being requested.
  */
-function bp_activity_get_meta( $activity_id = 0, $meta_key = '' ) {
-    global $wpdb, $bp;
+function bp_activity_get_meta( $activity_id = 0, $meta_key = '', $single = true ) {
 
     // Make sure activity_id is valid
-    if ( empty( $activity_id ) || !is_numeric( $activity_id ) )
-        return false;
-
-    // We have a key to look for
-    if ( !empty( $meta_key ) ) {
-
-        // Sanitize key
-        $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
-
-        // Check cache
-        if ( !$metas = wp_cache_get( 'bp_activity_meta_' . $activity_id . '_' . $meta_key, 'bp' ) ) {
-            // No cache so hit the DB
-            $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM {$bp->activity->table_name_meta} WHERE activity_id = %d AND meta_key = %s", $activity_id, $meta_key ) );
-
-            // Set cache
-            wp_cache_set( 'bp_activity_meta_' . $activity_id . '_' . $meta_key, $metas, 'bp' );
+    if ( empty( $activity_id ) || ! is_numeric( $activity_id ) ) {
+        return false;
+    }
+
+    // Legacy - Sanitize keys
+    $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
+
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    $retval = get_metadata( 'activity', $activity_id, $meta_key, $single );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    // Legacy - If fetching all meta for a group, just return the first
+    // of each found value
+    if ( empty( $meta_key ) ) {
+        $values = array();
+        foreach ( (array) $retval as $rkey => $rvalue ) {
+            $found = new stdClass;
+            $found->meta_key = $rkey;
+            $found->meta_value = array_pop( array_reverse( $rvalue ) );
+            $values[] = $found;
         }
 
-    // No key so get all for activity_id
-    } else {
-        $metas = $wpdb->get_results( $wpdb->prepare( "SELECT meta_key, meta_value FROM {$bp->activity->table_name_meta} WHERE activity_id = %d", $activity_id ) );
-
-        if ( !empty( $metas ) ) {
-            $metas = array_map( 'maybe_unserialize', (array) $metas );
-
-            foreach( $metas as $mkey => $mvalue ) {
-                wp_cache_set( 'bp_activity_meta_' . $activity_id . '_' . $mkey, $mvalue, 'bp' );
-            }
+        // If nothing was found, return false
+        if ( empty( $values ) ) {
+            $retval = false;
+        } else {
+            $retval = $values;
         }
     }
 
-    // No result so return false
-    if ( empty( $metas ) )
-        return false;
-
-    // Maybe, just maybe... unserialize
-    $metas = array_map( 'maybe_unserialize', (array) $metas );
-
-    // Return first item in array if only 1, else return all metas found
-    $retval = ( 1 == count( $metas ) ? $metas[0] : $metas );
+    // Legacy - On failure, expect false, not an empty string
+    if ( '' === $retval ) {
+        $retval = false;
+    }
 
     // Filter result before returning
-    return apply_filters( 'bp_activity_get_meta', $retval, $activity_id, $meta_key );
+    return apply_filters( 'bp_activity_get_meta', $retval, $activity_id, $meta_key, $single );
 }
 
@@ -668 +644 @@
  *
  * @since BuddyPress (1.2)
- *
- * @global object $wpdb WordPress database access object.
- * @global object $bp BuddyPress global settings.
- * @uses maybe_serialize()
- * @uses bp_activity_delete_meta()
- * @uses wp_cache_set()
  *
  * @param int $activity_id ID of the activity item whose metadata is being updated.
@@ -681 +651 @@
  */
 function bp_activity_update_meta( $activity_id, $meta_key, $meta_value ) {
-    global $wpdb, $bp;
-
-    // Make sure activity_id is valid
-    if ( !is_numeric( $activity_id ) )
-        return false;
-
-    // Sanitize key
+
+    // Legacy - Make sure activity_id is valid
+    if ( ! is_numeric( $activity_id ) ) {
+        return false;
+    }
+
+    // Legacy - Sanitize key
     $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
 
-    // Sanitize value
-    if ( is_string( $meta_value ) ) {
-        $meta_value = stripslashes( $meta_value );
-    }
-
-    // Maybe, just maybe... serialize
-    $meta_value = maybe_serialize( $meta_value );
-
-    // If value is false, delete the meta key
-    if ( false === $meta_value )
-        return bp_activity_delete_meta( $activity_id, $meta_key );
-
-    // See if meta key exists for activity_id
-    $cur = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$bp->activity->table_name_meta} WHERE activity_id = %d AND meta_key = %s", $activity_id, $meta_key ) );
-
-    // Meta key does not exist so INSERT
-    if ( empty( $cur ) )
-        $wpdb->query( $wpdb->prepare( "INSERT INTO {$bp->activity->table_name_meta} ( activity_id, meta_key, meta_value ) VALUES ( %d, %s, %s )", $activity_id, $meta_key, $meta_value ) );
-
-    // Meta key exists, so UPDATE
-    else if ( $cur->meta_value != $meta_value )
-        $wpdb->query( $wpdb->prepare( "UPDATE {$bp->activity->table_name_meta} SET meta_value = %s WHERE activity_id = %d AND meta_key = %s", $meta_value, $activity_id, $meta_key ) );
-
-    // Weirdness, so return false
-    else
-        return false;
-
-    // Set cache
-    wp_cache_set( 'bp_activity_meta_' . $activity_id . '_' . $meta_key, $meta_value, 'bp' );
-
-    // Victory is ours!
-    return true;
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    $retval = update_metadata( 'activity', $activity_id, $meta_key, $meta_value );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    // Legacy - return true if we fall through to add_metadata()
+    if ( is_int( $retval ) ) {
+        $retval = true;
+    }
+
+    return $retval;
 }
 

trunk/bp-activity/bp-activity-loader.php

@@ -96 +96 @@
         );
 
+        // Metadata tables for groups component
+        $meta_tables = array(
+            'activity' => $bp->table_prefix . 'bp_activity_meta',
+        );
+
         // All globals for activity component.
         // Note that global_tables is included in this array.
@@ -102 +107 @@
             'root_slug'             => isset( $bp->pages->activity->slug ) ? $bp->pages->activity->slug : BP_ACTIVITY_SLUG,
             'has_directory'         => true,
+            'notification_callback' => 'bp_activity_format_notifications',
             'search_string'         => __( 'Search Activity...', 'buddypress' ),
             'global_tables'         => $global_tables,
-            'notification_callback' => 'bp_activity_format_notifications',
+            'meta_tables'           => $meta_tables,
         );
 

trunk/bp-loader.php

@@ -454 +454 @@
             require( $this->plugin_dir . 'bp-core/deprecated/1.6.php' );
             require( $this->plugin_dir . 'bp-core/deprecated/1.7.php' );
+            require( $this->plugin_dir . 'bp-core/deprecated/2.0.php' );
         }
     }