<!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][7179] trunk: Improvements to refreshing of total_group_count on group membership events</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/7179">7179</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-06-07 01:31:27 +0000 (Fri, 07 Jun 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improvements to refreshing of total_group_count on group membership events
When group membership status is changed for a user, that user's
total_group_count meta must be updated. This changeset introduces a number of
improvements to the way this updating is done:
- Update using an actual queried group count, rather than incrementing. This
ensures that even if the count is off (due to a bug in BP or some other
plugin), it will be corrected the next time a membership event is recorded.
- Move the total_group_count refreshing further down the stack. Previously, the
updating was happening at various depths: sometimes in the
bp-groups-functions.php functions, sometimes in the database methods, and
sometimes not at all. By moving the updates so that they directly follow the
database queries, we reduce redundancy and ensure that the group count is
updated in all cases
This changeset also introduces integration tests for the relevant groups_*
membership functions and total_group_count.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5018">#5018</a>
Props mukkundthanki, r-a-y for early patches</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpgroupsbpgroupsclassesphp">trunk/bp-groups/bp-groups-classes.php</a></li>
<li><a href="#trunkbpgroupsbpgroupsfunctionsphp">trunk/bp-groups/bp-groups-functions.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkteststestcasesgroupsfunctionsphp">trunk/tests/testcases/groups/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpgroupsbpgroupsclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-classes.php (7178 => 7179)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-classes.php 2013-06-07 00:35:16 UTC (rev 7178)
+++ trunk/bp-groups/bp-groups-classes.php 2013-06-07 01:31:27 UTC (rev 7179)
</span><span class="lines">@@ -1222,6 +1222,9 @@
</span><span class="cx">
</span><span class="cx"> $this->id = $wpdb->insert_id;
</span><span class="cx">
</span><ins>+ // Update the user's group count
+ self::refresh_total_group_count_for_user( $this->user_id );
+
</ins><span class="cx"> do_action_ref_array( 'groups_member_after_save', array( &$this ) );
</span><span class="cx">
</span><span class="cx"> return true;
</span><span class="lines">@@ -1276,7 +1279,6 @@
</span><span class="cx"> $this->is_banned = 0;
</span><span class="cx">
</span><span class="cx"> groups_update_groupmeta( $this->group_id, 'total_member_count', ( (int) groups_get_groupmeta( $this->group_id, 'total_member_count' ) + 1 ) );
</span><del>- bp_update_user_meta( $this->user_id, 'total_group_count', (int) bp_get_user_meta( $this->user_id, 'total_group_count', true ) + 1 );
</del><span class="cx">
</span><span class="cx"> return $this->save();
</span><span class="cx"> }
</span><span class="lines">@@ -1286,16 +1288,12 @@
</span><span class="cx"> $this->inviter_id = 0;
</span><span class="cx"> $this->is_confirmed = 1;
</span><span class="cx"> $this->date_modified = bp_core_current_time();
</span><del>-
- bp_update_user_meta( $this->user_id, 'total_group_count', (int) bp_get_user_meta( $this->user_id, 'total_group_count', true ) + 1 );
</del><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> function accept_request() {
</span><span class="cx">
</span><span class="cx"> $this->is_confirmed = 1;
</span><span class="cx"> $this->date_modified = bp_core_current_time();
</span><del>-
- bp_update_user_meta( $this->user_id, 'total_group_count', (int) bp_get_user_meta( $this->user_id, 'total_group_count', true ) + 1 );
</del><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> function remove() {
</span><span class="lines">@@ -1308,19 +1306,27 @@
</span><span class="cx">
</span><span class="cx"> groups_update_groupmeta( $this->group_id, 'total_member_count', ( (int) groups_get_groupmeta( $this->group_id, 'total_member_count' ) - 1 ) );
</span><span class="cx">
</span><del>- $group_count = bp_get_user_meta( $this->user_id, 'total_group_count', true );
- if ( !empty( $group_count ) )
- bp_update_user_meta( $this->user_id, 'total_group_count', (int) $group_count - 1 );
</del><ins>+ // Update the user's group count
+ self::refresh_total_group_count_for_user( $this->user_id );
</ins><span class="cx">
</span><span class="cx"> return $result;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /** Static Methods ********************************************************/
</span><span class="cx">
</span><ins>+ public static function refresh_total_group_count_for_user( $user_id ) {
+ bp_update_user_meta( $user_id, 'total_group_count', (int) self::total_group_count( $user_id ) );
+ }
+
</ins><span class="cx"> function delete( $user_id, $group_id ) {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="cx">
</span><del>- return $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->groups->table_name_members} WHERE user_id = %d AND group_id = %d", $user_id, $group_id ) );
</del><ins>+ $remove = $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->groups->table_name_members} WHERE user_id = %d AND group_id = %d", $user_id, $group_id ) );
+
+ // Update the user's group count
+ self::refresh_total_group_count_for_user( $user_id );
+
+ return $remove;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> function get_group_ids( $user_id, $limit = false, $page = false ) {
</span></span></pre></div>
<a id="trunkbpgroupsbpgroupsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-functions.php (7178 => 7179)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-functions.php 2013-06-07 00:35:16 UTC (rev 7178)
+++ trunk/bp-groups/bp-groups-functions.php 2013-06-07 01:31:27 UTC (rev 7179)
</span><span class="lines">@@ -302,9 +302,6 @@
</span><span class="cx"> // Modify group member count
</span><span class="cx"> groups_update_groupmeta( $group_id, 'total_member_count', (int) groups_get_groupmeta( $group_id, 'total_member_count') - 1 );
</span><span class="cx">
</span><del>- // Modify user's group memberhip count
- bp_update_user_meta( $user_id, 'total_group_count', (int) bp_get_user_meta( $user_id, 'total_group_count', true ) - 1 );
-
</del><span class="cx"> /**
</span><span class="cx"> * If the user joined this group less than five minutes ago, remove the
</span><span class="cx"> * joined_group activity so users cannot flood the activity stream by
</span></span></pre></div>
<a id="trunkteststestcasesgroupsfunctionsphp"></a>
<div class="addfile"><h4>Added: trunk/tests/testcases/groups/functions.php (0 => 7179)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/groups/functions.php (rev 0)
+++ trunk/tests/testcases/groups/functions.php 2013-06-07 01:31:27 UTC (rev 7179)
</span><span class="lines">@@ -0,0 +1,131 @@
</span><ins>+<?php
+
+/**
+ * @group groups
+ * @group functions
+ */
+class BP_Tests_Groups_Functions extends BP_UnitTestCase {
+ /**
+ * @group total_group_count
+ * @group groups_join_group
+ */
+ public function test_total_group_count_groups_join_group() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $g = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+
+ groups_join_group( $g, $u2 );
+ $this->assertEquals( 1, bp_get_user_meta( $u2, 'total_group_count', true ) );
+ }
+
+ /**
+ * @group total_group_count
+ * @group groups_leave_group
+ */
+ public function test_total_group_count_groups_leave_group() {
+ $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' => $u1 ) );
+ groups_join_group( $g1, $u2 );
+ groups_join_group( $g2, $u2 );
+
+ groups_leave_group( $g1, $u2 );
+ $this->assertEquals( 1, bp_get_user_meta( $u2, 'total_group_count', true ) );
+ }
+
+ /**
+ * @group total_group_count
+ * @group groups_ban_member
+ */
+ public function test_total_group_count_groups_ban_member() {
+ $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' => $u1 ) );
+ groups_join_group( $g1, $u2 );
+ groups_join_group( $g2, $u2 );
+
+ // Fool the admin check
+ $this->set_current_user( $u1 );
+ buddypress()->is_item_admin = true;
+
+ groups_ban_member( $u2, $g1 );
+
+ $this->assertEquals( 1, bp_get_user_meta( $u2, 'total_group_count', true ) );
+ }
+
+ /**
+ * @group total_group_count
+ * @group BP_Groups_Member
+ * @group unban
+ */
+ public function test_total_group_count_BP_Groups_Member_unban() {
+ $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' => $u1 ) );
+ groups_join_group( $g1, $u2 );
+ groups_join_group( $g2, $u2 );
+
+ // Fool the admin check
+ $this->set_current_user( $u1 );
+ buddypress()->is_item_admin = true;
+
+ groups_ban_member( $u2, $g1 );
+
+ groups_unban_member( $u2, $g1 );
+
+ $this->assertEquals( 2, bp_get_user_meta( $u2, 'total_group_count', true ) );
+ }
+
+ /**
+ * @group total_group_count
+ * @group groups_accept_invite
+ */
+ public function test_total_group_count_groups_accept_invite() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $g = $this->factory->group->create();
+ groups_invite_user( array(
+ 'user_id' => $u1,
+ 'group_id' => $g,
+ 'inviter_id' => $u2,
+ ) );
+
+ groups_accept_invite( $u2, $g );
+
+ $this->assertEquals( 1, bp_get_user_meta( $u2, 'total_group_count', true ) );
+ }
+
+ /**
+ * @group total_group_count
+ * @group groups_accept_membership_request
+ */
+ public function test_total_group_count_groups_accept_membership_request() {
+ $u = $this->create_user();
+ $g = $this->factory->group->create();
+ groups_send_membership_request( $u, $g );
+
+ groups_accept_membership_request( 0, $u, $g );
+
+ $this->assertEquals( 1, bp_get_user_meta( $u, 'total_group_count', true ) );
+ }
+
+ public function test_total_group_count_groups_remove_member() {
+ $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' => $u1 ) );
+ groups_join_group( $g1, $u2 );
+ groups_join_group( $g2, $u2 );
+
+ // Fool the admin check
+ $this->set_current_user( $u1 );
+ buddypress()->is_item_admin = true;
+
+ groups_remove_member( $u2, $g1 );
+
+ $this->assertEquals( 1, bp_get_user_meta( $u2, 'total_group_count', true ) );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>