3 namespace Org\Mxchange\CoreFramework\Filter\Verifier\User;
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;
15 * A concrete filter for verfying the guest username. This filter may intercept the
16 * filter chain if no username is given or if supplied username has an invalid
17 * form. It could also intercept our filter chain if username was not found.
19 * @author Roland Haeder <webmaster@shipsimu.org>
21 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2022 Core Developer Team
22 * @license GNU GPL 3.0 or any newer version
23 * @link http://www.shipsimu.org
25 * This program is free software: you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation, either version 3 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program. If not, see <http://www.gnu.org/licenses/>.
38 class UserGuestVerifierFilter extends BaseFilter implements Filterable {
40 * Protected constructor
44 private function __construct () {
45 // Call parent constructor
46 parent::__construct(__CLASS__);
50 * Creates an instance of this filter class
52 * @return $filterInstance An instance of this filter class
54 public static final function createUserGuestVerifierFilter () {
56 $filterInstance = new UserGuestVerifierFilter();
58 // Return the instance
59 return $filterInstance;
63 * Executes the filter with given request and response objects
65 * @param $requestInstance An instance of a class with an Requestable interface
66 * @param $responseInstance An instance of a class with an Responseable interface
68 * @throws FilterChainException If this filter fails to operate
70 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
71 // Get username from request
72 $userName = $requestInstance->getRequestElement('user');
74 // Is the username set?
75 if (is_null($userName)) {
76 // Not found in form so stop the filtering process
77 $requestInstance->requestIsValid(false);
79 // Add a message to the response
80 $responseInstance->addFatalMessage('username_guest_unset');
83 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
84 } elseif (empty($userName)) {
86 $requestInstance->requestIsValid(false);
88 // Add a message to the response
89 $responseInstance->addFatalMessage('username_guest_empty');
92 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
93 } elseif ($this->ifUserGuestIsTaken($userName) === false) {
94 // Username is already taken
95 $requestInstance->requestIsValid(false);
97 // Add a message to the response
98 $responseInstance->addFatalMessage('username_guest_not_found');
101 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
104 // Set the element for compatiblity reasons
105 $requestInstance->setRequestElement('username', $userName);
109 * Check whether the username as already been taken
111 * @param $userName Username to check for existence
112 * @return $alreadyTaken Whether the username has been taken
114 private function ifUserGuestIsTaken ($userName) {
115 // Default is already taken
116 $alreadyTaken = true;
118 // Initialize instance
119 $userInstance = NULL;
121 // Get a registry instance
122 $registryInstance = GenericRegistry::getRegistry();
124 // Is the user already there?
125 if ($registryInstance->instanceExists('user')) {
126 // Use the instance for checking for the email
127 $userInstance = $registryInstance->getInstance('user');
128 $userInstance->setUserGuest($userName);
130 // If this instance is created then the username *does* exist
132 // Get a new instance
133 $userInstance = call_user_func_array(array(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('guest_class'), 'createGuestByUsername'), array($userName));
135 // Remember this user instance in our registry for later usage
136 $registryInstance->addInstance('user', $userInstance);
137 } catch (UsernameMissingException $e) {
138 // User was not found
142 // Does the username exist?
143 if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === false)) {
144 // This username is still available
145 $alreadyTaken = false;
149 return $alreadyTaken;