<!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][9887] trunk/src/bp-notifications: Notifications: Improve `all_for_user` cache deletion.</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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/9887">9887</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9887","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnjamesjacoby</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-05-21 19:56:59 +0000 (Thu, 21 May 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Notifications: Improve `all_for_user` cache deletion.
* Introduce `bp_notification_before_update` action which fires before a Notification is updated
* Introduce `bp_notifications_clear_all_for_user_cache()` as wrapper for `wp_cache_delete()` with appropriate cache group and key
* Introduce `bp_notifications_clear_all_for_user_cache_before_update()` hooked to `bp_notification_before_update` action, to handle cache deletion before a notification is updated
This change fixes a bug where marking single notifications as read/unread would not show anticipated results, as the `all_for_user` cache was not being properly cleared.
Props r-a-y. Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6445">#6445</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpnotificationsbpnotificationscachephp">trunk/src/bp-notifications/bp-notifications-cache.php</a></li>
<li><a href="#trunksrcbpnotificationsclassesclassbpnotificationsnotificationphp">trunk/src/bp-notifications/classes/class-bp-notifications-notification.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpnotificationsbpnotificationscachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-notifications/bp-notifications-cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-notifications/bp-notifications-cache.php 2015-05-21 19:34:40 UTC (rev 9886)
+++ trunk/src/bp-notifications/bp-notifications-cache.php 2015-05-21 19:56:59 UTC (rev 9887)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,6 +31,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Clear all notifications cache for a given user ID
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param int $user_id The user ID's cache to clear
+ */
+function bp_notifications_clear_all_for_user_cache( $user_id = 0 ) {
+ wp_cache_delete( 'all_for_user_' . $user_id, 'bp_notifications' );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Invalidate 'all_for_user_' cache when saving.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (2.0.0)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -38,7 +49,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param BP_Notifications_Notification $n Notification object.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_notifications_clear_all_for_user_cache_after_save( BP_Notifications_Notification $n ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_delete( 'all_for_user_' . $n->user_id, 'bp_notifications' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bp_notifications_clear_all_for_user_cache( $n->user_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_notification_after_save', 'bp_notifications_clear_all_for_user_cache_after_save' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -50,6 +61,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $args Notification deletion arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_notifications_clear_all_for_user_cache_before_delete( $args ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Pull up a list of items matching the args (those about te be deleted)
</span><span class="cx" style="display: block; padding: 0 10px"> $ns = BP_Notifications_Notification::get( $args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -58,8 +70,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $user_ids[] = $n->user_id;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( array_unique( $user_ids ) as $user_id ) {
- wp_cache_delete( 'all_for_user_' . $user_id, 'bp_notifications' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_ids = array_unique( $user_ids );
+ foreach ( $user_ids as $user_id ) {
+ bp_notifications_clear_all_for_user_cache( $user_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_notification_before_delete', 'bp_notifications_clear_all_for_user_cache_before_delete' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Invalidates 'all_for_user_' cache when updating.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param array $update_args See BP_Notifications_Notification::update() for description.
+ * @param array $where_args See BP_Notifications_Notification::update() for description.
+ */
+function bp_notifications_clear_all_for_user_cache_before_update( $update_args, $where_args ) {
+
+ // User ID is passed in where arugments
+ if ( ! empty( $where_args['user_id'] ) ) {
+ bp_notifications_clear_all_for_user_cache( $where_args['user_id'] );
+
+ // Get user ID from Notification ID
+ } elseif ( ! empty( $where_args['id'] ) ) {
+ $n = bp_notifications_get_notification( $where_args['id'] );
+ bp_notifications_clear_all_for_user_cache( $n->user_id );
+ }
+}
+add_action( 'bp_notification_before_update', 'bp_notifications_clear_all_for_user_cache_before_update', 10, 2 );
</ins></span></pre></div>
<a id="trunksrcbpnotificationsclassesclassbpnotificationsnotificationphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-notifications/classes/class-bp-notifications-notification.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-notifications/classes/class-bp-notifications-notification.php 2015-05-21 19:34:40 UTC (rev 9886)
+++ trunk/src/bp-notifications/classes/class-bp-notifications-notification.php 2015-05-21 19:56:59 UTC (rev 9887)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -830,12 +830,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $update = self::get_query_clauses( $update_args );
</span><span class="cx" style="display: block; padding: 0 10px"> $where = self::get_query_clauses( $where_args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // make sure we delete the notification cache for the user on update
- if ( ! empty( $where_args['user_id'] ) ) {
- wp_cache_delete( 'all_for_user_' . $where_args['user_id'], 'bp_notifications' );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires before the update of a notification item.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param array $update_args See BP_Notifications_Notification::update().
+ * @param array $where_args See BP_Notifications_Notification::update().
+ */
+ do_action( 'bp_notification_before_update', $update_args, $where_args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return self::_update( $update['data'], $where['data'], $update['format'], $where['format'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return self::_update(
+ $update['data'],
+ $where['data'],
+ $update['format'],
+ $where['format']
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>