<!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>[39101] trunk: REST API: Return an error when the length of a comment field is too long.</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 { 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/39101">39101</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/39101","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>rachelbaker</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-11-03 01:11:30 +0000 (Thu, 03 Nov 2016)</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: Return an error when the length of a comment field is too long.
Introduces `wp_check_comment_data_max_lengths()` which allows both the REST API comments endpoints and `wp_handle_comment_submission()` to check the length of the comment content, author name, author url, and author email fields against their respective database columns.
Props rachelbaker, mangeshp, salcode, pento.
Fixes <a href="https://core.trac.wordpress.org/ticket/38477">#38477</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.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>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommentphp"></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/comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment.php 2016-11-02 23:59:28 UTC (rev 39100)
+++ trunk/src/wp-includes/comment.php 2016-11-03 01:11:30 UTC (rev 39101)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1122,6 +1122,37 @@
</span><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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Compares the lengths of comment data against the maximum character limits.
+ *
+ * @since 4.7.0
+ *
+ * @param array $comment_data Array of arguments for inserting a comment.
+ * @return WP_Error|true WP_Error when a comment field exceeds the limit,
+ * otherwise true.
+ */
+function wp_check_comment_data_max_lengths( $comment_data ) {
+ $max_lengths = wp_get_comment_fields_max_lengths();
+
+ if ( isset( $comment_data['comment_author'] ) && mb_strlen( $comment_data['comment_author'], '8bit' ) > $max_lengths['comment_author'] ) {
+ return new WP_Error( 'comment_author_column_length', __( '<strong>ERROR</strong>: your name is too long.' ), 200 );
+ }
+
+ if ( isset( $comment_data['comment_author_email'] ) && strlen( $comment_data['comment_author_email'] ) > $max_lengths['comment_author_email'] ) {
+ return new WP_Error( 'comment_author_email_column_length', __( '<strong>ERROR</strong>: your email address is too long.' ), 200 );
+ }
+
+ if ( isset( $comment_data['comment_author_url'] ) && strlen( $comment_data['comment_author_url'] ) > $max_lengths['comment_author_url'] ) {
+ return new WP_Error( 'comment_author_url_column_length', __( '<strong>ERROR</strong>: your url is too long.' ), 200 );
+ }
+
+ if ( isset( $comment_data['comment_content'] ) && mb_strlen( $comment_data['comment_content'], '8bit' ) > $max_lengths['comment_content'] ) {
+ return new WP_Error( 'comment_content_column_length', __( '<strong>ERROR</strong>: your comment is too long.' ), 200 );
+ }
+
+ return true;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Does comment contain blacklisted characters or words.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3032,7 +3063,6 @@
</span><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"> $comment_type = '';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $max_lengths = wp_get_comment_fields_max_lengths();
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( get_option( 'require_name_email' ) && ! $user->exists() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 6 > strlen( $comment_author_email ) || '' == $comment_author ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3042,22 +3072,8 @@
</span><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">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( isset( $comment_author ) && $max_lengths['comment_author'] < mb_strlen( $comment_author, '8bit' ) ) {
- return new WP_Error( 'comment_author_column_length', __( '<strong>ERROR</strong>: your name is too long.' ), 200 );
- }
-
- if ( isset( $comment_author_email ) && $max_lengths['comment_author_email'] < strlen( $comment_author_email ) ) {
- return new WP_Error( 'comment_author_email_column_length', __( '<strong>ERROR</strong>: your email address is too long.' ), 200 );
- }
-
- if ( isset( $comment_author_url ) && $max_lengths['comment_author_url'] < strlen( $comment_author_url ) ) {
- return new WP_Error( 'comment_author_url_column_length', __( '<strong>ERROR</strong>: your url is too long.' ), 200 );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( '' == $comment_content ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'require_valid_comment', __( '<strong>ERROR</strong>: please type a comment.' ), 200 );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } elseif ( $max_lengths['comment_content'] < mb_strlen( $comment_content, '8bit' ) ) {
- return new WP_Error( 'comment_content_column_length', __( '<strong>ERROR</strong>: your comment is too long.' ), 200 );
</del><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"> $commentdata = compact(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3071,6 +3087,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_ID'
</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">+ $check_max_lengths = wp_check_comment_data_max_lengths( $commentdata );
+ if ( is_wp_error( $check_max_lengths ) ) {
+ return $check_max_lengths;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $comment_id = wp_new_comment( wp_slash( $commentdata ), true );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $comment_id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $comment_id;
</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 2016-11-02 23:59:28 UTC (rev 39100)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 2016-11-03 01:11:30 UTC (rev 39101)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -484,6 +484,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_comment['comment_agent'] = '';
</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">+ $check_comment_lengths = wp_check_comment_data_max_lengths( $prepared_comment );
+ if ( is_wp_error( $check_comment_lengths ) ) {
+ $error_code = $check_comment_lengths->get_error_code();
+ return new WP_Error( $error_code, __( 'Comment field exceeds maximum length allowed.' ), array( 'status' => 400 ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $prepared_comment['comment_approved'] = wp_allow_comment( $prepared_comment, true );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $prepared_comment['comment_approved'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -631,6 +637,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_args['comment_ID'] = $id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $check_comment_lengths = wp_check_comment_data_max_lengths( $prepared_args );
+ if ( is_wp_error( $check_comment_lengths ) ) {
+ $error_code = $check_comment_lengths->get_error_code();
+ return new WP_Error( $error_code, __( 'Comment field exceeds maximum length allowed.' ), array( 'status' => 400 ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $updated = wp_update_comment( $prepared_args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 0 === $updated ) {
</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 2016-11-02 23:59:28 UTC (rev 39100)
+++ trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php 2016-11-03 01:11:30 UTC (rev 39101)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1352,6 +1352,98 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 400, $response->get_status() );
</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 38477
+ */
+ public function test_create_comment_author_name_too_long() {
+ wp_set_current_user( 0 );
+
+ $params = array(
+ 'post' => self::$post_id,
+ 'author_name' => rand_long_str( 246 ),
+ 'author_email' => 'murphy@gingivitis.com',
+ 'author_url' => 'http://jazz.gingivitis.com',
+ 'content' => 'This isn\'t a saxophone. It\'s an umbrella.',
+ 'date' => '1995-04-30T10:22:00',
+ );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
+
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $params ) );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'comment_author_column_length', $response, 400 );
+ }
+
+ /**
+ * @ticket 38477
+ */
+ public function test_create_comment_author_email_too_long() {
+ wp_set_current_user( 0 );
+
+ $params = array(
+ 'post' => self::$post_id,
+ 'author_name' => 'Bleeding Gums Murphy',
+ 'author_email' => 'murphy@' . rand_long_str( 190 ) . '.com',
+ 'author_url' => 'http://jazz.gingivitis.com',
+ 'content' => 'This isn\'t a saxophone. It\'s an umbrella.',
+ 'date' => '1995-04-30T10:22:00',
+ );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
+
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $params ) );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'comment_author_email_column_length', $response, 400 );
+ }
+
+ /**
+ * @ticket 38477
+ */
+ public function test_create_comment_author_url_too_long() {
+ wp_set_current_user( 0 );
+
+ $params = array(
+ 'post' => self::$post_id,
+ 'author_name' => 'Bleeding Gums Murphy',
+ 'author_email' => 'murphy@gingivitis.com',
+ 'author_url' => 'http://jazz.' . rand_long_str( 185 ) . '.com',
+ 'content' => 'This isn\'t a saxophone. It\'s an umbrella.',
+ 'date' => '1995-04-30T10:22:00',
+ );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
+
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $params ) );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'comment_author_url_column_length', $response, 400 );
+ }
+
+ /**
+ * @ticket 38477
+ */
+ public function test_create_comment_content_too_long() {
+ wp_set_current_user( 0 );
+
+ $params = array(
+ 'post' => self::$post_id,
+ 'author_name' => 'Bleeding Gums Murphy',
+ 'author_email' => 'murphy@gingivitis.com',
+ 'author_url' => 'http://jazz.gingivitis.com',
+ 'content' => rand_long_str( 66525 ),
+ 'date' => '1995-04-30T10:22:00',
+ );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
+
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $params ) );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'comment_content_column_length', $response, 400 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_update_item() {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id = $this->factory->post->create();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1609,6 +1701,81 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'children', $response->get_links() );
</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 38477
+ */
+ public function test_update_comment_author_name_too_long() {
+ wp_set_current_user( self::$admin_id );
+
+ $params = array(
+ 'author_name' => rand_long_str( 246 ),
+ 'content' => 'This isn\'t a saxophone. It\'s an umbrella.',
+ );
+ $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/comments/%d', self::$approved_id ) );
+
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $params ) );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'comment_author_column_length', $response, 400 );
+ }
+
+ /**
+ * @ticket 38477
+ */
+ public function test_update_comment_author_email_too_long() {
+ wp_set_current_user( self::$admin_id );
+
+ $params = array(
+ 'author_email' => 'murphy@' . rand_long_str( 190 ) . '.com',
+ 'content' => 'This isn\'t a saxophone. It\'s an umbrella.',
+ );
+ $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/comments/%d', self::$approved_id ) );
+
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $params ) );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'comment_author_email_column_length', $response, 400 );
+ }
+
+ /**
+ * @ticket 38477
+ */
+ public function test_update_comment_author_url_too_long() {
+ wp_set_current_user( self::$admin_id );
+
+ $params = array(
+ 'author_url' => 'http://jazz.' . rand_long_str( 185 ) . '.com',
+ 'content' => 'This isn\'t a saxophone. It\'s an umbrella.',
+ );
+ $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/comments/%d', self::$approved_id ) );
+
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $params ) );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'comment_author_url_column_length', $response, 400 );
+ }
+
+ /**
+ * @ticket 38477
+ */
+ public function test_update_comment_content_too_long() {
+ wp_set_current_user( self::$admin_id );
+
+ $params = array(
+ 'content' => rand_long_str( 66525 ),
+ );
+ $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/comments/%d', self::$approved_id ) );
+
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $params ) );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'comment_content_column_length', $response, 400 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_delete_item() {
</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>
</div>
</body>
</html>