3 * A concrete filter for validating code graphical CAPTCHAs with hashes
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class GraphicalCodeCaptchaVerifierFilter extends BaseFilter implements Filterable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this filter class
38 * @return $filterInstance An instance of this filter class
40 public static final function createGraphicalCodeCaptchaVerifierFilter () {
42 $filterInstance = new GraphicalCodeCaptchaVerifierFilter();
44 // Return the instance
45 return $filterInstance;
49 * Executes the filter with given request and response objects
51 * @param $requestInstance An instance of a class with an Requestable interface
52 * @param $responseInstance An instance of a class with an Responseable interface
54 * @throws FilterChainException If this filter fails to operate
56 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
57 // Get the captcha code
58 $captchaCode = $requestInstance->getRequestElement('c_code');
61 if (is_null($captchaCode)) {
62 // Not set so request is invalid
63 $requestInstance->requestIsValid(FALSE);
66 $responseInstance->addFatalMessage('captcha_code_unset');
68 // Skip further processing
69 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
70 } elseif (empty($captchaCode)) {
71 // Empty value so request is invalid
72 $requestInstance->requestIsValid(FALSE);
75 $responseInstance->addFatalMessage('captcha_code_empty');
77 // Skip further processing
78 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
81 // Get the hash as well
82 $captchaHash = $requestInstance->getRequestElement('hash');
85 if (is_null($captchaHash)) {
86 // Not set so request is invalid
87 $requestInstance->requestIsValid(FALSE);
90 $responseInstance->addFatalMessage('captcha_hash_unset');
92 // Skip further processing
93 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
94 } elseif (empty($captchaHash)) {
95 // Empty value so request is invalid
96 $requestInstance->requestIsValid(FALSE);
99 $responseInstance->addFatalMessage('captcha_hash_empty');
101 // Skip further processing
102 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
105 // Now, both are set hash the given one. First get a crypto instance
106 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
108 // Then hash the code
109 $hashedCode = $cryptoInstance->hashString($captchaCode, $captchaHash);
111 // Is this CAPTCHA valid?
112 if ($hashedCode != $captchaHash) {
113 // Not the same so request is invalid
114 $requestInstance->requestIsValid(FALSE);
117 $responseInstance->addFatalMessage('captcha_hash_mismatch');
119 // Skip further processing
120 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
121 } // END - not the same!