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

   1 <?php
   2 /**
   3  * A special guest 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, 2009 Ship-Simu 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 ShipSimuGuestLogin 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 final static function createShipSimuGuestLogin () {
  46                 // Get a new instance
  47                 $loginInstance = new ShipSimuGuestLogin();
  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      UserAuthMethodException If wether username nor email login
  62          *                                                                              was detected
  63          * @throws      MissingMethodException          If a method was not found in the
  64          *                                                                              User class
  65          * @throws      UserPasswordMismatchException   If the supplied password did not
  66          *                                                                              match with the stored password
  67          */
  68         public function doLogin (Requestable $requestInstance, Responseable $responseInstance) {
  69                 // By default no method is selected
  70                 $method = null;
  71                 $data = "";
  72
  73                 // Detect login method (username or email) and try to get a userinstance
  74                 if (!is_null($requestInstance->getRequestElement('user'))) {
  75                         // Username found!
  76                         $method = 'createGuestByUsername';
  77                         $data = $requestInstance->getRequestElement('user');
  78                 } // END - if
  79
  80                 // Is a method detected?
  81                 if (is_null($method)) {
  82                         // Then abort here
  83                         throw new UserAuthMethodException($this, self::EXCEPTION_MISSING_METHOD);
  84                 } elseif (!method_exists($this->getConfigInstance()->getConfigEntry('guest_class'), $method)) {
  85                         // The method is invalid!
  86                         throw new MissingMethodException(array($this, $method), self::EXCEPTION_MISSING_METHOD);
  87                 }
  88
  89                 // Get a user instance
  90                 $userInstance = call_user_func_array(array($this->getConfigInstance()->getConfigEntry('guest_class'), $method), array($data));
  91
  92                 // Remember this new instance in registry
  93                 Registry::getRegistry()->addInstance('user', $userInstance);
  94
  95                 // Is the password correct?
  96                 if ($userInstance->ifPasswordHashMatches($requestInstance) === false) {
  97                         // Mismatching password
  98                         throw new UserPasswordMismatchException(array($this, $userInstance), BaseUser::EXCEPTION_USER_PASS_MISMATCH);
  99                 } // END - if
 100
 101                 // Now do the real login. This can be cookie- or session-based login
 102                 // which depends on the admins setting then on the user's taste.
 103                 // 1) Get a login helper instance
 104                 $helperInstance = ObjectFactory::createObjectByConfiguredName('login_helper_class', array($requestInstance));
 105
 106                 // 2) Execute the login. This will now login...
 107                 $helperInstance->executeLogin($responseInstance);
 108         }
 109
 110         /**
 111          * Determines wether the login was fine. This is done by checking if 'login' instance is in registry
 112          *
 113          * @return      $loginDone      Wether the login was fine or not
 114          */
 115         public function ifLoginWasSuccessfull () {
 116                 // Is the registry key there?
 117                 $loginDone = (Registry::getRegistry()->getInstance('login') instanceof Registerable);
 118
 119                 // Return the result
 120                 return $loginDone;
 121         }
 122
 123         /**
 124          * Encrypt given request key or throw an exception if key was not found in
 125          * request
 126          *
 127          * @param       $requestKey             Key in request class
 128          * @return      void
 129          */
 130         public function encryptPassword ($requestKey) {
 131                 // Check if password is found in request
 132                 if ($this->getRequestInstance()->isRequestElementSet($requestKey)) {
 133                         // So encrypt the password and store it for later usage in
 134                         // the request:
 135
 136                         // Get the plain password
 137                         $plainPassword = $this->getRequestInstance()->getRequestElement($requestKey);
 138
 139                         // Get user instance
 140                         $userInstance = Registry::getRegistry()->getInstance('user');
 141
 142                         // Get a crypto helper and hash the password
 143                         $this->hashedPassword = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($plainPassword, $userInstance->getPasswordHash());
 144
 145                         // Store the hash back in request
 146                         $this->getRequestInstance()->setRequestElement('pass_hash', $this->hashedPassword);
 147                 } // END - if
 148         }
 149 }
 150
 151 // [EOF]
 152 ?>