3 namespace CoreFramework\Filter\Captcha;
6 * A filter for checking if value "encrypt" is set and fine
8 * @author Roland Haeder <webmaster@shipsimu.org>
10 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
11 * @license GNU GPL 3.0 or any newer version
12 * @link http://www.shipsimu.org
14 * This program is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 class CaptchaEncryptFilter extends BaseFilter implements Filterable {
29 * Protected constructor
33 protected function __construct () {
34 // Call parent constructor
35 parent::__construct(__CLASS__);
39 * Creates an instance of this filter class
41 * @return $filterInstance An instance of this filter class
43 public static final function createCaptchaEncryptFilter () {
45 $filterInstance = new CaptchaEncryptFilter();
47 // Return the instance
48 return $filterInstance;
52 * Executes the filter with given request and response objects
54 * @param $requestInstance An instance of a class with an Requestable interface
55 * @param $responseInstance An instance of a class with an Responseable interface
57 * @throws EncryptMissingException If the "encrypt" value is not set
59 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
60 // Get "encrypt" string barely from the request
61 $encryptRequest = $requestInstance->getRequestElement('encrypt');
64 if (is_null($encryptRequest)) {
65 // Not found, so request is invalid
66 $requestInstance->requestIsValid(FALSE);
69 throw new EncryptMissingException($this, CryptoHelper::EXCEPTION_ENCRYPT_MISSING);
73 $encryptDecoded = base64_decode(str_replace(' ', '+', urldecode($encryptRequest)));
75 // Get a crypto helper and decrypt the string
76 $decryptedString = ObjectFactory::createObjectByConfiguredName('crypto_class')->decryptString($encryptDecoded);
78 // Is it the expected length?
79 if (strlen($decryptedString) != $this->getConfigInstance()->getConfigEntry('captcha_string_length')) {
80 // Not found, so request is invalid
81 $requestInstance->requestIsValid(FALSE);
84 throw new EncryptInvalidLengthException($this, CryptoHelper::EXCEPTION_ENCRYPT_INVALID);
87 // Write it to the request
88 $requestInstance->setRequestElement('decrypted', $decryptedString);