Files
SCM-Manager/scm-webapp/src/main/java/sonia/scm/search/LuceneSearchEngine.java
Sebastian Sdorra 21a6943980 Refactor Search API and allow analyzer per field (#1755)
The Search api is now simpler, because it provides useful defaults. Only if you want to deviate from the defaults, you can set these values. This is mostly reached by using the builder pattern. Furthermore it is now possible to configure an analyzer per field. The default analyzer is still the one which is derived from the index options, but it is possible to configure a new indexer with the analyzer attribute of the indexed annotation. The attribute allows the configuration for code, identifiers and path. The current implementation uses the same analyzer code, identifiers and path. The new implemented splits tokens on more delimiters as the default analyzer e.g.: dots, underscores etc.

Co-authored-by: René Pfeuffer <rene.pfeuffer@cloudogu.com>
2021-08-05 08:21:46 +02:00

111 lines
3.4 KiB
Java

/*
* MIT License
*
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package sonia.scm.search;
import org.apache.shiro.SecurityUtils;
import org.apache.shiro.subject.Subject;
import javax.inject.Inject;
import java.util.Collection;
import java.util.stream.Collectors;
public class LuceneSearchEngine implements SearchEngine {
private final SearchableTypeResolver resolver;
private final IndexQueue indexQueue;
private final LuceneQueryBuilderFactory queryBuilderFactory;
@Inject
public LuceneSearchEngine(SearchableTypeResolver resolver, IndexQueue indexQueue, LuceneQueryBuilderFactory queryBuilderFactory) {
this.resolver = resolver;
this.indexQueue = indexQueue;
this.queryBuilderFactory = queryBuilderFactory;
}
@Override
public Collection<SearchableType> getSearchableTypes() {
Subject subject = SecurityUtils.getSubject();
return resolver.getSearchableTypes()
.stream()
.filter(type -> type.getPermission().map(subject::isPermitted).orElse(true))
.collect(Collectors.toList());
}
@Override
public <T> ForType<T> forType(Class<T> type) {
return forType(resolver.resolve(type));
}
@Override
public ForType<Object> forType(String typeName) {
return forType(resolver.resolveByName(typeName));
}
private <T> ForType<T> forType(LuceneSearchableType searchableType) {
return new LuceneForType<>(searchableType);
}
class LuceneForType<T> implements ForType<T> {
private final LuceneSearchableType searchableType;
private IndexOptions options = IndexOptions.defaults();
private String index = "default";
private LuceneForType(LuceneSearchableType searchableType) {
this.searchableType = searchableType;
}
@Override
public ForType<T> withOptions(IndexOptions options) {
this.options = options;
return this;
}
@Override
public ForType<T> withIndex(String index) {
this.index = index;
return this;
}
private IndexParams params() {
return new IndexParams(index, searchableType, options);
}
@Override
public Index<T> getOrCreate() {
return indexQueue.getQueuedIndex(params());
}
@Override
public QueryBuilder<T> search() {
searchableType.getPermission().ifPresent(
permission -> SecurityUtils.getSubject().checkPermission(permission)
);
return queryBuilderFactory.create(params());
}
}
}