Yiisoft\Validator\Rule\IpHandler

Complexity

Total Complexity

27

Size/Duplication

Total Lines	160
Duplicated Lines	0 %

Test Coverage

Coverage

93.75%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	checkAllowedVersions()	0	4	3
B	validate()	0	47	7
B	validateValueParts()	0	30	7
A	validateVersion()	0	22	5
A	validateCidr()	0	27	4
A	getIpParsePattern()	0	6	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use InvalidArgumentException;
use RuntimeException;
use Yiisoft\NetworkUtilities\IpHelper;
use Yiisoft\Validator\Exception\UnexpectedRuleException;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\RuleHandlerInterface;
use Yiisoft\Validator\ValidationContext;

use function is_string;

/**
 * Checks if the value is a valid IPv4/IPv6 address or subnet.
 *
 * It also may change the value if normalization of IPv6 expansion is enabled.
 */
final class IpHandler implements RuleHandlerInterface
{
    /**
     * Negation char.
     *
     * Used to negate {@see $ranges} or {@see $network} or to negate validating value when {@see $allowNegation}
     * is used.
     */
    private const NEGATION_CHAR = '!';

    public function validate(mixed $value, object $rule, ValidationContext $context): Result
    {
        if (!$rule instanceof Ip) {
            throw new UnexpectedRuleException(Ip::class, $rule);
        }

        $this->checkAllowedVersions($rule);
        $result = new Result();
        if (!is_string($value)) {
            $result->addError(
                message: $rule->getMessage(),
                parameters: ['value' => $value]
            );
            return $result;
        }

        if (preg_match($this->getIpParsePattern(), $value, $matches) === 0) {
            $result->addError(
                message: $rule->getMessage(),
                parameters: ['value' => $value]
            );
            return $result;
        }
        $negation = !empty($matches['not'] ?? null);
        $ip = $matches['ip'];
        $cidr = $matches['cidr'] ?? null;
        $ipCidr = $matches['ipCidr'];

        try {
            $ipVersion = IpHelper::getIpVersion($ip, false);
        } catch (InvalidArgumentException $e) {
            $result->addError(
                message: $rule->getMessage(),
                parameters: ['value' => $value]
            );
            return $result;
        }

        $result = $this->validateValueParts($rule, $result, $cidr, $negation, $value, $context);
        if (!$result->isValid()) {
            return $result;
        }
        $result = $this->validateVersion($rule, $result, $ipVersion, $value, $context);
        if (!$result->isValid()) {
            return $result;
        }
        return $this->validateCidr($rule, $result, $cidr, $ipCidr, $value, $context);
    }

    /**
     * Used to get the Regexp pattern for initial IP address parsing.
     */
    public function getIpParsePattern(): string
    {
        return '/^(?<not>' . preg_quote(
            self::NEGATION_CHAR,
            '/'
        ) . ')?(?<ipCidr>(?<ip>(?:' . IpHelper::IPV4_PATTERN . ')|(?:' . IpHelper::IPV6_PATTERN . '))(?:\/(?<cidr>-?\d+))?)$/';
    }

    private function checkAllowedVersions(Ip $rule): void
    {
        if (!$rule->isAllowIpv4() && !$rule->isAllowIpv6()) {
            throw new RuntimeException('Both IPv4 and IPv6 checks can not be disabled at the same time.');
        }
    }

    private function validateValueParts(
        Ip $rule,
        Result $result,
        ?string $cidr,
        bool $negation,
        mixed $value,
        ?ValidationContext $context

The parameter $context is not used and could be removed.

    ): Result {
        if ($cidr === null && $rule->isRequireSubnet()) {
            $result->addError(
                message: $rule->getNoSubnetMessage(),
                parameters: ['value' => $value]
            );
            return $result;
        }
        if ($cidr !== null && !$rule->isAllowSubnet()) {
            $result->addError(
                message: $rule->getHasSubnetMessage(),
                parameters: ['value' => $value]
            );
            return $result;
        }
        if ($negation && !$rule->isAllowNegation()) {
            $result->addError(
                message: $rule->getMessage(),
                parameters: ['value' => $value]
            );
            return $result;
        }
        return $result;
    }

    private function validateVersion(
        Ip $rule,
        Result $result,
        int $ipVersion,
        mixed $value,
        ?ValidationContext $context

The parameter $context is not used and could be removed.

    ): Result {
        if ($ipVersion === IpHelper::IPV6 && !$rule->isAllowIpv6()) {
            $result->addError(
                message: $rule->getIpv6NotAllowedMessage(),
                parameters: ['value' => $value]
            );
            return $result;
        }
        if ($ipVersion === IpHelper::IPV4 && !$rule->isAllowIpv4()) {
            $result->addError(
                message: $rule->getIpv4NotAllowedMessage(),
                parameters: ['value' => $value]
            );
            return $result;
        }
        return $result;
    }

    private function validateCidr(
        Ip $rule,
        Result $result,
        ?string $cidr,
        string $ipCidr,
        mixed $value,
        ?ValidationContext $context

The parameter $context is not used and could be removed.

    ): Result {
        if ($cidr !== null) {
            try {
                IpHelper::getCidrBits($ipCidr);
            } catch (InvalidArgumentException $e) {
                $result->addError(
                    message: $rule->getWrongCidrMessage(),
                    parameters: ['value' => $value]
                );
                return $result;
            }
        }
        if (!$rule->isAllowed($ipCidr)) {
            $result->addError(
                message: $rule->getNotInRangeMessage(),
                parameters: ['value' => $value]
            );
            return $result;
        }
        return $result;
    }
}