Changeset 8310

Timestamp:

04/21/2014 09:59:55 PM (11 years ago)

Author:

johnjamesjacoby

Message:

Simplify signups table install & upgrade routines. See #5563. Props r-a-y. (trunk)

Location:

trunk/bp-core

Files:

• admin/bp-core-schema.php (modified) (1 diff)
• bp-core-update.php (modified) (4 diffs)

trunk/bp-core/admin/bp-core-schema.php

@@ -53 +53 @@
 
     // Install the signups table
-    bp_core_install_signups();
+    bp_core_maybe_install_signups();
 
 }

trunk/bp-core/bp-core-update.php

@@ -415 +415 @@
  */
 function bp_update_to_2_0_1() {
-    bp_core_maybe_upgrade_signups();
+
+    // We purposely call this during both the 2.0 upgrade and the 2.0.1 upgrade.
+    // Don't worry; it won't break anything, and safely handles all cases.
+    bp_core_maybe_install_signups();
 }
 
@@ -462 +465 @@
     }
 
-    // Check for the table (we suppress errors because users shouldn't see this)
+    // Suppress errors because users shouldn't see this
     $old_suppress = $wpdb->suppress_errors();
 
     // Never use bp_core_get_table_prefix() for any global users tables
+    // We also don't use $wpdb->signups because we want decisive evidence.
     $table_exists = $wpdb->get_results( "DESCRIBE {$wpdb->base_prefix}signups;" );
 
@@ -473 +477 @@
     // Return whether or not the table exists
     return (bool) $table_exists;
+}
+
+/**
+ * Check if the signups table already exists
+ *
+ * @since BuddyPress (2.0.1)
+ *
+ * @global WPDB $wpdb
+ *
+ * @link https://core.trac.wordpress.org/changeset/25179
+ *
+ * @return bool If signup_id column exists
+ */
+function bp_core_signups_id_column_exists() {
+    global $wpdb;
+
+    // No signups table to query, so bail and return false
+    if ( empty( $wpdb->signups ) ) {
+        return false;
+    }
+
+    // Suppress errors because users shouldn't see this
+    $old_suppress = $wpdb->suppress_errors();
+
+    // Never use bp_core_get_table_prefix() for any global users tables
+    $column_exists = $wpdb->query( "SHOW COLUMNS FROM {$wpdb->signups} LIKE 'signup_id'" );
+
+    // Restore previous error suppression setting
+    $wpdb->suppress_errors( $old_suppress );
+
+    // Column does not exist
+    return $column_exists;
 }
 
@@ -491 +527 @@
     }
 
-    // Try to install the sign-ups table
-    if ( ! is_multisite() && ! bp_core_signups_table_exists() ) {
+    // Table already exists, so maybe upgrade instead?
+    if ( bp_core_signups_table_exists() ) {
+
+        // 'signup_id' column doesn't exist, so run the upgrade
+        if ( ! bp_core_signups_id_column_exists() ) {
+            bp_core_upgrade_signups();
+        }
+
+    // Table does not exist, and not multisite, so install the signups table
+    } elseif ( ! is_multisite() ) {
         bp_core_install_signups();
     }
-
-    // Return whether or not the table exists now
-    return (bool) bp_core_signups_table_exists();
-}
-
-/**
- * Check if the signups table needs to be upgraded.
- *
- * Update the signups table, adding `signup_id` column and drop `domain` index.
- *
- * This is necessary because WordPress's `pre_schema_upgrade()` function wraps
- * table ALTER's in multisite checks, and other plugins may have installed their
- * own sign-ups table; Eg: Gravity Forms User Registration Add On
- *
- * @since BuddyPress (2.0.1)
- *
- * @see pre_schema_upgrade()
- * @link https://core.trac.wordpress.org/ticket/27855 WordPress Trac Ticket
- * @link https://buddypress.trac.wordpress.org/ticket/5563 BuddyPress Trac Ticket
- *
- * @return bool If signups table exists
- */
-function bp_core_maybe_upgrade_signups() {
-
-    // Bail if we are explicitly not upgrading global tables
-    if ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
-        return false;
-    }
-
-    // Actually upgrade the sign-ups table
-    if ( bp_core_maybe_install_signups() ) {
-        bp_core_upgrade_signups();
-    }
-
-    // Return whether or not the table exists now
-    return (bool) bp_core_signups_table_exists();
 }