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

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