<!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>[41662] trunk: Database: Throw a notice if `wpdb::prepare()` is called with an incorrect number of arguments</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/41662">41662</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/41662","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-10-02 02:10:14 +0000 (Mon, 02 Oct 2017)</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'>Database: Throw a notice if `wpdb::prepare()` is called with an incorrect number of arguments
`wpdb::prepare()` currently gives no information if the number of arguments passed doesn't match the number of placeholders in the query. This change gives an explicit notice that the call was incorrect.
Also fixes an enrelated term meta test that was triggering this new notice.
Props thekt12 for the initial patch.
Fixes <a href="https://core.trac.wordpress.org/ticket/42040">#42040</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeswpdbphp">trunk/src/wp-includes/wp-db.php</a></li>
<li><a href="#trunktestsphpunittestsdbphp">trunk/tests/phpunit/tests/db.php</a></li>
<li><a href="#trunktestsphpunitteststermmetaphp">trunk/tests/phpunit/tests/term/meta.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeswpdbphp"></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/wp-db.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/wp-db.php 2017-10-02 01:43:48 UTC (rev 41661)
+++ trunk/src/wp-includes/wp-db.php 2017-10-02 02:10:14 UTC (rev 41662)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1251,7 +1251,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $query = str_replace( '"%s"', '%s', $query ); // doublequote unquoting
</span><span class="cx" style="display: block; padding: 0 10px"> $query = preg_replace( '|(?<!%)%f|' , '%F', $query ); // Force floats to be locale unaware
</span><span class="cx" style="display: block; padding: 0 10px"> $query = preg_replace( '|(?<!%)%s|', "'%s'", $query ); // quote the strings, avoiding escaped strings like %%s
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $query = preg_replace( '/%(?:%|$|([^dsF]))/', '%%\\1', $query ); // escape any unescaped percents
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $query = preg_replace( '/%(?:%|$|([^dsF]))/', '%%\\1', $query ); // escape any unescaped percents
+
+ // Count the number of valid placeholders in the query
+ $placeholders = preg_match_all( '/(^|[^%]|(%%)+)%[sdF]/', $query );
+
+ if ( count ( $args ) !== $placeholders ) {
+ _doing_it_wrong( 'wpdb::prepare',
+ sprintf( __( 'The query does not contain the correct number of placeholders (%d) for the number of arguments passed (%d).' ),
+ $placeholders,
+ count( $args ) ),
+ '4.9.0'
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> array_walk( $args, array( $this, 'escape_by_ref' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> return @vsprintf( $query, $args );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2046,7 +2059,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $conditions = implode( ' AND ', $conditions );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $sql = "UPDATE `$table` SET $fields WHERE $conditions";
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->check_current_query = false;
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->query( $this->prepare( $sql, $values ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsdbphp"></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/db.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/db.php 2017-10-02 01:43:48 UTC (rev 41661)
+++ trunk/tests/phpunit/tests/db.php 2017-10-02 02:10:14 UTC (rev 41662)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -375,8 +375,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( "SELECT * FROM $wpdb->users WHERE id = 0 AND user_login = 'admin'", $prepared );
</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">- function test_prepare_vsprintf() {
- global $wpdb;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_prepare_vsprintf() {
+ global $wpdb;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared = $wpdb->prepare( "SELECT * FROM $wpdb->users WHERE id = %d AND user_login = %s", array( 1, "admin" ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( "SELECT * FROM $wpdb->users WHERE id = 1 AND user_login = 'admin'", $prepared );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -393,8 +393,75 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared = @$wpdb->prepare( "SELECT * FROM $wpdb->users WHERE id = %d AND user_login = %s", array( array( 1 ), "admin" ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( "SELECT * FROM $wpdb->users WHERE id = 0 AND user_login = 'admin'", $prepared );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</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 42040
+ * @dataProvider data_prepare_incorrect_arg_count
+ * @expectedIncorrectUsage wpdb::prepare
+ */
+ public function test_prepare_incorrect_arg_count( $query, $args, $expected ) {
+ global $wpdb;
+
+ // $query is the first argument to be passed to wpdb::prepare()
+ array_unshift( $args, $query );
+
+ $prepared = @call_user_func_array( array( $wpdb, 'prepare' ), $args );
+ $this->assertEquals( $expected, $prepared );
+ }
+
+ public function data_prepare_incorrect_arg_count() {
+ global $wpdb;
+
+ return array(
+ array(
+ "SELECT * FROM $wpdb->users WHERE id = %d AND user_login = %s", // Query
+ array( 1, "admin", "extra-arg" ), // ::prepare() args, to be passed via call_user_func_array
+ "SELECT * FROM $wpdb->users WHERE id = 1 AND user_login = 'admin'", // Expected output
+ ),
+ array(
+ "SELECT * FROM $wpdb->users WHERE id = %%%d AND user_login = %s",
+ array( 1 ),
+ false,
+ ),
+ array(
+ "SELECT * FROM $wpdb->users WHERE id = %d AND user_login = %s",
+ array( array( 1, "admin", "extra-arg" ) ),
+ "SELECT * FROM $wpdb->users WHERE id = 1 AND user_login = 'admin'",
+ ),
+ array(
+ "SELECT * FROM $wpdb->users WHERE id = %d AND %% AND user_login = %s",
+ array( 1, "admin", "extra-arg" ),
+ "SELECT * FROM $wpdb->users WHERE id = 1 AND % AND user_login = 'admin'",
+ ),
+ array(
+ "SELECT * FROM $wpdb->users WHERE id = %%%d AND %F AND %f AND user_login = %s",
+ array( 1, 2.3, "4.5", "admin", "extra-arg" ),
+ "SELECT * FROM $wpdb->users WHERE id = %1 AND 2.300000 AND 4.500000 AND user_login = 'admin'",
+ ),
+ array(
+ "SELECT * FROM $wpdb->users WHERE id = %d AND user_login = %s",
+ array( array( 1 ), "admin", "extra-arg" ),
+ "SELECT * FROM $wpdb->users WHERE id = 0 AND user_login = 'admin'",
+ ),
+ array(
+ "SELECT * FROM $wpdb->users WHERE id = %d and user_nicename = %s and user_status = %d and user_login = %s",
+ array( 1, "admin", 0 ),
+ '',
+ ),
+ array(
+ "SELECT * FROM $wpdb->users WHERE id = %d and user_nicename = %s and user_status = %d and user_login = %s",
+ array( array( 1, "admin", 0 ) ),
+ '',
+ ),
+ array(
+ "SELECT * FROM $wpdb->users WHERE id = %d and %% and user_login = %s and user_status = %d and user_login = %s",
+ array( 1, "admin", "extra-arg" ),
+ '',
+ ),
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_db_version() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunitteststermmetaphp"></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/meta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/meta.php 2017-10-02 01:43:48 UTC (rev 41661)
+++ trunk/tests/phpunit/tests/term/meta.php 2017-10-02 02:10:14 UTC (rev 41662)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -358,7 +358,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> register_taxonomy( 'wptests_tax', 'post' );
</span><span class="cx" style="display: block; padding: 0 10px"> $t1 = wp_insert_term( 'Foo', 'wptests_tax' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_term_meta( $t1, 'foo', 'bar' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_term_meta( $t1['term_id'], 'foo', 'bar' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> register_taxonomy( 'wptests_tax_2', 'post' );
</span><span class="cx" style="display: block; padding: 0 10px"> register_taxonomy( 'wptests_tax_3', 'post' );
</span></span></pre>
</div>
</div>
</body>
</html>