<!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>[36357] branches/4.4: Comments: Use the post-filter WHERE clause when querying for comment descendants.</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/36357">36357</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/36357","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-01-20 05:27:07 +0000 (Wed, 20 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: Use the post-filter WHERE clause when querying for comment descendants.
The descendant query in `WP_Comment_Query::fill_descendants()` uses the clauses
of the main `get_comment_ids()` query as a basis, discarding the `parent`,
`parent__in`, and `parent__not_in` clauses. As implemented in WP 4.4 <a href="https://core.trac.wordpress.org/changeset/34546">[34546]</a>,
the WHERE clause was assembled in such a way that any modifications applied
using the `comments_clauses` filter were not inherited by `fill_descendants()`.
This resulted in descendant queries that did not always properly filter
results, and sometimes contained syntax errors.
The current changeset fixes the problem by using the post-filter WHERE clause
as the basis for the `fill_descendants()` query. This change requires a new
approach for eliminating the unneeded parent-related clauses: instead of
eliminating values in an associative array, we must use regular expressions.
Merges <a href="https://core.trac.wordpress.org/changeset/36277">[36277]</a> to the 4.4 branch.
Props boonebgorges, firebird75.
Fixes <a href="https://core.trac.wordpress.org/ticket/35192">#35192</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches44srcwpincludesclasswpcommentqueryphp">branches/4.4/src/wp-includes/class-wp-comment-query.php</a></li>
<li><a href="#branches44testsphpunittestscommentqueryphp">branches/4.4/tests/phpunit/tests/comment/query.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches44">branches/4.4/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/4.4
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/4.4 2016-01-20 05:23:02 UTC (rev 36356)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/4.4 2016-01-20 05:27:07 UTC (rev 36357)
</ins><a id="branches44"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/4.4</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.1:18031
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.3:20543
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:18512,35802,35823,35825-35826,35829,35832-35834,35837,35839,35850,35876,35880,35897,35922,35931,35933,35943-35944,35978,35994,36003,36005,36007,36038,36040,36042,36045,36048,36056,36068,36081,36089,36094,36096-36097,36100,36108,36110,36117,36119-36121,36123,36130,36132,36134,36137,36141,36154,36157,36163,36168,36226,36251,36258,36260,36276
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:18512,35802,35823,35825-35826,35829,35832-35834,35837,35839,35850,35876,35880,35897,35922,35931,35933,35943-35944,35978,35994,36003,36005,36007,36038,36040,36042,36045,36048,36056,36068,36081,36089,36094,36096-36097,36100,36108,36110,36117,36119-36121,36123,36130,36132,36134,36137,36141,36154,36157,36163,36168,36226,36251,36258,36260,36276-36277
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches44srcwpincludesclasswpcommentqueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.4/src/wp-includes/class-wp-comment-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.4/src/wp-includes/class-wp-comment-query.php 2016-01-20 05:23:02 UTC (rev 36356)
+++ branches/4.4/src/wp-includes/class-wp-comment-query.php 2016-01-20 05:27:07 UTC (rev 36357)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,6 +60,17 @@
</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">+ * SQL WHERE clause.
+ *
+ * Stored after the 'comments_clauses' filter is run on the compiled WHERE sub-clauses.
+ *
+ * @since 4.4.2
+ * @access protected
+ * @var string
+ */
+ protected $filtered_where_clause;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Date query container
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.7.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -816,6 +827,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $limits = isset( $clauses[ 'limits' ] ) ? $clauses[ 'limits' ] : '';
</span><span class="cx" style="display: block; padding: 0 10px"> $groupby = isset( $clauses[ 'groupby' ] ) ? $clauses[ 'groupby' ] : '';
</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->filtered_where_clause = $where;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $where ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $where = 'WHERE ' . $where;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -867,13 +880,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 0 => wp_list_pluck( $comments, 'comment_ID' ),
</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">- $where_clauses = $this->sql_clauses['where'];
- unset(
- $where_clauses['parent'],
- $where_clauses['parent__in'],
- $where_clauses['parent__not_in']
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * The WHERE clause for the descendant query is the same as for the top-level
+ * query, minus the `parent`, `parent__in`, and `parent__not_in` sub-clauses.
+ */
+ $_where = $this->filtered_where_clause;
+ $exclude_keys = array( 'parent', 'parent__in', 'parent__not_in' );
+ foreach ( $exclude_keys as $exclude_key ) {
+ if ( isset( $this->sql_clauses['where'][ $exclude_key ] ) ) {
+ $clause = $this->sql_clauses['where'][ $exclude_key ];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Strip the clause as well as any adjacent ANDs.
+ $pattern = '|(?:AND)?\s*' . $clause . '\s*(?:AND)?|';
+ $_where_parts = preg_split( $pattern, $_where );
+
+ // Remove empties.
+ $_where_parts = array_filter( array_map( 'trim', $_where_parts ) );
+
+ // Reassemble with an AND.
+ $_where = implode( ' AND ', $_where_parts );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Fetch an entire level of the descendant tree at a time.
</span><span class="cx" style="display: block; padding: 0 10px"> $level = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> do {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -882,7 +910,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</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">- $where = 'WHERE ' . implode( ' AND ', $where_clauses ) . ' AND comment_parent IN (' . implode( ',', array_map( 'intval', $parent_ids ) ) . ')';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $where = 'WHERE ' . $_where . ' AND comment_parent IN (' . implode( ',', array_map( 'intval', $parent_ids ) ) . ')';
</ins><span class="cx" style="display: block; padding: 0 10px"> $comment_ids = $wpdb->get_col( "{$this->sql_clauses['select']} {$this->sql_clauses['from']} {$where} {$this->sql_clauses['groupby']} ORDER BY comment_date_gmt ASC, comment_ID ASC" );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $level++;
</span></span></pre></div>
<a id="branches44testsphpunittestscommentqueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.4/tests/phpunit/tests/comment/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.4/tests/phpunit/tests/comment/query.php 2016-01-20 05:23:02 UTC (rev 36356)
+++ branches/4.4/tests/phpunit/tests/comment/query.php 2016-01-20 05:27:07 UTC (rev 36357)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2112,6 +2112,97 @@
</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 35192
+ */
+ public function test_comment_clauses_prepend_callback_should_be_respected_when_filling_descendants() {
+ $top_level_0 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ ) );
+
+ $child1_of_0 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ 'comment_parent' => $top_level_0,
+ ) );
+
+ $child2_of_0 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ 'comment_parent' => $top_level_0,
+ ) );
+
+ $top_level_comments = self::factory()->comment->create_many( 3, array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ ) );
+
+ $this->to_exclude = array( $child2_of_0, $top_level_comments[1] );
+
+ add_filter( 'comments_clauses', array( $this, 'prepend_exclusions' ) );
+ $q = new WP_Comment_Query( array(
+ 'post_id' => $this->post_id,
+ 'hierarchical' => 'flat',
+ ) );
+ remove_filter( 'comments_clauses', array( $this, 'prepend_exclusions' ) );
+
+ unset( $this->to_exclude );
+
+ $this->assertEqualSets( array( $top_level_0, $child1_of_0, $top_level_comments[0], $top_level_comments[2] ), wp_list_pluck( $q->comments, 'comment_ID' ) );
+ }
+
+ public function prepend_exclusions( $clauses ) {
+ global $wpdb;
+ $clauses['where'] = $wpdb->prepare( 'comment_ID != %d AND comment_ID != %d AND ', $this->to_exclude[0], $this->to_exclude[1] ) . $clauses['where'];
+ return $clauses;
+ }
+
+ /**
+ * @ticket 35192
+ */
+ public function test_comment_clauses_append_callback_should_be_respected_when_filling_descendants() {
+ $top_level_0 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ ) );
+
+ $child1_of_0 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ 'comment_parent' => $top_level_0,
+ ) );
+
+ $child2_of_0 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ 'comment_parent' => $top_level_0,
+ ) );
+
+ $top_level_comments = self::factory()->comment->create_many( 3, array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ ) );
+
+ $this->to_exclude = array( $child2_of_0, $top_level_comments[1] );
+
+ add_filter( 'comments_clauses', array( $this, 'append_exclusions' ) );
+ $q = new WP_Comment_Query( array(
+ 'post_id' => $this->post_id,
+ 'hierarchical' => 'flat',
+ ) );
+ remove_filter( 'comments_clauses', array( $this, 'append_exclusions' ) );
+
+ unset( $this->to_exclude );
+
+ $this->assertEqualSets( array( $top_level_0, $child1_of_0, $top_level_comments[0], $top_level_comments[2] ), wp_list_pluck( $q->comments, 'comment_ID' ) );
+ }
+
+ public function append_exclusions( $clauses ) {
+ global $wpdb;
+ $clauses['where'] .= $wpdb->prepare( ' AND comment_ID != %d AND comment_ID != %d', $this->to_exclude[0], $this->to_exclude[1] );
+ return $clauses;
+ }
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 27571
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_update_comment_post_cache_should_be_disabled_by_default() {
</span></span></pre>
</div>
</div>
</body>
</html>