3 * A concrete filter for verfying the guest username. This filter may intercept the
4 * filter chain if no username is given or if supplied username has an invalid
5 * form. It could also intercept our filter chain if username was not found.
7 * @author Roland Haeder <webmaster@ship-simu.org>
9 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
10 * @license GNU GPL 3.0 or any newer version
11 * @link http://www.ship-simu.org
13 * This program is free software: you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation, either version 3 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 class UserGuestVerifierFilter extends BaseFilter implements Filterable {
28 * Protected constructor
32 protected function __construct () {
33 // Call parent constructor
34 parent::__construct(__CLASS__);
38 * Creates an instance of this filter class
40 * @param $controllerInstance An instance of a Controller class
41 * @return $filterInstance An instance of this filter class
43 public final static function createUserGuestVerifierFilter (Controller $controllerInstance) {
45 $filterInstance = new UserGuestVerifierFilter();
48 $filterInstance->setControllerInstance($controllerInstance);
50 // Return the instance
51 return $filterInstance;
55 * Executes the filter with given request and response objects
57 * @param $requestInstance An instance of a class with an Requestable interface
58 * @param $responseInstance An instance of a class with an Responseable interface
61 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
62 // Get username from request
63 $userName = $requestInstance->getRequestElement('user');
65 // Is the username set?
66 if (is_null($userName)) {
67 // Not found in form so stop the filtering process
68 $requestInstance->requestIsValid(false);
70 // Add a message to the response
71 $responseInstance->addFatalMessage('username_guest_unset');
75 } elseif (empty($userName)) {
77 $requestInstance->requestIsValid(false);
79 // Add a message to the response
80 $responseInstance->addFatalMessage('username_guest_empty');
84 } elseif ($this->ifUserGuestIsTaken($userName) === false) {
85 // Username is already taken
86 $requestInstance->requestIsValid(false);
88 // Add a message to the response
89 $responseInstance->addFatalMessage('username_guest_not_found');
95 // Set the element for compatiblity reasons
96 $requestInstance->setRequestElement('username', $userName);
100 * Check wether the username as already been taken
102 * @param $userName Username to check for existence
103 * @return $alreadyTaken Wether the username has been taken
105 private function ifUserGuestIsTaken ($userName) {
106 // Default is already taken
107 $alreadyTaken = true;
109 // Initialize instance
110 $userInstance = null;
112 // Get a registry instance
113 $registry = Registry::getRegistry();
115 // Is the user already there?
116 if ($registry->instanceExists('user')) {
117 // Use the instance for checking for the email
118 $userInstance = $registry->getInstance('user');
119 $userInstance->setUserGuest($userName);
121 // If this instance is created then the username *does* exist
123 // Get a new instance
124 $userInstance = call_user_func_array(array($this->getConfigInstance()->readConfig('guest_class'), 'createGuestByUsername'), array($userName));
126 // Remember this user instance in our registry for later usage
127 $registry->addInstance('user', $userInstance);
128 } catch (UsernameMissingException $e) {
129 // User was not found
133 // Does the username exist?
134 if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === false)) {
135 // This username is still available
136 $alreadyTaken = false;
140 return $alreadyTaken;