<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[49303] trunk: REST API, XML-RPC: Synchronise empty comment content checks.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/49303">49303</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/49303","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-10-24 22:44:38 +0000 (Sat, 24 Oct 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/43177">#43177</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpxmlrpcserverphp">trunk/src/wp-includes/class-wp-xmlrpc-server.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestcommentscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestcommentscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php</a></li>
<li><a href="#trunktestsphpunittestsxmlrpcwpnewCommentphp">trunk/tests/phpunit/tests/xmlrpc/wp/newComment.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpxmlrpcserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-xmlrpc-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-xmlrpc-server.php 2020-10-24 16:02:34 UTC (rev 49302)
+++ trunk/src/wp-includes/class-wp-xmlrpc-server.php 2020-10-24 22:44:38 UTC (rev 49303)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3876,13 +3876,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return new IXR_Error( 403, __( 'Sorry, comments are closed for this item.' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $content_struct['content'] ) ) {
- return new IXR_Error( 403, __( 'Comment is required.' ) );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $comment = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_post_ID' => $post_id,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'comment_content' => $content_struct['content'],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'comment_content' => trim( $content_struct['content'] ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $logged_in ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3923,6 +3919,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $comment['comment_parent'] = isset( $content_struct['comment_parent'] ) ? absint( $content_struct['comment_parent'] ) : 0;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** 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.' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'xmlrpc_call', 'wp.newComment' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestcommentscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 2020-10-24 16:02:34 UTC (rev 49302)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 2020-10-24 22:44:38 UTC (rev 49303)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -587,11 +587,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_comment['comment_type'] = 'comment';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * 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'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $prepared_comment['comment_content'] ) ) {
+ $prepared_comment['comment_content'] = '';
+ }
+
+ if ( ! $this->check_is_comment_content_allowed( $prepared_comment ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error(
</span><span class="cx" style="display: block; padding: 0 10px"> 'rest_comment_content_invalid',
</span><span class="cx" style="display: block; padding: 0 10px"> __( 'Invalid comment content.' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1280,9 +1280,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * the 'content.raw' properties of the Request object.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $request['content'] ) && is_string( $request['content'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $prepared_comment['comment_content'] = $request['content'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $prepared_comment['comment_content'] = trim( $request['content'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( isset( $request['content']['raw'] ) && is_string( $request['content']['raw'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $prepared_comment['comment_content'] = $request['content']['raw'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $prepared_comment['comment_content'] = trim( $request['content']['raw'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $request['post'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1866,4 +1866,39 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $email;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * 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'];
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestcommentscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php 2020-10-24 16:02:34 UTC (rev 49302)
+++ trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php 2020-10-24 22:44:38 UTC (rev 49303)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1398,6 +1398,76 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_comment_content_invalid', $response, 400 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @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'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_create_item_invalid_date() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$admin_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsxmlrpcwpnewCommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/xmlrpc/wp/newComment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/xmlrpc/wp/newComment.php 2020-10-24 16:02:34 UTC (rev 49302)
+++ trunk/tests/phpunit/tests/xmlrpc/wp/newComment.php 2020-10-24 22:44:38 UTC (rev 49303)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -50,6 +50,65 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 403, $result->code );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @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 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_new_comment_post_closed() {
</span><span class="cx" style="display: block; padding: 0 10px"> $post = self::factory()->post->create_and_get(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span></span></pre>
</div>
</div>
</body>
</html>