|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Yiisoft\Validator\Rule; |
|
6
|
|
|
|
|
7
|
|
|
use Attribute; |
|
8
|
|
|
use Yiisoft\Validator\FormatterInterface; |
|
9
|
|
|
use Yiisoft\Validator\Result; |
|
10
|
|
|
use Yiisoft\Validator\Rule; |
|
11
|
|
|
use Yiisoft\Validator\ValidationContext; |
|
12
|
|
|
|
|
13
|
|
|
use function is_string; |
|
14
|
|
|
use function strlen; |
|
15
|
|
|
|
|
16
|
|
|
/** |
|
17
|
|
|
* Validates that the value is a valid email address. |
|
18
|
|
|
*/ |
|
19
|
|
|
#[Attribute(Attribute::TARGET_PROPERTY)] |
|
20
|
|
|
final class Email extends Rule |
|
21
|
|
|
{ |
|
22
|
|
|
use IdnDependencyTrait; |
|
23
|
|
|
|
|
24
|
84 |
|
public function __construct( |
|
25
|
|
|
/** |
|
26
|
|
|
* @var string the regular expression used to validate value. |
|
27
|
|
|
* |
|
28
|
|
|
* @link http://www.regular-expressions.info/email.html |
|
29
|
|
|
*/ |
|
30
|
|
|
private string $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])?$/', |
|
31
|
|
|
/** |
|
32
|
|
|
* @var string the regular expression used to validate email addresses with the name part. This property is used |
|
33
|
|
|
* only when {@see $allowName} is `true`. |
|
34
|
|
|
* |
|
35
|
|
|
* @see $allowName |
|
36
|
|
|
*/ |
|
37
|
|
|
private string $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])?>$/', |
|
38
|
|
|
/** |
|
39
|
|
|
* @var string the regular expression used to validate complex emails when {@see $enableIDN} is `true`. |
|
40
|
|
|
*/ |
|
41
|
|
|
private string $idnEmailPattern = '/^([a-zA-Z0-9._%+-]+)@((\[\d{1,3}\.\d{1,3}\.\d{1,3}\.)|(([\w-]+\.)+))([a-zA-Z]{2,4}|\d{1,3})(\]?)$/', |
|
42
|
|
|
/** |
|
43
|
|
|
* @var bool whether to allow name in the email address (e.g. "John Smith <[email protected]>"). Defaults |
|
44
|
|
|
* to `false`. |
|
45
|
|
|
* |
|
46
|
|
|
* @see $fullPattern |
|
47
|
|
|
*/ |
|
48
|
|
|
private bool $allowName = false, |
|
49
|
|
|
/** |
|
50
|
|
|
* @var bool whether to check whether the email's domain exists and has either an A or MX record. |
|
51
|
|
|
* Be aware that this check can fail due to temporary DNS problems even if the email address is |
|
52
|
|
|
* valid and an email would be deliverable. Defaults to `false`. |
|
53
|
|
|
*/ |
|
54
|
|
|
private bool $checkDNS = false, |
|
55
|
|
|
/** |
|
56
|
|
|
* @var bool whether validation process should take into account IDN (internationalized domain |
|
57
|
|
|
* names). Defaults to false meaning that validation of emails containing IDN will always fail. |
|
58
|
|
|
* Note that in order to use IDN validation you have to install and enable `intl` PHP extension, |
|
59
|
|
|
* otherwise an exception would be thrown. |
|
60
|
|
|
*/ |
|
61
|
|
|
private bool $enableIDN = false, |
|
62
|
|
|
private string $message = 'This value is not a valid email address.', |
|
63
|
|
|
?FormatterInterface $formatter = null, |
|
64
|
|
|
bool $skipOnEmpty = false, |
|
65
|
|
|
bool $skipOnError = false, |
|
66
|
|
|
$when = null |
|
67
|
|
|
) { |
|
68
|
84 |
|
parent::__construct(formatter: $formatter, skipOnEmpty: $skipOnEmpty, skipOnError: $skipOnError, when: $when); |
|
69
|
84 |
|
$this->initIdnFunctionExists(); |
|
70
|
|
|
} |
|
71
|
|
|
|
|
72
|
83 |
|
protected function validateValue($value, ?ValidationContext $context = null): Result |
|
73
|
|
|
{ |
|
74
|
83 |
|
$this->idnFunctionRequired(); |
|
75
|
|
|
|
|
76
|
82 |
|
$originalValue = $value; |
|
77
|
82 |
|
$result = new Result(); |
|
78
|
|
|
|
|
79
|
82 |
|
if (!is_string($value)) { |
|
80
|
2 |
|
$valid = false; |
|
81
|
80 |
|
} elseif (!preg_match( |
|
82
|
|
|
'/^(?P<name>(?:"?([^"]*)"?\s)?)(?:\s+)?((?P<open><?)((?P<local>.+)@(?P<domain>[^>]+))(?P<close>>?))$/i', |
|
83
|
|
|
$value, |
|
84
|
|
|
$matches |
|
85
|
|
|
)) { |
|
86
|
6 |
|
$valid = false; |
|
87
|
|
|
} else { |
|
88
|
|
|
/** @psalm-var array{name:string,local:string,open:string,domain:string,close:string} $matches */ |
|
89
|
74 |
|
if ($this->enableIDN) { |
|
90
|
27 |
|
$matches['local'] = $this->idnToAscii($matches['local']); |
|
91
|
27 |
|
$matches['domain'] = $this->idnToAscii($matches['domain']); |
|
92
|
27 |
|
$value = implode([ |
|
93
|
27 |
|
$matches['name'], |
|
94
|
27 |
|
$matches['open'], |
|
95
|
27 |
|
$matches['local'], |
|
96
|
|
|
'@', |
|
97
|
27 |
|
$matches['domain'], |
|
98
|
27 |
|
$matches['close'], |
|
99
|
|
|
]); |
|
100
|
|
|
} |
|
101
|
|
|
|
|
102
|
74 |
|
if (is_string($matches['local']) && strlen($matches['local']) > 64) { |
|
103
|
|
|
// The maximum total length of a user name or other local-part is 64 octets. RFC 5322 section 4.5.3.1.1 |
|
104
|
|
|
// http://tools.ietf.org/html/rfc5321#section-4.5.3.1.1 |
|
105
|
1 |
|
$valid = false; |
|
106
|
73 |
|
} elseif (is_string($matches['local']) && strlen($matches['local'] . '@' . $matches['domain']) > 254) { |
|
107
|
|
|
// There is a restriction in RFC 2821 on the length of an address in MAIL and RCPT commands |
|
108
|
|
|
// of 254 characters. Since addresses that do not fit in those fields are not normally useful, the |
|
109
|
|
|
// upper limit on address lengths should normally be considered to be 254. |
|
110
|
|
|
// |
|
111
|
|
|
// Dominic Sayers, RFC 3696 erratum 1690 |
|
112
|
|
|
// http://www.rfc-editor.org/errata_search.php?eid=1690 |
|
113
|
1 |
|
$valid = false; |
|
114
|
|
|
} else { |
|
115
|
72 |
|
$valid = preg_match($this->pattern, $value) || ($this->allowName && preg_match( |
|
116
|
47 |
|
$this->fullPattern, |
|
117
|
|
|
$value |
|
118
|
|
|
)); |
|
119
|
72 |
|
if ($valid && $this->checkDNS) { |
|
120
|
4 |
|
$valid = checkdnsrr($matches['domain'] . '.', 'MX') || checkdnsrr($matches['domain'] . '.', 'A'); |
|
121
|
|
|
} |
|
122
|
|
|
} |
|
123
|
|
|
} |
|
124
|
|
|
|
|
125
|
82 |
|
if ($this->enableIDN && $valid === false) { |
|
126
|
10 |
|
$valid = (bool) preg_match($this->idnEmailPattern, $originalValue); |
|
127
|
|
|
} |
|
128
|
|
|
|
|
129
|
82 |
|
if ($valid === false) { |
|
130
|
44 |
|
$result->addError($this->formatMessage($this->message)); |
|
131
|
|
|
} |
|
132
|
|
|
|
|
133
|
82 |
|
return $result; |
|
134
|
|
|
} |
|
135
|
|
|
|
|
136
|
27 |
|
private function idnToAscii($idn) |
|
137
|
|
|
{ |
|
138
|
27 |
|
return idn_to_ascii($idn, 0, INTL_IDNA_VARIANT_UTS46); |
|
139
|
|
|
} |
|
140
|
|
|
|
|
141
|
4 |
|
public function getOptions(): array |
|
142
|
|
|
{ |
|
143
|
4 |
|
return array_merge(parent::getOptions(), [ |
|
144
|
4 |
|
'allowName' => $this->allowName, |
|
145
|
4 |
|
'checkDNS' => $this->checkDNS, |
|
146
|
4 |
|
'enableIDN' => $this->enableIDN, |
|
147
|
4 |
|
'message' => $this->formatMessage($this->message), |
|
148
|
|
|
]); |
|
149
|
|
|
} |
|
150
|
|
|
} |
|
151
|
|
|
|
yiisoft /
validator
