<!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>[BuddyPress][7054] trunk: Introduces bp_esc_sql_order() function for sanitizing 'order' params for SQL</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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/7054">7054</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-05-11 11:42:45 +0000 (Sat, 11 May 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduces bp_esc_sql_order() function for sanitizing 'order' params for SQL
Several BP database methods accept an 'order' parameter. This function should
be used to sanitize this parameter into a query-safe string 'ASC' or 'DESC'.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcorefunctionsphp">trunk/bp-core/bp-core-functions.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkteststestcasescorefunctionsphp">trunk/tests/testcases/core/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcorefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-functions.php (7053 => 7054)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-functions.php 2013-05-11 11:42:40 UTC (rev 7053)
+++ trunk/bp-core/bp-core-functions.php 2013-05-11 11:42:45 UTC (rev 7054)
</span><span class="lines">@@ -1081,6 +1081,21 @@
</span><span class="cx"> return $new_args;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Sanitize an 'order' parameter for use in building SQL queries
+ *
+ * Strings like 'DESC', 'desc', ' desc' will be interpreted into 'DESC'.
+ * Everything else becomes 'ASC'.
+ *
+ * @since BuddyPress (1.8)
+ * @param string $order The 'order' string, as passed to the SQL constructor
+ * @return string The sanitized value 'DESC' or 'ASC'
+ */
+function bp_esc_sql_order( $order = '' ) {
+ $order = strtoupper( trim( $order ) );
+ return 'DESC' === $order ? 'DESC' : 'ASC';
+}
+
</ins><span class="cx"> /** Embeds ********************************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunkteststestcasescorefunctionsphp"></a>
<div class="addfile"><h4>Added: trunk/tests/testcases/core/functions.php (0 => 7054)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/core/functions.php (rev 0)
+++ trunk/tests/testcases/core/functions.php 2013-05-11 11:42:45 UTC (rev 7054)
</span><span class="lines">@@ -0,0 +1,43 @@
</span><ins>+<?php
+
+/**
+ * @group core
+ */
+
+class BP_Tests_Core_Functions extends BP_UnitTestCase {
+ /**
+ * @group bp_esc_sql_order
+ */
+ public function test_bp_esc_sql_order_ASC() {
+ $this->assertEquals( 'ASC', bp_esc_sql_order( 'ASC' ) );
+ }
+
+ /**
+ * @group bp_esc_sql_order
+ */
+ public function test_bp_esc_sql_order_DESC() {
+ $this->assertEquals( 'DESC', bp_esc_sql_order( 'DESC' ) );
+ }
+
+ /**
+ * @group bp_esc_sql_order
+ */
+ public function test_bp_esc_sql_order_desc_lowercase() {
+ $this->assertEquals( 'DESC', bp_esc_sql_order( 'desc' ) );
+ }
+
+ /**
+ * @group bp_esc_sql_order
+ */
+ public function test_bp_esc_sql_order_desc_whitespace() {
+ $this->assertEquals( 'DESC', bp_esc_sql_order( ' desc ' ) );
+ }
+
+ /**
+ * @group bp_esc_sql_order
+ */
+ public function test_bp_esc_sql_order_invalid() {
+ $this->assertEquals( 'ASC', bp_esc_sql_order( 'In ur base killin ur d00dz' ) );
+ }
+
+}
</ins></span></pre>
</div>
</div>
</body>
</html>