3 namespace CoreFramework\Filter\User\Auth;
5 // Import framework stuff
6 use CoreFramework\Factory\ObjectFactory;
7 use CoreFramework\Filter\BaseFilter;
8 use CoreFramework\Filter\Filterable;
9 use CoreFramework\Loader\NoClassException;
10 use CoreFramework\Registry\Registry;
11 use CoreFramework\Request\Requestable;
12 use CoreFramework\Response\Responseable;
15 * A filter for checking user permissions
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 class UserAuthFilter extends BaseFilter implements Filterable {
37 // Exception constants
38 const EXCEPTION_AUTH_DATA_INVALID = 0x1b0;
41 * The login method we shall choose
43 private $authMethod = '';
46 * Protected constructor
50 protected function __construct () {
51 // Call parent constructor
52 parent::__construct(__CLASS__);
56 * Creates an instance of this filter class
58 * @return $filterInstance An instance of this filter class
60 public static final function createUserAuthFilter () {
62 $filterInstance = new UserAuthFilter();
64 // Set default auth method
65 $filterInstance->setDefaultAuthMethod();
67 // Return the instance
68 return $filterInstance;
72 * Setter for default login method from config
76 protected function setDefaultAuthMethod () {
77 $this->authMethod = $this->getConfigInstance()->getConfigEntry('auth_method_class');
81 * Executes the filter with given request and response objects
83 * @param $requestInstance An instance of a class with an Requestable interface
84 * @param $responseInstance An instance of a class with an Responseable interface
86 * @throws UserAuthorizationException If the auth login was not found or if it was invalid
87 * @throws UserPasswordMismatchException If the supplied password hash does not match
88 * @throws NoClassException If the user (guest/member) class was not found
90 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
91 // Then get an auth instance for checking and updating the auth cookies
92 $authInstance = ObjectFactory::createObjectByName($this->authMethod, array($responseInstance));
94 // Set request instance
95 $authInstance->setRequestInstance($requestInstance);
97 // Now, get the auth data for comparison
98 $authLogin = $authInstance->getUserAuth();
99 $authHash = $authInstance->getPasswordAuth();
101 // If one is empty stop here
102 if ((empty($authLogin)) || (empty($authHash))) {
103 // Destroy the auth data
104 $authInstance->destroyAuthData();
106 // Mark the request as invalid
107 $requestInstance->requestIsValid(FALSE);
110 $responseInstance->addFatalMessage('auth_data_incomplete');
113 throw new UserAuthorizationException($this, self::EXCEPTION_AUTH_DATA_INVALID);
116 // Regular user account
117 $className = $this->getConfigInstance()->getConfigEntry('user_class');
118 $methodName = 'createMemberByUserName';
120 // Now, try to get a user or guest instance
121 if ($authLogin == $this->getConfigInstance()->getConfigEntry('guest_login_user')) {
123 $className = $this->getConfigInstance()->getConfigEntry('guest_class');
124 $methodName = 'createGuestByUserName';
127 // Does the guest class exist?
128 if (!class_exists($className)) {
130 throw new NoClassException (array($this, $className), self::EXCEPTION_CLASS_NOT_FOUND);
133 // Now try the dynamic login
134 $userInstance = call_user_func_array(array($className, $methodName), array($authLogin));
136 // Is the password correct?
137 if ($userInstance->getPasswordHash() !== $authHash) {
138 // Mismatching password
139 throw new UserPasswordMismatchException(array($this, $userInstance), BaseUser::EXCEPTION_USER_PASS_MISMATCH);
142 // Remember auth and user instances in registry
143 Registry::getRegistry()->addInstance('auth', $authInstance);
144 Registry::getRegistry()->addInstance('user', $userInstance);