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 *
44 * Class generated the jsp files needed to manage portlets
45 *
46 */
47 public class PortletJspGenerator extends AbstractGenerator
48 {
49 private static final String PATH = "webapp/jsp/admin/plugins/";
50 private static final String EXT_JSP = ".jsp";
51 private static String [ ] _prefix = {
52 "Modify", "DoModify", "Create", "DoCreate"
53 };
54
55 /**
56 * {@inheritDoc }
57 */
58 @Override
59 public Map generate( PluginModel pm, String generationSchemeName )
60 {
61 HashMap map = new HashMap( );
62 String strPluginName = pm.getPluginNameAsRadicalPackage( );
63
64 String _path = PATH + pm.getPluginNameAsRadicalPath( ) + "/";
65
66 for ( Portlet portlet : pm.getPortlets( ) )
67 {
68 for ( int i = 0; i < _prefix.length; i++ )
69 {
70 String strPortletFile = _prefix [i] + portlet.getJspBaseName( ) + EXT_JSP;
71 String strPath = getFilePath( pm, _path, strPortletFile );
72 String strSourceCode = getPortletJspFile( portlet, strPluginName, i, pm.isModule( ) );
73 strSourceCode = strSourceCode.replace( "<", "<" );
74 strSourceCode = strSourceCode.replace( ">", ">" );
75 map.put( strPath, strSourceCode );
76 }
77 }
78
79 return map;
80 }
81
82 /**
83 * Gets the portlet Jsp File
84 *
85 * @param portlet
86 * The portlet
87 * @param strPluginName
88 * the plugin name
89 * @param nPortletJspType
90 * The type of portlet
91 * @return The source code of the portlet jsp
92 */
93 private String getPortletJspFile( Portlet portlet, String strPluginName, int nPortletJspType, boolean bIsModule )
94 {
95 Map<String, Object> model = new HashMap<>( );
96 model.put( Markers.MARK_PORTLET, portlet );
97 model.put( Markers.MARK_PLUGIN_NAME, strPluginName );
98 model.put( Markers.MARK_PORTLET_JSP_TYPE, nPortletJspType );
99 model.put( Markers.MARK_IS_MODULE, bIsModule );
100
101 return build( model );
102 }
103 }