Some updates:
[core.git] / framework / main / classes / filter / change / class_PasswordChangeFilter.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Filter\Change\Password;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
7 use Org\Mxchange\CoreFramework\Filter\Filterable;
8 use Org\Mxchange\CoreFramework\Registry\Registry;
9 use Org\Mxchange\CoreFramework\Request\Requestable;
10 use Org\Mxchange\CoreFramework\Response\Responseable;
11
12 /**
13  * A filter for password change detection
14  *
15  * @author              Roland Haeder <webmaster@shipsimu.org>
16  * @version             0.0.0
17 <<<<<<< HEAD:framework/main/classes/filter/change/class_PasswordChangeFilter.php
18  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
19 =======
20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
21 >>>>>>> Some updates::inc/main/classes/filter/change/class_PasswordChangeFilter.php
22  * @license             GNU GPL 3.0 or any newer version
23  * @link                http://www.shipsimu.org
24  *
25  * This program is free software: you can redistribute it and/or modify
26  * it under the terms of the GNU General Public License as published by
27  * the Free Software Foundation, either version 3 of the License, or
28  * (at your option) any later version.
29  *
30  * This program is distributed in the hope that it will be useful,
31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
33  * GNU General Public License for more details.
34  *
35  * You should have received a copy of the GNU General Public License
36  * along with this program. If not, see <http://www.gnu.org/licenses/>.
37  */
38 class PasswordChangeFilter extends BaseFilter implements Filterable {
39         /**
40          * Protected constructor
41          *
42          * @return      void
43          */
44         protected function __construct () {
45                 // Call parent constructor
46                 parent::__construct(__CLASS__);
47         }
48
49         /**
50          * Creates an instance of this filter class
51          *
52          * @param       $controllerInstance             An instance of a controller class
53          * @return      $filterInstance                 An instance of this filter class
54          */
55         public static final function createPasswordChangeFilter () {
56                 // Get a new instance
57                 $filterInstance = new PasswordChangeFilter();
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          * @todo        Finished updating user password hash here. HINT: Use the User class again.
70          * @throws      FilterChainException    If this filter fails to operate
71          */
72         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
73                 // Get both passwords
74                 $pass1 = $requestInstance->getRequestElement('pass1');
75                 $pass2 = $requestInstance->getRequestElement('pass2');
76
77                 // Is only first email set?
78                 if ((!empty($pass1)) && (empty($pass2))) {
79                         // Request is invalid!
80                         $requestInstance->requestIsValid(false);
81
82                         // Email 2 is empty
83                         $responseInstance->addFatalMessage('pass2_empty');
84
85                         // Stop processing here
86                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
87                 } // END - if
88
89                 // Is only second pass set?
90                 if ((empty($pass1)) && (!empty($pass2))) {
91                         // Request is invalid!
92                         $requestInstance->requestIsValid(false);
93
94                         // Email 1 is empty
95                         $responseInstance->addFatalMessage('pass1_empty');
96
97                         // Stop processing here
98                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
99                 } // END - if
100
101                 // Are password and confirmation empty?
102                 if ((empty($pass1)) && (empty($pass2))) {
103                         // Don't change password here
104                         return true;
105                 } // END - if
106
107                 // Do both match?
108                 if ($pass1 != $pass2) {
109                         // Request is invalid!
110                         $requestInstance->requestIsValid(false);
111
112                         // Emails are mismatching
113                         $responseInstance->addFatalMessage('pass_mismatch');
114
115                         // Stop processing here
116                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
117                 } // END - if
118
119                 // Now, get a user instance for comparison
120                 $userInstance = Registry::getRegistry()->getInstance('user');
121
122                 // Update the "password" field
123                 $this->partialStub('Unfinished part.');
124         }
125
126 }