yiisoft / validator

src/Rule/EmailHandler.php

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Yiisoft\Validator\Exception\UnexpectedRuleException;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\RuleHandlerInterface;
use Yiisoft\Validator\ValidationContext;

use function is_string;
use function strlen;

/**
 * Validates that the value is a valid email address.
 */
final class EmailHandler implements RuleHandlerInterface
{
    public function validate(mixed $value, object $rule, ValidationContext $context): Result
    {
        if (!$rule instanceof Email) {
            throw new UnexpectedRuleException(Email::class, $rule);
        }

        $result = new Result();
        if (!is_string($value)) {
            return $result->addError($rule->getIncorrectInputMessage(), [
                'attribute' => $context->getTranslatedAttribute(),
                'type' => get_debug_type($value),
            ]);
        }

        $originalValue = $value;

        if (!preg_match(

The first expression of a multi-line control structure must be on the line after the opening parenthesis

            '/^(?P<name>(?:"?([^"]*)"?\s)?)(?:\s+)?((?P<open><?)((?P<local>.+)@(?P<domain>[^>]+))(?P<close>>?))/',
            $value,
            $matches
        )) {

Each line in a multi-line control structure must be indented at least once; expected at least 12 spaces, but found 8

The closing parenthesis of a multi-line control structure must be on the line after the last expression

            $valid = false;
        } else {
            /** @var array{name:string,local:string,open:string,domain:string,close:string} $matches */
            if ($rule->isIdnEnabled()) {
                $matches['local'] = idn_to_ascii($matches['local']);
                $matches['domain'] = idn_to_ascii($matches['domain']);
                $value = implode('', [
                    $matches['name'],
                    $matches['open'],
                    $matches['local'],
                    '@',
                    $matches['domain'],
                    $matches['close'],
                ]);
            }

            if (is_string($matches['local']) && 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
                // https://www.rfc-editor.org/rfc/rfc5321#section-4.5.3.1.1
                $valid = false;
            } elseif (
                is_string($matches['local']) &&
                strlen($matches['local']) + strlen((string) $matches['domain']) > 253
            ) {
                // 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
                // https://www.rfc-editor.org/errata_search.php?eid=1690
                $valid = false;
            } else {
                $valid = preg_match($rule->getPattern(), $value) || ($rule->isNameAllowed() && preg_match(
                    $rule->getFullPattern(),
                    $value
                ));
                if ($valid && $rule->shouldCheckDns()) {
                    $valid = checkdnsrr($matches['domain']);
                }
            }
        }

        if ($valid === false && $rule->isIdnEnabled()) {
            $valid = (bool) preg_match($rule->getIdnEmailPattern(), $originalValue);
        }

        if ($valid === false) {
            $result->addError($rule->getMessage(), [
                'attribute' => $context->getTranslatedAttribute(),
                'value' => $originalValue,
            ]);
        }

        return $result;
    }
}