Ip::getIpParsePattern() - Code Metrics - Inspection of "Enhance tests" - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#199)

by Alexander

created 2022-04-05 06:49 UTC

Ip::getIpParsePattern() A

↳ Parent: Ip

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	1
eloc	4
nc	1
nop	0
dl	0
loc	6
ccs	2
cts	2
cp	1
crap	1
rs	10
c	1
b	1
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use InvalidArgumentException;
use RuntimeException;
use Yiisoft\NetworkUtilities\IpHelper;
use Yiisoft\Validator\FormatterInterface;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\Rule;
use Yiisoft\Validator\ValidationContext;

use function array_key_exists;
use function is_string;
use function strlen;

/**
 * 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.
 */
#[Attribute(Attribute::TARGET_PROPERTY)]
final class Ip extends Rule
{
    /**
     * Negation char.
     *
     * Used to negate {@see $ranges} or {@see $network} or to negate validating value when {@see $allowNegation}
     * is used.
     */
    private const NEGATION_CHAR = '!';
    /**
     * @see $networks
     */
    private array $defaultNetworks = [
        '*' => ['any'],
        'any' => ['0.0.0.0/0', '::/0'],
        'private' => ['10.0.0.0/8', '172.16.0.0/12', '192.168.0.0/16', 'fd00::/8'],
        'multicast' => ['224.0.0.0/4', 'ff00::/8'],
        'linklocal' => ['169.254.0.0/16', 'fe80::/10'],
        'localhost' => ['127.0.0.0/8', '::1'],
        'documentation' => ['192.0.2.0/24', '198.51.100.0/24', '203.0.113.0/24', '2001:db8::/32'],
        'system' => ['multicast', 'linklocal', 'localhost', 'documentation'],
    ];

    public function __construct(
        /**
         * @var array Custom network aliases, that can be used in {@see $ranges}.
         *
         *  - key - alias name
         *  - value - array of strings. String can be an IP range, IP address or another alias. String can be
         *    negated with {@see NEGATION_CHAR} (independent of {@see $allowNegation} option).
         *
         * The following aliases are defined by default in {@see $defaultNetworks} and will be merged with custom ones:
         *
         *  - `*`: `any`
         *  - `any`: `0.0.0.0/0, ::/0`
         *  - `private`: `10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fd00::/8`
         *  - `multicast`: `224.0.0.0/4, ff00::/8`
         *  - `linklocal`: `169.254.0.0/16, fe80::/10`
         *  - `localhost`: `127.0.0.0/8', ::1`
         *  - `documentation`: `192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24, 2001:db8::/32`
         *  - `system`: `multicast, linklocal, localhost, documentation`
         *
         * @see $defaultNetworks
         */
        private array $networks = [],
        /**
         * @var bool whether the validating value can be an IPv4 address. Defaults to `true`.
         */
        private bool $allowIpv4 = true,
        /**
         * @var bool whether the validating value can be an IPv6 address. Defaults to `true`.
         */
        private bool $allowIpv6 = true,
        /**
         * @var bool whether the address can be an IP with CIDR subnet, like `192.168.10.0/24`.
         * The following values are possible:
         *
         * - `false` - the address must not have a subnet (default).
         * - `true` - specifying a subnet is optional.
         */
        private bool $allowSubnet = false,
        private bool $requireSubnet = false,
        /**
         * @var bool whether address may have a {@see NEGATION_CHAR} character at the beginning.
         * Defaults to `false`.
         */
        private bool $allowNegation = false,
        /**
         * @var string user-defined error message is used when validation fails due to the wrong IP address format.
         *
         * You may use the following placeholders in the message:
         *
         * - `{attribute}`: the label of the attribute being validated
         * - `{value}`: the value of the attribute being validated
         */
        private string $message = 'Must be a valid IP address.',
        /**
         * @var string user-defined error message is used when validation fails due to the disabled IPv4 validation.
         *
         * You may use the following placeholders in the message:
         *
         * - `{attribute}`: the label of the attribute being validated
         * - `{value}`: the value of the attribute being validated
         *
         * @see $allowIpv4
         */
        private string $ipv4NotAllowedMessage = 'Must not be an IPv4 address.',
        /**
         * @var string user-defined error message is used when validation fails due to the disabled IPv6 validation.
         *
         * You may use the following placeholders in the message:
         *
         * - `{attribute}`: the label of the attribute being validated
         * - `{value}`: the value of the attribute being validated
         *
         * @see $allowIpv6
         */
        private string $ipv6NotAllowedMessage = 'Must not be an IPv6 address.',
        /**
         * @var string user-defined error message is used when validation fails due to the wrong CIDR.
         *
         * You may use the following placeholders in the message:
         *
         * - `{attribute}`: the label of the attribute being validated
         * - `{value}`: the value of the attribute being validated
         *
         * @see $allowSubnet
         */
        private string $wrongCidrMessage = 'Contains wrong subnet mask.',
        /**
         * @var string user-defined error message is used when validation fails due to subnet {@see $allowSubnet} is
         * used, but the CIDR prefix is not set.
         *
         * You may use the following placeholders in the message:
         *
         * - `{attribute}`: the label of the attribute being validated
         * - `{value}`: the value of the attribute being validated
         *
         * @see $allowSubnet
         */
        private string $noSubnetMessage = 'Must be an IP address with specified subnet.',
        /**
         * @var string user-defined error message is used when validation fails
         * due to {@see $allowSubnet} is false, but CIDR prefix is present.
         *
         * You may use the following placeholders in the message:
         *
         * - `{attribute}`: the label of the attribute being validated
         * - `{value}`: the value of the attribute being validated
         *
         * @see $allowSubnet
         */
        private string $hasSubnetMessage = 'Must not be a subnet.',
        /**
         * @var string user-defined error message is used when validation fails due to IP address
         * is not allowed by {@see $ranges} check.
         *
         * You may use the following placeholders in the message:
         *
         * - `{attribute}`: the label of the attribute being validated
         * - `{value}`: the value of the attribute being validated
         *
         * @see $ranges
         */
        private string $notInRangeMessage = 'Is not in the allowed range.',
        /**
         * @var array The IPv4 or IPv6 ranges that are allowed or forbidden.
         *
         * The following preparation tasks are performed:
         *
         * - Recursively substitutes aliases (described in {@see $networks}) with their values.
         * - Removes duplicates.
         *
         * When the array is empty, or the option not set, all IP addresses are allowed.
         *
         * Otherwise, the rules are checked sequentially until the first match is found.
         * An IP address is forbidden, when it has not matched any of the rules.
         *
         * Example:
         *
         * ```php
         * (new Ip(ranges: [
         *     '192.168.10.128'
         *     '!192.168.10.0/24',
         *     'any' // allows any other IP addresses
         * ]);
         * ```
         *
         * In this example, access is allowed for all the IPv4 and IPv6 addresses excluding the `192.168.10.0/24`
         * subnet. IPv4 address `192.168.10.128` is also allowed, because it is listed before the restriction.
         */
        private array $ranges = [],
        ?FormatterInterface $formatter = null,
        bool $skipOnEmpty = false,
        bool $skipOnError = false,
        $when = null
    ) {
        parent::__construct(formatter: $formatter, skipOnEmpty: $skipOnEmpty, skipOnError: $skipOnError, when: $when);

        foreach ($networks as $key => $_values) {
            if (array_key_exists($key, $this->defaultNetworks)) {
                throw new RuntimeException("Network alias \"{$key}\" already set as default.");
            }
        }

        $this->networks = array_merge($this->defaultNetworks, $this->networks);

        if ($requireSubnet) {
            $this->allowSubnet = true;
        }

        $this->ranges = $this->prepareRanges($ranges);
    }

    protected function validateValue($value, ?ValidationContext $context = null): Result
    {
        if (!$this->allowIpv4 && !$this->allowIpv6) {
            throw new RuntimeException('Both IPv4 and IPv6 checks can not be disabled at the same time.');
        }
        $result = new Result();
        if (!is_string($value)) {
            $result->addError($this->formatMessage($this->message));
            return $result;
        }

        if (preg_match($this->getIpParsePattern(), $value, $matches) === 0) {
            $result->addError($this->formatMessage($this->message));
            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($this->formatMessage($this->message));
            return $result;
        }

        if ($this->requireSubnet === true && $cidr === null) {
            $result->addError($this->formatMessage($this->noSubnetMessage));
            return $result;
        }
        if ($this->allowSubnet === false && $cidr !== null) {
            $result->addError($this->formatMessage($this->hasSubnetMessage));
            return $result;
        }
        if ($this->allowNegation === false && $negation) {
            $result->addError($this->formatMessage($this->message));
            return $result;
        }
        if ($ipVersion === IpHelper::IPV6 && !$this->allowIpv6) {
            $result->addError($this->formatMessage($this->ipv6NotAllowedMessage));
            return $result;
        }
        if ($ipVersion === IpHelper::IPV4 && !$this->allowIpv4) {
            $result->addError($this->formatMessage($this->ipv4NotAllowedMessage));
            return $result;
        }
        if (!$result->isValid()) {
            return $result;
        }
        if ($cidr !== null) {
            try {
                IpHelper::getCidrBits($ipCidr);
            } catch (InvalidArgumentException $e) {
                $result->addError($this->formatMessage($this->wrongCidrMessage));
                return $result;
            }
        }
        if (!$this->isAllowed($ipCidr)) {
            $result->addError($this->formatMessage($this->notInRangeMessage));
            return $result;
        }

        return $result;
    }

    public function getRanges(): array
    {
        return $this->ranges;
    }

    /**
     * The method checks whether the IP address with specified CIDR is allowed according to the {@see $ranges} list.
     */
    private function isAllowed(string $ip): bool
    {
        if (empty($this->ranges)) {
            return true;
        }

        foreach ($this->ranges as $string) {
            [$isNegated, $range] = $this->parseNegatedRange($string);
            if (IpHelper::inRange($ip, $range)) {
                return !$isNegated;
            }
        }

        return false;
    }

    /**
     * Parses IP address/range for the negation with {@see NEGATION_CHAR}.
     *
     * @param $string
     *
     * @return array `[0 => bool, 1 => string]`
     *  - boolean: whether the string is negated
     *  - string: the string without negation (when the negation were present)
     */
    private function parseNegatedRange($string): array
    {
        $isNegated = strpos($string, self::NEGATION_CHAR) === 0;
        return [$isNegated, $isNegated ? substr($string, strlen(self::NEGATION_CHAR)) : $string];
    }

    /**
     * Prepares array to fill in {@see $ranges}.
     *
     *  - Recursively substitutes aliases, described in {@see $networks} with their values,
     *  - Removes duplicates.
     *
     * @see $networks
     */
    private function prepareRanges(array $ranges): array
    {
        $result = [];
        foreach ($ranges as $string) {
            [$isRangeNegated, $range] = $this->parseNegatedRange($string);
            if (isset($this->networks[$range])) {
                $replacements = $this->prepareRanges($this->networks[$range]);
                foreach ($replacements as &$replacement) {
                    [$isReplacementNegated, $replacement] = $this->parseNegatedRange($replacement);
                    $result[] = ($isRangeNegated && !$isReplacementNegated ? self::NEGATION_CHAR : '') . $replacement;
                }
            } else {
                $result[] = $string;
            }
        }

        return array_unique($result);
    }

    /**
     * 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+))?)$/';
    }

    public function getOptions(): array
    {
        return array_merge(parent::getOptions(), [
            'allowIpv4' => $this->allowIpv4,
            'allowIpv6' => $this->allowIpv6,
            'allowSubnet' => $this->allowSubnet,
            'requireSubnet' => $this->requireSubnet,
            'allowNegation' => $this->allowNegation,
            'message' => $this->formatMessage($this->message),
            'ipv4NotAllowedMessage' => $this->formatMessage($this->ipv4NotAllowedMessage),
            'ipv6NotAllowedMessage' => $this->formatMessage($this->ipv6NotAllowedMessage),
            'wrongCidrMessage' => $this->formatMessage($this->wrongCidrMessage),
            'noSubnetMessage' => $this->formatMessage($this->noSubnetMessage),
            'hasSubnetMessage' => $this->formatMessage($this->hasSubnetMessage),
            'notInRangeMessage' => $this->formatMessage($this->notInRangeMessage),
            'ranges' => $this->ranges,
        ]);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Validator\Rule;
6
7		use Attribute;
8		use InvalidArgumentException;
9		use RuntimeException;
10		use Yiisoft\NetworkUtilities\IpHelper;
11		use Yiisoft\Validator\FormatterInterface;
12		use Yiisoft\Validator\Result;
13		use Yiisoft\Validator\Rule;
14		use Yiisoft\Validator\ValidationContext;
15
16		use function array_key_exists;
17		use function is_string;
18		use function strlen;
19
20		/**
21		* Checks if the value is a valid IPv4/IPv6 address or subnet.
22		*
23		* It also may change the value if normalization of IPv6 expansion is enabled.
24		*/
25		#[Attribute(Attribute::TARGET_PROPERTY)]
26		final class Ip extends Rule
27		{
28		/**
29		* Negation char.
30		*
31		* Used to negate {@see $ranges} or {@see $network} or to negate validating value when {@see $allowNegation}
32		* is used.
33		*/
34		private const NEGATION_CHAR = '!';
35		/**
36		* @see $networks
37		*/
38		private array $defaultNetworks = [
39		'*' => ['any'],
40		'any' => ['0.0.0.0/0', '::/0'],
41		'private' => ['10.0.0.0/8', '172.16.0.0/12', '192.168.0.0/16', 'fd00::/8'],
42		'multicast' => ['224.0.0.0/4', 'ff00::/8'],
43		'linklocal' => ['169.254.0.0/16', 'fe80::/10'],
44		'localhost' => ['127.0.0.0/8', '::1'],
45		'documentation' => ['192.0.2.0/24', '198.51.100.0/24', '203.0.113.0/24', '2001:db8::/32'],
46		'system' => ['multicast', 'linklocal', 'localhost', 'documentation'],
47		];
48
49	22	public function __construct(
50		/**
51		* @var array Custom network aliases, that can be used in {@see $ranges}.
52		*
53		* - key - alias name
54		* - value - array of strings. String can be an IP range, IP address or another alias. String can be
55		* negated with {@see NEGATION_CHAR} (independent of {@see $allowNegation} option).
56		*
57		* The following aliases are defined by default in {@see $defaultNetworks} and will be merged with custom ones:
58		*
59		* - `*`: `any`
60		* - `any`: `0.0.0.0/0, ::/0`
61		* - `private`: `10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fd00::/8`
62		* - `multicast`: `224.0.0.0/4, ff00::/8`
63		* - `linklocal`: `169.254.0.0/16, fe80::/10`
64		* - `localhost`: `127.0.0.0/8', ::1`
65		* - `documentation`: `192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24, 2001:db8::/32`
66		* - `system`: `multicast, linklocal, localhost, documentation`
67		*
68		* @see $defaultNetworks
69		*/
70		private array $networks = [],
71		/**
72		* @var bool whether the validating value can be an IPv4 address. Defaults to `true`.
73		*/
74		private bool $allowIpv4 = true,
75		/**
76		* @var bool whether the validating value can be an IPv6 address. Defaults to `true`.
77		*/
78		private bool $allowIpv6 = true,
79		/**
80		* @var bool whether the address can be an IP with CIDR subnet, like `192.168.10.0/24`.
81		* The following values are possible:
82		*
83		* - `false` - the address must not have a subnet (default).
84		* - `true` - specifying a subnet is optional.
85		*/
86		private bool $allowSubnet = false,
87		private bool $requireSubnet = false,
88		/**
89		* @var bool whether address may have a {@see NEGATION_CHAR} character at the beginning.
90		* Defaults to `false`.
91		*/
92		private bool $allowNegation = false,
93		/**
94		* @var string user-defined error message is used when validation fails due to the wrong IP address format.
95		*
96		* You may use the following placeholders in the message:
97		*
98		* - `{attribute}`: the label of the attribute being validated
99		* - `{value}`: the value of the attribute being validated
100		*/
101		private string $message = 'Must be a valid IP address.',
102		/**
103		* @var string user-defined error message is used when validation fails due to the disabled IPv4 validation.
104		*
105		* You may use the following placeholders in the message:
106		*
107		* - `{attribute}`: the label of the attribute being validated
108		* - `{value}`: the value of the attribute being validated
109		*
110		* @see $allowIpv4
111		*/
112		private string $ipv4NotAllowedMessage = 'Must not be an IPv4 address.',
113		/**
114		* @var string user-defined error message is used when validation fails due to the disabled IPv6 validation.
115		*
116		* You may use the following placeholders in the message:
117		*
118		* - `{attribute}`: the label of the attribute being validated
119		* - `{value}`: the value of the attribute being validated
120		*
121		* @see $allowIpv6
122		*/
123		private string $ipv6NotAllowedMessage = 'Must not be an IPv6 address.',
124		/**
125		* @var string user-defined error message is used when validation fails due to the wrong CIDR.
126		*
127		* You may use the following placeholders in the message:
128		*
129		* - `{attribute}`: the label of the attribute being validated
130		* - `{value}`: the value of the attribute being validated
131		*
132		* @see $allowSubnet
133		*/
134		private string $wrongCidrMessage = 'Contains wrong subnet mask.',
135		/**
136		* @var string user-defined error message is used when validation fails due to subnet {@see $allowSubnet} is
137		* used, but the CIDR prefix is not set.
138		*
139		* You may use the following placeholders in the message:
140		*
141		* - `{attribute}`: the label of the attribute being validated
142		* - `{value}`: the value of the attribute being validated
143		*
144		* @see $allowSubnet
145		*/
146		private string $noSubnetMessage = 'Must be an IP address with specified subnet.',
147		/**
148		* @var string user-defined error message is used when validation fails
149		* due to {@see $allowSubnet} is false, but CIDR prefix is present.
150		*
151		* You may use the following placeholders in the message:
152		*
153		* - `{attribute}`: the label of the attribute being validated
154		* - `{value}`: the value of the attribute being validated
155		*
156		* @see $allowSubnet
157		*/
158		private string $hasSubnetMessage = 'Must not be a subnet.',
159		/**
160		* @var string user-defined error message is used when validation fails due to IP address
161		* is not allowed by {@see $ranges} check.
162		*
163		* You may use the following placeholders in the message:
164		*
165		* - `{attribute}`: the label of the attribute being validated
166		* - `{value}`: the value of the attribute being validated
167		*
168		* @see $ranges
169		*/
170		private string $notInRangeMessage = 'Is not in the allowed range.',
171		/**
172		* @var array The IPv4 or IPv6 ranges that are allowed or forbidden.
173		*
174		* The following preparation tasks are performed:
175		*
176		* - Recursively substitutes aliases (described in {@see $networks}) with their values.
177		* - Removes duplicates.
178		*
179		* When the array is empty, or the option not set, all IP addresses are allowed.
180		*
181		* Otherwise, the rules are checked sequentially until the first match is found.
182		* An IP address is forbidden, when it has not matched any of the rules.
183		*
184		* Example:
185		*
186		* ```php
187		* (new Ip(ranges: [
188		* '192.168.10.128'
189		* '!192.168.10.0/24',
190		* 'any' // allows any other IP addresses
191		* ]);
192		* ```
193		*
194		* In this example, access is allowed for all the IPv4 and IPv6 addresses excluding the `192.168.10.0/24`
195		* subnet. IPv4 address `192.168.10.128` is also allowed, because it is listed before the restriction.
196		*/
197		private array $ranges = [],
198		?FormatterInterface $formatter = null,
199		bool $skipOnEmpty = false,
200		bool $skipOnError = false,
201		$when = null
202		) {
203	22	parent::__construct(formatter: $formatter, skipOnEmpty: $skipOnEmpty, skipOnError: $skipOnError, when: $when);
204
205	22	foreach ($networks as $key => $_values) {
206	2	if (array_key_exists($key, $this->defaultNetworks)) {
207	1	throw new RuntimeException("Network alias \"{$key}\" already set as default.");
208		}
209		}
210
211	21	$this->networks = array_merge($this->defaultNetworks, $this->networks);
212
213	21	if ($requireSubnet) {
214	3	$this->allowSubnet = true;
215		}
216
217	21	$this->ranges = $this->prepareRanges($ranges);
218		}
219
220	16	protected function validateValue($value, ?ValidationContext $context = null): Result
221		{
222	16	if (!$this->allowIpv4 && !$this->allowIpv6) {
223	1	throw new RuntimeException('Both IPv4 and IPv6 checks can not be disabled at the same time.');
224		}
225	15	$result = new Result();
226	15	if (!is_string($value)) {
227	4	$result->addError($this->formatMessage($this->message));
228	4	return $result;
229		}
230
231	11	if (preg_match($this->getIpParsePattern(), $value, $matches) === 0) {
232	6	$result->addError($this->formatMessage($this->message));
233	6	return $result;
234		}
235	8	$negation = !empty($matches['not'] ?? null);
236	8	$ip = $matches['ip'];
237	8	$cidr = $matches['cidr'] ?? null;
238	8	$ipCidr = $matches['ipCidr'];
239
240		try {
241	8	$ipVersion = IpHelper::getIpVersion($ip, false);
242		} catch (InvalidArgumentException $e) {
243		$result->addError($this->formatMessage($this->message));
244		return $result;
245		}
246
247	8	if ($this->requireSubnet === true && $cidr === null) {
248	3	$result->addError($this->formatMessage($this->noSubnetMessage));
249	3	return $result;
250		}
251	8	if ($this->allowSubnet === false && $cidr !== null) {
252	3	$result->addError($this->formatMessage($this->hasSubnetMessage));
253	3	return $result;
254		}
255	8	if ($this->allowNegation === false && $negation) {
256	3	$result->addError($this->formatMessage($this->message));
257	3	return $result;
258		}
259	8	if ($ipVersion === IpHelper::IPV6 && !$this->allowIpv6) {
260	1	$result->addError($this->formatMessage($this->ipv6NotAllowedMessage));
261	1	return $result;
262		}
263	8	if ($ipVersion === IpHelper::IPV4 && !$this->allowIpv4) {
264	2	$result->addError($this->formatMessage($this->ipv4NotAllowedMessage));
265	2	return $result;
266		}
267	8	if (!$result->isValid()) {
268		return $result;
269		}
270	8	if ($cidr !== null) {
271		try {
272	5	IpHelper::getCidrBits($ipCidr);
273	2	} catch (InvalidArgumentException $e) {
274	2	$result->addError($this->formatMessage($this->wrongCidrMessage));
275	2	return $result;
276		}
277		}
278	8	if (!$this->isAllowed($ipCidr)) {
279	4	$result->addError($this->formatMessage($this->notInRangeMessage));
280	4	return $result;
281		}
282
283	8	return $result;
284		}
285
286	5	public function getRanges(): array
287		{
288	5	return $this->ranges;
289		}
290
291		/**
292		* The method checks whether the IP address with specified CIDR is allowed according to the {@see $ranges} list.
293		*/
294	8	private function isAllowed(string $ip): bool
295		{
296	8	if (empty($this->ranges)) {
297	3	return true;
298		}
299
300	5	foreach ($this->ranges as $string) {
301	5	[$isNegated, $range] = $this->parseNegatedRange($string);
302	5	if (IpHelper::inRange($ip, $range)) {
303	5	return !$isNegated;
304		}
305		}
306
307	3	return false;
308		}
309
310		/**
311		* Parses IP address/range for the negation with {@see NEGATION_CHAR}.
312		*
313		* @param $string
314		*
315		* @return array `[0 => bool, 1 => string]`
316		* - boolean: whether the string is negated
317		* - string: the string without negation (when the negation were present)
318		*/
319	9	private function parseNegatedRange($string): array
320		{
321	9	$isNegated = strpos($string, self::NEGATION_CHAR) === 0;
322	9	return [$isNegated, $isNegated ? substr($string, strlen(self::NEGATION_CHAR)) : $string];
323		}
324
325		/**
326		* Prepares array to fill in {@see $ranges}.
327		*
328		* - Recursively substitutes aliases, described in {@see $networks} with their values,
329		* - Removes duplicates.
330		*
331		* @see $networks
332		*/
333	21	private function prepareRanges(array $ranges): array
334		{
335	21	$result = [];
336	21	foreach ($ranges as $string) {
337	9	[$isRangeNegated, $range] = $this->parseNegatedRange($string);
338	9	if (isset($this->networks[$range])) {
339	7	$replacements = $this->prepareRanges($this->networks[$range]);
340	7	foreach ($replacements as &$replacement) {
341	7	[$isReplacementNegated, $replacement] = $this->parseNegatedRange($replacement);
342	7	$result[] = ($isRangeNegated && !$isReplacementNegated ? self::NEGATION_CHAR : '') . $replacement;
343		}
344		} else {
345	9	$result[] = $string;
346		}
347		}
348
349	21	return array_unique($result);
350		}
351
352		/**
353		* Used to get the Regexp pattern for initial IP address parsing.
354		*/
355	11	public function getIpParsePattern(): string
356		{
357	11	return '/^(?<not>' . preg_quote(
358		self::NEGATION_CHAR,
359		'/'
360		) . ')?(?<ipCidr>(?<ip>(?:' . IpHelper::IPV4_PATTERN . ')\|(?:' . IpHelper::IPV6_PATTERN . '))(?:\/(?<cidr>-?\d+))?)$/';
361		}
362
363	7	public function getOptions(): array
364		{
365	7	return array_merge(parent::getOptions(), [
366	7	'allowIpv4' => $this->allowIpv4,
367	7	'allowIpv6' => $this->allowIpv6,
368	7	'allowSubnet' => $this->allowSubnet,
369	7	'requireSubnet' => $this->requireSubnet,
370	7	'allowNegation' => $this->allowNegation,
371	7	'message' => $this->formatMessage($this->message),
372	7	'ipv4NotAllowedMessage' => $this->formatMessage($this->ipv4NotAllowedMessage),
373	7	'ipv6NotAllowedMessage' => $this->formatMessage($this->ipv6NotAllowedMessage),
374	7	'wrongCidrMessage' => $this->formatMessage($this->wrongCidrMessage),
375	7	'noSubnetMessage' => $this->formatMessage($this->noSubnetMessage),
376	7	'hasSubnetMessage' => $this->formatMessage($this->hasSubnetMessage),
377	7	'notInRangeMessage' => $this->formatMessage($this->notInRangeMessage),
378	7	'ranges' => $this->ranges,
379		]);
380		}
381		}
382

yiisoft / validator

Pull Request — master (#199)

Ip::getIpParsePattern() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like