blob: 249a6342da6a64d0895f8ebf7127ce50811ae44a (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.searchers;
import com.yahoo.prelude.query.FuzzyItem;
import com.yahoo.prelude.query.Item;
import com.yahoo.prelude.query.ToolBox;
import com.yahoo.search.Query;
import com.yahoo.search.Result;
import com.yahoo.search.Searcher;
import com.yahoo.search.grouping.vespa.GroupingExecutor;
import com.yahoo.search.query.ranking.RankProperties;
import com.yahoo.search.result.ErrorMessage;
import com.yahoo.search.searchchain.Execution;
import com.yahoo.vespa.config.search.AttributesConfig;
import com.yahoo.yolean.chain.Before;
import java.util.HashSet;
import java.util.Optional;
import java.util.Set;
/**
* Validates any FuzzyItem query items.
*
* @author alexeyche
*/
@Before(GroupingExecutor.COMPONENT_NAME) // Must happen before query.prepare()
public class ValidateFuzzySearcher extends Searcher {
private final Set<String> validAttributes = new HashSet<>();
public ValidateFuzzySearcher(AttributesConfig attributesConfig) {
for (AttributesConfig.Attribute a : attributesConfig.attribute()) {
if (a.datatype() == AttributesConfig.Attribute.Datatype.STRING) {
validAttributes.add(a.name());
}
}
}
@Override
public Result search(Query query, Execution execution) {
Optional<ErrorMessage> e = validate(query);
return e.isEmpty() ? execution.search(query) : new Result(query, e.get());
}
private Optional<ErrorMessage> validate(Query query) {
FuzzyVisitor visitor = new FuzzyVisitor(query.getRanking().getProperties(), validAttributes, query);
ToolBox.visit(visitor, query.getModel().getQueryTree().getRoot());
return visitor.errorMessage;
}
private static class FuzzyVisitor extends ToolBox.QueryVisitor {
public Optional<ErrorMessage> errorMessage = Optional.empty();
private final Set<String> validAttributes;
private final Query query;
public FuzzyVisitor(RankProperties rankProperties, Set<String> validAttributes, Query query) {
this.validAttributes = validAttributes;
this.query = query;
}
@Override
public boolean visit(Item item) {
if (item instanceof FuzzyItem) {
String error = validate((FuzzyItem)item);
if (error != null)
errorMessage = Optional.of(ErrorMessage.createIllegalQuery(error));
}
return true;
}
/** Returns an error message if this is invalid, or null if it is valid */
private String validate(FuzzyItem item) {
if (!validAttributes.contains(item.getIndexName())) {
return item + " field is not a string attribute";
}
if (item.getPrefixLength() < 0) {
return item + " has invalid prefixLength " + item.getPrefixLength() + ": Must be >= 0";
}
if (item.getMaxEditDistance() < 0) {
return item + " has invalid maxEditDistance " + item.getMaxEditDistance() + ": Must be >= 0";
}
if (item.stringValue().isEmpty()) {
return item + " fuzzy query must be non-empty";
}
return null;
}
@Override
public void onExit() {}
}
}
|
