Changeset 34828

Timestamp:

10/05/2015 03:05:26 PM (9 years ago)

Author:

boonebgorges

Message:

Use wp_installing() instead of WP_INSTALLING constant.

The WP_INSTALLING constant is a flag that WordPress sets in a number of
places, telling the system that options should be fetched directly from the
database instead of from the cache, that WP should not ping wordpress.org for
updates, that the normal "not installed" checks should be bypassed, and so on.

A constant is generally necessary for this purpose, because the flag is
typically set before the WP bootstrap, meaning that WP functions are not yet
available. However, it is possible - notably, during wpmu_create_blog() -
for the "installing" flag to be set after WP has already loaded. In these
cases, WP_INSTALLING would be set for the remainder of the process, since
there's no way to change a constant once it's defined. This, in turn, polluted
later function calls that ought to have been outside the scope of site
creation, particularly the non-caching of option data. The problem was
particularly evident in the case of the automated tests, where WP_INSTALLING
was set the first time a site was created, and remained set for the rest of the
suite.

The new wp_installing() function allows developers to fetch the current
installation status (when called without any arguments) or to set the
installation status (when called with a boolean true or false). Use of
the WP_INSTALLING constant is still supported; wp_installing() will default
to true if the constant is defined during the bootstrap.

Props boonebgorges, jeremyfelt.
See #31130.

Location:

trunk

Files:

• src/wp-admin/admin.php (modified) (1 diff)
• src/wp-admin/includes/class-wp-upgrader.php (modified) (1 diff)
• src/wp-admin/includes/file.php (modified) (1 diff)
• src/wp-admin/includes/misc.php (modified) (1 diff)
• src/wp-admin/includes/translation-install.php (modified) (1 diff)
• src/wp-includes/functions.php (modified) (3 diffs)
• src/wp-includes/l10n.php (modified) (2 diffs)
• src/wp-includes/load.php (modified) (3 diffs)
• src/wp-includes/ms-functions.php (modified) (2 diffs)
• src/wp-includes/ms-settings.php (modified) (1 diff)
• src/wp-includes/option.php (modified) (8 diffs)
• src/wp-includes/script-loader.php (modified) (1 diff)
• src/wp-includes/theme.php (modified) (1 diff)
• src/wp-includes/update.php (modified) (4 diffs)
• src/wp-settings.php (modified) (1 diff)
• tests/phpunit/includes/factory.php (modified) (1 diff)
• tests/phpunit/includes/testcase.php (modified) (3 diffs)
• tests/phpunit/tests/comment/getPageOfComment.php (modified) (1 diff)
• tests/phpunit/tests/general/archives.php (modified) (1 diff)
• tests/phpunit/tests/option/transient.php (modified) (3 diffs)
• tests/phpunit/tests/option/updateOption.php (modified) (7 diffs)
• tests/phpunit/tests/post/getPostClass.php (modified) (1 diff)
• tests/phpunit/tests/term/getTerms.php (modified) (2 diffs)
• tests/phpunit/tests/term/wpInsertTerm.php (modified) (2 diffs)
• tests/phpunit/tests/user/capabilities.php (modified) (2 diffs)

trunk/src/wp-admin/admin.php

@@ -85 +85 @@
 
 // Schedule trash collection
-if ( !wp_next_scheduled('wp_scheduled_delete') && !defined('WP_INSTALLING') )
+if ( ! wp_next_scheduled( 'wp_scheduled_delete' ) && ! wp_installing() )
     wp_schedule_event(time(), 'daily', 'wp_scheduled_delete');
 

trunk/src/wp-admin/includes/class-wp-upgrader.php

@@ -2605 +2605 @@
             return true;
 
-        if ( defined( 'WP_INSTALLING' ) )
+        if ( wp_installing() )
             return true;
 

trunk/src/wp-admin/includes/file.php

@@ -1082 +1082 @@
 
         unset($stored_credentials['password'], $stored_credentials['port'], $stored_credentials['private_key'], $stored_credentials['public_key']);
-        if ( ! defined( 'WP_INSTALLING' ) ) {
+        if ( ! wp_installing() ) {
             update_option( 'ftp_credentials', $stored_credentials );
         }

trunk/src/wp-admin/includes/misc.php

@@ -262 +262 @@
  */
 function update_home_siteurl( $old_value, $value ) {
-    if ( defined( "WP_INSTALLING" ) )
+    if ( wp_installing() )
         return;
 

trunk/src/wp-admin/includes/translation-install.php

@@ -95 +95 @@
  */
 function wp_get_available_translations() {
-    if ( ! defined( 'WP_INSTALLING' ) && false !== ( $translations = get_site_transient( 'available_translations' ) ) ) {
+    if ( ! wp_installing() && false !== ( $translations = get_site_transient( 'available_translations' ) ) ) {
         return $translations;
     }

trunk/src/wp-includes/functions.php

@@ -1261 +1261 @@
 
 /**
+ * Check or set whether WordPress is in "installation" mode.
+ *
+ * If the `WP_INSTALLING` constant is defined during the bootstrap, `wp_installing()` will default to `true`.
+ *
+ * @since 4.4.0
+ *
+ * @staticvar bool $installing
+ *
+ * @param bool $is_installing Optional. True to set WP into Installing mode, false to turn Installing mode off.
+ *                            Omit this parameter if you only want to fetch the current status.
+ * @return bool True if WP is installing, otherwise false. When a `$is_installing` is passed, the function will
+ *              report whether WP was in installing mode prior to the change to `$is_installing`.
+ */
+function wp_installing( $is_installing = null ) {
+    static $installing = null;
+
+    // Support for the `WP_INSTALLING` constant, defined before WP is loaded.
+    if ( is_null( $installing ) ) {
+        $installing = defined( 'WP_INSTALLING' ) && WP_INSTALLING;
+    }
+
+    if ( ! is_null( $is_installing ) ) {
+        $old_installing = $installing;
+        $installing = $is_installing;
+        return (bool) $old_installing;
+    }
+
+    return (bool) $installing;
+}
+
+/**
  * Test whether blog is already installed.
  *
@@ -1286 +1317 @@
 
     $suppress = $wpdb->suppress_errors();
-    if ( ! defined( 'WP_INSTALLING' ) ) {
+    if ( ! wp_installing() ) {
         $alloptions = wp_load_alloptions();
     }
@@ -3338 +3369 @@
 
     // If installing or in the admin, provide the verbose message.
-    if ( defined('WP_INSTALLING') || defined('WP_ADMIN') )
+    if ( wp_installing() || defined( 'WP_ADMIN' ) )
         wp_die($wpdb->error);
 

trunk/src/wp-includes/l10n.php

@@ -54 +54 @@
     if ( is_multisite() ) {
         // Don't check blog option when installing.
-        if ( defined( 'WP_INSTALLING' ) || ( false === $ms_locale = get_option( 'WPLANG' ) ) ) {
+        if ( wp_installing() || ( false === $ms_locale = get_option( 'WPLANG' ) ) ) {
             $ms_locale = get_network_option( 'WPLANG' );
         }
@@ -636 +636 @@
     }
 
-    if ( is_admin() || defined( 'WP_INSTALLING' ) || ( defined( 'WP_REPAIRING' ) && WP_REPAIRING ) ) {
+    if ( is_admin() || wp_installing() || ( defined( 'WP_REPAIRING' ) && WP_REPAIRING ) ) {
         load_textdomain( 'default', WP_LANG_DIR . "/admin-$locale.mo" );
     }

trunk/src/wp-includes/load.php

@@ -166 +166 @@
  */
 function wp_maintenance() {
-    if ( !file_exists( ABSPATH . '.maintenance' ) || defined( 'WP_INSTALLING' ) )
+    if ( ! file_exists( ABSPATH . '.maintenance' ) || wp_installing() )
         return;
 
@@ -476 +476 @@
 function wp_not_installed() {
     if ( is_multisite() ) {
-        if ( ! is_blog_installed() && ! defined( 'WP_INSTALLING' ) ) {
+        if ( ! is_blog_installed() && ! wp_installing() ) {
             nocache_headers();
 
             wp_die( __( 'The site you have requested is not installed properly. Please contact the system administrator.' ) );
         }
-    } elseif ( ! is_blog_installed() && ! defined( 'WP_INSTALLING' ) ) {
+    } elseif ( ! is_blog_installed() && ! wp_installing() ) {
         nocache_headers();
 
@@ -540 +540 @@
     $plugins = array();
     $active_plugins = (array) get_option( 'active_plugins', array() );
-    if ( empty( $active_plugins ) || defined( 'WP_INSTALLING' ) )
+    if ( empty( $active_plugins ) || wp_installing() )
         return $plugins;
 

trunk/src/wp-includes/ms-functions.php

@@ -1117 +1117 @@
         return new WP_Error( 'blog_taken', __( 'Sorry, that site already exists!' ) );
 
-    if ( !defined('WP_INSTALLING') )
-        define( 'WP_INSTALLING', true );
+    if ( ! wp_installing() ) {
+        wp_installing( true );
+    }
 
     if ( ! $blog_id = insert_blog($domain, $path, $site_id) )
@@ -2173 +2174 @@
         return;
 
-    if ( !wp_next_scheduled('update_network_counts') && !defined('WP_INSTALLING') )
+    if ( ! wp_next_scheduled('update_network_counts') && ! wp_installing() )
         wp_schedule_event(time(), 'twicedaily', 'update_network_counts');
 }

trunk/src/wp-includes/ms-settings.php

@@ -137 +137 @@
 
     // @todo Investigate when exactly this can occur.
-    if ( empty( $current_blog ) && defined( 'WP_INSTALLING' ) ) {
+    if ( empty( $current_blog ) && wp_installing() ) {
         $current_blog = new stdClass;
         $current_blog->blog_id = $blog_id = 1;

trunk/src/wp-includes/option.php

@@ -54 +54 @@
         return false;
 
-    if ( ! defined( 'WP_INSTALLING' ) ) {
+    if ( ! wp_installing() ) {
         // prevent non-existent options from triggering multiple queries
         $notoptions = wp_cache_get( 'notoptions', 'options' );
@@ -172 +172 @@
     global $wpdb;
 
-    if ( !defined( 'WP_INSTALLING' ) || !is_multisite() )
+    if ( ! wp_installing() || ! is_multisite() )
         $alloptions = wp_cache_get( 'alloptions', 'options' );
     else
@@ -186 +186 @@
             $alloptions[$o->option_name] = $o->option_value;
         }
-        if ( !defined( 'WP_INSTALLING' ) || !is_multisite() )
+        if ( ! wp_installing() || ! is_multisite() )
             wp_cache_add( 'alloptions', $alloptions, 'options' );
     }
@@ -205 +205 @@
     global $wpdb;
 
-    if ( !is_multisite() || wp_using_ext_object_cache() || defined( 'WP_INSTALLING' ) )
+    if ( ! is_multisite() || wp_using_ext_object_cache() || wp_installing() )
         return;
 
@@ -333 +333 @@
     }
 
-    if ( ! defined( 'WP_INSTALLING' ) ) {
+    if ( ! wp_installing() ) {
         $alloptions = wp_load_alloptions();
         if ( isset( $alloptions[$option] ) ) {
@@ -434 +434 @@
         return false;
 
-    if ( ! defined( 'WP_INSTALLING' ) ) {
+    if ( ! wp_installing() ) {
         if ( 'yes' == $autoload ) {
             $alloptions = wp_load_alloptions();
@@ -510 +510 @@
 
     $result = $wpdb->delete( $wpdb->options, array( 'option_name' => $option ) );
-    if ( ! defined( 'WP_INSTALLING' ) ) {
+    if ( ! wp_installing() ) {
         if ( 'yes' == $row->autoload ) {
             $alloptions = wp_load_alloptions();
@@ -630 +630 @@
     } else {
         $transient_option = '_transient_' . $transient;
-        if ( ! defined( 'WP_INSTALLING' ) ) {
+        if ( ! wp_installing() ) {
             // If option is not in alloptions, it is not autoloaded and thus has a timeout
             $alloptions = wp_load_alloptions();

trunk/src/wp-includes/script-loader.php

@@ -830 +830 @@
     global $_wp_admin_css_colors;
 
-    if ( defined('WP_INSTALLING') )
+    if ( wp_installing() )
         return preg_replace( '#^wp-admin/#', './', $src );
 

trunk/src/wp-includes/theme.php

@@ -772 +772 @@
      * @param bool true Validation flag to check the current theme.
      */
-    if ( defined('WP_INSTALLING') || ! apply_filters( 'validate_current_theme', true ) )
+    if ( wp_installing() || ! apply_filters( 'validate_current_theme', true ) )
         return true;
 

trunk/src/wp-includes/update.php

@@ -23 +23 @@
  */
 function wp_version_check( $extra_stats = array(), $force_check = false ) {
-    if ( defined( 'WP_INSTALLING' ) ) {
+    if ( wp_installing() ) {
         return;
     }
@@ -188 +188 @@
  */
 function wp_update_plugins( $extra_stats = array() ) {
-    if ( defined( 'WP_INSTALLING' ) ) {
+    if ( wp_installing() ) {
         return;
     }
@@ -345 +345 @@
  */
 function wp_update_themes( $extra_stats = array() ) {
-    if ( defined( 'WP_INSTALLING' ) ) {
+    if ( wp_installing() ) {
         return;
     }
@@ -637 +637 @@
  */
 function wp_schedule_update_checks() {
-    if ( !wp_next_scheduled('wp_version_check') && !defined('WP_INSTALLING') )
+    if ( ! wp_next_scheduled( 'wp_version_check' ) && ! wp_installing() )
         wp_schedule_event(time(), 'twicedaily', 'wp_version_check');
 
-    if ( !wp_next_scheduled('wp_update_plugins') && !defined('WP_INSTALLING') )
+    if ( ! wp_next_scheduled( 'wp_update_plugins' ) && ! wp_installing() )
         wp_schedule_event(time(), 'twicedaily', 'wp_update_plugins');
 
-    if ( !wp_next_scheduled('wp_update_themes') && !defined('WP_INSTALLING') )
+    if ( ! wp_next_scheduled( 'wp_update_themes' ) && ! wp_installing() )
         wp_schedule_event(time(), 'twicedaily', 'wp_update_themes');
 
-    if ( ! wp_next_scheduled( 'wp_maybe_auto_update' ) && ! defined( 'WP_INSTALLING' ) ) {
+    if ( ! wp_next_scheduled( 'wp_maybe_auto_update' ) && ! wp_installing() ) {
         // Schedule auto updates for 7 a.m. and 7 p.m. in the timezone of the site.
         $next = strtotime( 'today 7am' );

trunk/src/wp-settings.php

@@ -322 +322 @@
 
 // Load the functions for the active theme, for both parent and child theme if applicable.
-if ( ! defined( 'WP_INSTALLING' ) || 'wp-activate.php' === $pagenow ) {
+if ( ! wp_installing() || 'wp-activate.php' === $pagenow ) {
     if ( TEMPLATEPATH !== STYLESHEETPATH && file_exists( STYLESHEETPATH . '/functions.php' ) )
         include( STYLESHEETPATH . '/functions.php' );

trunk/tests/phpunit/includes/factory.php

@@ -174 +174 @@
         $blog = wpmu_create_blog( $args['domain'], $args['path'], $args['title'], $user_id, $meta, $args['site_id'] );
         $wpdb->suppress_errors( $suppress );
+
+        // Tell WP we're done installing.
+        wp_installing( false );
+
         return $blog;
     }

trunk/tests/phpunit/includes/testcase.php

@@ -14 +14 @@
     protected static $hooks_saved = array();
     protected static $ignore_files;
-
-    protected $db_version;
 
     /**
@@ -59 +57 @@
 
         add_filter( 'wp_mail', array( $this, 'set_wp_mail_globals' ) );
-
-        /*
-         * During multisite tests, WP_INSTALLING forces `get_option()` to miss the cache, which causes problems
-         * with our query-counting cache tests. As a workaround in the case of tests that require checking
-         * 'db_version' (such as any test that uses the Term Meta API), we filter 'pre_option_db_version' and
-         * avoid hitting the database.
-         *
-         * See #31130.
-         */
-        $this->db_version = get_option( 'db_version' );
-        if ( is_multisite() ) {
-            add_filter( 'pre_option_db_version', array( $this, 'db_version' ) );
-        }
     }
 
@@ -636 +621 @@
 
     /**
-     * Return the current database version without hitting the database.
-     *
-     * This is used to bypass cache problems with some multisite tests. See #31130.
-     *
-     * @todo Don't do this anymore once #31130 is fixed.
-     *
-     * @since 4.4.0
-     */
-    public function db_version() {
-        return $this->db_version;
-    }
-
-    /**
      * Utility method that resets permalinks and flushes rewrites.
      *

trunk/tests/phpunit/tests/comment/getPageOfComment.php

@@ -61 +61 @@
      */
     public function test_subsequent_calls_should_hit_cache() {
-        // `get_page_of_comment()` calls `get_option()`, which is not properly cached when WP_INSTALLING.
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
         global $wpdb;
 

trunk/tests/phpunit/tests/general/archives.php

@@ -16 +16 @@
     function test_get_archives_cache() {
         global $wpdb;
-
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
 
         $this->factory->post->create_many( 15, array( 'post_type' => 'post' ) );

trunk/tests/phpunit/tests/option/transient.php

@@ -47 +47 @@
      */
     function test_transient_data_with_timeout() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING.' );
-        }
-
         $key = rand_str();
         $value = rand_str();
@@ -72 +68 @@
      */
     function test_transient_add_timeout() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING.' );
-        }
-
         $key = rand_str();
         $value = rand_str();
@@ -127 +119 @@
      */
     function test_nonexistent_key_old_timeout() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING.' );
-        }
-
         // Create a transient
         $key = 'test_transient';

trunk/tests/phpunit/tests/option/updateOption.php

@@ -21 +21 @@
      */
     public function test_should_set_autoload_yes_for_nonexistent_option_when_autoload_param_is_missing() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
         global $wpdb;
         $this->flush_cache();
@@ -45 +41 @@
      */
     public function test_should_set_autoload_yes_for_nonexistent_option_when_autoload_param_is_yes() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
         global $wpdb;
         $this->flush_cache();
@@ -69 +61 @@
      */
     public function test_should_set_autoload_no_for_nonexistent_option_when_autoload_param_is_no() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
         global $wpdb;
         $this->flush_cache();
@@ -94 +82 @@
      */
     public function test_should_set_autoload_no_for_nonexistent_option_when_autoload_param_is_false() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
         global $wpdb;
         $this->flush_cache();
@@ -119 +103 @@
      */
     public function test_autoload_should_be_updated_for_existing_option_when_value_is_changed() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
         global $wpdb;
         add_option( 'foo', 'bar', '', 'no' );
@@ -144 +124 @@
      */
     public function test_autoload_should_not_be_updated_for_existing_option_when_value_is_unchanged() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
         global $wpdb;
         add_option( 'foo', 'bar', '', 'yes' );
@@ -170 +146 @@
      */
     public function test_autoload_should_not_be_updated_for_existing_option_when_value_is_changed_but_no_value_of_autoload_is_provided() {
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
         global $wpdb;
         add_option( 'foo', 'bar', '', 'yes' );

trunk/tests/phpunit/tests/post/getPostClass.php

@@ -109 +109 @@
         global $wpdb;
 
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
         register_taxonomy( 'wptests_tax', 'post' );
         wp_set_post_terms( $this->post_id, array( 'foo', 'bar' ), 'wptests_tax' );

trunk/tests/phpunit/tests/term/getTerms.php

@@ -382 +382 @@
     public function test_child_of_should_skip_query_when_specified_parent_is_not_found_in_hierarchy_cache() {
         global $wpdb;
-
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
 
         register_taxonomy( 'wptests_tax', 'post', array( 'hierarchical' => true, ) );
@@ -1328 +1324 @@
         global $wpdb;
 
-        if ( is_multisite() ) {
-            $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
-        }
-
         register_taxonomy( 'wptests_tax', 'post', array( 'hierarchical' => true, ) );
 

trunk/tests/phpunit/tests/term/wpInsertTerm.php

@@ -469 +469 @@
      */
     public function test_wp_insert_term_duplicate_slug_different_taxonomy_before_410_schema_change() {
-
-        // See #31130.
         $old_db_version = 30055;
-        if ( is_multisite() ) {
-            $_db_version = $this->db_version;
-            $this->db_version = $old_db_version;
-        } else {
-            update_option( 'db_version', $old_db_version );
-        }
+        update_option( 'db_version', $old_db_version );
 
         register_taxonomy( 'wptests_tax', 'post' );
@@ -503 +496 @@
         $this->assertSame( 'foo-2', $new_term->slug );
         $this->assertNotEquals( $new_term->term_id, $term->term_id );
-
-        if ( is_multisite() ) {
-            $this->db_version = $_db_version;
-        }
 
         _unregister_taxonomy( 'wptests_tax', 'post' );

trunk/tests/phpunit/tests/user/capabilities.php

@@ -874 +874 @@
 
     function test_current_user_can_for_blog() {
+        global $wpdb;
+
         $user = new WP_User( $this->factory->user->create( array( 'role' => 'administrator' ) ) );
         $old_uid = get_current_user_id();
@@ -885 +887 @@
         }
 
+        $suppress = $wpdb->suppress_errors();
         $this->assertFalse( current_user_can_for_blog( 12345, 'edit_posts' ) );
+        $wpdb->suppress_errors( $suppress );
 
         $blog_id = $this->factory->blog->create( array( 'user_id' => $user->ID ) );