Now in own repository for remote checkouts
[core.git] / inc / classes / main / filter / verifier / class_AccountPasswordVerifierFilter.php
1 <?php
2 /**
3  * A concrete filter for validating the password. This filter may intercept
4  * the filter chain if no password is given or the password is invalid
5  *
6  * @author              Roland Haeder <webmaster@ship-simu.org>
7  * @version             0.0.0
8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
9  * @license             GNU GPL 3.0 or any newer version
10  * @link                http://www.ship-simu.org
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
24  */
25 class AccountPasswordVerifierFilter extends BaseFilter implements Filterable {
26         /**
27          * Protected constructor
28          *
29          * @return      void
30          */
31         protected function __construct () {
32                 // Call parent constructor
33                 parent::__construct(__CLASS__);
34         }
35
36         /**
37          * Creates an instance of this filter class
38          *
39          * @param       $controllerInstance             An instance of a Controller class
40          * @return      $filterInstance                 An instance of this filter class
41          */
42         public final static function createAccountPasswordVerifierFilter (Controller $controllerInstance) {
43                 // Get a new instance
44                 $filterInstance = new AccountPasswordVerifierFilter();
45
46                 // Set the controller
47                 $filterInstance->setControllerInstance($controllerInstance);
48
49                 // Return the instance
50                 return $filterInstance;
51         }
52
53         /**
54          * Executes the filter with given request and response objects
55          *
56          * @param       $requestInstance        An instance of a class with an Requestable interface
57          * @param       $responseInstance       An instance of a class with an Responseable interface
58          * @return      void
59          * @throws      AccountPasswordMismatchException        If the account password does not match
60          * @todo        Rewrite handling of different password fields
61          */
62         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
63                 // Get password
64                 $password = $requestInstance->getRequestElement('pass_old');
65
66                 // Is the password still not set?
67                 if (is_null($password)) {
68                         // Get password from alternative location
69                         $password = $requestInstance->getRequestElement('password');
70
71                         // Is the password still not set?
72                         if (is_null($password)) {
73                                 // Not found in form so stop the filtering process
74                                 $requestInstance->requestIsValid(false);
75
76                                 // Add a message to the response
77                                 $responseInstance->addFatalMessage('password_unset');
78
79                                 // Abort here
80                                 return false;
81                         } // END - if
82                 } // END - if
83
84                 if (empty($password)) {
85                         // Password is empty
86                         $requestInstance->requestIsValid(false);
87
88                         // Add a message to the response
89                         $responseInstance->addFatalMessage('password_empty');
90
91                         // Abort here
92                         return false;
93                 }
94
95                 // Get a user instance
96                 $userInstance = Registry::getRegistry()->getInstance('user');
97
98                 // Get current hash
99                 $currentHash = $userInstance->getField('pass_hash');
100
101                 // Get an encryption helper and encrypt the password
102                 $passHash = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($password, $currentHash);
103
104                 // Does it match?
105                 if ($currentHash != $passHash) {
106                         // Throw an exception here to stop the proccessing
107                         throw new AccountPasswordMismatchException($this, BaseUser::EXCEPTION_USER_PASS_MISMATCH);
108                 } // END - if
109         }
110 }
111
112 // [EOF]
113 ?>