Changeset 13655

Timestamp:

03/11/2010 01:51:24 AM (15 years ago)

Author:

nacin

Message:

First pass at error handling for populate_network() and network.php. see #11816

Location:

trunk/wp-admin

Files:

• includes/schema.php (modified) (2 diffs)
• network.php (modified) (13 diffs)

trunk/wp-admin/includes/schema.php

@@ -620 +620 @@
  *
  * @param int $network_id id of network to populate
+ * @return bool|WP_Error True on success, or WP_Error on warning (with the install otherwise successful,
+ *  so the error code must be checked) or failure.
  */
 function populate_network( $network_id = 1, $domain = '', $email = '', $site_name = '', $path = '/', $subdomain_install = false ) {
     global $wpdb, $current_site, $wp_db_version, $wp_rewrite;
 
-    $msg = '';
-    //@todo: turn these checks into returned messages
-    if ( $domain == '' )
-        die( 'You must provide a domain name!' );
-    if ( $site_name == '' )
-        die( 'You must provide a site name!' );
+    $errors = new WP_Error();
+    if ( '' == $domain )
+        $errors->add( 'empty_domain', __( 'You must provide a domain name.' ) );
+    if ( '' == $site_name )
+        $errors->add( 'empty_sitename', __( 'You must provide a name for your network of sites.' ) );
 
     // check for network collision
-    $existing_network = $wpdb->get_var( $wpdb->prepare( "SELECT id FROM $wpdb->site WHERE id = %d", $network_id ) );
-    if ( $existing_network == $network_id )
-        die( 'That network already exists!' );
+    if ( $network_id == $wpdb->get_var( $wpdb->prepare( "SELECT id FROM $wpdb->site WHERE id = %d", $network_id ) ) )
+        $errors->add( 'siteid_exists', __( 'The network already exists.' ) );
 
     $site_user = get_user_by_email( $email );
-    if ( !$site_user )
-        die( 'You must provide an email address!' );
+    if ( ! is_email( $email ) )
+        $errors->add( 'invalid_email', __( 'You must provide a valid e-mail address.' ) );
+
+    if ( $errors->get_error_code() )
+        return $errors;
+
     // set up site tables
     $template = get_option( 'template' );
@@ -743 +747 @@
     if ( $subdomain_install ) {
         $vhost_ok = false;
+        $errstr = '';
         $hostname = substr( md5( time() ), 0, 6 ) . '.' . $domain; // Very random hostname!
         $page = wp_remote_get( 'http://' . $hostname, array( 'timeout' => 5, 'httpversion' => '1.1' ) );
-        if ( is_wp_error( $page ) ) {
-            foreach ( $page->get_error_messages() as $err ) {
-                $errstr = $err;
-            }
-        } elseif( $page[ 'response' ][ 'code' ] == 200 ) {
+        if ( is_wp_error( $page ) )
+            $errstr = $page->get_error_message();
+        elseif ( 200 == $page['response']['code'] )
                 $vhost_ok = true;
+
+        if ( ! $vhost_ok ) {
+            $msg = '<p><strong>' . __( 'Warning! Wildcard DNS may not be configured correctly!' ) . '</strong></p>';
+            $msg .= '<p>' . sprintf( __( 'To use a subdomain configuration, you must have a wildcard entry in your DNS. The installer attempted to contact a random hostname (<code>%1$s</code>) on your domain.' ), $hostname );
+            if ( ! empty ( $errstr ) )
+                $msg .= ' ' . sprintf( __( 'This resulted in an error message: %s' ), $errstr );
+            $msg .= '</p>';
+            $msg .= '<p>' . __( 'If you want to host sites in the form of <code>http://site1.example.com</code> then you must add a wildcard record to your DNS records. This usually means adding a <code>*</code> hostname record pointing at your web server in your DNS configuration tool.' ) . '</p>';
+            $msg .= '<p>' . __( 'You can still use your site but any subdomain you create may not be accessible. If you know your DNS is correct, ignore this message.' ) . '</p>';
+            return new WP_Error( 'no_wildcard_dns', $msg );
         }
-        if ( ! $vhost_ok ) {
-            // @todo Update this to reflect the merge. Also: Multisite readme file, or remove the <blockquote> tags.
-            $msg = '<h2>' . esc_html__( 'Warning! Wildcard DNS may not be configured correctly!' ) . '</h2>';
-            $msg .= '<p>' . __( 'To use the subdomain feature of WordPress MU you must have a wildcard entry in your dns. The installer attempted to contact a random hostname ($hostname) on your domain but failed. It returned this error message:' ) . '<br />';
-            $msg .= '<br/><strong>' . $errstr . '</strong></p>';
-            $msg .= '<p>' . __( 'From the README.txt:' ) . '</p>';
-            $msg .= '<blockquote><p>' . __( "If you want to host blogs of the form http://blog.domain.tld/ where domain.tld is the domain name of your machine then you must add a wildcard record to your DNS records. This usually means adding a '*' hostname record pointing at your webserver in your DNS configuration tool.  Matt has a more detailed <a href='http://ma.tt/2003/10/10/wildcard-dns-and-sub-domains/'>explanation</a> on his blog. If you still have problems, these <a href='http://mu.wordpress.org/forums/tags/wildcard'>forum messages</a> may help." ) . '</p></blockquote>';
-            $msg .= '<p>' . __( 'You can still use your site but any subdomain you create may not be accessible. This check is not foolproof so ignore if you know your dns is correct.' ) . '</p>';
-        }
-    }
-    return $msg;
+    }
+
+    return true;
 }
 

trunk/wp-admin/network.php

@@ -63 +63 @@
 <h2><?php echo esc_html( $title ); ?></h2>
 
-<form method="post" action="network.php">
+<form method="post">
 <?php
 /**
@@ -73 +73 @@
  * @since 3.0.0
  */
-function network_step1() {
+function network_step1( $errors = false ) {
 
     $active_plugins = get_option( 'active_plugins' );
@@ -96 +96 @@
     }
 
+    wp_nonce_field( 'install-network-1' );
+
+    $error_codes = array();
+    if ( is_wp_error( $errors ) ) {
+        echo '<div class="error"><p><strong>' . __( 'ERROR: The network could not be created.' ) . '</strong></p>';
+        foreach ( $errors->get_error_messages() as $error )
+            echo "<p>$error</p>";
+        echo '</div>';
+        $error_codes = $errors->get_error_codes();
+    }
+
+    $site_name = ( ! empty( $_POST['sitename'] ) && ! in_array( 'empty_sitename', $error_codes ) ) ? $_POST['sitename'] : sprintf( _x('%s Sites', 'Default network name' ), get_option( 'blogname' ) );
+    $admin_email = ( ! empty( $_POST['email'] ) && ! in_array( 'invalid_email', $error_codes ) ) ? $_POST['email'] : get_option( 'admin_email' );
     ?>
     <p><?php _e( 'Welcome to the Network installation process!' ); ?></p>
@@ -102 +115 @@
 
     // @todo IIS...
-    if ( apache_mod_loaded('mod_rewrite') ) { // assume nothing
-        $rewrite_enabled = true;
+    if ( ! empty( $_POST['subdomain_install'] ) ) {
+        $subdomain_install = (bool) $_POST['subdomain_install'];
+    } elseif ( apache_mod_loaded('mod_rewrite') ) { // assume nothing
+        $subdomain_install = true;
     } else {
-        $rewrite_enabled = false;
+        $subdomain_install = false;
         if ( got_mod_rewrite() ) // dangerous assumptions
             echo '<p>' . __( 'Please make sure the Apache <code>mod_rewrite</code> module is installed as it will be used at the end of this install.' ) . '</p>';
@@ -113 +128 @@
     }
 
-    wp_nonce_field( 'install-network-1' );
-
     if ( 'localhost' != $hostname ) : ?>
         <h3><?php esc_html_e( 'Addresses of Sites in your Network' ); ?></h3>
@@ -120 +133 @@
         <p><?php _e( "You will need a wildcard DNS record if you're going to use the virtual host (sub-domain) functionality." ); ?></p>
         <?php /* @todo: Link to an MS readme? */ ?>
-        <?php if ( ! $rewrite_enabled ) { ?>
+        <?php if ( ! $subdomain_install ) { ?>
         <p><?php _e( '<strong>Note</strong> It looks like <code>mod_rewrite</code> is not installed.' ); ?></p>
         <?php } ?>
         <table class="form-table">
             <tr>
-                <th><label><input type='radio' name='subdomain_install' value='1'<?php checked( $rewrite_enabled ); ?> /> Sub-domains</label></th>
+                <th><label><input type='radio' name='subdomain_install' value='1'<?php checked( $subdomain_install ); ?> /> Sub-domains</label></th>
                 <td><?php _e('like <code>site1.example.com</code> and <code>site2.example.com</code>'); ?></td>
             </tr>
             <tr>
-                <th><label><input type='radio' name='subdomain_install' value='0'<?php checked( ! $rewrite_enabled ); ?> /> Sub-directories</label></th>
+                <th><label><input type='radio' name='subdomain_install' value='0'<?php checked( ! $subdomain_install ); ?> /> Sub-directories</label></th>
                 <td><?php _e('like <code>example.com/site1</code> and <code>example.com/site2</code>'); ?></td>
             </tr>
@@ -137 +150 @@
     endif;
 
-        $is_www = ( substr( $hostname, 0, 4 ) == 'www.' );
+        $is_www = ( 0 === strpos( $hostname, 'www.' ) );
         if ( $is_www ) :
         ?>
@@ -147 +160 @@
                 <td>
                     <?php printf( __( 'The Internet address of your network will be <code>%s</code>.' ), $hostname ); ?>
-                    <input type='hidden' name='basedomain' value='<?php echo esc_attr( $hostname ); ?>' />
                 </td>
             </tr>
@@ -172 +184 @@
                 <th scope='row'><?php esc_html_e( 'Network Title' ); ?></th>
                 <td>
-                    <input name='weblog_title' type='text' size='45' value='<?php echo esc_attr( sprintf( __('%s Sites'), get_option( 'blogname' ) ) ); ?>' />
+                    <input name='sitename' type='text' size='45' value='<?php echo esc_attr( $site_name ); ?>' />
                     <br /><?php _e( 'What would you like to call your network?' ); ?>
                 </td>
@@ -179 +191 @@
                 <th scope='row'><?php esc_html_e( 'Admin E-mail Address' ); ?></th>
                 <td>
-                    <input name='email' type='text' size='45' value='<?php echo esc_attr( get_option( 'admin_email' ) ); ?>' />
+                    <input name='email' type='text' size='45' value='<?php echo esc_attr( $admin_email ); ?>' />
                     <br /><?php _e( 'Your email address.' ); ?>
                 </td>
@@ -193 +205 @@
  * @since 3.0.0
  */
-function network_step2() {
+function network_step2( $errors = false ) {
     global $base, $wpdb;
     $hostname = get_clean_basedomain();
+
+    // Wildcard DNS message.
+    if ( is_wp_error( $errors ) )
+        echo '<div class="error">' . $errors->get_error_message() . '</div>';
+
     if ( $_POST ) {
         $vhost = 'localhost' == $hostname ? false : (bool) $_POST['subdomain_install'];
@@ -264 +281 @@
 <?php
 
-    // remove ending slash from $base and $url
-    $htaccess = '';
-    $base = rtrim( $base, '/' );
-
-    $htaccess_file = 'RewriteEngine On
-RewriteBase ' . $base . '/
-
-#uploaded files
+// @todo custom content dir
+$htaccess_file = 'RewriteEngine On
+RewriteBase ' . $base . '
+
+# uploaded files
 RewriteRule ^(.*/)?files/$ index.php [L]
 RewriteCond %{REQUEST_URI} !.*wp-content/plugins.*
@@ -308 +322 @@
     $hostname = get_clean_basedomain();
     $subdomain_install = 'localhost' == $hostname ? false : (bool) $_POST['subdomain_install'];
-    if ( ! network_domain_check() )
-        populate_network( 1, get_clean_basedomain(), sanitize_email( $_POST['email'] ), $_POST['weblog_title'], $base, $subdomain_install );
-    // create wp-config.php / htaccess
-    network_step2();
+    if ( ! network_domain_check() ) {
+        $result = populate_network( 1, get_clean_basedomain(), sanitize_email( $_POST['email'] ), $_POST['sitename'], $base, $subdomain_install );
+        if ( is_wp_error( $result ) ) {
+            if ( 1 == count( $result->get_error_codes() ) && 'no_wildcard_dns' == $result->get_error_code() )
+                network_step2( $result );
+            else
+                network_step1( $result );
+        } else {
+            network_step2();
+        }
+    } else {
+        network_step2();
+    }
 } elseif ( is_multisite() || network_domain_check() ) {
     network_step2();