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