3 namespace Org\Mxchange\CoreFramework\Filter\Verifier\User;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
7 use Org\Mxchange\CoreFramework\Filter\Chain\FilterChainException;
8 use Org\Mxchange\CoreFramework\Filter\Filterable;
9 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
10 use Org\Mxchange\CoreFramework\Request\Requestable;
11 use Org\Mxchange\CoreFramework\Response\Responseable;
14 * A concrete filter for verfying the guest username. This filter may intercept the
15 * filter chain if no username is given or if supplied username has an invalid
16 * form. It could also intercept our filter chain if username was not found.
18 * @author Roland Haeder <webmaster@shipsimu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.shipsimu.org
24 * This program is free software: you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation, either version 3 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 class UserGuestVerifierFilter extends BaseFilter implements Filterable {
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
49 * Creates an instance of this filter class
51 * @return $filterInstance An instance of this filter class
53 public static final function createUserGuestVerifierFilter () {
55 $filterInstance = new UserGuestVerifierFilter();
57 // Return the instance
58 return $filterInstance;
62 * Executes the filter with given request and response objects
64 * @param $requestInstance An instance of a class with an Requestable interface
65 * @param $responseInstance An instance of a class with an Responseable interface
67 * @throws FilterChainException If this filter fails to operate
69 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
70 // Get username from request
71 $userName = $requestInstance->getRequestElement('user');
73 // Is the username set?
74 if (is_null($userName)) {
75 // Not found in form so stop the filtering process
76 $requestInstance->requestIsValid(false);
78 // Add a message to the response
79 $responseInstance->addFatalMessage('username_guest_unset');
82 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
83 } elseif (empty($userName)) {
85 $requestInstance->requestIsValid(false);
87 // Add a message to the response
88 $responseInstance->addFatalMessage('username_guest_empty');
91 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
92 } elseif ($this->ifUserGuestIsTaken($userName) === false) {
93 // Username is already taken
94 $requestInstance->requestIsValid(false);
96 // Add a message to the response
97 $responseInstance->addFatalMessage('username_guest_not_found');
100 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
103 // Set the element for compatiblity reasons
104 $requestInstance->setRequestElement('username', $userName);
108 * Check whether the username as already been taken
110 * @param $userName Username to check for existence
111 * @return $alreadyTaken Whether the username has been taken
113 private function ifUserGuestIsTaken ($userName) {
114 // Default is already taken
115 $alreadyTaken = true;
117 // Initialize instance
118 $userInstance = NULL;
120 // Get a registry instance
121 $registry = GenericRegistry::getRegistry();
123 // Is the user already there?
124 if ($registry->instanceExists('user')) {
125 // Use the instance for checking for the email
126 $userInstance = $registry->getInstance('user');
127 $userInstance->setUserGuest($userName);
129 // If this instance is created then the username *does* exist
131 // Get a new instance
132 $userInstance = call_user_func_array(array($this->getConfigInstance()->getConfigEntry('guest_class'), 'createGuestByUsername'), array($userName));
134 // Remember this user instance in our registry for later usage
135 $registry->addInstance('user', $userInstance);
136 } catch (UsernameMissingException $e) {
137 // User was not found
141 // Does the username exist?
142 if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === false)) {
143 // This username is still available
144 $alreadyTaken = false;
148 return $alreadyTaken;