<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][8302] trunk: Signups: Introduce functions for upgrading the global `wp_signups` table if an old version exists.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/8302">8302</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2014-04-21 16:14:52 +0000 (Mon, 21 Apr 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Signups: Introduce functions for upgrading the global `wp_signups` table if an old version exists. This happens primarily on singlesite installations where third party plugins may have previously created the sign-ups table without keeping it updated.
* Bumps the DB version number to 8300.
* Moves functions for table creation and upgrade into the admin schema file.
* Moves sign-ups table creation out of activation process, and into the database upgrade process.
* No not rely on `dbDelta()` for these specific database upgrades (inspired by [WP25179])
See <a href="http://buddypress.trac.wordpress.org/ticket/5563">#5563</a>, #WP27855. (trunk)</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcoreadminbpcorefunctionsphp">trunk/bp-core/admin/bp-core-functions.php</a></li>
<li><a href="#trunkbpcoreadminbpcoreschemaphp">trunk/bp-core/admin/bp-core-schema.php</a></li>
<li><a href="#trunkbpcorebpcoreupdatephp">trunk/bp-core/bp-core-update.php</a></li>
<li><a href="#trunkbploaderphp">trunk/bp-loader.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcoreadminbpcorefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/admin/bp-core-functions.php (8301 => 8302)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/admin/bp-core-functions.php 2014-04-21 16:08:32 UTC (rev 8301)
+++ trunk/bp-core/admin/bp-core-functions.php 2014-04-21 16:14:52 UTC (rev 8302)
</span><span class="lines">@@ -276,8 +276,6 @@
</span><span class="cx"> 'id' => 'register',
</span><span class="cx"> 'name' => __( 'Register', 'buddypress' )
</span><span class="cx"> );
</span><del>-
- bp_core_maybe_install_signups();
</del><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // On the first admin screen after a new installation, this isn't set, so grab it to supress a misleading error message.
</span><span class="lines">@@ -794,39 +792,6 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Check if the signups table needs to be created.
- *
- * @since BuddyPress (2.0.0)
- *
- * @global $wpdb
- */
-function bp_core_maybe_install_signups() {
- global $wpdb;
-
- // Multisite installations already have the signups table.
- if ( ! empty( $wpdb->signups ) ) {
- return;
- }
-
- $bp_signups = bp_core_get_table_prefix() . 'signups';
-
- // Check for the table
- $suppress = $wpdb->suppress_errors();
- $table_exists = $wpdb->get_results( "DESCRIBE {$bp_signups};" );
- $wpdb->suppress_errors( $suppress );
-
- // Bail if the table exists
- if ( ! empty( $table_exists ) ) {
- return;
- }
-
- // Signups is not there and we need it so let's create it
- require_once( buddypress()->plugin_dir . '/bp-core/admin/bp-core-schema.php' );
-
- bp_core_install_signups();
-}
-
-/**
</del><span class="cx"> * Add "Mark as Spam/Ham" button to user row actions.
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span></span></pre></div>
<a id="trunkbpcoreadminbpcoreschemaphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/admin/bp-core-schema.php (8301 => 8302)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/admin/bp-core-schema.php 2014-04-21 16:08:32 UTC (rev 8301)
+++ trunk/bp-core/admin/bp-core-schema.php 2014-04-21 16:14:52 UTC (rev 8302)
</span><span class="lines">@@ -348,6 +348,8 @@
</span><span class="cx"> dbDelta( $sql );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/** Signups *******************************************************************/
+
</ins><span class="cx"> /**
</span><span class="cx"> * Install the signups table.
</span><span class="cx"> *
</span><span class="lines">@@ -359,19 +361,15 @@
</span><span class="cx"> function bp_core_install_signups() {
</span><span class="cx"> global $wpdb;
</span><span class="cx">
</span><del>- // Multisite installations already have the signups table
- if ( ! empty( $wpdb->signups ) ) {
- return;
- }
</del><ins>+ // Signups is not there and we need it so let's create it
+ require_once( buddypress()->plugin_dir . '/bp-core/admin/bp-core-schema.php' );
+ require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
</ins><span class="cx">
</span><del>- $wpdb->signups = bp_core_get_table_prefix() . 'signups';
</del><ins>+ // Never use bp_core_get_table_prefix() for any global users tables
+ $wpdb->signups = $wpdb->base_prefix . 'signups';
</ins><span class="cx">
</span><del>- // Setting the charset to be sure WordPress upgrade.php is loaded
- $charset_collate = bp_core_set_charset();
-
</del><span class="cx"> // Use WP's core CREATE TABLE query
</span><span class="cx"> $create_queries = wp_get_db_schema( 'ms_global' );
</span><del>-
</del><span class="cx"> if ( ! is_array( $create_queries ) ) {
</span><span class="cx"> $create_queries = explode( ';', $create_queries );
</span><span class="cx"> $create_queries = array_filter( $create_queries );
</span><span class="lines">@@ -380,13 +378,40 @@
</span><span class="cx"> // Filter out all the queries except wp_signups
</span><span class="cx"> foreach ( $create_queries as $key => $query ) {
</span><span class="cx"> if ( preg_match( "|CREATE TABLE ([^ ]*)|", $query, $matches ) ) {
</span><del>- if ( $wpdb->signups != trim( $matches[1], '`' ) ) {
</del><ins>+ if ( trim( $matches[1], '`' ) !== $wpdb->signups ) {
</ins><span class="cx"> unset( $create_queries[ $key ] );
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Run WordPress's database upgrader
</ins><span class="cx"> if ( ! empty( $create_queries ) ) {
</span><span class="cx"> dbDelta( $create_queries );
</span><span class="cx"> }
</span><span class="cx"> }
</span><ins>+
+/**
+ * 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
+ *
+ * @global WPDB $wpdb
+ */
+function bp_core_upgrade_signups() {
+ global $wpdb;
+
+ // Never use bp_core_get_table_prefix() for any global users tables
+ $wpdb->signups = $wpdb->base_prefix . 'signups';
+
+ // Attempt to alter the signups table
+ $wpdb->query( "ALTER TABLE {$wpdb->signups} ADD signup_id BIGINT(20) NOT NULL AUTO_INCREMENT PRIMARY KEY FIRST" );
+ $wpdb->query( "ALTER TABLE {$wpdb->signups} DROP INDEX domain" );
+}
</ins></span></pre></div>
<a id="trunkbpcorebpcoreupdatephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-update.php (8301 => 8302)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-update.php 2014-04-21 16:08:32 UTC (rev 8301)
+++ trunk/bp-core/bp-core-update.php 2014-04-21 16:14:52 UTC (rev 8302)
</span><span class="lines">@@ -235,6 +235,11 @@
</span><span class="cx"> if ( $raw_db_version < 7892 ) {
</span><span class="cx"> bp_update_to_2_0();
</span><span class="cx"> }
</span><ins>+
+ // 2.0.1
+ if ( $raw_db_version < 8300 ) {
+ bp_update_to_2_0_1();
+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /** All done! *************************************************************/
</span><span class="lines">@@ -243,6 +248,8 @@
</span><span class="cx"> bp_version_bump();
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/** Upgrade Routines **********************************************************/
+
</ins><span class="cx"> /**
</span><span class="cx"> * Remove unused metadata from database when upgrading from < 1.5.
</span><span class="cx"> *
</span><span class="lines">@@ -338,9 +345,10 @@
</span><span class="cx"> * - Ensure that the activity tables are installed, for last_activity storage.
</span><span class="cx"> * - Migrate last_activity data from usermeta to activity table
</span><span class="cx"> * - Add values for all BuddyPress options to the options table
</span><ins>+ *
+ * @since BuddyPress (2.0.0)
</ins><span class="cx"> */
</span><span class="cx"> function bp_update_to_2_0() {
</span><del>- global $wpdb;
</del><span class="cx">
</span><span class="cx"> /** Install activity tables for 'last_activity' ***************************/
</span><span class="cx">
</span><span class="lines">@@ -354,9 +362,8 @@
</span><span class="cx">
</span><span class="cx"> if ( ! is_multisite() ) {
</span><span class="cx">
</span><del>- if ( empty( $wpdb->signups ) ) {
- bp_core_install_signups();
- }
</del><ins>+ // Maybe install the signups table
+ bp_core_maybe_install_signups();
</ins><span class="cx">
</span><span class="cx"> $signups = get_users( array(
</span><span class="cx"> 'fields' => 'all_with_meta',
</span><span class="lines">@@ -400,6 +407,17 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * 2.0.1 database upgrade routine
+ *
+ * @since BuddyPress (2.0.1)
+ *
+ * @return void
+ */
+function bp_update_to_2_0_1() {
+ bp_core_maybe_upgrade_signups();
+}
+
+/**
</ins><span class="cx"> * Redirect user to BP's What's New page on first page load after activation.
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.7.0)
</span><span class="lines">@@ -424,6 +442,96 @@
</span><span class="cx"> set_transient( '_bp_activation_redirect', true, 30 );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/** Signups *******************************************************************/
+
+/**
+ * Check if the signups table already exists
+ *
+ * @since BuddyPress (2.0.1)
+ *
+ * @global WPDB $wpdb
+ *
+ * @return bool If signups table exists
+ */
+function bp_core_signups_table_exists() {
+ global $wpdb;
+
+ // Some installations may already have a signups table (multisite, plugins, etc...)
+ if ( ! empty( $wpdb->signups ) ) {
+ return true;
+ }
+
+ // Check for the table (we 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
+ $table_exists = $wpdb->get_results( "DESCRIBE {$wpdb->base_prefix}signups;" );
+
+ // Restore previous error suppression setting
+ $wpdb->suppress_errors( $old_suppress );
+
+ // Return whether or not the table exists
+ return (bool) $table_exists;
+}
+
+/**
+ * Check if the signups table needs to be created.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @global WPDB $wpdb
+ *
+ * @return bool If signups table exists
+ */
+function bp_core_maybe_install_signups() {
+
+ // Bail if we are explicitly not upgrading global tables
+ if ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
+ return false;
+ }
+
+ // Try to install the sign-ups table
+ if ( ! is_multisite() && ! bp_core_signups_table_exists() ) {
+ 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();
+}
+
</ins><span class="cx"> /** Activation Actions ********************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunkbploaderphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-loader.php (8301 => 8302)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-loader.php 2014-04-21 16:08:32 UTC (rev 8301)
+++ trunk/bp-loader.php 2014-04-21 16:14:52 UTC (rev 8302)
</span><span class="lines">@@ -304,7 +304,7 @@
</span><span class="cx"> /** Versions **************************************************/
</span><span class="cx">
</span><span class="cx"> $this->version = '2.1-alpha';
</span><del>- $this->db_version = 7892;
</del><ins>+ $this->db_version = 8300;
</ins><span class="cx">
</span><span class="cx"> /** Loading ***************************************************/
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>