X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/699231ae09f7057a4d0000cdf32e50a3df6a04ca..c55863f11e8589bf8d4a5698bf15752406654f1c:/wp-includes/ms-functions.php diff --git a/wp-includes/ms-functions.php b/wp-includes/ms-functions.php index cd9fbdc2..fd92b2c5 100644 --- a/wp-includes/ms-functions.php +++ b/wp-includes/ms-functions.php @@ -1,29 +1,39 @@ get_blog_count(), + 'users' => get_user_count(), + ); - $count_ts = get_site_option( 'user_count_ts' ); - if ( time() - $count_ts > 3600 ) { - $count = $wpdb->get_var( "SELECT COUNT(ID) FROM $wpdb->users" ); - update_site_option( 'user_count', $count ); - update_site_option( 'user_count_ts', time() ); - } else { - $count = get_site_option( 'user_count' ); - } - $stats['users'] = $count; return $stats; } +/** + * Get the admin for a domain/path combination. + * + * @since MU 1.0 + * + * @param string $sitedomain Optional. Site domain. + * @param string $path Optional. Site path. + * @return array The network admins + */ function get_admin_users_for_domain( $sitedomain = '', $path = '' ) { global $wpdb; @@ -38,74 +48,49 @@ function get_admin_users_for_domain( $sitedomain = '', $path = '' ) { return false; } -function get_blogs_of_user( $id, $all = false ) { - global $wpdb; - - $cache_suffix = $all ? '_all' : '_short'; - $return = wp_cache_get( 'blogs_of_user_' . $id . $cache_suffix, 'users' ); - if ( $return ) - return apply_filters( 'get_blogs_of_user', $return, $id, $all ); - - $user = get_userdata( (int) $id ); - if ( !$user ) - return false; - - $blogs = $match = array(); - $prefix_length = strlen($wpdb->base_prefix); - foreach ( (array) $user as $key => $value ) { - if ( $prefix_length && substr($key, 0, $prefix_length) != $wpdb->base_prefix ) - continue; - if ( substr($key, -12, 12) != 'capabilities' ) - continue; - if ( preg_match( '/^' . $wpdb->base_prefix . '((\d+)_)?capabilities$/', $key, $match ) ) { - if ( count( $match ) > 2 ) - $blog_id = $match[ 2 ]; - else - $blog_id = 1; - $blog = get_blog_details( $blog_id ); - if ( $blog && isset( $blog->domain ) && ( $all == true || $all == false && ( $blog->archived == 0 && $blog->spam == 0 && $blog->deleted == 0 ) ) ) { - $blogs[ $blog_id ]->userblog_id = $blog_id; - $blogs[ $blog_id ]->blogname = $blog->blogname; - $blogs[ $blog_id ]->domain = $blog->domain; - $blogs[ $blog_id ]->path = $blog->path; - $blogs[ $blog_id ]->site_id = $blog->site_id; - $blogs[ $blog_id ]->siteurl = $blog->siteurl; - } - } - } - - wp_cache_add( 'blogs_of_user_' . $id . $cache_suffix, $blogs, 'users', 5 ); - return apply_filters( 'get_blogs_of_user', $blogs, $id, $all ); -} - -function get_active_blog_for_user( $user_id ) { // get an active blog for user - either primary blog or from blogs list +/** + * Get one of a user's active blogs + * + * Returns the user's primary blog, if she has one and + * it is active. If it's inactive, function returns another + * active blog of the user. If none are found, the user + * is added as a Subscriber to the Dashboard Blog and that blog + * is returned. + * + * @since MU 1.0 + * @uses get_blogs_of_user() + * @uses add_user_to_blog() + * @uses get_blog_details() + * + * @param int $user_id The unique ID of the user + * @return object The blog object + */ +function get_active_blog_for_user( $user_id ) { global $wpdb; $blogs = get_blogs_of_user( $user_id ); - if ( empty( $blogs ) ) { - $details = get_dashboard_blog(); - add_user_to_blog( $details->blog_id, $user_id, 'subscriber' ); - update_user_meta( $user_id, 'primary_blog', $details->blog_id ); - wp_cache_delete( $user_id, 'users' ); - return $details; - } + if ( empty( $blogs ) ) + return null; + + if ( !is_multisite() ) + return $blogs[$wpdb->blogid]; $primary_blog = get_user_meta( $user_id, 'primary_blog', true ); - $details = get_dashboard_blog(); - if ( $primary_blog ) { - $blogs = get_blogs_of_user( $user_id ); - if ( isset( $blogs[ $primary_blog ] ) == false ) { - add_user_to_blog( $details->blog_id, $user_id, 'subscriber' ); - update_user_meta( $user_id, 'primary_blog', $details->blog_id ); - wp_cache_delete( $user_id, 'users' ); + $first_blog = current($blogs); + if ( false !== $primary_blog ) { + if ( ! isset( $blogs[ $primary_blog ] ) ) { + update_user_meta( $user_id, 'primary_blog', $first_blog->userblog_id ); + $primary = get_blog_details( $first_blog->userblog_id ); } else { - $details = get_blog_details( $primary_blog ); + $primary = get_blog_details( $primary_blog ); } } else { - add_user_to_blog( $details->blog_id, $user_id, 'subscriber' ); // Add subscriber permission for dashboard blog - update_user_meta( $user_id, 'primary_blog', $details->blog_id ); + //TODO Review this call to add_user_to_blog too - to get here the user must have a role on this blog? + add_user_to_blog( $first_blog->userblog_id, $user_id, 'subscriber' ); + update_user_meta( $user_id, 'primary_blog', $first_blog->userblog_id ); + $primary = $first_blog; } - if ( ( is_object( $details ) == false ) || ( is_object( $details ) && $details->archived == 1 || $details->spam == 1 || $details->deleted == 1 ) ) { + if ( ( ! is_object( $primary ) ) || ( $primary->archived == 1 || $primary->spam == 1 || $primary->deleted == 1 ) ) { $blogs = get_blogs_of_user( $user_id, true ); // if a user's primary blog is shut down, check their other blogs. $ret = false; if ( is_array( $blogs ) && count( $blogs ) > 0 ) { @@ -115,102 +100,91 @@ function get_active_blog_for_user( $user_id ) { // get an active blog for user - $details = get_blog_details( $blog_id ); if ( is_object( $details ) && $details->archived == 0 && $details->spam == 0 && $details->deleted == 0 ) { $ret = $blog; - $changed = false; - if ( get_user_meta( $user_id , 'primary_blog', true ) != $blog_id ) { + if ( get_user_meta( $user_id , 'primary_blog', true ) != $blog_id ) update_user_meta( $user_id, 'primary_blog', $blog_id ); - $changed = true; - } - if ( !get_user_meta($user_id , 'source_domain', true) ) { + if ( !get_user_meta($user_id , 'source_domain', true) ) update_user_meta( $user_id, 'source_domain', $blog->domain ); - $changed = true; - } - if ( $changed ) - wp_cache_delete( $user_id, 'users' ); break; } } } else { - // Should never get here - $dashboard_blog = get_dashboard_blog(); - add_user_to_blog( $dashboard_blog->blog_id, $user_id, 'subscriber' ); // Add subscriber permission for dashboard blog - update_user_meta( $user_id, 'primary_blog', $dashboard_blog->blog_id ); - return $dashboard_blog; + return null; } return $ret; } else { - return $details; - } -} - -function is_user_member_of_blog( $user_id, $blog_id = 0 ) { - $user_id = (int) $user_id; - $blog_id = (int) $blog_id; - - if ( $blog_id == 0 ) { - global $wpdb; - $blog_id = $wpdb->blogid; + return $primary; } - - $blogs = get_blogs_of_user( $user_id ); - if ( is_array( $blogs ) ) - return array_key_exists( $blog_id, $blogs ); - else - return false; } +/** + * The number of active users in your installation. + * + * The count is cached and updated twice daily. This is not a live count. + * + * @since MU 2.7 + * + * @return int + */ function get_user_count() { - global $wpdb; - - $count_ts = get_site_option( 'user_count_ts' ); - if ( time() - $count_ts > 3600 ) { - $count = $wpdb->get_var( $wpdb->prepare("SELECT COUNT(ID) as c FROM $wpdb->users WHERE spam = '0' AND deleted = '0'") ); - update_site_option( 'user_count', $count ); - update_site_option( 'user_count_ts', time() ); - } - - $count = get_site_option( 'user_count' ); - - return $count; + return get_site_option( 'user_count' ); } -function get_blog_count( $id = 0 ) { - global $wpdb; - - if ( $id == 0 ) - $id = $wpdb->siteid; - - $count_ts = get_site_option( 'blog_count_ts' ); - if ( time() - $count_ts > 3600 ) { - $count = $wpdb->get_var( $wpdb->prepare("SELECT COUNT(blog_id) as c FROM $wpdb->blogs WHERE site_id = %d AND spam = '0' AND deleted = '0' and archived = '0'", $id) ); - update_site_option( 'blog_count', $count ); - update_site_option( 'blog_count_ts', time() ); - } - - $count = get_site_option( 'blog_count' ); +/** + * The number of active sites on your installation. + * + * The count is cached and updated twice daily. This is not a live count. + * + * @since MU 1.0 + * + * @param int $network_id Deprecated, not supported. + * @return int + */ +function get_blog_count( $network_id = 0 ) { + if ( func_num_args() ) + _deprecated_argument( __FUNCTION__, '3.1' ); - return $count; + return get_site_option( 'blog_count' ); } +/** + * Get a blog post from any site on the network. + * + * @since MU 1.0 + * + * @param int $blog_id ID of the blog. + * @param int $post_id ID of the post you're looking for. + * @return WP_Post|null WP_Post on success or null on failure + */ function get_blog_post( $blog_id, $post_id ) { - global $wpdb; - - $key = $blog_id . '-' . $post_id; - $post = wp_cache_get( $key, 'global-posts' ); - if ( $post == false ) { - $post = $wpdb->get_row( $wpdb->prepare( 'SELECT * FROM ' . $wpdb->get_blog_prefix( $blog_id ) . 'posts WHERE ID = %d', $post_id ) ); - wp_cache_add( $key, $post, 'global-posts' ); - } + switch_to_blog( $blog_id ); + $post = get_post( $post_id ); + restore_current_blog(); return $post; } +/** + * Add a user to a blog. + * + * Use the 'add_user_to_blog' action to fire an event when + * users are added to a blog. + * + * @since MU 1.0 + * + * @param int $blog_id ID of the blog you're adding the user to. + * @param int $user_id ID of the user you're adding. + * @param string $role The role you want the user to have + * @return bool + */ function add_user_to_blog( $blog_id, $user_id, $role ) { switch_to_blog($blog_id); - $user = new WP_User($user_id); + $user = get_userdata( $user_id ); - if ( empty($user) || !$user->ID ) - return new WP_Error('user_does_not_exist', __('That user does not exist.')); + if ( ! $user ) { + restore_current_blog(); + return new WP_Error( 'user_does_not_exist', __( 'The requested user does not exist.' ) ); + } if ( !get_user_meta($user_id, 'primary_blog', true) ) { update_user_meta($user_id, 'primary_blog', $blog_id); @@ -226,6 +200,22 @@ function add_user_to_blog( $blog_id, $user_id, $role ) { return true; } +/** + * Remove a user from a blog. + * + * Use the 'remove_user_from_blog' action to fire an event when + * users are removed from a blog. + * + * Accepts an optional $reassign parameter, if you want to + * reassign the user's blog posts to another user upon removal. + * + * @since MU 1.0 + * + * @param int $user_id ID of the user you're removing. + * @param int $blog_id ID of the blog you're removing the user from. + * @param string $reassign Optional. A user to whom to reassign posts. + * @return bool + */ function remove_user_from_blog($user_id, $blog_id = '', $reassign = '') { global $wpdb; switch_to_blog($blog_id); @@ -252,7 +242,12 @@ function remove_user_from_blog($user_id, $blog_id = '', $reassign = '') { } // wp_revoke_user($user_id); - $user = new WP_User($user_id); + $user = get_userdata( $user_id ); + if ( ! $user ) { + restore_current_blog(); + return new WP_Error('user_does_not_exist', __('That user does not exist.')); + } + $user->remove_all_caps(); $blogs = get_blogs_of_user($user_id); @@ -268,25 +263,36 @@ function remove_user_from_blog($user_id, $blog_id = '', $reassign = '') { } restore_current_blog(); + + return true; } +/** + * Create an empty blog. + * + * @since MU 1.0 + * @uses install_blog() + * + * @param string $domain The new blog's domain. + * @param string $path The new blog's path. + * @param string $weblog_title The new blog's title. + * @param int $site_id Optional. Defaults to 1. + * @return int The ID of the newly created blog + */ function create_empty_blog( $domain, $path, $weblog_title, $site_id = 1 ) { - $domain = addslashes( $domain ); - $weblog_title = addslashes( $weblog_title ); - if ( empty($path) ) $path = '/'; // Check if the domain has been used already. We should return an error message. if ( domain_exists($domain, $path, $site_id) ) - return __( 'Error: Site URL already taken.' ); + return __( 'ERROR: Site URL already taken.' ); - // Need to backup wpdb table names, and create a new wp_blogs entry for new blog. + // Need to back up wpdb table names, and create a new wp_blogs entry for new blog. // Need to get blog_id from wp_blogs, and create new table names. // Must restore table names at the end of function. if ( ! $blog_id = insert_blog($domain, $path, $site_id) ) - return __( 'Error: problem creating site entry.' ); + return __( 'ERROR: problem creating site entry.' ); switch_to_blog($blog_id); install_blog($blog_id); @@ -295,119 +301,133 @@ function create_empty_blog( $domain, $path, $weblog_title, $site_id = 1 ) { return $blog_id; } -function get_blog_permalink( $_blog_id, $post_id ) { - $key = "{$_blog_id}-{$post_id}-blog_permalink"; - $link = wp_cache_get( $key, 'site-options' ); - if ( $link == false ) { - switch_to_blog( $_blog_id ); - $link = get_permalink( $post_id ); - restore_current_blog(); - wp_cache_add( $key, $link, 'site-options', 360 ); - } +/** + * Get the permalink for a post on another blog. + * + * @since MU 1.0 + * + * @param int $blog_id ID of the source blog. + * @param int $post_id ID of the desired post. + * @return string The post's permalink + */ +function get_blog_permalink( $blog_id, $post_id ) { + switch_to_blog( $blog_id ); + $link = get_permalink( $post_id ); + restore_current_blog(); + return $link; } +/** + * Get a blog's numeric ID from its URL. + * + * On a subdirectory installation like example.com/blog1/, + * $domain will be the root 'example.com' and $path the + * subdirectory '/blog1/'. With subdomains like blog1.example.com, + * $domain is 'blog1.example.com' and $path is '/'. + * + * @since MU 2.6.5 + * + * @param string $domain + * @param string $path Optional. Not required for subdomain installations. + * @return int 0 if no blog found, otherwise the ID of the matching blog + */ function get_blog_id_from_url( $domain, $path = '/' ) { global $wpdb; - $domain = strtolower( $wpdb->escape( $domain ) ); - $path = strtolower( $wpdb->escape( $path ) ); + $domain = strtolower( $domain ); + $path = strtolower( $path ); $id = wp_cache_get( md5( $domain . $path ), 'blog-id-cache' ); - if ( $id == -1 ) { // blog does not exist + if ( $id == -1 ) // blog does not exist return 0; - } elseif ( $id ) { - return (int)$id; - } + elseif ( $id ) + return (int) $id; - $id = $wpdb->get_var( "SELECT blog_id FROM $wpdb->blogs WHERE domain = '$domain' and path = '$path' /* get_blog_id_from_url */" ); + $id = $wpdb->get_var( $wpdb->prepare( "SELECT blog_id FROM $wpdb->blogs WHERE domain = %s and path = %s /* get_blog_id_from_url */", $domain, $path ) ); - if ( !$id ) { + if ( ! $id ) { wp_cache_set( md5( $domain . $path ), -1, 'blog-id-cache' ); - return false; + return 0; } + wp_cache_set( md5( $domain . $path ), $id, 'blog-id-cache' ); return $id; } -// wpmu admin functions - -function wpmu_admin_do_redirect( $url = '' ) { - $ref = ''; - if ( isset( $_GET['ref'] ) ) - $ref = $_GET['ref']; - if ( isset( $_POST['ref'] ) ) - $ref = $_POST['ref']; - - if ( $ref ) { - $ref = wpmu_admin_redirect_add_updated_param( $ref ); - wp_redirect( $ref ); - exit(); - } - if ( empty( $_SERVER['HTTP_REFERER'] ) == false ) { - wp_redirect( $_SERVER['HTTP_REFERER'] ); - exit(); - } - - $url = wpmu_admin_redirect_add_updated_param( $url ); - if ( isset( $_GET['redirect'] ) ) { - if ( substr( $_GET['redirect'], 0, 2 ) == 's_' ) - $url .= '&action=blogs&s='. esc_html( substr( $_GET['redirect'], 2 ) ); - } elseif ( isset( $_POST['redirect'] ) ) { - $url = wpmu_admin_redirect_add_updated_param( $_POST['redirect'] ); - } - wp_redirect( $url ); - exit(); -} - -function wpmu_admin_redirect_add_updated_param( $url = '' ) { - if ( strpos( $url, 'updated=true' ) === false ) { - if ( strpos( $url, '?' ) === false ) - return $url . '?updated=true'; - else - return $url . '&updated=true'; - } - return $url; -} +// Admin functions -function is_blog_user( $blog_id = 0 ) { - global $current_user, $wpdb; +/** + * Checks an email address against a list of banned domains. + * + * This function checks against the Banned Email Domains list + * at wp-admin/network/settings.php. The check is only run on + * self-registrations; user creation at wp-admin/network/users.php + * bypasses this check. + * + * @since MU + * + * @param string $user_email The email provided by the user at registration. + * @return bool Returns true when the email address is banned. + */ +function is_email_address_unsafe( $user_email ) { + $banned_names = get_site_option( 'banned_email_domains' ); + if ( $banned_names && ! is_array( $banned_names ) ) + $banned_names = explode( "\n", $banned_names ); - if ( !$blog_id ) - $blog_id = $wpdb->blogid; + $is_email_address_unsafe = false; - $cap_key = $wpdb->base_prefix . $blog_id . '_capabilities'; + if ( $banned_names && is_array( $banned_names ) ) { + $banned_names = array_map( 'strtolower', $banned_names ); + $normalized_email = strtolower( $user_email ); - if ( is_array($current_user->$cap_key) && in_array(1, $current_user->$cap_key) ) - return true; + list( $email_local_part, $email_domain ) = explode( '@', $normalized_email ); - return false; -} + foreach ( $banned_names as $banned_domain ) { + if ( ! $banned_domain ) + continue; -function is_email_address_unsafe( $user_email ) { - $banned_names = get_site_option( 'banned_email_domains' ); - if ($banned_names && !is_array( $banned_names )) - $banned_names = explode( "\n", $banned_names); + if ( $email_domain == $banned_domain ) { + $is_email_address_unsafe = true; + break; + } - if ( is_array( $banned_names ) && empty( $banned_names ) == false ) { - $email_domain = strtolower( substr( $user_email, 1 + strpos( $user_email, '@' ) ) ); - foreach ( (array) $banned_names as $banned_domain ) { - if ( $banned_domain == '' ) - continue; - if ( - strstr( $email_domain, $banned_domain ) || - ( - strstr( $banned_domain, '/' ) && - preg_match( $banned_domain, $email_domain ) - ) - ) - return true; + $dotted_domain = ".$banned_domain"; + if ( $dotted_domain === substr( $normalized_email, -strlen( $dotted_domain ) ) ) { + $is_email_address_unsafe = true; + break; + } } } - return false; + + return apply_filters( 'is_email_address_unsafe', $is_email_address_unsafe, $user_email ); } +/** + * Processes new user registrations. + * + * Checks the data provided by the user during signup. Verifies + * the validity and uniqueness of user names and user email addresses, + * and checks email addresses against admin-provided domain + * whitelists and blacklists. + * + * The hook 'wpmu_validate_user_signup' provides an easy way + * to modify the signup process. The value $result, which is passed + * to the hook, contains both the user-provided info and the error + * messages created by the function. 'wpmu_validate_user_signup' allows + * you to process the data in any way you'd like, and unset the + * relevant errors if necessary. + * + * @since MU + * @uses is_email_address_unsafe() + * @uses username_exists() + * @uses email_exists() + * + * @param string $user_name The login name provided by the user. + * @param string $user_email The email provided by the user. + * @return array Contains username, email, and error messages. + */ function wpmu_validate_user_signup($user_name, $user_email) { global $wpdb; @@ -415,18 +435,16 @@ function wpmu_validate_user_signup($user_name, $user_email) { $orig_username = $user_name; $user_name = preg_replace( '/\s+/', '', sanitize_user( $user_name, true ) ); - $maybe = array(); - preg_match( '/[a-z0-9]+/', $user_name, $maybe ); - if ( $user_name != $orig_username || $user_name != $maybe[0] ) { - $errors->add( 'user_name', __( "Only the lowercase letters a-z and numbers allowed" ) ); + if ( $user_name != $orig_username || preg_match( '/[^a-z0-9]/', $user_name ) ) { + $errors->add( 'user_name', __( 'Only lowercase letters (a-z) and numbers are allowed.' ) ); $user_name = $orig_username; } $user_email = sanitize_email( $user_email ); if ( empty( $user_name ) ) - $errors->add('user_name', __('Please enter a username')); + $errors->add('user_name', __( 'Please enter a username.' ) ); $illegal_names = get_site_option( 'illegal_names' ); if ( is_array( $illegal_names ) == false ) { @@ -434,25 +452,23 @@ function wpmu_validate_user_signup($user_name, $user_email) { add_site_option( 'illegal_names', $illegal_names ); } if ( in_array( $user_name, $illegal_names ) == true ) - $errors->add('user_name', __('That username is not allowed')); + $errors->add('user_name', __( 'That username is not allowed.' ) ); if ( is_email_address_unsafe( $user_email ) ) $errors->add('user_email', __('You cannot use that email address to signup. We are having problems with them blocking some of our email. Please use another email provider.')); if ( strlen( $user_name ) < 4 ) - $errors->add('user_name', __('Username must be at least 4 characters')); + $errors->add('user_name', __( 'Username must be at least 4 characters.' ) ); if ( strpos( ' ' . $user_name, '_' ) != false ) $errors->add( 'user_name', __( 'Sorry, usernames may not contain the character “_”!' ) ); // all numeric? - $match = array(); - preg_match( '/[0-9]*/', $user_name, $match ); - if ( $match[0] == $user_name ) + if ( preg_match( '/^[0-9]*$/', $user_name ) ) $errors->add('user_name', __('Sorry, usernames must have letters too!')); if ( !is_email( $user_email ) ) - $errors->add('user_email', __('Please enter a correct email address')); + $errors->add('user_email', __( 'Please enter a valid email address.' ) ); $limited_email_domains = get_site_option( 'limited_email_domains' ); if ( is_array( $limited_email_domains ) && empty( $limited_email_domains ) == false ) { @@ -463,11 +479,11 @@ function wpmu_validate_user_signup($user_name, $user_email) { // Check if the username has been used already. if ( username_exists($user_name) ) - $errors->add('user_name', __('Sorry, that username already exists!')); + $errors->add( 'user_name', __( 'Sorry, that username already exists!' ) ); // Check if the email address has been used already. if ( email_exists($user_email) ) - $errors->add('user_email', __('Sorry, that email address is already used!')); + $errors->add( 'user_email', __( 'Sorry, that email address is already used!' ) ); // Has someone already signed up for this username? $signup = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->signups WHERE user_login = %s", $user_name) ); @@ -476,21 +492,18 @@ function wpmu_validate_user_signup($user_name, $user_email) { $now = current_time( 'timestamp', true ); $diff = $now - $registered_at; // If registered more than two days ago, cancel registration and let this signup go through. - if ( $diff > 172800 ) - $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->signups WHERE user_login = %s", $user_name) ); + if ( $diff > 2 * DAY_IN_SECONDS ) + $wpdb->delete( $wpdb->signups, array( 'user_login' => $user_name ) ); else $errors->add('user_name', __('That username is currently reserved but may be available in a couple of days.')); - - if ( $signup->active == 0 && $signup->user_email == $user_email ) - $errors->add('user_email_used', __('username and email used')); } $signup = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->signups WHERE user_email = %s", $user_email) ); if ( $signup != null ) { $diff = current_time( 'timestamp', true ) - mysql2date('U', $signup->registered); // If registered more than two days ago, cancel registration and let this signup go through. - if ( $diff > 172800 ) - $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->signups WHERE user_email = %s", $user_email) ); + if ( $diff > 2 * DAY_IN_SECONDS ) + $wpdb->delete( $wpdb->signups, array( 'user_email' => $user_email ) ); else $errors->add('user_email', __('That email address has already been used. Please check your inbox for an activation email. It will become available in a couple of days if you do nothing.')); } @@ -500,8 +513,32 @@ function wpmu_validate_user_signup($user_name, $user_email) { return apply_filters('wpmu_validate_user_signup', $result); } +/** + * Processes new site registrations. + * + * Checks the data provided by the user during blog signup. Verifies + * the validity and uniqueness of blog paths and domains. + * + * This function prevents the current user from registering a new site + * with a blogname equivalent to another user's login name. Passing the + * $user parameter to the function, where $user is the other user, is + * effectively an override of this limitation. + * + * Filter 'wpmu_validate_blog_signup' if you want to modify + * the way that WordPress validates new site signups. + * + * @since MU + * @uses domain_exists() + * @uses username_exists() + * + * @param string $blogname The blog name provided by the user. Must be unique. + * @param string $blog_title The blog title provided by the user. + * @return array Contains the new site data and error messages. + */ function wpmu_validate_blog_signup($blogname, $blog_title, $user = '') { - global $wpdb, $domain, $base, $current_site; + global $wpdb, $domain, $current_site; + + $base = $current_site->path; $blog_title = strip_tags( $blog_title ); $blog_title = substr( $blog_title, 0, 50 ); @@ -517,22 +554,19 @@ function wpmu_validate_blog_signup($blogname, $blog_title, $user = '') { if (! is_subdomain_install() ) $illegal_names = array_merge($illegal_names, apply_filters( 'subdirectory_reserved_names', array( 'page', 'comments', 'blog', 'files', 'feed' ) ) ); - if ( empty( $blogname ) ) - $errors->add('blogname', __('Please enter a site name')); + $errors->add('blogname', __( 'Please enter a site name.' ) ); - $maybe = array(); - preg_match( '/[a-z0-9]+/', $blogname, $maybe ); - if ( $blogname != $maybe[0] ) - $errors->add('blogname', __('Only lowercase letters and numbers allowed')); + if ( preg_match( '/[^a-z0-9]+/', $blogname ) ) + $errors->add('blogname', __( 'Only lowercase letters (a-z) and numbers are allowed.' ) ); if ( in_array( $blogname, $illegal_names ) == true ) - $errors->add('blogname', __('That name is not allowed')); + $errors->add('blogname', __( 'That name is not allowed.' ) ); if ( strlen( $blogname ) < 4 && !is_super_admin() ) - $errors->add('blogname', __('Site name must be at least 4 characters')); + $errors->add('blogname', __( 'Site name must be at least 4 characters.' ) ); - if ( strpos( ' ' . $blogname, '_' ) != false ) + if ( strpos( $blogname, '_' ) !== false ) $errors->add( 'blogname', __( 'Sorry, site names may not contain the character “_”!' ) ); // do not allow users to create a blog that conflicts with a page on the main blog. @@ -540,17 +574,15 @@ function wpmu_validate_blog_signup($blogname, $blog_title, $user = '') { $errors->add( 'blogname', __( 'Sorry, you may not use that site name.' ) ); // all numeric? - $match = array(); - preg_match( '/[0-9]*/', $blogname, $match ); - if ( $match[0] == $blogname ) + if ( preg_match( '/^[0-9]*$/', $blogname ) ) $errors->add('blogname', __('Sorry, site names must have letters too!')); $blogname = apply_filters( 'newblogname', $blogname ); - $blog_title = stripslashes( $blog_title ); + $blog_title = wp_unslash( $blog_title ); if ( empty( $blog_title ) ) - $errors->add('blog_title', __('Please enter a site title')); + $errors->add('blog_title', __( 'Please enter a site title.' ) ); // Check if the domain/path has been used already. if ( is_subdomain_install() ) { @@ -560,8 +592,8 @@ function wpmu_validate_blog_signup($blogname, $blog_title, $user = '') { $mydomain = "$domain"; $path = $base.$blogname.'/'; } - if ( domain_exists($mydomain, $path) ) - $errors->add('blogname', __('Sorry, that site already exists!')); + if ( domain_exists($mydomain, $path, $current_site->id) ) + $errors->add( 'blogname', __( 'Sorry, that site already exists!' ) ); if ( username_exists( $blogname ) ) { if ( is_object( $user ) == false || ( is_object($user) && ( $user->user_login != $blogname ) ) ) @@ -573,26 +605,34 @@ function wpmu_validate_blog_signup($blogname, $blog_title, $user = '') { if ( ! empty($signup) ) { $diff = current_time( 'timestamp', true ) - mysql2date('U', $signup->registered); // If registered more than two days ago, cancel registration and let this signup go through. - if ( $diff > 172800 ) - $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->signups WHERE domain = %s AND path = %s", $mydomain, $path) ); + if ( $diff > 2 * DAY_IN_SECONDS ) + $wpdb->delete( $wpdb->signups, array( 'domain' => $mydomain , 'path' => $path ) ); else $errors->add('blogname', __('That site is currently reserved but may be available in a couple days.')); } - $result = array('domain' => $mydomain, 'path' => $path, 'blogname' => $blogname, 'blog_title' => $blog_title, 'errors' => $errors); + $result = array('domain' => $mydomain, 'path' => $path, 'blogname' => $blogname, 'blog_title' => $blog_title, 'user' => $user, 'errors' => $errors); return apply_filters('wpmu_validate_blog_signup', $result); } -// Record signup information for future activation. wpmu_validate_signup() should be run -// on the inputs before calling wpmu_signup(). -function wpmu_signup_blog($domain, $path, $title, $user, $user_email, $meta = '') { +/** + * Record site signup information for future activation. + * + * @since MU + * @uses wpmu_signup_blog_notification() + * + * @param string $domain The requested domain. + * @param string $path The requested path. + * @param string $title The requested site title. + * @param string $user The user's requested login name. + * @param string $user_email The user's email address. + * @param array $meta By default, contains the requested privacy setting and lang_id. + */ +function wpmu_signup_blog( $domain, $path, $title, $user, $user_email, $meta = array() ) { global $wpdb; $key = substr( md5( time() . rand() . $domain ), 0, 16 ); $meta = serialize($meta); - $domain = $wpdb->escape($domain); - $path = $wpdb->escape($path); - $title = $wpdb->escape($title); $wpdb->insert( $wpdb->signups, array( 'domain' => $domain, @@ -608,7 +648,20 @@ function wpmu_signup_blog($domain, $path, $title, $user, $user_email, $meta = '' wpmu_signup_blog_notification($domain, $path, $title, $user, $user_email, $key, $meta); } -function wpmu_signup_user($user, $user_email, $meta = '') { +/** + * Record user signup information for future activation. + * + * This function is used when user registration is open but + * new site registration is not. + * + * @since MU + * @uses wpmu_signup_user_notification() + * + * @param string $user The user's requested login name. + * @param string $user_email The user's email address. + * @param array $meta By default, this is an empty array. + */ +function wpmu_signup_user( $user, $user_email, $meta = array() ) { global $wpdb; // Format data @@ -631,8 +684,31 @@ function wpmu_signup_user($user, $user_email, $meta = '') { wpmu_signup_user_notification($user, $user_email, $key, $meta); } -// Notify user of signup success. -function wpmu_signup_blog_notification($domain, $path, $title, $user, $user_email, $key, $meta = '') { +/** + * Notify user of signup success. + * + * This is the notification function used when site registration + * is enabled. + * + * Filter 'wpmu_signup_blog_notification' to bypass this function or + * replace it with your own notification behavior. + * + * Filter 'wpmu_signup_blog_notification_email' and + * 'wpmu_signup_blog_notification_subject' to change the content + * and subject line of the email sent to newly registered users. + * + * @since MU + * + * @param string $domain The new blog domain. + * @param string $path The new blog path. + * @param string $title The site title. + * @param string $user The user's login name. + * @param string $user_email The user's email address. + * @param string $key The activation key created in wpmu_signup_blog() + * @param array $meta By default, contains the requested privacy setting and lang_id. + * @return bool + */ +function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_email, $key, $meta = array() ) { global $current_site; if ( !apply_filters('wpmu_signup_blog_notification', $domain, $path, $title, $user, $user_email, $key, $meta) ) @@ -650,14 +726,50 @@ function wpmu_signup_blog_notification($domain, $path, $title, $user, $user_emai $admin_email = 'support@' . $_SERVER['SERVER_NAME']; $from_name = get_site_option( 'site_name' ) == '' ? 'WordPress' : esc_html( get_site_option( 'site_name' ) ); $message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n"; - $message = sprintf( apply_filters( 'wpmu_signup_blog_notification_email', __( "To activate your blog, please click the following link:\n\n%s\n\nAfter you activate, you will receive *another email* with your login.\n\nAfter you activate, you can visit your site here:\n\n%s" ) ), $activate_url, esc_url( "http://{$domain}{$path}" ), $key ); + $message = sprintf( + apply_filters( 'wpmu_signup_blog_notification_email', + __( "To activate your blog, please click the following link:\n\n%s\n\nAfter you activate, you will receive *another email* with your login.\n\nAfter you activate, you can visit your site here:\n\n%s" ), + $domain, $path, $title, $user, $user_email, $key, $meta + ), + $activate_url, + esc_url( "http://{$domain}{$path}" ), + $key + ); // TODO: Don't hard code activation link. - $subject = sprintf( apply_filters( 'wpmu_signup_blog_notification_subject', __( '[%1s] Activate %2s' ) ), $from_name, esc_url( 'http://' . $domain . $path ) ); + $subject = sprintf( + apply_filters( 'wpmu_signup_blog_notification_subject', + __( '[%1$s] Activate %2$s' ), + $domain, $path, $title, $user, $user_email, $key, $meta + ), + $from_name, + esc_url( 'http://' . $domain . $path ) + ); wp_mail($user_email, $subject, $message, $message_headers); return true; } -function wpmu_signup_user_notification($user, $user_email, $key, $meta = '') { +/** + * Notify user of signup success. + * + * This is the notification function used when no new site has + * been requested. + * + * Filter 'wpmu_signup_user_notification' to bypass this function or + * replace it with your own notification behavior. + * + * Filter 'wpmu_signup_user_notification_email' and + * 'wpmu_signup_user_notification_subject' to change the content + * and subject line of the email sent to newly registered users. + * + * @since MU + * + * @param string $user The user's login name. + * @param string $user_email The user's email address. + * @param string $key The activation key created in wpmu_signup_user() + * @param array $meta By default, an empty array. + * @return bool + */ +function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array() ) { if ( !apply_filters('wpmu_signup_user_notification', $user, $user_email, $key, $meta) ) return false; @@ -667,33 +779,67 @@ function wpmu_signup_user_notification($user, $user_email, $key, $meta = '') { $admin_email = 'support@' . $_SERVER['SERVER_NAME']; $from_name = get_site_option( 'site_name' ) == '' ? 'WordPress' : esc_html( get_site_option( 'site_name' ) ); $message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n"; - $message = sprintf( apply_filters( 'wpmu_signup_user_notification_email', __( "To activate your user, please click the following link:\n\n%s\n\nAfter you activate, you will receive *another email* with your login.\n\n" ) ), site_url( "wp-activate.php?key=$key" ), $key ); + $message = sprintf( + apply_filters( 'wpmu_signup_user_notification_email', + __( "To activate your user, please click the following link:\n\n%s\n\nAfter you activate, you will receive *another email* with your login." ), + $user, $user_email, $key, $meta + ), + site_url( "wp-activate.php?key=$key" ) + ); // TODO: Don't hard code activation link. - $subject = sprintf( __( apply_filters( 'wpmu_signup_user_notification_subject', '[%1s] Activate %2s' ) ), $from_name, $user); + $subject = sprintf( + apply_filters( 'wpmu_signup_user_notification_subject', + __( '[%1$s] Activate %2$s' ), + $user, $user_email, $key, $meta + ), + $from_name, + $user + ); wp_mail($user_email, $subject, $message, $message_headers); return true; } +/** + * Activate a signup. + * + * Hook to 'wpmu_activate_user' or 'wpmu_activate_blog' for events + * that should happen only when users or sites are self-created (since + * those actions are not called when users and sites are created + * by a Super Admin). + * + * @since MU + * @uses wp_generate_password() + * @uses wpmu_welcome_user_notification() + * @uses add_user_to_blog() + * @uses wpmu_create_user() + * @uses wpmu_create_blog() + * @uses wpmu_welcome_notification() + * + * @param string $key The activation key provided to the user. + * @return array An array containing information about the activated user and/or blog + */ function wpmu_activate_signup($key) { - global $wpdb, $current_site; + global $wpdb; $signup = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->signups WHERE activation_key = %s", $key) ); - if ( empty($signup) ) - return new WP_Error('invalid_key', __('Invalid activation key.')); + if ( empty( $signup ) ) + return new WP_Error( 'invalid_key', __( 'Invalid activation key.' ) ); - if ( $signup->active ) - return new WP_Error('already_active', __('The site is already active.'), $signup); + if ( $signup->active ) { + if ( empty( $signup->domain ) ) + return new WP_Error( 'already_active', __( 'The user is already active.' ), $signup ); + else + return new WP_Error( 'already_active', __( 'The site is already active.' ), $signup ); + } - $meta = unserialize($signup->meta); - $user_login = $wpdb->escape($signup->user_login); - $user_email = $wpdb->escape($signup->user_email); - $password = wp_generate_password(); + $meta = maybe_unserialize($signup->meta); + $password = wp_generate_password( 12, false ); - $user_id = username_exists($user_login); + $user_id = username_exists($signup->user_login); if ( ! $user_id ) - $user_id = wpmu_create_user($user_login, $password, $user_email); + $user_id = wpmu_create_user($signup->user_login, $password, $signup->user_email); else $user_already_exists = true; @@ -708,17 +854,9 @@ function wpmu_activate_signup($key) { if ( isset( $user_already_exists ) ) return new WP_Error( 'user_already_exists', __( 'That username is already activated.' ), $signup); - wpmu_welcome_user_notification($user_id, $password, $meta); - $user_site = get_site_option( 'dashboard_blog', $current_site->blog_id ); - - if ( $user_site == false ) - add_user_to_blog( '1', $user_id, get_site_option( 'default_user_role', 'subscriber' ) ); - else - add_user_to_blog( $user_site, $user_id, get_site_option( 'default_user_role', 'subscriber' ) ); - - add_new_user_to_blog( $user_id, $user_email, $meta ); - do_action('wpmu_activate_user', $user_id, $password, $meta); - return array('user_id' => $user_id, 'password' => $password, 'meta' => $meta); + wpmu_welcome_user_notification( $user_id, $password, $meta ); + do_action( 'wpmu_activate_user', $user_id, $password, $meta ); + return array( 'user_id' => $user_id, 'password' => $password, 'meta' => $meta ); } $blog_id = wpmu_create_blog( $signup->domain, $signup->path, $signup->title, $user_id, $meta, $wpdb->siteid ); @@ -726,7 +864,7 @@ function wpmu_activate_signup($key) { // TODO: What to do if we create a user but cannot create a blog? if ( is_wp_error($blog_id) ) { // If blog is taken, that means a previous attempt to activate this blog failed in between creating the blog and - // setting the activation flag. Let's just set the active flag and instruct the user to reset their password. + // setting the activation flag. Let's just set the active flag and instruct the user to reset their password. if ( 'blog_taken' == $blog_id->get_error_code() ) { $blog_id->add_data( $signup ); $wpdb->update( $wpdb->signups, array( 'active' => 1, 'activated' => $now ), array( 'activation_key' => $key ) ); @@ -741,11 +879,27 @@ function wpmu_activate_signup($key) { return array('blog_id' => $blog_id, 'user_id' => $user_id, 'password' => $password, 'title' => $signup->title, 'meta' => $meta); } -function wpmu_create_user( $user_name, $password, $email) { +/** + * Create a user. + * + * This function runs when a user self-registers as well as when + * a Super Admin creates a new user. Hook to 'wpmu_new_user' for events + * that should affect all new users, but only on Multisite (otherwise + * use 'user_register'). + * + * @since MU + * @uses wp_create_user() + * + * @param string $user_name The new user's login name. + * @param string $password The new user's password. + * @param string $email The new user's email address. + * @return mixed Returns false on failure, or int $user_id on success + */ +function wpmu_create_user( $user_name, $password, $email ) { $user_name = preg_replace( '/\s+/', '', sanitize_user( $user_name, true ) ); $user_id = wp_create_user( $user_name, $password, $email ); - if ( is_wp_error($user_id) ) + if ( is_wp_error( $user_id ) ) return false; // Newly created users have no roles or caps until they are added to a blog. @@ -757,7 +911,36 @@ function wpmu_create_user( $user_name, $password, $email) { return $user_id; } -function wpmu_create_blog($domain, $path, $title, $user_id, $meta = '', $site_id = 1) { +/** + * Create a site. + * + * This function runs when a user self-registers a new site as well + * as when a Super Admin creates a new site. Hook to 'wpmu_new_blog' + * for events that should affect all new sites. + * + * On subdirectory installs, $domain is the same as the main site's + * domain, and the path is the subdirectory name (eg 'example.com' + * and '/blog1/'). On subdomain installs, $domain is the new subdomain + + * root domain (eg 'blog1.example.com'), and $path is '/'. + * + * @since MU + * @uses domain_exists() + * @uses insert_blog() + * @uses wp_install_defaults() + * @uses add_user_to_blog() + * + * @param string $domain The new site's domain. + * @param string $path The new site's path. + * @param string $title The new site's title. + * @param int $user_id The user ID of the new site's admin. + * @param array $meta Optional. Used to set initial site options. + * @param int $site_id Optional. Only relevant on multi-network installs. + * @return mixed Returns WP_Error object on failure, int $blog_id on success + */ +function wpmu_create_blog( $domain, $path, $title, $user_id, $meta = array(), $site_id = 1 ) { + $defaults = array( 'public' => 0 ); + $meta = wp_parse_args( $meta, $defaults ); + $domain = preg_replace( '/\s+/', '', sanitize_user( $domain, true ) ); if ( is_subdomain_install() ) @@ -771,7 +954,7 @@ function wpmu_create_blog($domain, $path, $title, $user_id, $meta = '', $site_id // Check if the domain has been used already. We should return an error message. if ( domain_exists($domain, $path, $site_id) ) - return new WP_Error('blog_taken', __('Site already exists.')); + return new WP_Error( 'blog_taken', __( 'Sorry, that site already exists!' ) ); if ( !defined('WP_INSTALLING') ) define( 'WP_INSTALLING', true ); @@ -785,17 +968,17 @@ function wpmu_create_blog($domain, $path, $title, $user_id, $meta = '', $site_id add_user_to_blog($blog_id, $user_id, 'administrator'); - if ( is_array($meta) ) foreach ($meta as $key => $value) { - if ( $key == 'public' || $key == 'archived' || $key == 'mature' || $key == 'spam' || $key == 'deleted' || $key == 'lang_id' ) + foreach ( $meta as $key => $value ) { + if ( in_array( $key, array( 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' ) ) ) update_blog_status( $blog_id, $key, $value ); else update_option( $key, $value ); } add_option( 'WPLANG', get_site_option( 'WPLANG' ) ); - update_option( 'blog_public', (int)$meta['public'] ); + update_option( 'blog_public', (int) $meta['public'] ); - if ( !is_super_admin() && get_user_meta( $user_id, 'primary_blog', true ) == get_site_option( 'dashboard_blog', 1 ) ) + if ( ! is_super_admin( $user_id ) && ! get_user_meta( $user_id, 'primary_blog', true ) ) update_user_meta( $user_id, 'primary_blog', $blog_id ); restore_current_blog(); @@ -804,6 +987,17 @@ function wpmu_create_blog($domain, $path, $title, $user_id, $meta = '', $site_id return $blog_id; } +/** + * Notifies the network admin that a new site has been activated. + * + * Filter 'newblog_notify_siteadmin' to change the content of + * the notification email. + * + * @since MU + * + * @param int $blog_id The new site's ID. + * @return bool + */ function newblog_notify_siteadmin( $blog_id, $deprecated = '' ) { if ( get_site_option( 'registrationnotification' ) != 'yes' ) return false; @@ -812,24 +1006,36 @@ function newblog_notify_siteadmin( $blog_id, $deprecated = '' ) { if ( is_email($email) == false ) return false; - $options_site_url = esc_url(network_admin_url('ms-options.php')); + $options_site_url = esc_url(network_admin_url('settings.php')); switch_to_blog( $blog_id ); $blogname = get_option( 'blogname' ); $siteurl = site_url(); restore_current_blog(); - $msg = sprintf( __( 'New Site: %1s -URL: %2s -Remote IP: %3s + $msg = sprintf( __( 'New Site: %1$s +URL: %2$s +Remote IP: %3$s -Disable these notifications: %4s' ), $blogname, $siteurl, $_SERVER['REMOTE_ADDR'], $options_site_url); +Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER['REMOTE_ADDR'] ), $options_site_url); $msg = apply_filters( 'newblog_notify_siteadmin', $msg ); wp_mail( $email, sprintf( __( 'New Site Registration: %s' ), $siteurl ), $msg ); return true; } +/** + * Notifies the network admin that a new user has been activated. + * + * Filter 'newuser_notify_siteadmin' to change the content of + * the notification email. + * + * @since MU + * @uses apply_filters() Filter newuser_notify_siteadmin to change the content of the email message + * + * @param int $user_id The new user's ID. + * @return bool + */ function newuser_notify_siteadmin( $user_id ) { if ( get_site_option( 'registrationnotification' ) != 'yes' ) return false; @@ -839,24 +1045,51 @@ function newuser_notify_siteadmin( $user_id ) { if ( is_email($email) == false ) return false; - $user = new WP_User($user_id); + $user = get_userdata( $user_id ); - $options_site_url = esc_url(network_admin_url('ms-options.php')); - $msg = sprintf(__('New User: %1s -Remote IP: %2s + $options_site_url = esc_url(network_admin_url('settings.php')); + $msg = sprintf(__('New User: %1$s +Remote IP: %2$s -Disable these notifications: %3s'), $user->user_login, $_SERVER['REMOTE_ADDR'], $options_site_url); +Disable these notifications: %3$s'), $user->user_login, wp_unslash( $_SERVER['REMOTE_ADDR'] ), $options_site_url); - $msg = apply_filters( 'newuser_notify_siteadmin', $msg ); + $msg = apply_filters( 'newuser_notify_siteadmin', $msg, $user ); wp_mail( $email, sprintf(__('New User Registration: %s'), $user->user_login), $msg ); return true; } +/** + * Check whether a blogname is already taken. + * + * Used during the new site registration process to ensure + * that each blogname is unique. + * + * @since MU + * + * @param string $domain The domain to be checked. + * @param string $path The path to be checked. + * @param int $site_id Optional. Relevant only on multi-network installs. + * @return int + */ function domain_exists($domain, $path, $site_id = 1) { global $wpdb; - return $wpdb->get_var( $wpdb->prepare("SELECT blog_id FROM $wpdb->blogs WHERE domain = %s AND path = %s AND site_id = %d", $domain, $path, $site_id) ); + $result = $wpdb->get_var( $wpdb->prepare("SELECT blog_id FROM $wpdb->blogs WHERE domain = %s AND path = %s AND site_id = %d", $domain, $path, $site_id) ); + return apply_filters( 'domain_exists', $result, $domain, $path, $site_id ); } +/** + * Store basic site info in the blogs table. + * + * This function creates a row in the wp_blogs table and returns + * the new blog's ID. It is the first step in creating a new blog. + * + * @since MU + * + * @param string $domain The domain of the new site. + * @param string $path The path of the new site. + * @param int $site_id Unless you're running a multi-network install, be sure to set this value to 1. + * @return int The ID of the new row + */ function insert_blog($domain, $path, $site_id) { global $wpdb; @@ -867,51 +1100,81 @@ function insert_blog($domain, $path, $site_id) { if ( ! $result ) return false; - refresh_blog_details($wpdb->insert_id); - return $wpdb->insert_id; + $blog_id = $wpdb->insert_id; + refresh_blog_details( $blog_id ); + + wp_maybe_update_network_site_counts(); + + return $blog_id; } -// Install an empty blog. wpdb should already be switched. +/** + * Install an empty blog. + * + * Creates the new blog tables and options. If calling this function + * directly, be sure to use switch_to_blog() first, so that $wpdb + * points to the new blog. + * + * @since MU + * @uses make_db_current_silent() + * @uses populate_roles() + * + * @param int $blog_id The value returned by insert_blog(). + * @param string $blog_title The title of the new site. + */ function install_blog($blog_id, $blog_title = '') { - global $wpdb, $table_prefix, $wp_roles; - $wpdb->suppress_errors(); + global $wpdb, $wp_roles, $current_site; // Cast for security $blog_id = (int) $blog_id; require_once( ABSPATH . 'wp-admin/includes/upgrade.php' ); - if ( $wpdb->get_results("SELECT ID FROM $wpdb->posts") ) - die(__('

Already Installed

You appear to have already installed WordPress. To reinstall please clear your old database tables first.

') . ''); - - $wpdb->suppress_errors(false); + $wpdb->suppress_errors(); + if ( $wpdb->get_results( "DESCRIBE {$wpdb->posts}" ) ) + die( '

' . __( 'Already Installed' ) . '

' . __( 'You appear to have already installed WordPress. To reinstall please clear your old database tables first.' ) . '

' ); + $wpdb->suppress_errors( false ); - $url = get_blogaddress_by_id($blog_id); + $url = get_blogaddress_by_id( $blog_id ); // Set everything up - make_db_current_silent(); + make_db_current_silent( 'blog' ); populate_options(); populate_roles(); $wp_roles->_init(); - // fix url. - update_option('siteurl', $url); - update_option('home', $url); - update_option('fileupload_url', $url . "files" ); - update_option('upload_path', "wp-content/blogs.dir/" . $blog_id . "/files"); - update_option('blogname', stripslashes( $blog_title ) ); - update_option('admin_email', ''); - $wpdb->update( $wpdb->options, array('option_value' => ''), array('option_name' => 'admin_email') ); + $url = untrailingslashit( $url ); - // remove all perms - $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE meta_key = %s", $table_prefix.'user_level') ); - $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE meta_key = %s", $table_prefix.'capabilities') ); + update_option( 'siteurl', $url ); + update_option( 'home', $url ); - $wpdb->suppress_errors( false ); + if ( get_site_option( 'ms_files_rewriting' ) ) + update_option( 'upload_path', UPLOADBLOGSDIR . "/$blog_id/files" ); + else + update_option( 'upload_path', get_blog_option( $current_site->blog_id, 'upload_path' ) ); + + update_option( 'blogname', wp_unslash( $blog_title ) ); + update_option( 'admin_email', '' ); + + // remove all perms + $table_prefix = $wpdb->get_blog_prefix(); + delete_metadata( 'user', 0, $table_prefix . 'user_level', null, true ); // delete all + delete_metadata( 'user', 0, $table_prefix . 'capabilities', null, true ); // delete all } -// Deprecated, use wp_install_defaults() -// should be switched already as $blog_id is ignored. +/** + * Set blog defaults. + * + * This function creates a row in the wp_blogs table. + * + * @since MU + * @deprecated MU + * @deprecated Use wp_install_defaults() + * @uses wp_install_defaults() + * + * @param int $blog_id Ignored in this function. + * @param int $user_id + */ function install_blog_defaults($blog_id, $user_id) { global $wpdb; @@ -924,15 +1187,32 @@ function install_blog_defaults($blog_id, $user_id) { $wpdb->suppress_errors( false ); } -function wpmu_welcome_notification($blog_id, $user_id, $password, $title, $meta = '') { - global $current_site; - - if ( !apply_filters('wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta) ) - return false; +/** + * Notify a user that her blog activation has been successful. + * + * Filter 'wpmu_welcome_notification' to disable or bypass. + * + * Filter 'update_welcome_email' and 'update_welcome_subject' to + * modify the content and subject line of the notification email. + * + * @since MU + * + * @param int $blog_id + * @param int $user_id + * @param string $password + * @param string $title The new blog's title + * @param array $meta Optional. Not used in the default function, but is passed along to hooks for customization. + * @return bool + */ +function wpmu_welcome_notification( $blog_id, $user_id, $password, $title, $meta = array() ) { + global $current_site; + + if ( !apply_filters('wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta) ) + return false; - $welcome_email = stripslashes( get_site_option( 'welcome_email' ) ); + $welcome_email = get_site_option( 'welcome_email' ); if ( $welcome_email == false ) - $welcome_email = stripslashes( __( 'Dear User, + $welcome_email = __( 'Dear User, Your new SITE_NAME site has been successfully set up at: BLOG_URL @@ -940,15 +1220,14 @@ BLOG_URL You can log in to the administrator account with the following information: Username: USERNAME Password: PASSWORD -Login Here: BLOG_URLwp-login.php +Log in here: BLOG_URLwp-login.php -We hope you enjoy your new site. -Thanks! +We hope you enjoy your new site. Thanks! ---The Team @ SITE_NAME' ) ); +--The Team @ SITE_NAME' ); $url = get_blogaddress_by_id($blog_id); - $user = new WP_User($user_id); + $user = get_userdata( $user_id ); $welcome_email = str_replace( 'SITE_NAME', $current_site->site_name, $welcome_email ); $welcome_email = str_replace( 'BLOG_TITLE', $title, $welcome_email ); @@ -967,14 +1246,29 @@ Thanks! $message = $welcome_email; if ( empty( $current_site->site_name ) ) - $current_site->site_name = 'WordPress MU'; + $current_site->site_name = 'WordPress'; - $subject = apply_filters( 'update_welcome_subject', sprintf(__('New %1$s Site: %2$s'), $current_site->site_name, stripslashes( $title ) ) ); + $subject = apply_filters( 'update_welcome_subject', sprintf(__('New %1$s Site: %2$s'), $current_site->site_name, wp_unslash( $title ) ) ); wp_mail($user->user_email, $subject, $message, $message_headers); return true; } -function wpmu_welcome_user_notification($user_id, $password, $meta = '') { +/** + * Notify a user that her account activation has been successful. + * + * Filter 'wpmu_welcome_user_notification' to disable or bypass. + * + * Filter 'update_welcome_user_email' and 'update_welcome_user_subject' to + * modify the content and subject line of the notification email. + * + * @since MU + * + * @param int $user_id + * @param string $password + * @param array $meta Optional. Not used in the default function, but is passed along to hooks for customization. + * @return bool + */ +function wpmu_welcome_user_notification( $user_id, $password, $meta = array() ) { global $current_site; if ( !apply_filters('wpmu_welcome_user_notification', $user_id, $password, $meta) ) @@ -982,7 +1276,7 @@ function wpmu_welcome_user_notification($user_id, $password, $meta = '') { $welcome_email = get_site_option( 'welcome_user_email' ); - $user = new WP_User($user_id); + $user = get_userdata( $user_id ); $welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta); $welcome_email = str_replace( 'SITE_NAME', $current_site->site_name, $welcome_email ); @@ -1000,35 +1294,42 @@ function wpmu_welcome_user_notification($user_id, $password, $meta = '') { $message = $welcome_email; if ( empty( $current_site->site_name ) ) - $current_site->site_name = 'WordPress MU'; + $current_site->site_name = 'WordPress'; $subject = apply_filters( 'update_welcome_user_subject', sprintf(__('New %1$s User: %2$s'), $current_site->site_name, $user->user_login) ); wp_mail($user->user_email, $subject, $message, $message_headers); return true; } +/** + * Get the current site info. + * + * Returns an object containing the 'id', 'domain', 'path', and 'site_name' + * properties of the site being viewed. + * + * @see wpmu_current_site() + * + * @since MU + * + * @return object + */ function get_current_site() { global $current_site; return $current_site; } -function get_user_id_from_string( $string ) { - $user_id = 0; - if ( is_email( $string ) ) { - $user = get_user_by('email', $string); - if ( $user ) - $user_id = $user->ID; - } elseif ( is_numeric( $string ) ) { - $user_id = $string; - } else { - $user = get_user_by('login', $string); - if ( $user ) - $user_id = $user->ID; - } - - return $user_id; -} - +/** + * Get a user's most recent post. + * + * Walks through each of a user's blogs to find the post with + * the most recent post_date_gmt. + * + * @since MU + * @uses get_blogs_of_user() + * + * @param int $user_id + * @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts + */ function get_most_recent_post_of_user( $user_id ) { global $wpdb; @@ -1038,7 +1339,8 @@ function get_most_recent_post_of_user( $user_id ) { // Walk through each blog and get the most recent post // published by $user_id foreach ( (array) $user_blogs as $blog ) { - $recent_post = $wpdb->get_row( $wpdb->prepare("SELECT ID, post_date_gmt FROM {$wpdb->base_prefix}{$blog->userblog_id}_posts WHERE post_author = %d AND post_type = 'post' AND post_status = 'publish' ORDER BY post_date_gmt DESC LIMIT 1", $user_id ), ARRAY_A); + $prefix = $wpdb->get_blog_prefix( $blog->userblog_id ); + $recent_post = $wpdb->get_row( $wpdb->prepare("SELECT ID, post_date_gmt FROM {$prefix}posts WHERE post_author = %d AND post_type = 'post' AND post_status = 'publish' ORDER BY post_date_gmt DESC LIMIT 1", $user_id ), ARRAY_A); // Make sure we found a post if ( isset($recent_post['ID']) ) { @@ -1061,7 +1363,20 @@ function get_most_recent_post_of_user( $user_id ) { return $most_recent_post; } -/* Misc functions */ +// Misc functions + +/** + * Get the size of a directory. + * + * A helper function that is used primarily to check whether + * a blog has exceeded its allowed upload space. + * + * @since MU + * @uses recurse_dirsize() + * + * @param string $directory + * @return int + */ function get_dirsize( $directory ) { $dirsize = get_transient( 'dirsize_cache' ); if ( is_array( $dirsize ) && isset( $dirsize[ $directory ][ 'size' ] ) ) @@ -1072,15 +1387,25 @@ function get_dirsize( $directory ) { $dirsize[ $directory ][ 'size' ] = recurse_dirsize( $directory ); - set_transient( 'dirsize_cache', $dirsize, 3600 ); + set_transient( 'dirsize_cache', $dirsize, HOUR_IN_SECONDS ); return $dirsize[ $directory ][ 'size' ]; } +/** + * Get the size of a directory recursively. + * + * Used by get_dirsize() to get a directory's size when it contains + * other directories. + * + * @since MU + * + * @param string $directory + * @return int + */ function recurse_dirsize( $directory ) { $size = 0; - if ( substr( $directory, -1 ) == '/' ) - $directory = substr($directory,0,-1); + $directory = untrailingslashit( $directory ); if ( !file_exists($directory) || !is_dir( $directory ) || !is_readable( $directory ) ) return false; @@ -1103,26 +1428,20 @@ function recurse_dirsize( $directory ) { return $size; } -function upload_is_user_over_quota( $echo = true ) { - if ( get_site_option( 'upload_space_check_disabled' ) ) - return true; - - $spaceAllowed = get_space_allowed(); - if ( empty( $spaceAllowed ) || !is_numeric( $spaceAllowed ) ) - $spaceAllowed = 10; // Default space allowed is 10 MB - - $dirName = BLOGUPLOADDIR; - $size = get_dirsize($dirName) / 1024 / 1024; - - if ( ($spaceAllowed-$size) < 0 ) { - if ( $echo ) - _e( 'Sorry, you have used your space allocation. Please delete some files to upload more files.' ); // No space left - return true; - } else { - return false; - } -} - +/** + * Check an array of MIME types against a whitelist. + * + * WordPress ships with a set of allowed upload filetypes, + * which is defined in wp-includes/functions.php in + * get_allowed_mime_types(). This function is used to filter + * that list against the filetype whitelist provided by Multisite + * Super Admins at wp-admin/network/settings.php. + * + * @since MU + * + * @param array $mimes + * @return array + */ function check_upload_mimes( $mimes ) { $site_exts = explode( ' ', get_site_option( 'upload_filetypes' ) ); foreach ( $site_exts as $ext ) { @@ -1134,28 +1453,34 @@ function check_upload_mimes( $mimes ) { return $site_mimes; } +/** + * Update a blog's post count. + * + * WordPress MS stores a blog's post count as an option so as + * to avoid extraneous COUNTs when a blog's details are fetched + * with get_blog_details(). This function is called when posts + * are published to make sure the count stays current. + * + * @since MU + */ function update_posts_count( $deprecated = '' ) { global $wpdb; update_option( 'post_count', (int) $wpdb->get_var( "SELECT COUNT(ID) FROM {$wpdb->posts} WHERE post_status = 'publish' and post_type = 'post'" ) ); } +/** + * Logs user registrations. + * + * @since MU + * + * @param int $blog_id + * @param int $user_id + */ function wpmu_log_new_registrations( $blog_id, $user_id ) { global $wpdb; - $user = new WP_User( (int) $user_id ); - $wpdb->insert( $wpdb->registration_log, array('email' => $user->user_email, 'IP' => preg_replace( '/[^0-9., ]/', '',$_SERVER['REMOTE_ADDR'] ), 'blog_id' => $blog_id, 'date_registered' => current_time('mysql')) ); -} - -function fix_import_form_size( $size ) { - if ( upload_is_user_over_quota( false ) == true ) - return 0; - - $spaceAllowed = 1024 * 1024 * get_space_allowed(); - $dirName = BLOGUPLOADDIR; - $dirsize = get_dirsize($dirName) ; - if ( $size > $spaceAllowed - $dirsize ) - return $spaceAllowed - $dirsize; // remaining space - else - return $size; // default + $user = get_userdata( (int) $user_id ); + if ( $user ) + $wpdb->insert( $wpdb->registration_log, array('email' => $user->user_email, 'IP' => preg_replace( '/[^0-9., ]/', '', wp_unslash( $_SERVER['REMOTE_ADDR'] ) ), 'blog_id' => $blog_id, 'date_registered' => current_time('mysql')) ); } /** @@ -1226,13 +1551,29 @@ function global_terms( $term_id, $deprecated = '' ) { return $global_id; } +/** + * Ensure that the current site's domain is listed in the allowed redirect host list. + * + * @see wp_validate_redirect() + * @since MU + * + * @return array The current site's domain + */ function redirect_this_site( $deprecated = '' ) { global $current_site; return array( $current_site->domain ); } +/** + * Check whether an upload is too big. + * + * @since MU + * + * @param array $upload + * @return mixed If the upload is under the size limit, $upload is returned. Otherwise returns an error message. + */ function upload_is_file_too_big( $upload ) { - if ( is_array( $upload ) == false || defined( 'WP_IMPORTING' ) ) + if ( is_array( $upload ) == false || defined( 'WP_IMPORTING' ) || get_site_option( 'upload_space_check_disabled' ) ) return $upload; if ( strlen( $upload['bits'] ) > ( 1024 * get_site_option( 'fileupload_maxk', 1500 ) ) ) @@ -1241,30 +1582,43 @@ function upload_is_file_too_big( $upload ) { return $upload; } -function wordpressmu_wp_mail_from( $email ) { - if ( strpos( $email, 'wordpress@' ) !== false ) - $email = get_option( 'admin_email' ); - return $email; -} - +/** + * Add a nonce field to the signup page. + * + * @since MU + * @uses wp_nonce_field() + */ function signup_nonce_fields() { $id = mt_rand(); echo ""; wp_nonce_field('signup_form_' . $id, '_signup_form', false); } +/** + * Process the signup nonce created in signup_nonce_fields(). + * + * @since MU + * @uses wp_create_nonce() + * + * @param array $result + * @return array + */ function signup_nonce_check( $result ) { if ( !strpos( $_SERVER[ 'PHP_SELF' ], 'wp-signup.php' ) ) return $result; if ( wp_create_nonce('signup_form_' . $_POST[ 'signup_form_id' ]) != $_POST['_signup_form'] ) - wp_die( __('Please try again!') ); + wp_die( __( 'Please try again.' ) ); return $result; } +/** + * Correct 404 redirects when NOBLOGREDIRECT is defined. + * + * @since MU + */ function maybe_redirect_404() { - global $current_site; if ( is_main_site() && is_404() && defined( 'NOBLOGREDIRECT' ) && ( $destination = apply_filters( 'blog_redirect_404', NOBLOGREDIRECT ) ) ) { if ( $destination == '%siteurl%' ) $destination = network_home_url(); @@ -1273,6 +1627,16 @@ function maybe_redirect_404() { } } +/** + * Add a new user to a blog by visiting /newbloguser/username/. + * + * This will only work when the user's details are saved as an option + * keyed as 'new_user_x', where 'x' is the username of the user to be + * added, as when a user is invited through the regular WP Add User interface. + * + * @since MU + * @uses add_existing_user_to_blog() + */ function maybe_add_existing_user_to_blog() { if ( false === strpos( $_SERVER[ 'REQUEST_URI' ], '/newbloguser/' ) ) return false; @@ -1288,86 +1652,122 @@ function maybe_add_existing_user_to_blog() { delete_option( 'new_user_' . $key ); if ( empty( $details ) || is_wp_error( add_existing_user_to_blog( $details ) ) ) - wp_die( sprintf(__('An error occurred adding you to this site. Back to the homepage.'), site_url() ) ); + wp_die( sprintf(__('An error occurred adding you to this site. Back to the homepage.'), home_url() ) ); - wp_die( sprintf(__('You have been added to this site. Please visit the homepage or login using your username and password.'), site_url(), admin_url() ), __('Success') ); + wp_die( sprintf( __( 'You have been added to this site. Please visit the homepage or log in using your username and password.' ), home_url(), admin_url() ), __( 'WordPress › Success' ) ); } +/** + * Add a user to a blog based on details from maybe_add_existing_user_to_blog(). + * + * @since MU + * @uses add_user_to_blog() + * + * @param array $details + */ function add_existing_user_to_blog( $details = false ) { + global $blog_id; + if ( is_array( $details ) ) { - $result = add_user_to_blog( '', $details[ 'user_id' ], $details[ 'role' ] ); + $result = add_user_to_blog( $blog_id, $details[ 'user_id' ], $details[ 'role' ] ); do_action( 'added_existing_user', $details[ 'user_id' ], $result ); } return $result; } -function add_new_user_to_blog( $user_id, $email, $meta ) { +/** + * Add a newly created user to the appropriate blog + * + * To add a user in general, use add_user_to_blog(). This function + * is specifically hooked into the wpmu_activate_user action. + * + * @since MU + * @see add_user_to_blog() + * + * @param int $user_id + * @param mixed $password Ignored. + * @param array $meta + */ +function add_new_user_to_blog( $user_id, $password, $meta ) { global $current_site; - if ( $meta[ 'add_to_blog' ] ) { + if ( !empty( $meta[ 'add_to_blog' ] ) ) { $blog_id = $meta[ 'add_to_blog' ]; $role = $meta[ 'new_role' ]; - remove_user_from_blog($user_id, $current_site->blogid); // remove user from main blog. + remove_user_from_blog($user_id, $current_site->blog_id); // remove user from main blog. add_user_to_blog( $blog_id, $user_id, $role ); update_user_meta( $user_id, 'primary_blog', $blog_id ); } } +/** + * Correct From host on outgoing mail to match the site domain + * + * @since MU + */ function fix_phpmailer_messageid( $phpmailer ) { global $current_site; $phpmailer->Hostname = $current_site->domain; } -function is_user_spammy( $username = 0 ) { - if ( $username == 0 ) { - global $current_user; - $user_id = $current_user->ID; - } else { - $user_id = get_user_id_from_string( $username ); +/** + * Check to see whether a user is marked as a spammer, based on user login. + * + * @since MU + * @uses get_user_by() + * + * @param string|WP_User $user Optional. Defaults to current user. WP_User object, + * or user login name as a string. + * @return bool + */ +function is_user_spammy( $user = null ) { + if ( ! is_a( $user, 'WP_User' ) ) { + if ( $user ) + $user = get_user_by( 'login', $user ); + else + $user = wp_get_current_user(); } - $u = new WP_User( $user_id ); - if ( $u->spam == 1 ) - return true; - - return false; + return $user && isset( $user->spam ) && 1 == $user->spam; } +/** + * Update this blog's 'public' setting in the global blogs table. + * + * Public blogs have a setting of 1, private blogs are 0. + * + * @since MU + * @uses update_blog_status() + * + * @param int $old_value + * @param int $value The new public value + * @return bool + */ function update_blog_public( $old_value, $value ) { - global $wpdb; - do_action('update_blog_public'); - update_blog_status( $wpdb->blogid, 'public', (int) $value ); + update_blog_status( get_current_blog_id(), 'public', (int) $value ); } add_action('update_option_blog_public', 'update_blog_public', 10, 2); -/* Redirect all hits to "dashboard" blog to wp-admin/ Dashboard. */ -function redirect_mu_dashboard() { - global $current_site, $current_blog; - - $dashboard_blog = get_dashboard_blog(); - if ( $current_blog->blog_id == $dashboard_blog->blog_id && $dashboard_blog->blog_id != $current_site->blog_id ) { - $protocol = ( is_ssl() ? 'https://' : 'http://' ); - wp_redirect( $protocol . $dashboard_blog->domain . trailingslashit( $dashboard_blog->path ) . 'wp-admin/' ); - die(); - } -} -add_action( 'template_redirect', 'redirect_mu_dashboard' ); - -function get_dashboard_blog() { - if ( $blog = get_site_option( 'dashboard_blog' ) ) - return get_blog_details( $blog ); - - return get_blog_details( $GLOBALS['current_site']->blog_id ); -} - +/** + * Check whether a usermeta key has to do with the current blog. + * + * @since MU + * @uses wp_get_current_user() + * + * @param string $key + * @param int $user_id Optional. Defaults to current user. + * @param int $blog_id Optional. Defaults to current blog. + * @return bool + */ function is_user_option_local( $key, $user_id = 0, $blog_id = 0 ) { - global $current_user, $wpdb; + global $wpdb; + $current_user = wp_get_current_user(); if ( $user_id == 0 ) $user_id = $current_user->ID; if ( $blog_id == 0 ) $blog_id = $wpdb->blogid; - $local_key = $wpdb->base_prefix . $blog_id . '_' . $key; + $local_key = $wpdb->get_blog_prefix( $blog_id ) . $key; if ( isset( $current_user->$local_key ) ) return true; @@ -1375,6 +1775,13 @@ function is_user_option_local( $key, $user_id = 0, $blog_id = 0 ) { return false; } +/** + * Check whether users can self-register, based on Network settings. + * + * @since MU + * + * @return bool + */ function users_can_register_signup_filter() { $registration = get_site_option('registration'); if ( $registration == 'all' || $registration == 'user' ) @@ -1384,9 +1791,18 @@ function users_can_register_signup_filter() { } add_filter('option_users_can_register', 'users_can_register_signup_filter'); +/** + * Ensure that the welcome message is not empty. Currently unused. + * + * @since MU + * + * @param string $text + * @return string + */ function welcome_user_msg_filter( $text ) { if ( !$text ) { - return __( 'Dear User, + remove_filter( 'site_option_welcome_user_email', 'welcome_user_msg_filter' ); + $text = __( 'Dear User, Your new account is set up. @@ -1398,6 +1814,7 @@ LOGINLINK Thanks! --The Team @ SITE_NAME' ); + update_site_option( 'welcome_user_email', $text ); } return $text; } @@ -1424,23 +1841,302 @@ function force_ssl_content( $force = '' ) { } /** - * Formats an String URL to use HTTPS if HTTP is found. + * Formats a URL to use https. + * * Useful as a filter. * * @since 2.8.5 - **/ + * + * @param string URL + * @return string URL with https as the scheme + */ function filter_SSL( $url ) { - if ( !is_string( $url ) ) - return get_bloginfo( 'url' ); //return home blog url with proper scheme + if ( ! is_string( $url ) ) + return get_bloginfo( 'url' ); // Return home blog url with proper scheme - $arrURL = parse_url( $url ); + if ( force_ssl_content() && is_ssl() ) + $url = set_url_scheme( $url, 'https' ); - if ( force_ssl_content() && is_ssl() ) { - if ( 'http' === $arrURL['scheme'] && 'https' !== $arrURL['scheme'] ) - $url = str_replace( $arrURL['scheme'], 'https', $url ); + return $url; +} + +/** + * Schedule update of the network-wide counts for the current network. + * + * @since 3.1.0 + */ +function wp_schedule_update_network_counts() { + if ( !is_main_site() ) + return; + + if ( !wp_next_scheduled('update_network_counts') && !defined('WP_INSTALLING') ) + wp_schedule_event(time(), 'twicedaily', 'update_network_counts'); +} + +/** + * Update the network-wide counts for the current network. + * + * @since 3.1.0 + */ +function wp_update_network_counts() { + wp_update_network_user_counts(); + wp_update_network_site_counts(); +} + +/** + * Update the count of sites for the current network. + * + * If enabled through the 'enable_live_network_counts' filter, update the sites count + * on a network when a site is created or its status is updated. + * + * @since 3.7.0 + * + * @uses wp_update_network_site_counts() + */ +function wp_maybe_update_network_site_counts() { + $is_small_network = ! wp_is_large_network( 'sites' ); + + /** + * Filter the decision to update network user and site counts in real time. + * + * @since 3.7.0 + * + * @param bool $small_network Based on wp_is_large_network( $context ). + * @param string $context Context. Either 'users' or 'sites'. + */ + if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'sites' ) ) + return; + + wp_update_network_site_counts(); +} + +/** + * Update the network-wide users count. + * + * If enabled through the 'enable_live_network_counts' filter, update the users count + * on a network when a user is created or its status is updated. + * + * @since 3.7.0 + * + * @uses wp_update_network_user_counts() + */ +function wp_maybe_update_network_user_counts() { + $is_small_network = ! wp_is_large_network( 'users' ); + + /** + * Filter the decision to update network user and site counts in real time. + * + * @since 3.7.0 + * + * @param bool $small_network Based on wp_is_large_network( $context ). + * @param string $context Context. Either 'users' or 'sites'. + */ + if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'users' ) ) + return; + + wp_update_network_user_counts(); +} + +/** + * Update the network-wide site count. + * + * @since 3.7.0 + */ +function wp_update_network_site_counts() { + global $wpdb; + + $count = $wpdb->get_var( $wpdb->prepare("SELECT COUNT(blog_id) as c FROM $wpdb->blogs WHERE site_id = %d AND spam = '0' AND deleted = '0' and archived = '0'", $wpdb->siteid) ); + update_site_option( 'blog_count', $count ); +} + +/** + * Update the network-wide user count. + * + * @since 3.7.0 + */ +function wp_update_network_user_counts() { + global $wpdb; + + $count = $wpdb->get_var( "SELECT COUNT(ID) as c FROM $wpdb->users WHERE spam = '0' AND deleted = '0'" ); + update_site_option( 'user_count', $count ); +} + +/** + * Returns the space used by the current blog. + * + * @since 3.5.0 + * + * @return int Used space in megabytes + */ +function get_space_used() { + // Allow for an alternative way of tracking storage space used + $space_used = apply_filters( 'pre_get_space_used', false ); + if ( false === $space_used ) { + $upload_dir = wp_upload_dir(); + $space_used = get_dirsize( $upload_dir['basedir'] ) / 1024 / 1024; } - return $url; + return $space_used; +} + +/** + * Returns the upload quota for the current blog. + * + * @since MU + * + * @return int Quota in megabytes + */ +function get_space_allowed() { + $space_allowed = get_option( 'blog_upload_space' ); + + if ( ! is_numeric( $space_allowed ) ) + $space_allowed = get_site_option( 'blog_upload_space' ); + + if ( empty( $space_allowed ) || ! is_numeric( $space_allowed ) ) + $space_allowed = 100; + + return apply_filters( 'get_space_allowed', $space_allowed ); } -?> +/** + * Determines if there is any upload space left in the current blog's quota. + * + * @since 3.0.0 + * + * @return int of upload space available in bytes + */ +function get_upload_space_available() { + $space_allowed = get_space_allowed() * 1024 * 1024; + if ( get_site_option( 'upload_space_check_disabled' ) ) + return $space_allowed; + + $space_used = get_space_used() * 1024 * 1024; + + if ( ( $space_allowed - $space_used ) <= 0 ) + return 0; + + return $space_allowed - $space_used; +} + +/** + * Determines if there is any upload space left in the current blog's quota. + * + * @since 3.0.0 + * @return bool True if space is available, false otherwise. + */ +function is_upload_space_available() { + if ( get_site_option( 'upload_space_check_disabled' ) ) + return true; + + return (bool) get_upload_space_available(); +} + +/** + * @since 3.0.0 + * + * @return int of upload size limit in bytes + */ +function upload_size_limit_filter( $size ) { + $fileupload_maxk = 1024 * get_site_option( 'fileupload_maxk', 1500 ); + if ( get_site_option( 'upload_space_check_disabled' ) ) + return min( $size, $fileupload_maxk ); + + return min( $size, $fileupload_maxk, get_upload_space_available() ); +} + +/** + * Whether or not we have a large network. + * + * The default criteria for a large network is either more than 10,000 users or more than 10,000 sites. + * Plugins can alter this criteria using the 'wp_is_large_network' filter. + * + * @since 3.3.0 + * @param string $using 'sites or 'users'. Default is 'sites'. + * @return bool True if the network meets the criteria for large. False otherwise. + */ +function wp_is_large_network( $using = 'sites' ) { + if ( 'users' == $using ) { + $count = get_user_count(); + return apply_filters( 'wp_is_large_network', $count > 10000, 'users', $count ); + } + + $count = get_blog_count(); + return apply_filters( 'wp_is_large_network', $count > 10000, 'sites', $count ); +} + + +/** + * Return an array of sites for a network or networks. + * + * @since 3.7.0 + * + * @param array $args { + * Array of default arguments. Optional. + * + * @type int|array $network_id A network ID or array of network IDs. Set to null to retrieve sites + * from all networks. Defaults to current network ID. + * @type int $public Retrieve public or non-public sites. Default null, for any. + * @type int $archived Retrieve archived or non-archived sites. Default null, for any. + * @type int $mature Retrieve mature or non-mature sites. Default null, for any. + * @type int $spam Retrieve spam or non-spam sites. Default null, for any. + * @type int $deleted Retrieve deleted or non-deleted sites. Default null, for any. + * @type int $limit Number of sites to limit the query to. Default 100. + * @type int $offset Exclude the first x sites. Used in combination with the $limit parameter. Default 0. + * } + * @return array An empty array if the install is considered "large" via wp_is_large_network(). Otherwise, + * an associative array of site data arrays, each containing the site (network) ID, blog ID, + * site domain and path, dates registered and modified, and the language ID. Also, boolean + * values for whether the site is public, archived, mature, spam, and/or deleted. + */ +function wp_get_sites( $args = array() ) { + global $wpdb; + + if ( wp_is_large_network() ) + return array(); + + $defaults = array( + 'network_id' => $wpdb->siteid, + 'public' => null, + 'archived' => null, + 'mature' => null, + 'spam' => null, + 'deleted' => null, + 'limit' => 100, + 'offset' => 0, + ); + + $args = wp_parse_args( $args, $defaults ); + + $query = "SELECT * FROM $wpdb->blogs WHERE 1=1 "; + + if ( isset( $args['network_id'] ) && ( is_array( $args['network_id'] ) || is_numeric( $args['network_id'] ) ) ) { + $network_ids = implode( ',', wp_parse_id_list( $args['network_id'] ) ); + $query .= "AND site_id IN ($network_ids) "; + } + + if ( isset( $args['public'] ) ) + $query .= $wpdb->prepare( "AND public = %d ", $args['public'] ); + + if ( isset( $args['archived'] ) ) + $query .= $wpdb->prepare( "AND archived = %d ", $args['archived'] ); + + if ( isset( $args['mature'] ) ) + $query .= $wpdb->prepare( "AND mature = %d ", $args['mature'] ); + + if ( isset( $args['spam'] ) ) + $query .= $wpdb->prepare( "AND spam = %d ", $args['spam'] ); + + if ( isset( $args['deleted'] ) ) + $query .= $wpdb->prepare( "AND deleted = %d ", $args['deleted'] ); + + if ( isset( $args['limit'] ) && $args['limit'] ) { + if ( isset( $args['offset'] ) && $args['offset'] ) + $query .= $wpdb->prepare( "LIMIT %d , %d ", $args['offset'], $args['limit'] ); + else + $query .= $wpdb->prepare( "LIMIT %d ", $args['limit'] ); + } + + $site_results = $wpdb->get_results( $query, ARRAY_A ); + + return $site_results; +}