FeedbackCaptchaService.java

/*
 * Copyright (c) 2002-2014, Mairie de 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.plugins.extend.modules.feedback.service;

import fr.paris.lutece.plugins.extend.modules.feedback.business.config.FeedbackExtenderConfig;
import fr.paris.lutece.plugins.extend.modules.feedback.util.constants.FeedbackConstants;
import fr.paris.lutece.portal.service.captcha.CaptchaSecurityService;
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.plugin.PluginService;
import fr.paris.lutece.portal.service.util.AppPropertiesService;

import java.util.Map;

import javax.servlet.http.HttpServletRequest;



/**
 *
 * FeedbackCaptchaService
 *
 */
public class FeedbackCaptchaService implements IFeedbackCaptchaService
{
    /** The Constant BEAN_SERVICE. */
    public static final String BEAN_SERVICE = "extend-feedback.feedbackCaptchaService";

    /**
     * {@inheritDoc}
     */
    @Override
    public void fillModel( Map<String, Object> model, FeedbackExtenderConfig config )
    {
        // Add Captcha
        model.put( FeedbackConstants.MARK_IS_ACTIVE_CAPTCHA, isCaptchaEnabled(  ) && config.isCaptcha( ) );

        if ( isCaptchaEnabled(  ) && config.isCaptcha( ) )
        {
            CaptchaSecurityService captchaService = new CaptchaSecurityService(  );
            model.put( FeedbackConstants.MARK_CAPTCHA, captchaService.getHtmlCode(  ) );
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void validateCaptcha( HttpServletRequest request )
        throws SiteMessageException
    {    	
        // Test the captcha
        if ( isCaptchaEnabled(  ) && Boolean.parseBoolean( request.getParameter( FeedbackConstants.PARAMETER_CAPTCHA_ENABLED ) ) )
        {
            CaptchaSecurityService captchaService = new CaptchaSecurityService(  );

            if ( !captchaService.validate( request ) )
            {
                SiteMessageService.setMessage( request, FeedbackConstants.MESSAGE_ERROR_BAD_JCAPTCHA,
                    SiteMessage.TYPE_STOP );
            }
        }
    }

    /**
     * Checks if is captcha enabled.
     *
     * @return true, if is captcha enabled
     */
    private static boolean isCaptchaEnabled(  )
    {
        return PluginService.isPluginEnable( FeedbackConstants.JCAPTCHA_PLUGIN ) &&
        Boolean.parseBoolean( AppPropertiesService.getProperty( FeedbackConstants.PROPERTY_USE_CAPTCHA,
                Boolean.TRUE.toString(  ) ) );
    }
}