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.includes;
35  
36  import fr.paris.lutece.portal.service.content.PageData;
37  import fr.paris.lutece.portal.service.includes.PageInclude;
38  import fr.paris.lutece.portal.service.template.AppTemplateService;
39  import fr.paris.lutece.portal.service.util.AppPropertiesService;
40  import fr.paris.lutece.util.html.HtmlTemplate;
41  
42  import java.util.HashMap;
43  import java.util.Map;
44  
45  import javax.servlet.http.HttpServletRequest;
46  
47  /**
48   * This Page Include
49   */
50  public class StatisticsInclude implements PageInclude
51  {
52      private static final String PROPERTY_STATISTICAL_SITE_ID = "lutece.statistical.site.id";
53      private static final String PROPERTY_STATISTICAL_INCLUDE_ENABLE = "lutece.statistical.include.enable";
54      private static final String PROPERTY_STATISTICAL_INCLUDE_TEMPLATE = "lutece.statistical.include.template";
55      private static final String PROPERTY_STATISTICAL_INCLUDE_HEAD_TEMPLATE = "lutece.statistical.include.template.head";
56      private static final String PROPERTY_STATISTICAL_SERVER_URL = "lutece.statistical.server.url";
57      private static final String MARK_STATISTICAL_INCLUDE = "statistical_include";
58      private static final String MARK_STATISTICAL_INCLUDE_HEAD = "statistical_include_head";
59      private static final String MARK_STATISTICAL_SITE_ID = "statistical_site_id";
60      private static final String MARK_STATISTICAL_SERVER_URL = "statistical_server_url";
61  
62      /**
63       * Substitue specific Freemarker markers in the page template.
64       * 
65       * @param rootModel
66       *            the HashMap containing markers to substitute
67       * @param data
68       *            A PageData object containing applications data
69       * @param nMode
70       *            The current mode
71       * @param request
72       *            The HTTP request
73       */
74      public void fillTemplate( Map<String, Object> rootModel, PageData data, int nMode, HttpServletRequest request )
75      {
76          String strStatisticalIncludeHead;
77          String strStatisticalInclude;
78  
79          if ( request != null )
80          {
81              String strStatisticalSiteId = AppPropertiesService.getProperty( PROPERTY_STATISTICAL_SITE_ID, "1" );
82              String strStatisticalIncludeEnable = AppPropertiesService.getProperty( PROPERTY_STATISTICAL_INCLUDE_ENABLE );
83              String strStatisticalServerUrl = AppPropertiesService.getProperty( PROPERTY_STATISTICAL_SERVER_URL );
84  
85              if ( ( strStatisticalIncludeEnable != null ) && ( strStatisticalIncludeEnable.equalsIgnoreCase( "true" ) ) )
86              {
87                  String strStatisticalIncludeTemplateHead = AppPropertiesService.getProperty( PROPERTY_STATISTICAL_INCLUDE_HEAD_TEMPLATE );
88  
89                  Map<String, String> model = new HashMap<>( );
90                  model.put( MARK_STATISTICAL_SITE_ID, strStatisticalSiteId );
91                  model.put( MARK_STATISTICAL_SERVER_URL, strStatisticalServerUrl );
92  
93                  HtmlTemplate tHead = AppTemplateService.getTemplate( strStatisticalIncludeTemplateHead, request.getLocale( ), model );
94                  strStatisticalIncludeHead = tHead.getHtml( );
95  
96                  String strStatisticalIncludeTemplate = AppPropertiesService.getProperty( PROPERTY_STATISTICAL_INCLUDE_TEMPLATE );
97                  HtmlTemplate t = AppTemplateService.getTemplate( strStatisticalIncludeTemplate, request.getLocale( ), model );
98                  strStatisticalInclude = t.getHtml( );
99              }
100             else
101             {
102                 // markers are defaulted to empty string to avoid freemarker errors
103                 strStatisticalIncludeHead = "";
104                 strStatisticalInclude = "";
105             }
106         }
107         else
108         {
109             // markers are defaulted to empty string to avoid freemarker errors
110             strStatisticalIncludeHead = "";
111             strStatisticalInclude = "";
112         }
113 
114         rootModel.put( MARK_STATISTICAL_INCLUDE_HEAD, strStatisticalIncludeHead );
115         rootModel.put( MARK_STATISTICAL_INCLUDE, strStatisticalInclude );
116     }
117 }