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.image;
35  
36  import java.awt.image.BufferedImage;
37  
38  import com.octo.captcha.image.ImageCaptcha;
39  
40  
41  /**
42   * <p>A Gimpy is a ImagCaptcha. It is also the most common captcha.</p> <ul> <li>Challenge type : image</li>
43   * <li>Response type : String</li> <li>Description : An image of a distorded word is shown. User have to recognize the
44   * word and to submit it.</li> </ul>
45   *
46   * @author <a href="mailto:mag@jcaptcha.net">Marc-Antoine Garrigue</a>
47   * @version 1.0
48   */
49  public class LuteceGimpyImage extends ImageCaptcha
50  {
51      /**
52       * Serial version UID
53       */
54      private static final long serialVersionUID = -677228576118984685L;
55  
56      private String _response;
57  
58      /**
59       *
60       * @param question the question
61       * @param challenge the challenge
62       * @param response the response
63       */
64      LuteceGimpyImage( String question, BufferedImage challenge, String response )
65      {
66          super( question, challenge );
67          _response = response;
68      }
69  
70      /**
71       * Validation routine from the CAPTCHA interface. this methods verify if the response is not null and a String and
72       * then compares the given response to the internal string.
73       *
74       * @param response the response
75       * @return true if the given response equals the internal response, false otherwise.
76       */
77      public final Boolean validateResponse( final Object response )
78      {
79          return ( ( null != response ) && response instanceof String ) ? validateResponse( (String) response )
80                                                                        : Boolean.FALSE;
81      }
82  
83      /**
84       * Very simple validation routine that compares the given response to the internal string.
85       *
86       * @param response the response
87       * @return true if the given response equals the internal response, false otherwise.
88       */
89      private Boolean validateResponse( final String response )
90      {
91          return Boolean.valueOf( response.equals( _response ) );
92      }
93  }