<!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>[13778] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory: Plugin Directory: Search: Improve the search code for phrase matching.</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 { white-space: pre-line; 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="http://meta.trac.wordpress.org/changeset/13778">13778</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/13778","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-06-06 04:13:41 +0000 (Thu, 06 Jun 2024)</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'>Plugin Directory: Search: Improve the search code for phrase matching.
This does not add support for proper phrase matching in the search, but rather corrects the code to properly handle Jetpack Phrase search mode.
Previously most of the customizations in our search code was being skipped, as the structure of the Jetpack ES query was in an unexpected form.
See <a href="http://meta.trac.wordpress.org/ticket/2642">#2642</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclassplugindirectoryphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclasspluginsearchphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-search.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclassplugindirectoryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php 2024-06-05 21:56:03 UTC (rev 13777)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php 2024-06-06 04:13:41 UTC (rev 13778)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -974,7 +974,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Sanitize / cleanup the search query a little bit.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $wp_query->is_search() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $s = $wp_query->get( 's' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $s = wp_unslash( $wp_query->get( 's' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $s = urldecode( $s );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If a URL-like request comes in, reduce to a slug
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -987,13 +987,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $s = mb_substr( $s, 0, 200 );
</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">- // Trim off special characters, only allowing wordy characters at the end of searches.
- $s = preg_replace( '!(\W+)$!iu', '', $s );
- // ..and whitespace
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Trim whitespace
</ins><span class="cx" style="display: block; padding: 0 10px"> $s = trim( $s );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wp_query->set( 's', $s );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If we're searching for a phrase, only trim non-quotey+wordy characters.
+ if ( str_starts_with( $s, '"' ) || str_starts_with( $s, "'" ) ) {
+ $s = preg_replace( '!(\s*[^\'"\w]+)$!iu', '', $s );
+ } else {
+ // If we're searching for a word, trim all non-wordy characters.
+ $s = preg_replace( '!(\s*\W+)$!iu', '', $s );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_query->set( 's', wp_slash( $s ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // If the search is in the block directory, require that.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $wp_query->get( 'block_search' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_query->query_vars['tax_query']['plugin_section'][] = array(
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclasspluginsearchphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-search.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-search.php 2024-06-05 21:56:03 UTC (rev 13777)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-search.php 2024-06-06 04:13:41 UTC (rev 13778)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -248,26 +248,33 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // In phrase-search mode, the should is not present, and it's instead simply a `must` query.
+ $es_query_args[ 'query' ][ 'function_score' ][ 'query' ][ 'bool' ][ 'should' ] ??= [];
+
+ // We'll always be adding function scoring.
+ $es_query_args[ 'query' ][ 'function_score' ][ 'functions' ] ??= [];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // The should match is where we add the fields to be searched in, and the weighting of them (boost).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $should_match = [];
- if ( isset( $es_query_args[ 'query' ][ 'function_score' ][ 'query' ][ 'bool' ][ 'should' ] ) ) {
- $should_match = & $es_query_args[ 'query' ][ 'function_score' ][ 'query' ][ 'bool' ][ 'should' ];
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $should_match = & $es_query_args[ 'query' ][ 'function_score' ][ 'query' ][ 'bool' ][ 'should' ];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $search_phrase = $should_match[0][ 'multi_match' ][ 'query' ] ?? '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // The must match is where the base query is present.
+ $must_match = & $es_query_args[ 'query' ][ 'function_score' ][ 'query' ][ 'bool' ][ 'must' ];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // The function score is where calculations on fields occur.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $function_score = [];
- if ( isset( $es_query_args[ 'query' ][ 'function_score' ][ 'functions' ] ) ) {
- $function_score = & $es_query_args[ 'query' ][ 'function_score' ][ 'functions' ];
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $function_score = & $es_query_args[ 'query' ][ 'function_score' ][ 'functions' ];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Determine what's actually being searched for according to ES.
+ $search_phrase = $must_match[0][ 'multi_match' ][ 'query' ] ?? ( $should_match[0][ 'multi_match' ][ 'query' ] ?? '' );
+
+ // $phrase_search_mode = ( 'phrase' === $must_match[0][ 'multi_match' ][ 'type' ] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Set boost on the match query, from jetpack_search_es_wp_query_args.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( isset( $es_query_args[ 'query' ][ 'function_score' ][ 'query' ][ 'bool' ][ 'must' ][0][ 'multi_match' ] ) ) {
- $es_query_args[ 'query' ][ 'function_score' ][ 'query' ][ 'bool' ][ 'must' ][0][ 'multi_match' ][ 'boost' ] = 0.1;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $must_match[0][ 'multi_match' ] ) ) {
+ $must_match[0][ 'multi_match' ][ 'boost' ] = 0.1;
</ins><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">- // This extends the search to additionally search in the title, excerpt, description and plugin_tags.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // This extends the word search to additionally search in the title, excerpt, description and plugin_tags.
+ // Note: This is not present in phrase searching mode.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $should_match[0][ 'multi_match' ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $should_match[0][ 'multi_match' ][ 'boost' ] = 2;
</span><span class="cx" style="display: block; padding: 0 10px"> $should_match[0][ 'multi_match' ][ 'fields' ] = $this->localise_es_fields( [
</span></span></pre>
</div>
</div>
</body>
</html>