X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/177fd6fefd2e3d5a0ea6591c71d660cabdb3c1a4..6e54d1cc889fd70eca54701860d695634b28a075:/wp-includes/user.php diff --git a/wp-includes/user.php b/wp-includes/user.php index c861be03..66d5d2e9 100644 --- a/wp-includes/user.php +++ b/wp-includes/user.php @@ -1,6 +1,28 @@ get_error_codes() == array('empty_username', 'empty_password') ) { + $user = new WP_Error('', ''); + } - // If the cookie is not set, be silent. - return new WP_Error(); + return $user; } - if ( empty($credentials['user_login']) || empty($credentials['user_password']) ) { + wp_set_auth_cookie($user->ID, $credentials['remember'], $secure_cookie); + do_action('wp_login', $credentials['user_login']); + return $user; +} + + +/** + * Authenticate the user using the username and password. + */ +add_filter('authenticate', 'wp_authenticate_username_password', 20, 3); +function wp_authenticate_username_password($user, $username, $password) { + if ( is_a($user, 'WP_User') ) { return $user; } + + if ( empty($username) || empty($password) ) { $error = new WP_Error(); - if ( empty($credentials['user_login']) ) + if ( empty($username) ) $error->add('empty_username', __('ERROR: The username field is empty.')); - if ( empty($credentials['user_password']) ) + + if ( empty($password) ) $error->add('empty_password', __('ERROR: The password field is empty.')); + return $error; } - $user = wp_authenticate($credentials['user_login'], $credentials['user_password']); - if ( is_wp_error($user) ) - return $user; + $userdata = get_user_by('login', $username); - wp_set_auth_cookie($user->ID, $credentials['remember']); - do_action('wp_login', $credentials['user_login']); + if ( !$userdata ) + return new WP_Error('invalid_username', sprintf(__('ERROR: Invalid username. Lost your password?'), site_url('wp-login.php?action=lostpassword', 'login'))); + + if ( is_multisite() ) { + // Is user marked as spam? + if ( 1 == $userdata->spam) + return new WP_Error('invalid_username', __('ERROR: Your account has been marked as a spammer.')); + + // Is a user's blog marked as spam? + if ( !is_super_admin( $userdata->ID ) && isset($userdata->primary_blog) ) { + $details = get_blog_details( $userdata->primary_blog ); + if ( is_object( $details ) && $details->spam == 1 ) + return new WP_Error('blog_suspended', __('Site Suspended.')); + } + } + + $userdata = apply_filters('wp_authenticate_user', $userdata, $password); + if ( is_wp_error($userdata) ) + return $userdata; + + if ( !wp_check_password($password, $userdata->user_pass, $userdata->ID) ) + return new WP_Error('incorrect_password', sprintf(__('ERROR: Incorrect password. Lost your password?'), site_url('wp-login.php?action=lostpassword', 'login'))); + + $user = new WP_User($userdata->ID); return $user; } -function get_profile($field, $user = false) { +/** + * Authenticate the user using the WordPress auth cookie. + */ +function wp_authenticate_cookie($user, $username, $password) { + if ( is_a($user, 'WP_User') ) { return $user; } + + if ( empty($username) && empty($password) ) { + $user_id = wp_validate_auth_cookie(); + if ( $user_id ) + return new WP_User($user_id); + + global $auth_secure_cookie; + + if ( $auth_secure_cookie ) + $auth_cookie = SECURE_AUTH_COOKIE; + else + $auth_cookie = AUTH_COOKIE; + + if ( !empty($_COOKIE[$auth_cookie]) ) + return new WP_Error('expired_session', __('Please log in again.')); + + // If the cookie is not set, be silent. + } + + return $user; +} + +/** + * Number of posts user has written. + * + * @since 3.0.0 + * @uses $wpdb WordPress database object for queries. + * + * @param int $userid User ID. + * @return int Amount of posts user has written. + */ +function count_user_posts($userid) { global $wpdb; - if ( !$user ) - $user = $wpdb->escape($_COOKIE[USER_COOKIE]); - return $wpdb->get_var("SELECT $field FROM $wpdb->users WHERE user_login = '$user'"); + + $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); } -function get_usernumposts($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; - $userid = (int) $userid; - return $wpdb->get_var("SELECT COUNT(*) FROM $wpdb->posts WHERE post_author = '$userid' AND post_type = 'post' AND " . get_private_posts_cap_sql('post')); + + $count = array(); + if ( ! is_array($users) || empty( $users ) ) + return $count; + + $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 ); + foreach ( $result as $row ) { + $count[ $row[0] ] = $row[1]; + } + + foreach ( $users as $id ) { + if ( ! isset( $count[ $id ] ) ) + $count[ $id ] = 0; + } + + return $count; } -// TODO: xmlrpc only. Maybe move to xmlrpc.php. -function user_pass_ok($user_login,$user_pass) { +/** + * Check that the user login name and password is correct. + * + * @since 0.71 + * @todo xmlrpc only. Maybe move to xmlrpc.php. + * + * @param string $user_login User name. + * @param string $user_pass User password. + * @return bool False if does not authenticate, true if username and password authenticates. + */ +function user_pass_ok($user_login, $user_pass) { $user = wp_authenticate($user_login, $user_pass); if ( is_wp_error($user) ) return false; @@ -79,166 +210,387 @@ function user_pass_ok($user_login,$user_pass) { // User option functions // -function get_user_option( $option, $user = 0 ) { +/** + * Get the current user's ID + * + * @since MU + * + * @uses wp_get_current_user + * + * @return int The current user's ID + */ +function get_current_user_id() { + $user = wp_get_current_user(); + return ( isset( $user->ID ) ? (int) $user->ID : 0 ); +} + +/** + * Retrieve user option that can be either per Site or per Network. + * + * If the user ID is not given, then the current user will be used instead. If + * the user ID is given, then the user data will be retrieved. The filter for + * the result, will also pass the original option name and finally the user data + * object as the third parameter. + * + * The option will first check for the per site name and then the per Network name. + * + * @since 2.0.0 + * @uses $wpdb WordPress database object for queries. + * @uses apply_filters() Calls 'get_user_option_$option' hook with result, + * option parameter, and user data object. + * + * @param string $option User option name. + * @param int $user Optional. User ID. + * @param bool $deprecated Use get_option() to check for an option in the options table. + * @return mixed + */ +function get_user_option( $option, $user = 0, $deprecated = '' ) { global $wpdb; - $option = preg_replace('|[^a-z0-9_]|i', '', $option); - if ( empty($user) ) + if ( !empty( $deprecated ) ) + _deprecated_argument( __FUNCTION__, '3.0' ); + + if ( empty($user) ) { $user = wp_get_current_user(); + $user = $user->ID; + } + + $user = get_userdata($user); + + // Keys used as object vars cannot have dashes. + $key = str_replace('-', '', $option); + + if ( isset( $user->{$wpdb->prefix . $key} ) ) // Blog specific + $result = $user->{$wpdb->prefix . $key}; + elseif ( isset( $user->{$key} ) ) // User specific and cross-blog + $result = $user->{$key}; else - $user = get_userdata($user); - - if ( isset( $user->{$wpdb->prefix . $option} ) ) // Blog specific - $result = $user->{$wpdb->prefix . $option}; - elseif ( isset( $user->{$option} ) ) // User specific and cross-blog - $result = $user->{$option}; - else // Blog global - $result = get_option( $option ); - + $result = false; + return apply_filters("get_user_option_{$option}", $result, $option, $user); } +/** + * Update user option with global blog capability. + * + * User options are just like user metadata except that they have support for + * global blog options. If the 'global' parameter is false, which it is by default + * it will prepend the WordPress table prefix to the option name. + * + * Deletes the user option if $newvalue is empty. + * + * @since 2.0.0 + * @uses $wpdb WordPress database object for queries + * + * @param int $user_id User ID + * @param string $option_name User option name. + * @param mixed $newvalue User option value. + * @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific). + * @return unknown + */ function update_user_option( $user_id, $option_name, $newvalue, $global = false ) { global $wpdb; + if ( !$global ) $option_name = $wpdb->prefix . $option_name; - return update_usermeta( $user_id, $option_name, $newvalue ); + + // For backward compatibility. See differences between update_user_meta() and deprecated update_usermeta(). + // http://core.trac.wordpress.org/ticket/13088 + if ( is_null( $newvalue ) || is_scalar( $newvalue ) && empty( $newvalue ) ) + return delete_user_meta( $user_id, $option_name ); + + return update_user_meta( $user_id, $option_name, $newvalue ); } -// Get users with capabilities for the current blog. -// For setups that use the multi-blog feature. +/** + * Delete user option with global blog capability. + * + * User options are just like user metadata except that they have support for + * global blog options. If the 'global' parameter is false, which it is by default + * it will prepend the WordPress table prefix to the option name. + * + * @since 3.0.0 + * @uses $wpdb WordPress database object for queries + * + * @param int $user_id User ID + * @param string $option_name User option name. + * @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific). + * @return unknown + */ +function delete_user_option( $user_id, $option_name, $global = false ) { + global $wpdb; + + if ( !$global ) + $option_name = $wpdb->prefix . $option_name; + return delete_user_meta( $user_id, $option_name ); +} + +/** + * Get users for the blog. + * + * For setups that use the multi-blog feature. Can be used outside of the + * multi-blog feature. + * + * @since 2.2.0 + * @uses $wpdb WordPress database object for queries + * @uses $blog_id The Blog id of the blog for those that use more than one blog + * + * @param int $id Blog ID. + * @return array List of users that are part of that Blog ID + */ function get_users_of_blog( $id = '' ) { global $wpdb, $blog_id; if ( empty($id) ) $id = (int) $blog_id; - $users = $wpdb->get_results( "SELECT user_id, user_login, display_name, user_email, meta_value FROM $wpdb->users, $wpdb->usermeta WHERE " . $wpdb->users . ".ID = " . $wpdb->usermeta . ".user_id AND meta_key = '" . $wpdb->prefix . "capabilities' ORDER BY {$wpdb->usermeta}.user_id" ); + $blog_prefix = $wpdb->get_blog_prefix($id); + $users = $wpdb->get_results( "SELECT user_id, user_id AS ID, user_login, display_name, user_email, meta_value FROM $wpdb->users, $wpdb->usermeta WHERE {$wpdb->users}.ID = {$wpdb->usermeta}.user_id AND meta_key = '{$blog_prefix}capabilities' ORDER BY {$wpdb->usermeta}.user_id" ); return $users; } -// -// User meta functions -// - -function delete_usermeta( $user_id, $meta_key, $meta_value = '' ) { - global $wpdb; - if ( !is_numeric( $user_id ) ) - return false; - $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key); - - if ( is_array($meta_value) || is_object($meta_value) ) - $meta_value = serialize($meta_value); - $meta_value = trim( $meta_value ); - - if ( ! empty($meta_value) ) - $wpdb->query("DELETE FROM $wpdb->usermeta WHERE user_id = '$user_id' AND meta_key = '$meta_key' AND meta_value = '$meta_value'"); - else - $wpdb->query("DELETE FROM $wpdb->usermeta WHERE user_id = '$user_id' AND meta_key = '$meta_key'"); - - wp_cache_delete($user_id, 'users'); - - return true; +/** + * Add meta data field to a user. + * + * Post meta data is called "Custom Fields" on the Administration Panels. + * + * @since 3.0.0 + * @uses add_metadata() + * @link http://codex.wordpress.org/Function_Reference/add_user_meta + * + * @param int $user_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_user_meta($user_id, $meta_key, $meta_value, $unique = false) { + return add_metadata('user', $user_id, $meta_key, $meta_value, $unique); } -function get_usermeta( $user_id, $meta_key = '') { - global $wpdb; - $user_id = (int) $user_id; - - if ( !$user_id ) - return false; - - if ( !empty($meta_key) ) { - $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key); - $user = wp_cache_get($user_id, 'users'); - // Check the cached user object - if ( false !== $user && isset($user->$meta_key) ) - $metas = array($user->$meta_key); - else - $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) ); - } else { - $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM $wpdb->usermeta WHERE user_id = %d", $user_id) ); - } - - if ( empty($metas) ) { - if ( empty($meta_key) ) - return array(); - else - return ''; - } - - $metas = array_map('maybe_unserialize', $metas); +/** + * Remove metadata matching criteria from a user. + * + * 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 3.0.0 + * @uses delete_metadata() + * @link http://codex.wordpress.org/Function_Reference/delete_user_meta + * + * @param int $user_id user ID + * @param string $meta_key Metadata name. + * @param mixed $meta_value Optional. Metadata value. + * @return bool False for failure. True for success. + */ +function delete_user_meta($user_id, $meta_key, $meta_value = '') { + return delete_metadata('user', $user_id, $meta_key, $meta_value); +} - if ( count($metas) == 1 ) - return $metas[0]; - else - return $metas; +/** + * Retrieve user meta field for a user. + * + * @since 3.0.0 + * @uses get_metadata() + * @link http://codex.wordpress.org/Function_Reference/get_user_meta + * + * @param int $user_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_user_meta($user_id, $key, $single = false) { + return get_metadata('user', $user_id, $key, $single); } -function update_usermeta( $user_id, $meta_key, $meta_value ) { - global $wpdb; - if ( !is_numeric( $user_id ) ) - return false; - $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key); +/** + * Update user meta field based on user ID. + * + * Use the $prev_value parameter to differentiate between meta fields with the + * same key and user ID. + * + * If the meta field for the user does not exist, it will be added. + * + * @since 3.0.0 + * @uses update_metadata + * @link http://codex.wordpress.org/Function_Reference/update_user_meta + * + * @param int $user_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_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') { + return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value); +} - // FIXME: usermeta data is assumed to be already escaped - if ( is_string($meta_value) ) - $meta_value = stripslashes($meta_value); - $meta_value = maybe_serialize($meta_value); - $meta_value = $wpdb->escape($meta_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 ) { + global $wp_roles; + + if ( ! isset( $wp_roles ) ) + $wp_roles = new WP_Roles(); + + $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; + } + } - if (empty($meta_value)) { - return delete_usermeta($user_id, $meta_key); - } + // Get the meta_value index from the end of the result set. + $total_users = (int) $row[$col]; - $cur = $wpdb->get_row("SELECT * FROM $wpdb->usermeta WHERE user_id = '$user_id' AND meta_key = '$meta_key'"); - if ( !$cur ) { - $wpdb->query("INSERT INTO $wpdb->usermeta ( user_id, meta_key, meta_value ) - VALUES - ( '$user_id', '$meta_key', '$meta_value' )"); - } else if ( $cur->meta_value != $meta_value ) { - $wpdb->query("UPDATE $wpdb->usermeta SET meta_value = '$meta_value' WHERE user_id = '$user_id' AND meta_key = '$meta_key'"); + $result['total_users'] = $total_users; + $result['avail_roles'] =& $role_counts; } else { - return false; - } + $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; + } + } + } + } - wp_cache_delete($user_id, 'users'); + $result['total_users'] = count( $users_of_blog ); + $result['avail_roles'] =& $avail_roles; + } - return true; + return $result; } // // Private helper functions // -// Setup global user vars. Used by set_current_user() for back compat. -function setup_userdata($user_id = '') { +/** + * Set up global user vars. + * + * Used by wp_set_current_user() for back compat. Might be deprecated in the future. + * + * @since 2.0.4 + * @global string $userdata User description. + * @global string $user_login The user username for logging in + * @global int $user_level The level of the user + * @global int $user_ID The ID of the user + * @global string $user_email The email address of the user + * @global string $user_url The url in the user's profile + * @global string $user_pass_md5 MD5 of the user's password + * @global string $user_identity The display name of the user + * + * @param int $for_user_id Optional. User ID to set up global data. + */ +function setup_userdata($for_user_id = '') { global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_pass_md5, $user_identity; - if ( '' == $user_id ) + if ( '' == $for_user_id ) $user = wp_get_current_user(); else - $user = new WP_User($user_id); + $user = new WP_User($for_user_id); - if ( 0 == $user->ID ) + $userdata = $user->data; + $user_ID = (int) $user->ID; + $user_level = (int) isset($user->user_level) ? $user->user_level : 0; + + if ( 0 == $user->ID ) { + $user_login = $user_email = $user_url = $user_pass_md5 = $user_identity = ''; return; + } - $userdata = $user->data; $user_login = $user->user_login; - $user_level = (int) isset($user->user_level) ? $user->user_level : 0; - $user_ID = (int) $user->ID; $user_email = $user->user_email; $user_url = $user->user_url; $user_pass_md5 = md5($user->user_pass); $user_identity = $user->display_name; } +/** + * Create dropdown HTML content of users. + * + * The content can either be displayed, which it is by default or retrieved by + * setting the 'echo' argument. The 'include' and 'exclude' arguments do not + * need to be used; all users will be displayed in that case. Only one can be + * used, either 'include' or 'exclude', but not both. + * + * The available arguments are as follows: + *