Improve user listing performance. Props miqrogroove. see #11914

git-svn-id: http://svn.automattic.com/wordpress/trunk@13576 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-admin/includes/schema.php

@@ -146,7 +146,8 @@ CREATE TABLE $wpdb->posts (
   PRIMARY KEY  (ID),
   KEY post_name (post_name),
   KEY type_status_date (post_type,post_status,post_date,ID),
-  KEY post_parent (post_parent)
+  KEY post_parent (post_parent),
+  KEY post_author (post_author)
 ) $charset_collate;
 CREATE TABLE $wpdb->users (
   ID bigint(20) unsigned NOT NULL auto_increment,

wp-admin/includes/template.php

@@ -1824,16 +1824,17 @@ function _page_rows( &$children_pages, &$count, $parent, $level, $pagenum, $per_
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Generate HTML for a single row on the users.php admin panel.
  *
- * @since unknown
+ * @since 2.1.0
  *
- * @param unknown_type $user_object
+ * @param object $user_object
- * @param unknown_type $style
+ * @param string $style Optional. Attributes added to the TR element.  Must be sanitized.
- * @param unknown_type $role
+ * @param string $role Key for the $wp_roles array.
- * @return unknown
+ * @param int $numposts Optional. Post count to display for this user.  Defaults to zero, as in, a new user has made zero posts.
+ * @return string
  */
-function user_row( $user_object, $style = '', $role = '' ) {
+function user_row( $user_object, $style = '', $role = '', $numposts = 0 ) {
 	global $wp_roles;
 
 	$current_user = wp_get_current_user();
@@ -1849,7 +1850,6 @@ function user_row( $user_object, $style = '', $role = '' ) {
 		$short_url = substr( $short_url, 0, -1 );
 	if ( strlen( $short_url ) > 35 )
 		$short_url = substr( $short_url, 0, 32 ).'...';
-	$numposts = get_usernumposts( $user_object->ID );
 	$checkbox = '';
 	// Check if the user for this row is editable
 	if ( current_user_can( 'edit_user', $user_object->ID ) ) {

wp-admin/users.php

@@ -208,9 +208,15 @@ default:
 	$userspage = isset($_GET['userspage']) ? $_GET['userspage'] : null;
 	$role = isset($_GET['role']) ? $_GET['role'] : null;
 
-	// Query the users
+	// Query the user IDs for this page
 	$wp_user_search = new WP_User_Search($usersearch, $userspage, $role);
 
+	// Query the post counts for this page
+	$post_counts = count_many_users_posts($wp_user_search->get_results());
+
+	// Query the users for this page
+	cache_users($wp_user_search->get_results());
+
 	$messages = array();
 	if ( isset($_GET['update']) ) :
 		switch($_GET['update']) {
@@ -263,22 +269,14 @@ if ( isset($_GET['usersearch']) && $_GET['usersearch'] )
 <form id="list-filter" action="" method="get">
 <ul class="subsubsub">
 <?php
-$role_links = array();
+$users_of_blog = count_users();
-$avail_roles = array();
+$total_users = $users_of_blog['total_users'];
-$users_of_blog = get_users_of_blog();
+$avail_roles =& $users_of_blog['avail_roles'];
-$total_users = count( $users_of_blog );
-foreach ( (array) $users_of_blog as $b_user ) {
-	$b_roles = unserialize($b_user->meta_value);
-	foreach ( (array) $b_roles as $b_role => $val ) {
-		if ( !isset($avail_roles[$b_role]) )
-			$avail_roles[$b_role] = 0;
-		$avail_roles[$b_role]++;
-	}
-}
 unset($users_of_blog);
 
 $current_role = false;
 $class = empty($role) ? ' class="current"' : '';
+$role_links = array();
 $role_links[] = "<li><a href='users.php'$class>" . sprintf( _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $total_users, 'users' ), number_format_i18n( $total_users ) ) . '</a>';
 foreach ( $wp_roles->get_names() as $this_role => $name ) {
 	if ( !isset($avail_roles[$this_role]) )
@@ -372,7 +370,7 @@ foreach ( $wp_user_search->get_results() as $userid ) {
 	$role = array_shift($roles);
 
 	$style = ( ' class="alternate"' == $style ) ? '' : ' class="alternate"';
-	echo "\n\t" . user_row($user_object, $style, $role);
+	echo "\n\t", user_row($user_object, $style, $role, $post_counts[(string)$userid]);
 }
 ?>
 </tbody>

wp-includes/author-template.php

@@ -151,12 +151,12 @@ function the_author_link() {
  *
  * @since 1.5
  * @uses $post The current post in the Loop's DB object.
- * @uses get_usernumposts()
+ * @uses count_user_posts()
  * @return int The number of posts by the author.
  */
 function get_the_author_posts() {
 	global $post;
-	return get_usernumposts($post->post_author);
+	return count_user_posts($post->post_author);
 }
 
 /**

wp-includes/pluggable.php

@@ -139,6 +139,38 @@ function get_userdata( $user_id ) {
 }
 endif;
 
+if ( !function_exists('cache_users') ) :
+/**
+ * Retrieve info for user lists to prevent multiple queries by get_userdata()
+ *
+ * @since 3.0.0
+ *
+ * @param array $users User ID numbers list
+ */
+function cache_users( $users ) {
+	global $wpdb;
+
+	$clean = array();
+	foreach($users as $id) {
+		$id = (int) $id;
+		if (wp_cache_get($id, 'users')) {
+			// seems to be cached already
+		} else {
+			$clean[] = $id;
+		}
+	}
+
+	if ( 0 == count($clean) )
+		return;
+
+	$list = implode(',', $clean);
+
+	$results = $wpdb->get_results("SELECT * FROM $wpdb->users WHERE ID IN ($list)");
+    
+	_fill_many_users($results);
+}
+endif;
+
 if ( !function_exists('get_user_by') ) :
 /**
  * Retrieve user info by a given field

wp-includes/post.php

@@ -3652,8 +3652,22 @@ function wp_check_for_changed_slugs($post_id) {
  * @return string SQL code that can be added to a where clause.
  */
 function get_private_posts_cap_sql($post_type) {
-	global $user_ID;
+	return get_posts_by_author_sql($post_type, FALSE);
-	$cap = '';
+}
+
+/**
+ * Retrieve the post SQL based on capability, author, and type.
+ *
+ * See above for full description.
+ *
+ * @since 3.0.0
+ * @param string $post_type currently only supports 'post' or 'page'.
+ * @param bool $full Optional.  Returns a full WHERE statement instead of just an 'andalso' term.
+ * @param int $post_author Optional.  Query posts having a single author ID.
+ * @return string SQL WHERE code that can be added to a query.
+ */
+function get_posts_by_author_sql($post_type, $full = TRUE, $post_author = NULL) {
+	global $user_ID, $wpdb;
 
 	// Private posts
 	if ($post_type == 'post') {
@@ -3663,24 +3677,40 @@ function get_private_posts_cap_sql($post_type) {
 		$cap = 'read_private_pages';
 	// Dunno what it is, maybe plugins have their own post type?
 	} else {
+		$cap = '';
 		$cap = apply_filters('pub_priv_sql_capability', $cap);
 
 		if (empty($cap)) {
 			// We don't know what it is, filters don't change anything,
 			// so set the SQL up to return nothing.
-			return '1 = 0';
+			return ' 1 = 0 ';
 		}
 	}
 
-	$sql = '(post_status = \'publish\'';
+	if ($full) {
+		if (is_null($post_author)) {
+			$sql = $wpdb->prepare('WHERE post_type = %s AND ', $post_type);
+		} else {
+			$sql = $wpdb->prepare('WHERE post_author = %d AND post_type = %s AND ', $post_author, $post_type);
+		}
+	} else {
+		$sql = '';
+	}
+
+	$sql .= "(post_status = 'publish'";
 
 	if (current_user_can($cap)) {
 		// Does the user have the capability to view private posts? Guess so.
-		$sql .= ' OR post_status = \'private\'';
+		$sql .= " OR post_status = 'private'";
 	} elseif (is_user_logged_in()) {
 		// Users can view their own private posts.
-		$sql .= ' OR post_status = \'private\' AND post_author = \'' . $user_ID . '\'';
+		$id = (int) $user_ID;
-	}
+		if (is_null($post_author) || !$full) {
+			$sql .= " OR post_status = 'private' AND post_author = $id";
+		} elseif ($id == (int)$post_author) {
+			$sql .= " OR post_status = 'private'";
+		} // else none
+	} // else none
 
 	$sql .= ')';
 

wp-includes/user.php

@@ -148,13 +148,48 @@ function wp_authenticate_cookie($user, $username, $password) {
  * @param int $userid User ID.
  * @return int Amount of posts user has written.
  */
-function get_usernumposts($userid) {
+function count_user_posts($userid) {
 	global $wpdb;
-	$userid = (int) $userid;
+
-	$count = $wpdb->get_var( $wpdb->prepare("SELECT COUNT(*) FROM $wpdb->posts WHERE post_author = %d AND post_type = 'post' AND ", $userid) . get_private_posts_cap_sql('post'));
+	$where = get_posts_by_author_sql('post', TRUE, $userid);
+
+	$count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" );
+
 	return apply_filters('get_usernumposts', $count, $userid);
 }
 
+/**
+ * Number of posts written by a list of users.
+ *
+ * @since 3.0.0
+ * @param array $userid User ID number list.
+ * @return array Amount of posts each user has written.
+ */
+function count_many_users_posts($users) {
+	global $wpdb;
+	
+	if (0 == count($users))
+		return array();
+	    
+	$userlist = implode(',', $users);
+	$where = get_posts_by_author_sql('post');
+
+	$result = $wpdb->get_results( "SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ($userlist) GROUP BY post_author", ARRAY_N );
+
+	$count = array();
+	foreach($result as $row) {
+		$count[$row[0]] = $row[1];
+	}
+
+	foreach($users as $id) {
+		$id = (string) $id;
+		if (!isset($count[$id]))
+			$count[$id] = 0;
+	}
+
+	return $count;
+}
+
 /**
  * Check that the user login name and password is correct.
  *
@@ -342,6 +377,79 @@ function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {
 	return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);
 }
 
+/**
+ * Count number of users who have each of the user roles.
+ *
+ * Assumes there are neither duplicated nor orphaned capabilities meta_values.
+ * Assumes role names are unique phrases.  Same assumption made by WP_User_Search::prepare_query()
+ * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users.
+ * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257.
+ *
+ * @since 3.0.0
+ * @param string $strategy 'time' or 'memory'
+ * @return array Includes a grand total and an array of counts indexed by role strings.
+ */
+function count_users($strategy = 'time') {
+	global $wpdb, $blog_id, $wp_roles;
+
+	// Initialize
+	$id = (int) $blog_id;
+	$blog_prefix = $wpdb->get_blog_prefix($id);
+	$result = array();
+
+	if ('time' == $strategy) {
+		$avail_roles = $wp_roles->get_names();
+
+		// Build a CPU-intensive query that will return concise information.
+		$select_count = array();
+		foreach ( $avail_roles as $this_role => $name ) {
+			$select_count[] = "COUNT(NULLIF(`meta_value` LIKE '%" . like_escape($this_role) . "%', FALSE))";
+		}
+		$select_count = implode(', ', $select_count);
+
+		// Add the meta_value index to the selection list, then run the query.
+		$row = $wpdb->get_row( "SELECT $select_count, COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'", ARRAY_N );
+
+		// Run the previous loop again to associate results with role names.
+		$col = 0;
+		$role_counts = array();
+		foreach ( $avail_roles as $this_role => $name ) {
+			$count = (int) $row[$col++];
+			if ($count > 0) {
+				$role_counts[$this_role] = $count;
+			}
+		}
+
+		// Get the meta_value index from the end of the result set.
+		$total_users = (int) $row[$col];
+
+		$result['total_users'] = $total_users;
+		$result['avail_roles'] =& $role_counts;
+	} else {
+		$avail_roles = array();
+
+		$users_of_blog = $wpdb->get_col( "SELECT meta_value FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'" );
+
+		foreach ( $users_of_blog as $caps_meta ) {
+			$b_roles = unserialize($caps_meta);
+			if ( is_array($b_roles) ) {
+				foreach ( $b_roles as $b_role => $val ) {
+					if ( isset($avail_roles[$b_role]) ) {
+						$avail_roles[$b_role]++;
+					} else {
+						$avail_roles[$b_role] = 1;
+					}
+				}
+			}
+		}
+
+		$result['total_users'] = count( $users_of_blog );
+		$result['avail_roles'] =& $avail_roles;
+	}
+
+	return $result;
+}
+
 //
 // Private helper functions
 //
@@ -498,8 +606,8 @@ function wp_dropdown_users( $args = '' ) {
  *
  * The finished user data is cached, but the cache is not used to fill in the
  * user data for the given object. Once the function has been used, the cache
- * should be used to retrieve user data. The purpose seems then to be to ensure
+ * should be used to retrieve user data. The intention is if the current data
- * that the data in the object is always fresh.
+ * had been cached already, there would be no need to call this function.
  *
  * @access private
  * @since 2.5.0
@@ -508,17 +616,54 @@ function wp_dropdown_users( $args = '' ) {
  * @param object $user The user data object.
  */
 function _fill_user( &$user ) {
+	$metavalues = get_user_metavalues(array($user->ID));
+	_fill_single_user($user, $metavalues[$user->ID]);
+}
+
+/**
+ * Perform the query to get the $metavalues array(s) needed by _fill_user and _fill_many_users
+ *
+ * @since 3.0.0
+ * @param array $ids User ID numbers list.
+ * @return array of arrays. The array is indexed by user_id, containing $metavalues object arrays.
+ */
+function get_user_metavalues($ids) {
 	global $wpdb;
 
+	$clean = array_map('intval', $ids);
+	if ( 0 == count($clean) )
+		return $objects;
+
+	$list = implode(',', $clean);
+
 	$show = $wpdb->hide_errors();
-	$metavalues = $wpdb->get_results($wpdb->prepare("SELECT meta_key, meta_value FROM $wpdb->usermeta WHERE user_id = %d", $user->ID));
+	$metavalues = $wpdb->get_results("SELECT user_id, meta_key, meta_value FROM $wpdb->usermeta WHERE user_id IN ($list)");
 	$wpdb->show_errors($show);
 
-	if ( $metavalues ) {
+	$objects = array();
-		foreach ( (array) $metavalues as $meta ) {
+	foreach($clean as $id) {
-			$value = maybe_unserialize($meta->meta_value);
+		$objects[$id] = array();
-			$user->{$meta->meta_key} = $value;
+	}
-		}
+	foreach($metavalues as $meta_object) {
+		$objects[$meta_object->user_id][] = $meta_object;
+	}
+
+	return $objects;
+}
+
+/**
+ * Unserialize user metadata, fill $user object, then cache everything.
+ *
+ * @since 3.0.0
+ * @param object $user The User object.
+ * @param array $metavalues An array of objects provided by get_user_metavalues()
+ */
+function _fill_single_user( &$user, &$metavalues ) {
+	global $wpdb;
+
+	foreach ( $metavalues as $meta ) {
+		$value = maybe_unserialize($meta->meta_value);
+		$user->{$meta->meta_key} = $value;
 	}
 
 	$level = $wpdb->prefix . 'user_level';
@@ -533,10 +678,29 @@ function _fill_user( &$user ) {
 	if ( isset($user->description) )
 		$user->user_description = $user->description;
 
-	wp_cache_add($user->ID, $user, 'users');
+	update_user_caches($user);
-	wp_cache_add($user->user_login, $user->ID, 'userlogins');
+}
-	wp_cache_add($user->user_email, $user->ID, 'useremail');
+
-	wp_cache_add($user->user_nicename, $user->ID, 'userslugs');
+/**
+ * Take an array of user objects, fill them with metas, and cache them.
+ *
+ * @since 3.0.0
+ * @param array $users User objects
+ * @param array $metas User metavalues objects
+ */
+function _fill_many_users( &$users ) {
+	$ids = array();
+	foreach($users as $user_object) {
+		$ids[] = $user_object->ID;
+	}
+
+    $metas = get_user_metavalues($ids);
+
+	foreach($users as $user_object) {
+		if (isset($metas[$user_object->ID])) {
+	        _fill_single_user($user_object, $metas[$user_object->ID]);
+		}
+	}
 }
 
 /**
@@ -655,13 +819,26 @@ function sanitize_user_field($field, $value, $user_id, $context) {
 	return $value;
 }
 
+/**
+ * Update all user caches
+ *
+ * @since 3.0.0
+ *
+ * @param object $user User object to be cached
+ */
+function update_user_caches(&$user) {
+	wp_cache_add($user->ID, $user, 'users');
+	wp_cache_add($user->user_login, $user->ID, 'userlogins');
+	wp_cache_add($user->user_email, $user->ID, 'useremail');
+	wp_cache_add($user->user_nicename, $user->ID, 'userslugs');
+}
+
 /**
  * Clean all user caches
  *
- * @since 3.0
+ * @since 3.0.0
  *
  * @param int $id User ID
- * @return void
  */
 function clean_user_cache($id) {
 	$user = new WP_User($id);