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