Ip::validateValue() - Code Metrics - Inspection of "Refactoring rules concept" - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#222)

by Rustam

created 2022-06-01 06:36 UTC

Ip::validateValue() D

↳ Parent: Project

Complexity

Conditions	20
Paths	15

Size

Total Lines	64
Code Lines	45

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	40
CRAP Score	20.3004

Importance

Changes

Metric	Value
cc	20
eloc	45
nc	15
nop	2
dl	0
loc	64
ccs	40
cts	44
cp	0.9091
crap	20.3004
rs	4.1666
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Closure;
use RuntimeException;
use Yiisoft\NetworkUtilities\IpHelper;
use Yiisoft\Validator\Rule\Trait\RuleNameTrait;

use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
use Yiisoft\Validator\ParametrizedRuleInterface;
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)]
final class Ip implements ParametrizedRuleInterface
{
    use HandlerClassNameTrait;
    use RuleNameTrait;

    /**
     * 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 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 = [],
        private bool $skipOnEmpty = false,
        private bool $skipOnError = false,
        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);
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

    /**
     * @return bool
     */
    public function isSkipOnEmpty(): bool
    {
        return $this->skipOnEmpty;
    }

    /**
     * @return bool
     */
    public function isSkipOnError(): bool
    {
        return $this->skipOnError;
    }

    /**
     * @return Closure|null
     */
    public function getWhen(): ?Closure
    {
        return $this->when;
    }

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

    /**
     * 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 = 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.
     *
     * @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);
    }

    /**
     * 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,
            '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->skipOnEmpty,
            'skipOnError' => $this->skipOnError,
        ];
    }
}


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\RuleNameTrait;
		0 ignored issues – show Bug introduced 2022-04-21 16:11 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected T_TRAIT, expecting T_STRING or '{' on line 11 at column 27 Loading history...
12		use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
13		use Yiisoft\Validator\ParametrizedRuleInterface;
14		use function array_key_exists;
15		use function strlen;
16
17		/**
18		* Checks if the value is a valid IPv4/IPv6 address or subnet.
19		*
20		* It also may change the value if normalization of IPv6 expansion is enabled.
21		*/
22		#[Attribute(Attribute::TARGET_PROPERTY)]
23		final class Ip implements ParametrizedRuleInterface
24		{
25		use HandlerClassNameTrait;
26		use RuleNameTrait;
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	23	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 string[] 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		private bool $skipOnEmpty = false,
199		private bool $skipOnError = false,
200		private ?Closure $when = null,
201		) {
202		foreach ($networks as $key => $_values) {
203	23	if (array_key_exists($key, $this->defaultNetworks)) {
204		throw new RuntimeException("Network alias \"{$key}\" already set as default.");
205	23	}
206	3	}
207	1
208		$this->networks = array_merge($this->defaultNetworks, $this->networks);
209
210		if ($requireSubnet) {
211	22	$this->allowSubnet = true;
212		}
213	22
214		$this->ranges = $this->prepareRanges($ranges);
215		}
216
217	22	/**
218		* @return array
219		*/
220	118	public function getNetworks(): array
221		{
222	118	return $this->networks;
223	1	}
224
225	117	/**
226	117	* @return bool
227	4	*/
228	4	public function isAllowIpv4(): bool
229		{
230		return $this->allowIpv4;
231	113	}
232	25
233	25	/**
234		* @return bool
235	88	*/
236	88	public function isAllowIpv6(): bool
237	88	{
238	88	return $this->allowIpv6;
239		}
240
241	88	/**
242		* @return bool
243		*/
244		public function isAllowSubnet(): bool
245		{
246		return $this->allowSubnet;
247	88	}
248	4
249	4	/**
250		* @return bool
251	84	*/
252	4	public function isRequireSubnet(): bool
253	4	{
254		return $this->requireSubnet;
255	80	}
256	4
257	4	/**
258		* @return bool
259	76	*/
260	1	public function isAllowNegation(): bool
261	1	{
262		return $this->allowNegation;
263	75	}
264	2
265	2	/**
266		* @return string
267	73	*/
268		public function getMessage(): string
269		{
270	73	return $this->message;
271		}
272	30
273	4	/**
274	4	* @return string
275	4	*/
276		public function getIpv4NotAllowedMessage(): string
277		{
278	69	return $this->ipv4NotAllowedMessage;
279	16	}
280	16
281		/**
282		* @return string
283	53	*/
284		public function getIpv6NotAllowedMessage(): string
285		{
286	4	return $this->ipv6NotAllowedMessage;
287		}
288	4
289		/**
290		* @return string
291		*/
292		public function getWrongCidrMessage(): string
293		{
294	69	return $this->wrongCidrMessage;
295		}
296	69
297	31	/**
298		* @return string
299		*/
300	38	public function getNoSubnetMessage(): string
301	38	{
302	38	return $this->noSubnetMessage;
303	32	}
304
305		/**
306		* @return string
307	6	*/
308		public function getHasSubnetMessage(): string
309		{
310		return $this->hasSubnetMessage;
311		}
312
313		/**
314		* @return string
315		*/
316		public function getNotInRangeMessage(): string
317		{
318		return $this->notInRangeMessage;
319	42	}
320
321	42	/**
322	42	* @return bool
323		*/
324		public function isSkipOnEmpty(): bool
325		{
326		return $this->skipOnEmpty;
327		}
328
329		/**
330		* @return bool
331		*/
332		public function isSkipOnError(): bool
333	22	{
334		return $this->skipOnError;
335	22	}
336	22
337	11	/**
338	11	* @return Closure\|null
339	10	*/
340	10	public function getWhen(): ?Closure
341	10	{
342	10	return $this->when;
343		}
344
345	11	public function getRanges(): array
346		{
347		return $this->ranges;
348		}
349	22
350		/**
351		* Parses IP address/range for the negation with {@see NEGATION_CHAR}.
352		*
353		* @param $string
354		*
355	113	* @return array `[0 => bool, 1 => string]`
356		* - boolean: whether the string is negated
357	113	* - string: the string without negation (when the negation were present)
358		*/
359		private function parseNegatedRange($string): array
360		{
361		$isNegated = str_starts_with($string, self::NEGATION_CHAR);
362		return [$isNegated, $isNegated ? substr($string, strlen(self::NEGATION_CHAR)) : $string];
363	7	}
364
365	7	/**
366	7	* Prepares array to fill in {@see $ranges}.
367	7	*
368	7	* - Recursively substitutes aliases, described in {@see $networks} with their values,
369	7	* - Removes duplicates.
370	7	*
371	7	* @see $networks
372	7	*/
373	7	private function prepareRanges(array $ranges): array
374	7	{
375	7	$result = [];
376	7	foreach ($ranges as $string) {
377	7	[$isRangeNegated, $range] = $this->parseNegatedRange($string);
378	7	if (isset($this->networks[$range])) {
379	7	$replacements = $this->prepareRanges($this->networks[$range]);
380		foreach ($replacements as &$replacement) {
381		[$isReplacementNegated, $replacement] = $this->parseNegatedRange($replacement);
382		$result[] = ($isRangeNegated && !$isReplacementNegated ? self::NEGATION_CHAR : '') . $replacement;
383		}
384		} else {
385		$result[] = $string;
386		}
387		}
388
389		return array_unique($result);
390		}
391
392		/**
393		* The method checks whether the IP address with specified CIDR is allowed according to the {@see $ranges} list.
394		*/
395		public function isAllowed(string $ip): bool
396		{
397		if (empty($this->ranges)) {
398		return true;
399		}
400
401		foreach ($this->ranges as $string) {
402		[$isNegated, $range] = $this->parseNegatedRange($string);
403		if (IpHelper::inRange($ip, $range)) {
404		return !$isNegated;
405		}
406		}
407
408		return false;
409		}
410
411		/**
412		* Used to get the Regexp pattern for initial IP address parsing.
413		*/
414		public function getIpParsePattern(): string
415		{
416		return '/^(?<not>' . preg_quote(
417		self::NEGATION_CHAR,
418		'/'
419		) . ')?(?<ipCidr>(?<ip>(?:' . IpHelper::IPV4_PATTERN . ')\|(?:' . IpHelper::IPV6_PATTERN . '))(?:\/(?<cidr>-?\d+))?)$/';
420		}
421
422		public function getOptions(): array
423		{
424		return [
425		'networks' => $this->networks,
426		'allowIpv4' => $this->allowIpv4,
427		'allowIpv6' => $this->allowIpv6,
428		'allowSubnet' => $this->allowSubnet,
429		'requireSubnet' => $this->requireSubnet,
430		'allowNegation' => $this->allowNegation,
431		'message' => [
432		'message' => $this->message,
433		],
434		'ipv4NotAllowedMessage' => [
435		'message' => $this->ipv4NotAllowedMessage,
436		],
437		'ipv6NotAllowedMessage' => [
438		'message' => $this->ipv6NotAllowedMessage,
439		],
440		'wrongCidrMessage' => [
441		'message' => $this->wrongCidrMessage,
442		],
443		'noSubnetMessage' => [
444		'message' => $this->noSubnetMessage,
445		],
446		'hasSubnetMessage' => [
447		'message' => $this->hasSubnetMessage,
448		],
449		'notInRangeMessage' => [
450		'message' => $this->notInRangeMessage,
451		],
452		'ranges' => $this->ranges,
453		'skipOnEmpty' => $this->skipOnEmpty,
454		'skipOnError' => $this->skipOnError,
455		];
456		}
457		}
458

yiisoft / validator

Pull Request — master (#222)

Ip::validateValue() D

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like