CaptchaSecurityService.java

  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.captcha;

  35. import fr.paris.lutece.portal.service.spring.SpringContextService;

  36. import org.springframework.beans.factory.BeanDefinitionStoreException;
  37. import org.springframework.beans.factory.CannotLoadBeanClassException;
  38. import org.springframework.beans.factory.NoSuchBeanDefinitionException;

  39. import javax.servlet.http.HttpServletRequest;

  40. /**
  41.  * Default captcha security service implementation
  42.  */
  43. public class CaptchaSecurityService implements ICaptchaSecurityService
  44. {
  45.     private boolean _bActive = true;
  46.     private boolean _bAvailable;
  47.     private ICaptchaService _captchaService;

  48.     /**
  49.      * Default constructor.
  50.      *
  51.      * Gets the captchaValidator from the captcha plugin. If the validator is missing, sets available to false;
  52.      */
  53.     public CaptchaSecurityService( )
  54.     {
  55.         try
  56.         {
  57.             // first check if captchaValidator bean is available in the jcaptcha plugin context
  58.             _captchaService = SpringContextService.getBean( "captcha.captchaService" );
  59.             _bAvailable = _captchaService != null;
  60.         }
  61.         catch( CannotLoadBeanClassException | NoSuchBeanDefinitionException | BeanDefinitionStoreException e )
  62.         {
  63.             _bAvailable = false;
  64.         }
  65.     }

  66.     /**
  67.      * {@inheritDoc}
  68.      */
  69.     @Override
  70.     public String getActiveBlockHtml( )
  71.     {
  72.         return null;
  73.     }

  74.     /**
  75.      * {@inheritDoc}
  76.      */
  77.     @Override
  78.     public String getHtmlCode( )
  79.     {
  80.         if ( isAvailable( ) && isActive( ) )
  81.         {
  82.             return _captchaService.getHtmlCode( );
  83.         }
  84.         else
  85.         {
  86.             return EMPTY_STRING;
  87.         }
  88.     }

  89.     /**
  90.      * {@inheritDoc}
  91.      */
  92.     @Override
  93.     public void setActive( boolean isActive )
  94.     {
  95.         _bActive = isActive;
  96.     }

  97.     /**
  98.      * {@inheritDoc}
  99.      */
  100.     @Override
  101.     public boolean validate( HttpServletRequest request )
  102.     {
  103.         if ( isAvailable( ) && isActive( ) )
  104.         {
  105.             return _captchaService.validate( request );
  106.         }
  107.         else
  108.         {
  109.             return true;
  110.         }
  111.     }

  112.     /**
  113.      * {@inheritDoc}
  114.      */
  115.     @Override
  116.     public boolean isActive( )
  117.     {
  118.         return _bActive;
  119.     }

  120.     /**
  121.      * {@inheritDoc}
  122.      */
  123.     @Override
  124.     public boolean isAvailable( )
  125.     {
  126.         return _bAvailable;
  127.     }
  128. }