Ticket #6063: 6063.meta-query.patch

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

@@ -359 +359 @@
                         'type'         => 'all',
                         'limit'        => null,
                         'page'         => null,
-                        'search_terms' => ''
+                        'search_terms' => '',
+                        'meta_query'   => array()
                 );
                 $r = wp_parse_args( $args, $defaults );
 
                 $user_id_sql = $pag_sql = $type_sql = $search_sql = '';
+                $meta_query_sql = array(
+                        'join'  => '',
+                        'where' => ''
+                );
 
                 if ( $r['limit'] && $r['page'] ) {
                         $pag_sql = $wpdb->prepare( " LIMIT %d, %d", intval( ( $r['page'] - 1 ) * $r['limit'] ), intval( $r['limit'] ) );
@@ -390 +395 @@
                         }
                 }
 
+                // Process meta query into SQL
+                $meta_query = self::get_meta_query_sql( $r['meta_query'] );
+                if ( ! empty( $meta_query['join'] ) ) {
+                        $meta_query_sql['join'] = $meta_query['join'];
+                }
+                if ( ! empty( $meta_query['where'] ) ) {
+                        $meta_query_sql['where'] = $meta_query['where'];
+                }
+
                 // set up SQL array
                 $sql = array();
                 $sql['select'] = 'SELECT m.thread_id, MAX(m.date_sent) AS date_sent';
-                $sql['from']   = "FROM {$bp->messages->table_name_recipients} r INNER JOIN {$bp->messages->table_name_messages} m";
-                $sql['where']  = "WHERE m.thread_id = r.thread_id {$user_id_sql} AND r.is_deleted = 0 {$type_sql} {$search_sql}";
+                $sql['from']   = "FROM {$bp->messages->table_name_recipients} r INNER JOIN {$bp->messages->table_name_messages} m {$meta_query_sql['join']}";
+                $sql['where']  = "WHERE m.thread_id = r.thread_id {$user_id_sql} AND r.is_deleted = 0 {$type_sql} {$search_sql} {$meta_query_sql['where']}";
                 $sql['misc']   = "GROUP BY m.thread_id ORDER BY date_sent DESC {$pag_sql}";
 
                 // get thread IDs
@@ -436 +450 @@
         }
 
         /**
+         * Get the SQL for the 'meta_query' param in BP_Messages_Thread::get_current_threads_for_user().
+         *
+         * We use WP_Meta_Query to do the heavy lifting of parsing the meta_query array
+         * and creating the necessary SQL clauses.
+         *
+         * @since BuddyPress (2.2.0)
+         *
+         * @param array $meta_query An array of meta_query filters. See the
+         *   documentation for WP_Meta_Query for details.
+         * @return array $sql_array 'join' and 'where' clauses.
+         */
+        public static function get_meta_query_sql( $meta_query = array() ) {
+                global $wpdb;
+
+                $sql_array = array(
+                        'join'  => '',
+                        'where' => '',
+                );
+
+                if ( ! empty( $meta_query ) ) {
+                        $meta_query = new WP_Meta_Query( $meta_query );
+
+                        // WP_Meta_Query expects the table name at
+                        // $wpdb->messagemeta
+                        $wpdb->messagemeta = buddypress()->messages->table_name_meta;
+
+                        return $meta_query->get_sql( 'message', 'm', 'id' );
+                }
+
+                return $sql_array;
+        }
+
+        /**
          * Mark a thread as read.
          *
          * @since BuddyPress (1.0.0)

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

@@ -381 +381 @@
  *           the value of $_REQUEST['s'].
  *     @type string $page_arg URL argument used for the pagination param.
  *           Default: 'mpage'.
+ *     @type array $meta_query Meta query arguments. Only applicable if $box is
+ *           not 'notices'. See WP_Meta_Query more details.
  * }
  * @return bool True if there are threads to display, otherwise false.
  */
@@ -405 +407 @@
                 'type'         => 'all',
                 'search_terms' => isset( $_REQUEST['s'] ) ? stripslashes( $_REQUEST['s'] ) : '',
                 'page_arg'     => 'mpage', // See https://buddypress.trac.wordpress.org/ticket/3679
+                'meta_query'   => array()
         ), 'has_message_threads' );
 
         // If trying to access notices without capabilities, redirect to root domain

tests/phpunit/testcases/messages/template.php

@@ -68 +68 @@
                 $this->assertEquals( 1, $messages_template->thread_count );
                 $this->assertSame( array( $t1 ), wp_list_pluck( $messages_template->threads, 'thread_id' ) );
         }
+
+        /**
+         * @group bp_has_message_threads
+         * @group meta_query
+         */
+        public function test_thread_has_messages_meta_query() {
+                $u1 = $this->factory->user->create();
+                $u2 = $this->factory->user->create();
+
+                // create some threads
+                $t1 = $this->factory->message->create( array(
+                        'sender_id'  => $u1,
+                        'recipients' => array( $u2 ),
+                        'subject'    => 'This is a knive',
+                ) );
+                $t2 = $this->factory->message->create( array(
+                        'sender_id'  => $u1,
+                        'recipients' => array( $u2 ),
+                        'subject'    => 'Oy',
+                ) );
+
+                // misc threads
+                $this->factory->message->create_many( 3, array(
+                        'sender_id'  => $u1,
+                        'recipients' => array( $u2 ),
+                ) );
+
+                // create some replies for thread 1
+                $this->factory->message->create( array(
+                        'thread_id'  => $t1,
+                        'sender_id'  => $u2,
+                        'recipients' => array( $u1 ),
+                        'content'    => "That's a spoon",
+                ) );
+                $this->factory->message->create( array(
+                        'thread_id'  => $t1,
+                        'sender_id'  => $u1,
+                        'recipients' => array( $u2 ),
+                        'content'    => "I see you've played knivey-spooney before.",
+                ) );
+                $this->factory->message->create( array(
+                        'thread_id'  => $t1,
+                        'sender_id'  => $u2,
+                        'recipients' => array( $u1 ),
+                        'content'    => '*crickets*',
+                ) );
+
+                // create some replies for thread 2
+                $this->factory->message->create( array(
+                        'thread_id'  => $t2,
+                        'sender_id'  => $u2,
+                        'recipients' => array( $u1 ),
+                        'content'    => "Oy yourself.",
+                ) );
+
+                // grab the message ids as individual variables for thread 1
+                $thread = new BP_Messages_Thread( $t1 );
+                $mids = wp_list_pluck( $thread->messages, 'id' );
+                list( $m1, $m2, $m3, $m4 ) = $mids;
+
+                // grab the message ids as individual variables for thread 2
+                $thread = new BP_Messages_Thread( $t2 );
+                $mids = wp_list_pluck( $thread->messages, 'id' );
+                list( $m5, $m6 ) = $mids;
+
+                // add meta for some of the messages
+                bp_messages_update_meta( $m1, 'utensil',  'knive' );
+                bp_messages_update_meta( $m1, 'is_knive', 'yes' );
+                bp_messages_update_meta( $m1, "starred_by_user_{$u2}", true );
+
+                bp_messages_update_meta( $m2, 'utensil',  'spoon' );
+                bp_messages_update_meta( $m2, 'is_knive', 'no' );
+                bp_messages_update_meta( $m2, 'is_spoon', 'yes' );
+
+                bp_messages_update_meta( $m3, "starred_by_user_{$u2}", true );
+
+                bp_messages_update_meta( $m5, "starred_by_user_{$u2}", true );
+
+                // now, do the message thread loop query
+                global $messages_template;
+                bp_has_message_threads( array(
+                        'user_id' => $u2,
+                        'meta_query' => array(
+                                array(
+                                        'key' => "starred_by_user_{$u2}"
+                                ),
+                        )
+                ) );
+
+                $this->assertEquals( 2, $messages_template->thread_count );
+                $this->assertEqualSets( array( $t1, $t2 ), wp_list_pluck( $messages_template->threads, 'thread_id' ) );
+        }
+
+        /**
+         * @group bp_has_message_threads
+         * @group meta_query
+         */
+        public function test_thread_has_messages_meta_query_multiple_clauses_relation_and() {
+                $u1 = $this->factory->user->create();
+                $u2 = $this->factory->user->create();
+
+                // create some threads
+                $t1 = $this->factory->message->create( array(
+                        'sender_id'  => $u1,
+                        'recipients' => array( $u2 ),
+                        'subject'    => 'This is a knive',
+                ) );
+                $t2 = $this->factory->message->create( array(
+                        'sender_id'  => $u1,
+                        'recipients' => array( $u2 ),
+                        'subject'    => 'Oy',
+                ) );
+
+                // misc threads
+                $this->factory->message->create_many( 3, array(
+                        'sender_id'  => $u1,
+                        'recipients' => array( $u2 ),
+                ) );
+
+                // create some replies for thread 1
+                $this->factory->message->create( array(
+                        'thread_id'  => $t1,
+                        'sender_id'  => $u2,
+                        'recipients' => array( $u1 ),
+                        'content'    => "That's a spoon",
+                ) );
+                $this->factory->message->create( array(
+                        'thread_id'  => $t1,
+                        'sender_id'  => $u1,
+                        'recipients' => array( $u2 ),
+                        'content'    => "I see you've played knivey-spooney before.",
+                ) );
+                $this->factory->message->create( array(
+                        'thread_id'  => $t1,
+                        'sender_id'  => $u2,
+                        'recipients' => array( $u1 ),
+                        'content'    => '*crickets*',
+                ) );
+
+                // create some replies for thread 2
+                $this->factory->message->create( array(
+                        'thread_id'  => $t2,
+                        'sender_id'  => $u2,
+                        'recipients' => array( $u1 ),
+                        'content'    => "Oy yourself.",
+                ) );
+
+                // grab the message ids as individual variables for thread 1
+                $thread = new BP_Messages_Thread( $t1 );
+                $mids = wp_list_pluck( $thread->messages, 'id' );
+                list( $m1, $m2, $m3, $m4 ) = $mids;
+
+                // grab the message ids as individual variables for thread 2
+                $thread = new BP_Messages_Thread( $t2 );
+                $mids = wp_list_pluck( $thread->messages, 'id' );
+                list( $m5, $m6 ) = $mids;
+
+                // add meta for some of the messages
+                bp_messages_update_meta( $m1, 'utensil',  'knive' );
+                bp_messages_update_meta( $m1, 'is_knive', 'yes' );
+                bp_messages_update_meta( $m1, "starred_by_user_{$u2}", true );
+
+                bp_messages_update_meta( $m2, 'utensil',  'spoon' );
+                bp_messages_update_meta( $m2, 'is_knive', 'no' );
+                bp_messages_update_meta( $m2, 'is_spoon', 'yes' );
+
+                bp_messages_update_meta( $m3, "starred_by_user_{$u2}", true );
+
+                bp_messages_update_meta( $m5, "starred_by_user_{$u2}", true );
+
+                // now, do the message thread loop query
+                global $messages_template;
+                bp_has_message_threads( array(
+                        'user_id' => $u2,
+                        'meta_query' => array(
+                                'relation' => 'AND',
+                                array(
+                                        'key' => "starred_by_user_{$u2}"
+                                ),
+                                array(
+                                        'key' => 'utensil',
+                                        'value' => 'knive',
+                                ),
+                        )
+                ) );
+
+                $this->assertEquals( 1, $messages_template->thread_count );
+                $this->assertEqualSets( array( $t1 ), wp_list_pluck( $messages_template->threads, 'thread_id' ) );
+        }
 }
+ No newline at end of file