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