EmailValidator.php 4.67 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 56 57 58 59 60
	/**
	 * Initializes the validator.
	 */
	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 70 71
	/**
	 * Validates the attribute of the object.
	 * If there is any error, the error message is added to the object.
w  
Qiang Xue committed
72
	 * @param \yii\base\Model $object the object being validated
w  
Qiang Xue committed
73 74
	 * @param string $attribute the attribute being validated
	 */
w  
Qiang Xue committed
75
	public function validateAttribute($object, $attribute)
w  
Qiang Xue committed
76 77
	{
		$value = $object->$attribute;
w  
Qiang Xue committed
78
		if (!$this->validateValue($value)) {
Qiang Xue committed
79
			$this->addError($object, $attribute, $this->message);
w  
Qiang Xue committed
80 81 82 83
		}
	}

	/**
Qiang Xue committed
84 85 86
	 * Validates the given value.
	 * @param mixed $value the value to be validated.
	 * @return boolean whether the value is valid.
w  
Qiang Xue committed
87 88 89 90
	 */
	public function validateValue($value)
	{
		// make sure string length is limited to avoid DOS attacks
91
		if (!is_string($value) || strlen($value) >= 320) {
92 93
			return false;
		}
94
		if (!preg_match('/^(.*<?)(.*)@(.*)(>?)$/', $value, $matches)) {
95 96
			return false;
		}
97
		$domain = $matches[3];
98
		if ($this->enableIDN) {
99
			$value = $matches[1] . idn_to_ascii($matches[2]) . '@' . idn_to_ascii($domain) . $matches[4];
100 101
		}
		$valid = preg_match($this->pattern, $value) || $this->allowName && preg_match($this->fullPattern, $value);
102 103
		if ($valid && $this->checkDNS) {
			$valid = checkdnsrr($domain, 'MX') || checkdnsrr($domain, 'A');
w  
Qiang Xue committed
104
		}
w  
Qiang Xue committed
105 106 107 108 109
		return $valid;
	}

	/**
	 * Returns the JavaScript needed for performing client-side validation.
w  
Qiang Xue committed
110
	 * @param \yii\base\Model $object the data object being validated
w  
Qiang Xue committed
111
	 * @param string $attribute the name of the attribute to be validated.
Alexander Makarov committed
112
	 * @param \yii\web\View $view the view object that is going to be used to render views or view files
113
	 * containing a model form with this validator applied.
w  
Qiang Xue committed
114 115
	 * @return string the client-side validation script.
	 */
116
	public function clientValidateAttribute($object, $attribute, $view)
w  
Qiang Xue committed
117
	{
Alexander Makarov committed
118
		$options = [
119 120 121
			'pattern' => new JsExpression($this->pattern),
			'fullPattern' => new JsExpression($this->fullPattern),
			'allowName' => $this->allowName,
Alexander Makarov committed
122
			'message' => Html::encode(strtr($this->message, [
123
				'{attribute}' => $object->getAttributeLabel($attribute),
Alexander Makarov committed
124
			])),
125
			'enableIDN' => (boolean)$this->enableIDN,
Alexander Makarov committed
126
		];
127 128
		if ($this->skipOnEmpty) {
			$options['skipOnEmpty'] = 1;
w  
Qiang Xue committed
129
		}
w  
Qiang Xue committed
130

131
		ValidationAsset::register($view);
132
		if ($this->enableIDN) {
133
			PunycodeAsset::register($view);
134
		}
135
		return 'yii.validation.email(value, messages, ' . Json::encode($options) . ');';
w  
Qiang Xue committed
136 137
	}
}