Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. DomainLiteral.php

class DomainLiteral

Same name in this branch
  1. 11.1.x vendor/egulias/email-validator/src/Warning/DomainLiteral.php \Egulias\EmailValidator\Warning\DomainLiteral

Hierarchy

  • class \Egulias\EmailValidator\Parser\PartParser
    • class \Egulias\EmailValidator\Parser\DomainLiteral extends \Egulias\EmailValidator\Parser\PartParser

Expanded class hierarchy of DomainLiteral

1 file declares its use of DomainLiteral
DomainPart.php in vendor/egulias/email-validator/src/Parser/DomainPart.php

File

vendor/egulias/email-validator/src/Parser/DomainLiteral.php, line 24

Namespace

Egulias\EmailValidator\Parser
View source
class DomainLiteral extends PartParser {
    public const IPV4_REGEX = '/\\b(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/';
    public const OBSOLETE_WARNINGS = [
        EmailLexer::INVALID,
        EmailLexer::C_DEL,
        EmailLexer::S_LF,
        EmailLexer::S_BACKSLASH,
    ];
    public function parse() : Result {
        $this->addTagWarnings();
        $IPv6TAG = false;
        $addressLiteral = '';
        do {
            if ($this->lexer->current
                ->isA(EmailLexer::C_NUL)) {
                return new InvalidEmail(new ExpectingDTEXT(), $this->lexer->current->value);
            }
            $this->addObsoleteWarnings();
            if ($this->lexer
                ->isNextTokenAny(array(
                EmailLexer::S_OPENBRACKET,
                EmailLexer::S_OPENBRACKET,
            ))) {
                return new InvalidEmail(new ExpectingDTEXT(), $this->lexer->current->value);
            }
            if ($this->lexer
                ->isNextTokenAny(array(
                EmailLexer::S_HTAB,
                EmailLexer::S_SP,
                EmailLexer::CRLF,
            ))) {
                $this->warnings[CFWSWithFWS::CODE] = new CFWSWithFWS();
                $this->parseFWS();
            }
            if ($this->lexer
                ->isNextToken(EmailLexer::S_CR)) {
                return new InvalidEmail(new CRNoLF(), $this->lexer->current->value);
            }
            if ($this->lexer->current
                ->isA(EmailLexer::S_BACKSLASH)) {
                return new InvalidEmail(new UnusualElements($this->lexer->current->value), $this->lexer->current->value);
            }
            if ($this->lexer->current
                ->isA(EmailLexer::S_IPV6TAG)) {
                $IPv6TAG = true;
            }
            if ($this->lexer->current
                ->isA(EmailLexer::S_CLOSEBRACKET)) {
                break;
            }
            $addressLiteral .= $this->lexer->current->value;
        } while ($this->lexer
            ->moveNext());
        
        //Encapsulate
        $addressLiteral = str_replace('[', '', $addressLiteral);
        $isAddressLiteralIPv4 = $this->checkIPV4Tag($addressLiteral);
        if (!$isAddressLiteralIPv4) {
            return new ValidEmail();
        }
        $addressLiteral = $this->convertIPv4ToIPv6($addressLiteral);
        if (!$IPv6TAG) {
            $this->warnings[WarningDomainLiteral::CODE] = new WarningDomainLiteral();
            return new ValidEmail();
        }
        $this->warnings[AddressLiteral::CODE] = new AddressLiteral();
        $this->checkIPV6Tag($addressLiteral);
        return new ValidEmail();
    }
    
    /**
     * @param string $addressLiteral
     * @param int $maxGroups
     */
    public function checkIPV6Tag($addressLiteral, $maxGroups = 8) : void {
        $prev = $this->lexer
            ->getPrevious();
        if ($prev->isA(EmailLexer::S_COLON)) {
            $this->warnings[IPV6ColonEnd::CODE] = new IPV6ColonEnd();
        }
        $IPv6 = substr($addressLiteral, 5);
        
        //Daniel Marschall's new IPv6 testing strategy
        $matchesIP = explode(':', $IPv6);
        $groupCount = count($matchesIP);
        $colons = strpos($IPv6, '::');
        if (count(preg_grep('/^[0-9A-Fa-f]{0,4}$/', $matchesIP, PREG_GREP_INVERT)) !== 0) {
            $this->warnings[IPV6BadChar::CODE] = new IPV6BadChar();
        }
        if ($colons === false) {
            // We need exactly the right number of groups
            if ($groupCount !== $maxGroups) {
                $this->warnings[IPV6GroupCount::CODE] = new IPV6GroupCount();
            }
            return;
        }
        if ($colons !== strrpos($IPv6, '::')) {
            $this->warnings[IPV6DoubleColon::CODE] = new IPV6DoubleColon();
            return;
        }
        if ($colons === 0 || $colons === strlen($IPv6) - 2) {
            // RFC 4291 allows :: at the start or end of an address
            
            //with 7 other groups in addition
            ++$maxGroups;
        }
        if ($groupCount > $maxGroups) {
            $this->warnings[IPV6MaxGroups::CODE] = new IPV6MaxGroups();
        }
        elseif ($groupCount === $maxGroups) {
            $this->warnings[IPV6Deprecated::CODE] = new IPV6Deprecated();
        }
    }
    public function convertIPv4ToIPv6(string $addressLiteralIPv4) : string {
        $matchesIP = [];
        $IPv4Match = preg_match(self::IPV4_REGEX, $addressLiteralIPv4, $matchesIP);
        // Extract IPv4 part from the end of the address-literal (if there is one)
        if ($IPv4Match > 0) {
            $index = (int) strrpos($addressLiteralIPv4, $matchesIP[0]);
            
            //There's a match but it is at the start
            if ($index > 0) {
                // Convert IPv4 part to IPv6 format for further testing
                return substr($addressLiteralIPv4, 0, $index) . '0:0';
            }
        }
        return $addressLiteralIPv4;
    }
    
    /**
     * @param string $addressLiteral
     *
     * @return bool
     */
    protected function checkIPV4Tag($addressLiteral) : bool {
        $matchesIP = [];
        $IPv4Match = preg_match(self::IPV4_REGEX, $addressLiteral, $matchesIP);
        // Extract IPv4 part from the end of the address-literal (if there is one)
        if ($IPv4Match > 0) {
            $index = strrpos($addressLiteral, $matchesIP[0]);
            
            //There's a match but it is at the start
            if ($index === 0) {
                $this->warnings[AddressLiteral::CODE] = new AddressLiteral();
                return false;
            }
        }
        return true;
    }
    private function addObsoleteWarnings() : void {
        if (in_array($this->lexer->current->type, self::OBSOLETE_WARNINGS)) {
            $this->warnings[ObsoleteDTEXT::CODE] = new ObsoleteDTEXT();
        }
    }
    private function addTagWarnings() : void {
        if ($this->lexer
            ->isNextToken(EmailLexer::S_COLON)) {
            $this->warnings[IPV6ColonStart::CODE] = new IPV6ColonStart();
        }
        if ($this->lexer
            ->isNextToken(EmailLexer::S_IPV6TAG)) {
            $lexer = clone $this->lexer;
            $lexer->moveNext();
            if ($lexer->isNextToken(EmailLexer::S_DOUBLECOLON)) {
                $this->warnings[IPV6ColonStart::CODE] = new IPV6ColonStart();
            }
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DomainLiteral::addObsoleteWarnings private function
DomainLiteral::addTagWarnings private function
DomainLiteral::checkIPV4Tag protected function
DomainLiteral::checkIPV6Tag public function
DomainLiteral::convertIPv4ToIPv6 public function
DomainLiteral::IPV4_REGEX public constant
DomainLiteral::OBSOLETE_WARNINGS public constant
DomainLiteral::parse public function Overrides PartParser::parse
PartParser::$lexer protected property
PartParser::$warnings protected property
PartParser::checkConsecutiveDots protected function
PartParser::escaped protected function
PartParser::getWarnings public function
PartParser::parseFWS protected function
PartParser::__construct public function 1

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal