3 namespace Org\Mxchange\CoreFramework\Filter\Validator\Username;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
8 use Org\Mxchange\CoreFramework\Filter\Chain\FilterChainException;
9 use Org\Mxchange\CoreFramework\Filter\Filterable;
10 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
11 use Org\Mxchange\CoreFramework\Request\Requestable;
12 use Org\Mxchange\CoreFramework\Response\Responseable;
13 use Org\Mxchange\CoreFramework\User\UsernameMissingException;
16 * A concrete filter for validating the username. This filter may intercept the
17 * filter chain if no username is given or if supplied username has an invalid
18 * form. It could also intercept our filter chain if username is already taken.
20 * @author Roland Haeder <webmaster@shipsimu.org>
22 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2021 Core Developer Team
23 * @license GNU GPL 3.0 or any newer version
24 * @link http://www.shipsimu.org
26 * This program is free software: you can redistribute it and/or modify
27 * it under the terms of the GNU General Public License as published by
28 * the Free Software Foundation, either version 3 of the License, or
29 * (at your option) any later version.
31 * This program is distributed in the hope that it will be useful,
32 * but WITHOUT ANY WARRANTY; without even the implied warranty of
33 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
34 * GNU General Public License for more details.
36 * You should have received a copy of the GNU General Public License
37 * along with this program. If not, see <http://www.gnu.org/licenses/>.
39 class UserNameValidatorFilter extends BaseFilter implements Filterable {
41 * Protected constructor
45 private function __construct () {
46 // Call parent constructor
47 parent::__construct(__CLASS__);
51 * Creates an instance of this filter class
53 * @return $filterInstance An instance of this filter class
55 public static final function createUserNameValidatorFilter () {
57 $filterInstance = new UserNameValidatorFilter();
59 // Return the instance
60 return $filterInstance;
64 * Executes the filter with given request and response objects
66 * @param $requestInstance An instance of a class with an Requestable interface
67 * @param $responseInstance An instance of a class with an Responseable interface
69 * @throws FilterChainException If this filter fails to operate
71 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
72 // Get username from request
73 $userName = $requestInstance->getRequestElement('username');
75 // Is the username set?
76 if (is_null($userName)) {
77 // Not found in form so stop the filtering process
78 $requestInstance->requestIsValid(false);
80 // Add a message to the response
81 $responseInstance->addFatalMessage('username_unset');
84 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
85 } elseif (empty($userName)) {
87 $requestInstance->requestIsValid(false);
89 // Add a message to the response
90 $responseInstance->addFatalMessage('username_empty');
93 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
94 } elseif ($this->ifUserNameIsTaken($userName)) {
95 // Username is already taken
96 $requestInstance->requestIsValid(false);
98 // Add a message to the response
99 $responseInstance->addFatalMessage('username_taken');
102 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
107 * Check whether the username as already been taken
109 * @param $userName Username to check for existence
110 * @return $alreadyTaken Whether the username has been taken
112 private function ifUserNameIsTaken ($userName) {
113 // Default is already taken
114 $alreadyTaken = true;
116 // Initialize instance
117 $userInstance = NULL;
119 // Get a registry instance
120 $registry = GenericRegistry::getRegistry();
122 // Is the user already there?
123 if ($registry->instanceExists('user')) {
124 // Use the instance for checking for the email
125 $userInstance = $registry->getInstance('user');
126 $userInstance->setUserName($userName);
128 // If this instance is created then the username *does* exist
130 // Get a new instance
131 $userInstance = call_user_func_array(array(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('user_class'), 'createMemberByUsername'), array($userName));
133 // Remember this user instance in our registry for later usage
134 $registry->addInstance('user', $userInstance);
135 } catch (UsernameMissingException $e) {
136 // User was not found
140 // Does the username exist?
141 if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === false)) {
142 // This username is still available
143 $alreadyTaken = false;
147 return $alreadyTaken;