1 /*
2 * Copyright (c) 2002-2023, 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.plugins.document.web;
35
36 import fr.paris.lutece.plugins.document.business.Document;
37 import fr.paris.lutece.plugins.document.business.DocumentHome;
38 import fr.paris.lutece.plugins.document.utils.IntegerUtils;
39 import fr.paris.lutece.portal.service.content.PageData;
40 import fr.paris.lutece.portal.service.html.XmlTransformerService;
41 import fr.paris.lutece.portal.service.includes.PageInclude;
42 import fr.paris.lutece.portal.service.util.AppPathService;
43
44 import org.apache.commons.lang3.StringUtils;
45
46 import java.io.FileInputStream;
47
48 import java.util.Map;
49
50 import javax.servlet.http.HttpServletRequest;
51
52 import javax.xml.transform.Source;
53 import javax.xml.transform.stream.StreamSource;
54
55
56 /**
57 * Document Meta PageInclude
58 */
59 public class DocumentMetaPageInclude implements PageInclude
60 {
61 private static final String MARK_DOCUMENT_META = "document_meta";
62 private static final String PARAMETER_DOCUMENT_ID = "document_id";
63 private static final String PATH_XSL = "/WEB-INF/plugins/document/xsl/";
64 private static final String FILE_XSL = "document_include_meta.xsl";
65 private static final String STYLE_PREFIX_ID = PATH_XSL + FILE_XSL;
66
67 /**
68 * Substitue specific Freemarker markers in the page template.
69 * @param rootModel the HashMap containing markers to substitute
70 * @param data A PageData object containing applications data
71 * @param nMode The current mode
72 * @param request The HTTP request
73 */
74 public void fillTemplate( Map<String, Object> rootModel, PageData data, int nMode, HttpServletRequest request )
75 {
76 String strMeta = StringUtils.EMPTY;
77
78 if ( request != null )
79 {
80 String strDocumentId = request.getParameter( PARAMETER_DOCUMENT_ID );
81
82 if ( IntegerUtils.isNumeric( strDocumentId ) )
83 {
84 Document document = DocumentHome.findByPrimaryKeyWithoutBinaries( IntegerUtils.convert( strDocumentId ) );
85
86 if ( document != null )
87 {
88 String strMetadata = document.getXmlMetadata( );
89
90 if ( StringUtils.isNotBlank( strMetadata ) )
91 {
92 Source xslSource = loadXsl( );
93 XmlTransformerService xmlTransformerService = new XmlTransformerService( );
94 strMeta = xmlTransformerService.transformBySourceWithXslCache( strMetadata, xslSource,
95 STYLE_PREFIX_ID, null, null );
96 }
97 }
98 }
99
100 rootModel.put( MARK_DOCUMENT_META, strMeta );
101 }
102 }
103
104 /**
105 * Load the XSL stylesheet used to convert document metadata into meta tags
106 * @return The source stream
107 */
108 private Source loadXsl( )
109 {
110 FileInputStream fis = AppPathService.getResourceAsStream( PATH_XSL, FILE_XSL );
111 Source sourceXsl = new StreamSource( fis );
112
113 return sourceXsl;
114 }
115 }