<!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>[33308] trunk: WPDB: Remove some of the complexities in `::strip_invalid_text()` associated with switching character sets between queries.</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/33308">33308</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/33308","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>2015-07-17 06:33:36 +0000 (Fri, 17 Jul 2015)</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'>WPDB: Remove some of the complexities in `::strip_invalid_text()` associated with switching character sets between queries. Instead of trying to dynamically change connection character sets, we now rely on the value of `::charset`. This also fixes the case where queries were being blocked when `DB_CHARSET` was `utf8`, but the column character set was non-`utf8`.
Fixes <a href="https://core.trac.wordpress.org/ticket/32165">#32165</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeswpdbphp">trunk/src/wp-includes/wp-db.php</a></li>
<li><a href="#trunktestsphpunittestsdbcharsetphp">trunk/tests/phpunit/tests/db/charset.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 2015-07-17 06:13:45 UTC (rev 33307)
+++ trunk/src/wp-includes/wp-db.php 2015-07-17 06:33:36 UTC (rev 33308)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2710,55 +2710,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $queries = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $data as $col => $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $value['db'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! isset( $queries[ $value['charset'] ] ) ) {
- $queries[ $value['charset'] ] = array();
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // We're going to need to truncate by characters or bytes, depending on the length value we have.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'byte' === $value['length']['type'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Split the CONVERT() calls by charset, so we can make sure the connection is right
- $queries[ $value['charset'] ][ $col ] = $this->prepare( "CONVERT( LEFT( CONVERT( %s USING binary ), %.0f ) USING {$value['charset']} )", $value['value'], $value['length']['length'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Using binary causes LEFT() to truncate by bytes.
+ $charset = 'binary';
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $queries[ $value['charset'] ][ $col ] = $this->prepare( "LEFT( CONVERT( %s USING {$value['charset']} ), %.0f )", $value['value'], $value['length']['length'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $charset = $value['charset'];
</ins><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">+ $queries[ $col ] = $this->prepare( "CONVERT( LEFT( CONVERT( %s USING $charset ), %.0f ) USING {$this->charset} )", $value['value'], $value['length']['length'] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> unset( $data[ $col ]['db'] );
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $connection_charset = $this->charset;
- foreach ( $queries as $charset => $query ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $sql = array();
+ foreach ( $queries as $column => $query ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $query ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">- // Change the charset to match the string(s) we're converting
- if ( $charset !== $connection_charset ) {
- $connection_charset = $charset;
- $this->set_charset( $this->dbh, $charset );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $sql[] = $query . " AS x_$column";
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->check_current_query = false;
-
- $sql = array();
- foreach ( $query as $column => $column_query ) {
- $sql[] = $column_query . " AS x_$column";
- }
-
- $row = $this->get_row( "SELECT " . implode( ', ', $sql ), ARRAY_A );
- if ( ! $row ) {
- $this->set_charset( $this->dbh, $connection_charset );
- return new WP_Error( 'wpdb_strip_invalid_text_failure' );
- }
-
- foreach ( array_keys( $query ) as $column ) {
- $data[ $column ]['value'] = $row["x_$column"];
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->check_current_query = false;
+ $row = $this->get_row( "SELECT " . implode( ', ', $sql ), ARRAY_A );
+ if ( ! $row ) {
+ return new WP_Error( 'wpdb_strip_invalid_text_failure' );
</ins><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">- // Don't forget to change the charset back!
- if ( $connection_charset !== $this->charset ) {
- $this->set_charset( $this->dbh );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( array_keys( $data ) as $column ) {
+ $data[ $column ]['value'] = $row["x_$column"];
</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></pre></div>
<a id="trunktestsphpunittestsdbcharsetphp"></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/charset.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/db/charset.php 2015-07-17 06:13:45 UTC (rev 33307)
+++ trunk/tests/phpunit/tests/db/charset.php 2015-07-17 06:33:36 UTC (rev 33308)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -244,6 +244,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => str_repeat( "\xcc\xe3", 5 ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'length' => array( 'type' => 'byte', 'length' => 10 ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'ujis_with_utf8_connection' => array(
+ 'charset' => 'ujis',
+ 'connection_charset' => 'utf8',
+ 'value' => '自動下書き',
+ 'expected' => '自動下書き',
+ 'length' => array( 'type' => 'byte', 'length' => 100 ),
+ ),
+ 'ujis_with_utf8_connection_char_length' => array(
+ 'charset' => 'ujis',
+ 'connection_charset' => 'utf8',
+ 'value' => '自動下書き',
+ 'expected' => '自動下書',
+ 'length' => array( 'type' => 'char', 'length' => 4 ),
+ ),
+ 'ujis_with_utf8_connection_byte_length' => array(
+ 'charset' => 'ujis',
+ 'connection_charset' => 'utf8',
+ 'value' => '自動下書き',
+ 'expected' => '自動',
+ 'length' => array( 'type' => 'byte', 'length' => 6 ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'false' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> // false is a column with no character set (ie, a number column)
</span><span class="cx" style="display: block; padding: 0 10px"> 'charset' => false,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -289,7 +310,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $fields as $test_case => $field ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = $field;
</span><span class="cx" style="display: block; padding: 0 10px"> $expected['value'] = $expected['expected'];
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $expected['expected'], $field['expected'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $expected['expected'], $field['expected'], $expected['connection_charset'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // We're keeping track of these for our multiple-field test.
</span><span class="cx" style="display: block; padding: 0 10px"> $multiple[] = $field;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -303,9 +324,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $data_provider[] = array( $data, $expected, $test_case );
</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">- // Time for our test of multiple fields at once.
- $data_provider[] = array( $multiple, $multiple_expected, 'multiple fields/charsets' );
-
</del><span class="cx" style="display: block; padding: 0 10px"> return $data_provider;
</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">@@ -318,7 +336,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->markTestSkipped( 'This test fails in PHP 5.2 on Windows. See https://core.trac.wordpress.org/ticket/31262' );
</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">+ $charset = self::$_wpdb->charset;
+ if ( isset( $data[0]['connection_charset'] ) ) {
+ $new_charset = $data[0]['connection_charset'];
+ unset( $data[0]['connection_charset'] );
+ } else {
+ $new_charset = $data[0]['charset'];
+ }
+
+ self::$_wpdb->charset = $new_charset;
+ self::$_wpdb->set_charset( self::$_wpdb->dbh, $new_charset );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $actual = self::$_wpdb->strip_invalid_text( $data );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ self::$_wpdb->charset = $charset;
+ self::$_wpdb->set_charset( self::$_wpdb->dbh, $charset );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, $actual, $message );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>