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          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set part description
  35                 $this->setObjectDescription("Login for Ship-Simu");
  36
  37                 // Create unique ID number
  38                 $this->generateUniqueId();
  39
  40                 // Clean up a little
  41                 $this->removeNumberFormaters();
  42                 $this->removeSystemArray();
  43         }
  44
  45         /**
  46          * Creates an instance of this login class
  47          *
  48          * @return      $loginInstance  An instance of this login class
  49          */
  50         public final static function createShipSimuUserLogin () {
  51                 // Get a new instance
  52                 $loginInstance = new ShipSimuUserLogin();
  53
  54                 // Return the instance
  55                 return $loginInstance;
  56         }
  57
  58         /**
  59          * Logins the user with the given request containing the credential. The
  60          * result of the login can be thrown by exception or, if prefered stored
  61          * in a boolean attribute which is then readable by a matching getter.
  62          *
  63          * @param       $requestInstance        An instance of a Requestable class
  64          * @param       $responseInstance       An instance of a Responseable class
  65          * @return      void
  66          * @throws      UserAuthMethodException If wether username nor email login
  67          *                                                                              was detected
  68          * @throws      MissingMethodException          If a method was not found in the
  69          *                                                                              User class
  70          * @throws      UserPasswordMismatchException   If the supplied password did not
  71          *                                                                              match with the stored password
  72          */
  73         public function doLogin (Requestable $requestInstance, Responseable $responseInstance) {
  74                 // By default no method is selected
  75                 $method = null;
  76                 $data = "";
  77
  78                 // Detect login method (username or email) and try to get a userinstance
  79                 if (!is_null($requestInstance->getRequestElement('username'))) {
  80                         // Username found!
  81                         $method = "createUserByUsername";
  82                         $data = $requestInstance->getRequestElement('username');
  83                 } elseif (!is_null($requestInstance->getRequestElement('email'))) {
  84                         // Email found!
  85                         $method = "createUserByEmail";
  86                         $data = $requestInstance->getRequestElement('email');
  87                 }
  88
  89                 // Is a method detected?
  90                 if (is_null($method)) {
  91                         // Then abort here
  92                         throw new UserAuthMethodException($this, self::EXCEPTION_MISSING_METHOD);
  93                 } elseif (!method_exists($this->getConfigInstance()->readConfig('user_class'), $method)) {
  94                         // The method is invalid!
  95                         throw new MissingMethodException(array($this, $method), self::EXCEPTION_MISSING_METHOD);
  96                 }
  97
  98                 // Get a instance of the registry
  99                 $userInstance = Registry::getRegistry()->getInstance('user');
 100
 101                 // Is there an instance?
 102                 if (is_null($userInstance)) {
 103                         // Get a user instance
 104                         $userInstance = call_user_func_array(array($this->getConfigInstance()->readConfig('user_class'), $method), array($data));
 105
 106                         // Remember this new instance in registry
 107                         Registry::getRegistry()->addInstance($userInstance);
 108                 } // END - if
 109
 110                 // Is the password correct?
 111                 if (!$userInstance->ifPasswordHashMatches($requestInstance)) {
 112                         // Mismatching password
 113                         throw new UserPasswordMismatchException(array($this, $userInstance), User::EXCEPTION_USER_PASS_MISMATCH);
 114                 } // END - if
 115
 116                 // Now do the real login. This can be cookie- or session-based login
 117                 // which depends on the admins setting then on the user's taste.
 118                 // 1) Get a login helper instance
 119                 $helperInstance = ObjectFactory::createObjectByConfiguredName('login_helper_class', array($requestInstance));
 120
 121                 // 2) Execute the login. This will now login...
 122                 $helperInstance->executeLogin($responseInstance);
 123         }
 124
 125         /**
 126          * Determines wether the login was fine. This is done by checking if the 'login' instance is in registry
 127          *
 128          * @return      $loginDone      Wether the login was fine or not
 129          */
 130         public function ifLoginWasSuccessfull () {
 131                 // Is the registry key there?
 132                 $loginDone = (Registry::getRegistry()->getInstance('login') instanceof Registerable);
 133
 134                 // Return the result
 135                 return $loginDone;
 136         }
 137 }
 138
 139 // [EOF]
 140 ?>