<!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][8053] trunk: Cache the unread inbox count for a 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/8053">8053</a></dd>
<dt>Author</dt> <dd>r-a-y</dd>
<dt>Date</dt> <dd>2014-03-06 01:28:03 +0000 (Thu, 06 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Cache the unread inbox count for a user.
This commit:
- Caches calls to BP_Messages_Thread::get_inbox_count()
- Invalidates the cache when a new message is sent or deleted
- Adds a unit test
See <a href="http://buddypress.trac.wordpress.org/ticket/5414">#5414</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpmessagesbpmessagescachephp">trunk/bp-messages/bp-messages-cache.php</a></li>
<li><a href="#trunkbpmessagesbpmessagesclassesphp">trunk/bp-messages/bp-messages-classes.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkteststestcasesmessagesfunctionsphp">trunk/tests/testcases/messages/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpmessagesbpmessagescachephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-messages/bp-messages-cache.php (8052 => 8053)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-messages/bp-messages-cache.php 2014-03-06 01:15:18 UTC (rev 8052)
+++ trunk/bp-messages/bp-messages-cache.php 2014-03-06 01:28:03 UTC (rev 8053)
</span><span class="lines">@@ -24,6 +24,33 @@
</span><span class="cx"> add_action( 'messages_screen_inbox', 'bp_core_clear_cache' );
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Clears unread count cache for each recipient after a message is sent.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param BP_Messages_Message $message
+ */
+function bp_messages_clear_unread_count_cache_on_message_save( BP_Messages_Message $message ) {
+ foreach ( (array) $message->recipients as $recipient ) {
+ wp_cache_delete( $recipient->user_id, 'bp_messages_unread_count' );
+ }
+}
+add_action( 'messages_message_after_save', 'bp_messages_clear_unread_count_cache_on_message_save' );
+
+/**
+ * Clears unread count cache for the logged-in user after a message is deleted.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int|array $thread_ids If single thread, the thread ID. Otherwise, an
+ * array of thread IDs
+ */
+function bp_messages_clear_unread_count_cache_on_message_delete( $thread_ids ) {
+ wp_cache_delete( bp_loggedin_user_id(), 'bp_messages_unread_count' );
+}
+add_action( 'messages_before_delete_thread', 'bp_messages_clear_unread_count_cache_on_message_delete' );
+
+/**
</ins><span class="cx"> * Invalidates cache for notices.
</span><span class="cx"> *
</span><span class="cx"> * Currently, invalidates active notice cache.
</span></span></pre></div>
<a id="trunkbpmessagesbpmessagesclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-messages/bp-messages-classes.php (8052 => 8053)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-messages/bp-messages-classes.php 2014-03-06 01:15:18 UTC (rev 8052)
+++ trunk/bp-messages/bp-messages-classes.php 2014-03-06 01:28:03 UTC (rev 8053)
</span><span class="lines">@@ -300,6 +300,8 @@
</span><span class="cx">
</span><span class="cx"> $sql = $wpdb->prepare( "UPDATE {$bp->messages->table_name_recipients} SET unread_count = 0 WHERE user_id = %d AND thread_id = %d", bp_loggedin_user_id(), $thread_id );
</span><span class="cx"> $wpdb->query($sql);
</span><ins>+
+ wp_cache_delete( bp_loggedin_user_id(), 'bp_messages_unread_count' );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -314,6 +316,8 @@
</span><span class="cx">
</span><span class="cx"> $sql = $wpdb->prepare( "UPDATE {$bp->messages->table_name_recipients} SET unread_count = 1 WHERE user_id = %d AND thread_id = %d", bp_loggedin_user_id(), $thread_id );
</span><span class="cx"> $wpdb->query($sql);
</span><ins>+
+ wp_cache_delete( bp_loggedin_user_id(), 'bp_messages_unread_count' );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -382,7 +386,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Gets the inbox message count for a user.
</del><ins>+ * Gets the unread message count for a user.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.0.0)
</span><span class="cx"> *
</span><span class="lines">@@ -396,11 +400,12 @@
</span><span class="cx"> $user_id = bp_loggedin_user_id();
</span><span class="cx"> }
</span><span class="cx">
</span><del>- $sql = $wpdb->prepare( "SELECT SUM(unread_count) FROM {$bp->messages->table_name_recipients} WHERE user_id = %d AND is_deleted = 0 AND sender_only = 0", $user_id );
- $unread_count = $wpdb->get_var( $sql );
</del><ins>+ $unread_count = wp_cache_get( $user_id, 'bp_messages_unread_count' );
</ins><span class="cx">
</span><del>- if ( empty( $unread_count ) || is_wp_error( $unread_count ) ) {
- return 0;
</del><ins>+ if ( false === $unread_count ) {
+ $unread_count = (int) $wpdb->get_var( $wpdb->prepare( "SELECT SUM(unread_count) FROM {$bp->messages->table_name_recipients} WHERE user_id = %d AND is_deleted = 0 AND sender_only = 0", $user_id ) );
+
+ wp_cache_set( $user_id, $unread_count, 'bp_messages_unread_count' );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> return (int) $unread_count;
</span></span></pre></div>
<a id="trunkteststestcasesmessagesfunctionsphp"></a>
<div class="addfile"><h4>Added: trunk/tests/testcases/messages/functions.php (0 => 8053)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/messages/functions.php (rev 0)
+++ trunk/tests/testcases/messages/functions.php 2014-03-06 01:28:03 UTC (rev 8053)
</span><span class="lines">@@ -0,0 +1,44 @@
</span><ins>+<?php
+
+/**
+ * @group messages
+ * @group functions
+ */
+class BP_Tests_Messages_Functions extends BP_UnitTestCase {
+
+ /**
+ * @group counts
+ */
+ public function test_get_unread_count() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+
+ // send a private message
+ $t1 = messages_new_message( array(
+ 'sender_id' => $u1,
+ 'recipients' => array( $u2 ),
+ 'subject' => 'A new message',
+ 'content' => 'Hey there!',
+ ) );
+
+ // get unread count for $u2
+ $this->set_current_user( $u2 );
+ $this->assertEquals( 1, messages_get_unread_count( $u2 ) );
+
+ // send another message and get recheck unread count
+ $t2 = messages_new_message( array(
+ 'sender_id' => $u1,
+ 'recipients' => array( $u2 ),
+ 'subject' => 'A new message',
+ 'content' => 'Hey there!',
+ ) );
+ $this->assertEquals( 2, messages_get_unread_count( $u2 ) );
+
+ // mark one message as read
+ messages_mark_thread_read( $t1 );
+
+ // recheck unread count
+ $this->assertEquals( 1, messages_get_unread_count( $u2 ) );
+ }
+
+}
</ins></span></pre>
</div>
</div>
</body>
</html>