File indexing completed on 2024-05-12 06:03:13

 <?php
 /**
  * Zend Framework
  *
  * LICENSE
  *
  * This source file is subject to the new BSD license that is bundled
  * with this package in the file LICENSE.txt.
  * It is also available through the world-wide-web at this URL:
  * http://framework.zend.com/license/new-bsd
  * If you did not receive a copy of the license and are unable to
  * obtain it through the world-wide-web, please send an email
  * to license@zend.com so we can send you a copy immediately.
  *
  * @category   Zend
  * @package    Zend_Validate
  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  * @version    $Id$
  */
 
 /**
  * @see Zend_Validate_Abstract
  */
 // require_once 'Zend/Validate/Abstract.php';
 
 /**
  * @see Zend_Validate_Hostname
  */
 // require_once 'Zend/Validate/Hostname.php';
 
 /**
  * @category   Zend
  * @package    Zend_Validate
  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 class Zend_Validate_EmailAddress extends Zend_Validate_Abstract
 {
     const INVALID            = 'emailAddressInvalid';
     const INVALID_FORMAT     = 'emailAddressInvalidFormat';
     const INVALID_HOSTNAME   = 'emailAddressInvalidHostname';
     const INVALID_MX_RECORD  = 'emailAddressInvalidMxRecord';
     const INVALID_SEGMENT    = 'emailAddressInvalidSegment';
     const DOT_ATOM           = 'emailAddressDotAtom';
     const QUOTED_STRING      = 'emailAddressQuotedString';
     const INVALID_LOCAL_PART = 'emailAddressInvalidLocalPart';
     const LENGTH_EXCEEDED    = 'emailAddressLengthExceeded';
 
     /**
      * @var array
      */
     protected $_messageTemplates = array(
         self::INVALID            => "Invalid type given. String expected",
         self::INVALID_FORMAT     => "'%value%' is not a valid email address in the basic format local-part@hostname",
         self::INVALID_HOSTNAME   => "'%hostname%' is not a valid hostname for email address '%value%'",
         self::INVALID_MX_RECORD  => "'%hostname%' does not appear to have a valid MX record for the email address '%value%'",
         self::INVALID_SEGMENT    => "'%hostname%' is not in a routable network segment. The email address '%value%' should not be resolved from public network",
         self::DOT_ATOM           => "'%localPart%' can not be matched against dot-atom format",
         self::QUOTED_STRING      => "'%localPart%' can not be matched against quoted-string format",
         self::INVALID_LOCAL_PART => "'%localPart%' is not a valid local part for email address '%value%'",
         self::LENGTH_EXCEEDED    => "'%value%' exceeds the allowed length",
     );
 
     /**
      * As of RFC5753 (JAN 2010), the following blocks are no longer reserved:
      *   - 128.0.0.0/16
      *   - 191.255.0.0/16
      *   - 223.255.255.0/24
      * @see http://tools.ietf.org/html/rfc5735#page-6
      *
      * As of RFC6598 (APR 2012), the following blocks are now reserved:
      *   - 100.64.0.0/10
      * @see http://tools.ietf.org/html/rfc6598#section-7
      *
      * @see http://en.wikipedia.org/wiki/IPv4
      * @var array
      */
     protected $_invalidIp = array(
         '0'   => '0.0.0.0/8',
         '10'  => '10.0.0.0/8',
         '100' => '100.64.0.0/10',
         '127' => '127.0.0.0/8',
         '169' => '169.254.0.0/16',
         '172' => '172.16.0.0/12',
         '192' => array(
             '192.0.0.0/24',
             '192.0.2.0/24',
             '192.88.99.0/24',
             '192.168.0.0/16'
         ),
         '198' => '198.18.0.0/15',
         '224' => '224.0.0.0/4',
         '240' => '240.0.0.0/4'
     );
 
     /**
      * @var array
      */
     protected $_messageVariables = array(
         'hostname'  => '_hostname',
         'localPart' => '_localPart'
     );
 
     /**
      * @var string
      */
     protected $_hostname;
 
     /**
      * @var string
      */
     protected $_localPart;
 
     /**
      * Internal options array
      */
     protected $_options = array(
         'mx'       => false,
         'deep'     => false,
         'domain'   => true,
         'allow'    => Zend_Validate_Hostname::ALLOW_DNS,
         'hostname' => null
     );
 
     /**
      * Instantiates hostname validator for local use
      *
      * The following option keys are supported:
      * 'hostname' => A hostname validator, see Zend_Validate_Hostname
      * 'allow'    => Options for the hostname validator, see Zend_Validate_Hostname::ALLOW_*
      * 'mx'       => If MX check should be enabled, boolean
      * 'deep'     => If a deep MX check should be done, boolean
      *
      * @param array|string|Zend_Config $options OPTIONAL
      */
     public function __construct($options = array())
     {
         if ($options instanceof Zend_Config) {
             $options = $options->toArray();
         } else if (!is_array($options)) {
             $options = func_get_args();
             $temp['allow'] = array_shift($options);
             if (!empty($options)) {
                 $temp['mx'] = array_shift($options);
             }
 
             if (!empty($options)) {
                 $temp['hostname'] = array_shift($options);
             }
 
             $options = $temp;
         }
 
         $options += $this->_options;
         $this->setOptions($options);
     }
 
     /**
      * Returns all set Options
      *
      * @return array
      */
     public function getOptions()
     {
         return $this->_options;
     }
 
     /**
      * Set options for the email validator
      *
      * @param array $options
      * @return Zend_Validate_EmailAddress Provides a fluent inteface
      */
     public function setOptions(array $options = array())
     {
         if (array_key_exists('messages', $options)) {
             $this->setMessages($options['messages']);
         }
 
         if (array_key_exists('hostname', $options)) {
             if (array_key_exists('allow', $options)) {
                 $this->setHostnameValidator($options['hostname'], $options['allow']);
             } else {
                 $this->setHostnameValidator($options['hostname']);
             }
         } elseif ($this->_options['hostname'] == null) {
             $this->setHostnameValidator();
         }
 
         if (array_key_exists('mx', $options)) {
             $this->setValidateMx($options['mx']);
         }
 
         if (array_key_exists('deep', $options)) {
             $this->setDeepMxCheck($options['deep']);
         }
 
         if (array_key_exists('domain', $options)) {
             $this->setDomainCheck($options['domain']);
         }
 
         return $this;
     }
 
     /**
      * Sets the validation failure message template for a particular key
      * Adds the ability to set messages to the attached hostname validator
      *
      * @param  string $messageString
      * @param  string $messageKey     OPTIONAL
      * @return Zend_Validate_Abstract Provides a fluent interface
      * @throws Zend_Validate_Exception
      */
     public function setMessage($messageString, $messageKey = null)
     {
         if ($messageKey === null) {
             $this->_options['hostname']->setMessage($messageString);
             parent::setMessage($messageString);
             return $this;
         }
 
         if (!isset($this->_messageTemplates[$messageKey])) {
             $this->_options['hostname']->setMessage($messageString, $messageKey);
         }
 
         $this->_messageTemplates[$messageKey] = $messageString;
         return $this;
     }
 
     /**
      * Returns the set hostname validator
      *
      * @return Zend_Validate_Hostname
      */
     public function getHostnameValidator()
     {
         return $this->_options['hostname'];
     }
 
     /**
      * @param Zend_Validate_Hostname $hostnameValidator OPTIONAL
      * @param int                    $allow             OPTIONAL
      * @return $this
      */
     public function setHostnameValidator(Zend_Validate_Hostname $hostnameValidator = null, $allow = Zend_Validate_Hostname::ALLOW_DNS)
     {
         if (!$hostnameValidator) {
             $hostnameValidator = new Zend_Validate_Hostname($allow);
         }
 
         $this->_options['hostname'] = $hostnameValidator;
         $this->_options['allow']    = $allow;
         return $this;
     }
 
     /**
      * Whether MX checking via getmxrr is supported or not
      *
      * This currently only works on UNIX systems
      *
      * @return boolean
      */
     public function validateMxSupported()
     {
         return function_exists('getmxrr');
     }
 
     /**
      * Returns the set validateMx option
      *
      * @return boolean
      */
     public function getValidateMx()
     {
         return $this->_options['mx'];
     }
 
     /**
      * Set whether we check for a valid MX record via DNS
      *
      * This only applies when DNS hostnames are validated
      *
      * @param boolean $mx Set allowed to true to validate for MX records, and false to not validate them
      * @throws Zend_Validate_Exception
      * @return Zend_Validate_EmailAddress Provides a fluent inteface
      */
     public function setValidateMx($mx)
     {
         if ((bool) $mx && !$this->validateMxSupported()) {
             // require_once 'Zend/Validate/Exception.php';
             throw new Zend_Validate_Exception('MX checking not available on this system');
         }
 
         $this->_options['mx'] = (bool) $mx;
         return $this;
     }
 
     /**
      * Returns the set deepMxCheck option
      *
      * @return boolean
      */
     public function getDeepMxCheck()
     {
         return $this->_options['deep'];
     }
 
     /**
      * Set whether we check MX record should be a deep validation
      *
      * @param boolean $deep Set deep to true to perform a deep validation process for MX records
      * @return Zend_Validate_EmailAddress Provides a fluent inteface
      */
     public function setDeepMxCheck($deep)
     {
         $this->_options['deep'] = (bool) $deep;
         return $this;
     }
 
     /**
      * Returns the set domainCheck option
      *
      * @return unknown
      */
     public function getDomainCheck()
     {
         return $this->_options['domain'];
     }
 
     /**
      * Sets if the domain should also be checked
      * or only the local part of the email address
      *
      * @param boolean $domain
      * @return Zend_Validate_EmailAddress Provides a fluent inteface
      */
     public function setDomainCheck($domain = true)
     {
         $this->_options['domain'] = (boolean) $domain;
         return $this;
     }
 
     /**
      * Returns if the given host is reserved
      *
      * @param string $host
      * @return boolean
      */
     private function _isReserved($host){
         if (!preg_match('/^([0-9]{1,3}\.){3}[0-9]{1,3}$/', $host)) {
             $host = gethostbyname($host);
         }
 
         $octet = explode('.',$host);
         if ((int)$octet[0] >= 224) {
             return true;
         } else if (array_key_exists($octet[0], $this->_invalidIp)) {
             foreach ((array)$this->_invalidIp[$octet[0]] as $subnetData) {
                 // we skip the first loop as we already know that octet matches
                 for ($i = 1; $i < 4; $i++) {
                     if (strpos($subnetData, $octet[$i]) !== $i * 4) {
                         break;
                     }
                 }
 
                 $host       = explode("/", $subnetData);
                 $binaryHost = "";
                 $tmp        = explode(".", $host[0]);
                 for ($i = 0; $i < 4 ; $i++) {
                     $binaryHost .= str_pad(decbin($tmp[$i]), 8, "0", STR_PAD_LEFT);
                 }
 
                 $segmentData = array(
                     'network'   => (int)$this->_toIp(str_pad(substr($binaryHost, 0, $host[1]), 32, 0)),
                     'broadcast' => (int)$this->_toIp(str_pad(substr($binaryHost, 0, $host[1]), 32, 1))
                 );
 
                 for ($j = $i; $j < 4; $j++) {
                     if ((int)$octet[$j] < $segmentData['network'][$j] ||
                         (int)$octet[$j] > $segmentData['broadcast'][$j]) {
                         return false;
                     }
                 }
             }
 
             return true;
         } else {
             return false;
         }
     }
 
     /**
      * Converts a binary string to an IP address
      *
      * @param string $binary
      * @return mixed
      */
     private function _toIp($binary)
     {
         $ip  = array();
         $tmp = explode(".", chunk_split($binary, 8, "."));
         for ($i = 0; $i < 4 ; $i++) {
             $ip[$i] = bindec($tmp[$i]);
         }
 
         return $ip;
     }
 
     /**
      * Internal method to validate the local part of the email address
      *
      * @return boolean
      */
     private function _validateLocalPart()
     {
         // First try to match the local part on the common dot-atom format
         $result = false;
 
         // Dot-atom characters are: 1*atext *("." 1*atext)
         // atext: ALPHA / DIGIT / and "!", "#", "$", "%", "&", "'", "*",
         //        "+", "-", "/", "=", "?", "^", "_", "`", "{", "|", "}", "~"
         $atext = 'a-zA-Z0-9\x21\x23\x24\x25\x26\x27\x2a\x2b\x2d\x2f\x3d\x3f\x5e\x5f\x60\x7b\x7c\x7d\x7e';
         if (preg_match('/^[' . $atext . ']+(\x2e+[' . $atext . ']+)*$/', $this->_localPart)) {
             $result = true;
         } else {
             // Try quoted string format (RFC 5321 Chapter 4.1.2)
 
             // Quoted-string characters are: DQUOTE *(qtext/quoted-pair) DQUOTE
             $qtext      = '\x20-\x21\x23-\x5b\x5d-\x7e'; // %d32-33 / %d35-91 / %d93-126
             $quotedPair = '\x20-\x7e'; // %d92 %d32-126
             if (preg_match('/^"(['. $qtext .']|\x5c[' . $quotedPair . '])*"$/', $this->localPart)) {
                 $result = true;
             } else {
                 $this->_error(self::DOT_ATOM);
                 $this->_error(self::QUOTED_STRING);
                 $this->_error(self::INVALID_LOCAL_PART);
             }
         }
 
         return $result;
     }
 
     /**
      * Internal method to validate the servers MX records
      *
      * @return boolean
      */
     private function _validateMXRecords()
     {
         $mxHosts = array();
         $hostname = $this->_hostname;
 
         //decode IDN domain name if possible
         if (function_exists('idn_to_ascii')) {
             $hostname = idn_to_ascii($this->_hostname);
         }
 
         $result = getmxrr($hostname, $mxHosts);
         if (!$result) {
             $this->_error(self::INVALID_MX_RECORD);
         } else if ($this->_options['deep'] && function_exists('checkdnsrr')) {
             $validAddress = false;
             $reserved     = true;
             foreach ($mxHosts as $hostname) {
                 $res = $this->_isReserved($hostname);
                 if (!$res) {
                     $reserved = false;
                 }
 
                 if (!$res
                     && (checkdnsrr($hostname, "A")
                     || checkdnsrr($hostname, "AAAA")
                     || checkdnsrr($hostname, "A6"))) {
                     $validAddress = true;
                     break;
                 }
             }
 
             if (!$validAddress) {
                 $result = false;
                 if ($reserved) {
                     $this->_error(self::INVALID_SEGMENT);
                 } else {
                     $this->_error(self::INVALID_MX_RECORD);
                 }
             }
         }
 
         return $result;
     }
 
     /**
      * Internal method to validate the hostname part of the email address
      *
      * @return boolean
      */
     private function _validateHostnamePart()
     {
         $hostname = $this->_options['hostname']->setTranslator($this->getTranslator())
                          ->isValid($this->_hostname);
         if (!$hostname) {
             $this->_error(self::INVALID_HOSTNAME);
 
             // Get messages and errors from hostnameValidator
             foreach ($this->_options['hostname']->getMessages() as $code => $message) {
                 $this->_messages[$code] = $message;
             }
 
             foreach ($this->_options['hostname']->getErrors() as $error) {
                 $this->_errors[] = $error;
             }
         } else if ($this->_options['mx']) {
             // MX check on hostname
             $hostname = $this->_validateMXRecords();
         }
 
         return $hostname;
     }
 
     /**
      * Defined by Zend_Validate_Interface
      *
      * Returns true if and only if $value is a valid email address
      * according to RFC2822
      *
      * @link   http://www.ietf.org/rfc/rfc2822.txt RFC2822
      * @link   http://www.columbia.edu/kermit/ascii.html US-ASCII characters
      * @param  string $value
      * @return boolean
      */
     public function isValid($value)
     {
         if (!is_string($value)) {
             $this->_error(self::INVALID);
             return false;
         }
 
         $matches = array();
         $length  = true;
         $this->_setValue($value);
 
         // Split email address up and disallow '..'
         if ((strpos($value, '..') !== false) or
             (!preg_match('/^(.+)@([^@]+)$/', $value, $matches))) {
             $this->_error(self::INVALID_FORMAT);
             return false;
         }
 
         $this->_localPart = $matches[1];
         $this->_hostname  = $matches[2];
 
         if ((strlen($this->_localPart) > 64) || (strlen($this->_hostname) > 255)) {
             $length = false;
             $this->_error(self::LENGTH_EXCEEDED);
         }
 
         // Match hostname part
         if ($this->_options['domain']) {
             $hostname = $this->_validateHostnamePart();
         }
 
         $local = $this->_validateLocalPart();
 
         // If both parts valid, return true
         if ($local && $length) {
             if (($this->_options['domain'] && $hostname) || !$this->_options['domain']) {
                 return true;
             }
         }
 
         return false;
     }
 }