View Javadoc
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.portal.web.search;
35  
36  import fr.paris.lutece.portal.service.admin.AccessDeniedException;
37  import fr.paris.lutece.portal.service.search.IndexationService;
38  import fr.paris.lutece.portal.service.search.SearchIndexer;
39  import fr.paris.lutece.portal.service.security.SecurityTokenService;
40  import fr.paris.lutece.portal.service.template.AppTemplateService;
41  import fr.paris.lutece.portal.web.admin.AdminFeaturesPageJspBean;
42  import fr.paris.lutece.portal.web.dashboard.AdminDashboardJspBean;
43  import fr.paris.lutece.util.html.HtmlTemplate;
44  
45  import java.util.Collection;
46  import java.util.HashMap;
47  
48  import javax.servlet.http.HttpServletRequest;
49  
50  /**
51   * This class provides the user interface to manage the launching of the indexing of the site pages
52   */
53  public class SearchIndexationJspBean extends AdminFeaturesPageJspBean
54  {
55      // //////////////////////////////////////////////////////////////////////////
56      // Constantes
57      /**
58       * Right to manage indexation
59       */
60      public static final String RIGHT_INDEXER = "CORE_SEARCH_INDEXATION";
61      private static final long serialVersionUID = 2585709013740037568L;
62      private static final String TEMPLATE_MANAGE_INDEXER = "admin/search/manage_search_indexation.html";
63      private static final String TEMPLATE_INDEXER_LOGS = "admin/search/search_indexation_logs.html";
64      private static final String MARK_LOGS = "logs";
65      private static final String MARK_INDEXERS_LIST = "indexers_list";
66  
67      /**
68       * Displays the indexing parameters
69       *
70       * @param request
71       *            the http request
72       * @return the html code which displays the parameters page
73       */
74      public String getIndexingProperties( HttpServletRequest request )
75      {
76          HashMap<String, Object> model = new HashMap<>( );
77          Collection<SearchIndexer> listIndexers = IndexationService.getIndexers( );
78          model.put( MARK_INDEXERS_LIST, listIndexers );
79          model.put( SecurityTokenService.MARK_TOKEN, SecurityTokenService.getInstance( ).getToken( request, TEMPLATE_MANAGE_INDEXER ) );
80  
81          HtmlTemplate template = AppTemplateService.getTemplate( TEMPLATE_MANAGE_INDEXER, getLocale( ), model );
82  
83          return getAdminPage( template.getHtml( ) );
84      }
85  
86      /**
87       * Calls the indexing process
88       *
89       * @param request
90       *            the http request
91       * @return the result of the indexing process
92       * @throws AccessDeniedException
93       *             if the security token is invalid
94       */
95      public String doIndexing( HttpServletRequest request ) throws AccessDeniedException
96      {
97          if ( !SecurityTokenService.getInstance( ).validate( request, TEMPLATE_MANAGE_INDEXER ) )
98          {
99              throw new AccessDeniedException( ERROR_INVALID_TOKEN );
100         }
101         HashMap<String, Object> model = new HashMap<>( );
102         String strLogs;
103 
104         if ( request.getParameter( "incremental" ) != null )
105         {
106             strLogs = IndexationService.processIndexing( false );
107         }
108         else
109         {
110             strLogs = IndexationService.processIndexing( true );
111         }
112 
113         model.put( MARK_LOGS, strLogs );
114 
115         HtmlTemplate template = AppTemplateService.getTemplate( TEMPLATE_INDEXER_LOGS, null, model );
116 
117         return getAdminPage( template.getHtml( ) );
118     }
119 }