Changeset 13196

Timestamp:

12/23/2021 08:07:07 PM (4 years ago)

Author:

imath

Message:

BP Messages: introduce a functionality to exit a messages thread

Exiting a messages thread is removing the user from the list of the recipients of the thread. The thread can carry on between the other recipients.

Props Oelita, vapvarun

Fixes #7540

Location:

trunk

Files:

• src/bp-messages/actions/exit.php (added)
• src/bp-messages/bp-messages-cache.php (modified) (1 diff)
• src/bp-messages/bp-messages-functions.php (modified) (1 diff)
• src/bp-messages/bp-messages-template.php (modified) (1 diff)
• src/bp-messages/classes/class-bp-messages-component.php (modified) (1 diff)
• src/bp-messages/classes/class-bp-messages-thread.php (modified) (1 diff)
• src/bp-templates/bp-legacy/buddypress/members/single/messages/single.php (modified) (2 diffs)
• src/bp-templates/bp-nouveau/buddypress/common/js-templates/messages/index.php (modified) (2 diffs)
• src/bp-templates/bp-nouveau/css/buddypress-rtl.css (modified) (2 diffs)
• src/bp-templates/bp-nouveau/css/buddypress.css (modified) (2 diffs)
• src/bp-templates/bp-nouveau/css/twentytwentyone-rtl.css (modified) (2 diffs)
• src/bp-templates/bp-nouveau/css/twentytwentyone.css (modified) (2 diffs)
• src/bp-templates/bp-nouveau/includes/messages/ajax.php (modified) (3 diffs)
• src/bp-templates/bp-nouveau/js/buddypress-messages.js (modified) (3 diffs)
• src/bp-templates/bp-nouveau/sass/_nouveau_messages.scss (modified) (2 diffs)
• src/bp-templates/bp-nouveau/sass/twentytwentyone.scss (modified) (1 diff)
• tests/phpunit/testcases/messages/class.bp-messages-thread.php (modified) (1 diff)

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

@@ -88 +88 @@
 }
 add_action( 'messages_delete_thread', 'bp_messages_clear_cache_on_message_delete', 10, 2 );
+add_action( 'bp_messages_exit_thread', 'bp_messages_clear_cache_on_message_delete', 10, 2 );
 
 /**

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

@@ -800 +800 @@
     return $retval;
 }
+
+/**
+ * Exit one or more message thread(s) for a given user.
+ *
+ * @since 10.0.0
+ *
+ * @param int|array $thread_ids Thread ID or array of thread IDs.
+ * @param int       $user_id    ID of the user to delete the threads for. Defaults
+ *                              to the current logged-in user.
+ * @return bool True on success, false on failure.
+ */
+function bp_messages_exit_thread( $thread_ids, $user_id = 0 ) {
+
+    if ( empty( $user_id ) ) {
+        $user_id = bp_loggedin_user_id();
+
+        if ( bp_displayed_user_id() ) {
+            $user_id = bp_displayed_user_id();
+        }
+    }
+
+    /**
+     * Fires before a user exits specified thread IDs.
+     *
+     * @since 10.0.0
+     *
+     * @param int|array $thread_ids Thread ID or array of thread IDs to be deleted.
+     * @param int       $user_id    ID of the user the threads are being deleted for.
+     */
+    do_action( 'bp_messages_before_exit_thread', $thread_ids, $user_id );
+
+    if ( is_array( $thread_ids ) ) {
+        $error = 0;
+        for ( $i = 0, $count = count( $thread_ids ); $i < $count; ++$i ) {
+            if ( ! BP_Messages_Thread::exit_thread( $thread_ids[ $i ], $user_id ) ) {
+                $error = 1;
+            }
+        }
+
+        if ( ! empty( $error ) ) {
+            return false;
+        }
+
+        /**
+         * Fires after a user exited the specified thread IDs.
+         *
+         * @since 10.0.0
+         *
+         * @param int|array Thread ID or array of thread IDs that were deleted.
+         * @param int       ID of the user that the threads were deleted for.
+         */
+        do_action( 'bp_messages_exit_thread', $thread_ids, $user_id );
+
+        return true;
+    } else {
+        if ( ! BP_Messages_Thread::exit_thread( $thread_ids, $user_id ) ) {
+            return false;
+        }
+
+        /** This action is documented in bp-messages/bp-messages-functions.php */
+        do_action( 'bp_messages_exit_thread', $thread_ids, $user_id );
+
+        return true;
+    }
+}

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

@@ -2190 +2190 @@
 
 /**
+ * Output the URL to exit the current thread.
+ *
+ * @since 10.0.0
+ */
+function bp_the_thread_exit_link() {
+    echo esc_url( bp_get_the_thread_exit_link() );
+}
+    /**
+     * Get the URL to exit the current thread.
+     *
+     * @since 10.0.0
+     *
+     * @return string URL
+     */
+    function bp_get_the_thread_exit_link() {
+
+        /**
+         * Filters the URL to exit the current thread.
+         *
+         * @since 1.0.0
+         *
+         * @param string $value URL to exit the current thread.
+         * @param string $value Text indicating action being executed.
+         */
+        return apply_filters( 'bp_get_the_thread_exit_link', wp_nonce_url( bp_displayed_user_domain() . bp_get_messages_slug() . '/inbox/exit/' . bp_get_the_thread_id(), 'bp_messages_exit_thread' ) );
+    }
+
+/**
  * Output the 'Sent x hours ago' string for the current message.
  *

trunk/src/bp-messages/classes/class-bp-messages-component.php

@@ -103 +103 @@
             // Authenticated action variables.
             if ( is_user_logged_in() && bp_action_variable( 0 ) &&
-                in_array( bp_action_variable( 0 ), array( 'delete', 'read', 'unread', 'bulk-manage', 'bulk-delete' ), true )
+                in_array( bp_action_variable( 0 ), array( 'delete', 'read', 'unread', 'bulk-manage', 'bulk-delete', 'exit' ), true )
             ) {
                 require $this->path . 'bp-messages/actions/' . bp_action_variable( 0 ) . '.php';

trunk/src/bp-messages/classes/class-bp-messages-thread.php

@@ -531 +531 @@
          */
         do_action( 'bp_messages_thread_after_delete', $thread_id, $message_ids, $user_id );
+
+        return true;
+    }
+
+    /**
+     * Exit a user from a thread.
+     *
+     * @since 10.0.0
+     *
+     * @global wpdb $wpdb WordPress database object.
+     *
+     * @param int $thread_id The message thread ID.
+     * @param int $user_id The ID of the user in the thread.
+     *                     Defaults to the current logged-in user.
+     *
+     * @return bool
+     */
+    public static function exit_thread( $thread_id = 0, $user_id = 0 ) {
+        global $wpdb;
+
+        $thread_id = (int) $thread_id;
+        $user_id   = (int) $user_id;
+
+        if ( empty( $user_id ) ) {
+            $user_id = bp_loggedin_user_id();
+        }
+
+        // Check the user is a recipient of the thread and recipients count > 2.
+        $recipients    = self::get_recipients_for_thread( $thread_id );
+        $recipient_ids = wp_list_pluck( $recipients, 'user_id' );
+
+        if ( 2 >= count( $recipient_ids ) || ! in_array( $user_id, $recipient_ids, true ) ) {
+            return false;
+        }
+
+        /**
+         * Fires before a user exits a thread.
+         *
+         * @since 10.0.0
+         *
+         * @param int $thread_id ID of the thread being deleted.
+         * @param int $user_id   ID of the user that the thread is being deleted for.
+         */
+        do_action( 'bp_messages_thread_before_exit', $thread_id, $user_id );
+
+        $bp = buddypress();
+
+        // Delete the user from messages recipients
+        $exited = $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->messages->table_name_recipients} WHERE thread_id = %d AND user_id = %d", $thread_id, $user_id ) );
+
+        // Bail if the user wasn't removed from the recipients list.
+        if ( empty( $exited ) ) {
+            return false;
+        }
+
+        /**
+         * Fires after a user exits a thread.
+         *
+         * @since 10.0.0
+         *
+         * @param int   $thread_id ID of the thread being deleted.
+         * @param int   $user_id   ID of the user the threads were deleted for.
+         */
+        do_action( 'bp_messages_thread_after_exit', $thread_id, $user_id );
 
         return true;

trunk/src/bp-templates/bp-legacy/buddypress/members/single/messages/single.php

@@ -5 +5 @@
  * @package BuddyPress
  * @subpackage bp-legacy
- * @version 3.0.0
+ * @version 10.0.0
  */
 
@@ -49 +49 @@
             </span>
 
-            <a class="button confirm" href="<?php bp_the_thread_delete_link(); ?>"><?php _e( 'Delete', 'buddypress' ); ?></a>
+            <a class="button confirm" href="<?php bp_the_thread_delete_link(); ?>"><?php esc_html_e( 'Delete', 'buddypress' ); ?></a>
+
+            <?php if ( bp_get_thread_recipients_count() > 2 ) : ?>
+
+                <a class="button confirm" href="<?php bp_the_thread_exit_link(); ?>"><?php esc_html_e( 'Exit Conversation', 'buddypress' ); ?></a>
+
+            <?php endif; ?>
 
             <?php

trunk/src/bp-templates/bp-nouveau/buddypress/common/js-templates/messages/index.php

@@ -189 +189 @@
                         <span class="bp-screen-reader-text"><?php esc_html_e( 'Delete conversation.', 'buddypress' ); ?></span>
                     </button>
+
+                    <# if ( undefined !== data.recipients && data.recipients.length > 2 ) { #>
+                        <button type="button" class="message-action-exit bp-tooltip bp-icons" data-bp-action="exit" data-bp-tooltip="<?php esc_attr_e( 'Exit conversation.', 'buddypress' ); ?>">
+                            <span class="bp-screen-reader-text"><?php esc_html_e( 'Exit conversation.', 'buddypress' ); ?></span>
+                        </button>
+                    <# } #>
 
                     <# if ( undefined !== data.star_link ) { #>
@@ -251 +257 @@
                 <span class="bp-screen-reader-text"><?php esc_html_e( 'Delete conversation.', 'buddypress' ); ?></span>
             </button>
+
+            <# if ( undefined !== data.recipients && data.recipients.length > 2 ) { #>
+                <button type="button" class="message-action-exit bp-tooltip bp-icons" data-bp-action="exit" data-bp-tooltip="<?php esc_attr_e( 'Exit conversation.', 'buddypress' ); ?>">
+                    <span class="bp-screen-reader-text"><?php esc_html_e( 'Exit conversation.', 'buddypress' ); ?></span>
+                </button>
+            <# } #>
         </div>
     </header>

trunk/src/bp-templates/bp-nouveau/css/buddypress-rtl.css

@@ -3072 +3072 @@
 .message-action-unstar:before,
 .message-action-view:before,
-.message-action-delete:before {
+.message-action-delete:before,
+.message-action-exit:before {
     font-family: dashicons;
     font-size: 18px;
@@ -3093 +3094 @@
 .message-action-delete:before {
     content: "\f153";
+}
+
+.message-action-exit:before {
+    content: "\f14a";
 }
 

trunk/src/bp-templates/bp-nouveau/css/buddypress.css

@@ -3072 +3072 @@
 .message-action-unstar:before,
 .message-action-view:before,
-.message-action-delete:before {
+.message-action-delete:before,
+.message-action-exit:before {
     font-family: dashicons;
     font-size: 18px;
@@ -3093 +3094 @@
 .message-action-delete:before {
     content: "\f153";
+}
+
+.message-action-exit:before {
+    content: "\f14a";
 }
 

trunk/src/bp-templates/bp-nouveau/css/twentytwentyone-rtl.css

@@ -907 +907 @@
 }
 
-#buddypress.twentytwentyone .bp-messages-content .actions button.bp-tooltip.message-action-delete:before {
+#buddypress.twentytwentyone .bp-messages-content .actions button.bp-tooltip.message-action-delete:before, #buddypress.twentytwentyone .bp-messages-content .actions button.bp-tooltip.message-action-exit:before {
     width: 32px;
     height: 32px;
@@ -914 +914 @@
 }
 
-#buddypress.twentytwentyone .bp-messages-content .actions button.bp-tooltip.message-action-delete:hover:before {
+#buddypress.twentytwentyone .bp-messages-content .actions button.bp-tooltip.message-action-delete:hover:before, #buddypress.twentytwentyone .bp-messages-content .actions button.bp-tooltip.message-action-exit:hover:before {
     border-radius: 50%;
     color: var(--global--color-background);

trunk/src/bp-templates/bp-nouveau/css/twentytwentyone.css

@@ -907 +907 @@
 }
 
-#buddypress.twentytwentyone .bp-messages-content .actions button.bp-tooltip.message-action-delete:before {
+#buddypress.twentytwentyone .bp-messages-content .actions button.bp-tooltip.message-action-delete:before, #buddypress.twentytwentyone .bp-messages-content .actions button.bp-tooltip.message-action-exit:before {
     width: 32px;
     height: 32px;
@@ -914 +914 @@
 }
 
-#buddypress.twentytwentyone .bp-messages-content .actions button.bp-tooltip.message-action-delete:hover:before {
+#buddypress.twentytwentyone .bp-messages-content .actions button.bp-tooltip.message-action-delete:hover:before, #buddypress.twentytwentyone .bp-messages-content .actions button.bp-tooltip.message-action-exit:hover:before {
     border-radius: 50%;
     color: var(--global--color-background);

trunk/src/bp-templates/bp-nouveau/includes/messages/ajax.php

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 8.0.0
+ * @version 10.0.0
  */
 
@@ -12 +12 @@
 add_action( 'admin_init', function() {
     $ajax_actions = array(
-        array( 'messages_send_message'             => array( 'function' => 'bp_nouveau_ajax_messages_send_message', 'nopriv' => false ) ),
-        array( 'messages_send_reply'               => array( 'function' => 'bp_nouveau_ajax_messages_send_reply', 'nopriv' => false ) ),
-        array( 'messages_get_user_message_threads' => array( 'function' => 'bp_nouveau_ajax_get_user_message_threads', 'nopriv' => false ) ),
-        array( 'messages_thread_read'              => array( 'function' => 'bp_nouveau_ajax_messages_thread_read', 'nopriv' => false ) ),
-        array( 'messages_get_thread_messages'      => array( 'function' => 'bp_nouveau_ajax_get_thread_messages', 'nopriv' => false ) ),
-        array( 'messages_delete'                   => array( 'function' => 'bp_nouveau_ajax_delete_thread_messages', 'nopriv' => false ) ),
-        array( 'messages_unstar'                   => array( 'function' => 'bp_nouveau_ajax_star_thread_messages', 'nopriv' => false ) ),
-        array( 'messages_star'                     => array( 'function' => 'bp_nouveau_ajax_star_thread_messages', 'nopriv' => false ) ),
-        array( 'messages_unread'                   => array( 'function' => 'bp_nouveau_ajax_readunread_thread_messages', 'nopriv' => false ) ),
-        array( 'messages_read'                     => array( 'function' => 'bp_nouveau_ajax_readunread_thread_messages', 'nopriv' => false ) ),
-        array( 'messages_dismiss_sitewide_notice'  => array( 'function' => 'bp_nouveau_ajax_dismiss_sitewide_notice', 'nopriv' => false ) ),
+        array(
+            'messages_send_message' => array(
+                'function' => 'bp_nouveau_ajax_messages_send_message',
+                'nopriv'   => false,
+            ),
+        ),
+        array(
+            'messages_send_reply' => array(
+                'function' => 'bp_nouveau_ajax_messages_send_reply',
+                'nopriv'  => false,
+            ),
+        ),
+        array(
+            'messages_get_user_message_threads' => array(
+                'function' => 'bp_nouveau_ajax_get_user_message_threads',
+                'nopriv'   => false,
+            ),
+        ),
+        array(
+            'messages_thread_read' => array(
+                'function' => 'bp_nouveau_ajax_messages_thread_read',
+                'nopriv'   => false,
+            ),
+        ),
+        array(
+            'messages_get_thread_messages' => array(
+                'function' => 'bp_nouveau_ajax_get_thread_messages',
+                'nopriv'   => false,
+            ),
+        ),
+        array(
+            'messages_delete' => array(
+                'function' => 'bp_nouveau_ajax_delete_thread_messages',
+                'nopriv'   => false,
+            ),
+        ),
+        array(
+            'messages_exit' => array(
+                'function' => 'bp_nouveau_ajax_exit_thread_messages',
+                'nopriv'   => false,
+            ),
+        ),
+        array(
+            'messages_unstar' => array(
+                'function' => 'bp_nouveau_ajax_star_thread_messages',
+                'nopriv'   => false,
+            ),
+        ),
+        array(
+            'messages_star' => array(
+                'function' => 'bp_nouveau_ajax_star_thread_messages',
+                'nopriv'   => false,
+            ),
+        ),
+        array(
+            'messages_unread' => array(
+                'function' => 'bp_nouveau_ajax_readunread_thread_messages',
+                'nopriv'   => false,
+            ),
+        ),
+        array(
+            'messages_read' => array(
+                'function' => 'bp_nouveau_ajax_readunread_thread_messages',
+                'nopriv'   => false,
+            ),
+        ),
+        array(
+            'messages_dismiss_sitewide_notice'  => array(
+                'function' => 'bp_nouveau_ajax_dismiss_sitewide_notice',
+                'nopriv' => false,
+            ),
+        ),
     );
 
@@ -781 +842 @@
     }
 }
+
+/**
+ * Ajax Handler of the exit action.
+ *
+ * @since 10.0.0
+ */
+function bp_nouveau_ajax_exit_thread_messages() {
+    $response = array(
+        'feedback' => __( 'There was a problem exiting the conversation. Please try again.', 'buddypress' ),
+        'type'     => 'error',
+    );
+
+    if ( empty( $_POST['nonce'] ) || ! wp_verify_nonce( $_POST['nonce'], 'bp_nouveau_messages' ) ) {
+        wp_send_json_error( $response );
+    }
+
+    if ( empty( $_POST['id'] ) ) {
+        wp_send_json_error( $response );
+    }
+
+    $thread_ids = wp_parse_id_list( $_POST['id'] );
+
+    foreach ( $thread_ids as $thread_id ) {
+        if ( ! messages_check_thread_access( $thread_id ) && ! bp_current_user_can( 'bp_moderate' ) ) {
+            wp_send_json_error( $response );
+        }
+
+        bp_messages_exit_thread( $thread_id );
+    }
+
+    wp_send_json_success( array(
+        'feedback' => __( 'You have left the message thread.', 'buddypress' ),
+        'type'     => 'success',
+    ) );
+}

trunk/src/bp-templates/bp-nouveau/js/buddypress-messages.js

@@ -979 +979 @@
                 bp.Nouveau.Messages.displayFeedback( response.feedback, response.type );
 
-                if ( 'delete' === action || ( 'starred' === self.collection.options.box && 'unstar' === action ) ) {
+                if ( 'delete' === action || 'exit' === action || ( 'starred' === self.collection.options.box && 'unstar' === action ) ) {
                     // Remove from the list of messages.
                     self.collection.remove( model.get( 'id' ) );
@@ -1090 +1090 @@
                 bp.Nouveau.Messages.displayFeedback( response.feedback, response.type );
 
-                if ( 'delete' === action || ( 'starred' === self.collection.options.box && 'unstar' === action ) ) {
+                if ( 'delete' === action || 'exit' === action || ( 'starred' === self.collection.options.box && 'unstar' === action ) ) {
                     // Remove from the list of messages.
                     self.collection.remove( thread_ids );
@@ -1242 +1242 @@
             bp.Nouveau.Messages.threads.doAction( action, this.model.get( 'id' ), options ).done( function( response ) {
                 // Remove all views
-                if ( 'delete' === action ) {
+                if ( 'delete' === action || 'exit' === action ) {
                     bp.Nouveau.Messages.clearViews();
                 } else if ( response.messages ) {

trunk/src/bp-templates/bp-nouveau/sass/_nouveau_messages.scss

@@ -8 +8 @@
 .message-action-unstar:before,
 .message-action-view:before,
-.message-action-delete:before {
+.message-action-delete:before,
+.message-action-exit:before {
     font-family: dashicons;
     font-size: 18px;
@@ -29 +30 @@
 .message-action-delete:before {
     content: "\f153";
+}
+
+.message-action-exit:before {
+    content: "\f14a";
 }
 

trunk/src/bp-templates/bp-nouveau/sass/twentytwentyone.scss

@@ -1228 +1228 @@
                 background: none;
 
-                &.message-action-delete {
+                &.message-action-delete,
+                &.message-action-exit {
 
                     &:before {

trunk/tests/phpunit/testcases/messages/class.bp-messages-thread.php

@@ -672 +672 @@
         $this->assertEquals( 'Bar and baz.', $thread->last_message_content );
     }
+
+    /**
+     * @group exit
+     * @ticket BP7540
+     */
+    public function test_bp_messages_thread_exit() {
+        $u1 = self::factory()->user->create();
+        $u2 = self::factory()->user->create();
+        $u3 = self::factory()->user->create();
+
+        $message = self::factory()->message->create_and_get( array(
+            'sender_id' => $u1,
+            'recipients' => array( $u2, $u3 ),
+            'subject' => 'Foo Bar',
+            'date_sent' => bp_core_current_time(),
+            'content' => 'Foo Bar is there.',
+        ) );
+
+        $t1 = $message->thread_id;
+
+        $this->assertTrue( BP_Messages_Thread::exit_thread( $t1, $u3 ) );
+    }
+
+    /**
+     * @group exit
+     * @ticket BP7540
+     */
+    public function test_bp_messages_thread_exit_not_enougth_recipients() {
+        $u1 = self::factory()->user->create();
+        $u2 = self::factory()->user->create();
+
+        $message = self::factory()->message->create_and_get( array(
+            'sender_id' => $u1,
+            'recipients' => array( $u2 ),
+            'subject' => 'Bar Foo',
+            'date_sent' => bp_core_current_time(),
+            'content' => 'Bar Foo is also there.',
+        ) );
+
+        $t1 = $message->thread_id;
+
+        $this->assertFalse( BP_Messages_Thread::exit_thread( $t1, $u2 ) );
+    }
+
+    /**
+     * @group exit
+     * @ticket BP7540
+     */
+    public function test_bp_messages_thread_exit_not_one_of_recipients() {
+        $u1 = self::factory()->user->create();
+        $u2 = self::factory()->user->create();
+        $u3 = self::factory()->user->create();
+        $u4 = self::factory()->user->create();
+
+        $message = self::factory()->message->create_and_get( array(
+            'sender_id' => $u1,
+            'recipients' => array( $u2, $u3 ),
+            'subject' => 'Taz',
+            'date_sent' => bp_core_current_time(),
+            'content' => 'Where is Taz?',
+        ) );
+
+        $t1 = $message->thread_id;
+
+        $this->assertFalse( BP_Messages_Thread::exit_thread( $t1, $u4 ) );
+    }
 }