80f38d13e310232fd75bbf36e1b1475e14908c17
[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, 2009 - 2011 Core Developer Team
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          * @return      $filterInstance                 An instance of this filter class
40          */
41         public static final function createAccountPasswordVerifierFilter () {
42                 // Get a new instance
43                 $filterInstance = new AccountPasswordVerifierFilter();
44
45                 // Return the instance
46                 return $filterInstance;
47         }
48
49         /**
50          * Executes the filter with given request and response objects
51          *
52          * @param       $requestInstance        An instance of a class with an Requestable interface
53          * @param       $responseInstance       An instance of a class with an Responseable interface
54          * @return      void
55          * @throws      AccountPasswordMismatchException        If the account password does not match
56          * @throws      FilterChainException                            If this filter fails to operate
57          * @todo        Rewrite handling of different password fields
58          */
59         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
60                 // Get password
61                 $password = $requestInstance->getRequestElement('pass_old');
62
63                 // Is the password still not set?
64                 if (is_null($password)) {
65                         // Get password from alternative location
66                         $password = $requestInstance->getRequestElement('password');
67
68                         // Is the password still not set?
69                         if (is_null($password)) {
70                                 // Not found in form so stop the filtering process
71                                 $requestInstance->requestIsValid(false);
72
73                                 // Add a message to the response
74                                 $responseInstance->addFatalMessage('password_unset');
75
76                                 // Abort here
77                                 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
78                         } // END - if
79                 } // END - if
80
81                 if (empty($password)) {
82                         // Password is empty
83                         $requestInstance->requestIsValid(false);
84
85                         // Add a message to the response
86                         $responseInstance->addFatalMessage('password_empty');
87
88                         // Abort here
89                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
90                 } // END - if
91
92                 // Get a user instance
93                 $userInstance = Registry::getRegistry()->getInstance('user');
94
95                 // Get current hash
96                 $currentHash = $userInstance->getField('pass_hash');
97
98                 // Get an encryption helper and encrypt the password
99                 $passHash = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($password, $currentHash);
100
101                 // Does it match?
102                 if ($currentHash != $passHash) {
103                         // Throw an exception here to stop the proccessing
104                         throw new AccountPasswordMismatchException($this, BaseUser::EXCEPTION_USER_PASS_MISMATCH);
105                 } // END - if
106         }
107 }
108
109 // [EOF]
110 ?>