View Javadoc
1   /*
2    * Copyright (c) 2002-2014, 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 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.datastore.DatastoreService;
38  import fr.paris.lutece.portal.service.includes.PageInclude;
39  import fr.paris.lutece.portal.service.init.AppInfo;
40  
41  import java.util.Map;
42  
43  import javax.servlet.http.HttpServletRequest;
44  
45  
46  /**
47   * This class includes metas into the head of the HTML page
48   */
49  public class MetasInclude implements PageInclude
50  {
51      private static final String KEY_WEBMASTER_META_AUTHOR = "portal.site.site_property.meta.author";
52      private static final String KEY_WEBMASTER_META_COPYRIGHT = "portal.site.site_property.meta.copyright";
53      private static final String KEY_WEBMASTER_META_KEYWORDS = "portal.site.site_property.meta.keywords";
54      private static final String KEY_WEBMASTER_META_DESCRIPTION = "portal.site.site_property.meta.description";
55      private static final String MARK_PAGE_HEAD_META_AUTHOR = "meta_author";
56      private static final String MARK_PAGE_HEAD_META_COPYRIGHT = "meta_copyright";
57      private static final String MARK_PAGE_HEAD_META_KEYWORDS = "meta_keywords";
58      private static final String MARK_PAGE_HEAD_META_DESCRIPTION = "meta_description";
59      private static final String MARK_PAGE_HEAD_META_GENERATOR = "meta_generator";
60  
61      /**
62       * Substitue specific Freemarker markers in the page template.
63       * @param rootModel the HashMap containing markers to substitute
64       * @param data A PageData object containing applications data
65       * @param nMode The current mode
66       * @param request The HTTP request
67       */
68      @Override
69      public void fillTemplate( Map<String, Object> rootModel, PageData data, int nMode, HttpServletRequest request )
70      {
71          String strMetaAuthor = ( data.getMetaAuthor(  ) != null ) ? data.getMetaAuthor(  )
72                                                                    : DatastoreService.getDataValue( KEY_WEBMASTER_META_AUTHOR,
73                  "" );
74          String strMetaCopyright = ( data.getMetaCopyright(  ) != null ) ? data.getMetaCopyright(  )
75                                                                          : DatastoreService.getDataValue( KEY_WEBMASTER_META_COPYRIGHT,
76                  "" );
77          String strMetaKeywords = ( ( data.getMetaKeywords(  ) != null ) && ( data.getMetaKeywords(  ).length(  ) > 0 ) )
78              ? ( DatastoreService.getDataValue( KEY_WEBMASTER_META_KEYWORDS, "" ) + ", " + data.getMetaKeywords(  ) )
79              : DatastoreService.getDataValue( KEY_WEBMASTER_META_KEYWORDS, "" );
80          String strMetaDescription = ( ( data.getMetaDescription(  ) != null ) &&
81              ( data.getMetaDescription(  ).length(  ) > 0 ) ) ? data.getMetaDescription(  )
82                                                               : DatastoreService.getDataValue( KEY_WEBMASTER_META_DESCRIPTION,
83                  "" );
84  
85          rootModel.put( MARK_PAGE_HEAD_META_AUTHOR, strMetaAuthor );
86          rootModel.put( MARK_PAGE_HEAD_META_COPYRIGHT, strMetaCopyright );
87          rootModel.put( MARK_PAGE_HEAD_META_KEYWORDS, strMetaKeywords );
88          rootModel.put( MARK_PAGE_HEAD_META_DESCRIPTION, strMetaDescription );
89          rootModel.put( MARK_PAGE_HEAD_META_GENERATOR, "LUTECE " + AppInfo.getVersion(  ) );
90      }
91  }