<!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][7994] trunk: Add object caching when fetching the active notice.</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/7994">7994</a></dd>
<dt>Author</dt> <dd>r-a-y</dd>
<dt>Date</dt> <dd>2014-02-26 21:37:39 +0000 (Wed, 26 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add object caching when fetching the active notice.
This commit:
- Introduces a new hook - 'messages_notice_before_delete' to do something before a notice is deleted
- Adds object caching to the BP_Messages_Notice::get_active() method
- Adds a cache invalidation function to bp-messages-cache.php
- Adds a unit test
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5419">#5419</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>trunk/tests/testcases/messages/</li>
<li><a href="#trunkteststestcasesmessagesclassbpmessagesnoticephp">trunk/tests/testcases/messages/class.bp-messages-notice.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 (7993 => 7994)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-messages/bp-messages-cache.php 2014-02-26 13:39:13 UTC (rev 7993)
+++ trunk/bp-messages/bp-messages-cache.php 2014-02-26 21:37:39 UTC (rev 7994)
</span><span class="lines">@@ -22,3 +22,16 @@
</span><span class="cx"> add_action( 'messages_screen_compose', 'bp_core_clear_cache' );
</span><span class="cx"> add_action( 'messages_screen_sentbox', 'bp_core_clear_cache' );
</span><span class="cx"> add_action( 'messages_screen_inbox', 'bp_core_clear_cache' );
</span><ins>+
+/**
+ * Invalidates cache for notices.
+ *
+ * Currently, invalidates active notice cache.
+ *
+ * @since BuddyPress (2.0.0)
+ */
+function bp_notices_clear_cache( $notice ) {
+ wp_cache_delete( 'active_notice', 'bp_messages' );
+}
+add_action( 'messages_notice_after_save', 'bp_notices_clear_cache' );
+add_action( 'messages_notice_before_delete', 'bp_notices_clear_cache' );
</ins><span class="cx">\ No newline at end of file
</span></span></pre></div>
<a id="trunkbpmessagesbpmessagesclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-messages/bp-messages-classes.php (7993 => 7994)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-messages/bp-messages-classes.php 2014-02-26 13:39:13 UTC (rev 7993)
+++ trunk/bp-messages/bp-messages-classes.php 2014-02-26 21:37:39 UTC (rev 7994)
</span><span class="lines">@@ -577,6 +577,8 @@
</span><span class="cx"> public function delete() {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="cx">
</span><ins>+ do_action( 'messages_notice_before_delete', $this );
+
</ins><span class="cx"> $sql = $wpdb->prepare( "DELETE FROM {$bp->messages->table_name_notices} WHERE id = %d", $this->id );
</span><span class="cx">
</span><span class="cx"> if ( ! $wpdb->query( $sql ) ) {
</span><span class="lines">@@ -643,10 +645,17 @@
</span><span class="cx"> * @return object The BP_Messages_Notice object
</span><span class="cx"> */
</span><span class="cx"> public static function get_active() {
</span><del>- global $wpdb, $bp;
</del><ins>+ $notice = wp_cache_get( 'active_notice', 'bp_messages' );
</ins><span class="cx">
</span><del>- $notice_id = $wpdb->get_var( "SELECT id FROM {$bp->messages->table_name_notices} WHERE is_active = 1" );
</del><ins>+ if ( false === $notice ) {
+ global $wpdb, $bp;
</ins><span class="cx">
</span><del>- return new BP_Messages_Notice( $notice_id );
</del><ins>+ $notice_id = $wpdb->get_var( "SELECT id FROM {$bp->messages->table_name_notices} WHERE is_active = 1" );
+ $notice = new BP_Messages_Notice( $notice_id );
+
+ wp_cache_set( 'active_notice', $notice, 'bp_messages' );
+ }
+
+ return $notice;
</ins><span class="cx"> }
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkteststestcasesmessagesclassbpmessagesnoticephp"></a>
<div class="addfile"><h4>Added: trunk/tests/testcases/messages/class.bp-messages-notice.php (0 => 7994)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/messages/class.bp-messages-notice.php (rev 0)
+++ trunk/tests/testcases/messages/class.bp-messages-notice.php 2014-02-26 21:37:39 UTC (rev 7994)
</span><span class="lines">@@ -0,0 +1,53 @@
</span><ins>+<?php
+
+/**
+ * @group notices
+ */
+class BP_Tests_BP_Messages_Notice_TestCases extends BP_UnitTestCase {
+
+ protected $old_current_user = 0;
+
+ public function setUp() {
+ parent::setUp();
+ $this->old_current_user = get_current_user_id();
+ $this->set_current_user( $this->create_user( array( 'role' => 'administrator' ) ) );
+ }
+
+ public function tearDown() {
+ parent::tearDown();
+ $this->set_current_user( $this->old_current_user );
+ }
+
+ /**
+ * @group cache
+ */
+ public function test_get_active_notices() {
+ // send notice
+ $subject = 'Test notice';
+ $message = 'This is a notice';
+ messages_send_notice( $subject, $message );
+
+ // now get the active notice and assert
+ $notice = BP_Messages_Notice::get_active();
+ $this->assertEquals( $subject, $notice->subject );
+ $this->assertEquals( $message, $notice->message );
+
+ // deactivate notice and make sure cache is invalidated
+ $notice->deactivate();
+ $this->assertFalse( wp_cache_get( 'active_notice', 'bp_messages' ) );
+
+ // create a new notice
+ $subject2 = 'Another notice';
+ $message2 = 'Say what?';
+ messages_send_notice( $subject2, $message2 );
+
+ // now get the new active notice
+ BP_Messages_Notice::get_active();
+
+ // grab the cache and make sure it equals our new notice
+ $cache = wp_cache_get( 'active_notice', 'bp_messages' );
+ $this->assertEquals( $subject2, $cache->subject );
+ $this->assertEquals( $message2, $cache->message );
+ }
+
+}
</ins></span></pre>
</div>
</div>
</body>
</html>