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