<!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>[32189] branches/4.0: Clean up some edge cases in `sanitize_sql_orderby()`.</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/32189">32189</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/32189","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-04-20 12:31:43 +0000 (Mon, 20 Apr 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'>Clean up some edge cases in `sanitize_sql_orderby()`. Merge of <a href="https://core.trac.wordpress.org/changeset/32164">[32164]</a> to the 4.0 branch.
Props vortfu, dd32.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches40srcwpincludesformattingphp">branches/4.0/src/wp-includes/formatting.php</a></li>
<li><a href="#branches40testsphpunittestsformattingSanitizeOrderbyphp">branches/4.0/tests/phpunit/tests/formatting/SanitizeOrderby.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches40srcwpincludesformattingphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.0/src/wp-includes/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.0/src/wp-includes/formatting.php 2015-04-20 11:51:13 UTC (rev 32188)
+++ branches/4.0/src/wp-includes/formatting.php 2015-04-20 12:31:43 UTC (rev 32189)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1305,21 +1305,23 @@
</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">- * Ensures a string is a valid SQL order by clause.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Ensures a string is a valid SQL 'order by' clause.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Accepts one or more columns, with or without ASC/DESC, and also accepts
- * RAND().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Accepts one or more columns, with or without a sort order (ASC / DESC).
+ * e.g. 'column_1', 'column_1, column_2', 'column_1 ASC, column_2 DESC' etc.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Also accepts 'RAND()'.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.1
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $orderby Order by string to be checked.
- * @return string|bool Returns the order by clause if it is a match, false otherwise.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $orderby Order by clause to be validated.
+ * @return string|bool Returns $orderby if valid, false otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function sanitize_sql_orderby( $orderby ){
- preg_match('/^\s*([a-z0-9_]+(\s+(ASC|DESC))?(\s*,\s*|\s*$))+|^\s*RAND\(\s*\)\s*$/i', $orderby, $obmatches);
- if ( !$obmatches )
- return false;
- return $orderby;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function sanitize_sql_orderby( $orderby ) {
+ if ( preg_match( '/^\s*(([a-z0-9_]+|`[a-z0-9_]+`)(\s+(ASC|DESC))?\s*(,\s*(?=[a-z0-9_`])|$))+$/i', $orderby ) || preg_match( '/^\s*RAND\(\s*\)\s*$/i', $orderby ) ) {
+ return $orderby;
+ }
+ return false;
</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="branches40testsphpunittestsformattingSanitizeOrderbyphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.0/tests/phpunit/tests/formatting/SanitizeOrderby.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.0/tests/phpunit/tests/formatting/SanitizeOrderby.php 2015-04-20 11:51:13 UTC (rev 32188)
+++ branches/4.0/tests/phpunit/tests/formatting/SanitizeOrderby.php 2015-04-20 12:31:43 UTC (rev 32189)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,38 +1,57 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/* // @todo These tests need to be rewritten for sanitize_sql_orderby
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * @group sanitize_sql_orderby
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> class Tests_Formatting_SanitizeOrderby extends WP_UnitTestCase {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function test_empty() {
- $cols = array('a' => 'a');
- $this->assertEquals( '', sanitize_sql_orderby('', $cols) );
- $this->assertEquals( '', sanitize_sql_orderby(' ', $cols) );
- $this->assertEquals( '', sanitize_sql_orderby("\t", $cols) );
- $this->assertEquals( '', sanitize_sql_orderby(null, $cols) );
- $this->assertEquals( '', sanitize_sql_orderby(0, $cols) );
- $this->assertEquals( '', sanitize_sql_orderby('+', $cols) );
- $this->assertEquals( '', sanitize_sql_orderby('-', $cols) );
- }
</del><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_unknown_column() {
- $cols = array('name' => 'post_name', 'date' => 'post_date');
- $this->assertEquals( '', sanitize_sql_orderby('unknown_column', $cols) );
- $this->assertEquals( '', sanitize_sql_orderby('+unknown_column', $cols) );
- $this->assertEquals( '', sanitize_sql_orderby('-unknown_column', $cols) );
- $this->assertEquals( '', sanitize_sql_orderby('-unknown1,+unknown2,unknown3', $cols) );
- $this->assertEquals( 'post_name ASC', sanitize_sql_orderby('name,unknown_column', $cols) );
- $this->assertEquals( '', sanitize_sql_orderby('!@#$%^&*()_=~`\'",./', $cols) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @covers ::sanitize_sql_orderby
+ * @dataProvider valid_orderbys
+ */
+ function test_valid( $orderby ) {
+ $this->assertEquals( $orderby, sanitize_sql_orderby( $orderby ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function valid_orderbys() {
+ return array(
+ array( '1' ),
+ array( '1 ASC' ),
+ array( '1 ASC, 2' ),
+ array( '1 ASC, 2 DESC' ),
+ array( '1 ASC, 2 DESC, 3' ),
+ array( ' 1 DESC' ),
+ array( 'field ASC' ),
+ array( 'field1 ASC, field2' ),
+ array( 'field_1 ASC, field_2 DESC' ),
+ array( 'field1, field2 ASC' ),
+ array( '`field1`' ),
+ array( '`field1` ASC' ),
+ array( '`field` ASC, `field2`' ),
+ array( 'RAND()' ),
+ array( ' RAND( ) ' ),
+ );
+ }
</ins><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_valid() {
- $cols = array('name' => 'post_name', 'date' => 'post_date', 'random' => 'rand()');
- $this->assertEquals( 'post_name ASC', sanitize_sql_orderby('name', $cols) );
- $this->assertEquals( 'post_name ASC', sanitize_sql_orderby('+name', $cols) );
- $this->assertEquals( 'post_name DESC', sanitize_sql_orderby('-name', $cols) );
- $this->assertEquals( 'post_date ASC, post_name ASC', sanitize_sql_orderby('date,name', $cols) );
- $this->assertEquals( 'post_date ASC, post_name ASC', sanitize_sql_orderby(' date , name ', $cols) );
- $this->assertEquals( 'post_name DESC, post_date ASC', sanitize_sql_orderby('-name,date', $cols) );
- $this->assertEquals( 'post_name ASC, post_date ASC', sanitize_sql_orderby('name ,+ date', $cols) );
- $this->assertEquals( 'rand() ASC', sanitize_sql_orderby('random', $cols) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @covers ::sanitize_sql_orderby
+ * @dataProvider invalid_orderbys
+ */
+ function test_invalid( $orderby ) {
+ $this->assertFalse( sanitize_sql_orderby( $orderby ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function invalid_orderbys() {
+ return array(
+ array( '' ),
+ array( '1 2' ),
+ array( '1, 2 3' ),
+ array( '1 DESC, ' ),
+ array( 'field-1' ),
+ array( 'field DESC,' ),
+ array( 'field1 field2' ),
+ array( 'field RAND()' ),
+ array( 'RAND() ASC' ),
+ array( '`field1` ASC, `field2' ),
+ array( 'field, !@#$%^' ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-*/
</del></span></pre>
</div>
</div>
</body>
</html>