Ticket #4551: meta-api.patch

bp-core/bp-core-meta.php

@@ +1 @@
+<?php
+/**
+ * BuddyPress Metadata API
+ *
+ * Functions for retrieving and manipulating metadata of various BuddyPress object/component types. Metadata
+ * for an object is a represented by a simple key-value pair. Objects may contain multiple
+ * metadata entries that share the same key and differ only in their value.
+ *
+ * @package BuddyPress
+ * @subpackage Core
+ * @since 1.6.2
+ */
+
+/**
+ * Add metadata for the specified object.
+ *
+ * @since 1.6.2
+ * @uses $wpdb WordPress database object for queries.
+ * @uses do_action() Calls 'added_{$meta_type}_meta' with meta_id of added metadata entry,
+ *              object ID, meta key, and meta value
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., activity, group etc)
+ * @param int $object_id ID of the object metadata is for
+ * @param string $meta_key Metadata key
+ * @param string $meta_value Metadata value
+ * @param bool $unique Optional, default is false. Whether the specified metadata key should be
+ *              unique for the object. If true, and the object already has a value for the specified
+ *              metadata key, no change will be made
+ * @return bool The meta ID on successful update, false on failure.
+ */
+function bp_add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique = false) {
+        if ( !$meta_type || !$meta_key )
+                return false;
+
+        if ( !$object_id = absint($object_id) )
+                return false;
+
+        if ( ! $table = _bp_get_meta_table($meta_type) )
+                return false;
+
+        global $wpdb;
+
+        $column = esc_sql($meta_type . '_id');
+
+        // expected_slashed ($meta_key)
+        $meta_key = stripslashes($meta_key);
+        $meta_value = stripslashes_deep($meta_value);
+        $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type );
+
+        $check = apply_filters( "add_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $unique );
+        if ( null !== $check )
+                return $check;
+
+        if ( $unique && $wpdb->get_var( $wpdb->prepare(
+                "SELECT COUNT(*) FROM $table WHERE meta_key = %s AND $column = %d",
+                $meta_key, $object_id ) ) )
+                return false;
+
+        $_meta_value = $meta_value;
+        $meta_value = maybe_serialize( $meta_value );
+
+        do_action( "add_{$meta_type}_meta", $object_id, $meta_key, $_meta_value );
+
+        $result = $wpdb->insert( $table, array(
+                $column => $object_id,
+                'meta_key' => $meta_key,
+                'meta_value' => $meta_value
+        ) );
+
+        if ( ! $result )
+                return false;
+
+        $mid = (int) $wpdb->insert_id;
+
+        wp_cache_delete($object_id, 'bp_'.$meta_type . '_meta');
+
+        do_action( "added_{$meta_type}_meta", $mid, $object_id, $meta_key, $_meta_value );
+
+        return $mid;
+}
+
+/**
+ * Update metadata for the specified object. If no value already exists for the specified object
+ * ID and metadata key, the metadata will be added.
+ *
+ * @since 1.6.2
+ * @uses $wpdb WordPress database object for queries.
+ * @uses do_action() Calls 'update_{$meta_type}_meta' before updating metadata with meta_id of
+ *              metadata entry to update, object ID, meta key, and meta value
+ * @uses do_action() Calls 'updated_{$meta_type}_meta' after updating metadata with meta_id of
+ *              updated metadata entry, object ID, meta key, and meta value
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., activity, group etc)
+ * @param int $object_id ID of the object metadata is for
+ * @param string $meta_key Metadata key
+ * @param string $meta_value Metadata value
+ * @param string $prev_value Optional. If specified, only update existing metadata entries with
+ *              the specified value. Otherwise, update all entries.
+ * @return bool True on successful update, false on failure.
+ */
+function bp_update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_value = '') {
+        if ( !$meta_type || !$meta_key )
+                return false;
+
+        if ( !$object_id = absint($object_id) )
+                return false;
+
+        if ( ! $table = _bp_get_meta_table($meta_type) )
+                return false;
+
+        global $wpdb;
+
+        $column = esc_sql($meta_type . '_id');//eg.g activity_id, group_id
+        $id_column = 'id';
+
+        // expected_slashed ($meta_key)
+        $meta_key = stripslashes($meta_key);
+        $passed_value = $meta_value;
+        $meta_value = stripslashes_deep($meta_value);
+        $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type );
+
+        $check = apply_filters( "update_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $prev_value );
+        if ( null !== $check )
+                return (bool) $check;
+
+        if ( ! $meta_id = $wpdb->get_var( $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s AND $column = %d", $meta_key, $object_id ) ) )
+                return bp_add_metadata($meta_type, $object_id, $meta_key, $passed_value);
+
+        // Compare existing value to new value if no prev value given and the key exists only once.
+        if ( empty($prev_value) ) {
+                $old_value = bp_get_metadata($meta_type, $object_id, $meta_key);
+                if ( count($old_value) == 1 ) {
+                        if ( $old_value[0] === $meta_value )
+                                return false;
+                }
+        }
+
+        $_meta_value = $meta_value;
+        $meta_value = maybe_serialize( $meta_value );
+
+        $data  = compact( 'meta_value' );
+        $where = array( $column => $object_id, 'meta_key' => $meta_key );
+
+        if ( !empty( $prev_value ) ) {
+                $prev_value = maybe_serialize($prev_value);
+                $where['meta_value'] = $prev_value;
+        }
+
+        do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
+
+       
+
+        $wpdb->update( $table, $data, $where );
+
+        wp_cache_delete($object_id, 'bp_'.$meta_type . '_meta');
+
+        do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
+
+        
+
+        return true;
+}
+
+/**
+ * Delete metadata for the specified object.
+ *
+ * @since 1.6.2
+ * @uses $wpdb WordPress database object for queries.
+ * @uses do_action() Calls 'deleted_{$meta_type}_meta' after deleting with meta_id of
+ *              deleted metadata entries, object ID, meta key, and meta value
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., activity, group)
+ * @param int $object_id ID of the object metadata is for
+ * @param string $meta_key Metadata key
+ * @param string $meta_value Optional. Metadata value. If specified, only delete metadata entries
+ *              with this value. Otherwise, delete all entries with the specified meta_key.
+ * @param bool $delete_all Optional, default is false. If true, delete matching metadata entries
+ *              for all objects, ignoring the specified object_id. Otherwise, only delete matching
+ *              metadata entries for the specified object_id.
+ * @return bool True on successful delete, false on failure.
+ */
+function bp_delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false) {
+        if ( !$meta_type || !$meta_key )
+                return false;
+
+        if ( (!$object_id = absint($object_id)) && !$delete_all )
+                return false;
+
+        if ( ! $table = _bp_get_meta_table($meta_type) )
+                return false;
+
+        global $wpdb;
+
+        $type_column = esc_sql($meta_type . '_id');
+        $id_column = 'id';
+        // expected_slashed ($meta_key)
+        $meta_key = stripslashes($meta_key);
+        $meta_value = stripslashes_deep($meta_value);
+
+        $check = apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all );
+        if ( null !== $check )
+                return (bool) $check;
+
+        $_meta_value = $meta_value;
+        $meta_value = maybe_serialize( $meta_value );
+
+        $query = $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s", $meta_key );
+
+        if ( !$delete_all )
+                $query .= $wpdb->prepare(" AND $type_column = %d", $object_id );
+
+        if ( $meta_value )
+                $query .= $wpdb->prepare(" AND meta_value = %s", $meta_value );
+
+        $meta_ids = $wpdb->get_col( $query );
+        if ( !count( $meta_ids ) )
+                return false;
+
+        if ( $delete_all )
+                $object_ids = $wpdb->get_col( $wpdb->prepare( "SELECT $type_column FROM $table WHERE meta_key = %s", $meta_key ) );
+
+        do_action( "delete_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
+
+        
+
+        $query = "DELETE FROM $table WHERE $id_column IN( " . implode( ',', $meta_ids ) . " )";
+
+        $count = $wpdb->query($query);
+
+        if ( !$count )
+                return false;
+
+        if ( $delete_all ) {
+                foreach ( (array) $object_ids as $o_id ) {
+                        wp_cache_delete($o_id, 'bp_'.$meta_type . '_meta');
+                }
+        } else {
+                wp_cache_delete($object_id, 'bp_'.$meta_type . '_meta');
+        }
+
+        do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
+
+        
+
+        return true;
+}
+
+/**
+ * Retrieve metadata for the specified object.
+ *
+ * @since 1.6.2
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., activity, group)
+ * @param int $object_id ID of the object metadata is for
+ * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for
+ *              the specified object.
+ * @param bool $single Optional, default is false. If true, return only the first value of the
+ *              specified meta_key. This parameter has no effect if meta_key is not specified.
+ * @return string|array Single metadata value, or array of values
+ */
+function bp_get_metadata($meta_type, $object_id, $meta_key = '', $single = false) {
+        if ( !$meta_type )
+                return false;
+
+        if ( !$object_id = absint($object_id) )
+                return false;
+
+        $check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, $single );
+        if ( null !== $check ) {
+                if ( $single && is_array( $check ) )
+                        return $check[0];
+                else
+                        return $check;
+        }
+
+        $meta_cache = wp_cache_get($object_id, 'bp_'.$meta_type . '_meta');
+
+        if ( !$meta_cache ) {
+                $meta_cache = _bp_update_meta_cache( $meta_type, array( $object_id ) );
+                $meta_cache = $meta_cache[$object_id];
+        }
+
+        if ( !$meta_key )
+                return $meta_cache;
+
+        if ( isset($meta_cache[$meta_key]) ) {
+                if ( $single )
+                        return maybe_unserialize( $meta_cache[$meta_key][0] );
+                else
+                        return array_map('maybe_unserialize', $meta_cache[$meta_key]);
+        }
+
+        if ($single)
+                return '';
+        else
+                return array();
+}
+
+/**
+ * Determine if a meta key is set for a given object
+ *
+ * @since 1.6.2
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., activity, group)
+ * @param int $object_id ID of the object metadata is for
+ * @param string $meta_key Metadata key.
+ * @return boolean true of the key is set, false if not.
+ */
+function bp_metadata_exists( $meta_type, $object_id, $meta_key ) {
+        if ( ! $meta_type )
+                return false;
+
+        if ( ! $object_id = absint( $object_id ) )
+                return false;
+
+        $check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, true );
+        if ( null !== $check )
+                return true;
+
+        $meta_cache = wp_cache_get( $object_id, 'bp_'.$meta_type . '_meta' );
+
+        if ( !$meta_cache ) {
+                $meta_cache = _bp_update_meta_cache( $meta_type, array( $object_id ) );
+                $meta_cache = $meta_cache[$object_id];
+        }
+
+        if ( isset( $meta_cache[ $meta_key ] ) )
+                return true;
+
+        return false;
+}
+
+/**
+ * Get meta data by meta ID
+ *
+ * @since 1.6.2
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., activity, group, or message)
+ * @param int $meta_id ID for a specific meta row
+ * @return object Meta object or false.
+ */
+function bp_get_metadata_by_mid( $meta_type, $meta_id ) {
+        global $wpdb;
+
+        if ( ! $meta_type )
+                return false;
+
+        if ( !$meta_id = absint( $meta_id ) )
+                return false;
+
+        if ( ! $table = _bp_get_meta_table($meta_type) )
+                return false;
+
+        $id_column = 'id';
+
+        $meta = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $table WHERE $id_column = %d", $meta_id ) );
+
+        if ( empty( $meta ) )
+                return false;
+
+        if ( isset( $meta->meta_value ) )
+                $meta->meta_value = maybe_unserialize( $meta->meta_value );
+
+        return $meta;
+}
+
+/**
+ * Update meta data by meta ID
+ *
+ * @since 1.6.2
+ *
+ * @uses get_metadata_by_mid() Calls get_metadata_by_mid() to fetch the meta key, value
+ *              and object_id of the given meta_id.
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., activity, group)
+ * @param int $meta_id ID for a specific meta row
+ * @param string $meta_value Metadata value
+ * @param string $meta_key Optional, you can provide a meta key to update it
+ * @return bool True on successful update, false on failure.
+ */
+function bp_update_metadata_by_mid( $meta_type, $meta_id, $meta_value, $meta_key = false ) {
+        global $wpdb;
+
+        // Make sure everything is valid.
+        if ( ! $meta_type )
+                return false;
+
+        if ( ! $meta_id = absint( $meta_id ) )
+                return false;
+
+        if ( ! $table = _bp_get_meta_table( $meta_type ) )
+                return false;
+
+        $column = esc_sql($meta_type . '_id');
+        $id_column =  'id';
+
+        // Fetch the meta and go on if it's found.
+        if ( $meta = bp_get_metadata_by_mid( $meta_type, $meta_id ) ) {
+                $original_key = $meta->meta_key;
+                $original_value = $meta->meta_value;
+                $object_id = $meta->{$column};
+
+                // If a new meta_key (last parameter) was specified, change the meta key,
+                // otherwise use the original key in the update statement.
+                if ( false === $meta_key ) {
+                        $meta_key = $original_key;
+                } elseif ( ! is_string( $meta_key ) ) {
+                        return false;
+                }
+
+                // Sanitize the meta
+                $_meta_value = $meta_value;
+                $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type );
+                $meta_value = maybe_serialize( $meta_value );
+
+                // Format the data query arguments.
+                $data = array(
+                        'meta_key' => $meta_key,
+                        'meta_value' => $meta_value
+                );
+
+                // Format the where query arguments.
+                $where = array();
+                $where[$id_column] = $meta_id;
+
+                do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
+
+                
+
+                // Run the update query, all fields in $data are %s, $where is a %d.
+                $result = (bool) $wpdb->update( $table, $data, $where, '%s', '%d' );
+
+                // Clear the caches.
+                wp_cache_delete($object_id, 'bp_'.$meta_type . '_meta');
+
+                do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
+
+                
+
+                return $result;
+        }
+
+        // And if the meta was not found.
+        return false;
+}
+
+/**
+ * Delete meta data by meta ID
+ *
+ * @since 1.6.2
+ *
+ * @uses get_metadata_by_mid() Calls get_metadata_by_mid() to fetch the meta key, value
+ *              and object_id of the given meta_id.
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
+ * @param int $meta_id ID for a specific meta row
+ * @return bool True on successful delete, false on failure.
+ */
+function bp_delete_metadata_by_mid( $meta_type, $meta_id ) {
+        global $wpdb;
+
+        // Make sure everything is valid.
+        if ( ! $meta_type )
+                return false;
+
+        if ( ! $meta_id = absint( $meta_id ) )
+                return false;
+
+        if ( ! $table = _bp_get_meta_table( $meta_type ) )
+                return false;
+
+        // object and id columns
+        $column = esc_sql($meta_type . '_id');
+        $id_column = 'id';
+
+        // Fetch the meta and go on if it's found.
+        if ( $meta = get_metadata_by_mid( $meta_type, $meta_id ) ) {
+                $object_id = $meta->{$column};
+
+                do_action( "delete_{$meta_type}_meta", (array) $meta_id, $object_id, $meta->meta_key, $meta->meta_value );
+
+
+                // Run the query, will return true if deleted, false otherwise
+                $result = (bool) $wpdb->delete( $table, array( $id_column => $meta_id ) );
+
+                // Clear the caches.
+                wp_cache_delete($object_id, 'bp_'.$meta_type . '_meta');
+
+                do_action( "deleted_{$meta_type}_meta", (array) $meta_id, $object_id, $meta->meta_key, $meta->meta_value );
+
+                
+
+                return $result;
+
+        }
+
+        // Meta id was not found.
+        return false;
+}
+
+/**
+ * Update the metadata cache for the specified objects.
+ *
+ * @since 1.6.2
+ * @uses $wpdb WordPress database object for queries.
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., activity, group)
+ * @param int|array $object_ids array or comma delimited list of object IDs to update cache for
+ * @return mixed Metadata cache for the specified objects, or false on failure.
+ */
+function _bp_update_meta_cache($meta_type, $object_ids) {
+        if ( empty( $meta_type ) || empty( $object_ids ) )
+                return false;
+
+        if ( ! $table = _bp_get_meta_table($meta_type) )
+                return false;
+
+        $column = esc_sql($meta_type . '_id');
+
+        global $wpdb;
+
+        if ( !is_array($object_ids) ) {
+                $object_ids = preg_replace('|[^0-9,]|', '', $object_ids);
+                $object_ids = explode(',', $object_ids);
+        }
+
+        $object_ids = array_map('intval', $object_ids);
+
+        $cache_key = 'bp_'.$meta_type . '_meta';
+        $ids = array();
+        $cache = array();
+        foreach ( $object_ids as $id ) {
+                $cached_object = wp_cache_get( $id, $cache_key );
+                if ( false === $cached_object )
+                        $ids[] = $id;
+                else
+                        $cache[$id] = $cached_object;
+        }
+
+        if ( empty( $ids ) )
+                return $cache;
+
+        // Get meta info
+        $id_list = join(',', $ids);
+        $meta_list = $wpdb->get_results( $wpdb->prepare("SELECT $column, meta_key, meta_value FROM $table WHERE $column IN ($id_list)",
+                $meta_type), ARRAY_A );
+
+        if ( !empty($meta_list) ) {
+                foreach ( $meta_list as $metarow) {
+                        $mpid = intval($metarow[$column]);
+                        $mkey = $metarow['meta_key'];
+                        $mval = $metarow['meta_value'];
+
+                        // Force subkeys to be array type:
+                        if ( !isset($cache[$mpid]) || !is_array($cache[$mpid]) )
+                                $cache[$mpid] = array();
+                        if ( !isset($cache[$mpid][$mkey]) || !is_array($cache[$mpid][$mkey]) )
+                                $cache[$mpid][$mkey] = array();
+
+                        // Add a value to the current pid/key:
+                        $cache[$mpid][$mkey][] = $mval;
+                }
+        }
+
+        foreach ( $ids as $id ) {
+                if ( ! isset($cache[$id]) )
+                        $cache[$id] = array();
+                wp_cache_add( $id, $cache[$id], $cache_key );
+        }
+
+        return $cache;
+}
+
+/**
+ * Given a meta query, generates SQL clauses to be appended to a main query
+ *
+ * @since 1.6.2
+ *
+ * @see WP_Meta_Query
+ *
+ * @param array $meta_query A meta query
+ * @param string $type Type of meta
+ * @param string $primary_table
+ * @param string $primary_id_column
+ * @param object $context (optional) The main query object
+ * @return array( 'join' => $join_sql, 'where' => $where_sql )
+ */
+function bp_get_meta_sql( $meta_query, $type, $primary_table, $primary_id_column, $context = null ) {
+        $meta_query_obj = new BP_Meta_Query( $meta_query );
+        return $meta_query_obj->get_sql( $type, $primary_table, $primary_id_column, $context );
+}
+
+/**
+ * Container class for a multiple metadata query, built on the op of WP_Meta_query and works exactly as WP_Meta_query
+ * 
+ * @since 1.6.2
+ */
+class BP_Meta_Query extends WP_Meta_Query {
+        /**
+        * List of metadata queries. A single query is an associative array:
+        * - 'key' string The meta key
+        * - 'value' string|array The meta value
+        * - 'compare' (optional) string How to compare the key to the value.
+        *              Possible values: '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'.
+        *              Default: '='
+        * - 'type' string (optional) The type of the value.
+        *              Possible values: 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'.
+        *              Default: 'CHAR'
+        *
+        * @since 1.6.2
+        * @access public
+        * @var array
+        */
+        
+
+        
+        function __construct( $meta_query = false ) {
+                parent::__construct($meta_query);
+        }
+
+        
+
+        /**
+         * Generates SQL clauses to be appended to a main query.
+         *
+         * @since 1.6.2
+         * @access public
+         *
+         * @param string $type Type of meta
+         * @param string $primary_table
+         * @param string $primary_id_column
+         * @param object $context (optional) The main query object
+         * @return array( 'join' => $join_sql, 'where' => $where_sql )
+         */
+        function get_sql( $type, $primary_table, $primary_id_column, $context = null ) {
+                global $wpdb;
+
+                if ( ! $meta_table = _bp_get_meta_table( $type ) )
+                        return false;
+
+                $meta_id_column = esc_sql( $type . '_id' );
+
+                $join = array();
+                $where = array();
+
+                foreach ( $this->queries as $k => $q ) {
+                        $meta_key = isset( $q['key'] ) ? trim( $q['key'] ) : '';
+                        $meta_type = isset( $q['type'] ) ? strtoupper( $q['type'] ) : 'CHAR';
+
+                        if ( 'NUMERIC' == $meta_type )
+                                $meta_type = 'SIGNED';
+                        elseif ( ! in_array( $meta_type, array( 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED' ) ) )
+                                $meta_type = 'CHAR';
+
+                        $i = count( $join );
+                        $alias = $i ? 'mt' . $i : $meta_table;
+
+                        // Set JOIN
+                        $join[$i]  = "INNER JOIN $meta_table";
+                        $join[$i] .= $i ? " AS $alias" : '';
+                        $join[$i] .= " ON ($primary_table.$primary_id_column = $alias.$meta_id_column)";
+
+                        $where[$k] = '';
+                        if ( !empty( $meta_key ) )
+                                $where[$k] = $wpdb->prepare( "$alias.meta_key = %s", $meta_key );
+
+                        if ( !isset( $q['value'] ) ) {
+                                if ( empty( $where[$k] ) )
+                                        unset( $join[$i] );
+                                continue;
+                        }
+
+                        $meta_value = $q['value'];
+
+                        $meta_compare = is_array( $meta_value ) ? 'IN' : '=';
+                        if ( isset( $q['compare'] ) )
+                                $meta_compare = strtoupper( $q['compare'] );
+
+                        if ( ! in_array( $meta_compare, array( '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) )
+                                $meta_compare = '=';
+
+                        if ( in_array( $meta_compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
+                                if ( ! is_array( $meta_value ) )
+                                        $meta_value = preg_split( '/[,\s]+/', $meta_value );
+
+                                if ( empty( $meta_value ) ) {
+                                        unset( $join[$i] );
+                                        continue;
+                                }
+                        } else {
+                                $meta_value = trim( $meta_value );
+                        }
+
+                        if ( 'IN' == substr( $meta_compare, -2) ) {
+                                $meta_compare_string = '(' . substr( str_repeat( ',%s', count( $meta_value ) ), 1 ) . ')';
+                        } elseif ( 'BETWEEN' == substr( $meta_compare, -7) ) {
+                                $meta_value = array_slice( $meta_value, 0, 2 );
+                                $meta_compare_string = '%s AND %s';
+                        } elseif ( 'LIKE' == substr( $meta_compare, -4 ) ) {
+                                $meta_value = '%' . like_escape( $meta_value ) . '%';
+                                $meta_compare_string = '%s';
+                        } else {
+                                $meta_compare_string = '%s';
+                        }
+
+                        if ( ! empty( $where[$k] ) )
+                                $where[$k] .= ' AND ';
+
+                        $where[$k] = ' (' . $where[$k] . $wpdb->prepare( "CAST($alias.meta_value AS {$meta_type}) {$meta_compare} {$meta_compare_string})", $meta_value );
+                }
+
+                $where = array_filter( $where );
+
+                if ( empty( $where ) )
+                        $where = '';
+                else
+                        $where = ' AND (' . implode( "\n{$this->relation} ", $where ) . ' )';
+
+                $join = implode( "\n", $join );
+                if ( ! empty( $join ) )
+                        $join = ' ' . $join;
+
+                return apply_filters_ref_array( 'get_meta_sql', array( compact( 'join', 'where' ), $this->queries, $type, $primary_table, $primary_id_column, $context ) );
+        }
+}
+
+/**
+ * Retrieve the name of the metadata table for the specified object type.
+ * Plugin Develpres can use the filter bp_meta_tables to add their own table
+ *
+ * @since 1.6.0
+ * @uses $wpdb WordPress database object for queries.
+ *
+ * @param string $type Type of object to get metadata table for (e.g., comment, post, or user)
+ * @return mixed Metadata table name, or false if no metadata table exists
+ */
+function _bp_get_meta_table($type) {
+        global $bp;
+
+        $table_map=array();
+        if(bp_is_action_variable('blogs'))
+            $table_map['activity']=$bp->activity->table_name_meta;
+        if(bp_is_active('groups'))
+            $table_map['group']=$bp->groups->table_name_groupmeta;
+        
+        if(bp_is_active('blogs'))
+            $table_map['blog']=$bp->blogs->table_name_blogmeta;
+                    
+        $table_map=apply_filters('bp_meta_tables',$table_map);//allow plugins to utilize it
+        $table_name = $table_map[$type];
+        
+        return $table_name;
+
+}
+
+
+
+
+

bp-loader.php

@@ -412 +412 @@
                 if ( empty( $this->maintenance_mode ) ) {
 
                         // Require all of the BuddyPress core libraries
+                        require( $this->plugin_dir . 'bp-core/bp-core-meta.php'    );
                         require( $this->plugin_dir . 'bp-core/bp-core-actions.php'    );
                         require( $this->plugin_dir . 'bp-core/bp-core-caps.php'       );
                         require( $this->plugin_dir . 'bp-core/bp-core-cache.php'      );

bp-activity/bp-activity-functions.php

@@ -444 +444 @@
  * @param string $meta_key
  * @param string $meta_value
  *
- * @global object $wpdb
- * @global object $bp BuddyPress global settings
- * @uses wp_cache_delete()
- * @uses is_wp_error()
+ * @uses bp_delete_metadata()
  *
  * @return bool True on success, false on failure
  */
 function bp_activity_delete_meta( $activity_id, $meta_key = '', $meta_value = '' ) {
-        global $wpdb, $bp;
+        
 
         // Return false if any of the above values are not set
         if ( !is_numeric( $activity_id ) )
                 return false;
 
-        // 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
-        $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
-        wp_cache_delete( 'bp_activity_meta_' . $activity_id . '_' . $meta_key, 'bp' );
-
-        // Success
-        if ( !is_wp_error( $retval ) )
-                return true;
-
-        // Fail
-        else
-                return false;
+        return bp_delete_metadata('activity', $activity_id, $meta_key, $meta_value);
 }
 
 /**
@@ -499 +466 @@
  * @param int $activity_id
  * @param string $meta_key
  *
- * @global object $wpdb
- * @global object $bp BuddyPress global settings
- * @uses wp_cache_get()
- * @uses wp_cache_set()
+ * @uses bp_get_metadata
  * @uses apply_filters() To call the 'bp_activity_get_meta' hook
  *
  * @return bool
  */
 function bp_activity_get_meta( $activity_id = 0, $meta_key = '' ) {
-        global $wpdb, $bp;
-
+        
         // Make sure activity_id is valid
         if ( empty( $activity_id ) || !is_numeric( $activity_id ) )
                 return false;
-
+        
+        $metas=array();
         // We have a key to look for
         if ( !empty( $meta_key ) ) {
+            $metas=bp_get_metadata('activity', $activity_id, $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' );
-                }
-
-        // 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' );
-                        }
-                }
-        }
-        
-        // 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 );
 
@@ -564 +498 @@
  * @param int $activity_id
  * @param string $meta_key
  * @param string $meta_value
+ * @uses bp_update_metadat()
  *
- * @global object $wpdb
- * @global object $bp BuddyPress global settings
- * @uses maybe_serialize()
- * @uses bp_activity_delete_meta()
- * @uses wp_cache_set()
- *
  * @return bool True on success, false on failure
  */
 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
-        $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
+            bp_update_metadata('activity', $activity_id, $meta_key, $meta_value);
 
-        // Sanitize value
-        if ( is_string( $meta_value ) )
-                $meta_value = stripslashes( $wpdb->escape( $meta_value ) );
-
-        // Maybe, just maybe... serialize
-        $meta_value = maybe_serialize( $meta_value );
-
-        // If value is empty, delete the meta key
-        if ( empty( $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;
 }

bp-blogs/bp-blogs-functions.php

@@ -573 +573 @@
         if ( !is_numeric( $blog_id ) )
                 return false;
 
-        $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
+        bp_delete_metadata('blog', $blog_id, $meta_key,$meta_value);
+        
 
-        if ( is_array($meta_value) || is_object($meta_value) )
-                $meta_value = serialize($meta_value);
-
-        $meta_value = trim( $meta_value );
-
-        if ( !$meta_key )
-                $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->blogs->table_name_blogmeta} WHERE blog_id = %d", $blog_id ) );
-        else if ( $meta_value )
-                $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->blogs->table_name_blogmeta} WHERE blog_id = %d AND meta_key = %s AND meta_value = %s", $blog_id, $meta_key, $meta_value ) );
-        else
-                $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->blogs->table_name_blogmeta} WHERE blog_id = %d AND meta_key = %s", $blog_id, $meta_key ) );
-
-        wp_cache_delete( 'bp_blogs_blogmeta_' . $blog_id . '_' . $meta_key, 'bp' );
-
         return true;
 }
 
 function bp_blogs_get_blogmeta( $blog_id, $meta_key = '') {
-        global $wpdb, $bp;
+        
 
         $blog_id = (int) $blog_id;
 
         if ( !$blog_id )
                 return false;
+        $metas=bp_get_metadata('blog', $blog_id, $meta_key, false);
 
-        if ( !empty($meta_key) ) {
-                $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
+        
 
-                if ( !$metas = wp_cache_get( 'bp_blogs_blogmeta_' . $blog_id . '_' . $meta_key, 'bp' ) ) {
-                        $metas = $wpdb->get_col( $wpdb->prepare( "SELECT meta_value FROM {$bp->blogs->table_name_blogmeta} WHERE blog_id = %d AND meta_key = %s", $blog_id, $meta_key ) );
-                        wp_cache_set( 'bp_blogs_blogmeta_' . $blog_id . '_' . $meta_key, $metas, 'bp' );
-                }
-        } else {
-                $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM {$bp->blogs->table_name_blogmeta} WHERE blog_id = %d", $blog_id) );
-        }
-
-        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
@@ -627 +597 @@
 }
 
 function bp_blogs_update_blogmeta( $blog_id, $meta_key, $meta_value ) {
-        global $wpdb, $bp;
+        
 
         if ( !is_numeric( $blog_id ) )
                 return false;
 
-        $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
+            bp_update_metadata('blog', $blog_id, $meta_key, $meta_value);
 
-        if ( is_string($meta_value) )
-                $meta_value = stripslashes($wpdb->escape($meta_value));
-
-        $meta_value = maybe_serialize($meta_value);
-
-        if (empty( $meta_value ) )
-                return bp_blogs_delete_blogmeta( $blog_id, $meta_key );
-
-        $cur = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$bp->blogs->table_name_blogmeta} WHERE blog_id = %d AND meta_key = %s", $blog_id, $meta_key ) );
-
-        if ( !$cur )
-                $wpdb->query( $wpdb->prepare( "INSERT INTO {$bp->blogs->table_name_blogmeta} ( blog_id, meta_key, meta_value ) VALUES ( %d, %s, %s )", $blog_id, $meta_key, $meta_value ) );
-        else if ( $cur->meta_value != $meta_value )
-                $wpdb->query( $wpdb->prepare( "UPDATE {$bp->blogs->table_name_blogmeta} SET meta_value = %s WHERE blog_id = %d AND meta_key = %s", $meta_value, $blog_id, $meta_key ) );
-        else
-                return false;
-
-        wp_cache_set( 'bp_blogs_blogmeta_' . $blog_id . '_' . $meta_key, $meta_value, 'bp' );
-
         return true;
 }
 

bp-groups/bp-groups-functions.php

@@ -904 +904 @@
 /*** Group Meta ****************************************************/
 
 function groups_delete_groupmeta( $group_id, $meta_key = false, $meta_value = false ) {
-        global $wpdb, $bp;
+        
 
         if ( !is_numeric( $group_id ) )
                 return false;
 
-        $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
+            bp_delete_metadata('group', $group_id, $meta_key, $meta_value);
 
-        if ( is_array( $meta_value ) || is_object( $meta_value ) )
-                $meta_value = serialize($meta_value);
-
-        $meta_value = trim( $meta_value );
-
-        if ( !$meta_key )
-                $wpdb->query( $wpdb->prepare( "DELETE FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d", $group_id ) );
-        else if ( $meta_value )
-                $wpdb->query( $wpdb->prepare( "DELETE FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d AND meta_key = %s AND meta_value = %s", $group_id, $meta_key, $meta_value ) );
-        else
-                $wpdb->query( $wpdb->prepare( "DELETE FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d AND meta_key = %s", $group_id, $meta_key ) );
-
-        // Delete the cached object
-        wp_cache_delete( 'bp_groups_groupmeta_' . $group_id . '_' . $meta_key, 'bp' );
-
         return true;
 }
 
 function groups_get_groupmeta( $group_id, $meta_key = '') {
-        global $wpdb, $bp;
-
+        
+        
         $group_id = (int) $group_id;
 
         if ( !$group_id )
                 return false;
-
-        if ( !empty($meta_key) ) {
-                $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
-
-                $metas = wp_cache_get( 'bp_groups_groupmeta_' . $group_id . '_' . $meta_key, 'bp' );
-                if ( false === $metas ) {
-                        $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d AND meta_key = %s", $group_id, $meta_key) );
-                        wp_cache_set( 'bp_groups_groupmeta_' . $group_id . '_' . $meta_key, $metas, 'bp' );
-                }
-        } else {
-                $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d", $group_id) );
-        }
-
-        if ( empty( $metas ) ) {
-                if ( empty( $meta_key ) )
-                        return array();
-                else
-                        return '';
-        }
-
-        $metas = array_map( 'maybe_unserialize', (array) $metas );
-
-        if ( 1 == count( $metas ) )
+        
+        $metas=bp_get_metadata('group', $group_id, $meta_key);
+        
+        if ( 1 == count( $metas ) )
                 return $metas[0];
         else
                 return $metas;
 }
 
 function groups_update_groupmeta( $group_id, $meta_key, $meta_value ) {
-        global $wpdb, $bp;
+        
 
         if ( !is_numeric( $group_id ) )
                 return false;
 
-        $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
+            bp_update_metadata('group', $group_id, $meta_key, $meta_value);
 
-        if ( is_string( $meta_value ) )
-                $meta_value = stripslashes( $wpdb->escape( $meta_value ) );
-
-        $meta_value = maybe_serialize( $meta_value );
-
-        $cur = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d AND meta_key = %s", $group_id, $meta_key ) );
-
-        if ( !$cur )
-                $wpdb->query( $wpdb->prepare( "INSERT INTO " . $bp->groups->table_name_groupmeta . " ( group_id, meta_key, meta_value ) VALUES ( %d, %s, %s )", $group_id, $meta_key, $meta_value ) );
-        else if ( $cur->meta_value != $meta_value )
-                $wpdb->query( $wpdb->prepare( "UPDATE " . $bp->groups->table_name_groupmeta . " SET meta_value = %s WHERE group_id = %d AND meta_key = %s", $meta_value, $group_id, $meta_key ) );
-        else
-                return false;
-
-        // Update the cached object and recache
-        wp_cache_set( 'bp_groups_groupmeta_' . $group_id . '_' . $meta_key, $meta_value, 'bp' );
-
         return true;
 }