Minor code improvements:
[shipsimu.git] / inc / classes / main / filter / auth / class_UserAuthFilter.php
1 <?php
2 /**
3  * A filter for checking user permissions
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.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 UserAuthFilter extends BaseFilter implements Filterable {
25         // Exception constants
26         const EXCEPTION_AUTH_DATA_INVALID = 0x1b0;
27
28         /**
29          * The login method we shall choose
30          */
31         private $authMethod = "";
32
33         /**
34          * Protected constructor
35          *
36          * @return      void
37          */
38         protected function __construct () {
39                 // Call parent constructor
40                 parent::__construct(__CLASS__);
41
42                 // Set part description
43                 $this->setObjectDescription("A user authorization filter");
44
45                 // Create unique ID number
46                 $this->generateUniqueId();
47         }
48
49         /**
50          * Creates an instance of this filter class
51          *
52          * @return      $filterInstance         An instance of this filter class
53          */
54         public final static function createUserAuthFilter () {
55                 // Get a new instance
56                 $filterInstance = new UserAuthFilter();
57
58                 // Set default auth method
59                 $filterInstance->setDefaultAuthMethod();
60
61                 // Return the instance
62                 return $filterInstance;
63         }
64
65         /**
66          * Setter for default login method from config
67          *
68          * @return      void
69          */
70         protected function setDefaultAuthMethod () {
71                 $this->authMethod = $this->getConfigInstance()->readConfig('auth_method_class');
72         }
73
74         /**
75          * Executes the filter with given request and response objects
76          *
77          * @param       $requestInstance        An instance of a class with an Requestable interface
78          * @param       $responseInstance       An instance of a class with an Responseable interface
79          * @return      void
80          * @throws      UserAuthorizationException      If the auth login was not found or if it was invalid
81          * @throws      UserPasswordMismatchException   If the supplied password hash does not match
82          * @throws      ClassNotFoundException  If the user (guest/member) class was not found
83          */
84         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
85                 // Then get an auth instance for checking and updating the auth cookies
86                 $authInstance = ObjectFactory::createObjectByName($this->authMethod, array($responseInstance));
87
88                 // Set request instance
89                 $authInstance->setRequestInstance($requestInstance);
90
91                 // Now, get the auth data for comparison
92                 $authLogin = $authInstance->getUserAuth();
93                 $authHash  = $authInstance->getPasswordAuth();
94
95                 // If one is empty stop here
96                 if ((empty($authLogin)) || (empty($authHash))) {
97                         // Destroy the auth data
98                         $authInstance->destroyAuthData();
99
100                         // Mark the request as invalid
101                         $requestInstance->requestIsValid(false);
102
103                         // Add fatal message
104                         $responseInstance->addFatalMessage('auth_data_incomplete');
105
106                         // Stop here
107                         throw new UserAuthorizationException($this, self::EXCEPTION_AUTH_DATA_INVALID);
108                 } // END - if
109
110                 // Regular user account
111                 $className = $this->getConfigInstance()->readConfig('user_class');
112                 $methodName = 'createMemberByUserName';
113
114                 // Now, try to get a user or guest instance
115                 if ($authLogin == $this->getConfigInstance()->readConfig('guest_login_user')) {
116                         // Set class
117                         $className = $this->getConfigInstance()->readConfig('guest_class');
118                         $methodName = 'createGuestByUserName';
119                 } // END - if
120
121                 // Does the guest class exist?
122                 if (!class_exists($className)) {
123                         // Then abort here
124                         throw new ClassNotFoundException (array($this, $className), self::EXCEPTION_CLASS_NOT_FOUND);
125                 } // END - if
126
127                 // Now try the dynamic login
128                 $userInstance = call_user_func_array(array($className, $methodName), array($authLogin));
129
130                 // Is the password correct?
131                 if ($userInstance->getPasswordHash() !== $authHash) {
132                         // Mismatching password
133                         throw new UserPasswordMismatchException(array($this, $userInstance), BaseUser::EXCEPTION_USER_PASS_MISMATCH);
134                 } // END - if
135
136                 // Remember auth and user instances in registry
137                 Registry::getRegistry()->addInstance('auth', $authInstance);
138                 Registry::getRegistry()->addInstance('user', $userInstance);
139         }
140 }
141
142 // [EOF]
143 ?>