View Javadoc
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.plugins.captcha.modules.jcaptcha.service;
35  
36  import javax.servlet.http.HttpServletRequest;
37  
38  import org.apache.commons.lang.StringUtils;
39  
40  import com.octo.captcha.service.CaptchaServiceException;
41  import com.octo.captcha.service.image.ImageCaptchaService;
42  import com.octo.captcha.service.sound.SoundCaptchaService;
43  
44  import fr.paris.lutece.plugins.captcha.service.ICaptchaEngine;
45  import fr.paris.lutece.portal.service.spring.SpringContextService;
46  import fr.paris.lutece.portal.service.template.AppTemplateService;
47  import fr.paris.lutece.portal.service.util.AppLogService;
48  import fr.paris.lutece.portal.service.util.AppPropertiesService;
49  import fr.paris.lutece.util.html.HtmlTemplate;
50  
51  
52  /**
53   *
54   */
55  public class JCaptchaEngineService implements ICaptchaEngine
56  {
57      private static final String CAPTCHA_PROVIDER = "JCaptcha";
58      private static final String TEMPLATE_JCAPTCHA = "jcaptcha.template.captchaTemplate";
59      private static final String LOGGER = "lutece.captcha";
60      private static final String PARAMETER_HONEY_POT = "jcaptchahoneypot";
61      private static final String PARAMETER_J_CAPTCHA_RESPONSE = "j_captcha_response";
62      private static final String BEAN_NAME_JCAPTCHA_IMAGE_SERVICE = "jcaptcha.imageCaptchaService";
63      private static final String BEAN_NAME_JCAPTCHA_SOUND_SERVICE = "jcaptcha.soundCaptchaService";
64  
65      /**
66       * {@inheritDoc}
67       */
68      @Override
69      public boolean validate( HttpServletRequest request )
70      {
71          AppLogService.debug( LOGGER, "Validate captcha response for id : " + request.getSession( ).getId( ) );
72  
73          // We use a honey pot : this parameter has an empty value and is hidden, thus it can not be modified by humans 
74          String strHoneyPot = request.getParameter( PARAMETER_HONEY_POT );
75          String captchaReponse = request.getParameter( PARAMETER_J_CAPTCHA_RESPONSE );
76          if ( StringUtils.isNotBlank( strHoneyPot ) || captchaReponse == null )
77          {
78              return false;
79          }
80  
81          captchaReponse = captchaReponse.toLowerCase( );
82          ImageCaptchaService imageCaptcha = (ImageCaptchaService) SpringContextService
83                  .getBean( BEAN_NAME_JCAPTCHA_IMAGE_SERVICE );
84          SoundCaptchaService soundCaptcha = (SoundCaptchaService) SpringContextService
85                  .getBean( BEAN_NAME_JCAPTCHA_SOUND_SERVICE );
86          boolean validImage = false;
87          boolean validSound = false;
88          String sessionId = request.getSession( ).getId( );
89  
90          try
91          {
92              validImage = imageCaptcha.validateResponseForID( sessionId, captchaReponse );
93              validSound = soundCaptcha.validateResponseForID( sessionId, captchaReponse );
94          }
95          catch ( CaptchaServiceException e )
96          {
97              AppLogService.debug( LOGGER, e );
98          }
99  
100         if ( validImage || validSound )
101         {
102             AppLogService.debug( LOGGER, "Valid response" );
103 
104             return true;
105         }
106         AppLogService.debug( LOGGER, "Unvalid response" );
107         return false;
108     }
109 
110     /**
111      * {@inheritDoc}
112      */
113     @Override
114     public String getHtmlCode( )
115     {
116         String strCaptchaTemplate = AppPropertiesService.getProperty( TEMPLATE_JCAPTCHA );
117 
118         HtmlTemplate captchaTemplate = AppTemplateService.getTemplate( strCaptchaTemplate );
119 
120         return captchaTemplate.getHtml( );
121     }
122 
123     /**
124      * {@inheritDoc}
125      */
126     @Override
127     public String getCaptchaEngineName( )
128     {
129         return CAPTCHA_PROVIDER;
130     }
131 }