application/ship-simu/main/login/class_ShipSimuUserLogin.php

   1 <?php
   2 /**
   3  * A special login class for Ship-Simu
   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 ShipSimuUserLogin extends BaseFrameworkSystem implements LoginableUser {
  25         /**
  26          * The hashed password
  27          */
  28         private $hashedPassword = "";
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38
  39                 // Clean up a little
  40                 $this->removeNumberFormaters();
  41                 $this->removeSystemArray();
  42         }
  43
  44         /**
  45          * Creates an instance of this login class
  46          *
  47          * @return      $loginInstance  An instance of this login class
  48          */
  49         public final static function createShipSimuUserLogin () {
  50                 // Get a new instance
  51                 $loginInstance = new ShipSimuUserLogin();
  52
  53                 // Return the instance
  54                 return $loginInstance;
  55         }
  56
  57         /**
  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.
  61          *
  62          * @param       $requestInstance        An instance of a Requestable class
  63          * @param       $responseInstance       An instance of a Responseable class
  64          * @return      void
  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
  69          * @todo        user account.
  70          */
  71         public function doLogin (Requestable $requestInstance, Responseable $responseInstance) {
  72                 // By default no method is selected
  73                 $method = null;
  74                 $data = "";
  75
  76                 // Get member class
  77                 $userClass = $this->getConfigInstance()->readConfig('user_class');
  78
  79                 // Get a user instance
  80                 $userInstance = call_user_func_array(array($userClass, 'createMemberByRequest'), array($requestInstance));
  81
  82                 // Remember this new instance in registry
  83                 Registry::getRegistry()->addInstance('user', $userInstance);
  84
  85                 // Is the password correct?
  86                 if ($userInstance->ifPasswordHashMatches($requestInstance) === false) {
  87                         // Mismatching password
  88                         $userInstance->debugInstance();
  89                         throw new UserPasswordMismatchException(array($this, $userInstance), BaseUser::EXCEPTION_USER_PASS_MISMATCH);
  90                 } // END - if
  91
  92                 // ToDo place
  93
  94                 // Now do the real login. This can be cookie- or session-based login
  95                 // which depends on the admins setting then on the user's taste.
  96                 // 1) Get a login helper instance
  97                 $helperInstance = ObjectFactory::createObjectByConfiguredName('login_helper_class', array($requestInstance));
  98
  99                 // 2) Execute the login. This will now login...
 100                 $helperInstance->executeLogin($responseInstance);
 101         }
 102
 103         /**
 104          * Determines wether the login was fine. This is done by checking if 'login' instance is in registry
 105          *
 106          * @return      $loginDone      Wether the login was fine or not
 107          */
 108         public function ifLoginWasSuccessfull () {
 109                 // Is the registry key there?
 110                 $loginDone = (Registry::getRegistry()->getInstance('login') instanceof Registerable);
 111
 112                 // Return the result
 113                 return $loginDone;
 114         }
 115
 116         /**
 117          * Encrypt given request key or throw an exception if key was not found in
 118          * request
 119          *
 120          * @param       $requestKey             Key in request class
 121          * @return      void
 122          */
 123         public function encryptPassword ($requestKey) {
 124                 // Check if password is found in request
 125                 if ($this->getRequestInstance()->isRequestElementSet($requestKey)) {
 126                         // So encrypt the password and store it for later usage in
 127                         // the request:
 128
 129                         // Get the plain password
 130                         $plainPassword = $this->getRequestInstance()->getRequestElement($requestKey);
 131
 132                         // Get user instance
 133                         $userInstance = Registry::getRegistry()->getInstance('user');
 134
 135                         // Get a crypto helper and hash the password
 136                         $this->hashedPassword = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($plainPassword, $userInstance->getPasswordHash());
 137
 138                         // Store the hash back in request
 139                         $this->getRequestInstance()->setRequestElement('pass_hash', $this->hashedPassword);
 140                 } // END - if
 141         }
 142 }
 143
 144 // [EOF]
 145 ?>