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.portal.service.captcha;
35  
36  import fr.paris.lutece.portal.service.spring.SpringContextService;
37  
38  import org.springframework.beans.factory.BeanDefinitionStoreException;
39  import org.springframework.beans.factory.CannotLoadBeanClassException;
40  import org.springframework.beans.factory.NoSuchBeanDefinitionException;
41  
42  import javax.servlet.http.HttpServletRequest;
43  
44  
45  /**
46   * Default captcha security service implementation
47   */
48  public class CaptchaSecurityService implements ICaptchaSecurityService
49  {
50      private boolean _bActive = true;
51      private boolean _bAvailable;
52      private ICaptchaService _captchaService;
53  
54      /**
55       * Default constructor.
56       *
57       * Gets the captchaValidator from the captcha plugin.
58       * If the validator is missing, sets available to false;
59       */
60      public CaptchaSecurityService(  )
61      {
62          try
63          {
64              // first check if captchaValidator bean is available in the jcaptcha plugin context
65              _captchaService = SpringContextService.getBean( "captcha.captchaService" );
66              _bAvailable = _captchaService != null;
67          }
68          catch ( BeanDefinitionStoreException e )
69          {
70              _bAvailable = false;
71          }
72          catch ( NoSuchBeanDefinitionException e )
73          {
74              _bAvailable = false;
75          }
76          catch ( CannotLoadBeanClassException e )
77          {
78              _bAvailable = false;
79          }
80      }
81  
82      /**
83       * {@inheritDoc}
84       */
85      @Override
86      public String getActiveBlockHtml(  )
87      {
88          // TODO Auto-generated method stub
89          return null;
90      }
91  
92      /**
93       * {@inheritDoc}
94       */
95      @Override
96      public String getHtmlCode(  )
97      {
98          if ( isAvailable(  ) && isActive(  ) )
99          {
100             return _captchaService.getHtmlCode(  );
101         }
102         else
103         {
104             return EMPTY_STRING;
105         }
106     }
107 
108     /**
109      * {@inheritDoc}
110      */
111     @Override
112     public void setActive( boolean isActive )
113     {
114         _bActive = isActive;
115     }
116 
117     /**
118      * {@inheritDoc}
119      */
120     @Override
121     public boolean validate( HttpServletRequest request )
122     {
123         if ( isAvailable(  ) && isActive(  ) )
124         {
125             return _captchaService.validate( request );
126         }
127         else
128         {
129             return true;
130         }
131     }
132 
133     /**
134      * {@inheritDoc}
135      */
136     @Override
137     public boolean isActive(  )
138     {
139         return _bActive;
140     }
141 
142     /**
143      * {@inheritDoc}
144      */
145     @Override
146     public boolean isAvailable(  )
147     {
148         return _bAvailable;
149     }
150 }