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\Filterable;
8 use Org\Mxchange\CoreFramework\Registry\Registry;
9 use Org\Mxchange\CoreFramework\Request\Requestable;
10 use Org\Mxchange\CoreFramework\Response\Responseable;
13 * A concrete filter for verfying the guest username. This filter may intercept the
14 * filter chain if no username is given or if supplied username has an invalid
15 * form. It could also intercept our filter chain if username was not found.
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 <<<<<<< HEAD:framework/main/classes/filter/verifier/class_UserGuestVerifierFilter.php
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
22 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
23 >>>>>>> Some updates::inc/main/classes/filter/verifier/class_UserGuestVerifierFilter.php
24 * @license GNU GPL 3.0 or any newer version
25 * @link http://www.shipsimu.org
27 * This program is free software: you can redistribute it and/or modify
28 * it under the terms of the GNU General Public License as published by
29 * the Free Software Foundation, either version 3 of the License, or
30 * (at your option) any later version.
32 * This program is distributed in the hope that it will be useful,
33 * but WITHOUT ANY WARRANTY; without even the implied warranty of
34 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35 * GNU General Public License for more details.
37 * You should have received a copy of the GNU General Public License
38 * along with this program. If not, see <http://www.gnu.org/licenses/>.
40 class UserGuestVerifierFilter extends BaseFilter implements Filterable {
42 * Protected constructor
46 protected function __construct () {
47 // Call parent constructor
48 parent::__construct(__CLASS__);
52 * Creates an instance of this filter class
54 * @return $filterInstance An instance of this filter class
56 public static final function createUserGuestVerifierFilter () {
58 $filterInstance = new UserGuestVerifierFilter();
60 // Return the instance
61 return $filterInstance;
65 * Executes the filter with given request and response objects
67 * @param $requestInstance An instance of a class with an Requestable interface
68 * @param $responseInstance An instance of a class with an Responseable interface
70 * @throws FilterChainException If this filter fails to operate
72 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
73 // Get username from request
74 $userName = $requestInstance->getRequestElement('user');
76 // Is the username set?
77 if (is_null($userName)) {
78 // Not found in form so stop the filtering process
79 $requestInstance->requestIsValid(false);
81 // Add a message to the response
82 $responseInstance->addFatalMessage('username_guest_unset');
85 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
86 } elseif (empty($userName)) {
88 $requestInstance->requestIsValid(false);
90 // Add a message to the response
91 $responseInstance->addFatalMessage('username_guest_empty');
94 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
95 } elseif ($this->ifUserGuestIsTaken($userName) === false) {
96 // Username is already taken
97 $requestInstance->requestIsValid(false);
99 // Add a message to the response
100 $responseInstance->addFatalMessage('username_guest_not_found');
103 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
106 // Set the element for compatiblity reasons
107 $requestInstance->setRequestElement('username', $userName);
111 * Check whether the username as already been taken
113 * @param $userName Username to check for existence
114 * @return $alreadyTaken Whether the username has been taken
116 private function ifUserGuestIsTaken ($userName) {
117 // Default is already taken
118 $alreadyTaken = true;
120 // Initialize instance
121 $userInstance = NULL;
123 // Get a registry instance
124 $registry = Registry::getRegistry();
126 // Is the user already there?
127 if ($registry->instanceExists('user')) {
128 // Use the instance for checking for the email
129 $userInstance = $registry->getInstance('user');
130 $userInstance->setUserGuest($userName);
132 // If this instance is created then the username *does* exist
134 // Get a new instance
135 $userInstance = call_user_func_array(array($this->getConfigInstance()->getConfigEntry('guest_class'), 'createGuestByUsername'), array($userName));
137 // Remember this user instance in our registry for later usage
138 $registry->addInstance('user', $userInstance);
139 } catch (UsernameMissingException $e) {
140 // User was not found
144 // Does the username exist?
145 if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === false)) {
146 // This username is still available
147 $alreadyTaken = false;
151 return $alreadyTaken;