<!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][8105] trunk: Cache the friendship request user IDs for a given user.</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/8105">8105</a></dd>
<dt>Author</dt> <dd>r-a-y</dd>
<dt>Date</dt> <dd>2014-03-10 20:36:19 +0000 (Mon, 10 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Cache the friendship request user IDs for a given user.
This commit:
- Caches calls to BP_Friends_Friendship::get_friendship_request_user_ids()
- Invalidates the friend request cache when a friendship is saved or removed
- Adds unit tests
See <a href="http://buddypress.trac.wordpress.org/ticket/5435">#5435</a>, <a href="http://buddypress.trac.wordpress.org/ticket/5414">#5414</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpfriendsbpfriendscachephp">trunk/bp-friends/bp-friends-cache.php</a></li>
<li><a href="#trunkbpfriendsbpfriendsclassesphp">trunk/bp-friends/bp-friends-classes.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkteststestcasesfriendsfunctionsphp">trunk/tests/testcases/friends/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpfriendsbpfriendscachephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-friends/bp-friends-cache.php (8104 => 8105)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-friends/bp-friends-cache.php 2014-03-10 20:35:18 UTC (rev 8104)
+++ trunk/bp-friends/bp-friends-cache.php 2014-03-10 20:36:19 UTC (rev 8105)
</span><span class="lines">@@ -31,6 +31,50 @@
</span><span class="cx"> add_action( 'friends_friendship_accepted', 'friends_clear_friend_object_cache' );
</span><span class="cx"> add_action( 'friends_friendship_deleted', 'friends_clear_friend_object_cache' );
</span><span class="cx">
</span><ins>+/**
+ * Clear the friend request cache for the user not initiating the friendship.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $friend_user_id The user ID not initiating the friendship
+ */
+function bp_friends_clear_request_cache( $friend_user_id ) {
+ wp_cache_delete( $friend_user_id, 'bp_friends_requests' );
+}
+
+/**
+ * Clear the friend request cache when a friendship is saved.
+ *
+ * A friendship is deemed saved when a friendship is requested or accepted.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $friendship_id The friendship ID
+ * @param int $initiator_user_id The user ID initiating the friendship
+ * @param int $friend_user_id The user ID not initiating the friendship
+ */
+function bp_friends_clear_request_cache_on_save( $friendship_id, $initiator_user_id, $friend_user_id ) {
+ bp_friends_clear_request_cache( $friend_user_id );
+}
+add_action( 'friends_friendship_requested', 'bp_friends_clear_request_cache_on_save', 10, 3 );
+add_action( 'friends_friendship_accepted', 'bp_friends_clear_request_cache_on_save', 10, 3 );
+
+/**
+ * Clear the friend request cache when a friendship is removed.
+ *
+ * A friendship is deemed removed when a friendship is withdrawn or rejected.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $friendship_id The friendship ID
+ * @param BP_Friends_Friendship $friendship
+ */
+function bp_friends_clear_request_cache_on_remove( $friendship_id, BP_Friends_Friendship $friendship ) {
+ bp_friends_clear_request_cache( $friendship->friend_user_id );
+}
+add_action( 'friends_friendship_withdrawn', 'bp_friends_clear_request_cache_on_remove', 10, 2 );
+add_action( 'friends_friendship_rejected', 'bp_friends_clear_request_cache_on_remove', 10, 2 );
+
</ins><span class="cx"> // List actions to clear super cached pages on, if super cache is installed
</span><span class="cx"> add_action( 'friends_friendship_rejected', 'bp_core_clear_cache' );
</span><span class="cx"> add_action( 'friends_friendship_accepted', 'bp_core_clear_cache' );
</span></span></pre></div>
<a id="trunkbpfriendsbpfriendsclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-friends/bp-friends-classes.php (8104 => 8105)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-friends/bp-friends-classes.php 2014-03-10 20:35:18 UTC (rev 8104)
+++ trunk/bp-friends/bp-friends-classes.php 2014-03-10 20:36:19 UTC (rev 8105)
</span><span class="lines">@@ -226,9 +226,17 @@
</span><span class="cx"> * @return array|bool An array of user IDs, or false if none are found.
</span><span class="cx"> */
</span><span class="cx"> public static function get_friendship_request_user_ids( $user_id ) {
</span><del>- global $wpdb, $bp;
</del><ins>+ $friend_requests = wp_cache_get( $user_id, 'bp_friends_requests' );
</ins><span class="cx">
</span><del>- return $wpdb->get_col( $wpdb->prepare( "SELECT initiator_user_id FROM {$bp->friends->table_name} WHERE friend_user_id = %d AND is_confirmed = 0", $user_id ) );
</del><ins>+ if ( false === $friend_requests ) {
+ global $wpdb, $bp;
+
+ $friend_requests = $wpdb->get_col( $wpdb->prepare( "SELECT initiator_user_id FROM {$bp->friends->table_name} WHERE friend_user_id = %d AND is_confirmed = 0", $user_id ) );
+
+ wp_cache_set( $user_id, $friend_requests, 'bp_friends_requests' );
+ }
+
+ return $friend_requests;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunkteststestcasesfriendsfunctionsphp"></a>
<div class="addfile"><h4>Added: trunk/tests/testcases/friends/functions.php (0 => 8105)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/friends/functions.php (rev 0)
+++ trunk/tests/testcases/friends/functions.php 2014-03-10 20:36:19 UTC (rev 8105)
</span><span class="lines">@@ -0,0 +1,109 @@
</span><ins>+<?php
+
+/**
+ * @group friends
+ * @group functions
+ */
+class BP_Tests_Friends_Functions extends BP_UnitTestCase {
+
+ /**
+ * @group friends_get_friendship_request_user_ids
+ * @group friends_add_friend
+ * @group friends_accept_friendship
+ */
+ public function test_requests_on_accept() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $u3 = $this->create_user();
+
+ // request friendship
+ friends_add_friend( $u2, $u1 );
+ friends_add_friend( $u3, $u1 );
+
+ // get request count for user 1 and assert
+ $requests = friends_get_friendship_request_user_ids( $u1 );
+ $this->assertEquals( array( $u2, $u3 ), $requests );
+
+ // accept friendship
+ $this->set_current_user( $u1 );
+ friends_accept_friendship( friends_get_friendship_id( $u2, $u1 ) );
+
+ // refetch request count for user 1 and assert
+ $requests = friends_get_friendship_request_user_ids( $u1 );
+ $this->assertEquals( array( $u3 ), $requests );
+ }
+
+ /**
+ * @group friends_get_friendship_request_user_ids
+ * @group friends_add_friend
+ */
+ public function test_requests_on_request() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $u3 = $this->create_user();
+
+ // request friendship
+ friends_add_friend( $u2, $u1 );
+
+ // get request count for user 1 and assert
+ $requests = friends_get_friendship_request_user_ids( $u1 );
+ $this->assertEquals( array( $u2 ), $requests );
+
+ // request another friendship
+ friends_add_friend( $u3, $u1 );
+
+ // refetch request count for user 1 and assert
+ $requests = friends_get_friendship_request_user_ids( $u1 );
+ $this->assertEquals( array( $u2, $u3 ), $requests );
+ }
+
+ /**
+ * @group friends_get_friendship_request_user_ids
+ * @group friends_add_friend
+ * @group friends_withdraw_friendship
+ */
+ public function test_requests_on_withdraw() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+
+ // request friendship
+ friends_add_friend( $u2, $u1 );
+
+ // get request count for user 1 and assert
+ $requests = friends_get_friendship_request_user_ids( $u1 );
+ $this->assertEquals( array( $u2 ), $requests );
+
+ // user 2 withdraws friendship
+ $this->set_current_user( $u2 );
+ friends_withdraw_friendship( $u2, $u1 );
+
+ // refetch request count for user 1 and assert
+ $requests = friends_get_friendship_request_user_ids( $u1 );
+ $this->assertEquals( array(), $requests );
+ }
+
+ /**
+ * @group friends_get_friendship_request_user_ids
+ * @group friends_add_friend
+ * @group friends_reject_friendship
+ */
+ public function test_requests_on_reject() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+
+ // request friendship
+ friends_add_friend( $u2, $u1 );
+
+ // get request count for user 1 and assert
+ $requests = friends_get_friendship_request_user_ids( $u1 );
+ $this->assertEquals( array( $u2 ), $requests );
+
+ // user 1 rejects friendship
+ $this->set_current_user( $u1 );
+ friends_reject_friendship( friends_get_friendship_id( $u2, $u1 ) );
+
+ // refetch request count for user 1 and assert
+ $requests = friends_get_friendship_request_user_ids( $u1 );
+ $this->assertEquals( array(), $requests );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>