View Javadoc
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  /**
35   *
36   */
37  package fr.paris.lutece.plugins.genericattributes.service.entrytype;
38  
39  import java.util.List;
40  import java.util.Locale;
41  import java.util.Objects;
42  import java.util.Optional;
43  
44  import javax.servlet.http.HttpServletRequest;
45  
46  import org.apache.commons.lang3.StringUtils;
47  
48  
49  import fr.paris.lutece.plugins.genericattributes.business.CartoProviderManager;
50  import fr.paris.lutece.plugins.genericattributes.business.Entry;
51  import fr.paris.lutece.plugins.genericattributes.business.Field;
52  import fr.paris.lutece.plugins.genericattributes.business.FieldHome;
53  import fr.paris.lutece.plugins.genericattributes.business.GenericAttributeError;
54  import fr.paris.lutece.plugins.genericattributes.business.ICartoProvider;
55  import fr.paris.lutece.plugins.genericattributes.business.Response;
56  import fr.paris.lutece.plugins.genericattributes.util.GenericAttributesUtils;
57  import fr.paris.lutece.portal.service.i18n.I18nService;
58  import fr.paris.lutece.portal.service.message.AdminMessage;
59  import fr.paris.lutece.portal.service.message.AdminMessageService;
60  import fr.paris.lutece.portal.service.util.AppPropertiesService;
61  import fr.paris.lutece.util.ReferenceList;
62  
63  /**
64   * @author bass
65   *
66   */
67  public abstract class AbstractEntryTypeCartography extends EntryTypeService
68  {
69      public static final String PARAMETER_ID_ENTRY = "id_entry";
70      public static final String PARAMETER_ID_RESOURCE = "id_resource";
71  
72      /** The Constant PARAMETER_MAP_PROVIDER. */
73      public static final String PARAMETER_MAP_PROVIDER = "map_provider";
74  
75      /** The Constant PARAMETER_EDIT_MODE. */
76      public static final String PARAMETER_EDIT_MODE = "edit_mode";
77  
78      /** The Constant PARAMETER_VIEW_NUMBER. */
79      public static final String PARAMETER_VIEW_NUMBER = "view_number";
80  
81      /** The Constant PARAMETER_SUFFIX_ID_ADDRESS. */
82      public static final String PARAMETER_SUFFIX_ID_ADDRESS = "_idAddress";
83  
84      /** The Constant PARAMETER_SUFFIX_ADDRESS. */
85      public static final String PARAMETER_SUFFIX_ADDRESS = "_address";
86  
87      /** The Constant PARAMETER_SUFFIX_ADDITIONAL_ADDRESS. */
88      public static final String PARAMETER_SUFFIX_ADDITIONAL_ADDRESS = "_additional_address";
89  
90      /** The Constant PARAMETER_SUFFIX_X_ADDRESS. */
91      public static final String PARAMETER_SUFFIX_X = "_x";
92  
93      /** The Constant PARAMETER_SUFFIX_Y_ADDRESS. */
94      public static final String PARAMETER_SUFFIX_Y = "_y";
95  
96      /** The Constant PARAMETER_SUFFIX_GEOMETRY. */
97      public static final String PARAMETER_SUFFIX_GEOMETRY = "_geometry";
98      
99      public static final String PARAMETER_SUFFIX_GEOJSON = "_geojson";
100     
101     public static final String PARAMETER_SUFFIX_ID_LAYER = "_idlayer";
102     
103     public static final String PARAMETER_COORDINATE_X = "coordinate_x";
104     public static final String PARAMETER_COORDINATE_Y = "coordinate_y";
105     public static final String PARAMETER_COORDINATE_POLYGON = "coordinate_polygon";
106     public static final String PARAMETER_COORDINATE_POLYLINE = "coordinate_polyline";
107     public static final String PARAMETER_DATALAYER = "iddatalayer";
108 
109     private static final String MESSAGE_SPECIFY_BOTH_X_AND_Y = "genericattributes.message.specifyBothXAndY";
110     public static final String PARAMETER_EDIT_MODE_LIST = "gismap.edit.mode.list";
111     
112     public static final String PROPERTY_ENTRY_TYPE_CARTOGRAPHY_EXPORT_WITH_FIELD_NAME = "genericattributes.entrytype.cartography.export.field.name";
113 
114     /**
115      * {@inheritDoc}
116      */
117     @Override
118     public String getRequestData( Entry entry, HttpServletRequest request, Locale locale )
119     {
120         initCommonRequestData( entry, request );
121         String strTitle = request.getParameter( PARAMETER_TITLE );
122         String strCode = request.getParameter( PARAMETER_ENTRY_CODE );
123         String strHelpMessage = ( request.getParameter( PARAMETER_HELP_MESSAGE ) != null ) ? request.getParameter( PARAMETER_HELP_MESSAGE ).trim( ) : null;
124         String strComment = request.getParameter( PARAMETER_COMMENT );
125         String strMandatory = request.getParameter( PARAMETER_MANDATORY );
126         String strMapProvider = request.getParameter( PARAMETER_MAP_PROVIDER );
127         String strEditMode = request.getParameter( PARAMETER_EDIT_MODE );
128         String strViewNumber = request.getParameter( PARAMETER_VIEW_NUMBER );
129         String strCSSClass = request.getParameter( PARAMETER_CSS_CLASS );
130         String strIndexed = request.getParameter( PARAMETER_INDEXED );
131         String strFieldError = StringUtils.EMPTY;
132 
133         if ( StringUtils.isBlank( strTitle ) )
134         {
135             strFieldError = ERROR_FIELD_TITLE;
136         }
137 
138         if ( StringUtils.isNotBlank( strFieldError ) )
139         {
140             Object [ ] tabRequiredFields = {
141                     I18nService.getLocalizedString( strFieldError, locale )
142             };
143 
144             return AdminMessageService.getMessageUrl( request, MESSAGE_MANDATORY_FIELD, tabRequiredFields, AdminMessage.TYPE_STOP );
145         }
146 
147         /**
148          * we need 10 fields : 1 for map provider, 1 for id address, 1 for label address, 1 for x address, 1 for y address, 1 for id geographical object, 1 for
149          * description geographical object, 1 for centroid geographical object, 1 for label geographical object and 1 for thematic geographical object
150          **/
151         //createOrUpdateProviderField( entry, strMapProvider );
152         GenericAttributesUtils.createOrUpdateField( entry, FIELD_PROVIDER, null, strMapProvider );
153         GenericAttributesUtils.createOrUpdateField( entry, FIELD_EDIT_MODE, null, strEditMode );
154         GenericAttributesUtils.createOrUpdateField( entry, FIELD_VIEW_NUMBER, null, strViewNumber );
155         GenericAttributesUtils.createOrUpdateField( entry, FIELD_GEOMETRY, null, FIELD_GEOMETRY );
156         GenericAttributesUtils.createOrUpdateField( entry, FIELD_GEOJSON, null, FIELD_GEOJSON );
157         GenericAttributesUtils.createOrUpdateField( entry, FIELD_ID_LAYER, null, FIELD_ID_LAYER );
158 
159         entry.setTitle( strTitle );
160         entry.setHelpMessage( strHelpMessage );
161         entry.setComment( strComment );
162         entry.setCSSClass( strCSSClass );
163         entry.setIndexed( strIndexed != null );
164         entry.setMandatory( strMandatory != null );
165         entry.setCode( strCode );
166         return null;
167     }
168 
169     /**
170      * {@inheritDoc}
171      */
172     @Override
173     public GenericAttributeError getResponseData( Entry entry, HttpServletRequest request, List<Response> listResponse, Locale locale )
174     {
175         
176         String strCoordinateX = request.getParameter( PARAMETER_COORDINATE_X );
177         String strCoordinateY = request.getParameter( PARAMETER_COORDINATE_Y );
178         String strCoordinatePolygon = request.getParameter( PARAMETER_COORDINATE_POLYGON );
179         String strCoordinatePolyline = request.getParameter( PARAMETER_COORDINATE_POLYLINE );
180         String strIdLayer = request.getParameter( PARAMETER_DATALAYER );
181         
182         List<ICartoProvider> lstcartoprovider = CartoProviderManager.getMapProvidersList();
183         String strGeoJson = "";
184         
185         //if ( !lstcartoprovider.isEmpty( )  )
186         //{
187 	        ICartoProvider cartoService = lstcartoprovider.get(0);
188 	        
189 	        if ( strCoordinateX != null && !strCoordinateX.isEmpty( ) && strCoordinateY != null && !strCoordinateY.isEmpty( ) )
190 	        {
191 	        	strGeoJson = cartoService.getGeolocItemPoint(Double.valueOf( strCoordinateX ), Double.valueOf( strCoordinateY ), "");
192 	        }
193 	        else if ( strCoordinatePolygon != null && !strCoordinatePolygon.isEmpty( ) )
194 	        {
195 	        	strGeoJson = cartoService.getGeolocItemPolygon( strCoordinatePolygon );
196 	        }
197 	        else if ( strCoordinatePolyline != null && !strCoordinatePolyline.isEmpty( ) )
198 	        {
199 	        	strGeoJson = cartoService.getGeolocItemPolyline( strCoordinatePolyline );
200 	        }
201         //}
202 
203         Field fieldIdAddress = entry.getFieldByCode( FIELD_ID_ADDRESS );
204         Field fieldGeoJson = entry.getFieldByCode( FIELD_GEOJSON );
205         Field fieldIdLayer = entry.getFieldByCode( FIELD_ID_LAYER );
206 
207         /**
208          * Create the field "idAddress" in case the field does not exist in the database.
209          */
210         if ( fieldIdAddress == null )
211         {
212             fieldIdAddress = GenericAttributesUtils.createOrUpdateField( entry, FIELD_ID_ADDRESS, null, FIELD_ID_ADDRESS );
213             FieldHome.create( fieldIdAddress );
214         }
215         
216         // 1 : Response Desc GeoJson
217         Responsecattributes/business/Response.html#Response">Response responseGeoJSON = new Response( );
218         responseGeoJSON.setEntry( entry );
219         responseGeoJSON.setResponseValue( strGeoJson );
220         responseGeoJSON.setField( fieldGeoJson );
221         responseGeoJSON.setToStringValueResponse( strGeoJson );
222         responseGeoJSON.setIterationNumber( getResponseIterationValue( request ) );
223         listResponse.add( responseGeoJSON );
224         
225         // 2 : Response Desc IDLayer
226         String solrTag = cartoService.getSolrTag( strIdLayer );
227         if ( !solrTag.isEmpty( ) )
228         {
229         Responsecattributes/business/Response.html#Response">Response responseIdLayer = new Response( );
230         responseIdLayer.setEntry( entry );
231         responseIdLayer.setResponseValue( solrTag );
232         responseIdLayer.setField( fieldIdLayer );
233         responseIdLayer.setToStringValueResponse( strIdLayer );
234         responseIdLayer.setIterationNumber( getResponseIterationValue( request ) );
235         listResponse.add( responseIdLayer );
236         }
237 
238         return super.getResponseData( entry, request, listResponse, locale );
239     }
240 
241     /**
242      * {@inheritDoc}
243      */
244     @Override
245     public String getResponseValueForRecap( Entry entry, HttpServletRequest request, Response response, Locale locale )
246     {
247         if ( response.getField( ) != null )
248         {
249             String strCode = response.getField( ).getCode( );
250 
251             if ( FIELD_ADDRESS.equals( strCode ) )
252             {
253                 return response.getResponseValue( );
254             }
255         }
256 
257         return StringUtils.EMPTY;
258     }
259 
260     /**
261      * Builds the {@link ReferenceList} of all available map providers
262      * 
263      * @return the {@link ReferenceList}
264      */
265     public ReferenceList getMapProvidersRefList( )
266     {
267     	List<ICartoProvider> lstcartoprovider = CartoProviderManager.getMapProvidersList();
268     	if ( !lstcartoprovider.isEmpty( ) )
269     	{
270     		return lstcartoprovider.get(0).getMapProvidersRefList( );
271     	}
272     	else
273     	{
274     		return new ReferenceList( );
275     	}
276     }
277 
278     /**
279      *
280      * {@inheritDoc}
281      */
282     @Override
283     public String getResponseValueForExport( Entry entry, HttpServletRequest request, Response response, Locale locale )
284     {
285         String result = StringUtils.EMPTY;
286 
287         boolean isExportWithFieldName = AppPropertiesService.getPropertyBoolean( PROPERTY_ENTRY_TYPE_CARTOGRAPHY_EXPORT_WITH_FIELD_NAME, true );
288 
289         if ( isExportWithFieldName && response.getField( ) != null )
290         {
291             result = Objects.toString( response.getField( ).getCode( ) ) +  GenericAttributesUtils.CONSTANT_EQUAL;
292         }
293         result += response.getResponseValue( );
294         return result;
295     }
296 
297 }