3 * A command for user login
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class WebShipsimuUserLoginCommand extends BaseCommand implements Commandable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->removeNumberFormaters();
36 $this->removeSystemArray();
40 * Creates an instance of this command and sets the resolver instance
42 * @param $resolverInstance An instance of a command resolver
43 * @return $commandInstance The created command instance
45 public final static function createWebShipsimuUserLoginCommand (CommandResolver $resolverInstance) {
47 $commandInstance = new WebShipsimuUserLoginCommand();
49 // Set the resolver instance
50 $commandInstance->setResolverInstance($resolverInstance);
52 // Return the prepared instance
53 return $commandInstance;
57 * Executes the command with given request and response objects
59 * @param $requestInstance An instance of a class with an Requestable interface
60 * @param $responseInstance An instance of a class with an Responseable interface
63 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
64 // First get a UserLogin instance
65 $loginInstance = ObjectFactory::createObjectByConfiguredName('user_login_class');
67 // First set request and response instance
68 $loginInstance->setRequestInstance($requestInstance);
70 // Encrypt the password
71 $loginInstance->encryptPassword('pass');
74 $loginInstance->doLogin($requestInstance, $responseInstance);
76 // Was the login fine? Then redirect here
77 if ($loginInstance->ifLoginWasSuccessfull()) {
78 // Try to redirect here
80 $responseInstance->redirectToConfiguredUrl('app_login_url');
81 } catch (FrameworkException $e) {
82 // Something went wrong here!
83 $responseInstance->addFatalMessage($e->getMessage());
86 // Attach error message to the response
87 $responseInstance->addFatalMessage('failed_user_login');
92 * Adds extra filters to the given controller instance
94 * @param $controllerInstance A controller instance
95 * @param $requestInstance An instance of a class with an Requestable interface
97 * @todo Add more filters
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'));
106 case "email": // Login via email
107 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_verifier_class'));
110 default: // Wether username or email is set
111 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_email_verifier_class'));
115 // Password verifier filter
116 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('password_verifier_class'));
118 // Add filter for CAPTCHA
119 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('captcha_user_verifier_class'));