EmailValidator.php 4.59 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\helpers\Html;
Qiang Xue committed
12
use yii\web\JsExpression;
13
use yii\helpers\Json;
Qiang Xue committed
14

w  
Qiang Xue committed
15
/**
w  
Qiang Xue committed
16
 * EmailValidator validates that the attribute value is a valid email address.
w  
Qiang Xue committed
17 18
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
19
 * @since 2.0
w  
Qiang Xue committed
20
 */
w  
Qiang Xue committed
21
class EmailValidator extends Validator
w  
Qiang Xue committed
22 23 24 25 26 27 28 29
{
	/**
	 * @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
30
	 * This property is used only when [[allowName]] is true.
w  
Qiang Xue committed
31 32 33 34
	 * @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
35
	 * @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
36 37 38 39 40 41 42 43 44 45 46 47 48 49
	 * @see fullPattern
	 */
	public $allowName = false;
	/**
	 * @var boolean whether to check the MX record for the email address.
	 * Defaults to false. To enable it, you need to make sure the PHP function 'checkdnsrr'
	 * exists in your PHP installation.
	 */
	public $checkMX = false;
	/**
	 * @var boolean whether to check port 25 for the email address.
	 * Defaults to false.
	 */
	public $checkPort = false;
50 51 52 53
	/**
	 * @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.
	 */
54
	public $enableIDN = false;
55

w  
Qiang Xue committed
56

Qiang Xue committed
57 58 59 60 61 62 63
	/**
	 * Initializes the validator.
	 */
	public function init()
	{
		parent::init();
		if ($this->message === null) {
64
			$this->message = Yii::t('yii', '{attribute} is not a valid email address.');
Qiang Xue committed
65 66 67
		}
	}

w  
Qiang Xue committed
68 69 70
	/**
	 * Validates the attribute of the object.
	 * If there is any error, the error message is added to the object.
w  
Qiang Xue committed
71
	 * @param \yii\base\Model $object the object being validated
w  
Qiang Xue committed
72 73
	 * @param string $attribute the attribute being validated
	 */
w  
Qiang Xue committed
74
	public function validateAttribute($object, $attribute)
w  
Qiang Xue committed
75 76
	{
		$value = $object->$attribute;
w  
Qiang Xue committed
77
		if (!$this->validateValue($value)) {
Qiang Xue committed
78
			$this->addError($object, $attribute, $this->message);
w  
Qiang Xue committed
79 80 81 82
		}
	}

	/**
Qiang Xue committed
83 84 85
	 * Validates the given value.
	 * @param mixed $value the value to be validated.
	 * @return boolean whether the value is valid.
w  
Qiang Xue committed
86 87 88 89
	 */
	public function validateValue($value)
	{
		// make sure string length is limited to avoid DOS attacks
90 91 92 93 94 95 96
		if (!is_string($value) || strlen($value) >= 255) {
			return false;
		}
		if (($atPosition = strpos($value, '@')) === false) {
			return false;
		}
		$domain = rtrim(substr($value, $atPosition + 1), '>');
97
		if ($this->enableIDN) {
98 99 100
			$value = idn_to_ascii(ltrim(substr($value, 0, $atPosition), '<')) . '@' . idn_to_ascii($domain);
		}
		$valid = preg_match($this->pattern, $value) || $this->allowName && preg_match($this->fullPattern, $value);
w  
Qiang Xue committed
101
		if ($valid) {
Qiang Xue committed
102 103 104 105 106 107
			if ($this->checkMX && function_exists('checkdnsrr')) {
				$valid = checkdnsrr($domain, 'MX');
			}
			if ($valid && $this->checkPort && function_exists('fsockopen')) {
				$valid = fsockopen($domain, 25) !== false;
			}
w  
Qiang Xue committed
108
		}
w  
Qiang Xue committed
109 110 111 112 113
		return $valid;
	}

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

136
		$view->registerAssetBundle('yii/validation');
137
		if ($this->enableIDN) {
Qiang Xue committed
138
			$view->registerAssetBundle('yii/punycode');
139
		}
140
		return 'yii.validation.email(value, messages, ' . Json::encode($options) . ');';
w  
Qiang Xue committed
141 142
	}
}