Changeset 13986

Timestamp:

07/27/2024 07:16:17 PM (11 months ago)

Author:

espellcaste

Message:

Allow creating messages with non-empty content.

Use of the PHP empty function to check if the message content is empty is not ideal when creating a message. Update the logic to consider any string as non-empty.

Props emaralive, niftythree.

See #9175
Closes ​https://github.com/buddypress/buddypress/pull/330

Location:

trunk

Files:

• src/bp-messages/bp-messages-functions.php (modified) (2 diffs)
• tests/phpunit/testcases/messages/functions.php (modified) (2 diffs)

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

@@ -57 +57 @@
     );
 
+    // Check if the message content is empty.
+    $content       = $r['content'];
+    $empty_content = false;
+
+    // Any string is considered non-empty.
+    if ( ! is_string( $content ) || '' === $content ) {
+        $empty_content = true;
+    }
+
     // Bail if no sender or no content.
-    if ( empty( $r['sender_id'] ) || empty( $r['content'] ) ) {
+    if ( empty( $r['sender_id'] ) || $empty_content ) {
         if ( 'wp_error' === $r['error_type'] ) {
             if ( empty( $r['sender_id'] ) ) {
@@ -69 +78 @@
 
             return new WP_Error( $error_code, $feedback );
-
-        } else {
-            return false;
-        }
+        }
+
+        return false;
     }
 

trunk/tests/phpunit/testcases/messages/functions.php

@@ -27 +27 @@
 
         // send another message and get recheck unread count
-        $t2 = messages_new_message( array(
+        messages_new_message( array(
             'sender_id'  => $u1,
             'recipients' => array( $u2 ),
@@ -40 +40 @@
         // recheck unread count
         $this->assertEquals( 1, messages_get_unread_count( $u2 ) );
+    }
+
+    /**
+     * @dataProvider provider_new_message_empty_content_options
+     *
+     * @ticket BP9175
+     * @group messages_new_message
+     */
+    public function test_messages_new_message_empty_content( $content ) {
+        $t1 = messages_new_message(
+            array(
+                'sender_id'  => self::factory()->user->create(),
+                'recipients' => array( self::factory()->user->create() ),
+                'subject'    => 'A new message',
+                'content'    => $content,
+                'error_type' => 'wp_error'
+            )
+        );
+
+        $this->assertSame(
+            'Your message was not sent. Please enter some content.',
+            $t1->get_error_message()
+        );
+    }
+
+    /**
+     * @dataProvider provider_new_message_irregular_content_options
+     *
+     * @ticket BP9175
+     * @group messages_new_message
+     */
+    public function test_messages_new_message_irregular_content( $content ) {
+        $t1 = messages_new_message( array(
+            'sender_id'  => self::factory()->user->create(),
+            'recipients' => array( self::factory()->user->create() ),
+            'subject'    => 'A new message',
+            'content'    => $content,
+            'error_type' => 'wp_error'
+        ) );
+
+        $this->assertTrue( is_int( $t1 ) );
+    }
+
+    /**
+     * Provider for the test_messages_new_message_irregular_content_options() test.
+     *
+     * @return array
+     */
+    public function provider_new_message_irregular_content_options() {
+        return array(
+            array( '0' ),
+            array( '00' ),
+            array( 'false' ),
+        );
+    }
+
+    /**
+     * Provider for the test_messages_new_message_empty_content() test.
+     *
+     * @return array
+     */
+    public function provider_new_message_empty_content_options() {
+        return array(
+            array( '' ),
+            array( "" ),
+            array( null ),
+            array( false ),
+            array( 0 ), // '0' is a valid message content.
+            array( array() ),
+            array( new stdClass() ),
+        );
     }