DomainConsumer extends GenericReceivedConsumer
Parses a so-called "extended-domain" (from and by) part of a Received header.
Looks for and extracts the following fields from an extended-domain part: Name, Hostname and Address.
The Name part is always the portion of the extended-domain part existing on its own, outside of the parenthesized hostname and address part. This is true regardless of whether an address is used as the name, as its assumed to be the string used to identify the server, whatever it may be.
The parenthesized part normally (but not necessarily) following a name must "look like" a tcp-info section of an extended domain as defined by RFC5321. The validation is very purposefully very loose to be accommodating to many erroneous implementations. Strictly speaking, a domain part, if it exists, must start with an alphanumeric character. There must be at least one '.' in the domain part, followed by any number of more alphanumeric, '.', and '-' characters. The address part must be within square brackets, '[]'... although an address outside of square brackets could be matched by the domain matcher if it exists alone within the parentheses. The address, strictly speaking, is any number of '.', numbers, ':' and letters a-f. This allows it to match ipv6 addresses as well. In addition, the address may start with the string "ipv6", and may be followed by a port number as some implementations seem to do.
Strings in parentheses not matching the aforementioned 'domain/address' pattern will be considered comments, and will be returned as a separate CommentPart.
Tags
Table of Contents
- $consumerService : ConsumerService
- $partFactory : HeaderPartFactory
- $partName : string
- __construct() : mixed
- Initializes the instance.
- __invoke() : array<string|int, HeaderPart>
- Invokes parsing of a header's value into header parts.
- getInstance() : mixed
- Returns the singleton instance for the class.
- advanceToNextToken() : mixed
- Determines if the iterator should be advanced to the next token after reading tokens or finding a start token.
- filterIgnoredSpaces() : array<string|int, HeaderPart>
- Filters out ignorable spaces between parts in the passed array.
- getAllConsumers() : array<string|int, AbstractConsumer>
- Returns this consumer and all unique sub consumers.
- getAllTokenSeparators() : array<string|int, string>
- Returns a list of regular expression markers for this consumer and all sub-consumers by calling 'getTokenSeparators'.
- getConsumerTokenParts() : array<string|int, HeaderPart>|array<string|int, mixed>
- Iterates through this consumer's sub-consumers checking if the current token triggers a sub-consumer's start token and passes control onto that sub-consumer's parseTokenIntoParts. If no sub-consumer is responsible for the current token, calls getPartForToken and returns it in an array.
- getPartForToken() : HeaderPart|null
- Constructs and returns a \ZBateson\MailMimeParser\Header\Part\HeaderPart for the passed string token. If the token should be ignored, the function must return null.
- getPartName() : string
- Returns the name of the part being parsed.
- getSubConsumers() : array<string|int, AbstractConsumer>
- Called during construction to set up the list of sub-consumers that will take control from this consumer should a token match a sub-consumer's start token.
- getTokenParts() : array<string|int, HeaderPart>|array<string|int, mixed>
- Returns an array of \ZBateson\MailMimeParser\Header\Part\HeaderPart for the current token on the iterator.
- getTokenSeparators() : array<string|int, string>
- Returns an array of regular expression separators specific to this consumer. The returned patterns are used to split the header value into tokens for the consumer to parse into parts.
- getTokenSplitPattern() : string
- Returns a regex pattern used to split the input header string. The default implementation calls getAllTokenSeparators and implodes the returned array with the regex OR '|' character as its glue.
- isEndToken() : bool
- Overridden to return true if the passed token is a closing parenthesis.
- isStartToken() : bool
- Returns true if the passed string token marks the beginning marker for the current consumer.
- parseTokensIntoParts() : array<string|int, HeaderPart>
- Iterates over the passed token Iterator and returns an array of parsed \ZBateson\MailMimeParser\Header\Part\HeaderPart objects.
- processParts() : array<string|int, ReceivedDomainPart>|array<string|int, CommentPart>|array<string|int, HeaderPart>
- Creates a single ReceivedDomainPart out of matched parts. If an unmatched parenthesized expression was found, it's returned as a CommentPart.
- splitRawValue() : array<string|int, mixed>
- Returns an array of split tokens from the input string.
- addSpaces() : mixed
- Checks if the passed space part should be added to the returned parts and adds it.
- addSpaceToRetParts() : mixed
- Loops over the $parts array from the current position, checks if the space should be added, then adds it to $retParts and returns.
- isSpaceToken() : bool
- Returns true if the passed HeaderPart is a Token instance and a space.
- matchHostPart() : bool
- Attempts to match a parenthesized expression to find a hostname and an address. Returns true if the expression matched, and either hostname or address were found.
- parseRawValue() : array<string|int, HeaderPart>
- Called by __invoke to parse the raw header value into header parts.
- shouldAddSpace() : bool
- Returns true if a space should be added based on the passed last and next parts.
Properties
$consumerService
protected
ConsumerService
$consumerService
$partFactory
protected
HeaderPartFactory
$partFactory
$partName
protected
string
$partName
Methods
__construct()
Initializes the instance.
public
__construct(ConsumerService $consumerService, HeaderPartFactory $partFactory) : mixed
Parameters
- $consumerService : ConsumerService
- $partFactory : HeaderPartFactory
Return values
mixed —__invoke()
Invokes parsing of a header's value into header parts.
public
__invoke(string $value) : array<string|int, HeaderPart>
Parameters
- $value : string
-
the raw header value
Return values
array<string|int, HeaderPart> —the array of parsed parts
getInstance()
Returns the singleton instance for the class.
public
static getInstance(ConsumerService $consumerService, HeaderPartFactory $partFactory) : mixed
Parameters
- $consumerService : ConsumerService
- $partFactory : HeaderPartFactory
Return values
mixed —advanceToNextToken()
Determines if the iterator should be advanced to the next token after reading tokens or finding a start token.
protected
advanceToNextToken(Iterator $tokens, bool $isStartToken) : mixed
The default implementation will advance for a start token, but not advance on the end token of the current consumer, allowing the end token to be passed up to a higher-level consumer.
Parameters
- $tokens : Iterator
- $isStartToken : bool
Return values
mixed —filterIgnoredSpaces()
Filters out ignorable spaces between parts in the passed array.
protected
filterIgnoredSpaces(array<string|int, HeaderPart> $parts) : array<string|int, HeaderPart>
Spaces with parts on either side of it that specify they can be ignored are filtered out. filterIgnoredSpaces is called from within processParts, and if needed by an implementing class that overrides processParts, must be specifically called.
Parameters
- $parts : array<string|int, HeaderPart>
Return values
array<string|int, HeaderPart> —getAllConsumers()
Returns this consumer and all unique sub consumers.
protected
getAllConsumers() : array<string|int, AbstractConsumer>
Loops into the sub-consumers (and their sub-consumers, etc...) finding all unique consumers, and returns them in an array.
Return values
array<string|int, AbstractConsumer> —getAllTokenSeparators()
Returns a list of regular expression markers for this consumer and all sub-consumers by calling 'getTokenSeparators'.
protected
getAllTokenSeparators() : array<string|int, string>
.
Return values
array<string|int, string> —an array of regular expression markers
getConsumerTokenParts()
Iterates through this consumer's sub-consumers checking if the current token triggers a sub-consumer's start token and passes control onto that sub-consumer's parseTokenIntoParts. If no sub-consumer is responsible for the current token, calls getPartForToken and returns it in an array.
protected
getConsumerTokenParts(Iterator $tokens) : array<string|int, HeaderPart>|array<string|int, mixed>
Parameters
- $tokens : Iterator
Return values
array<string|int, HeaderPart>|array<string|int, mixed> —getPartForToken()
Constructs and returns a \ZBateson\MailMimeParser\Header\Part\HeaderPart for the passed string token. If the token should be ignored, the function must return null.
protected
getPartForToken(string $token, bool $isLiteral) : HeaderPart|null
The default created part uses the instance's partFactory->newInstance method.
Parameters
- $token : string
-
the token
- $isLiteral : bool
-
set to true if the token represents a literal - e.g. an escaped token
Return values
HeaderPart|null —the constructed header part or null if the token should be ignored
getPartName()
Returns the name of the part being parsed.
protected
getPartName() : string
This is always the lower-case name provided to the constructor, not the actual string that started the consumer, which could be in any case.
Return values
string —getSubConsumers()
Called during construction to set up the list of sub-consumers that will take control from this consumer should a token match a sub-consumer's start token.
protected
abstract getSubConsumers() : array<string|int, AbstractConsumer>
Return values
array<string|int, AbstractConsumer> —the array of consumers
getTokenParts()
Returns an array of \ZBateson\MailMimeParser\Header\Part\HeaderPart for the current token on the iterator.
protected
getTokenParts(Iterator $tokens) : array<string|int, HeaderPart>|array<string|int, mixed>
If the current token is a start token from a sub-consumer, the sub- consumer's parseTokensIntoParts method is called.
Parameters
- $tokens : Iterator
Return values
array<string|int, HeaderPart>|array<string|int, mixed> —getTokenSeparators()
Returns an array of regular expression separators specific to this consumer. The returned patterns are used to split the header value into tokens for the consumer to parse into parts.
protected
abstract getTokenSeparators() : array<string|int, string>
Each array element makes part of a generated regular expression that is used in a call to preg_split(). RegEx patterns can be used, and care should be taken to escape special characters.
Return values
array<string|int, string> —the array of patterns
getTokenSplitPattern()
Returns a regex pattern used to split the input header string. The default implementation calls getAllTokenSeparators and implodes the returned array with the regex OR '|' character as its glue.
protected
getTokenSplitPattern() : string
Return values
string —the regex pattern
isEndToken()
Overridden to return true if the passed token is a closing parenthesis.
protected
isEndToken(string $token) : bool
Parameters
- $token : string
Return values
bool —isStartToken()
Returns true if the passed string token marks the beginning marker for the current consumer.
protected
abstract isStartToken(string $token) : bool
Parameters
- $token : string
-
the current token
Return values
bool —parseTokensIntoParts()
Iterates over the passed token Iterator and returns an array of parsed \ZBateson\MailMimeParser\Header\Part\HeaderPart objects.
protected
parseTokensIntoParts(Iterator $tokens) : array<string|int, HeaderPart>
The method checks each token to see if the token matches a sub-consumer's start token, or if it matches the current consumer's end token to stop processing.
If a sub-consumer's start token is matched, the sub-consumer is invoked and its returned parts are merged to the current consumer's header parts.
After all tokens are read and an array of Header\Parts are constructed, the array is passed to AbstractConsumer::processParts for any final processing.
Parameters
- $tokens : Iterator
-
an iterator over a string of tokens
Return values
array<string|int, HeaderPart> —an array of parsed parts
processParts()
Creates a single ReceivedDomainPart out of matched parts. If an unmatched parenthesized expression was found, it's returned as a CommentPart.
protected
processParts(array<string|int, HeaderPart> $parts) : array<string|int, ReceivedDomainPart>|array<string|int, CommentPart>|array<string|int, HeaderPart>
Parameters
- $parts : array<string|int, HeaderPart>
Return values
array<string|int, ReceivedDomainPart>|array<string|int, CommentPart>|array<string|int, HeaderPart> —splitRawValue()
Returns an array of split tokens from the input string.
protected
splitRawValue(string $rawValue) : array<string|int, mixed>
The method calls preg_split using getTokenSplitPattern. The split array will not contain any empty parts and will contain the markers.
Parameters
- $rawValue : string
-
the raw string
Return values
array<string|int, mixed> —the array of tokens
addSpaces()
Checks if the passed space part should be added to the returned parts and adds it.
private
addSpaces(array<string|int, HeaderPart> $parts, array<string|int, HeaderPart> &$retParts, int $curIndex[, HeaderPart &$spacePart = null ]) : mixed
Never adds a space if it's the first part, otherwise only add it if either part isn't set to ignore the space
Parameters
- $parts : array<string|int, HeaderPart>
- $retParts : array<string|int, HeaderPart>
- $curIndex : int
- $spacePart : HeaderPart = null
Return values
mixed —addSpaceToRetParts()
Loops over the $parts array from the current position, checks if the space should be added, then adds it to $retParts and returns.
private
addSpaceToRetParts(array<string|int, HeaderPart> $parts, array<string|int, HeaderPart> &$retParts, int $curIndex, HeaderPart &$spacePart, HeaderPart $lastPart) : mixed
Parameters
- $parts : array<string|int, HeaderPart>
- $retParts : array<string|int, HeaderPart>
- $curIndex : int
- $spacePart : HeaderPart
- $lastPart : HeaderPart
Return values
mixed —isSpaceToken()
Returns true if the passed HeaderPart is a Token instance and a space.
private
isSpaceToken(HeaderPart $part) : bool
Parameters
- $part : HeaderPart
Return values
bool —matchHostPart()
Attempts to match a parenthesized expression to find a hostname and an address. Returns true if the expression matched, and either hostname or address were found.
private
matchHostPart(string $value, string &$hostname, string &$address) : bool
Parameters
- $value : string
- $hostname : string
- $address : string
Return values
bool —parseRawValue()
Called by __invoke to parse the raw header value into header parts.
private
parseRawValue(string $value) : array<string|int, HeaderPart>
Calls splitTokens to split the value into token part strings, then calls parseParts to parse the returned array.
Parameters
- $value : string
Return values
array<string|int, HeaderPart> —the array of parsed parts
shouldAddSpace()
Returns true if a space should be added based on the passed last and next parts.
private
shouldAddSpace(HeaderPart $nextPart, HeaderPart $lastPart) : bool
Parameters
- $nextPart : HeaderPart
- $lastPart : HeaderPart