framework/main/classes/filter/validator/class_EmailValidatorFilter.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filter\Validator\Email;
   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
  14 /**
  15  * A concrete filter for validating the email address. This filter may intercept
  16  * the filter chain if no email address is given or if supplied email has an
  17  * invalid form. It could also intercept our filter chain if email address is
  18  * already used by some one if configuration requires this.
  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 EmailValidatorFilter 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 createEmailValidatorFilter () {
  56                 // Get a new instance
  57                 $filterInstance = new EmailValidatorFilter();
  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 Email from request
  73                 $email = $requestInstance->getRequestElement('email');
  74
  75                 // Is the Email set?
  76                 if ((is_null($email)) || (FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('register_email_unique') == 'Y')) {
  77                         // Try it again
  78                         $email1 = $requestInstance->getRequestElement('email1');
  79                         $email2 = $requestInstance->getRequestElement('email2');
  80
  81                         // Is the email still not set?
  82                         if ((is_null($email1)) || (is_null($email2))) {
  83                                 // Not found in form so stop the filtering process
  84                                 $requestInstance->requestIsValid(false);
  85
  86                                 // Add a message to the response
  87                                 $responseInstance->addFatalMessage('email_unset');
  88
  89                                 // Abort here
  90                                 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  91                         } elseif ((empty($email1)) || (empty($email2))) {
  92                                 // Email is empty
  93                                 $requestInstance->requestIsValid(false);
  94
  95                                 // Is the email empty?
  96                                 if (empty($email1)) {
  97                                         // Add a message to the response
  98                                         $responseInstance->addFatalMessage('email1_empty');
  99                                 }
 100
 101                                 // Is the confirmation empty?
 102                                 if (empty($email2)) {
 103                                         // Add a message to the response
 104                                         $responseInstance->addFatalMessage('email2_empty');
 105                                 }
 106
 107                                 // Abort here
 108                                 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
 109                         } elseif ($this->ifEmailIsTaken($email1)) {
 110                                 // Email is already taken
 111                                 $requestInstance->requestIsValid(false);
 112
 113                                 // Add a message to the response
 114                                 $responseInstance->addFatalMessage('email_taken');
 115
 116                                 // Abort here
 117                                 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
 118                         } elseif ($email1 != $email2) {
 119                                 // Emails didn't match
 120                                 $requestInstance->requestIsValid(false);
 121
 122                                 // Add a message to the response
 123                                 $responseInstance->addFatalMessage('emails_mismatch');
 124
 125                                 // Abort here
 126                                 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
 127                         } // END - elseif
 128                 } elseif (empty($email)) {
 129                         // Empty field!
 130                         $requestInstance->requestIsValid(false);
 131
 132                         // Add a message to the response
 133                         $responseInstance->addFatalMessage('email_empty');
 134
 135                         // Abort here
 136                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
 137                 } // END - elseif
 138         }
 139
 140         /**
 141          * Check whether the email as already been taken
 142          *
 143          * @param       $email                  Email to check for existence
 144          * @return      $alreadyTaken   Whether the email has been taken
 145          */
 146         private function ifEmailIsTaken ($email) {
 147                 // Default is already taken
 148                 $alreadyTaken = true;
 149
 150                 // Initialize instance
 151                 $userInstance = NULL;
 152
 153                 // Get a registry instance
 154                 $registry = GenericRegistry::getRegistry();
 155
 156                 // Is the user already there?
 157                 if ($registry->instanceExists('user')) {
 158                         // Use the instance for checking for the email
 159                         $userInstance = $registry->getInstance('user');
 160                         $userInstance->setEmailAddress($email);
 161                 } else {
 162                         // If this instance is created then the username *does* exist
 163                         $userInstance = call_user_func_array(array(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('user_class'), 'createMemberByEmail'), array($email));
 164
 165                         // Remember this user instance in our registry for later usage
 166                         $registry->addInstance('user', $userInstance);
 167                 }
 168
 169                 // Does the email exist?
 170                 if ($userInstance->ifEmailAddressExists() === false) {
 171                         // This email has not being used yet
 172                         $alreadyTaken = false;
 173                 }
 174
 175                 // Return the result
 176                 return $alreadyTaken;
 177         }
 178
 179 }