3 namespace Org\Mxchange\CoreFramework\Filter\Captcha;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
7 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
8 use Org\Mxchange\CoreFramework\Filter\Filterable;
9 use Org\Mxchange\CoreFramework\Helper\Crypto\CryptoHelper;
10 use Org\Mxchange\CoreFramework\Request\Requestable;
11 use Org\Mxchange\CoreFramework\Response\Responseable;
14 * A filter for checking if value "encrypt" is set and fine
16 * @author Roland Haeder <webmaster@shipsimu.org>
18 <<<<<<< HEAD:framework/main/classes/filter/crypto/class_CaptchaEncryptFilter.php
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
21 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
22 >>>>>>> Some updates::inc/main/classes/filter/crypto/class_CaptchaEncryptFilter.php
23 * @license GNU GPL 3.0 or any newer version
24 * @link http://www.shipsimu.org
26 * This program is free software: you can redistribute it and/or modify
27 * it under the terms of the GNU General Public License as published by
28 * the Free Software Foundation, either version 3 of the License, or
29 * (at your option) any later version.
31 * This program is distributed in the hope that it will be useful,
32 * but WITHOUT ANY WARRANTY; without even the implied warranty of
33 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
34 * GNU General Public License for more details.
36 * You should have received a copy of the GNU General Public License
37 * along with this program. If not, see <http://www.gnu.org/licenses/>.
39 class CaptchaEncryptFilter extends BaseFilter implements Filterable {
41 * Protected constructor
45 protected function __construct () {
46 // Call parent constructor
47 parent::__construct(__CLASS__);
51 * Creates an instance of this filter class
53 * @return $filterInstance An instance of this filter class
55 public static final function createCaptchaEncryptFilter () {
57 $filterInstance = new CaptchaEncryptFilter();
59 // Return the instance
60 return $filterInstance;
64 * Executes the filter with given request and response objects
66 * @param $requestInstance An instance of a class with an Requestable interface
67 * @param $responseInstance An instance of a class with an Responseable interface
69 * @throws EncryptMissingException If the "encrypt" value is not set
71 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
72 // Get "encrypt" string barely from the request
73 $encryptRequest = $requestInstance->getRequestElement('encrypt');
76 if (is_null($encryptRequest)) {
77 // Not found, so request is invalid
78 $requestInstance->requestIsValid(false);
81 throw new EncryptMissingException($this, CryptoHelper::EXCEPTION_ENCRYPT_MISSING);
85 $encryptDecoded = base64_decode(str_replace(' ', '+', urldecode($encryptRequest)));
87 // Get a crypto helper and decrypt the string
88 $decryptedString = ObjectFactory::createObjectByConfiguredName('crypto_class')->decryptString($encryptDecoded);
90 // Is it the expected length?
91 if (strlen($decryptedString) != $this->getConfigInstance()->getConfigEntry('captcha_string_length')) {
92 // Not found, so request is invalid
93 $requestInstance->requestIsValid(false);
96 throw new EncryptInvalidLengthException($this, CryptoHelper::EXCEPTION_ENCRYPT_INVALID);
99 // Write it to the request
100 $requestInstance->setRequestElement('decrypted', $decryptedString);