<!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][8928] trunk: Make sure BP_User_Query returns correct results when search term contains the Ampersand character</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/8928">8928</a></dd>
<dt>Author</dt> <dd>imath</dd>
<dt>Date</dt> <dd>2014-08-16 12:03:53 +0000 (Sat, 16 Aug 2014)</dd>
</dl>

<h3>Log Message</h3>
<pre>Make sure BP_User_Query returns correct results when search term contains the Ampersand character

1. Search terms containing this character was problematic as the "&" is a query var delimiter used in {{{bp_legacy_theme_ajax_querystring()}}} to build the ajax querystring

2. When a xProfile field is saved, the value is sanitized using the {{{xprofile_filter_kses()}}} filter which is converting "&" to "&amp;" before inserting the value in database.

Urlencoding the search terms in {{{bp_legacy_theme_ajax_querystring()}}} and applying {{{wp_kses_normalize_entities()}}} to search terms in {{{BP_User_Query}}} & in {{{bp_xprofile_bp_user_query_search()}}} make sure the correct results are returned to the user.

Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5694">#5694</a></pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreclassesphp">trunk/src/bp-core/bp-core-classes.php</a></li>
<li><a href="#trunksrcbptemplatesbplegacybuddypressfunctionsphp">trunk/src/bp-templates/bp-legacy/buddypress-functions.php</a></li>
<li><a href="#trunksrcbpxprofilebpxprofilefunctionsphp">trunk/src/bp-xprofile/bp-xprofile-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasescoreclassbpuserqueryphp">trunk/tests/phpunit/testcases/core/class-bp-user-query.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcoreclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-core/bp-core-classes.php (8927 => 8928)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-core/bp-core-classes.php    2014-08-16 11:49:07 UTC (rev 8927)
+++ trunk/src/bp-core/bp-core-classes.php       2014-08-16 12:03:53 UTC (rev 8928)
</span><span class="lines">@@ -368,7 +368,7 @@
</span><span class="cx">          // 'search_terms' searches user_login and user_nicename
</span><span class="cx">          // xprofile field matches happen in bp_xprofile_bp_user_query_search()
</span><span class="cx">          if ( false !== $search_terms ) {
</span><del>-                       $search_terms = bp_esc_like( $search_terms );
</del><ins>+                        $search_terms = bp_esc_like( wp_kses_normalize_entities( $search_terms ) );
</ins><span class="cx"> 
</span><span class="cx">                  if ( $search_wildcard === 'left' ) {
</span><span class="cx">                          $search_terms_nospace = '%' . $search_terms;
</span></span></pre></div>
<a id="trunksrcbptemplatesbplegacybuddypressfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-templates/bp-legacy/buddypress-functions.php (8927 => 8928)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-templates/bp-legacy/buddypress-functions.php        2014-08-16 11:49:07 UTC (rev 8927)
+++ trunk/src/bp-templates/bp-legacy/buddypress-functions.php   2014-08-16 12:03:53 UTC (rev 8928)
</span><span class="lines">@@ -536,7 +536,7 @@
</span><span class="cx"> 
</span><span class="cx">  $object_search_text = bp_get_search_default_text( $object );
</span><span class="cx">          if ( ! empty( $_POST['search_terms'] ) && $object_search_text != $_POST['search_terms'] && 'false' != $_POST['search_terms'] && 'undefined' != $_POST['search_terms'] )
</span><del>-               $qs[] = 'search_terms=' . $_POST['search_terms'];
</del><ins>+                $qs[] = 'search_terms=' . urlencode( $_POST['search_terms'] );
</ins><span class="cx"> 
</span><span class="cx">  // Now pass the querystring to override default values.
</span><span class="cx">  $query_string = empty( $qs ) ? '' : join( '&', (array) $qs );
</span></span></pre></div>
<a id="trunksrcbpxprofilebpxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-xprofile/bp-xprofile-functions.php (8927 => 8928)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-xprofile/bp-xprofile-functions.php  2014-08-16 11:49:07 UTC (rev 8927)
+++ trunk/src/bp-xprofile/bp-xprofile-functions.php     2014-08-16 12:03:53 UTC (rev 8928)
</span><span class="lines">@@ -685,7 +685,7 @@
</span><span class="cx"> 
</span><span class="cx">  $bp = buddypress();
</span><span class="cx"> 
</span><del>-       $search_terms_clean = bp_esc_like( $query->query_vars['search_terms'] );
</del><ins>+        $search_terms_clean = bp_esc_like( wp_kses_normalize_entities( $query->query_vars['search_terms'] ) );
</ins><span class="cx"> 
</span><span class="cx">  if ( $query->query_vars['search_wildcard'] === 'left' ) {
</span><span class="cx">          $search_terms_nospace = '%' . $search_terms_clean;
</span></span></pre></div>
<a id="trunktestsphpunittestcasescoreclassbpuserqueryphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/testcases/core/class-bp-user-query.php (8927 => 8928)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/testcases/core/class-bp-user-query.php       2014-08-16 11:49:07 UTC (rev 8927)
+++ trunk/tests/phpunit/testcases/core/class-bp-user-query.php  2014-08-16 12:03:53 UTC (rev 8928)
</span><span class="lines">@@ -201,6 +201,23 @@
</span><span class="cx">          $this->assertEquals( $user_id, $found_user_id );
</span><span class="cx">  }
</span><span class="cx"> 
</span><ins>+       public function test_bp_user_query_search_with_ampersand_sign() {
+
+               // LIKE special character: &
+               $user_id = $this->create_user();
+               xprofile_set_field_data( 1, $user_id, "a&mpersand" );
+               $q = new BP_User_Query( array( 'search_terms' => "a&m", ) );
+
+               $found_user_id = null;
+               if ( ! empty( $q->results ) ) {
+                       $found_user = array_pop( $q->results );
+                       $found_user_id = $found_user->ID;
+               }
+
+               $this->assertEquals( $user_id, $found_user_id );
+
+       }
+
</ins><span class="cx">   /**
</span><span class="cx">   * @group search_terms
</span><span class="cx">   */
</span></span></pre>
</div>
</div>

</body>
</html>