Changeset 5460

Timestamp:

12/08/2011 02:57:38 AM (13 years ago)

Author:

boonebgorges

Message:

Introduces automatic meta cache features.
Introduces bp_update_meta_cache(), for collecting all metadata associated with an object or with multiple objects in one fell swoop, and adding it to the WP cache for quicker access later
Introduces bp_groups_update_meta_cache(), for collecting groupmeta at the beginning of a group loop
Modifies the BP_Groups_Group object so that groupmeta is fetched in the populate() and get() methods
Fixes #3799

Location:

trunk

Files:

• bp-core/bp-core-cache.php (modified) (1 diff)
• bp-groups/bp-groups-cache.php (modified) (1 diff)
• bp-groups/bp-groups-classes.php (modified) (3 diffs)
• bp-groups/bp-groups-functions.php (modified) (2 diffs)

trunk/bp-core/bp-core-cache.php

@@ -49 +49 @@
 add_action( 'bp_core_render_notice', 'bp_core_clear_cache' );
 
+/**
+ * Update the metadata cache for the specified objects.
+ *
+ * @since 1.6
+ * @uses $wpdb WordPress database object for queries.
+ * @uses $bp BuddyPress global object.
+ *
+ * @param array $args See $defaults definition for more details
+ * @return mixed Metadata cache for the specified objects, or false on failure.
+ */
+function bp_update_meta_cache( $args = array() ) {
+    global $bp, $wpdb;
+    
+    $defaults = array(
+        'object_ids'       => array(), // Comma-separated list or array of item ids
+        'object_type'      => '',      // Canonical component id: groups, members, etc
+        'meta_table'       => '',      // Name of the table containing the metadata
+        'object_column'    => '',      // DB column for the object ids (group_id, etc)
+        'cache_key_prefix' => ''       // Prefix to use when creating cache key names. Eg
+                           //    'bp_groups_groupmeta'
+    );
+    $r = wp_parse_args( $args, $defaults );
+    extract( $r );
+        
+    if ( empty( $object_ids ) || empty( $object_type ) || empty( $meta_table ) ) {
+        return false;
+    }
+    
+    if ( empty( $cache_key_prefix ) ) {
+        $cache_key_prefix = $meta_table;
+    }
+    
+    if ( empty( $object_column ) ) {
+        $object_column = $object_type . '_id';
+    }
+
+    if ( !is_array( $object_ids ) ) {
+        $object_ids = preg_replace( '|[^0-9,]|', '', $object_ids );
+        $object_ids = explode( ',', $object_ids );
+    }
+
+    $object_ids = array_map( 'intval', $object_ids );
+
+    $cache = array();
+    
+    // Get meta info
+    $id_list   = join( ',', $object_ids );
+    $meta_list = $wpdb->get_results( $wpdb->prepare( "SELECT $object_column, meta_key, meta_value FROM $meta_table WHERE group_id IN ($id_list)" ), ARRAY_A );
+
+    if ( !empty( $meta_list ) ) {
+        foreach ( $meta_list as $metarow ) {
+            $mpid = intval( $metarow[$object_column] );
+            $mkey = $metarow['meta_key'];
+            $mval = $metarow['meta_value'];
+
+            // Force subkeys to be array type:
+            if ( !isset( $cache[$mpid] ) || !is_array( $cache[$mpid] ) )
+                $cache[$mpid] = array();
+            if ( !isset( $cache[$mpid][$mkey] ) || !is_array( $cache[$mpid][$mkey] ) )
+                $cache[$mpid][$mkey] = array();
+
+            // Add a value to the current pid/key:
+            $cache[$mpid][$mkey][] = $mval;
+        }
+    }
+    
+    foreach ( $object_ids as $id ) {
+        if ( ! isset($cache[$id]) )
+            $cache[$id] = array();
+    
+        foreach( $cache[$id] as $meta_key => $meta_value ) {
+            wp_cache_set( $cache_key_prefix . '_' . $id . '_' . $meta_key, $meta_value, 'bp' );
+        }
+    }
+
+    return $cache;
+}
+
 ?>

trunk/bp-groups/bp-groups-cache.php

@@ -12 +12 @@
 // Exit if accessed directly
 if ( !defined( 'ABSPATH' ) ) exit;
+
+/**
+ * Slurps up groupmeta
+ *
+ * This function is called in two places in the BP_Groups_Group class:
+ *   - in the populate() method, when single group objects are populated
+ *   - in the get() method, when multiple groups are queried
+ *
+ * It grabs all groupmeta associated with all of the groups passed in $group_ids and adds it to
+ * the WP cache. This improves efficiency when using groupmeta inline
+ *
+ * @param int|str|array $group_ids Accepts a single group_id, or a comma-separated list or array of
+ *    group ids
+ */
+function bp_groups_update_meta_cache( $group_ids = false ) {
+    global $bp;
+    
+    $cache_args = array(
+        'object_ids'       => $group_ids,
+        'object_type'      => $bp->groups->id,
+        'object_column'    => 'group_id',
+        'meta_table'       => $bp->groups->table_name_groupmeta,
+        'cache_key_prefix' => 'bp_groups_groupmeta'
+    );
+    
+    bp_update_meta_cache( $cache_args );
+}
 
 function groups_clear_group_object_cache( $group_id ) {

trunk/bp-groups/bp-groups-classes.php

@@ -31 +31 @@
         global $wpdb, $bp;
 
-        if ( $group = $wpdb->get_row( $wpdb->prepare( "SELECT g.*, gm.meta_value as last_activity, gm2.meta_value as total_member_count FROM {$bp->groups->table_name} g, {$bp->groups->table_name_groupmeta} gm, {$bp->groups->table_name_groupmeta} gm2 WHERE g.id = gm.group_id AND g.id = gm2.group_id AND gm.meta_key = 'last_activity' AND gm2.meta_key = 'total_member_count' AND g.id = %d", $this->id ) ) ) {
+        if ( $group = $wpdb->get_row( $wpdb->prepare( "SELECT g.* FROM {$bp->groups->table_name} g WHERE g.id = %d", $this->id ) ) ) {          
+            bp_groups_update_meta_cache( $this->id );
+                        
             $this->id                 = $group->id;
             $this->creator_id         = $group->creator_id;
@@ -40 +42 @@
             $this->enable_forum       = $group->enable_forum;
             $this->date_created       = $group->date_created;
-            $this->last_activity      = $group->last_activity;
-            $this->total_member_count = $group->total_member_count;
+            $this->last_activity      = groups_get_groupmeta( $this->id, 'last_activity' );
+            $this->total_member_count = groups_get_groupmeta( $this->id, 'total_member_count' );
             $this->is_member          = BP_Groups_Member::check_is_member( bp_loggedin_user_id(), $this->id );
 
@@ -368 +370 @@
         $total_groups     = $wpdb->get_var( $total_groups_sql );
 
+        $group_ids = array();
+        foreach ( (array)$paged_groups as $group ) {
+            $group_ids[] = $group->id;
+        }
+        
         /* Populate some extra information instead of querying each time in the loop */
         if ( !empty( $populate_extras ) ) {
-            $group_ids = array();
-            foreach ( (array)$paged_groups as $group ) $group_ids[] = $group->id;
             $group_ids = $wpdb->escape( join( ',', (array)$group_ids ) );
             $paged_groups = BP_Groups_Group::get_group_extras( $paged_groups, $group_ids, $type );
         }
+        
+        // Grab all groupmeta
+        bp_groups_update_meta_cache( $group_ids );
 
         unset( $sql, $total_sql );

trunk/bp-groups/bp-groups-functions.php

@@ -47 +47 @@
     if ( !$group = wp_cache_get( $cache_key, 'bp' ) ) {
         $group = new BP_Groups_Group( $group_id, true, $load_users );
-        wp_cache_set( $cache_key, $group, 'bp' );
+        wp_cache_set( $cache_key, $group, 'bp' );   
     }
 
@@ -919 +919 @@
         $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
 
-        $metas = wp_cache_get( 'bp_groups_groupmeta_' . $group_id . '_' . $meta_key, 'bp' );        
+        $metas = wp_cache_get( 'bp_groups_groupmeta_' . $group_id . '_' . $meta_key, 'bp' );
         if ( false === $metas ) {
             $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d AND meta_key = %s", $group_id, $meta_key) );