Ticket #5296: 5296.patch

bp-core/admin/bp-core-functions.php

@@ -388 +388 @@
                 '2' => array(
                         'href' => bp_get_admin_url( add_query_arg( array( 'page' => 'bp-settings' ), 'admin.php' ) ),
                         'name' => __( 'Settings', 'buddypress' )
-                )
+                ),
+
+                // Keyed late so it's always last
+                '99' => array(
+                        'href' => bp_get_admin_url( add_query_arg( array( 'page' => 'bp-tools' ), 'admin.php' ) ),
+                        'name' => __( 'Tools', 'buddypress' ),
+                ),
         );
 
         // If forums component is active, add additional tab

new file p-core/admin/bp-core-tools.php

@@ +1 @@
+<?php
+
+/**
+ * BuddyPress Tools panel
+ *
+ * @since BuddyPress (2.0.0)
+ */
+
+/**
+ * Render the BuddyPress Tools page.
+ *
+ * @since BuddyPress (2.0.0)
+ */
+function bp_core_admin_tools() {
+        ?>
+        <div class="wrap">
+                <?php screen_icon( 'buddypress'); ?>
+
+                <h2 class="nav-tab-wrapper"><?php bp_core_admin_tabs( __( 'Tools', 'buddypress' ) ); ?></h2>
+
+                <p><?php esc_html_e( 'BuddyPress keeps track of various relationships between users, groups, and activity items. Occasionally these relationships become out of sync, most often after an import, update, or migration. Use the tools below to manually recalculate these relationships.', 'buddypress' ); ?></p>
+                <p class="description"><?php esc_html_e( 'Some of these tools create substantial database overhead. Avoid running more than one repair job at a time.', 'buddypress' ); ?></p>
+
+                <form class="settings" method="post" action="">
+                        <table class="form-table">
+                                <tbody>
+                                        <tr valign="top">
+                                                <th scope="row"><?php esc_html_e( 'Data to Repair:', 'buddypress' ) ?></th>
+                                                <td>
+                                                        <fieldset>
+                                                                <legend class="screen-reader-text"><span><?php esc_html_e( 'Repair', 'buddypress' ) ?></span></legend>
+
+                                                                <?php foreach ( bp_admin_repair_list() as $item ) : ?>
+
+                                                                        <label><input type="checkbox" class="checkbox" name="<?php echo esc_attr( $item[0] ) . '" id="' . esc_attr( str_replace( '_', '-', $item[0] ) ); ?>" value="1" /> <?php echo esc_html( $item[1] ); ?></label><br />
+
+                                                                <?php endforeach; ?>
+
+                                                        </fieldset>
+                                                </td>
+                                        </tr>
+                                </tbody>
+                        </table>
+
+                        <fieldset class="submit">
+                                <input class="button-primary" type="submit" name="submit" value="<?php esc_attr_e( 'Repair Items', 'buddypress' ); ?>" />
+                                <?php wp_nonce_field( 'bp-do-counts' ); ?>
+                        </fieldset>
+                </form>
+        </div>
+        <?php
+}
+
+/**
+ * Handle the processing and feedback of the admin tools page.
+ *
+ * @since BuddyPress (2.0.0)
+ */
+function bp_admin_repair_handler() {
+        if ( ! bp_is_post_request() ) {
+                return;
+        }
+
+        check_admin_referer( 'bp-do-counts' );
+
+        // Stores messages
+        $messages = array();
+
+        wp_cache_flush();
+
+        foreach ( (array) bp_admin_repair_list() as $item ) {
+                if ( isset( $item[2] ) && isset( $_POST[$item[0]] ) && 1 === absint( $_POST[$item[0]] ) && is_callable( $item[2] ) ) {
+                        $messages[] = call_user_func( $item[2] );
+                }
+        }
+
+        if ( count( $messages ) ) {
+                foreach ( $messages as $message ) {
+                        bp_admin_tools_feedback( $message[1] );
+                }
+        }
+}
+add_action( bp_core_admin_hook(), 'bp_admin_repair_handler' );
+
+/**
+ * Get the array of the repair list.
+ *
+ * @return array
+ */
+function bp_admin_repair_list() {
+        // Members:
+        // - member count
+        $repair_list = array(
+                20 => array(
+                        'bp-total-member-count',
+                        __( 'Count total members', 'buddypress' ),
+                        'bp_admin_repair_count_members',
+                ),
+        );
+
+        // Friends:
+        // - user friend count
+        if ( bp_is_active( 'friends' ) ) {
+                $repair_list[0] = array(
+                        'bp-user-friends',
+                        __( 'Count friends for each user', 'buddypress' ),
+                        'bp_admin_repair_friend_count',
+                );
+        }
+
+        // Groups:
+        // - user group count
+        if ( bp_is_active( 'groups' ) ) {
+                $repair_list[10] = array(
+                        'bp-group-count',
+                        __( 'Count groups for each user', 'buddypress' ),
+                        'bp_admin_repair_group_count',
+                );
+        }
+
+        ksort( $repair_list );
+
+        return (array) apply_filters( 'bp_repair_list', $repair_list );
+}
+
+/**
+ * Recalculate friend counts for each user.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @return array
+ */
+function bp_admin_repair_friend_count() {
+        global $wpdb, $bp;
+
+        if ( ! bp_is_active( 'friends' ) ) {
+                return;
+        }
+
+        $statement = __( 'Counting the number of friends for each user&hellip; %s', 'buddypress' );
+        $result    = __( 'Failed!', 'buddypress' );
+
+        $sql_delete = "DELETE FROM {$wpdb->usermeta} WHERE meta_key IN ( 'total_friend_count' );";
+        if ( is_wp_error( $wpdb->query( $sql_delete ) ) ) {
+                return array( 1, sprintf( $statement, $result ) );
+        }
+
+        // Walk through all users on the site
+        $total_users = $wpdb->get_row( "SELECT count(ID) as c FROM {$wpdb->users}" )->c;
+
+        $updated = array();
+        if ( $total_users > 0 ) {
+                $per_query = 500;
+                $offset = 0;
+                while ( $offset < $total_users ) {
+                        // Only bother updating counts for users who actually have friendships
+                        $friendships = $wpdb->get_results( $wpdb->prepare( "SELECT initiator_user_id, friend_user_id FROM {$bp->friends->table_name} WHERE is_confirmed = 1 AND ( ( initiator_user_id > %d AND initiator_user_id <= %d ) OR ( friend_user_id > %d AND friend_user_id <= %d ) )", $offset, $offset + $per_query, $offset, $offset + $per_query ) );
+
+                        // The previous query will turn up duplicates, so we
+                        // filter them here
+                        foreach ( $friendships as $friendship ) {
+                                if ( ! isset( $updated[ $friendship->initiator_user_id ] ) ) {
+                                        BP_Friends_Friendship::total_friend_count( $friendship->initiator_user_id );
+                                        $updated[ $friendship->initiator_user_id ] = 1;
+                                }
+
+                                if ( ! isset( $updated[ $friendship->friend_user_id ] ) ) {
+                                        BP_Friends_Friendship::total_friend_count( $friendship->friend_user_id );
+                                        $updated[ $friendship->friend_user_id ] = 1;
+                                }
+                        }
+
+                        $offset += $per_query;
+                }
+        } else {
+                return array( 2, sprintf( $statement, $result ) );
+        }
+
+        return array( 0, sprintf( $statement, __( 'Complete!', 'buddypress' ) ) );
+}
+
+/**
+ * Recalculate group counts for each user.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @return array
+ */
+function bp_admin_repair_group_count() {
+        global $wpdb, $bp;
+
+        if ( ! bp_is_active( 'groups' ) ) {
+                return;
+        }
+
+        $statement = __( 'Counting the number of groups for each user&hellip; %s', 'buddypress' );
+        $result    = __( 'Failed!', 'buddypress' );
+
+        $sql_delete = "DELETE FROM {$wpdb->usermeta} WHERE meta_key IN ( 'total_group_count' );";
+        if ( is_wp_error( $wpdb->query( $sql_delete ) ) ) {
+                return array( 1, sprintf( $statement, $result ) );
+        }
+
+        // Walk through all users on the site
+        $total_users = $wpdb->get_row( "SELECT count(ID) as c FROM {$wpdb->users}" )->c;
+
+        if ( $total_users > 0 ) {
+                $per_query = 500;
+                $offset = 0;
+                while ( $offset < $total_users ) {
+                        // But only bother to update counts for users that have groups
+                        $users = $wpdb->get_col( $wpdb->prepare( "SELECT user_id FROM {$bp->groups->table_name_members} WHERE is_confirmed = 1 AND is_banned = 0 AND user_id > %d AND user_id <= %d", $offset, $offset + $per_query ) );
+
+                        foreach ( $users as $user ) {
+                                BP_Groups_Member::refresh_total_group_count_for_user( $user );
+                        }
+
+                        $offset += $per_query;
+                }
+        } else {
+                return array( 2, sprintf( $statement, $result ) );
+        }
+
+        return array( 0, sprintf( $statement, __( 'Complete!', 'buddypress' ) ) );
+}
+
+/**
+ * Recalculate the total number of active site members.
+ *
+ * @since BuddyPress (2.0.0)
+ */
+function bp_admin_repair_count_members() {
+        $statement = __( 'Counting the number of active members on the site&hellip; %s', 'buddypress' );
+        delete_transient( 'bp_active_member_count' );
+        bp_core_get_active_member_count();
+        return array( 0, sprintf( $statement, __( 'Complete!', 'buddypress' ) ) );
+}
+
+/**
+ * Assemble admin notices relating success/failure of repair processes.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param string $message Feedback message.
+ * @param unknown $class Unused.
+ */
+function bp_admin_tools_feedback( $message, $class = false ) {
+        if ( is_string( $message ) ) {
+                $message = '<p>' . $message . '</p>';
+                $class = $class ? $class : 'updated';
+        } elseif ( is_wp_error( $message ) ) {
+                $errors = $message->get_error_messages();
+
+                switch ( count( $errors ) ) {
+                        case 0:
+                                return false;
+                                break;
+
+                        case 1:
+                                $message = '<p>' . $errors[0] . '</p>';
+                                break;
+
+                        default:
+                                $message = '<ul>' . "\n\t" . '<li>' . implode( '</li>' . "\n\t" . '<li>', $errors ) . '</li>' . "\n" . '</ul>';
+                                break;
+                }
+
+                $class = $class ? $class : 'error';
+        } else {
+                return false;
+        }
+
+        $message = '<div id="message" class="' . esc_attr( $class ) . '">' . $message . '</div>';
+        $message = str_replace( "'", "\'", $message );
+        $lambda  = create_function( '', "echo '$message';" );
+
+        add_action( 'admin_notices', $lambda );
+
+        return $lambda;
+}

bp-core/bp-core-admin.php

@@ -118 +118 @@
                 require( $this->admin_dir . 'bp-core-functions.php'  );
                 require( $this->admin_dir . 'bp-core-components.php' );
                 require( $this->admin_dir . 'bp-core-slugs.php'      );
+                require( $this->admin_dir . 'bp-core-tools.php'      );
         }
 
         /**
@@ -242 +243 @@
                         'bp_core_admin_settings'
                 );
 
+                $hooks[] = add_submenu_page(
+                        $this->settings_page,
+                        __( 'BuddyPress Tools', 'buddypress' ),
+                        __( 'BuddyPress Tools', 'buddypress' ),
+                        'manage_options',
+                        'bp-tools',
+                        'bp_core_admin_tools'
+                );
+
                 // Fudge the highlighted subnav item when on a BuddyPress admin page
                 foreach( $hooks as $hook ) {
                         add_action( "admin_head-$hook", 'bp_core_modify_admin_menu_highlight' );
@@ -342 +352 @@
                 }
 
                 /** Avatar upload for users or groups ************************************/
-                
+
                 if ( ! empty( $avatar_setting ) ) {
                     // Allow avatar uploads
                     add_settings_field( 'bp-disable-avatar-uploads', __( 'Avatar Uploads',   'buddypress' ), 'bp_admin_setting_callback_avatar_uploads',   'buddypress', $avatar_setting );
@@ -400 +410 @@
                 // Settings pages
                 remove_submenu_page( $this->settings_page, 'bp-page-settings' );
                 remove_submenu_page( $this->settings_page, 'bp-settings'      );
+                remove_submenu_page( $this->settings_page, 'bp-tools'         );
 
                 // About and Credits pages
                 remove_submenu_page( 'index.php', 'bp-about'   );