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
38 import java.util.HashMap;
39 import java.util.Map;
40
41 /**
42 *
43 * The sql files generator
44 *
45 */
46 public class SqlCodeGenerator extends AbstractGenerator
47 {
48 private static final String PATH = "src/sql/plugins/{plugin_name}/";
49 private static String [ ] _prefix = {
50 "plugin/create_db_", "plugin/init_db_", "plugin/init_db_", "core/init_core_", "core/create_"
51 };
52 private static String [ ] _suffix = {
53 ".sql", ".sql", "_sample.sql", ".sql", "_portlet.sql"
54 };
55
56 /**
57 * {@inheritDoc }
58 */
59 @Override
60 public Map generate( PluginModel pm, String generationSchemeName )
61 {
62 HashMap map = new HashMap( );
63
64 for ( int i = 0; i < _prefix.length; i++ )
65 {
66 if ( ! ( _suffix [i].equals( "_portlet.sql" ) && pm.getPortlets( ).isEmpty( ) ) )
67 {
68 String strSqlFile = getSqlFileName( pm.getPluginName( ).toLowerCase( ), i );
69
70 String strPath = getFilePath( pm, PATH, strSqlFile );
71
72 String strSourceCode = getSqlScript( pm, i );
73 strSourceCode = strSourceCode.replace( "<", "<" );
74 strSourceCode = strSourceCode.replace( ">", ">" );
75 map.put( strPath, strSourceCode );
76 }
77 }
78
79 return map;
80 }
81
82 /**
83 * Returns the name of the sql file
84 *
85 * @param strPluginName
86 * The plugin name
87 * @param nSqlType
88 * The type of sql file
89 * @return the name of the sql file
90 */
91 private String getSqlFileName( String strPluginName, int nSqlType )
92 {
93 return _prefix [nSqlType] + strPluginName + _suffix [nSqlType];
94 }
95
96 /**
97 * Returns the necessary sql dump of creation of plugin and core
98 *
99 * @param nSqlType
100 * The type of the sql
101 * @param pm
102 * The plugin Model
103 * @return The corresponding sql output
104 */
105 private String getSqlScript( PluginModel pm, int nSqlType )
106 {
107 Map<String, Object> model = new HashMap<>( );
108
109 PluginXmlGenerator.setJspName( pm );
110 model.put( Markers.MARK_PLUGIN, pm );
111
112 model.put( Markers.MARK_SQL_TYPE, nSqlType );
113
114 return build( model );
115 }
116 }