inc/classes/main/filter/verifier/class_EmailValidatorFilter.php

   1 <?php
   2 /**
   3  * A concrete filter for validating the email address. This filter may intercept
   4  * the filter chain if no email address is given or if the supplied email has an
   5  * invalid form. It could also intercept the filter chain if the email address
   6  * is already used by some one if configuration requires this.
   7  *
   8  * @author              Roland Haeder <webmaster@ship-simu.org>
   9  * @version             0.0.0
  10  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
  11  * @license             GNU GPL 3.0 or any newer version
  12  * @link                http://www.ship-simu.org
  13  *
  14  * This program is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation, either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  26  */
  27 class EmailValidatorFilter extends BaseFilter implements Filterable {
  28         /**
  29          * Protected constructor
  30          *
  31          * @return      void
  32          */
  33         protected function __construct () {
  34                 // Call parent constructor
  35                 parent::__construct(__CLASS__);
  36
  37                 // Set part description
  38                 $this->setObjectDescription("A filter for Email validation");
  39
  40                 // Create unique ID number
  41                 $this->generateUniqueId();
  42         }
  43
  44         /**
  45          * Creates an instance of this filter class
  46          *
  47          * @return      $filterInstance         An instance of this filter class
  48          */
  49         public final static function createEmailValidatorFilter () {
  50                 // Get a new instance
  51                 $filterInstance = new EmailValidatorFilter();
  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          */
  64         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  65                 // Get Email from request
  66                 $email = $requestInstance->getRequestElement('email');
  67
  68                 // Is the Email set?
  69                 if ((is_null($email)) || ($this->getConfigInstance()->readConfig('register_email_unique') === "Y")) {
  70                         // Try it again
  71                         $email1 = $requestInstance->getRequestElement('email1');
  72                         $email2 = $requestInstance->getRequestElement('email2');
  73
  74                         // Is the email still not set?
  75                         if ((is_null($email1)) || (is_null($email2))) {
  76                                 // Not found in form so stop the filtering process
  77                                 $requestInstance->requestIsValid(false);
  78
  79                                 // Add a message to the response
  80                                 $responseInstance->addFatalMessage('email_unset');
  81
  82                                 // Abort here
  83                                 return false;
  84                         } elseif ((empty($email1)) || (empty($email2))) {
  85                                 // Email is empty
  86                                 $requestInstance->requestIsValid(false);
  87
  88                                 // Is the email empty?
  89                                 if (empty($email1)) {
  90                                         // Add a message to the response
  91                                         $responseInstance->addFatalMessage('email1_empty');
  92                                 } // END - if
  93
  94                                 // Is the confirmation empty?
  95                                 if (empty($email2)) {
  96                                         // Add a message to the response
  97                                         $responseInstance->addFatalMessage('email2_empty');
  98                                 } // END - if
  99
 100                                 // Abort here
 101                                 return false;
 102                         } elseif ($this->ifEmailIsTaken($email1)) {
 103                                 // Email is already taken
 104                                 $requestInstance->requestIsValid(false);
 105
 106                                 // Add a message to the response
 107                                 $responseInstance->addFatalMessage('email_taken');
 108
 109                                 // Abort here
 110                                 return false;
 111                         } elseif ($email1 != $email2) {
 112                                 // Emails didn't match
 113                                 $requestInstance->requestIsValid(false);
 114
 115                                 // Add a message to the response
 116                                 $responseInstance->addFatalMessage('emails_mismatch');
 117
 118                                 // Abort here
 119                                 return false;
 120                         } // END - elseif
 121                 } elseif (empty($email)) {
 122                         // Empty field!
 123                         $requestInstance->requestIsValid(false);
 124
 125                         // Add a message to the response
 126                         $responseInstance->addFatalMessage('email_empty');
 127
 128                         // Abort here
 129                         return false;
 130                 } // END - elseif
 131         }
 132
 133         /**
 134          * Check wether the email as already been taken
 135          *
 136          * @param       $email                  Email to check for existence
 137          * @return      $alreadyTaken   Wether the email has been taken
 138          */
 139         private function ifEmailIsTaken ($email) {
 140                 // Default is already taken
 141                 $alreadyTaken = true;
 142
 143                 // Initialize instance
 144                 $userInstance = null;
 145
 146                 // Get a registry instance
 147                 $registry = Registry::getRegistry();
 148
 149                 // Is the user already there?
 150                 if ($registry->instanceExists('user')) {
 151                         // Use the instance for checking for the email
 152                         $userInstance = $registry->getInstance('user');
 153                         $userInstance->setEmailAddress($email);
 154                 } else {
 155                         // If this instance is created then the username *does* exist
 156                         $userInstance = call_user_func_array(array($this->getConfigInstance()->readConfig('user_class'), "createUserByEmail"), array($email));
 157
 158                         // Remember this user instance in our registry for later usage
 159                         $registry->addInstance('user', $userInstance);
 160                 }
 161
 162                 // Does the email exist?
 163                 if (!$userInstance->ifEmailAddressExists()) {
 164                         // This email has not being used yet
 165                         $alreadyTaken = false;
 166                 }
 167
 168                 // Return the result
 169                 return $alreadyTaken;
 170         }
 171 }
 172
 173 // [EOF]
 174 ?>