3 namespace Org\Mxchange\CoreFramework\Filter\Captcha;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
8 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
9 use Org\Mxchange\CoreFramework\Filter\Filterable;
10 use Org\Mxchange\CoreFramework\Helper\Crypto\CryptoHelper;
11 use Org\Mxchange\CoreFramework\Request\Requestable;
12 use Org\Mxchange\CoreFramework\Response\Responseable;
15 * A filter for checking if value "encrypt" is set and fine
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2022 Core Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 class CaptchaEncryptFilter extends BaseFilter implements Filterable {
38 * Protected constructor
42 private function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
48 * Creates an instance of this filter class
50 * @return $filterInstance An instance of this filter class
52 public static final function createCaptchaEncryptFilter () {
54 $filterInstance = new CaptchaEncryptFilter();
56 // Return the instance
57 return $filterInstance;
61 * Executes the filter with given request and response objects
63 * @param $requestInstance An instance of a class with an Requestable interface
64 * @param $responseInstance An instance of a class with an Responseable interface
66 * @throws EncryptMissingException If the "encrypt" value is not set
68 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
69 // Get "encrypt" string barely from the request
70 $encryptRequest = $requestInstance->getRequestElement('encrypt');
73 if (is_null($encryptRequest)) {
74 // Not found, so request is invalid
75 $requestInstance->setIsRequestValid(FALSE);
78 throw new EncryptMissingException($this, CryptoHelper::EXCEPTION_ENCRYPT_MISSING);
82 $encryptDecoded = base64_decode(str_replace(' ', '+', urldecode($encryptRequest)));
84 // Get a crypto helper and decrypt the string
85 $decryptedString = ObjectFactory::createObjectByConfiguredName('crypto_class')->decryptString($encryptDecoded);
87 // Is it the expected length?
88 if (strlen($decryptedString) != FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('captcha_string_length')) {
89 // Not found, so request is invalid
90 $requestInstance->setIsRequestValid(FALSE);
93 throw new EncryptInvalidLengthException($this, CryptoHelper::EXCEPTION_ENCRYPT_INVALID);
96 // Write it to the request
97 $requestInstance->setRequestElement('decrypted', $decryptedString);