EncodingService.java

/*
 * Copyright (c) 2002-2022, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.portal.service.html;

import fr.paris.lutece.portal.service.util.AppLogService;
import fr.paris.lutece.portal.service.util.AppPropertiesService;

import java.io.UnsupportedEncodingException;

import java.net.URLEncoder;

/**
 * Encoding utils
 */
public final class EncodingService
{
    /**
     * <b>lutece.encoding.url</b>
     */
    private static final String PROPERTY_URL_ENCODING = "lutece.encoding.url";

    /**
     * Default encoding (UTF-8)
     */
    private static final String DEFAULT_URI_ENCODING = "UTF-8";

    /** Creates a new instance of EncodingService */
    private EncodingService( )
    {
    }

    /**
     * Encode an url string. Uses {@link #PROPERTY_URL_ENCODING} property and {@link #DEFAULT_URI_ENCODING} as default if {@link #PROPERTY_URL_ENCODING} not
     * found.
     * 
     * @param strSource
     *            The string to encode
     * @return The encoded string
     */
    public static String encodeUrl( String strSource )
    {
        return encodeUrl( strSource, PROPERTY_URL_ENCODING, DEFAULT_URI_ENCODING );
    }

    /**
     * Encode an url string. Uses {@link #DEFAULT_URI_ENCODING} as default.
     * 
     * @param strSource
     *            The string to encode
     * @param strProperty
     *            The property used used for the encoding. (ex : lutece.encoding.url )
     * @return The encoded string
     */
    public static String encodeUrl( String strSource, String strProperty )
    {
        return encodeUrl( strSource, strProperty, DEFAULT_URI_ENCODING );
    }

    /**
     * Encode an url string
     * 
     * @param strSource
     *            The string to encode
     * @param strProperty
     *            The property used used for the encoding. (ex : lutece.encoding.url )
     * @param strDefaultEncoding
     *            default encoding if <code>strProperty</code> cannot be found.
     * @return The encoded string
     */
    public static String encodeUrl( String strSource, String strProperty, String strDefaultEncoding )
    {
        String strEncoded = "";
        String strEncoding = AppPropertiesService.getProperty( strProperty, strDefaultEncoding );

        try
        {
            strEncoded = URLEncoder.encode( strSource, strEncoding );
        }
        catch( UnsupportedEncodingException e )
        {
            AppLogService.error( e.getMessage( ), e );
        }

        return strEncoded;
    }

    /**
     * Returns the current encoding
     * 
     * @return The current encoding
     */
    public static String getEncoding( )
    {
        return AppPropertiesService.getProperty( PROPERTY_URL_ENCODING );
    }
}