<!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][9744] trunk: Ensure that corresponding notifications are deleted when a message thread is deleted.</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/9744">9744</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/9744","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-04-12 19:42:38 +0000 (Sun, 12 Apr 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'>Ensure that corresponding notifications are deleted when a message thread is deleted.
This means deleting the notifications for each message in the thread, for each
recipient on the thread. Previously, only a subset of these were being deleted.
This changeset removes a test that used a dummy thread_id, a testing
technique that doesn't work with the new looping technique used for
notification deletion. The new unit test is a proper replacement.
Props pareshradadiya for an initial patch.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6329">#6329</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmessagesbpmessagesnotificationsphp">trunk/src/bp-messages/bp-messages-notifications.php</a></li>
<li><a href="#trunktestsphpunittestcasesmessagesnotificationsphp">trunk/tests/phpunit/testcases/messages/notifications.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmessagesbpmessagesnotificationsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-messages/bp-messages-notifications.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-messages/bp-messages-notifications.php 2015-04-12 12:22:12 UTC (rev 9743)
+++ trunk/src/bp-messages/bp-messages-notifications.php 2015-04-12 19:42:38 UTC (rev 9744)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -297,11 +297,20 @@
</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="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $message_id ID of the message.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $message_id ID of the thread.
+ * @param array $message_ids IDs of the messages.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function bp_messages_message_delete_notifications( $message_id = 0 ) {
- if ( bp_is_active( 'notifications' ) && ! empty( $message_id ) ) {
- bp_notifications_delete_notifications_by_item_id( bp_loggedin_user_id(), (int) $message_id, buddypress()->messages->id, 'new_message' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function bp_messages_message_delete_notifications( $thread_id, $message_ids ) {
+ if ( ! bp_is_active( 'notifications' ) ) {
+ return;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // For each recipient, delete notifications corresponding to each message.
+ $thread = new BP_Messages_Thread( $thread_id );
+ foreach ( $thread->get_recipients() as $recipient ) {
+ foreach ( $message_ids as $message_id ) {
+ bp_notifications_delete_notifications_by_item_id( $recipient->user_id, (int) $message_id, buddypress()->messages->id, 'new_message' );
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-add_action( 'messages_thread_deleted_thread', 'bp_messages_message_delete_notifications', 10, 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_action( 'bp_messages_thread_after_delete', 'bp_messages_message_delete_notifications', 10, 2 );
</ins></span></pre></div>
<a id="trunktestsphpunittestcasesmessagesnotificationsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/messages/notifications.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/messages/notifications.php 2015-04-12 12:22:12 UTC (rev 9743)
+++ trunk/tests/phpunit/testcases/messages/notifications.php 2015-04-12 19:42:38 UTC (rev 9744)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13,44 +13,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->filter_fired = '';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * @group bp_messages_message_delete_notifications
- */
- public function test_bp_messages_message_delete_notifications() {
- $current_user = get_current_user_id();
- $u = $this->factory->user->create();
- $this->set_current_user( $u );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Dummy thread ID
- $t = 12;
-
- // Admin
- $n = $this->factory->notification->create( array(
- 'component_name' => 'messages',
- 'user_id' => $u,
- 'item_id' => $t,
- 'component_action' => 'new_message',
- ) );
-
- $notifications = BP_Notifications_Notification::get( array(
- 'user_id' => $u,
- ) );
-
- // Double check it's there
- $this->assertEquals( array( $n ), wp_list_pluck( $notifications, 'id' ) );
-
- // fire the hook
- do_action( 'messages_thread_deleted_thread', $t );
-
- $notifications = BP_Notifications_Notification::get( array(
- 'user_id' => $u,
- ) );
-
- $this->assertEmpty( $notifications );
-
- $this->set_current_user( $current_user );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @group messages_format_notifications
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -147,6 +110,40 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'bp_messages_single_new_message_notification', $this->filter_fired );
</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">+ /**
+ * @ticket BP6329
+ */
+ public function test_messages_notifications_should_be_deleted_when_corresponding_message_is_deleted() {
+ if ( ! bp_is_active( 'messages' ) ) {
+ $this->markTestSkipped( __METHOD__ . ' requires the Messages component.' );
+ }
+
+ $u1 = $this->factory->user->create();
+ $u2 = $this->factory->user->create();
+
+ $t1 = messages_new_message( array(
+ 'sender_id' => $u1,
+ 'recipients' => array( $u2 ),
+ 'subject' => 'A new message',
+ 'content' => 'Hey there!',
+ ) );
+
+ // Verify that a notification has been created for the message.
+ $n1 = BP_Notifications_Notification::get( array(
+ 'component' => 'messages',
+ 'user_id' => $u2,
+ ) );
+ $this->assertNotEmpty( $n1 );
+
+ $this->assertTrue( messages_delete_thread( $t1 ) );
+
+ $n2 = BP_Notifications_Notification::get( array(
+ 'component' => 'messages',
+ 'user_id' => $u2,
+ ) );
+ $this->assertSame( array(), $n2 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function notification_filter_callback( $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->filter_fired = current_filter();
</span><span class="cx" style="display: block; padding: 0 10px"> return $value;
</span></span></pre>
</div>
</div>
</body>
</html>