application/admin/main/login/class_AdminUserLogin.php

   1 <?php
   2 /**
   3  * A special login class for administration area
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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
  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 AdminUserLogin 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
  40         /**
  41          * Creates an instance of this login class
  42          *
  43          * @return      $loginInstance  An instance of this login class
  44          */
  45         public static final function createAdminUserLogin () {
  46                 // Get a new instance
  47                 $loginInstance = new AdminUserLogin();
  48
  49                 // Return the instance
  50                 return $loginInstance;
  51         }
  52
  53         /**
  54          * Logins the user with the given request containing the credential. The
  55          * result of the login can be thrown by exception or, if prefered stored
  56          * in a boolean attribute which is then readable by a matching getter.
  57          *
  58          * @param       $requestInstance        An instance of a Requestable class
  59          * @param       $responseInstance       An instance of a Responseable class
  60          * @return      void
  61          * @throws      UserPasswordMismatchException   If the supplied password did not
  62          *                                                                              match with the stored password
  63          * @todo        We need to add something here which will make more than one
  64          * @todo        guest logins, users who are online but based on the same
  65          * @todo        user account.
  66          */
  67         public function doLogin (Requestable $requestInstance, Responseable $responseInstance) {
  68                 // By default no method is selected
  69                 $method = null;
  70                 $data = "";
  71
  72                 // Get member class
  73                 $userClass = $this->getConfigInstance()->getConfigEntry('user_class');
  74
  75                 // Get a user instance
  76                 $userInstance = call_user_func_array(array($userClass, 'createMemberByRequest'), array($requestInstance));
  77
  78                 // Remember this new instance in registry
  79                 Registry::getRegistry()->addInstance('user', $userInstance);
  80
  81                 // Is the password correct?
  82                 if ($userInstance->ifPasswordHashMatches($requestInstance) === false) {
  83                         // Mismatching password
  84                         throw new UserPasswordMismatchException(array($this, $userInstance), BaseUser::EXCEPTION_USER_PASS_MISMATCH);
  85                 } // END - if
  86
  87                 // ToDo place
  88
  89                 // Now do the real login. This can be cookie- or session-based login
  90                 // which depends on the admins setting then on the user's taste.
  91                 // 1) Get a login helper instance
  92                 $helperInstance = ObjectFactory::createObjectByConfiguredName('login_helper_class', array($requestInstance));
  93
  94                 // 2) Execute the login. This will now login...
  95                 $helperInstance->executeLogin($responseInstance);
  96         }
  97
  98         /**
  99          * Determines wether the login was fine. This is done by checking if 'login' instance is in registry
 100          *
 101          * @return      $loginDone      Wether the login was fine or not
 102          */
 103         public function ifLoginWasSuccessfull () {
 104                 // Is the registry key there?
 105                 $loginDone = (Registry::getRegistry()->getInstance('login') instanceof Registerable);
 106
 107                 // Return the result
 108                 return $loginDone;
 109         }
 110
 111         /**
 112          * Encrypt given request key or throw an exception if key was not found in
 113          * request
 114          *
 115          * @param       $requestKey             Key in request class
 116          * @return      void
 117          */
 118         public function encryptPassword ($requestKey) {
 119                 // Check if password is found in request
 120                 if ($this->getRequestInstance()->isRequestElementSet($requestKey)) {
 121                         // So encrypt the password and store it for later usage in
 122                         // the request:
 123
 124                         // Get the plain password
 125                         $plainPassword = $this->getRequestInstance()->getRequestElement($requestKey);
 126
 127                         // Get user instance
 128                         $userInstance = Registry::getRegistry()->getInstance('user');
 129
 130                         // Get a crypto helper and hash the password
 131                         $this->hashedPassword = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($plainPassword, $userInstance->getPasswordHash());
 132
 133                         // Store the hash back in request
 134                         $this->getRequestInstance()->setRequestElement('pass_hash', $this->hashedPassword);
 135                 } // END - if
 136         }
 137 }
 138
 139 // [EOF]
 140 ?>