Changeset 14452

Timestamp:

05/04/2010 08:48:28 PM (15 years ago)

Author:

nacin

Message:

Deprecate VHOST in favor of a boolean, SUBDOMAIN_INSTALL. Core will keep VHOST defined for plugins' sake, but you should only define SUBDOMAIN_INSTALL. Throws a notice if VHOST is defined, and a warning if they somehow conflict. Sunrise can still handle them. fixes #11796.

Location:

trunk

Files:

• wp-admin/network.php (modified) (6 diffs)
• wp-includes/ms-default-constants.php (modified) (1 diff)
• wp-includes/ms-load.php (modified) (1 diff)
• wp-includes/ms-settings.php (modified) (1 diff)
• wp-includes/wp-db.php (modified) (1 diff)

trunk/wp-admin/network.php

@@ -41 +41 @@
  *
  * @since 3.0.0
- * @return bool - whether subdomain install is allowed
+ * @return bool Whether subdomain install is allowed
  */
 function allow_subdomain_install() {
@@ -238 +238 @@
 
     if ( $_POST ) {
-        $vhost = !allow_subdomain_install() ? false : (bool) $_POST['subdomain_install'];
+        $subdomain_install = allow_subdomain_install() ? ! empty( $_POST['subdomain_install'] ) : false;
     } else {
         if ( is_multisite() ) {
-            $vhost = is_subdomain_install();
+            $subdomain_install = is_subdomain_install();
 ?>
     <div class="updated"><p><strong><?php _e( 'Notice: The Network feature is already enabled.' ); ?></strong> <?php _e( 'The original configuration steps are shown here for reference.' ); ?></p></div>
 <?php   } else {
-            $vhost = (bool) $wpdb->get_var( "SELECT meta_value FROM $wpdb->sitemeta WHERE site_id = 1 AND meta_key = 'subdomain_install'" );
+            $subdomain_install = (bool) $wpdb->get_var( "SELECT meta_value FROM $wpdb->sitemeta WHERE site_id = 1 AND meta_key = 'subdomain_install'" );
 ?>
     <div class="error"><p><strong><?php _e('Warning:'); ?></strong> <?php _e( 'An existing WordPress network was detected.' ); ?></p></div>
@@ -266 +266 @@
                 <textarea class="code" readonly="readonly" cols="100" rows="7">
 define( 'MULTISITE', true );
-define( 'VHOST', '<?php echo $vhost ? 'yes' : 'no'; ?>' );
+define( 'SUBDOMAIN_INSTALL', <?php echo $subdomain_install ? 'true' : 'false'; ?> );
 $base = '<?php echo $base; ?>';
 define( 'DOMAIN_CURRENT_SITE', '<?php echo $hostname; ?>' );
@@ -310 +310 @@
 
 # uploaded files
-RewriteRule ^' . ( $vhost ? '' : '([_0-9a-zA-Z-]+/)?' ) . 'files/(.+) wp-includes/ms-files.php?file=$' . ( $vhost ? 1 : 2 ) . ' [L]' . "\n";
-
-if ( ! $vhost )
+RewriteRule ^' . ( $subdomain_install ? '' : '([_0-9a-zA-Z-]+/)?' ) . 'files/(.+) wp-includes/ms-files.php?file=$' . ( $subdomain_install ? 1 : 2 ) . ' [L]' . "\n";
+
+if ( ! $subdomain_install )
     $htaccess_file .= "\n# add a trailing slash to /wp-admin\n" . 'RewriteRule ^([_0-9a-zA-Z-]+/)?wp-admin$ $1wp-admin/ [R=301,L]' . "\n";
 
@@ -320 +320 @@
 
 // @todo custom content dir.
-if ( ! $vhost )
+if ( ! $subdomain_install )
     $htaccess_file .= "\n" . 'RewriteRule  ^([_0-9a-zA-Z-]+/)?(wp-(content|admin|includes).*) $2 [L]
 RewriteRule  ^([_0-9a-zA-Z-]+/)?(.*\.php)$ $2 [L]';
@@ -328 +328 @@
 ?>
             <li><p><?php printf( __( 'Add the following to your <code>.htaccess</code> file in <code>%s</code>, replacing other WordPress rules:' ), ABSPATH ); ?></p>
-                <textarea class="code" readonly="readonly" cols="100" rows="<?php echo $vhost ? 11 : 16; ?>">
+                <textarea class="code" readonly="readonly" cols="100" rows="<?php echo $subdomain_install ? 11 : 16; ?>">
 <?php echo wp_htmledit_pre( $htaccess_file ); ?>
 </textarea></li>

trunk/wp-includes/ms-default-constants.php

@@ -92 +92 @@
         define( 'WPMU_ACCEL_REDIRECT', false );
 }
+
+/**
+ * Defines Multisite subdomain constants and handles warnings and notices.
+ *
+ * VHOST is deprecated in favor of SUBDOMAIN_INSTALL, which is a bool.
+ *
+ * On first call, the constants are checked and defined. On second call,
+ * we will have translations loaded and can trigger warnings easily.
+ *
+ * @since 3.0.0
+ */
+function ms_subdomain_constants() {
+    static $error = null;
+    static $error_warn = false;
+    
+    if ( false === $error )
+        return;
+
+    if ( $error ) {
+        $vhost_deprecated = __( 'The constant <code>VHOST</code> <strong>is deprecated</strong>. Use the boolean constant <code>SUBDOMAIN_INSTALL</code> in wp-config.php to enable a subdomain configuration. Use is_subdomain_install() to check whether a subdomain configuration is enabled.' );
+        if ( $error_warn ) {
+            trigger_error( __( '<strong>Conflicting values for the constants VHOST and SUBDOMAIN_INSTALL.</strong> The value of SUBDOMAIN_INSTALL will be assumed to be your subdomain configuration setting.' ) . ' ' . $vhost_deprecated, E_USER_WARNING );
+        } else {
+            _deprecated_argument( 'define()', '3.0', $vhost_deprecated );
+        }
+        return;
+    }
+
+    if ( defined( 'SUBDOMAIN_INSTALL' ) && defined( 'VHOST' ) ) {
+        if ( SUBDOMAIN_INSTALL == ( 'yes' == VHOST ) ) {
+            $error = true;
+        } else {
+            $error = $error_warn = true;
+        }
+    } elseif ( defined( 'SUBDOMAIN_INSTALL' ) ) {
+        define( 'VHOST', SUBDOMAIN_INSTALL ? 'yes' : 'no' );
+    } elseif ( defined( 'VHOST' ) ) {
+        $error = true;
+        define( 'SUBDOMAIN_INSTALL', 'yes' == VHOST );
+    } else {    
+        define( 'SUBDOMAIN_INSTALL', false );
+        define( 'VHOST', 'no' );
+    }
+}
+add_action( 'init', 'ms_subdomain_constants' );
+
 ?>

trunk/wp-includes/ms-load.php

@@ -17 +17 @@
  */
 function is_subdomain_install() {
+    if ( defined('SUBDOMAIN_INSTALL') )
+        return SUBDOMAIN_INSTALL;
+
     if ( defined('VHOST') && VHOST == 'yes' )
         return true;

trunk/wp-includes/ms-settings.php

@@ -21 +21 @@
 if ( defined( 'SUNRISE' ) )
     include_once( WP_CONTENT_DIR . '/sunrise.php' );
+
+/** Check for and define SUBDOMAIN_INSTALL and the deprecated VHOST constant. */
+ms_subdomain_constants();
 
 if ( !isset( $current_site ) || !isset( $current_blog ) ) {

trunk/wp-includes/wp-db.php

@@ -576 +576 @@
                 $this->$table = $prefixed_table;
 
-            if ( defined( 'VHOST' ) && empty( $this->blogid ) )
+            if ( is_multisite() && empty( $this->blogid ) )
                 return $old_prefix;