Ticket #7435: 7435.diff

src/bp-xprofile/bp-xprofile-cache.php

@@ -287 +287 @@
 }
 add_action( 'xprofile_field_before_save', 'bp_xprofile_reset_fields_by_name_cache_incrementor' );
 
+/**
+ * Resets all incremented bp_xprofile_groups caches.
+ *
+ * @since 4.0.0
+ */
+function bp_xprofile_reset_groups_cache_incrementor() {
+        bp_core_reset_incrementor( 'bp_xprofile_groups' );
+}
+add_action( 'xprofile_group_after_delete', 'bp_xprofile_reset_groups_cache_incrementor' );
+add_action( 'xprofile_group_after_save', 'bp_xprofile_reset_groups_cache_incrementor' );
+add_action( 'xprofile_field_after_delete', 'bp_xprofile_reset_groups_cache_incrementor' );
+add_action( 'xprofile_field_after_save', 'bp_xprofile_reset_groups_cache_incrementor' );
+
 // List actions to clear super cached pages on, if super cache is installed.
 add_action( 'xprofile_updated_profile', 'bp_core_clear_cache' );

src/bp-xprofile/classes/class-bp-xprofile-field.php

@@ -977 +977 @@
                 $sql        = $wpdb->prepare( "UPDATE {$table_name} SET field_order = %d, group_id = %d WHERE id = %d", $position, $field_group_id, $field_id );
                 $parent     = $wpdb->query( $sql );
 
+                $retval = false;
+
                 // Update $field_id with new $position and $field_group_id.
                 if ( ! empty( $parent ) && ! is_wp_error( $parent ) ) {
 
@@ -984 +986 @@
                         $sql = $wpdb->prepare( "UPDATE {$table_name} SET group_id = %d WHERE parent_id = %d", $field_group_id, $field_id );
                         $wpdb->query( $sql );
 
-                        // Invalidate profile field cache.
+                        // Invalidate profile field and group query cache.
                         wp_cache_delete( $field_id, 'bp_xprofile_fields' );
 
-                        return $parent;
+                        $retval = $parent;
                 }
 
-                return false;
+                bp_core_reset_incrementor( 'bp_xprofile_groups' );
+
+                return $retval;
         }
 
         /**

src/bp-xprofile/classes/class-bp-xprofile-group.php

@@ -288 +288 @@
                         'data'  => array(),
                 );
 
-                // WHERE.
-                if ( ! empty( $r['profile_group_id'] ) ) {
-                        $where_sql = $wpdb->prepare( 'WHERE g.id = %d', $r['profile_group_id'] );
-                } elseif ( $r['exclude_groups'] ) {
-                        $exclude   = join( ',', wp_parse_id_list( $r['exclude_groups'] ) );
-                        $where_sql = "WHERE g.id NOT IN ({$exclude})";
-                } else {
-                        $where_sql = '';
-                }
-
                 $bp = buddypress();
 
-                // Include or exclude empty groups.
-                if ( ! empty( $r['hide_empty_groups'] ) ) {
-                        $group_ids = $wpdb->get_col( "SELECT DISTINCT g.id FROM {$bp->profile->table_name_groups} g INNER JOIN {$bp->profile->table_name_fields} f ON g.id = f.group_id {$where_sql} ORDER BY g.group_order ASC" );
-                } else {
-                        $group_ids = $wpdb->get_col( "SELECT DISTINCT g.id FROM {$bp->profile->table_name_groups} g {$where_sql} ORDER BY g.group_order ASC" );
-                }
+                $group_ids = self::get_group_ids( $r );
 
                 // Get all group data.
                 $groups = self::get_group_data( $group_ids );
@@ -326 +311 @@
                         return $groups;
                 }
 
-                // Setup IN query from group IDs.
-                $group_ids_in = implode( ',', (array) $group_ids );
-
-                // Support arrays and comma-separated strings.
-                $exclude_fields_cs = wp_parse_id_list( $r['exclude_fields'] );
-
-                // Visibility - Handled here so as not to be overridden by sloppy use of the
-                // exclude_fields parameter. See bp_xprofile_get_hidden_fields_for_user().
-                $hidden_user_fields = bp_xprofile_get_hidden_fields_for_user( $r['user_id'] );
-                $exclude_fields_cs  = array_merge( $exclude_fields_cs, $hidden_user_fields );
-                $exclude_fields_cs  = implode( ',', $exclude_fields_cs );
-
-                // Set up NOT IN query for excluded field IDs.
-                if ( ! empty( $exclude_fields_cs ) ) {
-                        $exclude_fields_sql = "AND id NOT IN ({$exclude_fields_cs})";
-                } else {
-                        $exclude_fields_sql = '';
-                }
-
-                // Set up IN query for included field IDs.
-                $include_field_ids = array();
-
-                // Member-type restrictions.
-                if ( bp_get_member_types() ) {
-                        if ( $r['user_id'] || false !== $r['member_type'] ) {
-                                $member_types = $r['member_type'];
-                                if ( $r['user_id'] ) {
-                                        $member_types = bp_get_member_type( $r['user_id'], false );
-                                        if ( empty( $member_types ) ) {
-                                                $member_types = array( 'null' );
-                                        }
-                                }
-
-                                $member_types_fields = BP_XProfile_Field::get_fields_for_member_type( $member_types );
-                                $include_field_ids += array_keys( $member_types_fields );
-                        }
-                }
-
-                $in_sql = '';
-                if ( ! empty( $include_field_ids ) ) {
-                        $include_field_ids_cs = implode( ',', array_map( 'intval', $include_field_ids ) );
-                        $in_sql = " AND id IN ({$include_field_ids_cs}) ";
-                }
-
-                // Fetch the fields.
-                $field_ids = $wpdb->get_col( "SELECT id FROM {$bp->profile->table_name_fields} WHERE group_id IN ( {$group_ids_in} ) AND parent_id = 0 {$exclude_fields_sql} {$in_sql} ORDER BY field_order" );
+                $field_ids = self::get_group_field_ids( $group_ids, $r );
 
                 foreach( $groups as $group ) {
                         $group->fields = array();
@@ -498 +438 @@
                 return $groups;
         }
 
+        /**
+         * Gets group IDs, based on passed parameters.
+         *
+         * @since 4.0.0
+         *
+         * @param array $args {
+         *    Array of optional arguments:
+         *    @type int   $profile_group_id  Limit results to a single profile group. Default false.
+         *    @type array $exclude_groups    Comma-separated list or array of group IDs to exclude. Default false.
+         *    @type bool  $hide_empty_groups True to hide groups that don't have any fields. Default: false.
+         * }
+         * @return array
+         */
+        public static function get_group_ids( $args = array() ) {
+                global $wpdb;
+
+                $r = array_merge(
+                        array(
+                                'profile_group_id'  => false,
+                                'exclude_groups'    => false,
+                                'hide_empty_groups' => false,
+                        ),
+                        $args
+                );
+
+                $bp = buddypress();
+
+                if ( ! empty( $r['profile_group_id'] ) ) {
+                        $where_sql = $wpdb->prepare( 'WHERE g.id = %d', $r['profile_group_id'] );
+                } elseif ( $r['exclude_groups'] ) {
+                        $exclude   = join( ',', wp_parse_id_list( $r['exclude_groups'] ) );
+                        $where_sql = "WHERE g.id NOT IN ({$exclude})";
+                } else {
+                        $where_sql = '';
+                }
+
+                // Include or exclude empty groups.
+                if ( ! empty( $r['hide_empty_groups'] ) ) {
+                        $group_ids_sql = "SELECT DISTINCT g.id FROM {$bp->profile->table_name_groups} g INNER JOIN {$bp->profile->table_name_fields} f ON g.id = f.group_id {$where_sql} ORDER BY g.group_order ASC";
+                } else {
+                        $group_ids_sql = "SELECT DISTINCT g.id FROM {$bp->profile->table_name_groups} g {$where_sql} ORDER BY g.group_order ASC";
+                }
+
+                $cached = bp_core_get_incremented_cache( $group_ids_sql, 'bp_xprofile_groups' );
+                if ( false === $cached ) {
+                        $group_ids = $wpdb->get_col( $group_ids_sql );
+                        bp_core_set_incremented_cache( $group_ids_sql, 'bp_xprofile_groups', $group_ids );
+                } else {
+                        $group_ids = $cached;
+                }
+
+                return array_map( 'intval', $group_ids );
+        }
+
+        /**
+         * Gets group field IDs, based on passed parameters.
+         *
+         * @since 4.0.0
+         *
+         * @param array $group_ids Array of group IDs.
+         * @param array $args {
+         *    Array of optional arguments:
+         *      @type array        $exclude_fields    Comma-separated list or array of field IDs to exclude.
+         *                                            Default empty.
+         *      @type int          $user_id           Limit results to fields associated with a given user's
+         *                                            member type. Default empty.
+         *      @type array|string $member_type       Limit fields by those restricted to a given member type, or array of
+         *                                            member types. If `$user_id` is provided, the value of `$member_type`
+         *                                            is honored.
+         * }
+         * @return array
+         */
+        public static function get_group_field_ids( $group_ids, $args = array() ) {
+                global $wpdb;
+
+                $r = array_merge(
+                        array(
+                                'exclude_fields' => false,
+                                'user_id' => false,
+                                'member_type' => false,
+                        ),
+                        $args
+                );
+
+                $bp = buddypress();
+
+                // Setup IN query from group IDs.
+                if ( empty( $group_ids ) ) {
+                        $group_ids = array( 0 );
+                }
+                $group_ids_in = implode( ',', array_map( 'intval', $group_ids ) );
+
+                // Support arrays and comma-separated strings.
+                $exclude_fields_cs = wp_parse_id_list( $r['exclude_fields'] );
+
+                // Visibility - Handled here so as not to be overridden by sloppy use of the
+                // exclude_fields parameter. See bp_xprofile_get_hidden_fields_for_user().
+                $hidden_user_fields = bp_xprofile_get_hidden_fields_for_user( $r['user_id'] );
+                $exclude_fields_cs  = array_merge( $exclude_fields_cs, $hidden_user_fields );
+                $exclude_fields_cs  = implode( ',', $exclude_fields_cs );
+
+                // Set up NOT IN query for excluded field IDs.
+                if ( ! empty( $exclude_fields_cs ) ) {
+                        $exclude_fields_sql = "AND id NOT IN ({$exclude_fields_cs})";
+                } else {
+                        $exclude_fields_sql = '';
+                }
+
+                // Set up IN query for included field IDs.
+                $include_field_ids = array();
+
+                // Member-type restrictions.
+                if ( bp_get_member_types() ) {
+                        if ( $r['user_id'] || false !== $r['member_type'] ) {
+                                $member_types = $r['member_type'];
+                                if ( $r['user_id'] ) {
+                                        $member_types = bp_get_member_type( $r['user_id'], false );
+                                        if ( empty( $member_types ) ) {
+                                                $member_types = array( 'null' );
+                                        }
+                                }
+
+                                $member_types_fields = BP_XProfile_Field::get_fields_for_member_type( $member_types );
+                                $include_field_ids += array_keys( $member_types_fields );
+                        }
+                }
+
+                $in_sql = '';
+                if ( ! empty( $include_field_ids ) ) {
+                        $include_field_ids_cs = implode( ',', array_map( 'intval', $include_field_ids ) );
+                        $in_sql = " AND id IN ({$include_field_ids_cs}) ";
+                }
+
+                $field_ids_sql = "SELECT id FROM {$bp->profile->table_name_fields} WHERE group_id IN ( {$group_ids_in} ) AND parent_id = 0 {$exclude_fields_sql} {$in_sql} ORDER BY field_order";
+
+                $cached = bp_core_get_incremented_cache( $field_ids_sql, 'bp_xprofile_groups' );
+                if ( false === $cached ) {
+                        $field_ids = $wpdb->get_col( $field_ids_sql );
+                        bp_core_set_incremented_cache( $field_ids_sql, 'bp_xprofile_groups', $field_ids );
+                } else {
+                        $field_ids = $cached;
+                }
+
+                return array_map( 'intval', $field_ids );
+        }
+
         /**
          * Get data about a set of groups, based on IDs.
          *
@@ -613 +699 @@
                         return false;
                 }
 
-                // Purge profile field group cache.
+                // Purge profile field group and group query caches.
                 wp_cache_delete( 'all', 'bp_xprofile_groups' );
+                bp_core_reset_incrementor( 'bp_xprofile_groups' );
 
                 $bp = buddypress();
 

tests/phpunit/testcases/xprofile/class-bp-xprofile-group.php

@@ -441 +441 @@
 
                 $this->assertSame( "Test ' Name", $e1->name );
         }
+
+        /**
+         * @group BP7435
+         * @group cache
+         */
+        public function test_group_ids_query_should_be_cached() {
+                global $wpdb;
+
+                $group_ids   = array( 1 ); // Default group.
+                $group_ids[] = self::factory()->xprofile_group->create();
+                $group_ids[] = self::factory()->xprofile_group->create();
+                $group_ids[] = self::factory()->xprofile_group->create();
+
+                $params_1 = array(
+                        'exclude_groups' => false,
+                );
+
+                $params_2 = array(
+                        'exclude_groups' => array( 0 ),
+                );
+
+                // Prime cache.
+                $found_1 = BP_XProfile_Group::get_group_ids( $params_1 );
+                $this->assertEqualSets( $group_ids, $found_1 );
+
+                $num_queries = $wpdb->num_queries;
+
+                $found_1 = BP_XProfile_Group::get_group_ids( $params_1 );
+                $this->assertEqualSets( $group_ids, $found_1 );
+                $this->assertSame( $num_queries, $wpdb->num_queries );
+
+                // Different parameters should trigger a cache miss.
+                $found_2 = BP_XProfile_Group::get_group_ids( $params_2 );
+                $this->assertEqualSets( $group_ids, $found_2 );
+                $this->assertNotSame( $num_queries, $wpdb->num_queries );
+        }
+
+        /**
+         * @group BP7435
+         * @group cache
+         */
+        public function test_group_ids_query_cache_should_be_busted_on_group_delete() {
+                $group_ids    = array( 1 ); // Default group.
+                $group_ids[1] = self::factory()->xprofile_group->create();
+                $group_ids[2] = self::factory()->xprofile_group->create();
+                $group_ids[3] = self::factory()->xprofile_group->create();
+
+                // Prime cache.
+                $found = BP_XProfile_Group::get_group_ids();
+                $this->assertContains( $group_ids[1], $found );
+
+                $g1 = new BP_XProfile_Group( $group_ids[1] );
+                $g1->delete();
+
+                $found = BP_XProfile_Group::get_group_ids();
+                $this->assertNotContains( $group_ids[1], $found );
+        }
+
+        /**
+         * @group BP7435
+         * @group cache
+         */
+        public function test_group_ids_query_cache_should_be_busted_on_group_save() {
+                global $wpdb;
+
+                $group_ids    = array( 1 ); // Default group.
+                $group_ids[1] = self::factory()->xprofile_group->create();
+                $group_ids[2] = self::factory()->xprofile_group->create();
+                $group_ids[3] = self::factory()->xprofile_group->create();
+
+                // Prime cache.
+                $found = BP_XProfile_Group::get_group_ids();
+                $this->assertContains( $group_ids[1], $found );
+
+                $g1 = new BP_XProfile_Group( $group_ids[1] );
+                $g1->save();
+
+                $num_queries = $wpdb->num_queries;
+
+                $found = BP_XProfile_Group::get_group_ids();
+                $this->assertNotSame( $num_queries, $wpdb->num_queries );
+        }
+
+        /**
+         * @group BP7435
+         * @group cache
+         */
+        public function test_group_ids_query_cache_should_be_busted_on_field_save() {
+                global $wpdb;
+
+                $group_ids    = array( 1 ); // Default group.
+                $group_ids[1] = self::factory()->xprofile_group->create();
+                $group_ids[2] = self::factory()->xprofile_group->create();
+                $group_ids[3] = self::factory()->xprofile_group->create();
+
+                $f = self::factory()->xprofile_field->create( array(
+                        'field_group_id' => $group_ids[1],
+                ) );
+                $field = new BP_XProfile_Field( $f );
+
+                // Prime cache.
+                $found = BP_XProfile_Group::get_group_ids();
+                $this->assertContains( $group_ids[1], $found );
+
+                $field->save();
+
+                $num_queries = $wpdb->num_queries;
+
+                $found = BP_XProfile_Group::get_group_ids();
+                $this->assertNotSame( $num_queries, $wpdb->num_queries );
+        }
+
+        /**
+         * @group BP7435
+         * @group cache
+         */
+        public function test_group_ids_query_cache_should_be_busted_on_field_delete() {
+                $group_ids    = array( 1 ); // Default group.
+                $group_ids[1] = self::factory()->xprofile_group->create();
+                $group_ids[2] = self::factory()->xprofile_group->create();
+                $group_ids[3] = self::factory()->xprofile_group->create();
+
+                $f = self::factory()->xprofile_field->create( array(
+                        'field_group_id' => $group_ids[1],
+                ) );
+                $field = new BP_XProfile_Field( $f );
+
+                $args = array(
+                        'hide_empty_groups' => true,
+                );
+
+                // Prime cache.
+                $found = BP_XProfile_Group::get_group_ids( $args );
+                $this->assertContains( $group_ids[1], $found );
+
+                $field->delete();
+
+                $found = BP_XProfile_Group::get_group_ids( $args );
+                $this->assertNotContains( $group_ids[1], $found );
+        }
+
+        /**
+         * @group BP7435
+         * @group cache
+         */
+        public function test_group_field_ids_query_cache() {
+                global $wpdb;
+
+                $group_id = self::factory()->xprofile_group->create();
+
+                $f = self::factory()->xprofile_field->create( array(
+                        'field_group_id' => $group_id,
+                ) );
+                $field = new BP_XProfile_Field( $f );
+
+                // Prime cache.
+                $found = BP_XProfile_Group::get_group_field_ids( array( $group_id ) );
+                $this->assertContains( $f, $found );
+
+                $num_queries = $wpdb->num_queries;
+
+                $found = BP_XProfile_Group::get_group_field_ids( array( $group_id ) );
+                $this->assertContains( $f, $found );
+                $this->assertSame( $num_queries, $wpdb->num_queries );
+        }
+
+        /**
+         * @group BP7435
+         * @group cache
+         */
+        public function test_group_field_ids_query_cache_should_be_busted_on_field_save() {
+                global $wpdb;
+
+                $group_id = self::factory()->xprofile_group->create();
+
+                $f = self::factory()->xprofile_field->create( array(
+                        'field_group_id' => $group_id,
+                ) );
+                $field = new BP_XProfile_Field( $f );
+
+                // Prime cache.
+                $found = BP_XProfile_Group::get_group_field_ids( array( $group_id ) );
+                $this->assertContains( $f, $found );
+
+                $field->save();
+                $num_queries = $wpdb->num_queries;
+
+                $found = BP_XProfile_Group::get_group_field_ids( array( $group_id ) );
+                $this->assertContains( $f, $found );
+                $this->assertNotSame( $num_queries, $wpdb->num_queries );
+        }
+
+        /**
+         * @group BP7435
+         * @group cache
+         */
+        public function test_group_field_ids_query_cache_should_be_busted_on_field_delete() {
+                $group_id = self::factory()->xprofile_group->create();
+
+                $f = self::factory()->xprofile_field->create( array(
+                        'field_group_id' => $group_id,
+                ) );
+                $field = new BP_XProfile_Field( $f );
+
+                // Prime cache.
+                $found = BP_XProfile_Group::get_group_field_ids( array( $group_id ) );
+                $this->assertContains( $f, $found );
+
+                $field->delete();
+
+                $found = BP_XProfile_Group::get_group_field_ids( array( $group_id ) );
+                $this->assertNotContains( $f, $found );
+        }
 }