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

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