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.portal.service.html;
35
36 import fr.paris.lutece.portal.service.util.AppLogService;
37 import fr.paris.lutece.portal.service.util.AppPropertiesService;
38
39 import java.io.UnsupportedEncodingException;
40
41 import java.net.URLEncoder;
42
43 /**
44 * Encoding utils
45 */
46 public final class EncodingService
47 {
48 /**
49 * <b>lutece.encoding.url</b>
50 */
51 private static final String PROPERTY_URL_ENCODING = "lutece.encoding.url";
52
53 /**
54 * Default encoding (UTF-8)
55 */
56 private static final String DEFAULT_URI_ENCODING = "UTF-8";
57
58 /** Creates a new instance of EncodingService */
59 private EncodingService( )
60 {
61 }
62
63 /**
64 * Encode an url string. Uses {@link #PROPERTY_URL_ENCODING} property and {@link #DEFAULT_URI_ENCODING} as default if {@link #PROPERTY_URL_ENCODING} not
65 * found.
66 *
67 * @param strSource
68 * The string to encode
69 * @return The encoded string
70 */
71 public static String encodeUrl( String strSource )
72 {
73 return encodeUrl( strSource, PROPERTY_URL_ENCODING, DEFAULT_URI_ENCODING );
74 }
75
76 /**
77 * Encode an url string. Uses {@link #DEFAULT_URI_ENCODING} as default.
78 *
79 * @param strSource
80 * The string to encode
81 * @param strProperty
82 * The property used used for the encoding. (ex : lutece.encoding.url )
83 * @return The encoded string
84 */
85 public static String encodeUrl( String strSource, String strProperty )
86 {
87 return encodeUrl( strSource, strProperty, DEFAULT_URI_ENCODING );
88 }
89
90 /**
91 * Encode an url string
92 *
93 * @param strSource
94 * The string to encode
95 * @param strProperty
96 * The property used used for the encoding. (ex : lutece.encoding.url )
97 * @param strDefaultEncoding
98 * default encoding if <code>strProperty</code> cannot be found.
99 * @return The encoded string
100 */
101 public static String encodeUrl( String strSource, String strProperty, String strDefaultEncoding )
102 {
103 String strEncoded = "";
104 String strEncoding = AppPropertiesService.getProperty( strProperty, strDefaultEncoding );
105
106 try
107 {
108 strEncoded = URLEncoder.encode( strSource, strEncoding );
109 }
110 catch( UnsupportedEncodingException e )
111 {
112 AppLogService.error( e.getMessage( ), e );
113 }
114
115 return strEncoded;
116 }
117
118 /**
119 * Returns the current encoding
120 *
121 * @return The current encoding
122 */
123 public static String getEncoding( )
124 {
125 return AppPropertiesService.getProperty( PROPERTY_URL_ENCODING );
126 }
127 }