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 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 Core Developer Team
19 * @license GNU GPL 3.0 or any newer version
20 * @link http://www.shipsimu.org
22 * This program is free software: you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License as published by
24 * the Free Software Foundation, either version 3 of the License, or
25 * (at your option) any later version.
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU General Public License for more details.
32 * You should have received a copy of the GNU General Public License
33 * along with this program. If not, see <http://www.gnu.org/licenses/>.
35 class CaptchaEncryptFilter extends BaseFilter implements Filterable {
37 * Protected constructor
41 protected function __construct () {
42 // Call parent constructor
43 parent::__construct(__CLASS__);
47 * Creates an instance of this filter class
49 * @return $filterInstance An instance of this filter class
51 public static final function createCaptchaEncryptFilter () {
53 $filterInstance = new CaptchaEncryptFilter();
55 // Return the instance
56 return $filterInstance;
60 * Executes the filter with given request and response objects
62 * @param $requestInstance An instance of a class with an Requestable interface
63 * @param $responseInstance An instance of a class with an Responseable interface
65 * @throws EncryptMissingException If the "encrypt" value is not set
67 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
68 // Get "encrypt" string barely from the request
69 $encryptRequest = $requestInstance->getRequestElement('encrypt');
72 if (is_null($encryptRequest)) {
73 // Not found, so request is invalid
74 $requestInstance->requestIsValid(false);
77 throw new EncryptMissingException($this, CryptoHelper::EXCEPTION_ENCRYPT_MISSING);
81 $encryptDecoded = base64_decode(str_replace(' ', '+', urldecode($encryptRequest)));
83 // Get a crypto helper and decrypt the string
84 $decryptedString = ObjectFactory::createObjectByConfiguredName('crypto_class')->decryptString($encryptDecoded);
86 // Is it the expected length?
87 if (strlen($decryptedString) != $this->getConfigInstance()->getConfigEntry('captcha_string_length')) {
88 // Not found, so request is invalid
89 $requestInstance->requestIsValid(false);
92 throw new EncryptInvalidLengthException($this, CryptoHelper::EXCEPTION_ENCRYPT_INVALID);
95 // Write it to the request
96 $requestInstance->setRequestElement('decrypted', $decryptedString);