3 * A special login class for Ship-Simu
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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 ShipSimuUserLogin 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 createShipSimuUserLogin () {
51 $loginInstance = new ShipSimuUserLogin();
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
76 // Get a instance of the registry
77 $userInstance = Registry::getRegistry()->getInstance('user');
79 // Is there an instance?
80 if (is_null($userInstance)) {
82 $userClass = $this->getConfigInstance()->readConfig('user_class');
84 // Get a user instance
85 $userInstance = call_user_func_array(array($userClass, 'createMemberByRequest'), array($requestInstance));
87 // Remember this new instance in registry
88 Registry::getRegistry()->addInstance($userInstance);
91 // Is the password correct?
92 if (!$userInstance->ifPasswordHashMatches($requestInstance)) {
93 // Mismatching password
94 throw new UserPasswordMismatchException(array($this, $userInstance), BaseUser::EXCEPTION_USER_PASS_MISMATCH);
99 // Now do the real login. This can be cookie- or session-based login
100 // which depends on the admins setting then on the user's taste.
101 // 1) Get a login helper instance
102 $helperInstance = ObjectFactory::createObjectByConfiguredName('login_helper_class', array($requestInstance));
104 // 2) Execute the login. This will now login...
105 $helperInstance->executeLogin($responseInstance);
109 * Determines wether the login was fine. This is done by checking if the 'login' instance is in registry
111 * @return $loginDone Wether the login was fine or not
113 public function ifLoginWasSuccessfull () {
114 // Is the registry key there?
115 $loginDone = (Registry::getRegistry()->getInstance('login') instanceof Registerable);
122 * Encrypt the given request key or throw an exception if the key was not
123 * found in the request
125 * @param $requestKey Key in request class
128 public function encryptPassword ($requestKey) {
129 // Check if the password is found in the request
130 if ($this->getRequestInstance()->isRequestElementSet($requestKey)) {
131 // So encrypt the password and store it for later usage in
134 // Get the plain password
135 $plainPassword = $this->getRequestInstance()->getRequestElement($requestKey);
138 $userInstance = Registry::getRegistry()->getInstance('user');
140 // Get a crypto helper and hash the password
141 $this->hashedPassword = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($plainPassword, $userInstance->getPasswordHash());
143 // Store the hash back in the request
144 $this->getRequestInstance()->setRequestElement('pass_hash', $this->hashedPassword);