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