<!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>[54530] trunk: Query: Validate relation in `WP_Date_Query`.</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/54530">54530</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/54530","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-10-17 11:47:41 +0000 (Mon, 17 Oct 2022)</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'>Query: Validate relation in `WP_Date_Query`.
Props dd32, johnjamesjacoby, martinkrcho, ehtis, paulkevan, peterwilsoncc.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpdatequeryphp">trunk/src/wp-includes/class-wp-date-query.php</a></li>
<li><a href="#trunktestsphpunittestsdatequeryphp">trunk/tests/phpunit/tests/date/query.php</a></li>
<li><a href="#trunktestsphpunitteststermtaxQueryphp">trunk/tests/phpunit/tests/term/taxQuery.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpdatequeryphp"></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-date-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-date-query.php 2022-10-17 11:40:36 UTC (rev 54529)
+++ trunk/src/wp-includes/class-wp-date-query.php 2022-10-17 11:47:41 UTC (rev 54530)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -150,8 +150,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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( $date_query['relation'] ) && 'OR' === strtoupper( $date_query['relation'] ) ) {
- $this->relation = 'OR';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $date_query['relation'] ) ) {
+ $this->relation = $this->sanitize_relation( $date_query['relation'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->relation = 'AND';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -220,6 +220,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->validate_date_values( $queries );
</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">+ // Sanitize the relation parameter.
+ $queries['relation'] = $this->sanitize_relation( $queries['relation'] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $queries as $key => $q ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $q ) || in_array( $key, $this->time_keys, true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // This is a first-order query. Trust the values and sanitize when building SQL.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1041,4 +1044,20 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $wpdb->prepare( "DATE_FORMAT( $column, %s ) $compare %f", $format, $time );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Sanitizes a 'relation' operator.
+ *
+ * @since 6.0.3
+ *
+ * @param string $relation Raw relation key from the query argument.
+ * @return string Sanitized relation ('AND' or 'OR').
+ */
+ public function sanitize_relation( $relation ) {
+ if ( 'OR' === strtoupper( $relation ) ) {
+ return 'OR';
+ } else {
+ return 'AND';
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsdatequeryphp"></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/date/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/date/query.php 2022-10-17 11:40:36 UTC (rev 54529)
+++ trunk/tests/phpunit/tests/date/query.php 2022-10-17 11:47:41 UTC (rev 54530)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1145,4 +1145,142 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // MySQL ignores the invalid clause.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( array( $p1, $p2 ), $q->posts );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @covers WP_Date_Query::get_sql
+ */
+ public function test_relation_in_query_and() {
+ $date_query = array(
+ 'relation' => 'AND',
+ array(
+ 'before' => array(
+ 'year' => 2021,
+ 'month' => 9,
+ 'day' => 20,
+ ),
+ 'after' => array(
+ 'year' => 2019,
+ 'month' => 2,
+ 'day' => 25,
+ ),
+ 'inclusive' => true,
+ ),
+ array(
+ 'before' => array(
+ 'year' => 2016,
+ 'month' => 9,
+ 'day' => 11,
+ ),
+ 'after' => array(
+ 'year' => 2014,
+ 'month' => 5,
+ 'day' => 12,
+ ),
+ 'inclusive' => false,
+ ),
+ );
+
+ $q = new WP_Date_Query( $date_query );
+
+ $sql = $q->get_sql();
+
+ $parts = mb_split( '\)\s+AND\s+\(', $sql );
+ $this->assertIsArray( $parts, 'SQL query cannot be split into multiple parts using operator AND.' );
+ $this->assertEquals( 2, count( $parts ), 'SQL query does not contain correct number of AND operators.' );
+
+ $this->assertStringNotContainsString( 'OR', $sql, 'SQL query contains conditions joined by operator OR.' );
+ }
+
+ /**
+ * @covers WP_Date_Query::get_sql
+ */
+ public function test_relation_in_query_or() {
+ $date_query = array(
+ 'relation' => 'OR',
+ array(
+ 'before' => array(
+ 'year' => 2021,
+ 'month' => 9,
+ 'day' => 20,
+ ),
+ 'after' => array(
+ 'year' => 2019,
+ 'month' => 2,
+ 'day' => 25,
+ ),
+ 'inclusive' => true,
+ ),
+ array(
+ 'before' => array(
+ 'year' => 2016,
+ 'month' => 9,
+ 'day' => 11,
+ ),
+ 'after' => array(
+ 'year' => 2014,
+ 'month' => 5,
+ 'day' => 12,
+ ),
+ 'inclusive' => false,
+ ),
+ );
+
+ $q = new WP_Date_Query( $date_query );
+
+ $sql = $q->get_sql();
+
+ $this->assertStringContainsString( 'OR', $sql, 'SQL query does not contain conditions joined by operator OR.' );
+
+ $parts = mb_split( '\)\s+OR\s+\(', $sql );
+ $this->assertIsArray( $parts, 'SQL query cannot be split into multiple parts using operator OR.' );
+ $this->assertEquals( 2, count( $parts ), 'SQL query does not contain correct number of OR operators.' );
+
+ // Checking number of occurrences of AND while skipping the one at the beginning.
+ $this->assertSame( 2, substr_count( substr( $sql, 5 ), 'AND' ), 'SQL query does not contain expected number conditions joined by operator AND.' );
+ }
+
+ /**
+ * @covers WP_Date_Query::get_sql
+ */
+ public function test_relation_in_query_unsupported() {
+ $date_query = array(
+ 'relation' => 'UNSUPPORTED',
+ array(
+ 'before' => array(
+ 'year' => 2021,
+ 'month' => 9,
+ 'day' => 20,
+ ),
+ 'after' => array(
+ 'year' => 2019,
+ 'month' => 2,
+ 'day' => 25,
+ ),
+ 'inclusive' => true,
+ ),
+ array(
+ 'before' => array(
+ 'year' => 2016,
+ 'month' => 9,
+ 'day' => 11,
+ ),
+ 'after' => array(
+ 'year' => 2014,
+ 'month' => 5,
+ 'day' => 12,
+ ),
+ 'inclusive' => false,
+ ),
+ );
+
+ $q = new WP_Date_Query( $date_query );
+
+ $sql = $q->get_sql();
+
+ $parts = mb_split( '\)\s+AND\s+\(', $sql );
+ $this->assertIsArray( $parts, 'SQL query cannot be split into multiple parts using operator AND.' );
+ $this->assertEquals( 2, count( $parts ), 'SQL query does not contain correct number of AND operators.' );
+
+ $this->assertStringNotContainsString( 'OR', $sql, 'SQL query contains conditions joined by operator OR.' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitteststermtaxQueryphp"></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/term/taxQuery.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/taxQuery.php 2022-10-17 11:40:36 UTC (rev 54529)
+++ trunk/tests/phpunit/tests/term/taxQuery.php 2022-10-17 11:47:41 UTC (rev 54530)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -335,6 +335,7 @@
</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"> * @ticket 18105
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers WP_Tax_Query::get_sql
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_sql_relation_and_operator_in() {
</span><span class="cx" style="display: block; padding: 0 10px"> register_taxonomy( 'wptests_tax', 'post' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -381,11 +382,17 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 3, substr_count( $sql['join'], 'JOIN' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Checking number of occurrences of AND while skipping the one at the beginning.
+ $this->assertSame( 2, substr_count( substr( $sql['where'], 5 ), 'AND' ), 'SQL query does not contain expected number conditions joined by operator AND.' );
+
+ $this->assertStringNotContainsString( 'OR', $sql['where'], 'SQL query contains conditions joined by operator OR.' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> _unregister_taxonomy( 'wptests_tax' );
</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><span class="cx" style="display: block; padding: 0 10px"> * @ticket 18105
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers WP_Tax_Query::get_sql
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_sql_nested_relation_or_operator_in() {
</span><span class="cx" style="display: block; padding: 0 10px"> register_taxonomy( 'wptests_tax', 'post' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -434,6 +441,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $sql = $tq->get_sql( $wpdb->posts, 'ID' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 2, substr_count( $sql['join'], 'JOIN' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 2, substr_count( $sql['where'], 'OR' ), 'SQL query does not contain expected number conditions joined by operator OR.' );
+ $this->assertStringNotContainsString( 'AND', substr( $sql['where'], 5 ), 'SQL query contains conditions joined by operator AND.' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> _unregister_taxonomy( 'wptests_tax' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -495,4 +504,60 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> _unregister_taxonomy( 'wptests_tax' );
</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 18105
+ * @covers WP_Tax_Query::get_sql
+ */
+ public function test_get_sql_relation_unsupported() {
+ register_taxonomy( 'wptests_tax', 'post' );
+
+ $t1 = self::factory()->term->create(
+ array(
+ 'taxonomy' => 'wptests_tax',
+ )
+ );
+ $t2 = self::factory()->term->create(
+ array(
+ 'taxonomy' => 'wptests_tax',
+ )
+ );
+ $t3 = self::factory()->term->create(
+ array(
+ 'taxonomy' => 'wptests_tax',
+ )
+ );
+
+ $tq = new WP_Tax_Query(
+ array(
+ 'relation' => 'UNSUPPORTED',
+ array(
+ 'taxonomy' => 'wptests_tax',
+ 'field' => 'term_id',
+ 'terms' => $t1,
+ ),
+ array(
+ 'taxonomy' => 'wptests_tax',
+ 'field' => 'term_id',
+ 'terms' => $t2,
+ ),
+ array(
+ 'taxonomy' => 'wptests_tax',
+ 'field' => 'term_id',
+ 'terms' => $t3,
+ ),
+ )
+ );
+
+ global $wpdb;
+ $sql = $tq->get_sql( $wpdb->posts, 'ID' );
+
+ // Checking number of occurrences of AND while skipping the one at the beginning.
+ $this->assertSame( 2, substr_count( substr( $sql['where'], 5 ), 'AND' ), 'SQL query does not contain expected number conditions joined by operator AND.' );
+
+ $this->assertStringNotContainsString( 'UNSUPPORTED', $sql['where'], 'SQL query contains unsupported relation operator.' );
+ $this->assertStringNotContainsString( 'OR', $sql['where'], 'SQL query contains conditions joined by operator OR.' );
+
+ _unregister_taxonomy( 'wptests_tax' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>