955af1438f6b1f61cb7461b92f6a5756ad854ed9
[core.git] / framework / main / classes / filter / crypto / class_CaptchaEncryptFilter.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Filter\Captcha;
4
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;
12
13 /**
14  * A filter for checking if value "encrypt" is set and fine
15  *
16  * @author              Roland Haeder <webmaster@shipsimu.org>
17  * @version             0.0.0
18 <<<<<<< HEAD:framework/main/classes/filter/crypto/class_CaptchaEncryptFilter.php
19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
20 =======
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
25  *
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.
30  *
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.
35  *
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/>.
38  */
39 class CaptchaEncryptFilter extends BaseFilter implements Filterable {
40         /**
41          * Protected constructor
42          *
43          * @return      void
44          */
45         protected function __construct () {
46                 // Call parent constructor
47                 parent::__construct(__CLASS__);
48         }
49
50         /**
51          * Creates an instance of this filter class
52          *
53          * @return      $filterInstance                 An instance of this filter class
54          */
55         public static final function createCaptchaEncryptFilter () {
56                 // Get a new instance
57                 $filterInstance = new CaptchaEncryptFilter();
58
59                 // Return the instance
60                 return $filterInstance;
61         }
62
63         /**
64          * Executes the filter with given request and response objects
65          *
66          * @param       $requestInstance        An instance of a class with an Requestable interface
67          * @param       $responseInstance       An instance of a class with an Responseable interface
68          * @return      void
69          * @throws      EncryptMissingException         If the "encrypt" value is not set
70          */
71         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
72                 // Get "encrypt" string barely from the request
73                 $encryptRequest = $requestInstance->getRequestElement('encrypt');
74
75                 // Is it there?
76                 if (is_null($encryptRequest)) {
77                         // Not found, so request is invalid
78                         $requestInstance->requestIsValid(false);
79
80                         // Throw exception
81                         throw new EncryptMissingException($this, CryptoHelper::EXCEPTION_ENCRYPT_MISSING);
82                 } // END - if
83
84                 // Decode it fully
85                 $encryptDecoded = base64_decode(str_replace(' ', '+', urldecode($encryptRequest)));
86
87                 // Get a crypto helper and decrypt the string
88                 $decryptedString = ObjectFactory::createObjectByConfiguredName('crypto_class')->decryptString($encryptDecoded);
89
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);
94
95                         // Throw exception
96                         throw new EncryptInvalidLengthException($this, CryptoHelper::EXCEPTION_ENCRYPT_INVALID);
97                 } // END - if
98
99                 // Write it to the request
100                 $requestInstance->setRequestElement('decrypted', $decryptedString);
101         }
102
103 }