More conventions than code added:
[shipsimu.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                 // Set part description
36                 $this->setObjectDescription("A filter for account password verification");
37
38                 // Create unique ID number
39                 $this->generateUniqueId();
40         }
41
42         /**
43          * Creates an instance of this filter class
44          *
45          * @return      $filterInstance         An instance of this filter class
46          */
47         public final static function createAccountPasswordVerifierFilter () {
48                 // Get a new instance
49                 $filterInstance = new AccountPasswordVerifierFilter();
50
51                 // Return the instance
52                 return $filterInstance;
53         }
54
55         /**
56          * Executes the filter with given request and response objects
57          *
58          * @param       $requestInstance        An instance of a class with an Requestable interface
59          * @param       $responseInstance       An instance of a class with an Responseable interface
60          * @return      void
61          * @throws      AccountPasswordMismatchException        If the account password does not match
62          */
63         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
64                 // Get password
65                 $password = $requestInstance->getRequestElement('pass_old');
66
67                 // Is the password still not set?
68                 if (is_null($password)) {
69                         // Not found in form so stop the filtering process
70                         $requestInstance->requestIsValid(false);
71
72                         // Add a message to the response
73                         $responseInstance->addFatalMessage('pass_old_unset');
74
75                         // Abort here
76                         return false;
77                 } elseif (empty($password)) {
78                         // Password is empty
79                         $requestInstance->requestIsValid(false);
80
81                         // Add a message to the response
82                         $responseInstance->addFatalMessage('pass_old_empty');
83
84                         // Abort here
85                         return false;
86                 }
87
88                 // Get a user instance
89                 $userInstance = Registry::getRegistry()->getInstance('user');
90
91                 // Get old hash
92                 $oldHash = $userInstance->getField('pass_hash');
93
94                 // Get an encryption helper and encrypt the password
95                 $passHash = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($password, $oldHash);
96
97                 // Does it match?
98                 if ($oldHash != $passHash) {
99                         // Throw an exception here to stop the proccessing
100                         throw new AccountPasswordMismatchException($this, User::EXCEPTION_USER_PASS_MISMATCH);
101                 } // END - if
102         }
103 }
104
105 // [EOF]
106 ?>