<!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>[55083] trunk: Taxonomy: Remove placeholder from `WP_Term_Query` cache key.</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/55083">55083</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/55083","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-01-18 09:56:55 +0000 (Wed, 18 Jan 2023)</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'>Taxonomy: Remove placeholder from `WP_Term_Query` cache key.
Remove escape placeholder from query cache key, as placeholders are on a based on a unique id on every request. This meant that it is impossible for a cache to be reused, making queries that use escape placeholders such as searches, meta queries or using the `description__like` / `name__like` parameters were unable to be cached.
Follow on from <a href="https://core.trac.wordpress.org/changeset/54634">[54634]</a>.
Props spacedmonkey, peterwilsoncc.
Fixes <a href="https://core.trac.wordpress.org/ticket/57298">#57298</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswptermqueryphp">trunk/src/wp-includes/class-wp-term-query.php</a></li>
<li><a href="#trunktestsphpunitteststermqueryphp">trunk/tests/phpunit/tests/term/query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswptermqueryphp"></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-term-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-term-query.php 2023-01-17 21:32:42 UTC (rev 55082)
+++ trunk/src/wp-includes/class-wp-term-query.php 2023-01-18 09:56:55 UTC (rev 55083)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -774,20 +774,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->terms;
</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">- // $args can be anything. Only use the args defined in defaults to compute the key.
- $cache_args = wp_array_slice_assoc( $args, array_keys( $this->query_var_defaults ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cache_key = $this->generate_cache_key( $args, $this->request );
+ $cache = wp_cache_get( $cache_key, 'terms' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $cache_args['update_term_meta_cache'] );
-
- if ( 'count' !== $_fields && 'all_with_object_id' !== $_fields ) {
- $cache_args['fields'] = 'all';
- }
-
- $key = md5( serialize( $cache_args ) . serialize( $taxonomies ) . $this->request );
- $last_changed = wp_cache_get_last_changed( 'terms' );
- $cache_key = "get_terms:$key:$last_changed";
- $cache = wp_cache_get( $cache_key, 'terms' );
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( false !== $cache ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'ids' === $_fields ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $cache = array_map( 'intval', $cache );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1142,4 +1131,36 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $term_objects;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Generate cache key.
+ *
+ * @since 6.2.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $args WP_Term_Query arguments.
+ * @param string $sql SQL statement.
+ *
+ * @return string Cache key.
+ */
+ protected function generate_cache_key( array $args, $sql ) {
+ global $wpdb;
+ // $args can be anything. Only use the args defined in defaults to compute the key.
+ $cache_args = wp_array_slice_assoc( $args, array_keys( $this->query_var_defaults ) );
+
+ unset( $cache_args['update_term_meta_cache'] );
+
+ if ( 'count' !== $args['fields'] && 'all_with_object_id' !== $args['fields'] ) {
+ $cache_args['fields'] = 'all';
+ }
+ $taxonomies = (array) $args['taxonomy'];
+
+ // Replace wpdb placeholder in the SQL statement used by the cache key.
+ $sql = $wpdb->remove_placeholder_escape( $sql );
+
+ $key = md5( serialize( $cache_args ) . serialize( $taxonomies ) . $sql );
+ $last_changed = wp_cache_get_last_changed( 'terms' );
+ return "get_terms:$key:$last_changed";
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitteststermqueryphp"></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/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/query.php 2023-01-17 21:32:42 UTC (rev 55082)
+++ trunk/tests/phpunit/tests/term/query.php 2023-01-18 09:56:55 UTC (rev 55083)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -867,4 +867,124 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( $t1, $q->terms );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Ensure cache keys are generated without WPDB placeholders.
+ *
+ * @ticket 57298
+ *
+ * @covers WP_Term_Query::generate_cache_key
+ * @dataProvider data_query_cache
+ */
+ public function test_generate_cache_key_placeholder( $args ) {
+ global $wpdb;
+ $query1 = new WP_Term_Query();
+ $query1->query( $args );
+
+ $query_vars = $query1->query_vars;
+ $request = $query1->request;
+
+ $reflection = new ReflectionMethod( $query1, 'generate_cache_key' );
+ $reflection->setAccessible( true );
+
+ $cache_key_1 = $reflection->invoke( $query1, $query_vars, $request );
+
+ $request_without_placeholder = $wpdb->remove_placeholder_escape( $request );
+
+ $cache_key_2 = $reflection->invoke( $query1, $query_vars, $request_without_placeholder );
+
+ $this->assertSame( $cache_key_1, $cache_key_2, 'Cache key differs when using wpdb placeholder.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[] Test parameters.
+ */
+ public function data_query_cache() {
+ return array(
+ 'empty query' => array(
+ 'args' => array(),
+ ),
+ 'search query' => array(
+ 'args' => array(
+ 'search' => 'title',
+ ),
+ ),
+ 'search name query' => array(
+ 'args' => array(
+ 'name__like' => 'title',
+ ),
+ ),
+ 'search description query' => array(
+ 'args' => array(
+ 'description__like' => 'title',
+ ),
+ ),
+ 'meta query' => array(
+ 'args' => array(
+ 'meta_query' => array(
+ array(
+ 'key' => 'color',
+ ),
+ ),
+ ),
+ ),
+ 'meta query search' => array(
+ 'args' => array(
+ 'meta_query' => array(
+ array(
+ 'key' => 'color',
+ 'value' => '00',
+ 'compare' => 'LIKE',
+ ),
+ ),
+ ),
+ ),
+ 'nested meta query search' => array(
+ 'args' => array(
+ 'meta_query' => array(
+ 'relation' => 'AND',
+ array(
+ 'key' => 'color',
+ 'value' => '00',
+ 'compare' => 'LIKE',
+ ),
+ array(
+ 'relation' => 'OR',
+ array(
+ 'key' => 'color',
+ 'value' => '00',
+ 'compare' => 'LIKE',
+ ),
+ array(
+ 'relation' => 'AND',
+ array(
+ 'key' => 'wp_test_suite',
+ 'value' => '56802',
+ 'compare' => 'LIKE',
+ ),
+ array(
+ 'key' => 'wp_test_suite_too',
+ 'value' => '56802',
+ 'compare' => 'LIKE',
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ 'meta query not like search' => array(
+ 'args' => array(
+ 'meta_query' => array(
+ array(
+ 'key' => 'color',
+ 'value' => 'ff',
+ 'compare' => 'NOT LIKE',
+ ),
+ ),
+ ),
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>