1 /*
2 * Copyright (c) 2002-2020, 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.wordtemplate.service;
35
36 import fr.paris.lutece.plugins.wordtemplate.exception.WordTemplateException;
37 import freemarker.core.Environment;
38 import freemarker.template.Configuration;
39 import freemarker.template.Template;
40 import freemarker.template.TemplateException;
41 import java.io.IOException;
42 import java.io.StringWriter;
43
44 /**
45 * Template service based on the Freemarker template engine
46 */
47 public class TemplateEngineService
48 {
49
50 /**
51 * Process the template transformation and return the {@link HtmlTemplate}
52 *
53 * @param strTemplate
54 * The template name to call
55 * @return The {@link HtmlTemplate}
56 */
57 public static Template createTemplate( String strTemplate )
58 {
59 Template ftl;
60 try
61 {
62 Configuration cfg = new Configuration( Configuration.VERSION_2_3_28 );
63 ftl = new Template( "WordElementTemplate", strTemplate, cfg );
64 }
65 catch( IOException e )
66 {
67 throw new WordTemplateException( e.getMessage( ), e );
68 }
69 return ftl;
70 }
71
72 /**
73 * Process the template transformation and return the {@link HtmlTemplate}
74 *
75 * @param strTemplate
76 * The template name to call
77 * @param rootMap
78 * The HashMap model
79 * @return The {@link HtmlTemplate}
80 */
81 public static String processTemplate( String strTemplate, Object rootMap )
82 {
83 StringWriter writer = new StringWriter( 1024 );
84
85 try
86 {
87 Template template = createTemplate( strTemplate );
88 template.process( rootMap, writer );
89 }
90 catch( IOException | TemplateException e )
91 {
92 throw new WordTemplateException( e.getMessage( ), e );
93 }
94 return writer.toString( );
95 }
96
97 /**
98 * Process the template transformation and return the {@link HtmlTemplate}
99 *
100 * @param strTemplate
101 * The template name to call
102 * @param rootMap
103 * The HashMap model
104 * @return The {@link HtmlTemplate}
105 */
106 public static Environment getEnvironment( String strTemplate, Object rootMap )
107 {
108 StringWriter writer = new StringWriter( 1024 );
109
110 Environment environment;
111 try
112 {
113 Template template = createTemplate( strTemplate );
114 environment = template.createProcessingEnvironment( rootMap, writer );
115 environment.process( );
116 }
117 catch( IOException | TemplateException e )
118 {
119 throw new WordTemplateException( e.getMessage( ), e );
120 }
121 return environment;
122 }
123
124 }