application/city/classes/login/class_CityGuestLogin.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Login\Guest;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Request\Requestable;
   7 use Org\Mxchange\CoreFramework\Response\Responseable;
   8
   9 /**
  10  * A special guest login class for City
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2015, 2016 City Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.shipsimu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class CityGuestLogin extends BaseFrameworkSystem implements LoginableUser, Registerable {
  32         /**
  33          * The hashed password
  34          */
  35         private $hashedPassword = '';
  36
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Creates an instance of this login class
  49          *
  50          * @return      $loginInstance  An instance of this login class
  51          */
  52         public static final function createCityGuestLogin () {
  53                 // Get a new instance
  54                 $loginInstance = new CityGuestLogin();
  55
  56                 // Return the instance
  57                 return $loginInstance;
  58         }
  59
  60         /**
  61          * Logins the user with the given request containing the credential. The
  62          * result of the login can be thrown by exception or, if prefered stored
  63          * in a boolean attribute which is then readable by a matching getter.
  64          *
  65          * @param       $requestInstance        An instance of a Requestable class
  66          * @param       $responseInstance       An instance of a Responseable class
  67          * @return      void
  68          * @throws      UserPasswordMismatchException   If the supplied password did not
  69          *                                                                              match with the stored password
  70          */
  71         public function doLogin (Requestable $requestInstance, Responseable $responseInstance) {
  72                 // Get a user instance
  73                 $userInstance = UserFactory::createUserByRequest($requestInstance);
  74
  75                 // Remember this new instance in registry
  76                 Registry::getRegistry()->addInstance('user', $userInstance);
  77
  78                 // Is the password correct?
  79                 if ($userInstance->ifPasswordHashMatches($requestInstance) === FALSE) {
  80                         // Mismatching password
  81                         throw new UserPasswordMismatchException(array($this, $userInstance), BaseUser::EXCEPTION_USER_PASS_MISMATCH);
  82                 } // END - if
  83
  84                 // Now do the real login. This can be cookie- or session-based login
  85                 // which depends on the admins setting then on the user's taste.
  86                 // 1) Get a login helper instance
  87                 $helperInstance = ObjectFactory::createObjectByConfiguredName('login_helper_class', array($requestInstance));
  88
  89                 // 2) Execute the login. This will now login...
  90                 $helperInstance->executeLogin($responseInstance);
  91         }
  92
  93         /**
  94          * Check if the implementation is correct. Only the request instance is
  95          * needed as no redirect is done here.
  96          *
  97          * @param       $requestInstance        An instance of a Requestable class
  98          * @return
  99          */
 100         public function testLogin (Requestable $requestInstance) {
 101                 // Create dummy instance
 102                 $dummyInstance = Guest::createGuestByRequest($requestInstance);
 103         }
 104
 105         /**
 106          * Determines wether the login was fine. This is done by checking if 'login' instance is in registry
 107          *
 108          * @return      $loginDone      Wether the login was fine or not
 109          */
 110         public function ifLoginWasSuccessfull () {
 111                 // Is the registry key there?
 112                 $loginDone = (Registry::getRegistry()->getInstance('login') instanceof Registerable);
 113
 114                 // Return the result
 115                 return $loginDone;
 116         }
 117
 118         /**
 119          * Encrypt given request key or throw an exception if key was not found in
 120          * request
 121          *
 122          * @param       $requestKey             Key in request class
 123          * @return      void
 124          */
 125         public function encryptPassword ($requestKey) {
 126                 // Check if password is found in request
 127                 if ($this->getRequestInstance()->isRequestElementSet($requestKey)) {
 128                         // So encrypt the password and store it for later usage in
 129                         // the request:
 130
 131                         // Get the plain password
 132                         $plainPassword = $this->getRequestInstance()->getRequestElement($requestKey);
 133
 134                         // Get user instance
 135                         $userInstance = Registry::getRegistry()->getInstance('user');
 136
 137                         // Get a crypto helper and hash the password
 138                         $this->hashedPassword = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($plainPassword, $userInstance->getPasswordHash());
 139
 140                         // Store the hash back in request
 141                         $this->getRequestInstance()->setRequestElement('pass_hash', $this->hashedPassword);
 142                 } // END - if
 143         }
 144 }