Changeset 8315

Timestamp:

04/24/2014 12:22:29 AM (10 years ago)

Author:

boonebgorges

Message:

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 #5553

Props imath

Location:

trunk

Files:

• bp-core/bp-core-update.php (modified) (1 diff)
• bp-members/bp-members-functions.php (modified) (1 diff)
• tests/testcases/members/functions.php (modified) (1 diff)

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

@@ -366 +366 @@
         bp_core_maybe_install_signups();
 
-        $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'   );
-        }
+        // Run the migration script
+        bp_members_migrate_signups();
     }
 

trunk/bp-members/bp-members-functions.php

@@ -1638 +1638 @@
 }
 
+/**
+ * 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'   );
+    }
+}
+
 function bp_core_new_user_activity( $user ) {
     if ( empty( $user ) || !bp_is_active( 'activity' ) )

trunk/tests/testcases/members/functions.php

@@ -280 +280 @@
         $this->assertSame( $expected, bp_core_get_user_displaynames( array( $u1, $u2, ) ) );
     }
+
+    /**
+     * @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 );
+    }
 }