Continued with renaming-season:
[core.git] / framework / main / classes / filter / verifier / class_ConfirmCodeVerifierFilter.php
1 <?php
2 // Own namespace
3 namespace CoreFramework\Filter\Verifier\Confirmation;
4
5 // Import framework stuff
6 use CoreFramework\Filter\BaseFilter;
7 use CoreFramework\Filter\Filterable;
8 use CoreFramework\Registry\Registry;
9 use CoreFramework\Request\Requestable;
10 use CoreFramework\Response\Responseable;
11
12 /**
13  * A filter for checking if supplied confirmation code is valid.
14  *
15  * @author              Roland Haeder <webmaster@shipsimu.org>
16  * @version             0.0.0
17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
18  * @license             GNU GPL 3.0 or any newer version
19  * @link                http://www.shipsimu.org
20  *
21  * This program is free software: you can redistribute it and/or modify
22  * it under the terms of the GNU General Public License as published by
23  * the Free Software Foundation, either version 3 of the License, or
24  * (at your option) any later version.
25  *
26  * This program is distributed in the hope that it will be useful,
27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
29  * GNU General Public License for more details.
30  *
31  * You should have received a copy of the GNU General Public License
32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
33  */
34 class ConfirmCodeVerifierFilter extends BaseFilter implements Filterable {
35         /**
36          * Protected constructor
37          *
38          * @return      void
39          */
40         protected function __construct () {
41                 // Call parent constructor
42                 parent::__construct(__CLASS__);
43         }
44
45         /**
46          * Creates an instance of this filter class
47          *
48          * @return      $filterInstance         An instance of this filter class
49          */
50         public static final function createConfirmCodeVerifierFilter () {
51                 // Get a new instance
52                 $filterInstance = new ConfirmCodeVerifierFilter();
53
54                 // Return the instance
55                 return $filterInstance;
56         }
57
58         /**
59          * Executes the filter with given request and response objects
60          *
61          * @param       $requestInstance        An instance of a class with an Requestable interface
62          * @param       $responseInstance       An instance of a class with an Responseable interface
63          * @return      void
64          * @throws      FilterChainException    If this filter fails to operate
65          */
66         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
67                 // Get confirmation code from request
68                 $confirmCode = $requestInstance->getRequestElement('confirm');
69
70                 // Is this code set?
71                 if (is_null($confirmCode)) {
72                         // Is not in request
73                         $requestInstance->requestIsValid(FALSE);
74
75                         // Add a message to the response
76                         $responseInstance->addFatalMessage('confirm_code_unset');
77
78                         // Abort here
79                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
80                 } elseif (empty($confirmCode)) {
81                         // Email is empty
82                         $requestInstance->requestIsValid(FALSE);
83
84                         // Add a message to the response
85                         $responseInstance->addFatalMessage('confirm_code_empty');
86
87                         // Abort here
88                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
89                 }
90
91                 // Get a user instance from registry
92                 $userInstance = Registry::getRegistry()->getInstance('user');
93
94                 // Get the confirm code from user for comparison
95                 $userCode = $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH);
96
97                 // Do we have the same code or different?
98                 if ($userCode != $confirmCode) {
99                         // Email is empty
100                         $requestInstance->requestIsValid(FALSE);
101
102                         // Redirect to error page
103                         $responseInstance->redirectToConfiguredUrl('confirm_code_invalid');
104
105                         // Stop processing here
106                         exit();
107                 } // END - if
108         }
109
110 }