<!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][7621] trunk/bp-messages: Refactor Messages component's approach to Notifications integration:</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/7621">7621</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2013-11-30 04:44:58 +0000 (Sat, 30 Nov 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Refactor Messages component's approach to Notifications integration:
* Introduce helper functions for handling the adding/marking/deleting of notifications. Hook these new functions into their respective actions rather than have them hardcoded and interspersed amongst the first-class code.
* See <a href="http://buddypress.trac.wordpress.org/ticket/5266">#5266</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpmessagesbpmessagesfunctionsphp">trunk/bp-messages/bp-messages-functions.php</a></li>
<li><a href="#trunkbpmessagesbpmessagesnotificationsphp">trunk/bp-messages/bp-messages-notifications.php</a></li>
<li><a href="#trunkbpmessagesbpmessagestemplatephp">trunk/bp-messages/bp-messages-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpmessagesbpmessagesfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-messages/bp-messages-functions.php (7620 => 7621)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-messages/bp-messages-functions.php 2013-11-30 04:35:17 UTC (rev 7620)
+++ trunk/bp-messages/bp-messages-functions.php 2013-11-30 04:44:58 UTC (rev 7621)
</span><span class="lines">@@ -114,15 +114,6 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> if ( $message->send() ) {
</span><del>-
- // Send screen notifications to the recipients
- foreach ( (array) $message->recipients as $recipient ) {
- bp_core_add_notification( $message->id, $recipient->user_id, 'messages', 'new_message', $message->sender_id );
- }
-
- // Send email notifications to the recipients
- messages_notification_new_message( array( 'message_id' => $message->id, 'sender_id' => $message->sender_id, 'subject' => $message->subject, 'content' => $message->message, 'recipients' => $message->recipients, 'thread_id' => $message->thread_id) );
-
</del><span class="cx"> do_action_ref_array( 'messages_message_sent', array( &$message ) );
</span><span class="cx">
</span><span class="cx"> return $message->thread_id;
</span><span class="lines">@@ -223,47 +214,3 @@
</span><span class="cx"> function messages_is_valid_thread( $thread_id ) {
</span><span class="cx"> return BP_Messages_Thread::is_valid( $thread_id );
</span><span class="cx"> }
</span><del>-
-/**
- * Format the BuddyBar/Toolbar notifications for the Messages component
- *
- * @package BuddyPress
- *
- * @param string $action The kind of notification being rendered
- * @param int $item_id The primary item id
- * @param int $secondary_item_id The secondary item id
- * @param int $total_items The total number of messaging-related notifications waiting for the user
- * @param string $format 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar
- */
-function messages_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {
-
- if ( 'new_message' == $action ) {
- $link = trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() . '/inbox' );
- $title = __( 'Inbox', 'buddypress' );
-
- if ( (int) $total_items > 1 ) {
- $text = sprintf( __('You have %d new messages', 'buddypress' ), (int) $total_items );
- $filter = 'bp_messages_multiple_new_message_notification';
- } else {
- if ( !empty( $secondary_item_id ) ) {
- $text = sprintf( __('You have %d new message from %s', 'buddypress' ), (int) $total_items, bp_core_get_user_displayname( $secondary_item_id ) );
- } else {
- $text = sprintf( __('You have %d new message', 'buddypress' ), (int) $total_items );
- }
- $filter = 'bp_messages_single_new_message_notification';
- }
- }
-
- if ( 'string' == $format ) {
- $return = apply_filters( $filter, '<a href="' . $link . '" title="' . $title . '">' . $text . '</a>', (int) $total_items, $text, $link, $item_id, $secondary_item_id );
- } else {
- $return = apply_filters( $filter, array(
- 'text' => $text,
- 'link' => $link
- ), $link, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
- }
-
- do_action( 'messages_format_notifications', $action, $item_id, $secondary_item_id, $total_items );
-
- return $return;
-}
</del></span></pre></div>
<a id="trunkbpmessagesbpmessagesnotificationsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-messages/bp-messages-notifications.php (7620 => 7621)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-messages/bp-messages-notifications.php 2013-11-30 04:35:17 UTC (rev 7620)
+++ trunk/bp-messages/bp-messages-notifications.php 2013-11-30 04:44:58 UTC (rev 7621)
</span><span class="lines">@@ -7,34 +7,51 @@
</span><span class="cx"> * @subpackage MessagesNotifications
</span><span class="cx"> */
</span><span class="cx">
</span><del>-
</del><span class="cx"> // Exit if accessed directly
</span><span class="cx"> if ( !defined( 'ABSPATH' ) ) exit;
</span><span class="cx">
</span><ins>+/** Email *********************************************************************/
+
+/**
+ * Email message recipients to alert them of a new unread private message
+ *
+ * @since BuddyPress (1.0)
+ * @param array $args
+ */
</ins><span class="cx"> function messages_notification_new_message( $args = array() ) {
</span><span class="cx">
</span><ins>+ // Cast possible $message object as an array
+ if ( is_object( $args ) ) {
+ $args = (array) $args;
+ }
+
</ins><span class="cx"> // These should be extracted below
</span><span class="cx"> $recipients = array();
</span><span class="cx"> $email_subject = $email_content = '';
</span><ins>+ $sender_id = 0;
</ins><span class="cx">
</span><ins>+ // Barf
</ins><span class="cx"> extract( $args );
</span><span class="cx">
</span><ins>+ // Get the sender display name
</ins><span class="cx"> $sender_name = bp_core_get_user_displayname( $sender_id );
</span><span class="cx">
</span><span class="cx"> // Bail if no recipients
</span><span class="cx"> if ( ! empty( $recipients ) ) {
</span><span class="cx">
</span><del>- foreach( $recipients as $recipient ) {
</del><ins>+ foreach ( $recipients as $recipient ) {
</ins><span class="cx">
</span><del>- if ( $sender_id == $recipient->user_id || 'no' == bp_get_user_meta( $recipient->user_id, 'notification_messages_new_message', true ) )
</del><ins>+ if ( $sender_id == $recipient->user_id || 'no' == bp_get_user_meta( $recipient->user_id, 'notification_messages_new_message', true ) ) {
</ins><span class="cx"> continue;
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> // User data and links
</span><del>- $ud = get_userdata( $recipient->user_id );
</del><ins>+ $ud = get_userdata( $recipient->user_id );
</ins><span class="cx">
</span><span class="cx"> // Bail if user cannot be found
</span><del>- if ( empty( $ud ) )
</del><ins>+ if ( empty( $ud ) ) {
</ins><span class="cx"> continue;
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> $message_link = bp_core_get_user_domain( $recipient->user_id ) . bp_get_messages_slug() .'/';
</span><span class="cx"> $settings_slug = function_exists( 'bp_get_settings_slug' ) ? bp_get_settings_slug() : 'settings';
</span><span class="lines">@@ -77,3 +94,96 @@
</span><span class="cx">
</span><span class="cx"> do_action( 'bp_messages_sent_notification_email', $recipients, $email_subject, $email_content, $args );
</span><span class="cx"> }
</span><ins>+add_action( 'messages_message_sent', 'messages_notification_new_message', 10 );
+
+/** Notifications *************************************************************/
+
+/**
+ * Format the BuddyBar/Toolbar notifications for the Messages component
+ *
+ * @since BuddyPress (1.0)
+ * @param string $action The kind of notification being rendered
+ * @param int $item_id The primary item id
+ * @param int $secondary_item_id The secondary item id
+ * @param int $total_items The total number of messaging-related notifications waiting for the user
+ * @param string $format 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar
+ */
+function messages_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {
+
+ if ( 'new_message' === $action ) {
+ $link = trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() . '/inbox' );
+ $title = __( 'Inbox', 'buddypress' );
+
+ if ( (int) $total_items > 1 ) {
+ $text = sprintf( __('You have %d new messages', 'buddypress' ), (int) $total_items );
+ $filter = 'bp_messages_multiple_new_message_notification';
+ } else {
+ if ( !empty( $secondary_item_id ) ) {
+ $text = sprintf( __('You have %d new message from %s', 'buddypress' ), (int) $total_items, bp_core_get_user_displayname( $secondary_item_id ) );
+ } else {
+ $text = sprintf( __('You have %d new message', 'buddypress' ), (int) $total_items );
+ }
+ $filter = 'bp_messages_single_new_message_notification';
+ }
+ }
+
+ if ( 'string' === $format ) {
+ $return = apply_filters( $filter, '<a href="' . esc_url( $link ) . '" title="' . esc_attr( $title ) . '">' . esc_html( $text ) . '</a>', (int) $total_items, $text, $link, $item_id, $secondary_item_id );
+ } else {
+ $return = apply_filters( $filter, array(
+ 'text' => $text,
+ 'link' => $link
+ ), $link, (int) $total_items, $text, $link, $item_id, $secondary_item_id );
+ }
+
+ do_action( 'messages_format_notifications', $action, $item_id, $secondary_item_id, $total_items );
+
+ return $return;
+}
+
+/**
+ * Send notifications to message recipients
+ *
+ * @since BuddyPress (1.9.0)
+ * @param obj $message
+ */
+function bp_messages_message_sent_add_notification( $message ) {
+ if ( bp_is_active( 'notifications' ) && ! empty( $message->recipients ) ) {
+ foreach ( (array) $message->recipients as $recipient ) {
+ bp_notifications_add_notification( array(
+ 'user_id' => $recipient->user_id,
+ 'item_id' => $message->id,
+ 'secondary_item_id' => $message->sender_id,
+ 'component_name' => buddypress()->messages->id,
+ 'component_action' => 'new_message',
+ 'date_notified' => bp_core_current_time(),
+ 'is_new' => 1,
+ ) );
+ }
+ }
+}
+add_action( 'messages_message_sent', 'bp_messages_message_sent_add_notification', 10 );
+
+/**
+ * Mark new message notifications when member views their inbox.
+ *
+ * @since BuddyPress (1.9.0)
+ */
+function bp_messages_screen_inbox_mark_notifications() {
+ if ( bp_is_active( 'notifications' ) ) {
+ bp_notifications_mark_notifications_by_type( bp_loggedin_user_id(), buddypress()->messages->id, 'new_message' );
+ }
+}
+add_action( 'messages_screen_inbox', 'bp_messages_screen_inbox_mark_notifications', 10 );
+
+/**
+ * Mark new message notification when member reads a message thread directly.
+ *
+ * @since BuddyPress (1.9.0)
+ */
+function bp_messages_screen_conversation_mark_notifications() {
+ if ( bp_is_active( 'notifications' ) ) {
+ bp_notifications_mark_notifications_by_item_id( bp_loggedin_user_id(), (int) bp_action_variable( 0 ), buddypress()->messages->id, 'new_message' );
+ }
+}
+add_action( 'messages_screen_conversation', 'bp_messages_screen_inbox_mark_notifications', 10 );
</ins></span></pre></div>
<a id="trunkbpmessagesbpmessagestemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-messages/bp-messages-template.php (7620 => 7621)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-messages/bp-messages-template.php 2013-11-30 04:35:17 UTC (rev 7620)
+++ trunk/bp-messages/bp-messages-template.php 2013-11-30 04:44:58 UTC (rev 7621)
</span><span class="lines">@@ -184,10 +184,6 @@
</span><span class="cx"> if ( bp_is_current_action( 'notices' ) && !bp_current_user_can( 'bp_moderate' ) ) {
</span><span class="cx"> wp_redirect( bp_displayed_user_id() );
</span><span class="cx"> } else {
</span><del>- if ( bp_is_current_action( 'inbox' ) ) {
- bp_core_mark_notifications_by_type( bp_loggedin_user_id(), $bp->messages->id, 'new_message' );
- }
-
</del><span class="cx"> if ( bp_is_current_action( 'sentbox' ) ) {
</span><span class="cx"> $box = 'sentbox';
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>