inc/classes/main/filter/verifier/class_UserGuestVerifierFilter.php

   1 <?php
   2 /**
   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.
   6  *
   7  * @author              Roland Haeder <webmaster@ship-simu.org>
   8  * @version             0.0.0
   9  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
  10  * @license             GNU GPL 3.0 or any newer version
  11  * @link                http://www.ship-simu.org
  12  *
  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.
  17  *
  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.
  22  *
  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/>.
  25  */
  26 class UserGuestVerifierFilter extends BaseFilter implements Filterable {
  27         /**
  28          * Protected constructor
  29          *
  30          * @return      void
  31          */
  32         protected function __construct () {
  33                 // Call parent constructor
  34                 parent::__construct(__CLASS__);
  35         }
  36
  37         /**
  38          * Creates an instance of this filter class
  39          *
  40          * @return      $filterInstance                 An instance of this filter class
  41          */
  42         public static final function createUserGuestVerifierFilter () {
  43                 // Get a new instance
  44                 $filterInstance = new UserGuestVerifierFilter();
  45
  46                 // Return the instance
  47                 return $filterInstance;
  48         }
  49
  50         /**
  51          * Executes the filter with given request and response objects
  52          *
  53          * @param       $requestInstance        An instance of a class with an Requestable interface
  54          * @param       $responseInstance       An instance of a class with an Responseable interface
  55          * @return      void
  56          * @throws      FilterChainException    If this filter fails to operate
  57          */
  58         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  59                 // Get username from request
  60                 $userName = $requestInstance->getRequestElement('user');
  61
  62                 // Is the username set?
  63                 if (is_null($userName)) {
  64                         // Not found in form so stop the filtering process
  65                         $requestInstance->requestIsValid(false);
  66
  67                         // Add a message to the response
  68                         $responseInstance->addFatalMessage('username_guest_unset');
  69
  70                         // Abort here
  71                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  72                 } elseif (empty($userName)) {
  73                         // Empty field!
  74                         $requestInstance->requestIsValid(false);
  75
  76                         // Add a message to the response
  77                         $responseInstance->addFatalMessage('username_guest_empty');
  78
  79                         // Abort here
  80                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  81                 } elseif ($this->ifUserGuestIsTaken($userName) === false) {
  82                         // Username is already taken
  83                         $requestInstance->requestIsValid(false);
  84
  85                         // Add a message to the response
  86                         $responseInstance->addFatalMessage('username_guest_not_found');
  87
  88                         // Abort here
  89                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  90                 }
  91
  92                 // Set the element for compatiblity reasons
  93                 $requestInstance->setRequestElement('username', $userName);
  94         }
  95
  96         /**
  97          * Check whether the username as already been taken
  98          *
  99          * @param       $userName               Username to check for existence
 100          * @return      $alreadyTaken   Whether the username has been taken
 101          */
 102         private function ifUserGuestIsTaken ($userName) {
 103                 // Default is already taken
 104                 $alreadyTaken = true;
 105
 106                 // Initialize instance
 107                 $userInstance = NULL;
 108
 109                 // Get a registry instance
 110                 $registry = Registry::getRegistry();
 111
 112                 // Is the user already there?
 113                 if ($registry->instanceExists('user')) {
 114                         // Use the instance for checking for the email
 115                         $userInstance = $registry->getInstance('user');
 116                         $userInstance->setUserGuest($userName);
 117                 } else {
 118                         // If this instance is created then the username *does* exist
 119                         try {
 120                                 // Get a new instance
 121                                 $userInstance = call_user_func_array(array($this->getConfigInstance()->getConfigEntry('guest_class'), 'createGuestByUsername'), array($userName));
 122
 123                                 // Remember this user instance in our registry for later usage
 124                                 $registry->addInstance('user', $userInstance);
 125                         } catch (UsernameMissingException $e) {
 126                                 // User was not found
 127                         }
 128                 }
 129
 130                 // Does the username exist?
 131                 if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === false)) {
 132                         // This username is still available
 133                         $alreadyTaken = false;
 134                 }
 135
 136                 // Return the result
 137                 return $alreadyTaken;
 138         }
 139 }
 140
 141 // [EOF]
 142 ?>