474a81d3368a4b2b72d3c68b75b124ec0dc8af28
[core.git] / framework / main / classes / filter / verifier / class_ConfirmCodeVerifierFilter.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Filter\Verifier\Confirmation;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Database\Frontend\User\UserDatabaseWrapper;
7 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
8 use Org\Mxchange\CoreFramework\Filter\Filterable;
9 use Org\Mxchange\CoreFramework\Registry\Registry;
10 use Org\Mxchange\CoreFramework\Request\Requestable;
11 use Org\Mxchange\CoreFramework\Response\Responseable;
12
13 /**
14  * A filter for checking if supplied confirmation code is valid.
15  *
16  * @author              Roland Haeder <webmaster@shipsimu.org>
17  * @version             0.0.0
18 <<<<<<< HEAD:framework/main/classes/filter/verifier/class_ConfirmCodeVerifierFilter.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/verifier/class_ConfirmCodeVerifierFilter.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 ConfirmCodeVerifierFilter 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 createConfirmCodeVerifierFilter () {
56                 // Get a new instance
57                 $filterInstance = new ConfirmCodeVerifierFilter();
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      FilterChainException    If this filter fails to operate
70          */
71         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
72                 // Get confirmation code from request
73                 $confirmCode = $requestInstance->getRequestElement('confirm');
74
75                 // Is this code set?
76                 if (is_null($confirmCode)) {
77                         // Is not in request
78                         $requestInstance->requestIsValid(false);
79
80                         // Add a message to the response
81                         $responseInstance->addFatalMessage('confirm_code_unset');
82
83                         // Abort here
84                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
85                 } elseif (empty($confirmCode)) {
86                         // Email is empty
87                         $requestInstance->requestIsValid(false);
88
89                         // Add a message to the response
90                         $responseInstance->addFatalMessage('confirm_code_empty');
91
92                         // Abort here
93                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
94                 }
95
96                 // Get a user instance from registry
97                 $userInstance = Registry::getRegistry()->getInstance('user');
98
99                 // Get the confirm code from user for comparison
100                 $userCode = $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH);
101
102                 // Do we have the same code or different?
103                 if ($userCode != $confirmCode) {
104                         // Email is empty
105                         $requestInstance->requestIsValid(false);
106
107                         // Redirect to error page
108                         $responseInstance->redirectToConfiguredUrl('confirm_code_invalid');
109
110                         // Stop processing here
111                         exit();
112                 } // END - if
113         }
114
115 }