Ticket #3083: 3083.02.patch

src/bp-core/admin/bp-core-schema.php

@@ -304 +304 @@
                                 KEY is_active (is_active)
                         ) {$charset_collate};";
 
+        $sql[] = "CREATE TABLE {$bp_prefix}bp_messages_meta (
+                                id bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY,
+                                message_id bigint(20) NOT NULL,
+                                meta_key varchar(255) DEFAULT NULL,
+                                meta_value longtext DEFAULT NULL,
+                                KEY message_id (message_id),
+                                KEY meta_key (meta_key)
+                        ) {$charset_collate};";
+
         dbDelta( $sql );
 }
 

src/bp-core/bp-core-update.php

@@ -241 +241 @@
                 if ( $raw_db_version < 8311 ) {
                         bp_update_to_2_0_1();
                 }
+
+                // 2.2
+                if ( $raw_db_version < 9180 ) {
+                        bp_update_to_2_2();
+                }
         }
 
         /** All done! *************************************************************/
@@ -390 +395 @@
 }
 
 /**
+ * 2.2.0 update routine.
+ *
+ * - Add messages meta table
+ *
+ * @since BuddyPress (2.2.0)
+ */
+function bp_update_to_2_2() {
+        if ( bp_is_active( 'messages' ) ) {
+                bp_core_install_private_messaging();
+        }
+}
+
+/**
  * Redirect user to BP's What's New page on first page load after activation.
  *
  * @since BuddyPress (1.7.0)

src/bp-loader.php

@@ -301 +301 @@
                 /** Versions **********************************************************/
 
                 $this->version    = '2.2-alpha';
-                $this->db_version = 9167;
+                $this->db_version = 9180;
 
                 /** Loading ***********************************************************/
 

src/bp-messages/bp-messages-cache.php

@@ -12 +12 @@
 // Exit if accessed directly
 if ( !defined( 'ABSPATH' ) ) exit;
 
+/**
+ * Slurp up metadata for a set of messages.
+ *
+ * It grabs all message meta associated with all of the messages passed in
+ * $message_ids and adds it to WP cache. This improves efficiency when using
+ * message meta within a loop context.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param int|str|array $message_ids Accepts a single message_id, or a
+ *        comma-separated list or array of message ids.
+ */
+function bp_messages_update_meta_cache( $message_ids = false ) {
+        bp_update_meta_cache( array(
+                'object_ids'       => $message_ids,
+                'object_type'      => buddypress()->messages->id,
+                'cache_group'      => 'message_meta',
+                'object_column'    => 'message_id',
+                'meta_table'       => buddypress()->messages->table_name_meta,
+                'cache_key_prefix' => 'bp_messages_meta'
+        ) );
+}
+
 // List actions to clear super cached pages on, if super cache is installed
 add_action( 'messages_delete_thread',  'bp_core_clear_cache' );
 add_action( 'messages_send_notice',    'bp_core_clear_cache' );

src/bp-messages/bp-messages-classes.php

@@ -109 +109 @@
          *
          * @since BuddyPress (1.0.0)
          *
-         * @param bool|int $thread_id The message thread ID.
-         * @param string $order The order to sort the messages. Either 'ASC' or 'DESC'.
+         * @see BP_Messages_Thread::populate() for full description of parameters
          */
-        public function __construct( $thread_id = false, $order = 'ASC' ) {
+        public function __construct( $thread_id = false, $order = 'ASC', $args = array() ) {
                 if ( $thread_id ) {
-                        $this->populate( $thread_id, $order );
+                        $this->populate( $thread_id, $order, $args );
                 }
         }
 
@@ -127 +126 @@
          *
          * @param int $thread_id The message thread ID.
          * @param string $order The order to sort the messages. Either 'ASC' or 'DESC'.
+         * @param array $args {
+         *     Array of arguments.
+         *     @type bool $update_meta_cache Whether to pre-fetch metadata for
+         *           queried message items. Default: true.
+         * }
          * @return bool False on failure.
          */
-        public function populate( $thread_id, $order ) {
+        public function populate( $thread_id = 0, $order = 'ASC', $args = array() ) {
                 global $wpdb, $bp;
 
                 if( 'ASC' != $order && 'DESC' != $order ) {
-                        $order= 'ASC';
+                        $order = 'ASC';
                 }
 
+                // merge $args with our defaults
+                $r = wp_parse_args( $args, array(
+                        'update_meta_cache' => true
+                ) );
+
                 $this->messages_order = $order;
                 $this->thread_id      = $thread_id;
 
@@ -155 +164 @@
                         $this->unread_count = $this->recipients[bp_loggedin_user_id()]->unread_count;
                 }
 
+                // Grab all message meta
+                if ( true === (bool) $r['update_meta_cache'] ) {
+                        bp_messages_update_meta_cache( wp_list_pluck( $this->messages, 'id' ) );
+                }
+
                 /**
                  * Fires after a BP_Messages_Thread object has been populated.
                  *
@@ -218 +232 @@
         /** Static Functions ******************************************************/
 
         /**
-         * Delete a message thread.
+         * Mark messages in a thread as deleted or delete all messages in a thread.
+         *
+         * Note: All messages in a thread are deleted once every recipient in a thread
+         * has marked the thread as deleted.
          *
          * @since BuddyPress (1.0.0)
          *
          * @param int $thread_id The message thread ID
-         * @return bool
+         * @return bool Always true... sucks.
          */
         public static function delete( $thread_id ) {
                 global $wpdb, $bp;
 
                 /**
-                 * Fires before a message thread is deleted.
+                 * Fires before a message thread is marked as deleted.
                  *
                  * @since BuddyPress (2.2.0)
                  *
                  * @param int $thread_id ID of the thread being deleted.
                  */
-                do_action( 'bp_messages_thread_before_delete', $thread_id );
+                do_action( 'bp_messages_thread_before_mark_delete', $thread_id );
 
                 // Mark messages as deleted
+                //
+                // @todo the reliance on bp_loggedin_user_id() sucks for plugins
+                //       refactor this method to accept a $user_id parameter
                 $wpdb->query( $wpdb->prepare( "UPDATE {$bp->messages->table_name_recipients} SET is_deleted = 1 WHERE thread_id = %d AND user_id = %d", $thread_id, bp_loggedin_user_id() ) );
 
-                // Get the message id in order to pass to the action
-                $message_id = $wpdb->get_var( $wpdb->prepare( "SELECT id FROM {$bp->messages->table_name_messages} WHERE thread_id = %d", $thread_id ) );
+                // Get the message ids in order to pass to the action
+                $message_ids = $wpdb->get_col( $wpdb->prepare( "SELECT id FROM {$bp->messages->table_name_messages} WHERE thread_id = %d", $thread_id ) );
 
                 // Check to see if any more recipients remain for this message
-                // if not, then delete the message from the database.
                 $recipients = $wpdb->get_results( $wpdb->prepare( "SELECT id FROM {$bp->messages->table_name_recipients} WHERE thread_id = %d AND is_deleted = 0", $thread_id ) );
 
+                // No more recipients so delete all messages associated with the thread
                 if ( empty( $recipients ) ) {
+                        /**
+                         * Fires before an entire message thread is deleted.
+                         *
+                         * @since BuddyPress (2.2.0)
+                         *
+                         * @param int $thread_id ID of the thread being deleted.
+                         * @param array $message_ids IDs of messages being deleted
+                         */
+                        do_action( 'bp_messages_thread_before_delete', $thread_id, $message_ids );
+
                         // Delete all the messages
                         $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->messages->table_name_messages} WHERE thread_id = %d", $thread_id ) );
 
+                        // Do something for each message ID
+                        foreach ( $message_ids as $message_id ) {
+                                // Delete message meta
+                                bp_messages_delete_meta( $message_id );
+
+                                /**
+                                 * Fires after a message is deleted. This hook is poorly named.
+                                 *
+                                 * @since BuddyPress (1.0.0)
+                                 *
+                                 * @param int $message_id ID of the message
+                                 */
+                                do_action( 'messages_thread_deleted_thread', $message_id );
+                        }
+
                         // Delete all the recipients
                         $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->messages->table_name_recipients} WHERE thread_id = %d", $thread_id ) );
                 }
 
                 /**
-                 * Fires after a message thread is deleted.
+                 * Fires after a message thread is either marked as deleted or deleted
                  *
                  * @since BuddyPress (2.2.0)
                  *
                  * @param int $thread_id ID of the thread being deleted.
                  */
-                do_action( 'bp_messages_thread_after_delete', $message_id );
+                do_action( 'bp_messages_thread_after_delete', $thread_id, $message_ids );
 
                 return true;
         }
@@ -325 +370 @@
 
                 $threads = false;
                 foreach ( (array) $sorted_threads as $thread_id => $date_sent ) {
-                        $threads[] = new BP_Messages_Thread( $thread_id );
+                        $threads[] = new BP_Messages_Thread( $thread_id, 'ASC', array(
+                                // need some feedback here...
+                                // what are the chances a plugin will need the message meta during the inbox?
+                                'update_meta_cache' => false
+                        ) );
                 }
 
                 /**

src/bp-messages/bp-messages-functions.php

@@ -335 +335 @@
 function messages_is_valid_thread( $thread_id ) {
         return BP_Messages_Thread::is_valid( $thread_id );
 }
+
+/** Messages Meta *******************************************************/
+
+/**
+ * Delete metadata for a message.
+ *
+ * If $meta_key is false, this will delete all meta for the message ID.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @see delete_metadata() for full documentation excluding $meta_type variable.
+ */
+function bp_messages_delete_meta( $message_id, $meta_key = false, $meta_value = false, $delete_all = false ) {
+        // Legacy - if no meta_key is passed, delete all for the item
+        if ( empty( $meta_key ) ) {
+                global $wpdb;
+
+                $keys = $wpdb->get_col( $wpdb->prepare( "SELECT meta_key FROM {$wpdb->messagemeta} WHERE message_id = %d", $message_id ) );
+
+                // With no meta_key, ignore $delete_all
+                $delete_all = false;
+        } else {
+                $keys = array( $meta_key );
+        }
+
+        // no keys, so stop now!
+        if ( empty( $keys ) ) {
+                return false;
+        }
+
+        add_filter( 'query', 'bp_filter_metaid_column_name' );
+
+        foreach ( $keys as $key ) {
+                $retval = delete_metadata( 'message', $message_id, $key, $meta_value, $delete_all );
+        }
+
+        remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+        return $retval;
+}
+
+/**
+ * Get a piece of message metadata.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @see get_metadata() for full documentation excluding $meta_type variable.
+ */
+function bp_messages_get_meta( $message_id, $meta_key = '', $single = true ) {
+        add_filter( 'query', 'bp_filter_metaid_column_name' );
+        $retval = get_metadata( 'message', $message_id, $meta_key, $single );
+        remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+        return $retval;
+}
+
+/**
+ * Update a piece of message metadata.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @see update_metadata() for full documentation excluding $meta_type variable.
+ */
+function bp_messages_update_meta( $message_id, $meta_key, $meta_value, $prev_value = '' ) {
+        add_filter( 'query', 'bp_filter_metaid_column_name' );
+        $retval = update_metadata( 'message', $message_id, $meta_key, $meta_value, $prev_value );
+        remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+        return $retval;
+}
+
+/**
+ * Add a piece of message metadata.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @see add_metadata() for full documentation excluding $meta_type variable.
+ */
+function bp_message_add_meta( $message_id, $meta_key, $meta_value, $unique = false ) {
+        add_filter( 'query', 'bp_filter_metaid_column_name' );
+        $retval = add_metadata( 'message', $message_id, $meta_key, $meta_value, $unique );
+        remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+        return $retval;
+}

src/bp-messages/bp-messages-loader.php

@@ -90 +90 @@
                 $global_tables = array(
                         'table_name_notices'    => $bp->table_prefix . 'bp_messages_notices',
                         'table_name_messages'   => $bp->table_prefix . 'bp_messages_messages',
-                        'table_name_recipients' => $bp->table_prefix . 'bp_messages_recipients'
+                        'table_name_recipients' => $bp->table_prefix . 'bp_messages_recipients',
+                        'table_name_meta'       => $bp->table_prefix . 'bp_messages_meta',
                 );
 
+                // Metadata tables for messaging component
+                $meta_tables = array(
+                        'message' => $bp->table_prefix . 'bp_messages_meta',
+                );
+
+                $this->autocomplete_all = defined( 'BP_MESSAGES_AUTOCOMPLETE_ALL' );
+
                 // All globals for messaging component.
                 // Note that global_tables is included in this array.
-                $globals = array(
+                parent::setup_globals( array(
                         'slug'                  => BP_MESSAGES_SLUG,
                         'has_directory'         => false,
                         'notification_callback' => 'messages_format_notifications',
                         'search_string'         => __( 'Search Messages...', 'buddypress' ),
-                        'global_tables'         => $global_tables
-                );
-
-                $this->autocomplete_all = defined( 'BP_MESSAGES_AUTOCOMPLETE_ALL' );
-
-                parent::setup_globals( $globals );
+                        'global_tables'         => $global_tables,
+                        'meta_tables'           => $meta_tables
+                ) );
         }
 
         /**

src/bp-messages/bp-messages-template.php

@@ -1467 +1467 @@
         /**
          * Constructor method.
          *
-         * @param int $thread_id ID of the message thread.
-         * @param string $order 'ASC' or 'DESC'.
+         * @see BP_Messages_Thread::populate() for full parameter info
          */
-        public function __construct( $thread_id, $order ) {
-                $this->thread        = new BP_Messages_Thread( $thread_id, $order );
+        public function __construct( $thread_id, $order, $args ) {
+                $this->thread        = new BP_Messages_Thread( $thread_id, $order, $args );
                 $this->message_count = count( $this->thread->messages );
 
                 $last_message_index                 = $this->message_count - 1;
@@ -1572 +1571 @@
  *           Default: if viewing a thread, the thread ID will be parsed from
  *           the URL (bp_action_variable( 0 )).
  *     @type string $order 'ASC' or 'DESC'. Default: 'ASC'.
+ *     @type bool $update_meta_cache Whether to pre-fetch metadata for
+ *           queried message items. Default: true.
  * }
  * @return bool True if there are messages to display, otherwise false.
  */
@@ -1579 +1580 @@
         global $thread_template;
 
         $r = bp_parse_args( $args, array(
-                'thread_id' => false,
-                'order'     => 'ASC'
+                'thread_id'         => false,
+                'order'             => 'ASC',
+                'update_meta_cache' => true,
         ), 'thread_has_messages' );
 
         if ( empty( $r['thread_id'] ) && bp_is_messages_component() && bp_is_current_action( 'view' ) ) {
                 $r['thread_id'] = (int) bp_action_variable( 0 );
         }
 
-        $thread_template = new BP_Messages_Thread_Template( $r['thread_id'], $r['order'] );
+        // Set up extra args
+        $extra_args = $r;
+        unset( $extra_args['thread_id'], $extra_args['order'] );
+
+        $thread_template = new BP_Messages_Thread_Template( $r['thread_id'], $r['order'], $extra_args );
 
         return $thread_template->has_messages();
 }
@@ -1992 +1998 @@
 /**
  * Enable oEmbed support for Messages.
  *
- * There's no caching as BP 1.5 does not have a Messages meta API.
- *
  * @since BuddyPress (1.5.0)
  *
  * @see BP_Embed
- *
- * @todo Add Messages meta?
  */
 function bp_messages_embed() {
-        add_filter( 'embed_post_id', 'bp_get_message_thread_id' );
+        add_filter( 'embed_post_id',         'bp_get_the_thread_message_id' );
+        add_filter( 'bp_embed_get_cache',    'bp_embed_message_cache',      10, 3 );
+        add_action( 'bp_embed_update_cache', 'bp_embed_message_save_cache', 10, 3 );
+}
+add_action( 'thread_loop_start', 'bp_messages_embed' );
+
+/**
+ * Fetch a private message item's cached embeds.
+ *
+ * Used during {@link BP_Embed::parse_oembed()} via {@link bp_messages_embed()}.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param string $cache An empty string passed by BP_Embed::parse_oembed() for
+ *        functions like this one to filter.
+ * @param int $id The ID of the message item.
+ * @param string $cachekey The cache key generated in BP_Embed::parse_oembed().
+ * @return mixed The cached embeds for this message item.
+ */
+function bp_embed_message_cache( $cache, $id, $cachekey ) {
+        return bp_messages_get_meta( $id, $cachekey );
+}
+
+/**
+ * Set a private message item's embed cache.
+ *
+ * Used during {@link BP_Embed::parse_oembed()} via {@link bp_messages_embed()}.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param string $cache An empty string passed by BP_Embed::parse_oembed() for
+ *        functions like this one to filter.
+ * @param string $cachekey The cache key generated in BP_Embed::parse_oembed().
+ * @param int $id The ID of the message item.
+ * @return bool True on success, false on failure.
+ */
+function bp_embed_message_save_cache( $cache, $cachekey, $id ) {
+        bp_messages_update_meta( $id, $cachekey, $cache );
 }
-add_action( 'messages_box_loop_start', 'bp_messages_embed' );

src/bp-templates/bp-legacy/buddypress-functions.php

@@ -1298 +1298 @@
 
                 bp_thread_has_messages( array( 'thread_id' => (int) $_REQUEST['thread_id'] ) );
 
+                bp_thread_the_message();
+
                 if ( $thread_template->message_count % 2 == 1 ) {
                         $class = 'odd';
                 } else {

new file tests/phpunit/testcases/messages/cache.php

@@ +1 @@
+<?php
+
+/**
+ * @group messages
+ * @group cache
+ */
+class BP_Tests_Message_Cache extends BP_UnitTestCase {
+        /**
+         * @group bp_messages_update_meta_cache
+         */
+        public function test_bp_messages_update_meta_cache() {
+                $u1 = $this->factory->user->create();
+                $u2 = $this->factory->user->create();
+
+                // create the thread
+                $t1 = $this->factory->message->create( array(
+                        'sender_id'  => $u1,
+                        'recipients' => array( $u2 ),
+                        'subject'    => 'This is a knive',
+                ) );
+
+                // create a reply
+                $this->factory->message->create( array(
+                        'thread_id'  => $t1,
+                        'sender_id'  => $u2,
+                        'recipients' => array( $u1 ),
+                        'content'    => "That's a spoon",
+                ) );
+
+                // grab the message ids as individual variables
+                list( $m1, $m2 ) = $this->get_message_ids( $t1 );
+
+                // add cache for each message
+                bp_messages_update_meta( $m1, 'utensil',  'knive' );
+                bp_messages_update_meta( $m1, 'is_knive', 'yes' );
+
+                bp_messages_update_meta( $m2, 'utensil',  'spoon' );
+                bp_messages_update_meta( $m2, 'is_knive', 'no' );
+                bp_messages_update_meta( $m2, 'is_spoon', 'yes' );
+
+                // prime cache
+                bp_messages_get_meta( $m1, 'utensil' );
+
+                // Ensure an empty cache for second message
+                wp_cache_delete( $m2, 'message_meta' );
+
+                // update message meta cache
+                bp_messages_update_meta_cache( array( $m1, $m2 ) );
+
+                $expected = array(
+                        $m1 => array(
+                                'utensil' => array(
+                                        'knive',
+                                ),
+                                'is_knive' => array(
+                                        'yes',
+                                ),
+                        ),
+                        $m2 => array(
+                                'utensil' => array(
+                                        'spoon',
+                                ),
+                                'is_knive' => array(
+                                        'no',
+                                ),
+                                'is_spoon' => array(
+                                        'yes',
+                                ),
+                        ),
+                );
+
+                $found = array(
+                        $m1 => wp_cache_get( $m1, 'message_meta' ),
+                        $m2 => wp_cache_get( $m2, 'message_meta' ),
+                );
+
+                $this->assertEquals( $expected, $found );
+        }
+
+        /**
+         * @group bp_messages_update_meta_cache
+         * @group bp_thread_has_messages
+         */
+        public function test_bp_messages_metadata_cache_in_message_loop() {
+                $u1 = $this->factory->user->create();
+                $u2 = $this->factory->user->create();
+
+                // create the thread
+                $t1 = $this->factory->message->create( array(
+                        'sender_id'  => $u1,
+                        'recipients' => array( $u2 ),
+                        'subject'    => 'Oy',
+                ) );
+
+                // add message cache
+                list( $m1 ) = $this->get_message_ids( $t1 );
+                bp_messages_update_meta( $m1, 'yolo', 'gah' );
+
+                // prime meta cache in message loop
+                bp_thread_has_messages( array(
+                        'thread_id' => $t1,
+                        'update_meta_cache' => true
+                ) );
+
+                $this->assertNotEmpty( wp_cache_get( $m1, 'message_meta' ) );
+        }
+
+        /**
+         * @group bp_messages_delete_meta
+         * @group messages_delete_thread
+         */
+        public function test_bp_messages_delete_metadata_cache_on_thread_delete() {
+                $this->old_current_user = get_current_user_id();
+
+                $u1 = $this->factory->user->create();
+                $u2 = $this->factory->user->create();
+
+                // create the thread
+                $t1 = $this->factory->message->create( array(
+                        'sender_id'  => $u1,
+                        'recipients' => array( $u2 ),
+                        'subject'    => 'Oy',
+                ) );
+
+                // create a reply
+                $this->factory->message->create( array(
+                        'thread_id'  => $t1,
+                        'sender_id'  => $u2,
+                        'recipients' => array( $u1 ),
+                        'content'    => 'Yo',
+                ) );
+
+                // add message meta
+                list( $m1, $m2 ) = $this->get_message_ids( $t1 );
+                bp_messages_update_meta( $m1, 'yolo', 'gah' );
+                bp_messages_update_meta( $m2, 'yolo', 'bah' );
+
+                // prime message meta cache
+                bp_messages_get_meta( $m1, 'yolo' );
+                bp_messages_get_meta( $m2, 'yolo' );
+
+                // delete thread
+                // to outright delete a thread, both recipients must delete it
+                $this->set_current_user( $u1 );
+                messages_delete_thread( $t1 );
+                $this->set_current_user( $u2 );
+                messages_delete_thread( $t1 );
+
+                // assert empty meta cache
+                $this->assertEmpty( wp_cache_get( $m1, 'message_meta' ) );
+                $this->assertEmpty( wp_cache_get( $m2, 'message_meta' ) );
+
+                // cleanup
+                $this->set_current_user( $this->old_current_user );
+        }
+
+        /**
+         * Helper method to grab the message IDs from a message thread.
+         *
+         * @param int $thread_id The message thread ID
+         * @return array
+         */
+        protected function get_message_ids( $thread_id = 0 ) {
+                $thread = new BP_Messages_Thread( $thread_id );
+                return wp_list_pluck( $thread->messages, 'id' );
+        }
+}