<!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>[37939] branches/4.2: Database: `dbDelta()` will no longer try to downgrade the size of `TEXT` and `BLOB` columns.</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/37939">37939</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/37939","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>2016-07-01 11:50:08 +0000 (Fri, 01 Jul 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'>Database: `dbDelta()` will no longer try to downgrade the size of `TEXT` and `BLOB` columns.
When upgrading to `utf8mb4`, `TEXT` fields will be upgraded to `MEDIUMTEXT` (and likewise for all other `*TEXT` and `*BLOB` fields). This is to allow for the additional space requirements of `utf8mb4`.
On the subsequent upgrade, `dbDelta()` would try and downgrade the fields to their original size again. At best, this it a waste of time, at worst, this could truncate any data larger than the original size. There's no harm in leaving them at their new size, so let's do that.
The `FULLTEXT` indexes are removed from the tests, as `dbDelta()`'s `FULLTEXT` support was added in WordPress 4.4.
This also includes the `setUp()` and `tearDown()` parts of <a href="https://core.trac.wordpress.org/changeset/32270">[32270]</a>, to allow the tests to run, and fixes a typo them.
Merge of <a href="https://core.trac.wordpress.org/changeset/37525">[37525]</a> to the 4.2 branch.
Partial merge of <a href="https://core.trac.wordpress.org/changeset/36552">[36552]</a> to the 4.2 branch.
Partial merge of <a href="https://core.trac.wordpress.org/changeset/32270">[32270]</a> to the 4.2 branch.
See <a href="https://core.trac.wordpress.org/ticket/36748">#36748</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches42srcwpadminincludesupgradephp">branches/4.2/src/wp-admin/includes/upgrade.php</a></li>
<li><a href="#branches42testsphpunittestsdbdeltaphp">branches/4.2/tests/phpunit/tests/dbdelta.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches42srcwpadminincludesupgradephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.2/src/wp-admin/includes/upgrade.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.2/src/wp-admin/includes/upgrade.php 2016-07-01 11:41:57 UTC (rev 37938)
+++ branches/4.2/src/wp-admin/includes/upgrade.php 2016-07-01 11:50:08 UTC (rev 37939)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1949,6 +1949,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $iqueries = apply_filters( 'dbdelta_insert_queries', $iqueries );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $text_fields = array( 'tinytext', 'text', 'mediumtext', 'longtext' );
+ $blob_fields = array( 'tinyblob', 'blob', 'mediumblob', 'longblob' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $global_tables = $wpdb->tables( 'global' );
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $cqueries as $table => $qry ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Upgrade global tables only for the main site. Don't upgrade at all if DO_NOT_UPGRADE_GLOBAL_TABLES is defined.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2018,9 +2021,24 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Is actual field type different from the field type in query?
</span><span class="cx" style="display: block; padding: 0 10px"> if ($tablefield->Type != $fieldtype) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $do_change = true;
+ if ( in_array( strtolower( $fieldtype ), $text_fields ) && in_array( strtolower( $tablefield->Type ), $text_fields ) ) {
+ if ( array_search( strtolower( $fieldtype ), $text_fields ) < array_search( strtolower( $tablefield->Type ), $text_fields ) ) {
+ $do_change = false;
+ }
+ }
+
+ if ( in_array( strtolower( $fieldtype ), $blob_fields ) && in_array( strtolower( $tablefield->Type ), $blob_fields ) ) {
+ if ( array_search( strtolower( $fieldtype ), $blob_fields ) < array_search( strtolower( $tablefield->Type ), $blob_fields ) ) {
+ $do_change = false;
+ }
+ }
+
+ if ( $do_change ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> // Add a query to change the column type
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $cqueries[] = "ALTER TABLE {$table} CHANGE COLUMN {$tablefield->Field} " . $cfields[strtolower($tablefield->Field)];
- $for_update[$table.'.'.$tablefield->Field] = "Changed type of {$table}.{$tablefield->Field} from {$tablefield->Type} to {$fieldtype}";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cqueries[] = "ALTER TABLE {$table} CHANGE COLUMN {$tablefield->Field} " . $cfields[strtolower($tablefield->Field)];
+ $for_update[$table.'.'.$tablefield->Field] = "Changed type of {$table}.{$tablefield->Field} from {$tablefield->Type} to {$fieldtype}";
+ }
</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"> // Get the default value from the array
</span></span></pre></div>
<a id="branches42testsphpunittestsdbdeltaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.2/tests/phpunit/tests/dbdelta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.2/tests/phpunit/tests/dbdelta.php 2016-07-01 11:41:57 UTC (rev 37938)
+++ branches/4.2/tests/phpunit/tests/dbdelta.php 2016-07-01 11:50:08 UTC (rev 37939)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,8 +8,53 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_dbDelta extends WP_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Make sure the upgrade code is loaded before the tests are run.
+ */
+ public static function setUpBeforeClass() {
+
+ parent::setUpBeforeClass();
+
+ require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
+ }
+
+ /**
+ * Create a custom table to be used in each test.
+ */
+ public function setUp() {
+
+ global $wpdb;
+
+ $wpdb->query(
+ "
+ CREATE TABLE {$wpdb->prefix}dbdelta_test (
+ id bigint(20) NOT NULL AUTO_INCREMENT,
+ column_1 varchar(255) NOT NULL,
+ column_2 text,
+ column_3 blob,
+ PRIMARY KEY (id),
+ KEY key_1 (column_1),
+ KEY compound_key (id,column_1)
+ )
+ "
+ );
+
+ parent::setUp();
+ }
+
+ /**
+ * Delete the custom table on teardown.
+ */
+ public function tearDown() {
+
+ global $wpdb;
+
+ parent::tearDown();
+
+ $wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}dbdelta_test" );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_create_new_table() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- include_once( ABSPATH . 'wp-admin/includes/upgrade.php');
</del><span class="cx" style="display: block; padding: 0 10px"> $table_name = 'test_new_table';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $create = "CREATE TABLE $table_name (\n a varchar(255)\n)";
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,4 +85,100 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( array(), $actual );
</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 36748
+ */
+ function test_dont_downsize_text_fields() {
+ global $wpdb;
+
+ $result = dbDelta(
+ "
+ CREATE TABLE {$wpdb->prefix}dbdelta_test (
+ id bigint(20) NOT NULL AUTO_INCREMENT,
+ column_1 varchar(255) NOT NULL,
+ column_2 tinytext,
+ column_3 blob,
+ PRIMARY KEY (id),
+ KEY key_1 (column_1),
+ KEY compound_key (id,column_1)
+ ) ENGINE=MyISAM
+ ", false );
+
+ $this->assertSame( array(), $result );
+ }
+
+ /**
+ * @ticket 36748
+ */
+ function test_dont_downsize_blob_fields() {
+ global $wpdb;
+
+ $result = dbDelta(
+ "
+ CREATE TABLE {$wpdb->prefix}dbdelta_test (
+ id bigint(20) NOT NULL AUTO_INCREMENT,
+ column_1 varchar(255) NOT NULL,
+ column_2 text,
+ column_3 tinyblob,
+ PRIMARY KEY (id),
+ KEY key_1 (column_1),
+ KEY compound_key (id,column_1)
+ ) ENGINE=MyISAM
+ ", false );
+
+ $this->assertSame( array(), $result );
+ }
+
+ /**
+ * @ticket 36748
+ */
+ function test_upsize_text_fields() {
+ global $wpdb;
+
+ $result = dbDelta(
+ "
+ CREATE TABLE {$wpdb->prefix}dbdelta_test (
+ id bigint(20) NOT NULL AUTO_INCREMENT,
+ column_1 varchar(255) NOT NULL,
+ column_2 bigtext,
+ column_3 blob,
+ PRIMARY KEY (id),
+ KEY key_1 (column_1),
+ KEY compound_key (id,column_1)
+ ) ENGINE=MyISAM
+ ", false );
+
+ $this->assertSame(
+ array(
+ "{$wpdb->prefix}dbdelta_test.column_2"
+ => "Changed type of {$wpdb->prefix}dbdelta_test.column_2 from text to bigtext"
+ ), $result );
+ }
+
+ /**
+ * @ticket 36748
+ */
+ function test_upsize_blob_fields() {
+ global $wpdb;
+
+ $result = dbDelta(
+ "
+ CREATE TABLE {$wpdb->prefix}dbdelta_test (
+ id bigint(20) NOT NULL AUTO_INCREMENT,
+ column_1 varchar(255) NOT NULL,
+ column_2 text,
+ column_3 mediumblob,
+ PRIMARY KEY (id),
+ KEY key_1 (column_1),
+ KEY compound_key (id,column_1)
+ ) ENGINE=MyISAM
+ ", false );
+
+ $this->assertSame(
+ array(
+ "{$wpdb->prefix}dbdelta_test.column_3"
+ => "Changed type of {$wpdb->prefix}dbdelta_test.column_3 from blob to mediumblob"
+ ), $result );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>