Wordpress 3.7
[autoinstalls/wordpress.git] / wp-includes / meta.php
index a318bbe21c090100dfa46734e718abf3e8cfaee2..4066781af07133b750084c6c3ae9722b2efc2608 100644 (file)
@@ -2,8 +2,8 @@
 /**
  * Metadata API
  *
- * Functions for retrieving and manipulating metadata of various WordPress object types.  Metadata
- * for an object is a represented by a simple key-value pair.  Objects may contain multiple
+ * Functions for retrieving and manipulating metadata of various WordPress object 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 WordPress
  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
  * @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
+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
+ * @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.
+ * @return int|bool The meta ID on successful update, false on failure.
  */
 function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique = false) {
        if ( !$meta_type || !$meta_key )
@@ -40,11 +40,11 @@ function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique =
 
        global $wpdb;
 
-       $column = esc_sql($meta_type . '_id');
+       $column = sanitize_key($meta_type . '_id');
 
        // expected_slashed ($meta_key)
-       $meta_key = stripslashes($meta_key);
-       $meta_value = stripslashes_deep($meta_value);
+       $meta_key = wp_unslash($meta_key);
+       $meta_value = wp_unslash($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 );
@@ -80,7 +80,7 @@ function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique =
 }
 
 /**
- * Update metadata for the specified object.  If no value already exists for the specified object
+ * 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 2.9.0
@@ -93,9 +93,9 @@ function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique =
  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
  * @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.
+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
+ * @param mixed $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 update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_value = '') {
@@ -110,22 +110,19 @@ function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_v
 
        global $wpdb;
 
-       $column = esc_sql($meta_type . '_id');
+       $column = sanitize_key($meta_type . '_id');
        $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
 
        // expected_slashed ($meta_key)
-       $meta_key = stripslashes($meta_key);
+       $meta_key = wp_unslash($meta_key);
        $passed_value = $meta_value;
-       $meta_value = stripslashes_deep($meta_value);
+       $meta_value = wp_unslash($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 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 = get_metadata($meta_type, $object_id, $meta_key);
@@ -135,6 +132,9 @@ function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_v
                }
        }
 
+       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 add_metadata($meta_type, $object_id, $meta_key, $passed_value);
+
        $_meta_value = $meta_value;
        $meta_value = maybe_serialize( $meta_value );
 
@@ -151,7 +151,9 @@ function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_v
        if ( 'post' == $meta_type )
                do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
 
-       $wpdb->update( $table, $data, $where );
+       $result = $wpdb->update( $table, $data, $where );
+       if ( ! $result )
+               return false;
 
        wp_cache_delete($object_id, $meta_type . '_meta');
 
@@ -174,10 +176,10 @@ function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_v
  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
  * @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
+ * @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar. 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.
  */
@@ -193,11 +195,11 @@ function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $d
 
        global $wpdb;
 
-       $type_column = esc_sql($meta_type . '_id');
+       $type_column = sanitize_key($meta_type . '_id');
        $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
        // expected_slashed ($meta_key)
-       $meta_key = stripslashes($meta_key);
-       $meta_value = stripslashes_deep($meta_value);
+       $meta_key = wp_unslash($meta_key);
+       $meta_value = wp_unslash($meta_value);
 
        $check = apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all );
        if ( null !== $check )
@@ -223,6 +225,7 @@ function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $d
 
        do_action( "delete_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
 
+       // Old-style action.
        if ( 'post' == $meta_type )
                do_action( 'delete_postmeta', $meta_ids );
 
@@ -243,6 +246,7 @@ function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $d
 
        do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
 
+       // Old-style action.
        if ( 'post' == $meta_type )
                do_action( 'deleted_postmeta', $meta_ids );
 
@@ -256,10 +260,10 @@ function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $d
  *
  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
  * @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
+ * @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.
+ * @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 get_metadata($meta_type, $object_id, $meta_key = '', $single = false) {
@@ -395,7 +399,7 @@ function update_metadata_by_mid( $meta_type, $meta_id, $meta_value, $meta_key =
        if ( ! $table = _get_meta_table( $meta_type ) )
                return false;
 
-       $column = esc_sql($meta_type . '_id');
+       $column = sanitize_key($meta_type . '_id');
        $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
 
        // Fetch the meta and go on if it's found.
@@ -433,7 +437,9 @@ function update_metadata_by_mid( $meta_type, $meta_id, $meta_value, $meta_key =
                        do_action( 'update_postmeta', $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' );
+               $result = $wpdb->update( $table, $data, $where, '%s', '%d' );
+               if ( ! $result )
+                       return false;
 
                // Clear the caches.
                wp_cache_delete($object_id, $meta_type . '_meta');
@@ -443,7 +449,7 @@ function update_metadata_by_mid( $meta_type, $meta_id, $meta_value, $meta_key =
                if ( 'post' == $meta_type )
                        do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
 
-               return $result;
+               return true;
        }
 
        // And if the meta was not found.
@@ -476,7 +482,7 @@ function delete_metadata_by_mid( $meta_type, $meta_id ) {
                return false;
 
        // object and id columns
-       $column = esc_sql($meta_type . '_id');
+       $column = sanitize_key($meta_type . '_id');
        $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
 
        // Fetch the meta and go on if it's found.
@@ -485,19 +491,21 @@ function delete_metadata_by_mid( $meta_type, $meta_id ) {
 
                do_action( "delete_{$meta_type}_meta", (array) $meta_id, $object_id, $meta->meta_key, $meta->meta_value );
 
-               if ( 'post' == $meta_type )
-                       do_action( 'delete_postmeta', $meta_id );
+               // Old-style action.
+               if ( 'post' == $meta_type || 'comment' == $meta_type )
+                       do_action( "delete_{$meta_type}meta", $meta_id );
 
                // Run the query, will return true if deleted, false otherwise
-               $result = (bool) $wpdb->query( $wpdb->prepare( "DELETE FROM $table WHERE $id_column = %d LIMIT 1;", $meta_id ) );
+               $result = (bool) $wpdb->delete( $table, array( $id_column => $meta_id ) );
 
                // Clear the caches.
                wp_cache_delete($object_id, $meta_type . '_meta');
 
                do_action( "deleted_{$meta_type}_meta", (array) $meta_id, $object_id, $meta->meta_key, $meta->meta_value );
 
-               if ( 'post' == $meta_type )
-                       do_action( 'deleted_postmeta', $meta_id );
+               // Old-style action.
+               if ( 'post' == $meta_type || 'comment' == $meta_type )
+                       do_action( "deleted_{$meta_type}meta", $meta_id );
 
                return $result;
 
@@ -524,7 +532,7 @@ function update_meta_cache($meta_type, $object_ids) {
        if ( ! $table = _get_meta_table($meta_type) )
                return false;
 
-       $column = esc_sql($meta_type . '_id');
+       $column = sanitize_key($meta_type . '_id');
 
        global $wpdb;
 
@@ -610,7 +618,8 @@ class WP_Meta_Query {
        * - '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'.
+       *              Possible values: '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN',
+       *              'BETWEEN', 'NOT BETWEEN', 'REGEXP', 'NOT REGEXP', 'RLIKE'.
        *              Default: '='
        * - 'type' string (optional) The type of the value.
        *              Possible values: 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'.
@@ -674,7 +683,7 @@ class WP_Meta_Query {
                }
 
                // WP_Query sets 'meta_value' = '' by default
-               if ( isset( $qv[ 'meta_value' ] ) && '' !== $qv[ 'meta_value' ] )
+               if ( isset( $qv[ 'meta_value' ] ) && '' !== $qv[ 'meta_value' ] && ( ! is_array( $qv[ 'meta_value' ] ) || $qv[ 'meta_value' ] ) )
                        $meta_query[0]['value'] = $qv[ 'meta_value' ];
 
                if ( !empty( $qv['meta_query'] ) && is_array( $qv['meta_query'] ) ) {
@@ -684,6 +693,29 @@ class WP_Meta_Query {
                $this->__construct( $meta_query );
        }
 
+       /**
+        * Given a meta type, return the appropriate alias if applicable
+        *
+        * @since 3.7.0
+        *
+        * @param string $type MySQL type to cast meta_value
+        * @return string MySQL type
+        */
+       function get_cast_for_type( $type = '' ) {
+               if ( empty( $type ) )
+                       return 'CHAR';
+
+               $meta_type = strtoupper( $type );
+
+               if ( ! in_array( $meta_type, array( 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED', 'NUMERIC' ) ) )
+                       return 'CHAR';
+
+               if ( 'NUMERIC' == $meta_type )
+                       $meta_type = 'SIGNED';
+
+               return $meta_type;
+       }
+
        /**
         * Generates SQL clauses to be appended to a main query.
         *
@@ -702,24 +734,76 @@ class WP_Meta_Query {
                if ( ! $meta_table = _get_meta_table( $type ) )
                        return false;
 
-               $meta_id_column = esc_sql( $type . '_id' );
+               $meta_id_column = sanitize_key( $type . '_id' );
 
                $join = array();
                $where = array();
 
+               $key_only_queries = array();
+               $queries = array();
+
+               // Split out the queries with empty arrays as value
                foreach ( $this->queries as $k => $q ) {
+                       if ( isset( $q['value'] ) && is_array( $q['value'] ) && empty( $q['value'] ) ) {
+                               $key_only_queries[$k] = $q;
+                               unset( $this->queries[$k] );
+                       }
+               }
+
+               // Split out the meta_key only queries (we can only do this for OR)
+               if ( 'OR' == $this->relation ) {
+                       foreach ( $this->queries as $k => $q ) {
+                               if ( ! isset( $q['value'] ) && ! empty( $q['key'] ) )
+                                       $key_only_queries[$k] = $q;
+                               else
+                                       $queries[$k] = $q;
+                       }
+               } else {
+                       $queries = $this->queries;
+               }
+
+               // Specify all the meta_key only queries in one go
+               if ( $key_only_queries ) {
+                       $join[]  = "INNER JOIN $meta_table ON $primary_table.$primary_id_column = $meta_table.$meta_id_column";
+
+                       foreach ( $key_only_queries as $key => $q )
+                               $where["key-only-$key"] = $wpdb->prepare( "$meta_table.meta_key = %s", trim( $q['key'] ) );
+               }
+
+               foreach ( $queries as $k => $q ) {
                        $meta_key = isset( $q['key'] ) ? trim( $q['key'] ) : '';
-                       $meta_type = isset( $q['type'] ) ? strtoupper( $q['type'] ) : 'CHAR';
+                       $meta_type = $this->get_cast_for_type( isset( $q['type'] ) ? $q['type'] : '' );
 
-                       if ( 'NUMERIC' == $meta_type )
-                               $meta_type = 'SIGNED';
-                       elseif ( ! in_array( $meta_type, array( 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED' ) ) )
-                               $meta_type = 'CHAR';
+                       $meta_value = isset( $q['value'] ) ? $q['value'] : null;
+
+                       if ( isset( $q['compare'] ) )
+                               $meta_compare = strtoupper( $q['compare'] );
+                       else
+                               $meta_compare = is_array( $meta_value ) ? 'IN' : '=';
+
+                       if ( ! in_array( $meta_compare, array(
+                               '=', '!=', '>', '>=', '<', '<=',
+                               'LIKE', 'NOT LIKE',
+                               'IN', 'NOT IN',
+                               'BETWEEN', 'NOT BETWEEN',
+                               'NOT EXISTS',
+                               'REGEXP', 'NOT REGEXP', 'RLIKE'
+                       ) ) )
+                               $meta_compare = '=';
 
                        $i = count( $join );
                        $alias = $i ? 'mt' . $i : $meta_table;
 
-                       // Set JOIN
+                       if ( 'NOT EXISTS' == $meta_compare ) {
+                               $join[$i]  = "LEFT JOIN $meta_table";
+                               $join[$i] .= $i ? " AS $alias" : '';
+                               $join[$i] .= " ON ($primary_table.$primary_id_column = $alias.$meta_id_column AND $alias.meta_key = '$meta_key')";
+
+                               $where[$k] = ' ' . $alias . '.' . $meta_id_column . ' IS NULL';
+
+                               continue;
+                       }
+
                        $join[$i]  = "INNER JOIN $meta_table";
                        $join[$i] .= $i ? " AS $alias" : '';
                        $join[$i] .= " ON ($primary_table.$primary_id_column = $alias.$meta_id_column)";
@@ -728,21 +812,12 @@ class WP_Meta_Query {
                        if ( !empty( $meta_key ) )
                                $where[$k] = $wpdb->prepare( "$alias.meta_key = %s", $meta_key );
 
-                       if ( !isset( $q['value'] ) ) {
+                       if ( is_null( $meta_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 );
@@ -861,5 +936,3 @@ function register_meta( $meta_type, $meta_key, $sanitize_callback, $auth_callbac
        if ( is_callable( $auth_callback ) )
                add_filter( "auth_{$meta_type}_meta_{$meta_key}", $auth_callback, 10, 6 );
 }
-
-?>