From e495d1e7d19cc2134699805b977fc6777633c39e Mon Sep 17 00:00:00 2001 From: Martijn van Groningen Date: Mon, 9 Dec 2013 11:57:59 +0100 Subject: [PATCH] Added the `force_source` option to highlighting that enforces to use of the _source even if there are stored fields. The percolator uses this option to deal with the fact that the MemoryIndex doesn't support stored fields, this is possible b/c the _source of the document being percolated is always present. Closes #4348 --- .../search/request/highlighting.asciidoc | 18 +++++++ .../percolator/PercolatorService.java | 6 +++ .../highlight/FastVectorHighlighter.java | 6 +-- .../search/highlight/HighlightBuilder.java | 26 ++++++++++ .../search/highlight/HighlightPhase.java | 8 ++++ .../search/highlight/HighlightUtils.java | 4 +- .../highlight/HighlighterParseElement.java | 8 ++++ .../search/highlight/PlainHighlighter.java | 2 +- .../search/highlight/PostingsHighlighter.java | 2 +- .../highlight/SearchContextHighlight.java | 10 ++++ .../percolator/PercolatorTests.java | 15 +++++- .../highlight/HighlighterSearchTests.java | 48 +++++++++++++++++++ 12 files changed, 145 insertions(+), 8 deletions(-) diff --git a/docs/reference/search/request/highlighting.asciidoc b/docs/reference/search/request/highlighting.asciidoc index 300b66d8f9d85..fb6ccbf0a2033 100644 --- a/docs/reference/search/request/highlighting.asciidoc +++ b/docs/reference/search/request/highlighting.asciidoc @@ -110,6 +110,24 @@ The following is an example that forces the use of the plain highlighter: } -------------------------------------------------- +==== Force highlighting on source + +added[1.0.0.RC1] + +Forces the highlighting to highlight fields based on the source even if fields are +stored separately. Defaults to `false`. + +[source,js] +-------------------------------------------------- +{ + "query" : {...}, + "highlight" : { + "fields" : { + "content" : {"force_source" : true} + } + } +} +-------------------------------------------------- [[tags]] ==== Highlighting Tags diff --git a/src/main/java/org/elasticsearch/percolator/PercolatorService.java b/src/main/java/org/elasticsearch/percolator/PercolatorService.java index 7d27439836874..d521f20d8f51d 100644 --- a/src/main/java/org/elasticsearch/percolator/PercolatorService.java +++ b/src/main/java/org/elasticsearch/percolator/PercolatorService.java @@ -82,6 +82,7 @@ import org.elasticsearch.search.facet.InternalFacets; import org.elasticsearch.search.highlight.HighlightField; import org.elasticsearch.search.highlight.HighlightPhase; +import org.elasticsearch.search.highlight.SearchContextHighlight; import org.elasticsearch.search.internal.SearchContext; import java.io.IOException; @@ -309,6 +310,11 @@ private ParsedDocument parseRequest(IndexService documentIndexService, Percolate // We need to get the actual source from the request body for highlighting, so parse the request body again // and only get the doc source. if (context.highlight() != null) { + // Enforce highlighting by source, because MemoryIndex doesn't support stored fields. + for (SearchContextHighlight.Field field : context.highlight().fields()) { + field.forceSource(true); + } + parser.close(); currentFieldName = null; parser = XContentFactory.xContent(source).createParser(source); diff --git a/src/main/java/org/elasticsearch/search/highlight/FastVectorHighlighter.java b/src/main/java/org/elasticsearch/search/highlight/FastVectorHighlighter.java index ca2d3a56feb7e..b6de209405d25 100644 --- a/src/main/java/org/elasticsearch/search/highlight/FastVectorHighlighter.java +++ b/src/main/java/org/elasticsearch/search/highlight/FastVectorHighlighter.java @@ -104,7 +104,7 @@ public HighlightField highlight(HighlighterContext highlighterContext) { if (field.numberOfFragments() == 0) { fragListBuilder = new SingleFragListBuilder(); - if (mapper.fieldType().stored()) { + if (!field.forceSource() && mapper.fieldType().stored()) { fragmentsBuilder = new SimpleFragmentsBuilder(mapper, field.preTags(), field.postTags(), boundaryScanner); } else { fragmentsBuilder = new SourceSimpleFragmentsBuilder(mapper, context, field.preTags(), field.postTags(), boundaryScanner); @@ -112,13 +112,13 @@ public HighlightField highlight(HighlighterContext highlighterContext) { } else { fragListBuilder = field.fragmentOffset() == -1 ? new SimpleFragListBuilder() : new SimpleFragListBuilder(field.fragmentOffset()); if (field.scoreOrdered()) { - if (mapper.fieldType().stored()) { + if (!field.forceSource() && mapper.fieldType().stored()) { fragmentsBuilder = new ScoreOrderFragmentsBuilder(field.preTags(), field.postTags(), boundaryScanner); } else { fragmentsBuilder = new SourceScoreOrderFragmentsBuilder(mapper, context, field.preTags(), field.postTags(), boundaryScanner); } } else { - if (mapper.fieldType().stored()) { + if (!field.forceSource() && mapper.fieldType().stored()) { fragmentsBuilder = new SimpleFragmentsBuilder(mapper, field.preTags(), field.postTags(), boundaryScanner); } else { fragmentsBuilder = new SourceSimpleFragmentsBuilder(mapper, context, field.preTags(), field.postTags(), boundaryScanner); diff --git a/src/main/java/org/elasticsearch/search/highlight/HighlightBuilder.java b/src/main/java/org/elasticsearch/search/highlight/HighlightBuilder.java index 42099f79e7768..1946fdbd696e5 100644 --- a/src/main/java/org/elasticsearch/search/highlight/HighlightBuilder.java +++ b/src/main/java/org/elasticsearch/search/highlight/HighlightBuilder.java @@ -60,6 +60,8 @@ public class HighlightBuilder implements ToXContent { private Map options; + private Boolean forceSource; + /** * Adds a field to be highlighted with default fragment size of 100 characters, and * default number of fragments of 5 using the default encoder @@ -233,6 +235,14 @@ public HighlightBuilder options(Map options) { return this; } + /** + * Forces the highlighting to highlight fields based on the source even if fields are stored separately. + */ + public HighlightBuilder forceSource(boolean forceSource) { + this.forceSource = forceSource; + return this; + } + @Override public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { builder.startObject("highlight"); @@ -269,6 +279,9 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws if (options != null && options.size() > 0) { builder.field("options", options); } + if (forceSource != null) { + builder.field("force_source", forceSource); + } if (fields != null) { builder.startObject("fields"); for (Field field : fields) { @@ -321,6 +334,9 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws if (field.options != null && field.options.size() > 0) { builder.field("options", field.options); } + if (field.forceSource != null) { + builder.field("force_source", forceSource); + } builder.endObject(); } @@ -349,6 +365,7 @@ public static class Field { Integer noMatchSize; String[] matchedFields; Map options; + Boolean forceSource; public Field(String name) { this.name = name; @@ -479,5 +496,14 @@ public Field matchedFields(String... matchedFields) { this.matchedFields = matchedFields; return this; } + + /** + * Forces the highlighting to highlight this field based on the source even if this field is stored separately. + */ + public Field forceSource(boolean forceSource) { + this.forceSource = forceSource; + return this; + } + } } diff --git a/src/main/java/org/elasticsearch/search/highlight/HighlightPhase.java b/src/main/java/org/elasticsearch/search/highlight/HighlightPhase.java index 8804733a7feac..881c4702b504d 100644 --- a/src/main/java/org/elasticsearch/search/highlight/HighlightPhase.java +++ b/src/main/java/org/elasticsearch/search/highlight/HighlightPhase.java @@ -31,6 +31,7 @@ import org.elasticsearch.index.mapper.DocumentMapper; import org.elasticsearch.index.mapper.FieldMapper; import org.elasticsearch.index.mapper.MapperService; +import org.elasticsearch.index.mapper.internal.SourceFieldMapper; import org.elasticsearch.search.SearchParseElement; import org.elasticsearch.search.fetch.FetchSubPhase; import org.elasticsearch.search.internal.InternalSearchHit; @@ -85,6 +86,13 @@ public void hitExecute(SearchContext context, HitContext hitContext) throws Elas fieldNamesToHighlight = ImmutableSet.of(field.field()); } + if (field.forceSource()) { + SourceFieldMapper sourceFieldMapper = context.mapperService().documentMapper(hitContext.hit().type()).sourceMapper(); + if (!sourceFieldMapper.enabled()) { + throw new ElasticSearchIllegalArgumentException("source is forced for field [" + field.field() + "] but type [" + hitContext.hit().type() + "] has disabled _source"); + } + } + for (String fieldName : fieldNamesToHighlight) { FieldMapper fieldMapper = getMapperForField(fieldName, context, hitContext); if (fieldMapper == null) { diff --git a/src/main/java/org/elasticsearch/search/highlight/HighlightUtils.java b/src/main/java/org/elasticsearch/search/highlight/HighlightUtils.java index 4fbab0c34ca2f..963691189cb51 100644 --- a/src/main/java/org/elasticsearch/search/highlight/HighlightUtils.java +++ b/src/main/java/org/elasticsearch/search/highlight/HighlightUtils.java @@ -41,9 +41,9 @@ private HighlightUtils() { } - static List loadFieldValues(FieldMapper mapper, SearchContext searchContext, FetchSubPhase.HitContext hitContext) throws IOException { + static List loadFieldValues(FieldMapper mapper, SearchContext searchContext, FetchSubPhase.HitContext hitContext, boolean forceSource) throws IOException { List textsToHighlight; - if (mapper.fieldType().stored()) { + if (!forceSource && mapper.fieldType().stored()) { CustomFieldsVisitor fieldVisitor = new CustomFieldsVisitor(ImmutableSet.of(mapper.names().indexName()), false); hitContext.reader().document(hitContext.docId(), fieldVisitor); textsToHighlight = fieldVisitor.fields().get(mapper.names().indexName()); diff --git a/src/main/java/org/elasticsearch/search/highlight/HighlighterParseElement.java b/src/main/java/org/elasticsearch/search/highlight/HighlighterParseElement.java index c022fb4da77e0..c50933c1c4021 100644 --- a/src/main/java/org/elasticsearch/search/highlight/HighlighterParseElement.java +++ b/src/main/java/org/elasticsearch/search/highlight/HighlighterParseElement.java @@ -75,6 +75,7 @@ public void parse(XContentParser parser, SearchContext context) throws Exception boolean globalScoreOrdered = false; boolean globalHighlightFilter = false; boolean globalRequireFieldMatch = false; + boolean globalForceSource = false; int globalFragmentSize = 100; int globalNumOfFragments = 5; String globalEncoder = "default"; @@ -136,6 +137,8 @@ public void parse(XContentParser parser, SearchContext context) throws Exception globalFragmenter = parser.text(); } else if ("no_match_size".equals(topLevelFieldName) || "noMatchSize".equals(topLevelFieldName)) { globalNoMatchSize = parser.intValue(); + } else if ("force_source".equals(topLevelFieldName) || "forceSource".equals(topLevelFieldName)) { + globalForceSource = parser.booleanValue(); } } else if (token == XContentParser.Token.START_OBJECT && "options".equals(topLevelFieldName)) { globalOptions = parser.map(); @@ -199,6 +202,8 @@ public void parse(XContentParser parser, SearchContext context) throws Exception field.fragmenter(parser.text()); } else if ("no_match_size".equals(fieldName) || "noMatchSize".equals(fieldName)) { field.noMatchSize(parser.intValue()); + } else if ("force_source".equals(fieldName) || "forceSource".equals(fieldName)) { + field.forceSource(parser.booleanValue()); } } else if (token == XContentParser.Token.START_OBJECT) { if ("highlight_query".equals(fieldName) || "highlightQuery".equals(fieldName)) { @@ -267,6 +272,9 @@ public void parse(XContentParser parser, SearchContext context) throws Exception if (field.noMatchSize() == -1) { field.noMatchSize(globalNoMatchSize); } + if (field.forceSource() == null) { + field.forceSource(globalForceSource); + } } context.highlight(new SearchContextHighlight(fields)); diff --git a/src/main/java/org/elasticsearch/search/highlight/PlainHighlighter.java b/src/main/java/org/elasticsearch/search/highlight/PlainHighlighter.java index f6596f4a1a3fb..f67665ce422a3 100644 --- a/src/main/java/org/elasticsearch/search/highlight/PlainHighlighter.java +++ b/src/main/java/org/elasticsearch/search/highlight/PlainHighlighter.java @@ -99,7 +99,7 @@ public HighlightField highlight(HighlighterContext highlighterContext) { List textsToHighlight; try { - textsToHighlight = HighlightUtils.loadFieldValues(mapper, context, hitContext); + textsToHighlight = HighlightUtils.loadFieldValues(mapper, context, hitContext, field.forceSource()); for (Object textToHighlight : textsToHighlight) { String text = textToHighlight.toString(); diff --git a/src/main/java/org/elasticsearch/search/highlight/PostingsHighlighter.java b/src/main/java/org/elasticsearch/search/highlight/PostingsHighlighter.java index bbf3a17b94485..b850a1bbeeb45 100644 --- a/src/main/java/org/elasticsearch/search/highlight/PostingsHighlighter.java +++ b/src/main/java/org/elasticsearch/search/highlight/PostingsHighlighter.java @@ -93,7 +93,7 @@ public HighlightField highlight(HighlighterContext highlighterContext) { try { //we manually load the field values (from source if needed) - List textsToHighlight = HighlightUtils.loadFieldValues(fieldMapper, context, hitContext); + List textsToHighlight = HighlightUtils.loadFieldValues(fieldMapper, context, hitContext, field.forceSource()); CustomPostingsHighlighter highlighter = new CustomPostingsHighlighter(mapperHighlighterEntry.passageFormatter, textsToHighlight, mergeValues, Integer.MAX_VALUE-1, field.noMatchSize()); if (field.numberOfFragments() == 0) { diff --git a/src/main/java/org/elasticsearch/search/highlight/SearchContextHighlight.java b/src/main/java/org/elasticsearch/search/highlight/SearchContextHighlight.java index 157f01251a24a..d43b0552d5084 100644 --- a/src/main/java/org/elasticsearch/search/highlight/SearchContextHighlight.java +++ b/src/main/java/org/elasticsearch/search/highlight/SearchContextHighlight.java @@ -64,6 +64,8 @@ public static class Field { private String highlighterType; + private Boolean forceSource; + private String fragmenter; private int boundaryMaxScan = -1; @@ -166,6 +168,14 @@ public void highlighterType(String type) { this.highlighterType = type; } + public Boolean forceSource() { + return forceSource; + } + + public void forceSource(boolean forceSource) { + this.forceSource = forceSource; + } + public String fragmenter() { return fragmenter; } diff --git a/src/test/java/org/elasticsearch/percolator/PercolatorTests.java b/src/test/java/org/elasticsearch/percolator/PercolatorTests.java index dfbc66d1cb710..a40bf09294d8d 100644 --- a/src/test/java/org/elasticsearch/percolator/PercolatorTests.java +++ b/src/test/java/org/elasticsearch/percolator/PercolatorTests.java @@ -1305,11 +1305,24 @@ public void testPercolatorWithHighlighting() throws Exception { ensureGreen(); if (randomBoolean()) { + // FVH HL client.admin().indices().preparePutMapping("test").setType("type") .setSource( jsonBuilder().startObject().startObject("type") .startObject("properties") - .startObject("field1").field("type", "string").field("term_vector", "with_positions_offsets").endObject() + .startObject("field1").field("type", "string").field("store", randomBoolean()) + .field("term_vector", "with_positions_offsets").endObject() + .endObject() + .endObject().endObject() + ) + .execute().actionGet(); + } if (randomBoolean()) { + // plain hl with stored fields + client.admin().indices().preparePutMapping("test").setType("type") + .setSource( + jsonBuilder().startObject().startObject("type") + .startObject("properties") + .startObject("field1").field("type", "string").field("store", true).endObject() .endObject() .endObject().endObject() ) diff --git a/src/test/java/org/elasticsearch/search/highlight/HighlighterSearchTests.java b/src/test/java/org/elasticsearch/search/highlight/HighlighterSearchTests.java index ae5dc9f6a0f95..3d6634f4b7772 100644 --- a/src/test/java/org/elasticsearch/search/highlight/HighlighterSearchTests.java +++ b/src/test/java/org/elasticsearch/search/highlight/HighlighterSearchTests.java @@ -506,6 +506,54 @@ public void testHighlightingOnWildcardFields() throws Exception { assertHighlight(searchResponse, 0, "field2", 0, 1, equalTo("this is another test")); } + @Test + public void testPlainHighlighterForceSource() throws Exception { + prepareCreate("test") + .addMapping("type1", "field1", "type=string,store=yes,term_vector=with_positions_offsets,index_options=offsets") + .get(); + ensureGreen(); + + client().prepareIndex("test", "type1") + .setSource("field1", "The quick brown fox jumps over the lazy dog").get(); + refresh(); + + SearchResponse searchResponse = client().prepareSearch("test") + .setQuery(termQuery("field1", "quick")) + .addHighlightedField(new Field("field1").preTags("").postTags("").highlighterType("fvh").forceSource(true)) + .get(); + assertHighlight(searchResponse, 0, "field1", 0, 1, equalTo("The quick brown fox jumps over the lazy dog")); + + searchResponse = client().prepareSearch("test") + .setQuery(termQuery("field1", "quick")) + .addHighlightedField(new Field("field1").preTags("").postTags("").highlighterType("plain").forceSource(true)) + .get(); + assertHighlight(searchResponse, 0, "field1", 0, 1, equalTo("The quick brown fox jumps over the lazy dog")); + + searchResponse = client().prepareSearch("test") + .setQuery(termQuery("field1", "quick")) + .addHighlightedField(new Field("field1").preTags("").postTags("").highlighterType("postings").forceSource(true)) + .get(); + assertHighlight(searchResponse, 0, "field1", 0, 1, equalTo("The quick brown fox jumps over the lazy dog")); + + searchResponse = client().prepareSearch("test") + .setQuery(termQuery("field1", "quick")) + .addHighlightedField(new Field("field1").preTags("").postTags("").highlighterType("fvh").forceSource(false)) + .get(); + assertHighlight(searchResponse, 0, "field1", 0, 1, equalTo("The quick brown fox jumps over the lazy dog")); + + searchResponse = client().prepareSearch("test") + .setQuery(termQuery("field1", "quick")) + .addHighlightedField(new Field("field1").preTags("").postTags("").highlighterType("plain").forceSource(false)) + .get(); + assertHighlight(searchResponse, 0, "field1", 0, 1, equalTo("The quick brown fox jumps over the lazy dog")); + + searchResponse = client().prepareSearch("test") + .setQuery(termQuery("field1", "quick")) + .addHighlightedField(new Field("field1").preTags("").postTags("").highlighterType("postings").forceSource(false)) + .get(); + assertHighlight(searchResponse, 0, "field1", 0, 1, equalTo("The quick brown fox jumps over the lazy dog")); + } + @Test public void testPlainHighlighter() throws Exception { createIndex("test");