Changeset 7862

Timestamp:

02/13/2014 03:50:39 AM (11 years ago)

Author:

boonebgorges

Message:

Migrate xprofilemeta functions to the WP metadata API

The case of XProfile metadata is complex, because xprofile groups, fields, and
data all store their metadata in a single table, differentiated by object_type.
This complication requires additional filters on WP's core metadata queries.

See #4551

Location:

trunk

Files:

• bp-xprofile/bp-xprofile-filters.php (modified) (1 diff)
• bp-xprofile/bp-xprofile-functions.php (modified) (1 diff)
• bp-xprofile/bp-xprofile-loader.php (modified) (1 diff)
• tests/testcases/xprofile/filters.php (added)
• tests/testcases/xprofile/functions.php (modified) (1 diff)

trunk/bp-xprofile/bp-xprofile-filters.php

@@ -262 +262 @@
 }
 add_filter( 'bp_user_query_populate_extras', 'bp_xprofile_filter_user_query_populate_extras', 2, 2 );
+
+/**
+ * Filter meta queries to modify for the xprofile data schema.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @access private Do not use.
+ *
+ * @param string $q SQL query.
+ * @return string
+ */
+function bp_xprofile_filter_meta_query( $q ) {
+    global $wpdb;
+
+    // Get the first word of the command
+    preg_match( '/^(\S+)/', $q, $first_word_matches );
+
+    if ( empty( $first_word_matches[0] ) ) {
+        return $q;
+    }
+
+    // Get the field type
+    preg_match( '/xprofile_(group|field|data)_id/', $q, $matches );
+
+    if ( empty( $matches[0] ) || empty( $matches[1] ) ) {
+        return $q;
+    }
+
+    switch ( $first_word_matches[0] ) {
+
+        /**
+         * SELECT:
+         * - replace 'xprofile_{fieldtype}_id' with 'object_id'
+         * - ensure that 'object_id' is aliased to 'xprofile_{fieldtype}_id',
+         *   because update_meta_cache() needs the column name to parse
+         *   the query results
+         * - append the 'object type' WHERE clause
+         */
+        case 'SELECT' :
+            $q = str_replace(
+                array(
+                    $matches[0],
+                    'SELECT object_id',
+                    'WHERE ',
+                ),
+                array(
+                    'object_id',
+                    'SELECT object_id AS ' . $matches[0],
+                    $wpdb->prepare( 'WHERE object_type = %s AND ', $matches[1] ),
+                ),
+                $q
+            );
+            break;
+
+        /**
+         * UPDATE and DELETE:
+         * - replace 'xprofile_{fieldtype}_id' with 'object_id'
+         * - append the 'object type' WHERE clause
+         */
+        case 'UPDATE' :
+        case 'DELETE' :
+            $q = str_replace(
+                array(
+                    $matches[0],
+                    'WHERE ',
+                ),
+                array(
+                    'object_id',
+                    $wpdb->prepare( 'WHERE object_type = %s AND ', $matches[1] ),
+                ),
+                $q
+            );
+            break;
+
+        /**
+         * UPDATE and DELETE:
+         * - replace 'xprofile_{fieldtype}_id' with 'object_id'
+         * - ensure that the object_type field gets filled in
+         */
+        case 'INSERT' :
+            $q = str_replace(
+                array(
+                    '`' . $matches[0] . '`',
+                    'VALUES (',
+                ),
+                array(
+                    '`object_type`,`object_id`',
+                    $wpdb->prepare( "VALUES (%s,", $matches[1] ),
+                ),
+                $q
+            );
+            break;
+    }
+
+    return $q;
+}

trunk/bp-xprofile/bp-xprofile-functions.php

@@ -530 +530 @@
 /*** XProfile Meta ****************************************************/
 
+/**
+ * Delete a piece of xprofile metadata.
+ *
+ * @param int $object_id ID of the object the metadata belongs to.
+ * @param string $object_type Type of object. 'group', 'field', or 'data'.
+ * @param string $meta_key Key of the metadata being deleted. If omitted, all
+ *        metadata for the object will be deleted.
+ * @param mixed $meta_value Optional. If provided, only metadata that matches
+ *        the value will be permitted.
+ * @return bool True on success, false on failure.
+ */
 function bp_xprofile_delete_meta( $object_id, $object_type, $meta_key = false, $meta_value = false ) {
-    global $wpdb, $bp;
-
-    $object_id = (int) $object_id;
-
-    if ( !$object_id )
-        return false;
-
-    if ( !isset( $object_type ) )
-        return false;
-
-    if ( !in_array( $object_type, array( 'group', 'field', 'data' ) ) )
-        return false;
-
+    global $wpdb;
+
+    // Legacy - no empty object id
+    if ( empty( $object_id ) ) {
+        return false;
+    }
+
+    // Legacy - sanitize object type
+    if ( ! in_array( $object_type, array( 'group', 'field', 'data' ) ) ) {
+        return false;
+    }
+
+    // Legacy - if no meta_key is passed, delete all for the item
+    if ( empty( $meta_key ) ) {
+        $table_key  = 'xprofile_' . $object_type . 'meta';
+        $table_name = $wpdb->{$table_key};
+        $keys = $wpdb->get_col( $wpdb->prepare( "SELECT meta_key FROM {$table_name} WHERE object_type = %s AND object_id = %d", $object_type, $object_id ) );
+    } else {
+        $keys = array( $meta_key );
+    }
+
+    // Legacy - trim meta_value
+    $meta_value = trim( $meta_value );
+
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    add_filter( 'query', 'bp_xprofile_filter_meta_query' );
+
+    foreach ( $keys as $key ) {
+        $retval = delete_metadata( 'xprofile_' . $object_type, $object_id, $key, $meta_value );
+    }
+
+    remove_filter( 'query', 'bp_xprofile_filter_meta_query' );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    return $retval;
+}
+
+/**
+ * Get a piece of xprofile metadata.
+ *
+ * @param int $object_id ID of the object the metadata belongs to.
+ * @param string $object_type Type of object. 'group', 'field', or 'data'.
+ * @param string $meta_key Key of the metadata being fetched. If omitted, all
+ *        metadata for the object will be retrieved.
+ * @return mixed Meta value if found. False on failure.
+ */
+function bp_xprofile_get_meta( $object_id, $object_type, $meta_key = '') {
+    // Legacy - sanitize object type
+    if ( ! in_array( $object_type, array( 'group', 'field', 'data' ) ) ) {
+        return false;
+    }
+
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    add_filter( 'query', 'bp_xprofile_filter_meta_query' );
+    $retval = get_metadata( 'xprofile_' . $object_type, $object_id, $meta_key, true );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+    remove_filter( 'query', 'bp_xprofile_filter_meta_query' );
+
+    // Legacy - if no meta_key is provided, return just the located
+    // values (not a structured array)
+    if ( empty( $meta_key ) && ! empty( $retval ) ) {
+        $values = array();
+        foreach ( $retval as $v ) {
+            $values[] = array_pop( $v );
+        }
+
+        $retval = $values;
+    }
+
+    return $retval;
+}
+
+/**
+ * Update a piece of xprofile metadata.
+ *
+ * @param int $object_id ID of the object the metadata belongs to.
+ * @param string $object_type Type of object. 'group', 'field', or 'data'.
+ * @param string $meta_key Key of the metadata being updated.
+ * @param mixed $meta_value Value of the metadata being updated.
+ * @return bool True on success, false on failure.
+ */
+function bp_xprofile_update_meta( $object_id, $object_type, $meta_key, $meta_value ) {
+
+    // Legacy - sanitize meta_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 );
-    }
-
-    $meta_value = trim( $meta_value );
-
-    if ( empty( $meta_key ) ) {
-        $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->profile->table_name_meta} WHERE object_id = %d AND object_type = %s", $object_id, $object_type ) );
-    } elseif ( !empty( $meta_value ) ) {
-        $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->profile->table_name_meta} WHERE object_id = %d AND object_type = %s AND meta_key = %s AND meta_value = %s", $object_id, $object_type, $meta_key, $meta_value ) );
-    } else {
-        $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->profile->table_name_meta} WHERE object_id = %d AND object_type = %s AND meta_key = %s", $object_id, $object_type, $meta_key ) );
-    }
-
-    // Delete the cached object
-    wp_cache_delete( 'bp_xprofile_meta_' . $object_type . '_' . $object_id . '_' . $meta_key, 'bp' );
-
-    return true;
-}
-
-function bp_xprofile_get_meta( $object_id, $object_type, $meta_key = '') {
-    global $wpdb, $bp;
-
-    $object_id = (int) $object_id;
-
-    if ( !$object_id )
-        return false;
-
-    if ( !isset( $object_type ) )
-        return false;
-
-    if ( !in_array( $object_type, array( 'group', 'field', 'data' ) ) )
-        return false;
-
-    if ( !empty( $meta_key ) ) {
-        $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
-
-        if ( !$metas = wp_cache_get( 'bp_xprofile_meta_' . $object_type . '_' . $object_id . '_' . $meta_key, 'bp' ) ) {
-            $metas = $wpdb->get_col( $wpdb->prepare( "SELECT meta_value FROM {$bp->profile->table_name_meta} WHERE object_id = %d AND object_type = %s AND meta_key = %s", $object_id, $object_type, $meta_key ) );
-            wp_cache_set( 'bp_xprofile_meta_' . $object_type . '_' . $object_id . '_' . $meta_key, $metas, 'bp' );
-        }
-    } else {
-        $metas = $wpdb->get_col( $wpdb->prepare( "SELECT meta_value FROM {$bp->profile->table_name_meta} WHERE object_id = %d AND object_type = %s", $object_id, $object_type ) );
-    }
-
-    if ( empty( $metas ) ) {
-        if ( empty( $meta_key ) ) {
-            return array();
-        } else {
-            return '';
-        }
-    }
-
-    $metas = array_map( 'maybe_unserialize', (array) $metas );
-
-    if ( 1 == count( $metas ) )
-        return $metas[0];
-    else
-        return $metas;
-}
-
-function bp_xprofile_update_meta( $object_id, $object_type, $meta_key, $meta_value ) {
-    global $wpdb, $bp;
-
-    $object_id = (int) $object_id;
-
-    if ( empty( $object_id ) )
-        return false;
-
-    if ( !isset( $object_type ) )
-        return false;
-
-    if ( !in_array( $object_type, array( 'group', 'field', 'data' ) ) )
-        return false;
-
-    $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
-
-    if ( is_string( $meta_value ) ) {
-        $meta_value = stripslashes( $meta_value );
-    }
-
-    $meta_value = maybe_serialize( $meta_value );
-
-    if ( empty( $meta_value ) )
-        return bp_xprofile_delete_meta( $object_id, $object_type, $meta_key );
-
-    $cur = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$bp->profile->table_name_meta} WHERE object_id = %d AND object_type = %s AND meta_key = %s", $object_id, $object_type, $meta_key ) );
-
-    if ( empty( $cur ) )
-        $wpdb->query( $wpdb->prepare( "INSERT INTO {$bp->profile->table_name_meta} ( object_id, object_type, meta_key, meta_value ) VALUES ( %d, %s, %s, %s )", $object_id, $object_type,  $meta_key, $meta_value ) );
-    else if ( $cur->meta_value != $meta_value )
-        $wpdb->query( $wpdb->prepare( "UPDATE {$bp->profile->table_name_meta} SET meta_value = %s WHERE object_id = %d AND object_type = %s AND meta_key = %s", $meta_value, $object_id, $object_type, $meta_key ) );
-    else
-        return false;
-
-    // Update the cached object and recache
-    wp_cache_set( 'bp_xprofile_meta_' . $object_type . '_' . $object_id . '_' . $meta_key, $meta_value, 'bp' );
-
-    return true;
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    add_filter( 'query', 'bp_xprofile_filter_meta_query' );
+    $retval = update_metadata( 'xprofile_' . $object_type, $object_id, $meta_key, $meta_value );
+    remove_filter( 'query', 'bp_xprofile_filter_meta_query' );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    // Legacy - if we fall through to add_metadata(), return true rather
+    // than the integer meta_id
+    if ( is_int( $retval ) ) {
+        $retval = (bool) $retval;
+    }
+
+    return $retval;
 }
 

trunk/bp-xprofile/bp-xprofile-loader.php

@@ -139 +139 @@
         );
 
+        $meta_tables = array(
+            'xprofile_group' => $bp->table_prefix . 'bp_xprofile_meta',
+            'xprofile_field' => $bp->table_prefix . 'bp_xprofile_meta',
+            'xprofile_data'  => $bp->table_prefix . 'bp_xprofile_meta',
+        );
+
         $globals = array(
             'slug'                  => BP_XPROFILE_SLUG,
             'has_directory'         => false,
             'notification_callback' => 'xprofile_format_notifications',
-            'global_tables'         => $global_tables
+            'global_tables'         => $global_tables,
+            'meta_tables'           => $meta_tables,
         );
 

trunk/tests/testcases/xprofile/functions.php

@@ -235 +235 @@
 
         // These will fail because of a caching bug
-        //$this->assertEquals( '', bp_xprofile_get_meta( $g->id, 'group', 'foo' ) );
-        //$this->assertEquals( '', bp_xprofile_get_meta( $g->id, 'group', 'foo2' ) );
+        $this->assertEquals( '', bp_xprofile_get_meta( $g->id, 'group', 'foo' ) );
+        $this->assertEquals( '', bp_xprofile_get_meta( $g->id, 'group', 'foo2' ) );
     }