SafeRequestFilterSite.java

/*
 * Copyright (c) 2002-2025, 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.web.xss;

import fr.paris.lutece.portal.service.message.SiteMessage;
import fr.paris.lutece.portal.service.message.SiteMessageException;
import fr.paris.lutece.portal.service.message.SiteMessageService;
import fr.paris.lutece.portal.service.util.AppPathService;
import fr.paris.lutece.portal.service.util.AppPropertiesService;

import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;

/**
 * This class extends SafeRequestFilter and use SiteMessageService for display error Message
 * 
 * @author merlinfe
 *
 */
public class SafeRequestFilterSite extends SafeRequestFilter
{

    private static final String PROPERTY_ACTIVATE_XSS_FILTER = "lutece.safe.request.site.activateXssFilter";
    private static final String PROPERTY_SANITIZE_FILTER_MODE = "lutece.safe.request.site.sanitizeFilterMode";
    private static final String PROPERTY_XSS_CHARACTERS = "lutece.safe.request.site.xssCharacters";

    /**
     * {@inheritDoc}
     */
    @Override
    public void init( FilterConfig config ) throws ServletException
    {
        String xssFilter = AppPropertiesService.getProperty( PROPERTY_ACTIVATE_XSS_FILTER );
        String sanitizeFilterMode = AppPropertiesService.getProperty( PROPERTY_SANITIZE_FILTER_MODE );
        String xssCharacters = AppPropertiesService.getProperty( PROPERTY_XSS_CHARACTERS );

        if( xssFilter == null && sanitizeFilterMode==null && xssCharacters==null )
        {
            initFromFilterConfig( config );
        }
        else
        {
            initFilter( Boolean.parseBoolean(xssFilter), Boolean.parseBoolean(sanitizeFilterMode), xssCharacters );
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getMessageUrl( HttpServletRequest request, String strMessageKey, Object [ ] messageArgs, String strTitleKey )
    {
        try
        {
            SiteMessageService.setMessage( request, strMessageKey, messageArgs, strTitleKey, null, "", SiteMessage.TYPE_STOP );
        }
        catch( SiteMessageException lme )
        {
            return AppPathService.getSiteMessageUrl( request );
        }

        return null;
    }
}