application/city/classes/commands/html/class_CityHtmlCityUserLoginCommand.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Command;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Command\BaseCommand;
   7 use Org\Mxchange\CoreFramework\Command\Commandable;
   8 use Org\Mxchange\CoreFramework\Controller\Controller;
   9 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
  10 use Org\Mxchange\CoreFramework\Request\Requestable;
  11 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
  12 use Org\Mxchange\CoreFramework\Response\Responseable;
  13
  14 /**
  15  * A command for user login
  16  *
  17  * @author              Roland Haeder <webmaster@shipsimu.org>
  18  * @version             0.0.0
  19  * @copyright   Copyright (c) 2015 - 2023 City Developer Team
  20  * @license             GNU GPL 3.0 or any newer version
  21  * @link                http://www.shipsimu.org
  22  *
  23  * This program is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation, either version 3 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  35  */
  36 class CityHtmlCityUserLoginCommand extends BaseCommand implements Commandable {
  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 command and sets the resolver instance
  49          *
  50          * @param       $resolverInstance       An instance of a command resolver
  51          * @return      $commandInstance        The created command instance
  52          */
  53         public static final function createCityHtmlCityUserLoginCommand (CommandResolver $resolverInstance) {
  54                 // Get a new instance
  55                 $commandInstance = new CityHtmlCityUserLoginCommand();
  56
  57                 // Set the resolver instance
  58                 $commandInstance->setResolverInstance($resolverInstance);
  59
  60                 // Return the prepared instance
  61                 return $commandInstance;
  62         }
  63
  64         /**
  65          * Executes the command with given request and response objects
  66          *
  67          * @param       $requestInstance        An instance of a class with an Requestable interface
  68          * @param       $responseInstance       An instance of a class with an Responseable interface
  69          * @return      void
  70          */
  71         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  72                 // First get a UserLogin instance
  73                 $loginInstance = ObjectFactory::createObjectByConfiguredName('user_login_class');
  74
  75                 // Encrypt the password
  76                 $loginInstance->encryptPassword('pass');
  77
  78                 // Do the login here
  79                 $loginInstance->doLogin($requestInstance, $responseInstance);
  80
  81                 // Was the login fine? Then redirect here
  82                 if ($loginInstance->ifLoginWasSuccessfull()) {
  83                         // Try to redirect here
  84                         try {
  85                                 // Redirect...
  86                                 $responseInstance->redirectToConfiguredUrl('app_login');
  87
  88                                 // Exit here
  89                                 exit();
  90                         } catch (FrameworkException $e) {
  91                                 // Something went wrong here!
  92                                 $responseInstance->addFatalMessage($e->getMessage());
  93                         }
  94                 } else {
  95                         // Attach error message to the response
  96                         $responseInstance->addFatalMessage('failed_user_login');
  97                 }
  98         }
  99
 100         /**
 101          * Adds extra filters to the given controller instance
 102          *
 103          * @param       $controllerInstance             A controller instance
 104          * @param       $requestInstance                An instance of a class with an Requestable interface
 105          * @return      void
 106          * @todo        Add more filters
 107          */
 108         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 109                 // Which login type do we have?
 110                 switch (FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('login_type')) {
 111                         case 'username': // Login via username
 112                                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_verifier_filter_class'));
 113                                 break;
 114
 115                         case 'email': // Login via email
 116                                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_verifier_filter_class'));
 117                                 break;
 118
 119                         default: // Wether username or email is set
 120                                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_email_verifier_filter_class'));
 121                                 break;
 122                 }
 123
 124                 // Password verifier filter
 125                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('password_verifier_filter_class'));
 126
 127                 // Add filter for CAPTCHA
 128                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('captcha_user_verifier_filter_class'));
 129         }
 130 }