3eace252964e4bd792fb31b0e4dcae4664f8e40c
[core.git] / inc / main / classes / filter / verifier / class_ConfirmCodeVerifierFilter.php
1 <?php
2 /**
3  * A filter for checking if supplied confirmation code is valid.
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
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.
15  *
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.
20  *
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/>.
23  */
24 class ConfirmCodeVerifierFilter extends BaseFilter implements Filterable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this filter class
37          *
38          * @return      $filterInstance         An instance of this filter class
39          */
40         public static final function createConfirmCodeVerifierFilter () {
41                 // Get a new instance
42                 $filterInstance = new ConfirmCodeVerifierFilter();
43
44                 // Return the instance
45                 return $filterInstance;
46         }
47
48         /**
49          * Executes the filter with given request and response objects
50          *
51          * @param       $requestInstance        An instance of a class with an Requestable interface
52          * @param       $responseInstance       An instance of a class with an Responseable interface
53          * @return      void
54          * @throws      FilterChainException    If this filter fails to operate
55          */
56         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
57                 // Get confirmation code from request
58                 $confirmCode = $requestInstance->getRequestElement('confirm');
59
60                 // Is this code set?
61                 if (is_null($confirmCode)) {
62                         // Is not in request
63                         $requestInstance->requestIsValid(FALSE);
64
65                         // Add a message to the response
66                         $responseInstance->addFatalMessage('confirm_code_unset');
67
68                         // Abort here
69                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
70                 } elseif (empty($confirmCode)) {
71                         // Email is empty
72                         $requestInstance->requestIsValid(FALSE);
73
74                         // Add a message to the response
75                         $responseInstance->addFatalMessage('confirm_code_empty');
76
77                         // Abort here
78                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
79                 }
80
81                 // Get a user instance from registry
82                 $userInstance = Registry::getRegistry()->getInstance('user');
83
84                 // Get the confirm code from user for comparison
85                 $userCode = $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH);
86
87                 // Do we have the same code or different?
88                 if ($userCode != $confirmCode) {
89                         // Email is empty
90                         $requestInstance->requestIsValid(FALSE);
91
92                         // Redirect to error page
93                         $responseInstance->redirectToConfiguredUrl('confirm_code_invalid');
94
95                         // Stop processing here
96                         exit();
97                 } // END - if
98         }
99 }
100
101 // [EOF]
102 ?>