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