3 * A special login class for administration area
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Admin-Area Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class AdminUserLogin extends BaseFrameworkSystem implements LoginableUser {
28 private $hashedPassword = "";
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
40 $this->removeNumberFormaters();
41 $this->removeSystemArray();
45 * Creates an instance of this login class
47 * @return $loginInstance An instance of this login class
49 public final static function createAdminUserLogin () {
51 $loginInstance = new AdminUserLogin();
53 // Return the instance
54 return $loginInstance;
58 * Logins the user with the given request containing the credential. The
59 * result of the login can be thrown by exception or, if prefered stored
60 * in a boolean attribute which is then readable by a matching getter.
62 * @param $requestInstance An instance of a Requestable class
63 * @param $responseInstance An instance of a Responseable class
65 * @throws UserPasswordMismatchException If the supplied password did not
66 * match with the stored password
67 * @todo We need to add something here which will make more than one
68 * @todo guest logins, users who are online but based on the same
71 public function doLogin (Requestable $requestInstance, Responseable $responseInstance) {
72 // By default no method is selected
77 $userClass = $this->getConfigInstance()->getConfigEntry('user_class');
79 // Get a user instance
80 $userInstance = call_user_func_array(array($userClass, 'createMemberByRequest'), array($requestInstance));
82 // Remember this new instance in registry
83 Registry::getRegistry()->addInstance('user', $userInstance);
85 // Is the password correct?
86 if ($userInstance->ifPasswordHashMatches($requestInstance) === false) {
87 // Mismatching password
88 throw new UserPasswordMismatchException(array($this, $userInstance), BaseUser::EXCEPTION_USER_PASS_MISMATCH);
93 // Now do the real login. This can be cookie- or session-based login
94 // which depends on the admins setting then on the user's taste.
95 // 1) Get a login helper instance
96 $helperInstance = ObjectFactory::createObjectByConfiguredName('login_helper_class', array($requestInstance));
98 // 2) Execute the login. This will now login...
99 $helperInstance->executeLogin($responseInstance);
103 * Determines wether the login was fine. This is done by checking if 'login' instance is in registry
105 * @return $loginDone Wether the login was fine or not
107 public function ifLoginWasSuccessfull () {
108 // Is the registry key there?
109 $loginDone = (Registry::getRegistry()->getInstance('login') instanceof Registerable);
116 * Encrypt given request key or throw an exception if key was not found in
119 * @param $requestKey Key in request class
122 public function encryptPassword ($requestKey) {
123 // Check if password is found in request
124 if ($this->getRequestInstance()->isRequestElementSet($requestKey)) {
125 // So encrypt the password and store it for later usage in
128 // Get the plain password
129 $plainPassword = $this->getRequestInstance()->getRequestElement($requestKey);
132 $userInstance = Registry::getRegistry()->getInstance('user');
134 // Get a crypto helper and hash the password
135 $this->hashedPassword = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($plainPassword, $userInstance->getPasswordHash());
137 // Store the hash back in request
138 $this->getRequestInstance()->setRequestElement('pass_hash', $this->hashedPassword);