Skip to content

Commit

Permalink
Fix an error with Lucene query escaping
Browse files Browse the repository at this point in the history
  • Loading branch information
@afoucret
afoucret committed Oct 25, 2024
1 parent 3217f63 commit d92b9dd
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 20 deletions.
16 changes: 13 additions & 3 deletions x-pack/plugin/kql/src/main/java/org/elasticsearch/xpack/kql/parser/ParserUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@

import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
* Utility class for parsing and processing KQL expressions.
Expand Down Expand Up @@ -102,7 +100,19 @@ public static boolean hasWildcard(ParserRuleContext ctx) {
*/
public static String escapeLuceneQueryString(String queryText, boolean preserveWildcards) {
if (preserveWildcards) {
return Stream.of(queryText.split("[*]]")).map(QueryParser::escape).collect(Collectors.joining("*"));
StringBuilder escapedQuery = new StringBuilder(queryText.length());
StringBuilder subpart = new StringBuilder(queryText.length());
for (int i = 0; i < queryText.length(); i++) {
char currentChar = queryText.charAt(i);
if (currentChar == '*') {
escapedQuery.append(QueryParser.escape(subpart.toString())).append(currentChar);
subpart = new StringBuilder(queryText.length() - i);
} else {
subpart.append(currentChar);
}
}

return escapedQuery.append(QueryParser.escape(subpart.toString())).toString();
}

return QueryParser.escape(queryText);
Expand Down
36 changes: 19 additions & 17 deletions x-pack/plugin/kql/src/test/java/org/elasticsearch/xpack/kql/parser/ParserUtilsTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,14 +165,14 @@ public void testUnquotedLiteralInvalidUnicodeCodeParsing() {
// Invalid unicode digit (G)
ParserRuleContext ctx = parserRuleContext(literalNode("\\u0G41"));
KqlParsingException e = assertThrows(KqlParsingException.class, () -> extractText(ctx));
assertThat(e.getMessage(), equalTo("line 0:4: Invalid unicode character code [0G41]"));
assertThat(e.getMessage(), equalTo("line 0:3: Invalid unicode character code [0G41]"));
}

{
// U+D800—U+DFFF can only be used as surrogate pairs and are not valid character codes.
ParserRuleContext ctx = parserRuleContext(literalNode("\\uD900"));
KqlParsingException e = assertThrows(KqlParsingException.class, () -> extractText(ctx));
assertThat(e.getMessage(), equalTo("line 0:4: Invalid unicode character code, [D900] is a surrogate code"));
assertThat(e.getMessage(), equalTo("line 0:3: Invalid unicode character code, [D900] is a surrogate code"));
}
}

Expand All @@ -194,30 +194,32 @@ public void testQuotedStringInvalidUnicodeCodeParsing() {

public void testEscapeLuceneQueryString() {
// Quotes
assertThat(escapeLuceneQueryString("\"The Pink Panther\"", true), equalTo("\\\"The Pink Panther\\\""));
assertThat(escapeLuceneQueryString("\"The Pink Panther\"", randomBoolean()), equalTo("\\\"The Pink Panther\\\""));

// Escape chars
assertThat(escapeLuceneQueryString("The Pink \\ Panther", true), equalTo("The Pink \\\\ Panther"));
assertThat(escapeLuceneQueryString("The Pink \\ Panther", randomBoolean()), equalTo("The Pink \\\\ Panther"));

// Field operations
assertThat(escapeLuceneQueryString("title:Do it right", true), equalTo("title\\:Do it right"));
assertThat(escapeLuceneQueryString("title:(pink panther)", true), equalTo("title\\:\\(pink panther\\)"));
assertThat(escapeLuceneQueryString("title:-pink", true), equalTo("title\\:\\-pink"));
assertThat(escapeLuceneQueryString("title:+pink", true), equalTo("title\\:\\+pink"));
assertThat(escapeLuceneQueryString("title:pink~", true), equalTo("title\\:pink\\~"));
assertThat(escapeLuceneQueryString("title:pink~3.5", true), equalTo("title\\:pink\\~3.5"));
assertThat(escapeLuceneQueryString("title:pink panther^4", true), equalTo("title\\:pink panther\\^4"));
assertThat(escapeLuceneQueryString("rating:[0 TO 5]", true), equalTo("rating\\:\\[0 TO 5\\]"));
assertThat(escapeLuceneQueryString("rating:{0 TO 5}", true), equalTo("rating\\:\\{0 TO 5\\}"));
assertThat(escapeLuceneQueryString("title:Do it right", randomBoolean()), equalTo("title\\:Do it right"));
assertThat(escapeLuceneQueryString("title:(pink panther)", randomBoolean()), equalTo("title\\:\\(pink panther\\)"));
assertThat(escapeLuceneQueryString("title:-pink", randomBoolean()), equalTo("title\\:\\-pink"));
assertThat(escapeLuceneQueryString("title:+pink", randomBoolean()), equalTo("title\\:\\+pink"));
assertThat(escapeLuceneQueryString("title:pink~", randomBoolean()), equalTo("title\\:pink\\~"));
assertThat(escapeLuceneQueryString("title:pink~3.5", randomBoolean()), equalTo("title\\:pink\\~3.5"));
assertThat(escapeLuceneQueryString("title:pink panther^4", randomBoolean()), equalTo("title\\:pink panther\\^4"));
assertThat(escapeLuceneQueryString("rating:[0 TO 5]", randomBoolean()), equalTo("rating\\:\\[0 TO 5\\]"));
assertThat(escapeLuceneQueryString("rating:{0 TO 5}", randomBoolean()), equalTo("rating\\:\\{0 TO 5\\}"));

// Boolean operators
assertThat(escapeLuceneQueryString("foo || bar", true), equalTo("foo \\|\\| bar"));
assertThat(escapeLuceneQueryString("foo && bar", true), equalTo("foo \\&\\& bar"));
assertThat(escapeLuceneQueryString("!foo", true), equalTo("\\!foo"));
assertThat(escapeLuceneQueryString("foo || bar", randomBoolean()), equalTo("foo \\|\\| bar"));
assertThat(escapeLuceneQueryString("foo && bar", randomBoolean()), equalTo("foo \\&\\& bar"));
assertThat(escapeLuceneQueryString("!foo", randomBoolean()), equalTo("\\!foo"));

// Wildcards:
assertThat(escapeLuceneQueryString("te?t", true), equalTo("te\\?t"));
assertThat(escapeLuceneQueryString("te?t", randomBoolean()), equalTo("te\\?t"));
assertThat(escapeLuceneQueryString("foo*", true), equalTo("foo*"));
assertThat(escapeLuceneQueryString("*foo", true), equalTo("*foo"));
assertThat(escapeLuceneQueryString("foo * bar", true), equalTo("foo * bar"));
assertThat(escapeLuceneQueryString("foo*", false), equalTo("foo\\*"));
}

Expand Down

0 comments on commit d92b9dd

Please sign in to comment.