b61db662e2aa0cbbe05d3d2e8c14656263d8b490
[shipsimu.git] / inc / classes / main / filter / verifier / class_UserNameVerifierFilter.php
1 <?php
2 /**
3  * A concrete filter for verfying the username. This filter may intercept the
4  * filter chain if no username is given or if supplied username has an invalid
5  * form. It could also intercept our filter chain if username was not found.
6  *
7  * @author              Roland Haeder <webmaster@ship-simu.org>
8  * @version             0.0.0
9  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
10  * @license             GNU GPL 3.0 or any newer version
11  * @link                http://www.ship-simu.org
12  *
13  * This program is free software: you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation, either version 3 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program. If not, see <http://www.gnu.org/licenses/>.
25  */
26 class UserNameVerifierFilter extends BaseFilter implements Filterable {
27         /**
28          * Protected constructor
29          *
30          * @return      void
31          */
32         protected function __construct () {
33                 // Call parent constructor
34                 parent::__construct(__CLASS__);
35         }
36
37         /**
38          * Creates an instance of this filter class
39          *
40          * @return      $filterInstance         An instance of this filter class
41          */
42         public final static function createUserNameVerifierFilter () {
43                 // Get a new instance
44                 $filterInstance = new UserNameVerifierFilter();
45
46                 // Return the instance
47                 return $filterInstance;
48         }
49
50         /**
51          * Executes the filter with given request and response objects
52          *
53          * @param       $requestInstance        An instance of a class with an Requestable interface
54          * @param       $responseInstance       An instance of a class with an Responseable interface
55          * @return      void
56          */
57         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
58                 // Get username from request
59                 $userName = $requestInstance->getRequestElement('username');
60
61                 // Is the username set?
62                 if (is_null($userName)) {
63                         // Not found in form so stop the filtering process
64                         $requestInstance->requestIsValid(false);
65
66                         // Add a message to the response
67                         $responseInstance->addFatalMessage('username_unset');
68
69                         // Abort here
70                         return false;
71                 } elseif (empty($userName)) {
72                         // Empty field!
73                         $requestInstance->requestIsValid(false);
74
75                         // Add a message to the response
76                         $responseInstance->addFatalMessage('username_empty');
77
78                         // Abort here
79                         return false;
80                 } elseif ($this->ifUserNameIsTaken($userName) === false) {
81                         // Username is already taken
82                         $requestInstance->requestIsValid(false);
83
84                         // Add a message to the response
85                         $responseInstance->addFatalMessage('username_not_found');
86
87                         // Abort here
88                         return false;
89                 }
90         }
91
92         /**
93          * Check wether the username as already been taken
94          *
95          * @param       $userName               Username to check for existence
96          * @return      $alreadyTaken   Wether the username has been taken
97          */
98         private function ifUserNameIsTaken ($userName) {
99                 // Default is already taken
100                 $alreadyTaken = true;
101
102                 // Initialize instance
103                 $userInstance = null;
104
105                 // Get a registry instance
106                 $registry = Registry::getRegistry();
107
108                 // Is the user already there?
109                 if ($registry->instanceExists('user')) {
110                         // Use the instance for checking for the email
111                         $userInstance = $registry->getInstance('user');
112                         $userInstance->setUserName($userName);
113                 } else {
114                         // If this instance is created then the username *does* exist
115                         try {
116                                 // Get a new instance
117                                 $userInstance = call_user_func_array(array($this->getConfigInstance()->readConfig('user_class'), 'createMemberByUsername'), array($userName));
118
119                                 // Remember this user instance in our registry for later usage
120                                 $registry->addInstance('user', $userInstance);
121                         } catch (UsernameMissingException $e) {
122                                 // User was not found
123                         }
124                 }
125
126                 // Does the username exist?
127                 if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === false)) {
128                         // This username is still available
129                         $alreadyTaken = false;
130                 } // END - if
131
132                 // Return the result
133                 return $alreadyTaken;
134         }
135 }
136
137 // [EOF]
138 ?>