<!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][8315] trunk: Improve the migration tool that converts old non-multisite signups to post-2.0 system</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/8315">8315</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-04-24 00:22:29 +0000 (Thu, 24 Apr 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve the migration tool that converts old non-multisite signups to post-2.0 system
This refactoring involves a number of improvements:
- Old signups are identified as those users with user_status=2, instead of
those users with an 'activation_key' usermeta value. Use of the latter
technique caused problems with upgrades when plugins had interfered in the
normal BuddyPress registration flow in such a way as to retain the activation
key on activated accounts. user_status=2 is a more reliable technique.
- Querying by user_status=2 means that the get_users() query does not have to
include all usermeta, which makes for a more performant query on large sites.
- The migration routine has been broken out into a separate function
bp_members_migrate_signups(), and unit tests have been written for it.
- Activation keys are now regenerated for migrated users who did not have an
existing key in usermeta for some reason.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5553">#5553</a>
Props imath</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcoreupdatephp">trunk/bp-core/bp-core-update.php</a></li>
<li><a href="#trunkbpmembersbpmembersfunctionsphp">trunk/bp-members/bp-members-functions.php</a></li>
<li><a href="#trunkteststestcasesmembersfunctionsphp">trunk/tests/testcases/members/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcoreupdatephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-update.php (8314 => 8315)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-update.php 2014-04-24 00:22:06 UTC (rev 8314)
+++ trunk/bp-core/bp-core-update.php 2014-04-24 00:22:29 UTC (rev 8315)
</span><span class="lines">@@ -365,40 +365,8 @@
</span><span class="cx"> // Maybe install the signups table
</span><span class="cx"> bp_core_maybe_install_signups();
</span><span class="cx">
</span><del>- $signups = get_users( array(
- 'fields' => 'all_with_meta',
- 'meta_key' => 'activation_key',
- 'meta_compare' => 'EXISTS',
- ) );
-
- if ( empty( $signups ) ) {
- return;
- }
-
- foreach ( $signups as $signup ) {
- $meta = array();
-
- if ( bp_is_active( 'xprofile' ) ) {
- $meta['field_1'] = $signup->display_name;
- }
-
- $meta['password'] = $signup->user_pass;
-
- $user_login = preg_replace( '/\s+/', '', sanitize_user( $signup->user_login, true ) );
- $user_email = sanitize_email( $signup->user_email );
-
- BP_Signup::add( array(
- 'user_login' => $user_login,
- 'user_email' => $user_email,
- 'registered' => $signup->user_registered,
- 'activation_key' => $signup->activation_key,
- 'meta' => $meta
- ) );
-
- // Deleting these options will remove signups from users count
- delete_user_option( $signup->ID, 'capabilities' );
- delete_user_option( $signup->ID, 'user_level' );
- }
</del><ins>+ // Run the migration script
+ bp_members_migrate_signups();
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /** Add BP options to the options table ***********************************/
</span></span></pre></div>
<a id="trunkbpmembersbpmembersfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-members/bp-members-functions.php (8314 => 8315)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-members/bp-members-functions.php 2014-04-24 00:22:06 UTC (rev 8314)
+++ trunk/bp-members/bp-members-functions.php 2014-04-24 00:22:29 UTC (rev 8315)
</span><span class="lines">@@ -1637,6 +1637,87 @@
</span><span class="cx"> return $user_id;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Migrate signups from pre-2.0 configuration to wp_signups.
+ *
+ * @since BuddyPress (2.0.1)
+ */
+function bp_members_migrate_signups() {
+ global $wpdb;
+
+ $status_2_ids = $wpdb->get_col( "SELECT ID FROM {$wpdb->users} WHERE user_status = '2'" );
+
+ if ( ! empty( $status_2_ids ) ) {
+ $signups = get_users( array(
+ 'fields' => array(
+ 'ID',
+ 'user_login',
+ 'user_pass',
+ 'user_registered',
+ 'user_email',
+ 'display_name',
+ ),
+ 'include' => $status_2_ids,
+ ) );
+
+ // Fetch activation keys separately, to avoid the all_with_meta
+ // overhead
+ $status_2_ids_sql = implode( ',', $status_2_ids );
+ $ak_data = $wpdb->get_results( "SELECT user_id, meta_value FROM {$wpdb->usermeta} WHERE meta_key = 'activation_key' AND user_id IN ({$status_2_ids_sql})" );
+
+ // Rekey
+ $activation_keys = array();
+ foreach ( $ak_data as $ak_datum ) {
+ $activation_keys[ intval( $ak_datum->user_id ) ] = $ak_datum->meta_value;
+ }
+
+ unset( $status_2_ids_sql, $status_2_ids, $ak_data );
+
+ // Merge
+ foreach ( $signups as &$signup ) {
+ if ( isset( $activation_keys[ $signup->ID ] ) ) {
+ $signup->activation_key = $activation_keys[ $signup->ID ];
+ }
+ }
+
+ // Reset the signup var as we're using it to process the migration
+ unset( $signup );
+
+ } else {
+ return;
+ }
+
+ foreach ( $signups as $signup ) {
+ $meta = array();
+
+ // Rebuild the activation key, if missing
+ if ( empty( $signup->activation_key ) ) {
+ $signup->activation_key = wp_hash( $signup->ID );
+ }
+
+ if ( bp_is_active( 'xprofile' ) ) {
+ $meta['field_1'] = $signup->display_name;
+ }
+
+ $meta['password'] = $signup->user_pass;
+
+ $user_login = preg_replace( '/\s+/', '', sanitize_user( $signup->user_login, true ) );
+ $user_email = sanitize_email( $signup->user_email );
+
+ BP_Signup::add( array(
+ 'user_login' => $user_login,
+ 'user_email' => $user_email,
+ 'registered' => $signup->user_registered,
+ 'activation_key' => $signup->activation_key,
+ 'meta' => $meta
+ ) );
+
+ // Deleting these options will remove signups from users count
+ delete_user_option( $signup->ID, 'capabilities' );
+ delete_user_option( $signup->ID, 'user_level' );
+ }
+}
+
</ins><span class="cx"> function bp_core_new_user_activity( $user ) {
</span><span class="cx"> if ( empty( $user ) || !bp_is_active( 'activity' ) )
</span><span class="cx"> return false;
</span></span></pre></div>
<a id="trunkteststestcasesmembersfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/members/functions.php (8314 => 8315)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/members/functions.php 2014-04-24 00:22:06 UTC (rev 8314)
+++ trunk/tests/testcases/members/functions.php 2014-04-24 00:22:29 UTC (rev 8315)
</span><span class="lines">@@ -279,4 +279,95 @@
</span><span class="cx">
</span><span class="cx"> $this->assertSame( $expected, bp_core_get_user_displaynames( array( $u1, $u2, ) ) );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @group bp_members_migrate_signups
+ */
+ public function test_bp_members_migrate_signups_standard() {
+ $u = $this->create_user();
+ $u_obj = new WP_User( $u );
+
+ // Fake an old-style registration
+ $key = wp_hash( $u_obj->ID );
+ update_user_meta( $u, 'activation_key', $key );
+
+ global $wpdb;
+ $wpdb->update(
+ $wpdb->users,
+ array( 'user_status' => '2', ),
+ array( 'ID' => $u, ),
+ array( '%d', ),
+ array( '%d', )
+ );
+ clean_user_cache( $u );
+
+ bp_members_migrate_signups();
+
+ $found = BP_Signup::get();
+
+ // Use email address as a sanity check
+ $found_email = isset( $found['signups'][0]->user_email ) ? $found['signups'][0]->user_email : '';
+ $this->assertSame( $u_obj->user_email, $found_email );
+
+ // Check that activation keys match
+ $found_key = isset( $found['signups'][0]->activation_key ) ? $found['signups'][0]->activation_key : '';
+ $this->assertSame( $key, $found_key );
+ }
+
+ /**
+ * @group bp_members_migrate_signups
+ */
+ public function test_bp_members_migrate_signups_activation_key_but_user_status_0() {
+ $u = $this->create_user();
+ $u_obj = new WP_User( $u );
+
+ // Fake an old-style registration
+ $key = wp_hash( $u_obj->ID );
+ update_user_meta( $u, 'activation_key', $key );
+
+ // ...but ensure that user_status is 0. This mimics the
+ // behavior of certain plugins that disrupt the BP registration
+ // flow
+ global $wpdb;
+ $wpdb->update(
+ $wpdb->users,
+ array( 'user_status' => '0', ),
+ array( 'ID' => $u, ),
+ array( '%d', ),
+ array( '%d', )
+ );
+ clean_user_cache( $u );
+
+ bp_members_migrate_signups();
+
+ // No migrations should have taken place
+ $found = BP_Signup::get();
+ $this->assertEmpty( $found['total'] );
+ }
+
+ /**
+ * @group bp_members_migrate_signups
+ */
+ public function test_bp_members_migrate_signups_no_activation_key_but_user_status_2() {
+ $u = $this->create_user();
+ $u_obj = new WP_User( $u );
+
+ // Fake an old-style registration but without an activation key
+ global $wpdb;
+ $wpdb->update(
+ $wpdb->users,
+ array( 'user_status' => '2', ),
+ array( 'ID' => $u, ),
+ array( '%d', ),
+ array( '%d', )
+ );
+ clean_user_cache( $u );
+
+ bp_members_migrate_signups();
+
+ // Use email address as a sanity check
+ $found = BP_Signup::get();
+ $found_email = isset( $found['signups'][0]->user_email ) ? $found['signups'][0]->user_email : '';
+ $this->assertSame( $u_obj->user_email, $found_email );
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>