<?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-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: EmailAddress.php 8986 2008-03-21 21:38:32Z matthew $
 */

/**
 * @see Zend_Validate_Abstract
 */
require_once 'external/Zend/Validate/Abstract.php';

/**
 * @see Zend_Validate_Hostname
 */
require_once 'external/Zend/Validate/Hostname.php';

/**
 * @category   Zend
 * @package    Zend_Validate
 * @copyright  Copyright (c) 2005-2008 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_HOSTNAME = 'emailAddressInvalidHostname';
  const INVALID_MX_RECORD = 'emailAddressInvalidMxRecord';
  const DOT_ATOM = 'emailAddressDotAtom';
  const QUOTED_STRING = 'emailAddressQuotedString';
  const INVALID_LOCAL_PART = 'emailAddressInvalidLocalPart';
  
  /**
   * @var array
   */
  protected $_messageTemplates = array(
      self::INVALID => "'%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::DOT_ATOM => "'%localPart%' not matched against dot-atom format", 
      self::QUOTED_STRING => "'%localPart%' not matched against quoted-string format", 
      self::INVALID_LOCAL_PART => "'%localPart%' is not a valid local part for email address '%value%'");
  
  /**
   * @var array
   */
  protected $_messageVariables = array('hostname' => '_hostname', 'localPart' => '_localPart');
  
  /**
   * Local object for validating the hostname part of an email address
   *
   * @var Zend_Validate_Hostname
   */
  public $hostnameValidator;
  
  /**
   * Whether we check for a valid MX record via DNS
   *
   * @var boolean
   */
  protected $_validateMx = false;
  
  /**
   * @var string
   */
  protected $_hostname;
  
  /**
   * @var string
   */
  protected $_localPart;

  /**
   * Instantiates hostname validator for local use
   *
   * You can pass a bitfield to determine what types of hostnames are allowed.
   * These bitfields are defined by the ALLOW_* constants in Zend_Validate_Hostname
   * The default is to allow DNS hostnames only
   *
   * @param integer                $allow             OPTIONAL
   * @param bool                   $validateMx        OPTIONAL
   * @param Zend_Validate_Hostname $hostnameValidator OPTIONAL
   * @return void
   */
  public function __construct($allow = Zend_Validate_Hostname::ALLOW_DNS, $validateMx = false, Zend_Validate_Hostname $hostnameValidator = null) {
    $this->setValidateMx($validateMx);
    $this->setHostnameValidator($hostnameValidator, $allow);
  }

  /**
   * @param Zend_Validate_Hostname $hostnameValidator OPTIONAL
   * @param int                    $allow             OPTIONAL
   * @return void
   */
  public function setHostnameValidator(Zend_Validate_Hostname $hostnameValidator = null, $allow = Zend_Validate_Hostname::ALLOW_DNS) {
    if ($hostnameValidator === null) {
      $hostnameValidator = new Zend_Validate_Hostname($allow);
    }
    $this->hostnameValidator = $hostnameValidator;
  }

  /**
   * Whether MX checking via dns_get_mx is supported or not
   *
   * This currently only works on UNIX systems
   *
   * @return boolean
   */
  public function validateMxSupported() {
    return function_exists('dns_get_mx');
  }

  /**
   * Set whether we check for a valid MX record via DNS
   *
   * This only applies when DNS hostnames are validated
   *
   * @param boolean $allowed Set allowed to true to validate for MX records, and false to not validate them
   */
  public function setValidateMx($allowed) {
    $this->_validateMx = (bool)$allowed;
  }

  /**
   * 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) {
    $valueString = (string)$value;
    
    $this->_setValue($valueString);
    
    // Split email address up
    if (! preg_match('/^(.+)@([^@]+)$/', $valueString, $matches)) {
      $this->_error(self::INVALID);
      return false;
    }
    
    $this->_localPart = $matches[1];
    $this->_hostname = $matches[2];
    
    // Match hostname part
    $hostnameResult = $this->hostnameValidator->setTranslator($this->getTranslator())->isValid($this->_hostname);
    if (! $hostnameResult) {
      $this->_error(self::INVALID_HOSTNAME);
      
      // Get messages and errors from hostnameValidator
      foreach ($this->hostnameValidator->getMessages() as $message) {
        $this->_messages[] = $message;
      }
      foreach ($this->hostnameValidator->getErrors() as $error) {
        $this->_errors[] = $error;
      }
    }
    
    // MX check on hostname via dns_get_record()
    if ($this->_validateMx) {
      if ($this->validateMxSupported()) {
        $result = dns_get_mx($this->_hostname, $mxHosts);
        if (count($mxHosts) < 1) {
          $hostnameResult = false;
          $this->_error(self::INVALID_MX_RECORD);
        }
      } else {
        /**
         * MX checks are not supported by this system
         * @see Zend_Validate_Exception
         */
        require_once 'external/Zend/Validate/Exception.php';
        throw new Zend_Validate_Exception('Internal error: MX checking not available on this system');
      }
    }
    
    // First try to match the local part on the common dot-atom format
    $localResult = 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';
    if (preg_match('/^[' . $atext . ']+(\x2e+[' . $atext . ']+)*$/', $this->_localPart)) {
      $localResult = true;
    } else {
      // Try quoted string format
      

      // Quoted-string characters are: DQUOTE *([FWS] qtext/quoted-pair) [FWS] DQUOTE
      // qtext: Non white space controls, and the rest of the US-ASCII characters not
      //   including "\" or the quote character
      $noWsCtl = '\x01-\x08\x0b\x0c\x0e-\x1f\x7f';
      $qtext = $noWsCtl . '\x21\x23-\x5b\x5d-\x7e';
      $ws = '\x20\x09';
      if (preg_match('/^\x22([' . $ws . $qtext . '])*[$ws]?\x22$/', $this->_localPart)) {
        $localResult = true;
      } else {
        $this->_error(self::DOT_ATOM);
        $this->_error(self::QUOTED_STRING);
        $this->_error(self::INVALID_LOCAL_PART);
      }
    }
    
    // If both parts valid, return true
    if ($localResult && $hostnameResult) {
      return true;
    } else {
      return false;
    }
  }

}
