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.plugins.pluginwizard.service.generator;
35
36 import fr.paris.lutece.plugins.pluginwizard.business.model.PluginModel;
37 import fr.paris.lutece.plugins.pluginwizard.business.model.Portlet;
38
39 import java.util.HashMap;
40 import java.util.Map;
41
42 /**
43 * The generator produced the templates necessary for the handling of portlets
44 */
45 public class PortletTemplateGenerator extends AbstractGenerator
46 {
47 private static final String PATH = "webapp/WEB-INF/templates/admin/plugins/{plugin_name}/portlet/";
48 private static final String EXT_HTML = ".html";
49 private static String [ ] _prefix = {
50 "combo_feed_", "modify_", "create_"
51 };
52
53 /**
54 * {@inheritDoc }
55 */
56 @Override
57 public Map generate( PluginModel pm, String generationSchemeName )
58 {
59 HashMap map = new HashMap( );
60 String strPluginName = pm.getPluginNameAsRadicalPackage( );
61
62 for ( Portlet portlet : pm.getPortlets( ) )
63 {
64 for ( int i = 0; i < _prefix.length; i++ )
65 {
66 String strPortletFile = getPortletTemplateName( portlet.getJspBaseName( ).toLowerCase( ), i );
67
68 String strPath = getFilePath( pm, PATH, strPortletFile );
69
70 String strSourceCode = getPortletHtmlTemplate( portlet, strPluginName, i );
71 strSourceCode = strSourceCode.replace( "<", "<" );
72 strSourceCode = strSourceCode.replace( ">", ">" );
73 strSourceCode = strSourceCode.replace( "@@", "#" );
74 map.put( strPath, strSourceCode );
75 }
76 }
77
78 return map;
79 }
80
81 /**
82 * Chooses the name of the template
83 *
84 * @param strPortletName
85 * The name of the portlet
86 * @param nTemplate
87 * The type of template
88 * @return The name of the tempate
89 */
90 private String getPortletTemplateName( String strPortletName, int nTemplate )
91 {
92 return _prefix [nTemplate] + strPortletName + EXT_HTML;
93 }
94
95 /**
96 * Produces text content of the html template for a portlet
97 *
98 * @param portlet
99 * The instance of a portlet
100 * @param strPluginName
101 * The plugin name
102 * @param nPortletTemplateType
103 * The type of portlet
104 * @return The content of the html template
105 */
106 private String getPortletHtmlTemplate( Portlet portlet, String strPluginName, int nPortletTemplateType )
107 {
108 Map<String, Object> model = new HashMap<>( );
109 model.put( Markers.MARK_I18N_BRACKETS_OPEN, "@@i18n{" );
110 model.put( Markers.MARK_I18N_BRACKETS_CLOSE, "}" );
111 model.put( Markers.MARK_BRACKETS_OPEN, "${" );
112 model.put( Markers.MARK_BRACKETS_CLOSE, "}" );
113 model.put( Markers.MARK_MACRO, "@" );
114 model.put( Markers.MARK_PORTLET, portlet );
115 model.put( Markers.MARK_PLUGIN_NAME, strPluginName );
116 model.put( Markers.MARK_PORTLET_TEMPLATE_TYPE, nPortletTemplateType );
117
118 return build( model );
119 }
120 }