Changeset 49303

Timestamp:

10/24/2020 10:44:38 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API, XML-RPC: Synchronise empty comment content checks.

The REST API and XML-RPC now uses the same detection methodology for empty comment content as wp_handle_comment_submission(). Specifically, comments now have their content trimmed and '0' is allowed.

Props jaswrks, rmccue, dd32, rachelbaker, Cawa-93, aduth, TimothyBlynJacobs.
Fixes #43177.

Location:

trunk

Files:

• src/wp-includes/class-wp-xmlrpc-server.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-comments-controller.php (modified) (1 diff)
• tests/phpunit/tests/xmlrpc/wp/newComment.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-xmlrpc-server.php

@@ -3877 +3877 @@
         }
 
-        if ( empty( $content_struct['content'] ) ) {
-            return new IXR_Error( 403, __( 'Comment is required.' ) );
-        }
-
         $comment = array(
             'comment_post_ID' => $post_id,
-            'comment_content' => $content_struct['content'],
+            'comment_content' => trim( $content_struct['content'] ),
         );
 
@@ -3923 +3919 @@
 
         $comment['comment_parent'] = isset( $content_struct['comment_parent'] ) ? absint( $content_struct['comment_parent'] ) : 0;
+
+        /** This filter is documented in wp-includes/comment.php */
+        $allow_empty = apply_filters( 'allow_empty_comment', false, $comment );
+
+        if ( ! $allow_empty && '' === $comment['comment_content'] ) {
+            return new IXR_Error( 403, __( 'Comment is required.' ) );
+        }
 
         /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

@@ -588 +588 @@
         $prepared_comment['comment_type'] = 'comment';
 
-        /*
-         * Do not allow a comment to be created with missing or empty
-         * comment_content. See wp_handle_comment_submission().
-         */
-        if ( empty( $prepared_comment['comment_content'] ) ) {
+        if ( ! isset( $prepared_comment['comment_content'] ) ) {
+            $prepared_comment['comment_content'] = '';
+        }
+
+        if ( ! $this->check_is_comment_content_allowed( $prepared_comment ) ) {
             return new WP_Error(
                 'rest_comment_content_invalid',
@@ -1281 +1281 @@
          */
         if ( isset( $request['content'] ) && is_string( $request['content'] ) ) {
-            $prepared_comment['comment_content'] = $request['content'];
+            $prepared_comment['comment_content'] = trim( $request['content'] );
         } elseif ( isset( $request['content']['raw'] ) && is_string( $request['content']['raw'] ) ) {
-            $prepared_comment['comment_content'] = $request['content']['raw'];
+            $prepared_comment['comment_content'] = trim( $request['content']['raw'] );
         }
 
@@ -1867 +1867 @@
         return $email;
     }
+
+    /**
+     * If empty comments are not allowed, checks if the provided comment content is not empty.
+     *
+     * @since 5.6.0
+     *
+     * @param array $prepared_comment The prepared comment data.
+     * @return bool True if the content is allowed, false otherwise.
+     */
+    protected function check_is_comment_content_allowed( $prepared_comment ) {
+        $check = wp_parse_args(
+            $prepared_comment,
+            array(
+                'comment_post_ID'      => 0,
+                'comment_parent'       => 0,
+                'user_ID'              => 0,
+                'comment_author'       => null,
+                'comment_author_email' => null,
+                'comment_author_url'   => null,
+            )
+        );
+
+        /** This filter is documented in wp-includes/comment.php */
+        $allow_empty = apply_filters( 'allow_empty_comment', false, $check );
+
+        if ( $allow_empty ) {
+            return true;
+        }
+
+        /*
+         * Do not allow a comment to be created with missing or empty
+         * comment_content. See wp_handle_comment_submission().
+         */
+        return '' !== $check['comment_content'];
+    }
 }

trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php

@@ -1399 +1399 @@
     }
 
+    /**
+     * @ticket 43177
+     */
+    public function test_create_item_invalid_only_spaces_content() {
+        wp_set_current_user( self::$admin_id );
+
+        $params = array(
+            'post'         => self::$post_id,
+            'author_name'  => 'Reverend Lovejoy',
+            'author_email' => 'lovejoy@example.com',
+            'author_url'   => 'http://timothylovejoy.jr',
+            'content'      => '   ',
+        );
+
+        $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
+        $request->add_header( 'content-type', 'application/json' );
+        $request->set_body( wp_json_encode( $params ) );
+
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertErrorResponse( 'rest_comment_content_invalid', $response, 400 );
+    }
+
+    /**
+     * @ticket 43177
+     */
+    public function test_create_item_allows_0_as_content() {
+        wp_set_current_user( self::$admin_id );
+
+        $params = array(
+            'post'         => self::$post_id,
+            'author_name'  => 'Reverend Lovejoy',
+            'author_email' => 'lovejoy@example.com',
+            'author_url'   => 'http://timothylovejoy.jr',
+            'content'      => '0',
+        );
+
+        $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
+        $request->add_header( 'content-type', 'application/json' );
+        $request->set_body( wp_json_encode( $params ) );
+
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertSame( 201, $response->get_status() );
+        $this->assertEquals( '0', $response->get_data()['content']['raw'] );
+    }
+
+    /**
+     * @ticket 43177
+     */
+    public function test_create_item_allow_empty_comment_filter() {
+        add_filter( 'allow_empty_comment', '__return_true' );
+
+        wp_set_current_user( self::$admin_id );
+
+        $params = array(
+            'post'         => self::$post_id,
+            'author_name'  => 'Reverend Lovejoy',
+            'author_email' => 'lovejoy@example.com',
+            'author_url'   => 'http://timothylovejoy.jr',
+            'content'      => '',
+        );
+
+        $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
+        $request->add_header( 'content-type', 'application/json' );
+        $request->set_body( wp_json_encode( $params ) );
+
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertSame( 201, $response->get_status() );
+        $this->assertEquals( '', $response->get_data()['content']['raw'] );
+    }
+
     public function test_create_item_invalid_date() {
         wp_set_current_user( self::$admin_id );

trunk/tests/phpunit/tests/xmlrpc/wp/newComment.php

@@ -51 +51 @@
     }
 
+    /**
+     * @ticket 43177
+     */
+    public function test_empty_content_multiple_spaces() {
+        $result = $this->myxmlrpcserver->wp_newComment(
+            array(
+                1,
+                'administrator',
+                'administrator',
+                self::$post->ID,
+                array(
+                    'content' => '   ',
+                ),
+            )
+        );
+
+        $this->assertIXRError( $result );
+        $this->assertSame( 403, $result->code );
+    }
+
+    /**
+     * @ticket 43177
+     */
+    public function test_valid_comment_0_content() {
+        $result = $this->myxmlrpcserver->wp_newComment(
+            array(
+                1,
+                'administrator',
+                'administrator',
+                self::$post->ID,
+                array(
+                    'content' => '0',
+                ),
+            )
+        );
+
+        $this->assertNotIXRError( $result );
+    }
+
+    /**
+     * @ticket 43177
+     */
+    public function test_valid_comment_allow_empty_content() {
+        add_filter( 'allow_empty_comment', '__return_true' );
+        $result = $this->myxmlrpcserver->wp_newComment(
+            array(
+                1,
+                'administrator',
+                'administrator',
+                self::$post->ID,
+                array(
+                    'content' => '   ',
+                ),
+            )
+        );
+
+        $this->assertNotIXRError( $result );
+    }
+
     function test_new_comment_post_closed() {
         $post = self::factory()->post->create_and_get(