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 use CoreFramework\Request\Requestable;
   8 use CoreFramework\Response\Responseable;
   9
  10 /**
  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.
  14  *
  15  * @author              Roland Haeder <webmaster@shipsimu.org>
  16  * @version             0.0.0
  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
  20  *
  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.
  25  *
  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.
  30  *
  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/>.
  33  */
  34 class UserGuestVerifierFilter extends BaseFilter implements Filterable {
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43         }
  44
  45         /**
  46          * Creates an instance of this filter class
  47          *
  48          * @return      $filterInstance         An instance of this filter class
  49          */
  50         public static final function createUserGuestVerifierFilter () {
  51                 // Get a new instance
  52                 $filterInstance = new UserGuestVerifierFilter();
  53
  54                 // Return the instance
  55                 return $filterInstance;
  56         }
  57
  58         /**
  59          * Executes the filter with given request and response objects
  60          *
  61          * @param       $requestInstance        An instance of a class with an Requestable interface
  62          * @param       $responseInstance       An instance of a class with an Responseable interface
  63          * @return      void
  64          * @throws      FilterChainException    If this filter fails to operate
  65          */
  66         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  67                 // Get username from request
  68                 $userName = $requestInstance->getRequestElement('user');
  69
  70                 // Is the username set?
  71                 if (is_null($userName)) {
  72                         // Not found in form so stop the filtering process
  73                         $requestInstance->requestIsValid(FALSE);
  74
  75                         // Add a message to the response
  76                         $responseInstance->addFatalMessage('username_guest_unset');
  77
  78                         // Abort here
  79                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  80                 } elseif (empty($userName)) {
  81                         // Empty field!
  82                         $requestInstance->requestIsValid(FALSE);
  83
  84                         // Add a message to the response
  85                         $responseInstance->addFatalMessage('username_guest_empty');
  86
  87                         // Abort here
  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);
  92
  93                         // Add a message to the response
  94                         $responseInstance->addFatalMessage('username_guest_not_found');
  95
  96                         // Abort here
  97                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  98                 }
  99
 100                 // Set the element for compatiblity reasons
 101                 $requestInstance->setRequestElement('username', $userName);
 102         }
 103
 104         /**
 105          * Check whether the username as already been taken
 106          *
 107          * @param       $userName               Username to check for existence
 108          * @return      $alreadyTaken   Whether the username has been taken
 109          */
 110         private function ifUserGuestIsTaken ($userName) {
 111                 // Default is already taken
 112                 $alreadyTaken = TRUE;
 113
 114                 // Initialize instance
 115                 $userInstance = NULL;
 116
 117                 // Get a registry instance
 118                 $registry = Registry::getRegistry();
 119
 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);
 125                 } else {
 126                         // If this instance is created then the username *does* exist
 127                         try {
 128                                 // Get a new instance
 129                                 $userInstance = call_user_func_array(array($this->getConfigInstance()->getConfigEntry('guest_class'), 'createGuestByUsername'), array($userName));
 130
 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
 135                         }
 136                 }
 137
 138                 // Does the username exist?
 139                 if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === FALSE)) {
 140                         // This username is still available
 141                         $alreadyTaken = FALSE;
 142                 }
 143
 144                 // Return the result
 145                 return $alreadyTaken;
 146         }
 147
 148 }