<!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][8753] trunk/src: Core: adjust the SQL generated by `BP_User_Query`'s `search_wildcard` parameter for better Suggestions API search results.</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/8753">8753</a></dd>
<dt>Author</dt> <dd>djpaul</dd>
<dt>Date</dt> <dd>2014-08-03 20:51:44 +0000 (Sun, 03 Aug 2014)</dd>
</dl>

<h3>Log Message</h3>
<pre>Core: adjust the SQL generated by `BP_User_Query`'s `search_wildcard` parameter for better Suggestions API search results.

Introduced in <a href="http://buddypress.trac.wordpress.org/changeset/8675">r8675</a>, the `search_wildcard` parameter controls where BuddyPress places MySQL wildcard characters around the search term (when it's set).

This change adjusts how the wildcard SQL is constructed; in addition to the wildcard, we now also check for matches that have a single space character at the opposite end of the string (from where the wildcard is). This allows searching data that looks like (for example) a surname in a combined first name/surname field.
e.g. if a displayname is "Paul Gibbs", you can search for "Gi", and with `search_wildcard=right`, the SQL generated will be `LIKE 'Gi%' OR LIKE '% Gi%'`.

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

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreclassesphp">trunk/src/bp-core/bp-core-classes.php</a></li>
<li><a href="#trunksrcbpgroupsbpgroupsclassesphp">trunk/src/bp-groups/bp-groups-classes.php</a></li>
<li><a href="#trunksrcbpxprofilebpxprofilefunctionsphp">trunk/src/bp-xprofile/bp-xprofile-functions.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 (8752 => 8753)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-core/bp-core-classes.php    2014-08-03 02:26:38 UTC (rev 8752)
+++ trunk/src/bp-core/bp-core-classes.php       2014-08-03 20:51:44 UTC (rev 8753)
</span><span class="lines">@@ -368,17 +368,26 @@
</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_like = bp_esc_like( $search_terms );
</del><ins>+                        $search_terms = bp_esc_like( $search_terms );
</ins><span class="cx"> 
</span><span class="cx">                  if ( $search_wildcard === 'left' ) {
</span><del>-                               $search_terms_like = '%' . $search_terms_like;
</del><ins>+                                $search_terms_nospace = '%' . $search_terms;
+                               $search_terms_space   = '%' . $search_terms . ' %';
</ins><span class="cx">                   } elseif ( $search_wildcard === 'right' ) {
</span><del>-                               $search_terms_like = $search_terms_like . '%';
</del><ins>+                                $search_terms_nospace =        $search_terms . '%';
+                               $search_terms_space   = '% ' . $search_terms . '%';
</ins><span class="cx">                   } else {
</span><del>-                               $search_terms_like = '%' . $search_terms_like . '%';
</del><ins>+                                $search_terms_nospace = '%' . $search_terms . '%';
+                               $search_terms_space   = '%' . $search_terms . '%';
</ins><span class="cx">                   }
</span><span class="cx"> 
</span><del>-                       $sql['where']['search'] = $wpdb->prepare( "u.{$this->uid_name} IN ( SELECT ID FROM {$wpdb->users} WHERE ( user_login LIKE %s OR user_nicename LIKE %s ) )", $search_terms_like, $search_terms_like );
</del><ins>+                        $sql['where']['search'] = $wpdb->prepare(
+                               "u.{$this->uid_name} IN ( SELECT ID FROM {$wpdb->users} WHERE ( user_login LIKE %s OR user_login LIKE %s OR user_nicename LIKE %s OR user_nicename LIKE %s ) )",
+                               $search_terms_nospace,
+                               $search_terms_space,
+                               $search_terms_nospace,
+                               $search_terms_space
+                       );
</ins><span class="cx">           }
</span><span class="cx"> 
</span><span class="cx">          // 'meta_key', 'meta_value' allow usermeta search
</span><span class="lines">@@ -2566,7 +2575,7 @@
</span><span class="cx">   * }
</span><span class="cx">   */
</span><span class="cx">  protected $default_args = array(
</span><del>-               'limit'        => 16,
</del><ins>+                'limit'        => 10,
</ins><span class="cx">           'only_friends' => false,
</span><span class="cx">          'term'         => '',
</span><span class="cx">          'type'         => '',
</span><span class="lines">@@ -2606,6 +2615,7 @@
</span><span class="cx">                  'page'            => 1,
</span><span class="cx">                  'per_page'        => $this->args['limit'],
</span><span class="cx">                  'search_terms'    => $this->args['term'],
</span><ins>+                       'search_wildcard' => is_rtl() ? 'left' : 'right',
</ins><span class="cx">           );
</span><span class="cx"> 
</span><span class="cx">          // Only return matches of friends of this user.
</span></span></pre></div>
<a id="trunksrcbpgroupsbpgroupsclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-groups/bp-groups-classes.php (8752 => 8753)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-groups/bp-groups-classes.php        2014-08-03 02:26:38 UTC (rev 8752)
+++ trunk/src/bp-groups/bp-groups-classes.php   2014-08-03 20:51:44 UTC (rev 8753)
</span><span class="lines">@@ -4387,6 +4387,7 @@
</span><span class="cx">                  'page'            => 1,
</span><span class="cx">                  'per_page'        => $this->args['limit'],
</span><span class="cx">                  'search_terms'    => $this->args['term'],
</span><ins>+                       'search_wildcard' => 'right',
</ins><span class="cx">           );
</span><span class="cx"> 
</span><span class="cx">          // Only return matches of friends of this user.
</span></span></pre></div>
<a id="trunksrcbpxprofilebpxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-xprofile/bp-xprofile-functions.php (8752 => 8753)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-xprofile/bp-xprofile-functions.php  2014-08-03 02:26:38 UTC (rev 8752)
+++ trunk/src/bp-xprofile/bp-xprofile-functions.php     2014-08-03 20:51:44 UTC (rev 8753)
</span><span class="lines">@@ -590,22 +590,29 @@
</span><span class="cx"> 
</span><span class="cx">  $bp = buddypress();
</span><span class="cx"> 
</span><del>-       $search_terms_clean = esc_sql( esc_sql( $query->query_vars['search_terms'] ) );
</del><ins>+        $search_terms_clean = bp_esc_like( $query->query_vars['search_terms'] );
</ins><span class="cx"> 
</span><span class="cx">  if ( $query->query_vars['search_wildcard'] === 'left' ) {
</span><del>-               $search_terms_clean = '%' . $search_terms_clean;
</del><ins>+                $search_terms_nospace = '%' . $search_terms_clean;
+               $search_terms_space   = '%' . $search_terms_clean . ' %';
</ins><span class="cx">   } elseif ( $query->query_vars['search_wildcard'] === 'right' ) {
</span><del>-               $search_terms_clean = $search_terms_clean . '%';
</del><ins>+                $search_terms_nospace =        $search_terms_clean . '%';
+               $search_terms_space   = '% ' . $search_terms_clean . '%';
</ins><span class="cx">   } else {
</span><del>-               $search_terms_clean = '%' . $search_terms_clean . '%';
</del><ins>+                $search_terms_nospace = '%' . $search_terms_clean . '%';
+               $search_terms_space   = '%' . $search_terms_clean . '%';
</ins><span class="cx">   }
</span><span class="cx"> 
</span><span class="cx">  // Combine the core search (against wp_users) into a single OR clause
</span><span class="cx">  // with the xprofile_data search
</span><ins>+       $search_xprofile = $wpdb->prepare(
+               "u.{$query->uid_name} IN ( SELECT user_id FROM {$bp->profile->table_name_data} WHERE value LIKE %s OR value LIKE %s )",
+               $search_terms_nospace,
+               $search_terms_space
+       );
+
</ins><span class="cx">   $search_core     = $sql['where']['search'];
</span><del>-       $search_xprofile = "u.{$query->uid_name} IN ( SELECT user_id FROM {$bp->profile->table_name_data} WHERE value LIKE '{$search_terms_clean}' )";
</del><span class="cx">   $search_combined = "( {$search_xprofile} OR {$search_core} )";
</span><del>-
</del><span class="cx">   $sql['where']['search'] = $search_combined;
</span><span class="cx"> 
</span><span class="cx">  return $sql;
</span></span></pre>
</div>
</div>

</body>
</html>