<!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][8310] trunk/bp-core: Simplify `signups` table install & upgrade routines.</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/8310">8310</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2014-04-21 21:59:55 +0000 (Mon, 21 Apr 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Simplify `signups` table install & upgrade routines. See <a href="http://buddypress.trac.wordpress.org/ticket/5563">#5563</a>. Props r-a-y. (trunk)</pre>
<h3>Modified Paths</h3>
<ul>
<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>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcoreadminbpcoreschemaphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/admin/bp-core-schema.php (8309 => 8310)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/admin/bp-core-schema.php 2014-04-21 21:48:38 UTC (rev 8309)
+++ trunk/bp-core/admin/bp-core-schema.php 2014-04-21 21:59:55 UTC (rev 8310)
</span><span class="lines">@@ -52,7 +52,7 @@
</span><span class="cx"> bp_core_install_blog_tracking();
</span><span class="cx">
</span><span class="cx"> // Install the signups table
</span><del>- bp_core_install_signups();
</del><ins>+ bp_core_maybe_install_signups();
</ins><span class="cx">
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunkbpcorebpcoreupdatephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-update.php (8309 => 8310)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-update.php 2014-04-21 21:48:38 UTC (rev 8309)
+++ trunk/bp-core/bp-core-update.php 2014-04-21 21:59:55 UTC (rev 8310)
</span><span class="lines">@@ -414,7 +414,10 @@
</span><span class="cx"> * @return void
</span><span class="cx"> */
</span><span class="cx"> function bp_update_to_2_0_1() {
</span><del>- bp_core_maybe_upgrade_signups();
</del><ins>+
+ // 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();
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -461,10 +464,11 @@
</span><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // Check for the table (we suppress errors because users shouldn't see this)
</del><ins>+ // Suppress errors because users shouldn't see this
</ins><span class="cx"> $old_suppress = $wpdb->suppress_errors();
</span><span class="cx">
</span><span class="cx"> // Never use bp_core_get_table_prefix() for any global users tables
</span><ins>+ // We also don't use $wpdb->signups because we want decisive evidence.
</ins><span class="cx"> $table_exists = $wpdb->get_results( "DESCRIBE {$wpdb->base_prefix}signups;" );
</span><span class="cx">
</span><span class="cx"> // Restore previous error suppression setting
</span><span class="lines">@@ -475,61 +479,65 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Check if the signups table needs to be created.
</del><ins>+ * Check if the signups table already exists
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (2.0.0)
</del><ins>+ * @since BuddyPress (2.0.1)
</ins><span class="cx"> *
</span><span class="cx"> * @global WPDB $wpdb
</span><span class="cx"> *
</span><del>- * @return bool If signups table exists
</del><ins>+ * @link https://core.trac.wordpress.org/changeset/25179
+ *
+ * @return bool If signup_id column exists
</ins><span class="cx"> */
</span><del>-function bp_core_maybe_install_signups() {
</del><ins>+function bp_core_signups_id_column_exists() {
+ global $wpdb;
</ins><span class="cx">
</span><del>- // Bail if we are explicitly not upgrading global tables
- if ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
</del><ins>+ // No signups table to query, so bail and return false
+ if ( empty( $wpdb->signups ) ) {
</ins><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // Try to install the sign-ups table
- if ( ! is_multisite() && ! bp_core_signups_table_exists() ) {
- bp_core_install_signups();
- }
</del><ins>+ // Suppress errors because users shouldn't see this
+ $old_suppress = $wpdb->suppress_errors();
</ins><span class="cx">
</span><del>- // Return whether or not the table exists now
- return (bool) bp_core_signups_table_exists();
</del><ins>+ // 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;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Check if the signups table needs to be upgraded.
</del><ins>+ * Check if the signups table needs to be created.
</ins><span class="cx"> *
</span><del>- * Update the signups table, adding `signup_id` column and drop `domain` index.
</del><ins>+ * @since BuddyPress (2.0.0)
</ins><span class="cx"> *
</span><del>- * 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
</del><ins>+ * @global WPDB $wpdb
</ins><span class="cx"> *
</span><del>- * @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
- *
</del><span class="cx"> * @return bool If signups table exists
</span><span class="cx"> */
</span><del>-function bp_core_maybe_upgrade_signups() {
</del><ins>+function bp_core_maybe_install_signups() {
</ins><span class="cx">
</span><span class="cx"> // Bail if we are explicitly not upgrading global tables
</span><span class="cx"> if ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // Actually upgrade the sign-ups table
- if ( bp_core_maybe_install_signups() ) {
- bp_core_upgrade_signups();
</del><ins>+ // 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();
</ins><span class="cx"> }
</span><del>-
- // Return whether or not the table exists now
- return (bool) bp_core_signups_table_exists();
</del><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /** Activation Actions ********************************************************/
</span></span></pre>
</div>
</div>
</body>
</html>