3 namespace CoreFramework\Filter\Verifier\User;
5 // Import framework stuff
6 use CoreFramework\Registry\Generic\Registry;
7 use CoreFramework\Request\Requestable;
10 * A concrete filter for verfying the username. This filter may intercept the
11 * filter chain if no username is given or if supplied username has an invalid
12 * form. It could also intercept our filter chain if username was not found.
14 * @author Roland Haeder <webmaster@shipsimu.org>
16 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.shipsimu.org
20 * This program is free software: you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation, either version 3 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 class UserNameVerifierFilter extends BaseFilter implements Filterable {
35 * Protected constructor
39 protected function __construct () {
40 // Call parent constructor
41 parent::__construct(__CLASS__);
45 * Creates an instance of this filter class
47 * @return $filterInstance An instance of this filter class
49 public static final 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
63 * @throws FilterChainException If this filter fails to operate
65 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
66 // Get username from request
67 $userName = $requestInstance->getRequestElement('username');
69 // Is the username set?
70 if (is_null($userName)) {
71 // Not found in form so stop the filtering process
72 $requestInstance->requestIsValid(FALSE);
74 // Add a message to the response
75 $responseInstance->addFatalMessage('username_unset');
78 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
79 } elseif (empty($userName)) {
81 $requestInstance->requestIsValid(FALSE);
83 // Add a message to the response
84 $responseInstance->addFatalMessage('username_empty');
87 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
88 } elseif ($this->ifUserNameIsTaken($userName) === FALSE) {
89 // Username is already taken
90 $requestInstance->requestIsValid(FALSE);
92 // Add a message to the response
93 $responseInstance->addFatalMessage('username_not_found');
96 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
101 * Check whether the username as already been taken
103 * @param $userName Username to check for existence
104 * @return $alreadyTaken Whether the username has been taken
106 private function ifUserNameIsTaken ($userName) {
107 // Default is already taken
108 $alreadyTaken = TRUE;
110 // Initialize instance
111 $userInstance = NULL;
113 // Get a registry instance
114 $registry = Registry::getRegistry();
116 // Is the user already there?
117 if ($registry->instanceExists('user')) {
118 // Use the instance for checking for the email
119 $userInstance = $registry->getInstance('user');
120 $userInstance->setUserName($userName);
122 // If this instance is created then the username *does* exist
124 // Get a new instance
125 $userInstance = call_user_func_array(array($this->getConfigInstance()->getConfigEntry('user_class'), 'createMemberByUsername'), array($userName));
127 // Remember this user instance in our registry for later usage
128 $registry->addInstance('user', $userInstance);
129 } catch (UsernameMissingException $e) {
130 // User was not found
134 // Does the username exist?
135 if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === FALSE)) {
136 // This username is still available
137 $alreadyTaken = FALSE;
141 return $alreadyTaken;