From c67e70dd91a6abda17af8f9cbf01a9537cca227e Mon Sep 17 00:00:00 2001 From: westi Date: Thu, 17 Sep 2009 20:17:33 +0000 Subject: [PATCH] First pass commentmeta implementation. See #2659 props scribu. git-svn-id: http://svn.automattic.com/wordpress/trunk@11943 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/schema.php | 9 ++ wp-includes/comment.php | 82 ++++++++++++++ wp-includes/meta.php | 212 +++++++++++++++++++++++++++++++++++ wp-includes/post.php | 155 +------------------------ wp-includes/version.php | 2 +- wp-includes/wp-db.php | 11 +- wp-settings.php | 1 + 7 files changed, 320 insertions(+), 152 deletions(-) create mode 100644 wp-includes/meta.php diff --git a/wp-admin/includes/schema.php b/wp-admin/includes/schema.php index f735c9e4b..ef8ade2c9 100644 --- a/wp-admin/includes/schema.php +++ b/wp-admin/includes/schema.php @@ -54,6 +54,15 @@ CREATE TABLE $wpdb->term_relationships ( PRIMARY KEY (object_id,term_taxonomy_id), KEY term_taxonomy_id (term_taxonomy_id) ) $charset_collate; +CREATE TABLE $wpdb->commentmeta ( + meta_id bigint(20) unsigned NOT NULL auto_increment, + comment_id bigint(20) unsigned NOT NULL default '0', + meta_key varchar(255) default NULL, + meta_value longtext, + PRIMARY KEY (meta_id), + KEY post_id (comment_id), + KEY meta_key (meta_key) +) $charset_collate; CREATE TABLE $wpdb->comments ( comment_ID bigint(20) unsigned NOT NULL auto_increment, comment_post_ID bigint(20) unsigned NOT NULL default '0', diff --git a/wp-includes/comment.php b/wp-includes/comment.php index 3020772be..8c91b5d5a 100644 --- a/wp-includes/comment.php +++ b/wp-includes/comment.php @@ -361,6 +361,88 @@ function get_comment_count( $post_id = 0 ) { return $comment_count; } +// +// Comment meta functions +// + +/** + * Add meta data field to a comment. + * + * Post meta data is called "Custom Fields" on the Administration Panels. + * + * @since 2.9 + * @uses add_metadata + * @link http://codex.wordpress.org/Function_Reference/add_comment_meta + * + * @param int $comment_id Post ID. + * @param string $key Metadata name. + * @param mixed $value Metadata value. + * @param bool $unique Optional, default is false. Whether the same key should not be added. + * @return bool False for failure. True for success. + */ +function add_comment_meta($comment_id, $meta_key, $meta_value, $unique = false) { + return add_metadata('comment', $comment_id, $meta_key, $meta_value, $unique); +} + +/** + * Remove metadata matching criteria from a comment. + * + * You can match based on the key, or key and value. Removing based on key and + * value, will keep from removing duplicate metadata with the same key. It also + * allows removing all metadata matching key, if needed. + * + * @since 2.9 + * @uses delete_metadata + * @link http://codex.wordpress.org/Function_Reference/delete_comment_meta + * + * @param int $comment_id comment ID + * @param string $meta_key Metadata name. + * @param mixed $meta_value Optional. Metadata value. + * @return bool False for failure. True for success. + */ +function delete_comment_meta($comment_id, $meta_key, $meta_value = '') { + return delete_metadata('comment', $comment_id, $meta_key, $meta_value); +} + +/** + * Retrieve comment meta field for a comment. + * + * @since 2.9 + * @uses get_metadata + * @link http://codex.wordpress.org/Function_Reference/get_comment_meta + * + * @param int $comment_id Post ID. + * @param string $key The meta key to retrieve. + * @param bool $single Whether to return a single value. + * @return mixed Will be an array if $single is false. Will be value of meta data field if $single + * is true. + */ +function get_comment_meta($comment_id, $key, $single = false) { + return get_metadata('comment', $comment_id, $key, $single); +} + +/** + * Update comment meta field based on comment ID. + * + * Use the $prev_value parameter to differentiate between meta fields with the + * same key and comment ID. + * + * If the meta field for the comment does not exist, it will be added. + * + * @since 2.9 + * @uses update_metadata + * @link http://codex.wordpress.org/Function_Reference/update_comment_meta + * + * @param int $comment_id Post ID. + * @param string $key Metadata key. + * @param mixed $value Metadata value. + * @param mixed $prev_value Optional. Previous value to check before removing. + * @return bool False on failure, true if success. + */ +function update_comment_meta($comment_id, $meta_key, $meta_value, $prev_value = '') { + return update_metadata('comment', $comment_id, $meta_key, $meta_value, $prev_value); +} + /** * Sanitizes the cookies sent to the user already. * diff --git a/wp-includes/meta.php b/wp-includes/meta.php new file mode 100644 index 000000000..597bc9cb3 --- /dev/null +++ b/wp-includes/meta.php @@ -0,0 +1,212 @@ +get_var( $wpdb->prepare( + "SELECT COUNT(*) FROM $table WHERE meta_key = %s AND $column = %d", + $meta_key, $object_id ) ) ) + return false; + + $meta_value = maybe_serialize( stripslashes_deep($meta_value) ); + + $wpdb->insert( $table, array( + $column => $object_id, + 'meta_key' => $meta_key, + 'meta_value' => $meta_value + ) ); + + wp_cache_delete($object_id, $meta_type . '_meta'); + + do_action( "added_{$meta_type}_meta", $wpdb->insert_id, $object_id, $meta_key, $meta_value ); + + return true; +} + +function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_value = '') { + if ( !$meta_type || !$meta_key ) + return false; + + if ( ! $table = _get_meta_table($meta_type) ) + return false; + + global $wpdb; + + $column = esc_sql($meta_type . '_id'); + + // expected_slashed ($meta_key) + $meta_key = stripslashes($meta_key); + + if ( ! $wpdb->get_var( $wpdb->prepare( "SELECT meta_key FROM $table WHERE meta_key = %s AND $column = %d", $meta_key, $object_id ) ) ) + return add_metadata($meta_type, $object_id, $meta_key, $meta_value); + + $meta_value = maybe_serialize( stripslashes_deep($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, $meta_type . '_meta'); + + do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $meta_value ); + + return true; +} + +function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '') { + if ( !$meta_type || !$meta_key ) + return false; + + if ( ! $table = _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 = maybe_serialize( stripslashes_deep($meta_value) ); + + $query = $wpdb->prepare( "DELETE FROM $table WHERE meta_key = %s", $meta_key ); + + if ( $meta_value ) + $query .= $wpdb->prepare("AND meta_value = %s", $meta_value ); + + $count = $wpdb->query($query); + + if ( !$count ) + return false; + + wp_cache_delete($object_id, $meta_type . '_meta'); + + do_action( "deleted_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $meta_value ); + + return true; +} + +function get_metadata($meta_type, $object_id, $meta_key = '', $single = false) { + if ( !$meta_type ) + return false; + + $meta_cache = wp_cache_get($object_id, $meta_type . '_meta'); + + if ( !$meta_cache ) { + update_meta_cache($meta_type, $object_id); + $meta_cache = wp_cache_get($object_id, $meta_type . '_meta'); + } + + 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]); + } + } + + return false; +} + +function update_meta_cache($meta_type, $object_ids) { + if ( empty( $meta_type ) || empty( $object_ids ) ) + return false; + + if ( ! $table = _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 = $meta_type . '_meta'; + $ids = array(); + foreach ( $object_ids as $id ) { + if ( false === wp_cache_get($id, $cache_key) ) + $ids[] = $id; + } + + if ( empty( $ids ) ) + return false; + + // Get meta info + $id_list = join(',', $ids); + $cache = array(); + $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(); + } + + foreach ( array_keys($cache) as $object) + wp_cache_set($object, $cache[$object], $cache_key); + + return $cache; +} + +function _get_meta_table($type) { + global $wpdb; + + $table_name = $type . 'meta'; + + if ( empty($wpdb->$table_name) ) + return false; + + return $wpdb->$table_name; +} +?> \ No newline at end of file diff --git a/wp-includes/post.php b/wp-includes/post.php index e3ae274b5..b2fe6968c 100644 --- a/wp-includes/post.php +++ b/wp-includes/post.php @@ -511,30 +511,11 @@ function get_posts($args = null) { * @return bool False for failure. True for success. */ function add_post_meta($post_id, $meta_key, $meta_value, $unique = false) { - if ( !$meta_key ) - return false; - - global $wpdb; - // make sure meta is added to the post, not a revision if ( $the_post = wp_is_post_revision($post_id) ) $post_id = $the_post; - // expected_slashed ($meta_key) - $meta_key = stripslashes($meta_key); - - if ( $unique && $wpdb->get_var( $wpdb->prepare( "SELECT meta_key FROM $wpdb->postmeta WHERE meta_key = %s AND post_id = %d", $meta_key, $post_id ) ) ) - return false; - - $meta_value = maybe_serialize( stripslashes_deep($meta_value) ); - - $wpdb->insert( $wpdb->postmeta, compact( 'post_id', 'meta_key', 'meta_value' ) ); - - wp_cache_delete($post_id, 'post_meta'); - - do_action( 'added_post_meta', $wpdb->insert_id, $post_id, $meta_key, $meta_value ); - - return true; + return add_metadata('post', $post_id, $meta_key, $meta_value, $unique); } /** @@ -554,39 +535,11 @@ function add_post_meta($post_id, $meta_key, $meta_value, $unique = false) { * @return bool False for failure. True for success. */ function delete_post_meta($post_id, $meta_key, $meta_value = '') { - global $wpdb; - // make sure meta is added to the post, not a revision if ( $the_post = wp_is_post_revision($post_id) ) $post_id = $the_post; - // expected_slashed ($meta_key, $meta_value) - $meta_key = stripslashes( $meta_key ); - $meta_value = maybe_serialize( stripslashes_deep($meta_value) ); - - if ( !$meta_key ) - return false; - - if ( empty( $meta_value ) ) - $meta_id = $wpdb->get_var( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = %s", $post_id, $meta_key ) ); - else - $meta_id = $wpdb->get_var( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = %s AND meta_value = %s", $post_id, $meta_key, $meta_value ) ); - - if ( !$meta_id ) - return false; - - do_action( 'delete_post_meta', $meta_id, $post_id, $meta_key, $meta_value ); - - if ( empty( $meta_value ) ) - $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = %s", $post_id, $meta_key ) ); - else - $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = %s AND meta_value = %s", $post_id, $meta_key, $meta_value ) ); - - wp_cache_delete($post_id, 'post_meta'); - - do_action( 'deleted_post_meta', $meta_id, $post_id, $meta_key, $meta_value ); - - return true; + return delete_metadata('post', $post_id, $meta_key, $meta_value); } /** @@ -603,27 +556,7 @@ function delete_post_meta($post_id, $meta_key, $meta_value = '') { * is true. */ function get_post_meta($post_id, $key, $single = false) { - if ( !$key ) - return ''; - - $post_id = (int) $post_id; - - $meta_cache = wp_cache_get($post_id, 'post_meta'); - - if ( !$meta_cache ) { - update_postmeta_cache($post_id); - $meta_cache = wp_cache_get($post_id, 'post_meta'); - } - - if ( isset($meta_cache[$key]) ) { - if ( $single ) { - return maybe_unserialize( $meta_cache[$key][0] ); - } else { - return array_map('maybe_unserialize', $meta_cache[$key]); - } - } - - return ''; + return get_metadata('post', $post_id, $key, $single); } /** @@ -645,40 +578,11 @@ function get_post_meta($post_id, $key, $single = false) { * @return bool False on failure, true if success. */ function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') { - global $wpdb; - // make sure meta is added to the post, not a revision if ( $the_post = wp_is_post_revision($post_id) ) $post_id = $the_post; - // expected_slashed ($meta_key) - $meta_key = stripslashes($meta_key); - - if ( !$meta_key ) - return false; - - $meta_id = $wpdb->get_var( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = %s AND post_id = %d", $meta_key, $post_id ) ); - if ( ! $meta_id ) - return add_post_meta($post_id, $meta_key, $meta_value); - - $meta_value = maybe_serialize( stripslashes_deep($meta_value) ); - - $data = compact( 'meta_value' ); - $where = compact( 'meta_key', 'post_id' ); - - if ( !empty( $prev_value ) ) { - $prev_value = maybe_serialize($prev_value); - $where['meta_value'] = $prev_value; - } - - do_action( 'update_post_meta', $meta_id, $post_id, $meta_key, $meta_value ); - - $wpdb->update( $wpdb->postmeta, $data, $where ); - wp_cache_delete($post_id, 'post_meta'); - - do_action( 'updated_post_meta', $meta_id, $post_id, $meta_key, $meta_value ); - - return true; + return update_metadata('post', $post_id, $meta_key, $meta_value, $prev_value); } /** @@ -3304,56 +3208,7 @@ function update_post_caches(&$posts) { * @return bool|array Returns false if there is nothing to update or an array of metadata. */ function update_postmeta_cache($post_ids) { - global $wpdb; - - if ( empty( $post_ids ) ) - return false; - - if ( !is_array($post_ids) ) { - $post_ids = preg_replace('|[^0-9,]|', '', $post_ids); - $post_ids = explode(',', $post_ids); - } - - $post_ids = array_map('intval', $post_ids); - - $ids = array(); - foreach ( (array) $post_ids as $id ) { - if ( false === wp_cache_get($id, 'post_meta') ) - $ids[] = $id; - } - - if ( empty( $ids ) ) - return false; - - // Get post-meta info - $id_list = join(',', $ids); - $cache = array(); - if ( $meta_list = $wpdb->get_results("SELECT post_id, meta_key, meta_value FROM $wpdb->postmeta WHERE post_id IN ($id_list)", ARRAY_A) ) { - foreach ( (array) $meta_list as $metarow) { - $mpid = (int) $metarow['post_id']; - $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 ( (array) $ids as $id ) { - if ( ! isset($cache[$id]) ) - $cache[$id] = array(); - } - - foreach ( (array) array_keys($cache) as $post) - wp_cache_set($post, $cache[$post], 'post_meta'); - - return $cache; + return update_meta_cache('post', $post_ids); } // diff --git a/wp-includes/version.php b/wp-includes/version.php index 5bc2b2c64..a9bf4741f 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -15,7 +15,7 @@ $wp_version = '2.9-rare'; * * @global int $wp_db_version */ -$wp_db_version = 11557; +$wp_db_version = 11943; /** * Holds the TinyMCE version diff --git a/wp-includes/wp-db.php b/wp-includes/wp-db.php index f14074b36..b04ae8b43 100644 --- a/wp-includes/wp-db.php +++ b/wp-includes/wp-db.php @@ -208,6 +208,15 @@ class wpdb { */ var $postmeta; + /** + * WordPress Comment Metadata table + * + * @since 2.9 + * @access public + * @var string + */ + var $commentmeta; + /** * WordPress User Metadata table * @@ -252,7 +261,7 @@ class wpdb { * @var array */ var $tables = array('users', 'usermeta', 'posts', 'categories', 'post2cat', 'comments', 'links', 'link2cat', 'options', - 'postmeta', 'terms', 'term_taxonomy', 'term_relationships'); + 'postmeta', 'terms', 'term_taxonomy', 'term_relationships', 'commentmeta'); /** * List of deprecated WordPress tables diff --git a/wp-settings.php b/wp-settings.php index e66124468..099d7e0e3 100644 --- a/wp-settings.php +++ b/wp-settings.php @@ -332,6 +332,7 @@ require (ABSPATH . WPINC . '/capabilities.php'); require (ABSPATH . WPINC . '/query.php'); require (ABSPATH . WPINC . '/theme.php'); require (ABSPATH . WPINC . '/user.php'); +require (ABSPATH . WPINC . '/meta.php'); require (ABSPATH . WPINC . '/general-template.php'); require (ABSPATH . WPINC . '/link-template.php'); require (ABSPATH . WPINC . '/author-template.php');