Wordpress 3.7
[autoinstalls/wordpress.git] / wp-includes / user.php
index bfc82f3349f8d3b29633e46399745030344f17d8..9a60cd206904116e33997625c8754c14fb9a5a2c 100644 (file)
@@ -73,6 +73,9 @@ function wp_authenticate_username_password($user, $username, $password) {
        if ( is_a($user, 'WP_User') ) { return $user; }
 
        if ( empty($username) || empty($password) ) {
+               if ( is_wp_error( $user ) )
+                       return $user;
+
                $error = new WP_Error();
 
                if ( empty($username) )
@@ -87,20 +90,7 @@ function wp_authenticate_username_password($user, $username, $password) {
        $user = get_user_by('login', $username);
 
        if ( !$user )
-               return new WP_Error('invalid_username', sprintf(__('<strong>ERROR</strong>: Invalid username. <a href="%s" title="Password Lost and Found">Lost your password</a>?'), wp_lostpassword_url()));
-
-       if ( is_multisite() ) {
-               // Is user marked as spam?
-               if ( 1 == $user->spam)
-                       return new WP_Error('invalid_username', __('<strong>ERROR</strong>: Your account has been marked as a spammer.'));
-
-               // Is a user's blog marked as spam?
-               if ( !is_super_admin( $user->ID ) && isset($user->primary_blog) ) {
-                       $details = get_blog_details( $user->primary_blog );
-                       if ( is_object( $details ) && $details->spam == 1 )
-                               return new WP_Error('blog_suspended', __('Site Suspended.'));
-               }
-       }
+               return new WP_Error( 'invalid_username', sprintf( __( '<strong>ERROR</strong>: Invalid username. <a href="%s" title="Password Lost and Found">Lost your password</a>?' ), wp_lostpassword_url() ) );
 
        $user = apply_filters('wp_authenticate_user', $user, $password);
        if ( is_wp_error($user) )
@@ -140,6 +130,22 @@ function wp_authenticate_cookie($user, $username, $password) {
        return $user;
 }
 
+/**
+ * For multisite blogs, check if the authenticated user has been marked as a
+ * spammer, or if the user's primary blog has been marked as spam.
+ *
+ * @since 3.7.0
+ */
+function wp_authenticate_spam_check( $user ) {
+       if ( $user && is_a( $user, 'WP_User' ) && is_multisite() ) {
+               $spammed = apply_filters( 'check_is_user_spammed', is_user_spammy(), $user );
+
+               if ( $spammed )
+                       return new WP_Error( 'spammer_account', __( '<strong>ERROR</strong>: Your account has been marked as a spammer.' ) );
+       }
+       return $user;
+}
+
 /**
  * Number of posts user has written.
  *
@@ -242,8 +248,9 @@ function get_user_option( $option, $user = 0, $deprecated = '' ) {
        if ( ! $user = get_userdata( $user ) )
                return false;
 
-       if ( $user->has_prop( $wpdb->prefix . $option ) ) // Blog specific
-               $result = $user->get( $wpdb->prefix . $option );
+       $prefix = $wpdb->get_blog_prefix();
+       if ( $user->has_prop( $prefix . $option ) ) // Blog specific
+               $result = $user->get( $prefix . $option );
        elseif ( $user->has_prop( $option ) ) // User specific and cross-blog
                $result = $user->get( $option );
        else
@@ -274,12 +281,7 @@ function update_user_option( $user_id, $option_name, $newvalue, $global = false
        global $wpdb;
 
        if ( !$global )
-               $option_name = $wpdb->prefix . $option_name;
-
-       // 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 );
+               $option_name = $wpdb->get_blog_prefix() . $option_name;
 
        return update_user_meta( $user_id, $option_name, $newvalue );
 }
@@ -303,7 +305,7 @@ function delete_user_option( $user_id, $option_name, $global = false ) {
        global $wpdb;
 
        if ( !$global )
-               $option_name = $wpdb->prefix . $option_name;
+               $option_name = $wpdb->get_blog_prefix() . $option_name;
        return delete_user_meta( $user_id, $option_name );
 }
 
@@ -397,8 +399,10 @@ class WP_User_Query {
                        $qv['fields'] = array_unique( $qv['fields'] );
 
                        $this->query_fields = array();
-                       foreach ( $qv['fields'] as $field )
-                               $this->query_fields[] = $wpdb->users . '.' . esc_sql( $field );
+                       foreach ( $qv['fields'] as $field ) {
+                               $field = 'ID' === $field ? 'ID' : sanitize_key( $field );
+                               $this->query_fields[] = "$wpdb->users.$field";
+                       }
                        $this->query_fields = implode( ',', $this->query_fields );
                } elseif ( 'all' == $qv['fields'] ) {
                        $this->query_fields = "$wpdb->users.*";
@@ -406,37 +410,44 @@ class WP_User_Query {
                        $this->query_fields = "$wpdb->users.ID";
                }
 
-               if ( $qv['count_total'] )
+               if ( isset( $qv['count_total'] ) && $qv['count_total'] )
                        $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
 
                $this->query_from = "FROM $wpdb->users";
                $this->query_where = "WHERE 1=1";
 
                // sorting
-               if ( in_array( $qv['orderby'], array('nicename', 'email', 'url', 'registered') ) ) {
-                       $orderby = 'user_' . $qv['orderby'];
-               } elseif ( in_array( $qv['orderby'], array('user_nicename', 'user_email', 'user_url', 'user_registered') ) ) {
-                       $orderby = $qv['orderby'];
-               } elseif ( 'name' == $qv['orderby'] || 'display_name' == $qv['orderby'] ) {
-                       $orderby = 'display_name';
-               } elseif ( 'post_count' == $qv['orderby'] ) {
-                       // todo: avoid the JOIN
-                       $where = get_posts_by_author_sql('post');
-                       $this->query_from .= " LEFT OUTER JOIN (
-                               SELECT post_author, COUNT(*) as post_count
-                               FROM $wpdb->posts
-                               $where
-                               GROUP BY post_author
-                       ) p ON ({$wpdb->users}.ID = p.post_author)
-                       ";
-                       $orderby = 'post_count';
-               } elseif ( 'ID' == $qv['orderby'] || 'id' == $qv['orderby'] ) {
-                       $orderby = 'ID';
-               } else {
-                       $orderby = 'user_login';
+               if ( isset( $qv['orderby'] ) ) {
+                       if ( in_array( $qv['orderby'], array('nicename', 'email', 'url', 'registered') ) ) {
+                               $orderby = 'user_' . $qv['orderby'];
+                       } elseif ( in_array( $qv['orderby'], array('user_nicename', 'user_email', 'user_url', 'user_registered') ) ) {
+                               $orderby = $qv['orderby'];
+                       } elseif ( 'name' == $qv['orderby'] || 'display_name' == $qv['orderby'] ) {
+                               $orderby = 'display_name';
+                       } elseif ( 'post_count' == $qv['orderby'] ) {
+                               // todo: avoid the JOIN
+                               $where = get_posts_by_author_sql('post');
+                               $this->query_from .= " LEFT OUTER JOIN (
+                                       SELECT post_author, COUNT(*) as post_count
+                                       FROM $wpdb->posts
+                                       $where
+                                       GROUP BY post_author
+                               ) p ON ({$wpdb->users}.ID = p.post_author)
+                               ";
+                               $orderby = 'post_count';
+                       } elseif ( 'ID' == $qv['orderby'] || 'id' == $qv['orderby'] ) {
+                               $orderby = 'ID';
+                       } elseif ( 'meta_value' == $qv['orderby'] ) {
+                               $orderby = "$wpdb->usermeta.meta_value";
+                       } else {
+                               $orderby = 'user_login';
+                       }
                }
 
-               $qv['order'] = strtoupper( $qv['order'] );
+               if ( empty( $orderby ) )
+                       $orderby = 'user_login';
+
+               $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
                if ( 'ASC' == $qv['order'] )
                        $order = 'ASC';
                else
@@ -444,14 +455,17 @@ class WP_User_Query {
                $this->query_orderby = "ORDER BY $orderby $order";
 
                // limit
-               if ( $qv['number'] ) {
+               if ( isset( $qv['number'] ) && $qv['number'] ) {
                        if ( $qv['offset'] )
                                $this->query_limit = $wpdb->prepare("LIMIT %d, %d", $qv['offset'], $qv['number']);
                        else
                                $this->query_limit = $wpdb->prepare("LIMIT %d", $qv['number']);
                }
 
-               $search = trim( $qv['search'] );
+               $search = '';
+               if ( isset( $qv['search'] ) )
+                       $search = trim( $qv['search'] );
+
                if ( $search ) {
                        $leading_wild = ( ltrim($search, '*') != $search );
                        $trailing_wild = ( rtrim($search, '*') != $search );
@@ -474,25 +488,31 @@ class WP_User_Query {
                                        $search_columns = array('user_email');
                                elseif ( is_numeric($search) )
                                        $search_columns = array('user_login', 'ID');
-                               elseif ( preg_match('|^https?://|', $search) && ! wp_is_large_network( 'users' ) )
+                               elseif ( preg_match('|^https?://|', $search) && ! ( is_multisite() && wp_is_large_network( 'users' ) ) )
                                        $search_columns = array('user_url');
                                else
                                        $search_columns = array('user_login', 'user_nicename');
                        }
 
+                       $search_columns = apply_filters( 'user_search_columns', $search_columns, $search, $this );
+
                        $this->query_where .= $this->get_search_sql( $search, $search_columns, $wild );
                }
 
-               $blog_id = absint( $qv['blog_id'] );
+               $blog_id = 0;
+               if ( isset( $qv['blog_id'] ) )
+                       $blog_id = absint( $qv['blog_id'] );
 
-               if ( 'authors' == $qv['who'] && $blog_id ) {
+               if ( isset( $qv['who'] ) && 'authors' == $qv['who'] && $blog_id ) {
                        $qv['meta_key'] = $wpdb->get_blog_prefix( $blog_id ) . 'user_level';
                        $qv['meta_value'] = 0;
                        $qv['meta_compare'] = '!=';
                        $qv['blog_id'] = $blog_id = 0; // Prevent extra meta query
                }
 
-               $role = trim( $qv['role'] );
+               $role = '';
+               if ( isset( $qv['role'] ) )
+                       $role = trim( $qv['role'] );
 
                if ( $blog_id && ( $role || is_multisite() ) ) {
                        $cap_meta_query = array();
@@ -518,10 +538,10 @@ class WP_User_Query {
                                $this->query_fields = 'DISTINCT ' . $this->query_fields;
                }
 
-               if ( !empty( $qv['include'] ) ) {
+               if ( ! empty( $qv['include'] ) ) {
                        $ids = implode( ',', wp_parse_id_list( $qv['include'] ) );
                        $this->query_where .= " AND $wpdb->users.ID IN ($ids)";
-               } elseif ( !empty($qv['exclude']) ) {
+               } elseif ( ! empty( $qv['exclude'] ) ) {
                        $ids = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
                        $this->query_where .= " AND $wpdb->users.ID NOT IN ($ids)";
                }
@@ -546,7 +566,7 @@ class WP_User_Query {
                        $this->results = $wpdb->get_col("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
                }
 
-               if ( $qv['count_total'] )
+               if ( isset( $qv['count_total'] ) && $qv['count_total'] )
                        $this->total_users = $wpdb->get_var( apply_filters( 'found_users_query', 'SELECT FOUND_ROWS()' ) );
 
                if ( !$this->results )
@@ -794,7 +814,7 @@ function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
  * @param string $meta_key Metadata name.
  * @param mixed $meta_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.
+ * @return int|bool Meta ID on success, false on failure.
  */
 function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
        return add_metadata('user', $user_id, $meta_key, $meta_value, $unique);
@@ -814,7 +834,7 @@ function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
  * @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.
+ * @return bool True on success, false on failure.
  */
 function delete_user_meta($user_id, $meta_key, $meta_value = '') {
        return delete_metadata('user', $user_id, $meta_key, $meta_value);
@@ -853,7 +873,7 @@ function get_user_meta($user_id, $key = '', $single = false) {
  * @param string $meta_key Metadata key.
  * @param mixed $meta_value Metadata value.
  * @param mixed $prev_value Optional. Previous value to check before removing.
- * @return bool False on failure, true if success.
+ * @return bool True on success, false on failure.
  */
 function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {
        return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);
@@ -1032,7 +1052,7 @@ function wp_dropdown_users( $args = '' ) {
        extract( $r, EXTR_SKIP );
 
        $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
-       $query_args['fields'] = array( 'ID', $show );
+       $query_args['fields'] = array( 'ID', 'user_login', $show );
        $users = get_users( $query_args );
 
        $output = '';
@@ -1390,7 +1410,7 @@ function wp_insert_user( $userdata ) {
        }
 
        $data = compact( 'user_pass', 'user_email', 'user_url', 'user_nicename', 'display_name', 'user_registered' );
-       $data = stripslashes_deep( $data );
+       $data = wp_unslash( $data );
 
        if ( $update ) {
                $wpdb->update( $wpdb->users, $data, compact( 'ID' ) );
@@ -1429,9 +1449,6 @@ function wp_insert_user( $userdata ) {
  * It is possible to update a user's password by specifying the 'user_pass'
  * value in the $userdata parameter array.
  *
- * If $userdata does not contain an 'ID' key, then a new user will be created
- * and the new user's ID will be returned.
- *
  * If current user's password is being updated, then the cookies will be
  * cleared.
  *
@@ -1453,7 +1470,7 @@ function wp_update_user($userdata) {
        // First, get all of the original fields
        $user_obj = get_userdata( $ID );
        if ( ! $user_obj )
-               return new WP_Error( 'invalid_user_id', __( 'Invalid user ID' ) );
+               return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
 
        $user = $user_obj->to_array();
 
@@ -1504,8 +1521,8 @@ function wp_update_user($userdata) {
  * @return int The new user's ID.
  */
 function wp_create_user($username, $password, $email = '') {
-       $user_login = esc_sql( $username );
-       $user_email = esc_sql( $email    );
+       $user_login = wp_slash( $username );
+       $user_email = wp_slash( $email    );
        $user_pass = $password;
 
        $userdata = compact('user_login', 'user_email', 'user_pass');
@@ -1523,23 +1540,172 @@ function wp_create_user($username, $password, $email = '') {
  */
 function _get_additional_user_keys( $user ) {
        $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front' );
-       return array_merge( $keys, array_keys( _wp_get_user_contactmethods( $user ) ) );
+       return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) );
 }
 
 /**
- * Set up the default contact methods.
+ * Set up the user contact methods.
+ *
+ * Default contact methods were removed in 3.6. A filter dictates contact methods.
+ *
+ * @since 3.7.0
+ *
+ * @param WP_User $user Optional. WP_User object.
+ * @return array Array of contact methods and their labels.
+ */
+function wp_get_user_contact_methods( $user = null ) {
+       $methods = array();
+       if ( get_site_option( 'initial_db_version' ) < 23588 ) {
+               $methods = array(
+                       'aim'    => __( 'AIM' ),
+                       'yim'    => __( 'Yahoo IM' ),
+                       'jabber' => __( 'Jabber / Google Talk' )
+               );
+       }
+
+       /**
+        * Filter the user contact methods.
+        *
+        * @since 2.9.0
+        *
+        * @param array   $methods Array of contact methods and their labels.
+        * @param WP_User $user    Optional. WP_User object.
+        */
+       return apply_filters( 'user_contactmethods', $methods, $user );
+}
+
+/**
+ * The old private function for setting up user contact methods.
  *
  * @since 2.9.0
  * @access private
- *
- * @param object $user User data object (optional).
- * @return array $user_contactmethods Array of contact methods and their labels.
  */
 function _wp_get_user_contactmethods( $user = null ) {
-       $user_contactmethods = array(
-               'aim' => __('AIM'),
-               'yim' => __('Yahoo IM'),
-               'jabber' => __('Jabber / Google Talk')
-       );
-       return apply_filters( 'user_contactmethods', $user_contactmethods, $user );
+       return wp_get_user_contact_methods( $user );
+}
+
+/**
+ * Retrieves a user row based on password reset key and login
+ *
+ * A key is considered 'expired' if it exactly matches the value of the
+ * user_activation_key field, rather than being matched after going through the
+ * hashing process. This field is now hashed; old values are no longer accepted
+ * but have a different WP_Error code so good user feedback can be provided.
+ *
+ * @uses $wpdb WordPress Database object
+ *
+ * @param string $key       Hash to validate sending user's password.
+ * @param string $login     The user login.
+ * @return WP_User|WP_Error WP_User object on success, WP_Error object for invalid or expired keys.
+ */
+function check_password_reset_key($key, $login) {
+       global $wpdb, $wp_hasher;
+
+       $key = preg_replace('/[^a-z0-9]/i', '', $key);
+
+       if ( empty( $key ) || !is_string( $key ) )
+               return new WP_Error('invalid_key', __('Invalid key'));
+
+       if ( empty($login) || !is_string($login) )
+               return new WP_Error('invalid_key', __('Invalid key'));
+
+       $row = $wpdb->get_row( $wpdb->prepare( "SELECT ID, user_activation_key FROM $wpdb->users WHERE user_login = %s", $login ) );
+       if ( ! $row )
+               return new WP_Error('invalid_key', __('Invalid key'));
+
+       if ( empty( $wp_hasher ) ) {
+               require_once ABSPATH . 'wp-includes/class-phpass.php';
+               $wp_hasher = new PasswordHash( 8, true );
+       }
+
+       if ( $wp_hasher->CheckPassword( $key, $row->user_activation_key ) )
+               return get_userdata( $row->ID );
+
+       if ( $key === $row->user_activation_key ) {
+               $return = new WP_Error( 'expired_key', __( 'Invalid key' ) );
+               $user_id = $row->ID;
+
+               /**
+                * Filter the return value of check_password_reset_key() when an
+                * old-style key is used (plain-text key was stored in the database).
+                *
+                * @since 3.7.0
+                *
+                * @param WP_Error $return  A WP_Error object denoting an expired key.
+                *                          Return a WP_User object to validate the key.
+                * @param int      $user_id The matched user ID.
+                */
+               return apply_filters( 'password_reset_key_expired', $return, $user_id );
+       }
+
+       return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
+}
+
+/**
+ * Handles resetting the user's password.
+ *
+ * @param object $user The user
+ * @param string $new_pass New password for the user in plaintext
+ */
+function reset_password( $user, $new_pass ) {
+       do_action( 'password_reset', $user, $new_pass );
+
+       wp_set_password( $new_pass, $user->ID );
+       update_user_option( $user->ID, 'default_password_nag', false, true );
+
+       wp_password_change_notification( $user );
+}
+
+/**
+ * Handles registering a new user.
+ *
+ * @param string $user_login User's username for logging in
+ * @param string $user_email User's email address to send password and add
+ * @return int|WP_Error Either user's ID or error on failure.
+ */
+function register_new_user( $user_login, $user_email ) {
+       $errors = new WP_Error();
+
+       $sanitized_user_login = sanitize_user( $user_login );
+       $user_email = apply_filters( 'user_registration_email', $user_email );
+
+       // Check the username
+       if ( $sanitized_user_login == '' ) {
+               $errors->add( 'empty_username', __( '<strong>ERROR</strong>: Please enter a username.' ) );
+       } elseif ( ! validate_username( $user_login ) ) {
+               $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ) );
+               $sanitized_user_login = '';
+       } elseif ( username_exists( $sanitized_user_login ) ) {
+               $errors->add( 'username_exists', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ) );
+       }
+
+       // Check the e-mail address
+       if ( $user_email == '' ) {
+               $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please type your e-mail address.' ) );
+       } elseif ( ! is_email( $user_email ) ) {
+               $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The email address isn&#8217;t correct.' ) );
+               $user_email = '';
+       } elseif ( email_exists( $user_email ) ) {
+               $errors->add( 'email_exists', __( '<strong>ERROR</strong>: This email is already registered, please choose another one.' ) );
+       }
+
+       do_action( 'register_post', $sanitized_user_login, $user_email, $errors );
+
+       $errors = apply_filters( 'registration_errors', $errors, $sanitized_user_login, $user_email );
+
+       if ( $errors->get_error_code() )
+               return $errors;
+
+       $user_pass = wp_generate_password( 12, false );
+       $user_id = wp_create_user( $sanitized_user_login, $user_pass, $user_email );
+       if ( ! $user_id || is_wp_error( $user_id ) ) {
+               $errors->add( 'registerfail', sprintf( __( '<strong>ERROR</strong>: Couldn&#8217;t register you&hellip; please contact the <a href="mailto:%s">webmaster</a> !' ), get_option( 'admin_email' ) ) );
+               return $errors;
+       }
+
+       update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag.
+
+       wp_new_user_notification( $user_id, $user_pass );
+
+       return $user_id;
 }