<!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>[36272] trunk: Comments: Restrict the maximum characters for input fields within the comments template.</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/36272">36272</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/36272","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-01-13 01:24:46 +0000 (Wed, 13 Jan 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'>Comments: Restrict the maximum characters for input fields within the comments template.
Added hardcoded maxlength attributes on the author, author_email, author_url, and comment_field input markup. These can be modified via the comment_form_defaults filter. Added logic in wp_handle_comment_submission() to return a WP_Error when the comment_author, comment_author_url, or comment_content values exceed the max length of their columns. Introduces wp_get_comment_column_max_length() which returns the max column length for a given column name, and is filterable. Unit tests included for the error conditions in wp_handle_comment_submission()
Fixes <a href="https://core.trac.wordpress.org/ticket/10377">#10377</a>.
Props westonruter rachelbaker.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
<li><a href="#trunktestsphpunitincludesutilsphp">trunk/tests/phpunit/includes/utils.php</a></li>
<li><a href="#trunktestsphpunittestscommentsubmissionphp">trunk/tests/phpunit/tests/comment-submission.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommenttemplatephp"></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-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment-template.php 2016-01-12 20:42:46 UTC (rev 36271)
+++ trunk/src/wp-includes/comment-template.php 2016-01-13 01:24:46 UTC (rev 36272)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2099,11 +2099,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $html5 = 'html5' === $args['format'];
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'author' => '<p class="comment-form-author">' . '<label for="author">' . __( 'Name' ) . ( $req ? ' <span class="required">*</span>' : '' ) . '</label> ' .
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<input id="author" name="author" type="text" value="' . esc_attr( $commenter['comment_author'] ) . '" size="30"' . $aria_req . $html_req . ' /></p>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<input id="author" name="author" type="text" value="' . esc_attr( $commenter['comment_author'] ) . '" size="30" maxlength="245"' . $aria_req . $html_req . ' /></p>',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'email' => '<p class="comment-form-email"><label for="email">' . __( 'Email' ) . ( $req ? ' <span class="required">*</span>' : '' ) . '</label> ' .
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<input id="email" name="email" ' . ( $html5 ? 'type="email"' : 'type="text"' ) . ' value="' . esc_attr( $commenter['comment_author_email'] ) . '" size="30" aria-describedby="email-notes"' . $aria_req . $html_req . ' /></p>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<input id="email" name="email" ' . ( $html5 ? 'type="email"' : 'type="text"' ) . ' value="' . esc_attr( $commenter['comment_author_email'] ) . '" size="30" maxlength="100" aria-describedby="email-notes"' . $aria_req . $html_req . ' /></p>',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'url' => '<p class="comment-form-url"><label for="url">' . __( 'Website' ) . '</label> ' .
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<input id="url" name="url" ' . ( $html5 ? 'type="url"' : 'type="text"' ) . ' value="' . esc_attr( $commenter['comment_author_url'] ) . '" size="30" /></p>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<input id="url" name="url" ' . ( $html5 ? 'type="url"' : 'type="text"' ) . ' value="' . esc_attr( $commenter['comment_author_url'] ) . '" size="30" maxlength="200" /></p>',
</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"> $required_text = sprintf( ' ' . __('Required fields are marked %s'), '<span class="required">*</span>' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2118,7 +2118,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = apply_filters( 'comment_form_default_fields', $fields );
</span><span class="cx" style="display: block; padding: 0 10px"> $defaults = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'fields' => $fields,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'comment_field' => '<p class="comment-form-comment"><label for="comment">' . _x( 'Comment', 'noun' ) . '</label> <textarea id="comment" name="comment" cols="45" rows="8" aria-required="true" required="required"></textarea></p>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'comment_field' => '<p class="comment-form-comment"><label for="comment">' . _x( 'Comment', 'noun' ) . '</label> <textarea id="comment" name="comment" cols="45" rows="8" maxlength="65525" aria-required="true" required="required"></textarea></p>',
</ins><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/link-template.php */
</span><span class="cx" style="display: block; padding: 0 10px"> 'must_log_in' => '<p class="must-log-in">' . sprintf( __( 'You must be <a href="%s">logged in</a> to post a comment.' ), wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/link-template.php */
</span></span></pre></div>
<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-01-12 20:42:46 UTC (rev 36271)
+++ trunk/src/wp-includes/comment.php 2016-01-13 01:24:46 UTC (rev 36272)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -948,6 +948,43 @@
</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">+ * Calculate the maximum character length of a column from the comments table.
+ *
+ * @since 4.5.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $column Name of a column in the comments table.
+ * @return int Maximum column character length.
+ */
+function wp_get_comment_column_max_length( $column ) {
+ global $wpdb;
+
+ $col_length = $wpdb->get_col_length( $wpdb->comments, $column );
+ if ( ! is_array( $col_length ) && (int) $col_length > 0 ) {
+ $max_length = (int) $col_length;
+ } elseif ( is_array( $col_length ) && isset( $col_length['length'] ) && intval( $col_length['length'] ) > 0 ) {
+ $max_length = (int) $col_length['length'];
+ } else {
+ $max_length = 255;
+ }
+
+ if ( ! empty( $col_length['type'] ) && 'byte' === $col_length['type'] ) {
+ $max_length = $max_length - 10;
+ }
+
+ /**
+ * Filters the calculated length for a given column of the comments table.
+ *
+ * @since 4.5.0
+ *
+ * @param int $max_length Maximum column character length.
+ * @param string $column Column name.
+ */
+ return apply_filters( 'wp_get_comment_column_max_length', $max_length, $column );
+}
+
+/**
</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">@@ -2778,8 +2815,22 @@
</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">+ if ( isset( $comment_author ) && wp_get_comment_column_max_length( '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 ) && wp_get_comment_column_max_length( '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 ) && wp_get_comment_column_max_length( '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 );
+ }
+
</ins><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( wp_get_comment_column_max_length( 'comment_content' ) < mb_strlen( $comment_content, '8bit' ) ) {
+ return new WP_Error( 'comment_content_column_length', __( '<strong>ERROR</strong>: your comment is too long.' ), 200 );
</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"> $commentdata = compact(
</span></span></pre></div>
<a id="trunktestsphpunitincludesutilsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/utils.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/utils.php 2016-01-12 20:42:46 UTC (rev 36271)
+++ trunk/tests/phpunit/includes/utils.php 2016-01-13 01:24:46 UTC (rev 36272)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,6 +6,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return substr(md5(uniqid(rand())), 0, $len);
</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">+function rand_long_str( $length ) {
+ $chars = 'abcdefghijklmnopqrstuvwxyz';
+ $string = '';
+
+ for ( $i = 0; $i < $length; $i++ ) {
+ $rand = rand( 0, strlen( $chars ) - 1 );
+ $string .= substr( $chars, $rand, 1 );
+ }
+
+ return $string;
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // strip leading and trailing whitespace from each line in the string
</span><span class="cx" style="display: block; padding: 0 10px"> function strip_ws($txt) {
</span><span class="cx" style="display: block; padding: 0 10px"> $lines = explode("\n", $txt);
</span></span></pre></div>
<a id="trunktestsphpunittestscommentsubmissionphp"></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/comment-submission.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment-submission.php 2016-01-12 20:42:46 UTC (rev 36271)
+++ trunk/tests/phpunit/tests/comment-submission.php 2016-01-13 01:24:46 UTC (rev 36272)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -593,6 +593,86 @@
</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">+ * @ticket 10377
+ */
+ public function test_submitting_comment_with_content_too_long_returns_error() {
+ $error = 'comment_content_column_length';
+
+ $post = self::factory()->post->create_and_get();
+
+ $data = array(
+ 'comment_post_ID' => $post->ID,
+ 'comment' => rand_long_str( 65536 ),
+ 'author' => 'Comment Author',
+ 'email' => 'comment@example.org',
+ );
+ $comment = wp_handle_comment_submission( $data );
+
+ $this->assertWPError( $comment );
+ $this->assertSame( $error, $comment->get_error_code() );
+ }
+
+ /**
+ * @ticket 10377
+ */
+ public function test_submitting_comment_with_author_too_long_returns_error() {
+ $error = 'comment_author_column_length';
+
+ $post = self::factory()->post->create_and_get();
+
+ $data = array(
+ 'comment_post_ID' => $post->ID,
+ 'comment' => rand_str(),
+ 'author' => rand_long_str( 255 ),
+ 'email' => 'comment@example.org',
+ );
+ $comment = wp_handle_comment_submission( $data );
+
+ $this->assertWPError( $comment );
+ $this->assertSame( $error, $comment->get_error_code() );
+ }
+
+ /**
+ * @ticket 10377
+ */
+ public function test_submitting_comment_with_email_too_long_returns_error() {
+ $error = 'comment_author_email_column_length';
+
+ $post = self::factory()->post->create_and_get();
+
+ $data = array(
+ 'comment_post_ID' => $post->ID,
+ 'comment' => rand_str(),
+ 'author' => 'Comment Author',
+ 'email' => rand_long_str( 90 ) . '@example.com',
+ );
+ $comment = wp_handle_comment_submission( $data );
+
+ $this->assertWPError( $comment );
+ $this->assertSame( $error, $comment->get_error_code() );
+ }
+
+ /**
+ * @ticket 10377
+ */
+ public function test_submitting_comment_with_url_too_long_returns_error() {
+ $error = 'comment_author_url_column_length';
+
+ $post = self::factory()->post->create_and_get();
+ $data = array(
+ 'comment_post_ID' => $post->ID,
+ 'comment' => rand_str(),
+ 'author' => 'Comment Author',
+ 'email' => 'comment@example.org',
+ 'url' => rand_long_str( 201 ),
+ );
+ $comment = wp_handle_comment_submission( $data );
+
+ $this->assertWPError( $comment );
+ $this->assertSame( $error, $comment->get_error_code() );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 34997
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_comment_submission_sends_all_expected_parameters_to_preprocess_comment_filter() {
</span></span></pre>
</div>
</div>
</body>
</html>