EmailValidator.php 3.77 KB
Newer Older
w  
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

w  
Qiang Xue committed
8 9
namespace yii\validators;

Qiang Xue committed
10
use Yii;
11
use yii\base\InvalidConfigException;
12
use yii\helpers\Html;
Qiang Xue committed
13
use yii\web\JsExpression;
14
use yii\helpers\Json;
Qiang Xue committed
15

w  
Qiang Xue committed
16
/**
w  
Qiang Xue committed
17
 * EmailValidator validates that the attribute value is a valid email address.
w  
Qiang Xue committed
18 19
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
20
 * @since 2.0
w  
Qiang Xue committed
21
 */
w  
Qiang Xue committed
22
class EmailValidator extends Validator
w  
Qiang Xue committed
23 24 25 26 27 28 29 30
{
	/**
	 * @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.
w  
Qiang Xue committed
31
	 * This property is used only when [[allowName]] is true.
w  
Qiang Xue committed
32 33 34 35
	 * @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])?>$/';
	/**
Qiang Xue committed
36
	 * @var boolean whether to allow name in the email address (e.g. "John Smith <john.smith@example.com>"). Defaults to false.
w  
Qiang Xue committed
37 38 39 40
	 * @see fullPattern
	 */
	public $allowName = false;
	/**
41 42 43
	 * @var boolean whether to check whether the emails domain exists and has either an A or MX record.
	 * Be aware of the fact 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.
w  
Qiang Xue committed
44
	 */
45
	public $checkDNS = false;
46 47 48
	/**
	 * @var boolean whether validation process should take into account IDN (internationalized domain
	 * names). Defaults to false meaning that validation of emails containing IDN will always fail.
49 50
	 * Note that in order to use IDN validation you have to install and enable `intl` PHP extension,
	 * otherwise an exception would be thrown.
51
	 */
52
	public $enableIDN = false;
53

w  
Qiang Xue committed
54

Qiang Xue committed
55
	/**
Qiang Xue committed
56
	 * @inheritdoc
Qiang Xue committed
57 58 59 60
	 */
	public function init()
	{
		parent::init();
61 62 63
		if ($this->enableIDN && !function_exists('idn_to_ascii')) {
			throw new InvalidConfigException('In order to use IDN validation intl extension must be installed and enabled.');
		}
Qiang Xue committed
64
		if ($this->message === null) {
65
			$this->message = Yii::t('yii', '{attribute} is not a valid email address.');
Qiang Xue committed
66 67 68
		}
	}

w  
Qiang Xue committed
69
	/**
Qiang Xue committed
70
	 * @inheritdoc
w  
Qiang Xue committed
71
	 */
Qiang Xue committed
72
	protected function validateValue($value)
w  
Qiang Xue committed
73 74
	{
		// make sure string length is limited to avoid DOS attacks
75
		if (!is_string($value) || strlen($value) >= 320) {
Qiang Xue committed
76 77 78 79 80 81 82 83 84 85 86 87
			$valid = false;
		} elseif (!preg_match('/^(.*<?)(.*)@(.*)(>?)$/', $value, $matches)) {
			$valid = false;
		} else {
			$domain = $matches[3];
			if ($this->enableIDN) {
				$value = $matches[1] . idn_to_ascii($matches[2]) . '@' . idn_to_ascii($domain) . $matches[4];
			}
			$valid = preg_match($this->pattern, $value) || $this->allowName && preg_match($this->fullPattern, $value);
			if ($valid && $this->checkDNS) {
				$valid = checkdnsrr($domain, 'MX') || checkdnsrr($domain, 'A');
			}
w  
Qiang Xue committed
88
		}
Qiang Xue committed
89
		return $valid ? null : [$this->message, []];
w  
Qiang Xue committed
90 91 92
	}

	/**
Qiang Xue committed
93
	 * @inheritdoc
w  
Qiang Xue committed
94
	 */
95
	public function clientValidateAttribute($object, $attribute, $view)
w  
Qiang Xue committed
96
	{
Alexander Makarov committed
97
		$options = [
98 99 100
			'pattern' => new JsExpression($this->pattern),
			'fullPattern' => new JsExpression($this->fullPattern),
			'allowName' => $this->allowName,
Alexander Makarov committed
101
			'message' => Html::encode(strtr($this->message, [
102
				'{attribute}' => $object->getAttributeLabel($attribute),
Alexander Makarov committed
103
			])),
104
			'enableIDN' => (boolean)$this->enableIDN,
Alexander Makarov committed
105
		];
106 107
		if ($this->skipOnEmpty) {
			$options['skipOnEmpty'] = 1;
w  
Qiang Xue committed
108
		}
w  
Qiang Xue committed
109

110
		ValidationAsset::register($view);
111
		if ($this->enableIDN) {
112
			PunycodeAsset::register($view);
113
		}
114
		return 'yii.validation.email(value, messages, ' . Json::encode($options) . ');';
w  
Qiang Xue committed
115 116
	}
}