View Javadoc
1   /*
2    * Copyright (c) 2002-2025, 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.Application;
37  import fr.paris.lutece.plugins.pluginwizard.business.model.BusinessClass;
38  import fr.paris.lutece.plugins.pluginwizard.business.model.PluginModel;
39  import fr.paris.lutece.plugins.pluginwizard.service.ModelService;
40  import fr.paris.lutece.plugins.pluginwizard.util.Utils;
41  import fr.paris.lutece.portal.service.template.AppTemplateService;
42  import fr.paris.lutece.util.html.HtmlTemplate;
43  
44  import java.util.Collection;
45  import java.util.HashMap;
46  import java.util.Locale;
47  import java.util.Map;
48  
49  /**
50   *
51   * Generates Html files used as template to construct front office
52   *
53   */
54  public class XPageTemplateGenerator extends AbstractGenerator
55  {
56      private static final String PATH = "webapp/WEB-INF/templates/skin/plugins/{plugin_name}/";
57      private static String [ ] _template_prefix = {
58              "create_", "modify_", "manage_"
59      };
60      private String _strTabsTemplate;
61  
62      /**
63       * {@inheritDoc }
64       * 
65       * @param pm
66       */
67      @Override
68      public Map generate( PluginModel pm, String generationSchemeName )
69      {
70          HashMap map = new HashMap( );
71          String strPluginName = pm.getPluginNameAsPackage( );
72  
73          // for each application,which business classes are attached to
74          Collection<Application> listApplication = pm.getApplications( );
75  
76          for ( Application application : listApplication )
77          {
78              Collection<BusinessClass> listBusinessClasses = ModelService.getBusinessClassesByApplication( pm, application.getId( ) );
79  
80              if ( listBusinessClasses.isEmpty( ) )
81              {
82                  String strPath = getFilePath( pm, PATH, application.getApplicationName( ) + ".html" );
83                  String strSourceCode = getCreateHtmlCode( application, strPluginName );
84                  map.put( strPath, strSourceCode );
85              }
86              else
87              {
88                  for ( BusinessClass businessClass : listBusinessClasses )
89                  {
90                      for ( int i = 0; i < _template_prefix.length; i++ )
91                      {
92                      	String strSuffix = ".html";
93                          String strPath ="";
94   
95                          //manage files case where plural business name is used 
96                          if( i == 2 )
97                          {
98                              strPath = getFilePath( pm, PATH, _template_prefix [i] + businessClass.getPluralBusinessClass( ).toLowerCase( ) + strSuffix );
99                          }
100                         else
101                         {
102                             strPath = getFilePath( pm, PATH, _template_prefix [i] + businessClass.getBusinessClass( ).toLowerCase( ) + strSuffix );
103                         }
104                     	
105                         String strSourceCode = getCreateHtmlCode( listBusinessClasses, application, businessClass, i, strPluginName );
106                         map.put( strPath, strSourceCode );
107                     }
108                 }
109 
110                 // Add the main template where all the business management interface will be accessible
111                 String strPath = getFilePath( pm, PATH, application.getApplicationName( ).toLowerCase( ) + "_tabs.html" );
112 
113                 String strSourceCode = getTabsHtmlCode( listBusinessClasses, strPluginName, application );
114                 map.put( strPath, strSourceCode );
115             }
116         }
117 
118         return map;
119     }
120 
121     /**
122      * Gets the code of a create template for a specific business object
123      *
124      * @param listAllBusinessClasses
125      *            A list of business classes attached to plugin
126      * @param businessClass
127      *            The instance of the business class
128      * @param nTemplateType
129      *            The type of template
130      * @param application
131      *            The application
132      * @param strPluginName
133      *            The plugin name
134      * @return The html code of the create template
135      */
136     private String getCreateHtmlCode( Collection<BusinessClass> listAllBusinessClasses, Application application, BusinessClass businessClass, int nTemplateType,
137             String strPluginName )
138     {
139         Map<String, Object> model = new HashMap<>( );
140 
141         model.put( Markers.MARK_PLUGIN_NAME, strPluginName );
142         model.put( Markers.MARK_I18N_BRACKETS_OPEN, "@@i18n{" );
143         model.put( Markers.MARK_I18N_BRACKETS_CLOSE, "}" );
144         model.put( Markers.MARK_MACRO, "@" );
145         model.put( Markers.MARK_VARIABLE, "@@" );
146         model.put( Markers.MARK_BRACKETS_OPEN, "${" );
147         model.put( Markers.MARK_BRACKETS_CLOSE, "}" );
148         model.put( Markers.MARK_BUSINESS_CLASS, businessClass );
149         model.put( Markers.MARK_LIST_BUSINESS_CLASSES, listAllBusinessClasses );
150         model.put( Markers.MARK_APPLICATION, application );
151         model.put( Markers.MARK_INCLUDE, "@@include" );
152 
153         model.put( Markers.MARK_TEMPLATE_TYPE, nTemplateType );
154 
155         HtmlTemplate template = AppTemplateService.getTemplate( getTemplate( ), Locale.getDefault( ), model );
156 
157         return template.getHtml( ).replace( "@@", "#" );
158     }
159 
160     /**
161      * Gets the code of a tab template for a specific business object
162      *
163      * @param listAllBusinessClasses
164      *            A list of business classes attached to plugin
165      * @param strPluginName
166      *            The plugin name
167      * @param application
168      *            The application
169      * @return The html code of the tab template
170      */
171     private String getTabsHtmlCode( Collection<BusinessClass> listAllBusinessClasses, String strPluginName, Application application )
172     {
173         Map<String, Object> model = new HashMap<>( );
174 
175         model.put( Markers.MARK_PLUGIN_NAME, strPluginName );
176         model.put( Markers.MARK_APPLICATION, application );
177         model.put( Markers.MARK_I18N_BRACKETS_OPEN, "@@i18n{" );
178         model.put( Markers.MARK_I18N_BRACKETS_CLOSE, "}" );
179         model.put( Markers.MARK_MACRO, "@" );
180         model.put( Markers.MARK_VARIABLE, "@@" );
181         model.put( Markers.MARK_BRACKETS_OPEN, "${" );
182         model.put( Markers.MARK_BRACKETS_CLOSE, "}" );
183         model.put( Markers.MARK_MACRO_DEF, "@@macro" );
184         model.put( Markers.MARK_LIST_BUSINESS_CLASSES, listAllBusinessClasses );
185 
186         HtmlTemplate template = AppTemplateService.getTemplate( _strTabsTemplate, Locale.getDefault( ), model );
187 
188         return template.getHtml( ).replace( "@@", "#" );
189     }
190 
191     /**
192      * Gets the code of a create template for a specific business object
193      *
194      * @param application
195      *            The application
196      * @param strPluginName
197      *            The plugin name
198      * @return The html code of the create template
199      */
200     private String getCreateHtmlCode( Application application, String strPluginName )
201     {
202         Map<String, Object> model = new HashMap<>( );
203 
204         model.put( Markers.MARK_PLUGIN_NAME, strPluginName );
205         model.put( Markers.MARK_I18N_BRACKETS_OPEN, "@@i18n{" );
206         model.put( Markers.MARK_I18N_BRACKETS_CLOSE, "}" );
207         model.put( Markers.MARK_MACRO, "@" );
208         model.put( Markers.MARK_VARIABLE, "@@" );
209         model.put( Markers.MARK_BRACKETS_OPEN, "${" );
210         model.put( Markers.MARK_BRACKETS_CLOSE, "}" );
211         model.put( Markers.MARK_APPLICATION, application );
212         model.put( Markers.MARK_INCLUDE, "@@include" );
213 
214         HtmlTemplate template = AppTemplateService.getTemplate( getTemplate( ), Locale.getDefault( ), model );
215 
216         return template.getHtml( ).replace( "@@", "#" );
217     }
218 
219     /**
220      * @param tabsTemplate
221      *            the tabsTemplate to set
222      */
223     public void setTabsTemplate( String tabsTemplate )
224     {
225         _strTabsTemplate = tabsTemplate;
226     }
227 }