3 * A filter for checking if value "encrypt" is set and fine
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class CaptchaEncryptFilter extends BaseFilter implements Filterable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this filter class
38 * @param $controllerInstance An instance of a Controller class
39 * @return $filterInstance An instance of this filter class
41 public final static function createCaptchaEncryptFilter (Controller $controllerInstance) {
43 $filterInstance = new CaptchaEncryptFilter();
46 $filterInstance->setControllerInstance($controllerInstance);
48 // Return the instance
49 return $filterInstance;
53 * Executes the filter with given request and response objects
55 * @param $requestInstance An instance of a class with an Requestable interface
56 * @param $responseInstance An instance of a class with an Responseable interface
58 * @throws EncryptMissingException If the "encrypt" value is not set
60 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
61 // Get "encrypt" string barely from the request
62 $encryptRequest = $requestInstance->getRequestElement('encrypt');
65 if (is_null($encryptRequest)) {
66 // Not found, so request is invalid
67 $requestInstance->requestIsValid(false);
70 throw new EncryptMissingException($this, CryptoHelper::EXCEPTION_ENCRYPT_MISSING);
74 $encryptDecoded = base64_decode(str_replace(" ", "+", urldecode($encryptRequest)));
76 // Get a crypto helper and decrypt the string
77 $decryptedString = ObjectFactory::createObjectByConfiguredName('crypto_class')->decryptString($encryptDecoded);
79 // Is it the expected length?
80 if (strlen($decryptedString) != $this->getConfigInstance()->readConfig('captcha_string_length')) {
81 // Not found, so request is invalid
82 $requestInstance->requestIsValid(false);
85 throw new EncryptInvalidLengthException($this, CryptoHelper::EXCEPTION_ENCRYPT_INVALID);
88 // Write it to the request
89 $requestInstance->setRequestElement('decrypted', $decryptedString);