3 * A concrete filter for verfying the username. This filter may intercept the
4 * filter chain if no username is given or if the supplied username has an
5 * invalid form. It could also intercept the filter chain if the username was
8 * @author Roland Haeder <webmaster@ship-simu.org>
10 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
11 * @license GNU GPL 3.0 or any newer version
12 * @link http://www.ship-simu.org
14 * This program is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 class UserNameVerifierFilter extends BaseFilter implements Filterable {
29 * Protected constructor
33 protected function __construct () {
34 // Call parent constructor
35 parent::__construct(__CLASS__);
37 // Set part description
38 $this->setObjectDescription("A filter for username verification");
40 // Create unique ID number
41 $this->generateUniqueId();
45 * Creates an instance of this filter class
47 * @return $filterInstance An instance of this filter class
49 public final static function createUserNameVerifierFilter () {
51 $filterInstance = new UserNameVerifierFilter();
53 // Return the instance
54 return $filterInstance;
58 * Executes the filter with given request and response objects
60 * @param $requestInstance An instance of a class with an Requestable interface
61 * @param $responseInstance An instance of a class with an Responseable interface
64 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
65 // Get username from request
66 $userName = $requestInstance->getRequestElement('username');
68 // Is the username set?
69 if (is_null($userName)) {
70 // Not found in form so stop the filtering process
71 $requestInstance->requestIsValid(false);
73 // Add a message to the response
74 $responseInstance->addFatalMessage('username_unset');
78 } elseif (empty($userName)) {
80 $requestInstance->requestIsValid(false);
82 // Add a message to the response
83 $responseInstance->addFatalMessage('username_empty');
87 } elseif (!$this->ifUserNameIsTaken($userName)) {
88 // Username is already taken
89 $requestInstance->requestIsValid(false);
91 // Add a message to the response
92 $responseInstance->addFatalMessage('username_not_found');
100 * Check wether the username as already been taken
102 * @param $userName Username to check for existence
103 * @return $alreadyTaken Wether the username has been taken
105 private function ifUserNameIsTaken ($userName) {
106 // Default is already taken
107 $alreadyTaken = true;
109 // Initialize instance
110 $userInstance = null;
112 // Get a registry instance
113 $registry = Registry::getRegistry();
115 // Is the user already there?
116 if ($registry->instanceExists('user')) {
117 // Use the instance for checking for the email
118 $userInstance = $registry->getInstance('user');
119 $userInstance->setUserName($userName);
121 // If this instance is created then the username *does* exist
123 // Get a new instance
124 $userInstance = call_user_func_array(array($this->getConfigInstance()->readConfig('user_class'), "createUserByUsername"), array($userName));
126 // Remember this user instance in our registry for later usage
127 $registry->addInstance('user', $userInstance);
128 } catch (UsernameMissingException $e) {
129 // User was not found
133 // Does the username exist?
134 if ((is_null($userInstance)) || (!$userInstance->ifUsernameExists())) {
135 // This username is still available
136 $alreadyTaken = false;
140 return $alreadyTaken;