Changeset 33057

Timestamp:

07/03/2015 04:33:14 AM (9 years ago)

Author:

dd32

Message:

Introduce wp_should_upgrade_global_tables() to determine if global tables should be upgraded automatically. Use it throughout the existing upgrade routines.

Props johnjamesjacoby for initial patch
Fixes #32154 for trunk

File:

• trunk/src/wp-admin/includes/upgrade.php (modified) (10 diffs)

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

@@ -1253 +1253 @@
 
     // 3.0 screen options key name changes.
-    if ( is_main_site() && !defined('DO_NOT_UPGRADE_GLOBAL_TABLES') ) {
+    if ( wp_should_upgrade_global_tables() ) {
         $sql = "DELETE FROM $wpdb->usermeta
             WHERE meta_key LIKE %s
@@ -1293 +1293 @@
     global $wp_current_db_version, $wpdb, $wp_registered_widgets, $sidebars_widgets;
 
-    if ( $wp_current_db_version < 19061 && is_main_site() && ! defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
+    if ( $wp_current_db_version < 19061 && wp_should_upgrade_global_tables() ) {
         $wpdb->query( "DELETE FROM $wpdb->usermeta WHERE meta_key IN ('show_admin_bar_admin', 'plugins_last_view')" );
     }
@@ -1377 +1377 @@
     }
 
-    if ( $wp_current_db_version < 20022 && is_main_site() && ! defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
+    if ( $wp_current_db_version < 20022 && wp_should_upgrade_global_tables() ) {
         $wpdb->query( "DELETE FROM $wpdb->usermeta WHERE meta_key = 'themes_last_view'" );
     }
@@ -1404 +1404 @@
         update_option( 'link_manager_enabled', 1 ); // Previously set to 0 by populate_options()
 
-    if ( $wp_current_db_version < 21811 && is_main_site() && ! defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
+    if ( $wp_current_db_version < 21811 && wp_should_upgrade_global_tables() ) {
         $meta_keys = array();
         foreach ( array_merge( get_post_types(), get_taxonomies() ) as $name ) {
@@ -1674 +1674 @@
     // 4.2
     if ( $wp_current_db_version < 31351 && $wpdb->charset === 'utf8mb4' ) {
-        if ( ! ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) && DO_NOT_UPGRADE_GLOBAL_TABLES ) ) {
+        if ( wp_should_upgrade_global_tables() ) {
             $wpdb->query( "ALTER TABLE $wpdb->usermeta DROP INDEX meta_key, ADD INDEX meta_key(meta_key(191))" );
             $wpdb->query( "ALTER TABLE $wpdb->site DROP INDEX domain, ADD INDEX domain(domain(140),path(51))" );
@@ -1690 +1690 @@
     // 4.3
     if ( $wp_current_db_version < 33055 && 'utf8mb4' === $wpdb->charset ) {
-        if ( ! ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) && DO_NOT_UPGRADE_GLOBAL_TABLES ) ) {
+        if ( wp_should_upgrade_global_tables() ) {
             $upgrade = false;
             $indexes = $wpdb->get_results( "SHOW INDEXES FROM $wpdb->signups" );
@@ -2099 +2099 @@
     $global_tables = $wpdb->tables( 'global' );
     foreach ( $cqueries as $table => $qry ) {
-        // Upgrade global tables only for the main site. Don't upgrade at all if DO_NOT_UPGRADE_GLOBAL_TABLES is defined.
-        if ( in_array( $table, $global_tables ) && ( !is_main_site() || defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) ) {
+        // Upgrade global tables only for the main site. Don't upgrade at all if conditions are not optimal.
+        if ( in_array( $table, $global_tables ) && ! wp_should_upgrade_global_tables() ) {
             unset( $cqueries[ $table ], $for_update[ $table ] );
             continue;
@@ -2617 +2617 @@
 
     // Multisite schema upgrades.
-    if ( $wp_current_db_version < 25448 && is_multisite() && ! defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) && is_main_network() ) {
+    if ( $wp_current_db_version < 25448 && is_multisite() && wp_should_upgrade_global_tables() ) {
 
         // Upgrade verions prior to 3.7
@@ -2635 +2635 @@
     // Upgrade versions prior to 4.2.
     if ( $wp_current_db_version < 31351 ) {
-        if ( ! is_multisite() ) {
+        if ( wp_should_upgrade_global_tables() ) {
             $wpdb->query( "ALTER TABLE $wpdb->usermeta DROP INDEX meta_key, ADD INDEX meta_key(meta_key(191))" );
         }
@@ -2672 +2672 @@
 }
 endif;
+
+/**
+ * Determine if global tables should be upgraded.
+ * 
+ * This function performs a series of checks to ensure the environment allows
+ * for the safe upgrading of global WordPress database tables. It is necessary
+ * because global tables will commonly grow to millions of rows on large
+ * installations, and the ability to control their upgrade routines can be
+ * critical to the operation of large networks.
+ *
+ * In a future iteration, this function may use `wp_is_large_network()` to more-
+ * intelligently prevent global table upgrades. Until then, we make sure
+ * WordPress is on the main site of the main network, to avoid running queries
+ * more than once in multi-site or multi-network environments.
+ *
+ * @since 4.3.0
+ *
+ * @return bool Whether to run the upgrade routines on global tables.
+ */
+function wp_should_upgrade_global_tables() {
+
+    // Return false early if explicitly not upgrading
+    if ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
+        return false;
+    }
+
+    // Assume global tables should be upgraded
+    $should_upgrade = true;
+
+    // Set to false if not on main network (does not matter if not multi-network)
+    if ( ! is_main_network() ) {
+        $should_upgrade = false;
+    }
+
+    // Set to false if not on main site of current network (does not matter if not multi-site)
+    if ( ! is_main_site() ) {
+        $should_upgrade = false;
+    }
+
+    /**
+     * Filter if upgrade routines should be run on global tables in multisite.
+     *
+     * @param bool $should_upgrade Whether to run the upgrade routines on global tables.
+     */
+    return apply_filters( 'wp_should_upgrade_global_tables', $should_upgrade );
+}