<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][8531] trunk: Check groups loop data when using `bp_group_is_user_banned()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/8531">8531</a></dd>
<dt>Author</dt> <dd>r-a-y</dd>
<dt>Date</dt> <dd>2014-06-15 20:00:53 +0000 (Sun, 15 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>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 <a href="http://buddypress.trac.wordpress.org/ticket/5705">#5705</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsbpgroupstemplatephp">trunk/src/bp-groups/bp-groups-template.php</a></li>
<li><a href="#trunktestsphpunittestcasesgroupstemplatephp">trunk/tests/phpunit/testcases/groups/template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsbpgroupstemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-groups/bp-groups-template.php (8530 => 8531)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-groups/bp-groups-template.php 2014-06-15 18:22:12 UTC (rev 8530)
+++ trunk/src/bp-groups/bp-groups-template.php 2014-06-15 20:00:53 UTC (rev 8531)
</span><span class="lines">@@ -1668,36 +1668,57 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Checks if a user is banned from a group.
</del><ins>+ * Check if a user is banned from a group.
</ins><span class="cx"> *
</span><del>- * 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().
</del><ins>+ * 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.
</ins><span class="cx"> *
</span><ins>+ * 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)
+ *
</ins><span class="cx"> * @global BP_Groups_Template $groups_template Group template loop object
</span><del>- * @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)
</del><ins>+ * @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.
</ins><span class="cx"> */
</span><span class="cx"> function bp_group_is_user_banned( $group = false, $user_id = 0 ) {
</span><span class="cx"> global $groups_template;
</span><span class="cx">
</span><span class="cx"> // Site admins always have access
</span><del>- if ( bp_current_user_can( 'bp_moderate' ) )
</del><ins>+ if ( bp_current_user_can( 'bp_moderate' ) ) {
</ins><span class="cx"> return false;
</span><ins>+ }
</ins><span class="cx">
</span><del>- if ( empty( $group ) ) {
- $group =& $groups_template->group;
</del><ins>+ // 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;
</ins><span class="cx">
</span><del>- if ( !$user_id && isset( $group->is_banned ) )
- return apply_filters( 'bp_group_is_user_banned', $group->is_banned );
</del><ins>+ // 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 );
+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- 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 ) );
</del><ins>+ return (bool) apply_filters( 'bp_group_is_user_banned', $retval );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> function bp_group_accept_invite_link() {
</span></span></pre></div>
<a id="trunktestsphpunittestcasesgroupstemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/testcases/groups/template.php (8530 => 8531)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/testcases/groups/template.php 2014-06-15 18:22:12 UTC (rev 8530)
+++ trunk/tests/phpunit/testcases/groups/template.php 2014-06-15 20:00:53 UTC (rev 8531)
</span><span class="lines">@@ -689,4 +689,73 @@
</span><span class="cx"> $this->assertEquals( $v, $requests_template->requests[0]->{$k} );
</span><span class="cx"> }
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @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 );
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>