Changeset 8491 for trunk/src/bp-activity/bp-activity-classes.php

Timestamp:

06/09/2014 06:33:05 PM (9 years ago)

Author:

boonebgorges

Message:

Disable COUNT queries by default in bp_activity_get() stack

The COUNT query performed to get the total activity count has proven to be a
performance bottleneck on large sites. Moreover, the way that activity items
are displayed on the front end (using the Load More link) means that the total
count is not actually used by BuddyPress in most cases. To reduce query
overhead, we introduce a 'count_total' parameter to the bp_activity_get()
stack, and set it to false by default.

For backward compatibility, a few additional changes are introduced:

• In the activity-loop.php template, the <noscript> pagination markup is removed. In its place, the Load More link is refactored so that it loads the next available page of activity items.
• The mechanism used to determine whether there are more activity items to show (bp_activity_has_more_items()) has been refined; when no COUNT query takes place, we query for the $per_page value + 1 to infer whether more items are available.

Fixes #5629

Props boonebgorges, r-a-y

File:

• trunk/src/bp-activity/bp-activity-classes.php (modified) (6 diffs)

trunk/src/bp-activity/bp-activity-classes.php

@@ -268 +268 @@
      *     @type bool $update_meta_cache Whether to pre-fetch metadata for
      *           queried activity items. Default: true.
+     *     @type string|bool $count_total If true, an additional DB query
+     *           is run to count the total activity items for the query.
+     *           Default: false.
      * }
      * @return array The array returned has two keys:
@@ -312 +315 @@
             'spam'              => 'ham_only', // Spam status
             'update_meta_cache' => true,
+            'count_total'       => false,
         );
         $r = wp_parse_args( $args, $defaults );
@@ -412 +416 @@
         $per_page = absint( $per_page );
 
+        $retval = array(
+            'activities'     => null,
+            'total'          => null,
+            'has_more_items' => null,
+        );
+
         // Filter and return true to use the legacy query structure (not recommended)
         if ( apply_filters( 'bp_use_legacy_activity_query', false, __METHOD__, $r ) ) {
@@ -432 +442 @@
 
             if ( ! empty( $per_page ) && ! empty( $page ) ) {
-                $activity_ids_sql .= $wpdb->prepare( " LIMIT %d, %d", absint( ( $page - 1 ) * $per_page ), $per_page );
+                // We query for $per_page + 1 items in order to
+                // populate the has_more_items flag
+                $activity_ids_sql .= $wpdb->prepare( " LIMIT %d, %d", absint( ( $page - 1 ) * $per_page ), $per_page + 1 );
             }
 
@@ -438 +450 @@
 
             $activity_ids = $wpdb->get_col( $activity_ids_sql );
-            $activities   = self::get_activity_data( $activity_ids );
-        }
-
-        $total_activities_sql = apply_filters( 'bp_activity_total_activities_sql', "SELECT count(DISTINCT a.id) FROM {$bp->activity->table_name} a {$join_sql} {$where_sql}", $where_sql, $sort );
-        $total_activities     = $wpdb->get_var( $total_activities_sql );
+
+            $retval['has_more_items'] = ! empty( $per_page ) && count( $activity_ids ) > $per_page;
+
+            // If we've fetched more than the $per_page value, we
+            // can discard the extra now
+            if ( ! empty( $per_page ) && count( $activity_ids ) === $per_page + 1 ) {
+                array_pop( $activity_ids );
+            }
+
+            $activities = self::get_activity_data( $activity_ids );
+        }
 
         // Get the fullnames of users so we don't have to query in the loop
@@ -466 +484 @@
         $activities = BP_Activity_Activity::generate_action_strings( $activities );
 
+        $retval['activities'] = $activities;
+
         // If $max is set, only return up to the max results
-        if ( !empty( $max ) ) {
-            if ( (int) $total_activities > (int) $max )
-                $total_activities = $max;
-        }
-
-        return array( 'activities' => $activities, 'total' => (int) $total_activities );
+        if ( ! empty( $r['count_total'] ) ) {
+
+            $total_activities_sql = apply_filters( 'bp_activity_total_activities_sql', "SELECT count(DISTINCT a.id) FROM {$bp->activity->table_name} a {$join_sql} {$where_sql}", $where_sql, $sort );
+            $total_activities     = $wpdb->get_var( $total_activities_sql );
+
+            if ( !empty( $max ) ) {
+                if ( (int) $total_activities > (int) $max )
+                    $total_activities = $max;
+            }
+
+            $retval['total'] = $total_activities;
+        }
+
+        return $retval;
     }