<!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>[59319] trunk: Comments: Use a more precise check for disallowed keys on filtered comment data.</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/59319">59319</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/59319","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-10-29 15:36:56 +0000 (Tue, 29 Oct 2024)</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: Use a more precise check for disallowed keys on filtered comment data.
The previous approach of running `wp_allow_comment()` twice could have unintended consequences, e.g. the `check_comment_flood` action was also triggered twice, which might lead to false-positive identification of comment flood in case there is some custom callback hooked to it, which is not expecting identical data seeing twice.
This commit introduces a new function, `wp_check_comment_data()`, to specifically check for disallowed content before and after comment data is filtered.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/59267">[59267]</a>.
Props david.binda, SergeyBiryukov.
See <a href="https://core.trac.wordpress.org/ticket/61827">#61827</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
<li><a href="#trunktestsphpunittestscommentwpHandleCommentSubmissionphp">trunk/tests/phpunit/tests/comment/wpHandleCommentSubmission.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 2024-10-29 07:31:49 UTC (rev 59318)
+++ trunk/src/wp-includes/comment.php 2024-10-29 15:36:56 UTC (rev 59319)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -773,59 +773,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'comment_flood', $comment_flood_message, 429 );
</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( $commentdata['user_id'] ) ) {
- $user = get_userdata( $commentdata['user_id'] );
- $post_author = $wpdb->get_var(
- $wpdb->prepare(
- "SELECT post_author FROM $wpdb->posts WHERE ID = %d LIMIT 1",
- $commentdata['comment_post_ID']
- )
- );
- }
-
- if ( isset( $user ) && ( $commentdata['user_id'] == $post_author || $user->has_cap( 'moderate_comments' ) ) ) {
- // The author and the admins get respect.
- $approved = 1;
- } else {
- // Everyone else's comments will be checked.
- if ( check_comment(
- $commentdata['comment_author'],
- $commentdata['comment_author_email'],
- $commentdata['comment_author_url'],
- $commentdata['comment_content'],
- $commentdata['comment_author_IP'],
- $commentdata['comment_agent'],
- $commentdata['comment_type']
- ) ) {
- $approved = 1;
- } else {
- $approved = 0;
- }
-
- if ( wp_check_comment_disallowed_list(
- $commentdata['comment_author'],
- $commentdata['comment_author_email'],
- $commentdata['comment_author_url'],
- $commentdata['comment_content'],
- $commentdata['comment_author_IP'],
- $commentdata['comment_agent']
- ) ) {
- $approved = EMPTY_TRASH_DAYS ? 'trash' : 'spam';
- }
- }
-
- /**
- * Filters a comment's approval status before it is set.
- *
- * @since 2.1.0
- * @since 4.9.0 Returning a WP_Error value from the filter will short-circuit comment insertion
- * and allow skipping further processing.
- *
- * @param int|string|WP_Error $approved The approval status. Accepts 1, 0, 'spam', 'trash',
- * or WP_Error.
- * @param array $commentdata Comment data.
- */
- return apply_filters( 'pre_comment_approved', $approved, $commentdata );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return wp_check_comment_data( $commentdata );
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1293,6 +1241,75 @@
</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">+ * Checks whether comment data passes internal checks or has disallowed content.
+ *
+ * @since 6.7.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $comment_data Array of arguments for inserting a comment.
+ * @return int|string|WP_Error The approval status on success (0|1|'spam'|'trash'),
+ * WP_Error otherwise.
+ */
+function wp_check_comment_data( $comment_data ) {
+ global $wpdb;
+
+ if ( ! empty( $comment_data['user_id'] ) ) {
+ $user = get_userdata( $comment_data['user_id'] );
+ $post_author = $wpdb->get_var(
+ $wpdb->prepare(
+ "SELECT post_author FROM $wpdb->posts WHERE ID = %d LIMIT 1",
+ $comment_data['comment_post_ID']
+ )
+ );
+ }
+
+ if ( isset( $user ) && ( $comment_data['user_id'] == $post_author || $user->has_cap( 'moderate_comments' ) ) ) {
+ // The author and the admins get respect.
+ $approved = 1;
+ } else {
+ // Everyone else's comments will be checked.
+ if ( check_comment(
+ $comment_data['comment_author'],
+ $comment_data['comment_author_email'],
+ $comment_data['comment_author_url'],
+ $comment_data['comment_content'],
+ $comment_data['comment_author_IP'],
+ $comment_data['comment_agent'],
+ $comment_data['comment_type']
+ ) ) {
+ $approved = 1;
+ } else {
+ $approved = 0;
+ }
+
+ if ( wp_check_comment_disallowed_list(
+ $comment_data['comment_author'],
+ $comment_data['comment_author_email'],
+ $comment_data['comment_author_url'],
+ $comment_data['comment_content'],
+ $comment_data['comment_author_IP'],
+ $comment_data['comment_agent']
+ ) ) {
+ $approved = EMPTY_TRASH_DAYS ? 'trash' : 'spam';
+ }
+ }
+
+ /**
+ * Filters a comment's approval status before it is set.
+ *
+ * @since 2.1.0
+ * @since 4.9.0 Returning a WP_Error value from the filter will short-circuit comment insertion
+ * and allow skipping further processing.
+ *
+ * @param int|string|WP_Error $approved The approval status. Accepts 1, 0, 'spam', 'trash',
+ * or WP_Error.
+ * @param array $commentdata Comment data.
+ */
+ return apply_filters( 'pre_comment_approved', $approved, $comment_data );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Checks if a comment contains disallowed characters or words.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2279,11 +2296,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $commentdata['comment_approved'] = wp_allow_comment( $commentdata, $wp_error );
</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 ( is_wp_error( $commentdata['comment_approved'] ) ) {
+ return $commentdata['comment_approved'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $commentdata = wp_filter_comment( $commentdata );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $commentdata['comment_approved'], array( 'trash', 'spam' ), true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Validate the comment again after filters are applied to comment data.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $commentdata['comment_approved'] = wp_allow_comment( $commentdata, $wp_error );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $commentdata['comment_approved'] = wp_check_comment_data( $commentdata );
</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 ( is_wp_error( $commentdata['comment_approved'] ) ) {
</span></span></pre></div>
<a id="trunktestsphpunittestscommentwpHandleCommentSubmissionphp"></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/wpHandleCommentSubmission.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment/wpHandleCommentSubmission.php 2024-10-29 07:31:49 UTC (rev 59318)
+++ trunk/tests/phpunit/tests/comment/wpHandleCommentSubmission.php 2024-10-29 15:36:56 UTC (rev 59319)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -989,9 +989,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $comment = wp_handle_comment_submission( $data );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertNotWPError( $comment );
- $this->assertInstanceOf( 'WP_Comment', $comment );
- $this->assertSame( 'trash', $comment->comment_approved );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertInstanceOf( 'WP_Comment', $comment, 'The comment was not submitted.' );
+ $this->assertSame( 'trash', $comment->comment_approved, 'The wrong approved status was returned.' );
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1009,8 +1008,34 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $comment = wp_handle_comment_submission( $data );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertNotWPError( $comment );
- $this->assertInstanceOf( 'WP_Comment', $comment );
- $this->assertSame( 'trash', $comment->comment_approved );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertInstanceOf( 'WP_Comment', $comment, 'The comment was not submitted.' );
+ $this->assertSame( 'trash', $comment->comment_approved, 'The wrong approved status was returned.' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 61827
+ */
+ public function test_disallowed_keys_filtered_html_match_does_not_call_check_comment_flood_action_twice() {
+ $data = array(
+ 'comment_post_ID' => self::$post->ID,
+ 'comment' => '<a href=http://example.com/>example</a>',
+ 'author' => 'Comment Author',
+ 'email' => 'comment@example.org',
+ );
+
+ update_option( 'disallowed_keys', "href=\\\"http\nfoo" );
+
+ $pre_comment_approved = new MockAction();
+ $check_comment_flood = new MockAction();
+ add_filter( 'pre_comment_approved', array( $pre_comment_approved, 'filter' ), 10, 2 );
+ add_action( 'check_comment_flood', array( $check_comment_flood, 'action' ), 10, 4 );
+
+ $comment = wp_handle_comment_submission( $data );
+
+ $this->assertInstanceOf( 'WP_Comment', $comment, 'The comment was not submitted.' );
+ $this->assertSame( 'trash', $comment->comment_approved, 'The wrong approved status was returned.' );
+
+ $this->assertSame( 2, $pre_comment_approved->get_call_count(), 'The `pre_comment_approved` filter was not called twice.' );
+ $this->assertSame( 1, $check_comment_flood->get_call_count(), 'The `check_comment_flood` action was not called exactly once.' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>