3 namespace CoreFramework\Filter\Verifier\User;
5 // Import framework stuff
6 use CoreFramework\Filter\BaseFilter;
7 use CoreFramework\Registry\Registry;
8 use CoreFramework\Request\Requestable;
9 use CoreFramework\Response\Responseable;
12 * A concrete filter for verfying the guest username. This filter may intercept the
13 * filter chain if no username is given or if supplied username has an invalid
14 * form. It could also intercept our filter chain if username was not found.
16 * @author Roland Haeder <webmaster@shipsimu.org>
18 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
19 * @license GNU GPL 3.0 or any newer version
20 * @link http://www.shipsimu.org
22 * This program is free software: you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License as published by
24 * the Free Software Foundation, either version 3 of the License, or
25 * (at your option) any later version.
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU General Public License for more details.
32 * You should have received a copy of the GNU General Public License
33 * along with this program. If not, see <http://www.gnu.org/licenses/>.
35 class UserGuestVerifierFilter extends BaseFilter implements Filterable {
37 * Protected constructor
41 protected function __construct () {
42 // Call parent constructor
43 parent::__construct(__CLASS__);
47 * Creates an instance of this filter class
49 * @return $filterInstance An instance of this filter class
51 public static final function createUserGuestVerifierFilter () {
53 $filterInstance = new UserGuestVerifierFilter();
55 // Return the instance
56 return $filterInstance;
60 * Executes the filter with given request and response objects
62 * @param $requestInstance An instance of a class with an Requestable interface
63 * @param $responseInstance An instance of a class with an Responseable interface
65 * @throws FilterChainException If this filter fails to operate
67 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
68 // Get username from request
69 $userName = $requestInstance->getRequestElement('user');
71 // Is the username set?
72 if (is_null($userName)) {
73 // Not found in form so stop the filtering process
74 $requestInstance->requestIsValid(FALSE);
76 // Add a message to the response
77 $responseInstance->addFatalMessage('username_guest_unset');
80 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
81 } elseif (empty($userName)) {
83 $requestInstance->requestIsValid(FALSE);
85 // Add a message to the response
86 $responseInstance->addFatalMessage('username_guest_empty');
89 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
90 } elseif ($this->ifUserGuestIsTaken($userName) === FALSE) {
91 // Username is already taken
92 $requestInstance->requestIsValid(FALSE);
94 // Add a message to the response
95 $responseInstance->addFatalMessage('username_guest_not_found');
98 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
101 // Set the element for compatiblity reasons
102 $requestInstance->setRequestElement('username', $userName);
106 * Check whether the username as already been taken
108 * @param $userName Username to check for existence
109 * @return $alreadyTaken Whether the username has been taken
111 private function ifUserGuestIsTaken ($userName) {
112 // Default is already taken
113 $alreadyTaken = TRUE;
115 // Initialize instance
116 $userInstance = NULL;
118 // Get a registry instance
119 $registry = Registry::getRegistry();
121 // Is the user already there?
122 if ($registry->instanceExists('user')) {
123 // Use the instance for checking for the email
124 $userInstance = $registry->getInstance('user');
125 $userInstance->setUserGuest($userName);
127 // If this instance is created then the username *does* exist
129 // Get a new instance
130 $userInstance = call_user_func_array(array($this->getConfigInstance()->getConfigEntry('guest_class'), 'createGuestByUsername'), array($userName));
132 // Remember this user instance in our registry for later usage
133 $registry->addInstance('user', $userInstance);
134 } catch (UsernameMissingException $e) {
135 // User was not found
139 // Does the username exist?
140 if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === FALSE)) {
141 // This username is still available
142 $alreadyTaken = FALSE;
146 return $alreadyTaken;