1 /*
2 * Copyright (c) 2002-2025, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.suggest.service.suggestsearch;
35
36 import fr.paris.lutece.plugins.suggest.business.SuggestSubmit;
37 import fr.paris.lutece.plugins.suggest.business.SubmitFilter;
38 import fr.paris.lutece.plugins.suggest.service.SuggestSubmitService;
39 import fr.paris.lutece.plugins.suggest.service.search.SuggestIndexer;
40 import fr.paris.lutece.plugins.suggest.utils.SuggestUtils;
41 import fr.paris.lutece.portal.service.plugin.Plugin;
42 import fr.paris.lutece.portal.service.spring.SpringContextService;
43
44 import org.apache.commons.lang3.StringUtils;
45
46 import java.util.ArrayList;
47 import java.util.List;
48
49 /**
50 * DocumentSearchService
51 */
52 public class SuggestSearchService
53 {
54 private static final String BEAN_SEARCH_ENGINE = "suggest.suggestSearchEngine";
55 private static final String REGEX_ID = "^[\\d]+$";
56
57 // Constants corresponding to the variables defined in the lutece.properties file
58 private static SuggestSearchService _singleton;
59
60 /**
61 * @return the instance of the service
62 */
63 public static SuggestSearchService getInstance( )
64 {
65 if ( _singleton == null )
66 {
67 _singleton = new SuggestSearchService( );
68 }
69
70 return _singleton;
71 }
72
73 /**
74 * Return search results
75 *
76 * @param strQuery
77 * The search query
78 * @param filter
79 * The filter
80 * @param plugin
81 * The plugin
82 * @return Results as a collection of {@link SuggestSubmit}
83 */
84 public List<Integer> getSearchResults( String strQuery, SubmitFilter filter, Plugin plugin )
85 {
86 List<Integer> listSuggestSubmitResult = new ArrayList<>( );
87 SuggestSearchEngine engine = SpringContextService.getBean( BEAN_SEARCH_ENGINE );
88 List<Integer> suggestSubmitListId = SuggestSubmitService.getService( ).getSuggestSubmitListId( filter, plugin );
89 List<SuggestSearchItem> listSearchesults = StringUtils.isEmpty( strQuery ) ? null : engine.getSearchResults( strQuery, filter );
90
91 if ( StringUtils.isEmpty( strQuery ) )
92 {
93 listSuggestSubmitResult = suggestSubmitListId;
94 }
95 else
96 if ( suggestSubmitListId != null )
97 {
98 for ( Integer nSuggestSubmitId : suggestSubmitListId )
99 {
100 for ( SuggestSearchItem searchResult : listSearchesults )
101 {
102 if ( ( searchResult.getType( ) != null ) && ( searchResult.getId( ) != null )
103 && searchResult.getType( ).equals( SuggestIndexer.INDEX_TYPE_SUGGEST ) && searchResult.getIdSuggestSubmit( ).matches( REGEX_ID )
104 && ( Integer.parseInt( searchResult.getIdSuggestSubmit( ) ) == nSuggestSubmitId ) )
105 {
106 listSuggestSubmitResult.add( SuggestUtils.getIntegerParameter( searchResult.getIdSuggestSubmit( ) ) );
107 }
108 }
109 }
110 }
111
112 return listSuggestSubmitResult;
113 }
114 }