Ip::getIncorrectInputMessage() - Code Metrics - Inspection of "Set Psalm level to 1" - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#364)

unknown

created 2022-11-12 13:29 UTC

Ip::getIncorrectInputMessage() A

↳ Parent: Ip

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Closure;
use RuntimeException;
use Yiisoft\NetworkUtilities\IpHelper;
use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
use Yiisoft\Validator\Rule\Trait\WhenTrait;
use Yiisoft\Validator\SerializableRuleInterface;
use Yiisoft\Validator\SkipOnEmptyInterface;
use Yiisoft\Validator\SkipOnErrorInterface;
use Yiisoft\Validator\ValidationContext;
use Yiisoft\Validator\WhenInterface;

use function array_key_exists;
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 | Attribute::IS_REPEATABLE)]
final class Ip implements SerializableRuleInterface, SkipOnErrorInterface, WhenInterface, SkipOnEmptyInterface
{
    use SkipOnEmptyTrait;
    use SkipOnErrorTrait;
    use WhenTrait;

    /**
     * Negation char.
     *
     * Used to negate {@see $ranges} or {@see $network} or to negate validating value when {@see $allowNegation}
     * is used.
     */
    private const NEGATION_CHAR = '!';
    /**
     * @var array<string, list<string>>

     *
     * @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<string, list<string>> 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`.
         */
        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,
        private string $incorrectInputMessage = 'The value must have a string type.',
        /**
         * @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 when
         * {@see $allowIpv4} is 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.
         */
        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 when
         * {@see $allowIpv6} is 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.
         */
        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 when
         * {@see $allowSubnet} is 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.
         */
        private string $wrongCidrMessage = 'Contains wrong subnet mask.',
        /**
         * @var string User-defined error message is used when validation fails due to {@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.
         */
        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.
         */
        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.
         */
        private string $notInRangeMessage = 'Is not in the allowed range.',
        /**
         * @var string[] 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 = [],
        /**
         * @var bool|callable|null
         */
        private mixed $skipOnEmpty = null,
        private bool $skipOnError = false,
        /**
         * @var Closure(mixed, ValidationContext):bool|null
         */
        private ?Closure $when = null,
    ) {
        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);
    }

    public function getName(): string
    {
        return 'ip';
    }

    public function getNetworks(): array
    {
        return $this->networks;
    }

    public function isAllowIpv4(): bool
    {
        return $this->allowIpv4;
    }

    public function isAllowIpv6(): bool
    {
        return $this->allowIpv6;
    }

    public function isAllowSubnet(): bool
    {
        return $this->allowSubnet;
    }

    public function isRequireSubnet(): bool
    {
        return $this->requireSubnet;
    }

    public function isAllowNegation(): bool
    {
        return $this->allowNegation;
    }

    public function getIncorrectInputMessage(): string
    {
        return $this->incorrectInputMessage;
    }

    public function getMessage(): string
    {
        return $this->message;
    }

    public function getIpv4NotAllowedMessage(): string
    {
        return $this->ipv4NotAllowedMessage;
    }

    public function getIpv6NotAllowedMessage(): string
    {
        return $this->ipv6NotAllowedMessage;
    }

    public function getWrongCidrMessage(): string
    {
        return $this->wrongCidrMessage;
    }

    public function getNoSubnetMessage(): string
    {
        return $this->noSubnetMessage;
    }

    public function getHasSubnetMessage(): string
    {
        return $this->hasSubnetMessage;
    }

    public function getNotInRangeMessage(): string
    {
        return $this->notInRangeMessage;
    }

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

    /**
     * Parses IP address/range for the negation with {@see NEGATION_CHAR}.
     *
     * @return array{0: bool, 1: string} The result array consists of 2 elements:
     * - boolean: whether the string is negated
     * - string: the string without negation (when the negation were present)
     */
    private function parseNegatedRange(string $string): array
    {
        $isNegated = str_starts_with($string, self::NEGATION_CHAR);
        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.
     *
     * @param string[] $ranges
     *
     * @return string[]
     */
    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);
    }

    /**
     * The method checks whether the IP address with specified CIDR is allowed according to the {@see $ranges} list.
     */
    public 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;
    }

    /**
     * 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 [
            'networks' => $this->networks,
            'allowIpv4' => $this->allowIpv4,
            'allowIpv6' => $this->allowIpv6,
            'allowSubnet' => $this->allowSubnet,
            'requireSubnet' => $this->requireSubnet,
            'allowNegation' => $this->allowNegation,
            'incorrectInputMessage' => [
                'message' => $this->incorrectInputMessage,
            ],
            'message' => [
                'message' => $this->message,
            ],
            'ipv4NotAllowedMessage' => [
                'message' => $this->ipv4NotAllowedMessage,
            ],
            'ipv6NotAllowedMessage' => [
                'message' => $this->ipv6NotAllowedMessage,
            ],
            'wrongCidrMessage' => [
                'message' => $this->wrongCidrMessage,
            ],
            'noSubnetMessage' => [
                'message' => $this->noSubnetMessage,
            ],
            'hasSubnetMessage' => [
                'message' => $this->hasSubnetMessage,
            ],
            'notInRangeMessage' => [
                'message' => $this->notInRangeMessage,
            ],
            'ranges' => $this->ranges,
            'skipOnEmpty' => $this->getSkipOnEmptyOption(),
            'skipOnError' => $this->skipOnError,
        ];
    }

    public function getHandlerClassName(): string
    {
        return IpHandler::class;
    }
}


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

yiisoft / validator

Pull Request — master (#364)

Ip::getIncorrectInputMessage() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like