1 /*
2 * Copyright (c) 2002-2018, Mairie de 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 description of 'Mairie de Paris' nor 'Lutece' nor the descriptions 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.gtools.web;
35
36 import fr.paris.lutece.portal.service.content.PageData;
37 import fr.paris.lutece.portal.service.datastore.DatastoreService;
38 import fr.paris.lutece.portal.service.includes.PageInclude;
39 import fr.paris.lutece.portal.service.plugin.Plugin;
40 import fr.paris.lutece.portal.service.plugin.PluginService;
41 import fr.paris.lutece.portal.service.template.AppTemplateService;
42 import fr.paris.lutece.util.html.HtmlTemplate;
43
44 import java.util.HashMap;
45 import java.util.Map;
46
47 import javax.servlet.http.HttpServletRequest;
48
49 /**
50 * Include of the ganalytics code
51 */
52 public class AnalyticsInclude implements PageInclude
53 {
54 private static final String KEY_ANALYTICS_CODE = "gtools.site_property.analytics.code";
55 private static final String MARK_GANALYTICS = "google_analytics";
56 private static final String PLUGIN_NAME = "gtools";
57 private static final String TEMPLATE_INCLUDE_GANALYTICS_CODE = "skin/plugins/gtools/include_analytics.html";
58 private static final String MARK_INCLUDE_GANALYTICS_CODE = "ganalytics_code";
59 private Plugin _plugin;
60
61 /**
62 * Substitue specific Freemarker markers in the page template.
63 *
64 * @param rootModel
65 * the HashMap containing markers to substitute
66 * @param data
67 * A PageData object containing applications data
68 * @param nMode
69 * The current mode
70 * @param request
71 * The HTTP request
72 */
73 @Override
74 public void fillTemplate( Map<String, Object> rootModel, PageData data, int nMode, HttpServletRequest request )
75 {
76 _plugin = PluginService.getPlugin( PLUGIN_NAME );
77
78 if ( _plugin != null && request != null )
79 {
80 Map<String, Object> model = new HashMap<String, Object>( );
81 String strCode = DatastoreService.getDataValue( KEY_ANALYTICS_CODE, "<no code provided>" );
82 model.put( MARK_INCLUDE_GANALYTICS_CODE, strCode );
83
84 HtmlTemplate template = AppTemplateService.getTemplate( TEMPLATE_INCLUDE_GANALYTICS_CODE, request.getLocale( ), model );
85
86 rootModel.put( MARK_GANALYTICS, template.getHtml( ) );
87 }
88 else
89 {
90 rootModel.put( MARK_GANALYTICS, "" );
91 }
92 }
93 }