You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
217 lines
8.1 KiB
217 lines
8.1 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\validators; |
|
|
|
use Yii; |
|
use yii\base\ErrorException; |
|
use yii\base\InvalidConfigException; |
|
use yii\helpers\Json; |
|
use yii\web\JsExpression; |
|
|
|
/** |
|
* EmailValidator validates that the attribute value is a valid email address. |
|
* |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
class EmailValidator extends Validator |
|
{ |
|
/** |
|
* @var string the regular expression used to validate the attribute value. |
|
* @see http://www.regular-expressions.info/email.html |
|
*/ |
|
public $pattern = '/^[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$/'; |
|
/** |
|
* @var string the regular expression used to validate email addresses with the name part. |
|
* This property is used only when [[allowName]] is true. |
|
* @see allowName |
|
*/ |
|
public $fullPattern = '/^[^@]*<[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?>$/'; |
|
/** |
|
* @var string the regular expression used to validate the part before the @ symbol, used if ASCII conversion fails to validate the address. |
|
* @see http://www.regular-expressions.info/email.html |
|
* @since 2.0.42 |
|
*/ |
|
public $patternASCII = '/^[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+)*$/'; |
|
/** |
|
* @var string the regular expression used to validate email addresses with the name part before the @ symbol, used if ASCII conversion fails to validate the address. |
|
* This property is used only when [[allowName]] is true. |
|
* @see allowName |
|
* @since 2.0.42 |
|
*/ |
|
public $fullPatternASCII = '/^[^@]*<[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+)*$/'; |
|
/** |
|
* @var bool whether to allow name in the email address (e.g. "John Smith <john.smith@example.com>"). Defaults to false. |
|
* @see fullPattern |
|
*/ |
|
public $allowName = false; |
|
/** |
|
* @var bool whether to check whether the email's domain exists and has either an A or MX record. |
|
* Be aware that this check can fail due to temporary DNS problems even if the email address is |
|
* valid and an email would be deliverable. Defaults to false. |
|
*/ |
|
public $checkDNS = false; |
|
/** |
|
* @var bool whether validation process should take into account IDN (internationalized domain |
|
* names). Defaults to false meaning that validation of emails containing IDN will always fail. |
|
* Note that in order to use IDN validation you have to install and enable `intl` PHP extension, |
|
* otherwise an exception would be thrown. |
|
*/ |
|
public $enableIDN = false; |
|
/** |
|
* @var bool whether [[enableIDN]] should apply to the local part of the email (left side |
|
* of the `@`). Only applies if [[enableIDN]] is `true`. |
|
* @since 2.0.43 |
|
*/ |
|
public $enableLocalIDN = true; |
|
|
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
public function init() |
|
{ |
|
parent::init(); |
|
if ($this->enableIDN && !function_exists('idn_to_ascii')) { |
|
throw new InvalidConfigException('In order to use IDN validation intl extension must be installed and enabled.'); |
|
} |
|
if ($this->message === null) { |
|
$this->message = Yii::t('yii', '{attribute} is not a valid email address.'); |
|
} |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function validateValue($value) |
|
{ |
|
if (!is_string($value)) { |
|
$valid = false; |
|
} elseif (!preg_match('/^(?P<name>(?:"?([^"]*)"?\s)?)(?:\s+)?(?:(?P<open><?)((?P<local>.+)@(?P<domain>[^>]+))(?P<close>>?))$/i', $value, $matches)) { |
|
$valid = false; |
|
} else { |
|
if ($this->enableIDN) { |
|
if ($this->enableLocalIDN) { |
|
$matches['local'] = $this->idnToAsciiWithFallback($matches['local']); |
|
} |
|
$matches['domain'] = $this->idnToAscii($matches['domain']); |
|
$value = $matches['name'] . $matches['open'] . $matches['local'] . '@' . $matches['domain'] . $matches['close']; |
|
} |
|
|
|
if (strlen($matches['local']) > 64) { |
|
// The maximum total length of a user name or other local-part is 64 octets. RFC 5322 section 4.5.3.1.1 |
|
// http://tools.ietf.org/html/rfc5321#section-4.5.3.1.1 |
|
$valid = false; |
|
} elseif (strlen($matches['local'] . '@' . $matches['domain']) > 254) { |
|
// There is a restriction in RFC 2821 on the length of an address in MAIL and RCPT commands |
|
// of 254 characters. Since addresses that do not fit in those fields are not normally useful, the |
|
// upper limit on address lengths should normally be considered to be 254. |
|
// |
|
// Dominic Sayers, RFC 3696 erratum 1690 |
|
// http://www.rfc-editor.org/errata_search.php?eid=1690 |
|
$valid = false; |
|
} else { |
|
$valid = preg_match($this->pattern, $value) || ($this->allowName && preg_match($this->fullPattern, $value)); |
|
if ($valid && $this->checkDNS) { |
|
$valid = $this->isDNSValid($matches['domain']); |
|
} |
|
} |
|
} |
|
|
|
return $valid ? null : [$this->message, []]; |
|
} |
|
|
|
/** |
|
* @param string $domain |
|
* @return bool if DNS records for domain are valid |
|
* @see https://github.com/yiisoft/yii2/issues/17083 |
|
*/ |
|
protected function isDNSValid($domain) |
|
{ |
|
return $this->hasDNSRecord($domain, true) || $this->hasDNSRecord($domain, false); |
|
} |
|
|
|
private function hasDNSRecord($domain, $isMX) |
|
{ |
|
$normalizedDomain = $domain . '.'; |
|
if (!checkdnsrr($normalizedDomain, ($isMX ? 'MX' : 'A'))) { |
|
return false; |
|
} |
|
|
|
try { |
|
// dns_get_record can return false and emit Warning that may or may not be converted to ErrorException |
|
$records = dns_get_record($normalizedDomain, ($isMX ? DNS_MX : DNS_A)); |
|
} catch (ErrorException $exception) { |
|
return false; |
|
} |
|
|
|
return !empty($records); |
|
} |
|
|
|
private function idnToAscii($idn) |
|
{ |
|
if (PHP_VERSION_ID < 50600) { |
|
// TODO: drop old PHP versions support |
|
return idn_to_ascii($idn); |
|
} |
|
|
|
return idn_to_ascii($idn, IDNA_NONTRANSITIONAL_TO_ASCII, INTL_IDNA_VARIANT_UTS46); |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
public function clientValidateAttribute($model, $attribute, $view) |
|
{ |
|
ValidationAsset::register($view); |
|
if ($this->enableIDN) { |
|
PunycodeAsset::register($view); |
|
} |
|
$options = $this->getClientOptions($model, $attribute); |
|
|
|
return 'yii.validation.email(value, messages, ' . Json::htmlEncode($options) . ');'; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
public function getClientOptions($model, $attribute) |
|
{ |
|
$options = [ |
|
'pattern' => new JsExpression($this->pattern), |
|
'fullPattern' => new JsExpression($this->fullPattern), |
|
'allowName' => $this->allowName, |
|
'message' => $this->formatMessage($this->message, [ |
|
'attribute' => $model->getAttributeLabel($attribute), |
|
]), |
|
'enableIDN' => (bool) $this->enableIDN, |
|
]; |
|
if ($this->skipOnEmpty) { |
|
$options['skipOnEmpty'] = 1; |
|
} |
|
|
|
return $options; |
|
} |
|
|
|
/** |
|
* @param string $value |
|
* @return string|bool returns string if it is valid and/or can be converted, bool false if it can't be converted and/or is invalid |
|
* @see https://github.com/yiisoft/yii2/issues/18585 |
|
*/ |
|
private function idnToAsciiWithFallback($value) |
|
{ |
|
$ascii = $this->idnToAscii($value); |
|
if ($ascii === false) { |
|
if (preg_match($this->patternASCII, $value) || ($this->allowName && preg_match($this->fullPatternASCII, $value))) { |
|
return $value; |
|
} |
|
} |
|
|
|
return $ascii; |
|
} |
|
}
|
|
|