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