1 /*
2 * Copyright (c) 2002-2022, 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.appointment.modules.management.service.indexer;
35
36 import java.io.IOException;
37 import java.nio.file.Paths;
38
39 import javax.inject.Inject;
40 import javax.inject.Named;
41
42 import org.apache.lucene.analysis.Analyzer;
43 import org.apache.lucene.index.DirectoryReader;
44 import org.apache.lucene.index.IndexWriter;
45 import org.apache.lucene.index.IndexWriterConfig;
46 import org.apache.lucene.index.IndexWriterConfig.OpenMode;
47 import org.apache.lucene.store.Directory;
48 import org.apache.lucene.store.FSDirectory;
49
50 import fr.paris.lutece.portal.service.util.AppLogService;
51 import fr.paris.lutece.portal.service.util.AppPathService;
52 import fr.paris.lutece.portal.service.util.AppPropertiesService;
53
54 public class LuceneAppointmentIndexFactory
55 {
56 // Constants
57 private static final String PATH_INDEX = "appointment-management.internalIndexer.lucene.indexPath";
58 private static final String PATH_INDEX_IN_WEBAPP = "appointment-management.internalIndexer.lucene.indexInWebapp";
59
60 @Inject
61 @Named( value = "appointment-management.luceneAnalizer" )
62 private Analyzer _analyzer;
63
64 private IndexWriter _indexWriter;
65
66 /**
67 * Create the IndexWriter with its configuration
68 *
69 * @param bCreateIndex
70 * The boolean which tell if the index must be created
71 * @return the created IndexWriter
72 * @throws IOException
73 * - if there is a low level IO error
74 */
75 public IndexWriter getIndexWriter( Boolean bCreateIndex )
76 {
77 if ( _indexWriter == null || !_indexWriter.isOpen( ) )
78 {
79 try
80 {
81 Directory luceneDirectory = getDirectory( );
82
83 if ( !DirectoryReader.indexExists( luceneDirectory ) )
84 {
85 bCreateIndex = Boolean.TRUE;
86 }
87
88 IndexWriterConfig conf = new IndexWriterConfig( _analyzer );
89
90 if ( Boolean.TRUE.equals( bCreateIndex ) )
91 {
92 conf.setOpenMode( OpenMode.CREATE );
93 }
94 else
95 {
96 conf.setOpenMode( OpenMode.APPEND );
97 }
98 _indexWriter = new IndexWriter( luceneDirectory, conf );
99 }
100 catch( IOException e )
101 {
102 AppLogService.error( "Unable to create a new Lucene Index Writer", e );
103 return null;
104 }
105 }
106 return _indexWriter;
107 }
108
109 /**
110 * Return the Directory to use for the search
111 *
112 * @return the Directory to use for the search
113 * @throws IOException
114 * - if the path string cannot be converted to a Path
115 */
116 public Directory getDirectory( ) throws IOException
117 {
118 String strIndex;
119
120 boolean indexInWebapp = AppPropertiesService.getPropertyBoolean( PATH_INDEX_IN_WEBAPP, true );
121 if ( indexInWebapp )
122 {
123 strIndex = AppPathService.getPath( PATH_INDEX );
124 }
125 else
126 {
127 strIndex = AppPropertiesService.getProperty( PATH_INDEX );
128 }
129
130 return FSDirectory.open( Paths.get( strIndex ) );
131 }
132 }