6a2ab504c3d6151643f56c378dcf52d2983f851c
[shipsimu.git] / 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                 // Get the controller instance from the resolver (breaks MVC pattern again)
59                 $controllerInstance = $resolverInstance->getControllerInstance();
60
61                 switch ($commandInstance->getConfigInstance()->readConfig('login_type')) {
62                         case "username": // Login via username
63                                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_verifier_class'));
64                                 break;
65
66                         case "email": // Login via email
67                                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_verifier_class'));
68                                 break;
69
70                         default: // Wether username or email is set
71                                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_email_verifier_class'));
72                                 break;
73                 }
74
75                 /* @TODO Add more filters */
76                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('password_verifier_class'));
77
78                 // Return the prepared instance
79                 return $commandInstance;
80         }
81
82         /**
83          * Executes the command with given request and response objects
84          *
85          * @param       $requestInstance        An instance of a class with an Requestable interface
86          * @param       $responseInstance       An instance of a class with an Responseable interface
87          * @return      void
88          */
89         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
90                 // First get a UserLogin instance
91                 $loginInstance = ObjectFactory::createObjectByConfiguredName('user_login_class');
92
93                 // First set request and response instance
94                 $loginInstance->setRequestInstance($requestInstance);
95
96                 // Encrypt the password
97                 $loginInstance->encryptPassword('pass');
98
99                 // Do the login here
100                 $loginInstance->doLogin($requestInstance, $responseInstance);
101
102                 // Was the login fine? Then redirect here
103                 if ($loginInstance->ifLoginWasSuccessfull()) {
104                         // Try to redirect here
105                         try {
106                                 $responseInstance->redirectToConfiguredUrl('app_login_url');
107                         } catch (FrameworkException $e) {
108                                 // Something went wrong here!
109                                 $responseInstance->addFatalMessage($e->getMessage());
110                         }
111                 } else {
112                         // Attach error message to the response
113                         $responseInstance->addFatalMessage('failed_user_login');
114                 }
115         }
116 }
117
118 // [EOF]
119 ?>