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__);
34 // Set part description
35 $this->setObjectDescription("User login handling command for Ship-Simu");
37 // Create unique ID number
38 $this->generateUniqueId();
41 $this->removeNumberFormaters();
42 $this->removeSystemArray();
46 * Creates an instance of this command and sets the resolver instance
48 * @param $resolverInstance An instance of a command resolver
49 * @return $commandInstance The created command instance
51 public final static function createWebShipsimuUserLoginCommand (CommandResolver $resolverInstance) {
53 $commandInstance = new WebShipsimuUserLoginCommand();
55 // Set the resolver instance
56 $commandInstance->setResolverInstance($resolverInstance);
58 // Get the controller instance from the resolver (breaks MVC pattern again)
59 $controllerInstance = $resolverInstance->getControllerInstance();
61 switch ($commandInstance->getConfigInstance()->readConfig('login_type')) {
62 case "username": // Login via username
63 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_verifier_class'));
66 case "email": // Login via email
67 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_verifier_class'));
70 default: // Wether username or email is set
71 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_email_verifier_class'));
74 // @TODO Add more filters
75 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('password_verifier_class'));
77 // Return the prepared instance
78 return $commandInstance;
82 * Executes the command with given request and response objects
84 * @param $requestInstance An instance of a class with an Requestable interface
85 * @param $responseInstance An instance of a class with an Responseable interface
88 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
89 // First get a UserLogin instance
90 $loginInstance = ObjectFactory::createObjectByConfiguredName('user_login_class');
92 // First set request and response instance
93 $loginInstance->setRequestInstance($requestInstance);
95 // Encrypt the password
96 $loginInstance->encryptPassword('pass');
99 $loginInstance->doLogin($requestInstance, $responseInstance);
101 // Was the login fine? Then redirect here
102 if ($loginInstance->ifLoginWasSuccessfull()) {
103 // Try to redirect here
105 $responseInstance->redirectToConfiguredUrl('app_login_url');
106 } catch (FrameworkException $e) {
107 // Something went wrong here!
108 $responseInstance->addFatalMessage($e->getMessage());
111 // Attach error message to the response
112 $responseInstance->addFatalMessage('failed_user_login');