application/ship-simu/main/commands/web/class_WebShipsimuUserLoginCommand.php

   1 <?php
   2 /**
   3  * A command for user login
   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 WebShipsimuUserLoginCommand extends BaseCommand implements Commandable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Clean up a little
  35                 $this->removeNumberFormaters();
  36                 $this->removeSystemArray();
  37         }
  38
  39         /**
  40          * Creates an instance of this command and sets the resolver instance
  41          *
  42          * @param       $resolverInstance       An instance of a command resolver
  43          * @return      $commandInstance        The created command instance
  44          */
  45         public final static function createWebShipsimuUserLoginCommand (CommandResolver $resolverInstance) {
  46                 // Get a new instance
  47                 $commandInstance = new WebShipsimuUserLoginCommand();
  48
  49                 // Set the resolver instance
  50                 $commandInstance->setResolverInstance($resolverInstance);
  51
  52                 // Return the prepared instance
  53                 return $commandInstance;
  54         }
  55
  56         /**
  57          * Executes the command with given request and response objects
  58          *
  59          * @param       $requestInstance        An instance of a class with an Requestable interface
  60          * @param       $responseInstance       An instance of a class with an Responseable interface
  61          * @return      void
  62          */
  63         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  64                 // First get a UserLogin instance
  65                 $loginInstance = ObjectFactory::createObjectByConfiguredName('user_login_class');
  66
  67                 // First set request and response instance
  68                 $loginInstance->setRequestInstance($requestInstance);
  69
  70                 // Encrypt the password
  71                 $loginInstance->encryptPassword('pass');
  72
  73                 // Do the login here
  74                 $loginInstance->doLogin($requestInstance, $responseInstance);
  75
  76                 // Was the login fine? Then redirect here
  77                 if ($loginInstance->ifLoginWasSuccessfull()) {
  78                         // Try to redirect here
  79                         try {
  80                                 $responseInstance->redirectToConfiguredUrl('app_login_url');
  81                         } catch (FrameworkException $e) {
  82                                 // Something went wrong here!
  83                                 $responseInstance->addFatalMessage($e->getMessage());
  84                         }
  85                 } else {
  86                         // Attach error message to the response
  87                         $responseInstance->addFatalMessage('failed_user_login');
  88                 }
  89         }
  90
  91         /**
  92          * Adds extra filters to the given controller instance
  93          *
  94          * @param       $controllerInstance             A controller instance
  95          * @param       $requestInstance                An instance of a class with an Requestable interface
  96          * @return      void
  97          * @todo        Add more filters
  98          */
  99         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 100                 // Which login type do we have?
 101                 switch ($this->getConfigInstance()->readConfig('login_type')) {
 102                         case "username": // Login via username
 103                                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_verifier_class'));
 104                                 break;
 105
 106                         case "email": // Login via email
 107                                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_verifier_class'));
 108                                 break;
 109
 110                         default: // Wether username or email is set
 111                                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_email_verifier_class'));
 112                                 break;
 113                 }
 114
 115                 // Password verifier filter
 116                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('password_verifier_class'));
 117
 118                 // Add filter for CAPTCHA
 119                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('captcha_user_verifier_class'));
 120         }
 121 }
 122
 123 // [EOF]
 124 ?>