View Javadoc
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.portal.web.template;
35  
36  import fr.paris.lutece.portal.business.template.AutoInclude;
37  import fr.paris.lutece.portal.business.user.AdminUser;
38  import fr.paris.lutece.portal.service.dashboard.admin.AdminDashboardComponent;
39  import fr.paris.lutece.portal.service.template.AppTemplateService;
40  import fr.paris.lutece.portal.service.template.CommonsService;
41  import fr.paris.lutece.portal.service.template.FreeMarkerTemplateService;
42  import fr.paris.lutece.util.html.HtmlTemplate;
43  import java.util.HashMap;
44  import java.util.List;
45  import java.util.Map;
46  import javax.servlet.http.HttpServletRequest;
47  
48  /**
49   * AutoIncludeAdminDashboardComponent
50   */
51  public class AutoIncludeAdminDashboardComponent extends AdminDashboardComponent
52  {
53      // Templates
54      private static final String TEMPLATE_MANAGE_AUTOINCLUDES = "/admin/dashboard/admin/autoincludes_dashboard.html";
55      // Markers
56      private static final String MARK_AUTOINCLUDE_LIST = "autoinclude_list";
57      private static final String MARK_AUTOIMPORT_MAP = "autoimport_map";
58      private static final String MARK_COMMONS_LIST = "commons_list";
59      private static final String MARK_CURRENT_COMMONS = "current_commons";
60  
61      /**
62       * {@inheritDoc}
63       */
64      @Override
65      public String getDashboardData( AdminUser user, HttpServletRequest request )
66      {
67          Map<String, Object> model = new HashMap<>( );
68          FreeMarkerTemplateService fmtService = FreeMarkerTemplateService.getInstance( );
69          model.put( MARK_AUTOINCLUDE_LIST, fmtService.getAutoIncludesList( ) );
70          model.put( MARK_AUTOIMPORT_MAP, fmtService.getAutoImportsMap( ) );
71          model.put( MARK_COMMONS_LIST, CommonsService.getCommonsList( ) );
72          model.put( MARK_CURRENT_COMMONS, CommonsService.getCurrentCommonsKey( ) );
73  
74          HtmlTemplate template = AppTemplateService.getTemplate( TEMPLATE_MANAGE_AUTOINCLUDES, user.getLocale( ), model );
75          return template.getHtml( );
76      }
77  
78  }