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