Changeset 8531

Timestamp:

06/15/2014 08:00:53 PM (12 years ago)

Author:

r-a-y

Message:

Check groups loop data when using bp_group_is_user_banned().

Previously, `bp_group_is_user_banned() did not reference the data already
queried in the groups loop via BP_Groups_Group::get_group_extras(). As a
result, if a user without the 'bp_moderate' cap was logged in and viewing
the group directory, this added twenty additional DB queries to the page.

Commit also standardizes the return value of bp_group_is_user_banned() to
a boolean. Previously, it was possible for the function to return either a
string of the integer, null or a boolean.

Fixes #5705.

Location:

trunk

Files:

• src/bp-groups/bp-groups-template.php (modified) (2 diffs)
• tests/phpunit/testcases/groups/template.php (modified) (1 diff)

trunk/src/bp-groups/bp-groups-template.php

@@ -1669 +1669 @@
 
 /**
- * Checks if a user is banned from a group.
- *
- * If this function is invoked inside the groups template loop (e.g. the group directory), then
- * check $groups_template->group->is_banned instead of making another SQL query.
- * However, if used in a single group's pages, we must use groups_is_user_banned().
+ * Check if a user is banned from a group.
+ *
+ * If this function is invoked inside the groups template loop, then we check
+ * $groups_template->group->is_banned instead of using {@link groups_is_user_banned()}
+ * and making another SQL query.
+ *
+ * In BuddyPress 2.1, to standardize this function, we are defaulting the
+ * return value to a boolean.  In previous versions, using this function would
+ * return either a string of the integer (0 or 1) or null if a result couldn't
+ * be found from the database.  If the logged-in user had the 'bp_moderate'
+ * capability, the return value would be boolean false.
+ *
+ * @since BuddyPress (1.5.0)
  *
  * @global BP_Groups_Template $groups_template Group template loop object
- * @param object $group Group to check if user is banned from the group
- * @param int $user_id
- * @return bool If user is banned from the group or not
- * @since BuddyPress (1.5)
+ * @param BP_Groups_Group $group Group to check if user is banned
+ * @param int $user_id The user ID to check
+ * @return bool True if user is banned.  False if user isn't banned.
  */
 function bp_group_is_user_banned( $group = false, $user_id = 0 ) {
@@ -1685 +1692 @@
 
         // Site admins always have access
-        if ( bp_current_user_can( 'bp_moderate' ) )
+        if ( bp_current_user_can( 'bp_moderate' ) ) {
                 return false;
-
-        if ( empty( $group ) ) {
-                $group =& $groups_template->group;
-
-                if ( !$user_id && isset( $group->is_banned ) )
-                        return apply_filters( 'bp_group_is_user_banned', $group->is_banned );
-        }
-
-        if ( !$user_id )
-                $user_id = bp_loggedin_user_id();
-
-        return apply_filters( 'bp_group_is_user_banned', groups_is_user_banned( $user_id, $group->id ) );
+        }
+
+        // check groups loop first
+        // @see BP_Groups_Group::get_group_extras()
+        if ( ! empty( $groups_template->in_the_loop ) && isset( $groups_template->group->is_banned ) ) {
+                $retval = $groups_template->group->is_banned;
+
+        // not in loop
+        } else {
+                // Default to not banned
+                $retval = false;
+
+                if ( empty( $group ) ) {
+                        $group = $groups_template->group;
+                }
+        
+                if ( empty( $user_id ) ) {
+                        $user_id = bp_loggedin_user_id();
+                }
+
+                if ( ! empty( $user_id ) && ! empty( $group->id ) ) {
+                        $retval = groups_is_user_banned( $user_id, $group->id );
+                }
+        }
+
+        return (bool) apply_filters( 'bp_group_is_user_banned', $retval );
 }
 

trunk/tests/phpunit/testcases/groups/template.php

@@ -690 +690 @@
                 }
         }
+
+        /**
+         * @group bp_group_is_user_banned
+         */
+        public function test_bp_group_is_user_banned_in_groups_loop() {
+                $u1 = $this->create_user();
+                $u2 = $this->create_user();
+                $g1 = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+                $g2 = $this->factory->group->create( array( 'creator_id' => $u2 ) );
+                groups_join_group( $g1, $u2 );
+                groups_join_group( $g2, $u2 );
+                groups_join_group( $g2, $u1 );
+
+                // Ban user 1 from group 2
+                // Fool the admin check
+                $old_user = get_current_user_id();
+                $this->set_current_user( $u2 );
+                buddypress()->is_item_admin = true;
+                groups_ban_member( $u1, $g2 );
+
+                // Start the groups loop
+                $this->set_current_user( $u1 );
+                if ( bp_has_groups() ) : while ( bp_groups() ) : bp_the_group();
+                        $found[] = bp_group_is_user_banned();
+                endwhile; endif;
+
+                // Assert
+                $expected = array( 0, 1 );
+                $this->assertEquals( $expected, $found );
+
+                // Clean up
+                $GLOBALS['groups_template'] = null;
+                $this->set_current_user( $old_user );
+        }
+
+        /**
+         * @group bp_group_is_user_banned
+         */
+        public function test_bp_group_is_user_banned_not_in_groups_loop() {
+                $u1 = $this->create_user();
+                $u2 = $this->create_user();
+                $g1 = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+                $g2 = $this->factory->group->create( array( 'creator_id' => $u2 ) );
+                groups_join_group( $g1, $u2 );
+                groups_join_group( $g2, $u2 );
+                groups_join_group( $g2, $u1 );
+
+                // Ban user 1 from group 2
+                // Fool the admin check
+                $old_user = get_current_user_id();
+                $this->set_current_user( $u2 );
+                buddypress()->is_item_admin = true;
+                groups_ban_member( $u1, $g2 );
+
+                // Do group ban checks
+                $group1 = new BP_Groups_Group( $g1 );
+                $group2 = new BP_Groups_Group( $g2 );
+
+                $found = array();
+                $found[] = bp_group_is_user_banned( $group1, $u1 );
+                $found[] = bp_group_is_user_banned( $group2, $u1 );
+
+                // Assert
+                $expected = array( 0, 1 );
+                $this->assertEquals( $expected, $found );
+
+                // Clean up
+                $this->set_current_user( $old_user );
+        }
 }