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.BusinessClass;
37  import fr.paris.lutece.plugins.pluginwizard.business.model.Feature;
38  import fr.paris.lutece.plugins.pluginwizard.business.model.PluginModel;
39  import fr.paris.lutece.plugins.pluginwizard.service.ModelService;
40  
41  import java.util.ArrayList;
42  import java.util.Collections;
43  import java.util.HashMap;
44  import java.util.List;
45  import java.util.Map;
46  
47  /**
48   *
49   * Class produces the xml file describing the generated plugin
50   *
51   */
52  public class PluginXmlGenerator extends AbstractFileGenerator
53  {
54      private static final String PATH = "webapp/WEB-INF/plugins/";
55      private static final String EXT = ".xml";
56  
57      /**
58       * {@inheritDoc }
59       */
60      @Override
61      public Map generate( PluginModel pm, String generationSchemeName )
62      {
63          return generateFile( pm, generationSchemeName );
64      }
65  
66      /**
67       * {@inheritDoc }
68       */
69      @Override
70      protected String getCode( PluginModel pm, String generationSchemeName )
71      {
72          Map<String, Object> model = new HashMap<>( );
73  
74          setJspName( pm );
75          model.put( Markers.MARK_PLUGIN, pm );
76  
77          return build( model );
78      }
79  
80      public static void setJspName( PluginModel pm )
81      {
82          for ( Feature feature : pm.getFeatures( ) )
83          {
84              List<BusinessClass> listBusiness = ModelService.getBusinessClassesByFeature( pm, feature.getId( ) );
85  
86              if ( ( listBusiness != null ) && ( listBusiness.size( ) > 0 ) )
87              {
88                  List<String> BusinessNames = new ArrayList<>( );
89                  int i = 0;
90                  int id = 0;
91  
92                  for ( BusinessClass bc : listBusiness )
93                  {
94                      BusinessNames.add( bc.getBusinessClass( ) );
95                  }
96  
97                  Collections.sort( BusinessNames );
98  
99                  for ( BusinessClass bc : listBusiness )
100                 {
101                     if ( bc.getBusinessClass( ).equals( BusinessNames.get( 0 ) ) )
102                     {
103                         id = i;
104                     }
105 
106                     i++;
107                 }
108 
109                 BusinessClass businessClass = listBusiness.get( id );
110                 feature.setJspName( "Manage" + businessClass.getPluralBusinessClassCapsFirst( ) + ".jsp" );
111             }
112             else
113             {
114                 feature.setJspName( feature.getFeatureName( ) + ".jsp" );
115             }
116         }
117     }
118 
119     /**
120      * {@inheritDoc }
121      */
122     @Override
123     protected String getFilename( PluginModel pm )
124     {
125         if( pm.isWorkflowTask( ) )
126         {
127         	return "workflow-" + pm.getPluginNameForRessource( ) + EXT;
128         }
129         
130         return pm.getPluginNameForRessource( ) + EXT;
131     }
132 
133     /**
134      * {@inheritDoc }
135      */
136     @Override
137     public String getPath( )
138     {
139         return PATH;
140     }
141 }