LuceneFormSearchEngine.java
/*
* Copyright (c) 2002-2022, City of Paris
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright notice
* and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice
* and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* License 1.0
*/
package fr.paris.lutece.plugins.forms.service.search;
import fr.paris.lutece.plugins.forms.business.form.FormItemSortConfig;
import fr.paris.lutece.plugins.forms.business.form.LuceneQueryBuilder;
import fr.paris.lutece.plugins.forms.business.form.column.querypart.IFormColumnQueryPart;
import fr.paris.lutece.plugins.forms.business.form.filter.querypart.IFormFilterQueryPart;
import fr.paris.lutece.plugins.forms.business.form.panel.FormPanel;
import fr.paris.lutece.plugins.forms.business.form.panel.initializer.querypart.IFormPanelInitializerQueryPart;
import fr.paris.lutece.plugins.forms.business.form.search.FormResponseSearchItem;
import fr.paris.lutece.portal.service.search.IndexationService;
import fr.paris.lutece.portal.service.search.LuceneSearchEngine;
import fr.paris.lutece.portal.service.search.SearchItem;
import fr.paris.lutece.portal.service.util.AppLogService;
import java.io.IOException;
import java.text.Normalizer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import javax.inject.Inject;
import org.apache.commons.lang3.StringUtils;
import org.apache.lucene.document.Document;
import org.apache.lucene.index.DirectoryReader;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.queryparser.classic.MultiFieldQueryParser;
import org.apache.lucene.queryparser.classic.QueryParser;
import org.apache.lucene.search.BooleanClause;
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.ScoreDoc;
import org.apache.lucene.search.Sort;
import org.apache.lucene.search.SortField;
import org.apache.lucene.search.SortedNumericSortField;
import org.apache.lucene.search.TopDocs;
import org.apache.lucene.store.Directory;
public class LuceneFormSearchEngine implements IFormSearchEngine
{
public static final String BEAN_NAME = "forms.luceneFormsSearchEngine";
@Inject
private LuceneFormSearchFactory _luceneFormSearchFactory;
/**
* {@inheritDoc }
*/
@Override
public List<Integer> getSearchResults( FormSearchConfig formSearchConfig )
{
ArrayList<Integer> listResults = new ArrayList<>( );
IndexSearcher searcher = null;
try ( Directory directory = _luceneFormSearchFactory.getDirectory( ) ; IndexReader ir = DirectoryReader.open( directory ) ; )
{
searcher = new IndexSearcher( ir );
Collection<String> queries = new ArrayList<>( );
Collection<String> fields = new ArrayList<>( );
Collection<BooleanClause.Occur> flags = new ArrayList<>( );
QueryParser qpContent = new QueryParser( SearchItem.FIELD_CONTENTS, IndexationService.getAnalyser( ) );
QueryParser qpDateCreation = new QueryParser( FormResponseSearchItem.FIELD_DATE_CREATION, IndexationService.getAnalyser( ) );
QueryParser qpDateUpdate = new QueryParser( FormResponseSearchItem.FIELD_DATE_UPDATE, IndexationService.getAnalyser( ) );
QueryParser qpGuid = new QueryParser( FormResponseSearchItem.FIELD_GUID, IndexationService.getAnalyser( ) );
qpContent.setDefaultOperator( QueryParser.Operator.AND );
qpDateCreation.setDefaultOperator( QueryParser.Operator.AND );
qpDateUpdate.setDefaultOperator( QueryParser.Operator.AND );
qpGuid.setDefaultOperator( QueryParser.Operator.AND );
String searchedText = normalizeSearchText( formSearchConfig.getSearchedText( ) );
Query queryContent = qpContent.parse( searchedText );
Query queryDateCreation = qpDateCreation.parse( searchedText );
Query queryDateUpdate = qpDateUpdate.parse( searchedText );
Query queryGuid = qpGuid.parse( searchedText );
queries.add( queryContent.toString( ) );
queries.add( queryDateCreation.toString( ) );
queries.add( queryDateUpdate.toString( ) );
queries.add( queryGuid.toString( ) );
fields.add( SearchItem.FIELD_CONTENTS );
fields.add( FormResponseSearchItem.FIELD_DATE_CREATION );
fields.add( FormResponseSearchItem.FIELD_DATE_UPDATE );
fields.add( FormResponseSearchItem.FIELD_GUID );
flags.add( BooleanClause.Occur.SHOULD );
flags.add( BooleanClause.Occur.SHOULD );
flags.add( BooleanClause.Occur.SHOULD );
flags.add( BooleanClause.Occur.SHOULD );
Query queryMulti = MultiFieldQueryParser.parse( queries.toArray( new String [ queries.size( )] ), fields.toArray( new String [ fields.size( )] ),
flags.toArray( new BooleanClause.Occur [ flags.size( )] ), IndexationService.getAnalyser( ) );
// Get results documents
TopDocs topDocs = searcher.search( queryMulti, LuceneSearchEngine.MAX_RESPONSES );
ScoreDoc [ ] hits = topDocs.scoreDocs;
for ( int i = 0; i < hits.length; i++ )
{
Document document = searcher.doc( hits [i].doc );
SearchItem si = new SearchItem( document );
listResults.add( Integer.parseInt( si.getId( ) ) );
}
}
catch( Exception e )
{
AppLogService.error( e.getMessage( ), e );
}
return listResults;
}
private String normalizeSearchText( String text )
{
if ( StringUtils.isEmpty( text ) )
{
return text;
}
return Normalizer.normalize( text, Normalizer.Form.NFD ).replaceAll( "\\p{M}", "" );
}
/**
* {@inheritDoc }
*/
@Override
public List<Integer> getSearchResults( String strSearchText )
{
FormSearchConfig config = new FormSearchConfig( );
config.setSearchedText( strSearchText );
return getSearchResults( config );
}
/**
* {@inheritDoc }
*/
@Override
public List<FormResponseSearchItem> getSearchResults( List<IFormPanelInitializerQueryPart> listFormPanelInitializerQueryPart,
List<IFormColumnQueryPart> listFormColumnQueryPart, List<IFormFilterQueryPart> listFormFilterQueryPart, FormItemSortConfig sortConfig,
int nStartIndex, int nPageSize, FormPanel formPanel )
{
// Build the query to execute
Query query = LuceneQueryBuilder.buildQuery( listFormPanelInitializerQueryPart, listFormFilterQueryPart );
// Build the sort
Sort sort = buildLuceneSort( sortConfig );
List<FormResponseSearchItem> listResults = new ArrayList<>( );
IndexSearcher searcher = null;
try ( Directory directory = _luceneFormSearchFactory.getDirectory( ) ; IndexReader ir = DirectoryReader.open( directory ) ; )
{
searcher = new IndexSearcher( ir );
TopDocs topDocs = null;
// Get results documents
if ( sort != null )
{
topDocs = searcher.search( query, LuceneSearchEngine.MAX_RESPONSES, sort );
}
else
{
topDocs = searcher.search( query, LuceneSearchEngine.MAX_RESPONSES );
}
ScoreDoc [ ] hits = topDocs.scoreDocs;
int nMaxIndex = hits.length;
if ( nPageSize > 0 )
{
nMaxIndex = Math.min( nStartIndex + nPageSize, hits.length );
}
formPanel.setTotalFormResponseItemCount( hits.length );
for ( int i = nStartIndex; i < nMaxIndex; i++ )
{
Document document = searcher.doc( hits [i].doc );
listResults.add( new FormResponseSearchItem( document ) );
}
}
catch( IOException e )
{
AppLogService.error( e.getMessage( ), e );
}
return listResults;
}
/**
* Build the Lucene Sort obj
*
* @param sortConfig
* The sort config
* @return the Lucene Sort obj
*/
private Sort buildLuceneSort( FormItemSortConfig sortConfig )
{
if ( sortConfig != null )
{
String strAttributeName = sortConfig.getSortAttributeName( );
if ( strAttributeName != null )
{
if ( strAttributeName.endsWith( FormResponseSearchItem.FIELD_DATE_SUFFIX ) )
{
return new Sort( new SortedNumericSortField( sortConfig.getSortAttributeName( ), SortField.Type.LONG, sortConfig.isAscSort( ) ) );
}
if ( strAttributeName.endsWith( FormResponseSearchItem.FIELD_INT_SUFFIX ) )
{
return new Sort( new SortedNumericSortField( sortConfig.getSortAttributeName( ), SortField.Type.LONG, sortConfig.isAscSort( ) ) );
}
return new Sort( new SortField( sortConfig.getSortAttributeName( ), SortField.Type.STRING, sortConfig.isAscSort( ) ) );
}
}
return null;
}
}