Changeset 6281 for trunk/src/includes/admin/upgrades.php

Timestamp:

02/03/2017 06:37:37 PM (9 years ago)

Author:

johnjamesjacoby

Message:

Tools: Separate wp_usermeta clean-up from database upgrade routines.

Clean-up should be run after upgrades, not during. This way all results can be verified by the admin.

See #3052.

File:

• trunk/src/includes/admin/upgrades.php (modified) (1 diff)

trunk/src/includes/admin/upgrades.php

@@ -156 +156 @@
 <?php
 }
+
+/**
+ * Upgrade user favorites for bbPress 2.6 and higher
+ *
+ * @since 2.6.0 bbPress (r6174)
+ *
+ * @return array An array of the status code and the message
+ */
+function bbp_admin_upgrade_user_favorites() {
+
+    // Define variables
+    $bbp_db    = bbp_db();
+    $statement = __( 'Upgrading user favorites &hellip; %s', 'bbpress' );
+    $result    = __( 'No favorites to upgrade.',             'bbpress' );
+    $total     = 0;
+    $key       = $bbp_db->prefix . '_bbp_favorites';
+    $favorites = $bbp_db->get_results( $bbp_db->prepare( "SELECT * FROM {$bbp_db->usermeta} WHERE meta_key = %s", $key ) );
+
+    // Bail if no closed topics found
+    if ( empty( $favorites ) || is_wp_error( $favorites ) ) {
+        return array( 1, sprintf( $statement, $result ) );
+    }
+
+    // Loop through each user's favorites
+    foreach ( $favorites as $meta ) {
+
+        // Get post IDs
+        $post_ids = explode( ',', $meta->meta_value );
+
+        // Add user ID to all favorited posts
+        foreach ( $post_ids as $post_id ) {
+
+            // Skip if already exists
+            if ( $bbp_db->get_var( $bbp_db->prepare( "SELECT COUNT(*) FROM {$bbp_db->postmeta} WHERE post_id = %d AND meta_key = %s AND meta_value = %d", $post_id, '_bbp_favorite', $meta->user_id ) ) ) {
+                continue;
+            }
+
+            // Add the post meta
+            $added = add_post_meta( $post_id, '_bbp_favorite', $meta->user_id, false );
+
+            // Bump counts if successfully added
+            if ( ! empty( $added ) ) {
+                ++$total;
+            }
+        }
+    }
+
+    // Cleanup
+    unset( $favorites, $added, $post_ids );
+
+    // Complete results
+    $result = sprintf( _n( 'Complete! %d favorite upgraded.', 'Complete! %d favorites upgraded.', $total, 'bbpress' ), $total );
+
+    return array( 0, sprintf( $statement, $result ) );
+}
+
+/**
+ * Upgrade user topic subscriptions for bbPress 2.6 and higher
+ *
+ * @since 2.6.0 bbPress (r6174)
+ *
+ * @return array An array of the status code and the message
+ */
+function bbp_admin_upgrade_user_topic_subscriptions() {
+
+    // Define variables
+    $bbp_db        = bbp_db();
+    $statement     = __( 'Upgrading user topic subscriptions &hellip; %s', 'bbpress' );
+    $result        = __( 'No topic subscriptions to upgrade.',             'bbpress' );
+    $total         = 0;
+    $key           = $bbp_db->prefix . '_bbp_subscriptions';
+    $subscriptions = $bbp_db->get_results( $bbp_db->prepare( "SELECT * FROM {$bbp_db->usermeta} WHERE meta_key = %s ORDER BY user_id", $key ) );
+
+    // Bail if no topic subscriptions found
+    if ( empty( $subscriptions ) || is_wp_error( $subscriptions ) ) {
+        return array( 1, sprintf( $statement, $result ) );
+    }
+
+    // Loop through each user's topic subscriptions
+    foreach ( $subscriptions as $meta ) {
+
+        // Get post IDs
+        $post_ids = explode( ',', $meta->meta_value );
+
+        // Add user ID to all subscribed topics
+        foreach ( $post_ids as $post_id ) {
+
+            // Skip if already exists
+            if ( $bbp_db->get_var( $bbp_db->prepare( "SELECT COUNT(*) FROM {$bbp_db->postmeta} WHERE post_id = %d AND meta_key = %s AND meta_value = %d", $post_id, '_bbp_subscription', $meta->user_id ) ) ) {
+                continue;
+            }
+
+            // Add the post meta
+            $added = add_post_meta( $post_id, '_bbp_subscription', $meta->user_id, false );
+
+            // Bump counts if successfully added
+            if ( ! empty( $added ) ) {
+                ++$total;
+            }
+        }
+    }
+
+    // Cleanup
+    unset( $subscriptions, $added, $post_ids );
+
+    // Complete results
+    $result = sprintf( _n( 'Complete! %d topic subscription upgraded.', 'Complete! %d topic subscriptions upgraded.', $total, 'bbpress' ), $total );
+
+    return array( 0, sprintf( $statement, $result ) );
+}
+
+/**
+ * Upgrade user forum subscriptions for bbPress 2.6 and higher
+ *
+ * @since 2.6.0 bbPress (r6193)
+ *
+ * @return array An array of the status code and the message
+ */
+function bbp_admin_upgrade_user_forum_subscriptions() {
+
+    // Define variables
+    $bbp_db        = bbp_db();
+    $statement     = __( 'Upgrading user forum subscriptions &hellip; %s', 'bbpress' );
+    $result        = __( 'No forum subscriptions to upgrade.',             'bbpress' );
+    $total         = 0;
+    $key           = $bbp_db->prefix . '_bbp_forum_subscriptions';
+    $subscriptions = $bbp_db->get_results( $bbp_db->prepare( "SELECT * FROM {$bbp_db->usermeta} WHERE meta_key = %s ORDER BY user_id", $key ) );
+
+    // Bail if no forum subscriptions found
+    if ( empty( $subscriptions ) || is_wp_error( $subscriptions ) ) {
+        return array( 1, sprintf( $statement, $result ) );
+    }
+
+    // Loop through each user's forum subscriptions
+    foreach ( $subscriptions as $meta ) {
+
+        // Get post IDs
+        $post_ids = explode( ',', $meta->meta_value );
+
+        // Add user ID to all subscribed forums
+        foreach ( $post_ids as $post_id ) {
+
+            // Skip if already exists
+            if ( $bbp_db->get_var( $bbp_db->prepare( "SELECT COUNT(*) FROM {$bbp_db->postmeta} WHERE post_id = %d AND meta_key = %s AND meta_value = %d", $post_id, '_bbp_forum_subscription', $meta->user_id ) ) ) {
+                continue;
+            }
+
+            // Add the post meta
+            $added = add_post_meta( $post_id, '_bbp_subscription', $meta->user_id, false );
+
+            // Bump counts if successfully added
+            if ( ! empty( $added ) ) {
+                ++$total;
+            }
+        }
+    }
+
+    // Cleanup
+    unset( $subscriptions, $added, $post_ids );
+
+    // Complete results
+    $result = sprintf( _n( 'Complete! %d forum subscription upgraded.', 'Complete! %d forum subscriptions upgraded.', $total, 'bbpress' ), $total );
+
+    return array( 0, sprintf( $statement, $result ) );
+}
+
+/**
+ * Remove favorites data from wp_usermeta for bbPress 2.6 and higher
+ *
+ * @since 2.6.0 bbPress (r6281)
+ *
+ * @return array An array of the status code and the message
+ */
+function bbp_admin_upgrade_remove_favorites_from_usermeta() {
+
+    // Define variables
+    $bbp_db    = bbp_db();
+    $statement = __( 'Remove favorites from usermeta &hellip; %s', 'bbpress' );
+    $result    = __( 'No favorites to remove.',                    'bbpress' );
+    $total     = 0;
+    $key       = $bbp_db->prefix . '_bbp_favorites';
+    $favs      = $bbp_db->get_results( $bbp_db->prepare( "SELECT * FROM {$bbp_db->usermeta} WHERE meta_key = %s ORDER BY user_id", $key ) );
+
+    // Bail if no favorites found
+    if ( empty( $favs ) || is_wp_error( $favs ) ) {
+        return array( 1, sprintf( $statement, $result ) );
+    }
+
+    // Loop through each user's favorites
+    foreach ( $favorites as $meta ) {
+
+        // Get post IDs
+        $post_ids  = explode( ',', $meta->meta_value );
+        $total     = $total + count( $post_ids );
+
+        delete_metadata_by_mid( 'user', $meta->umeta_id );
+    }
+
+    // Cleanup
+    unset( $favs, $post_ids );
+
+    // Complete results
+    $result = sprintf( _n( 'Complete! %d favorites upgraded.', 'Complete! %d favorites upgraded.', $total, 'bbpress' ), $total );
+
+    return array( 0, sprintf( $statement, $result ) );
+}
+
+/**
+ * Remove topic subscriptions data from wp_usermeta for bbPress 2.6 and higher
+ *
+ * @since 2.6.0 bbPress (r6281)
+ *
+ * @return array An array of the status code and the message
+ */
+function bbp_admin_upgrade_remove_topic_subscriptions_from_usermeta() {
+
+    // Define variables
+    $bbp_db    = bbp_db();
+    $statement = __( 'Remove topic subscriptions from usermeta &hellip; %s', 'bbpress' );
+    $result    = __( 'No topic subscriptions to remove.',                    'bbpress' );
+    $total     = 0;
+    $key       = $bbp_db->prefix . '_bbp_subscriptions';
+    $subs      = $bbp_db->get_results( $bbp_db->prepare( "SELECT * FROM {$bbp_db->usermeta} WHERE meta_key = %s ORDER BY user_id", $key ) );
+
+    // Bail if no forum favorites found
+    if ( empty( $subs ) || is_wp_error( $subs ) ) {
+        return array( 1, sprintf( $statement, $result ) );
+    }
+
+    // Loop through each user's favorites
+    foreach ( $subs as $meta ) {
+
+        // Get post IDs
+        $post_ids  = explode( ',', $meta->meta_value );
+        $total     = $total + count( $post_ids );
+
+        delete_metadata_by_mid( 'user', $meta->umeta_id );
+    }
+
+    // Cleanup
+    unset( $subs, $post_ids );
+
+    // Complete results
+    $result = sprintf( _n( 'Complete! %d topic subscription upgraded.', 'Complete! %d topic subscriptions upgraded.', $total, 'bbpress' ), $total );
+
+    return array( 0, sprintf( $statement, $result ) );
+}
+
+/**
+ * Remove topic subscriptions data from wp_usermeta for bbPress 2.6 and higher
+ *
+ * @since 2.6.0 bbPress (r6281)
+ *
+ * @return array An array of the status code and the message
+ */
+function bbp_admin_upgrade_remove_forum_subscriptions_from_usermeta() {
+
+    // Define variables
+    $bbp_db    = bbp_db();
+    $statement = __( 'Remove forum subscriptions from usermeta &hellip; %s', 'bbpress' );
+    $result    = __( 'No forum subscriptions to remove.',                    'bbpress' );
+    $total     = 0;
+    $key       = $bbp_db->prefix . '_bbp_forum_subscriptions';
+    $subs      = $bbp_db->get_results( $bbp_db->prepare( "SELECT * FROM {$bbp_db->usermeta} WHERE meta_key = %s ORDER BY user_id", $key ) );
+
+    // Bail if no forum favorites found
+    if ( empty( $subs ) || is_wp_error( $subs ) ) {
+        return array( 1, sprintf( $statement, $result ) );
+    }
+
+    // Loop through each user's favorites
+    foreach ( $subs as $meta ) {
+
+        // Get post IDs
+        $post_ids  = explode( ',', $meta->meta_value );
+        $total     = $total + count( $post_ids );
+
+        delete_metadata_by_mid( 'user', $meta->umeta_id );
+    }
+
+    // Cleanup
+    unset( $subs, $post_ids );
+
+    // Complete results
+    $result = sprintf( _n( 'Complete! %d forum subscription upgraded.', 'Complete! %d forum subscriptions upgraded.', $total, 'bbpress' ), $total );
+
+    return array( 0, sprintf( $statement, $result ) );
+}