Ip::__construct() - Code Metrics - Inspection of "Refactoring v2 (using container directly as a serv..." - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#222)

by Alexander

created 2022-04-16 07:15 UTC

Ip::__construct() A

↳ Parent: Ip

Complexity

Conditions	4
Paths	5

Size

Total Lines	166
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	4.0312

Importance

Changes

Metric	Value
cc	4
eloc	7
c	0
b	0
f	0
nc	5
nop	17
dl	0
loc	166
ccs	7
cts	8
cp	0.875
crap	4.0312
rs	10

How to fix Long Method Many Parameters

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule\Ip;

use Attribute;
use Closure;
use RuntimeException;
use Yiisoft\NetworkUtilities\IpHelper;
use Yiisoft\Validator\Rule\RuleNameTrait;
use Yiisoft\Validator\Rule\ValidatorClassNameTrait;
use Yiisoft\Validator\RuleInterface;
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 RuleInterface
{
    use RuleNameTrait;
    use ValidatorClassNameTrait;

    /**
     * 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
         */
        public array $networks = [],
        /**
         * @var bool whether the validating value can be an IPv4 address. Defaults to `true`.
         */
        public bool $allowIpv4 = true,
        /**
         * @var bool whether the validating value can be an IPv6 address. Defaults to `true`.
         */
        public 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.
         */
        public bool $allowSubnet = false,
        public bool $requireSubnet = false,
        /**
         * @var bool whether address may have a {@see NEGATION_CHAR} character at the beginning.
         * Defaults to `false`.
         */
        public 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
         */
        public 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
         */
        public 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
         */
        public 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
         */
        public 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
         */
        public 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
         */
        public 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
         */
        public 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.
         */
        public array $ranges = [],
        public bool $skipOnEmpty = false,
        public bool $skipOnError = false,
        public ?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 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 = 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);
    }

    /**
     * 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\Ip;
6
7		use Attribute;
8		use Closure;
9		use RuntimeException;
10		use Yiisoft\NetworkUtilities\IpHelper;
11		use Yiisoft\Validator\Rule\RuleNameTrait;
12		use Yiisoft\Validator\Rule\ValidatorClassNameTrait;
13		use Yiisoft\Validator\RuleInterface;
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 RuleInterface
24		{
25		use RuleNameTrait;
26		use ValidatorClassNameTrait;
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	6	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		public array $networks = [],
71		/**
72		* @var bool whether the validating value can be an IPv4 address. Defaults to `true`.
73		*/
74		public bool $allowIpv4 = true,
75		/**
76		* @var bool whether the validating value can be an IPv6 address. Defaults to `true`.
77		*/
78		public 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		public bool $allowSubnet = false,
87		public 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		public 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		public 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		public 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		public 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		public 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		public 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		public 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		public 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		public array $ranges = [],
198		public bool $skipOnEmpty = false,
199		public bool $skipOnError = false,
200		public ?Closure $when = null,
201		) {
202	6	foreach ($networks as $key => $_values) {
203	1	if (array_key_exists($key, $this->defaultNetworks)) {
204	1	throw new RuntimeException("Network alias \"{$key}\" already set as default.");
205		}
206		}
207
208	5	$this->networks = array_merge($this->defaultNetworks, $this->networks);
209
210	5	if ($requireSubnet) {
211		$this->allowSubnet = true;
212		}
213
214	5	$this->ranges = $this->prepareRanges($ranges);
215		}
216
217	4	public function getRanges(): array
218		{
219	4	return $this->ranges;
220		}
221
222		/**
223		* Parses IP address/range for the negation with {@see NEGATION_CHAR}.
224		*
225		* @param $string
226		*
227		* @return array `[0 => bool, 1 => string]`
228		* - boolean: whether the string is negated
229		* - string: the string without negation (when the negation were present)
230		*/
231	42	private function parseNegatedRange($string): array
232		{
233	42	$isNegated = strpos($string, self::NEGATION_CHAR) === 0;
234	42	return [$isNegated, $isNegated ? substr($string, strlen(self::NEGATION_CHAR)) : $string];
235		}
236
237		/**
238		* Prepares array to fill in {@see $ranges}.
239		*
240		* - Recursively substitutes aliases, described in {@see $networks} with their values,
241		* - Removes duplicates.
242		*
243		* @see $networks
244		*/
245	5	private function prepareRanges(array $ranges): array
246		{
247	5	$result = [];
248	5	foreach ($ranges as $string) {
249	4	[$isRangeNegated, $range] = $this->parseNegatedRange($string);
250	4	if (isset($this->networks[$range])) {
251	3	$replacements = $this->prepareRanges($this->networks[$range]);
252	3	foreach ($replacements as &$replacement) {
253	3	[$isReplacementNegated, $replacement] = $this->parseNegatedRange($replacement);
254	3	$result[] = ($isRangeNegated && !$isReplacementNegated ? self::NEGATION_CHAR : '') . $replacement;
255		}
256		} else {
257	4	$result[] = $string;
258		}
259		}
260
261	5	return array_unique($result);
262		}
263
264		/**
265		* The method checks whether the IP address with specified CIDR is allowed according to the {@see $ranges} list.
266		*/
267	69	public function isAllowed(string $ip): bool
268		{
269	69	if (empty($this->ranges)) {
270	31	return true;
271		}
272
273	38	foreach ($this->ranges as $string) {
274	38	[$isNegated, $range] = $this->parseNegatedRange($string);
275	38	if (IpHelper::inRange($ip, $range)) {
276	32	return !$isNegated;
277		}
278		}
279
280	6	return false;
281		}
282
283		/**
284		* Used to get the Regexp pattern for initial IP address parsing.
285		*/
286	112	public function getIpParsePattern(): string
287		{
288	112	return '/^(?<not>' . preg_quote(
289		self::NEGATION_CHAR,
290		'/'
291		) . ')?(?<ipCidr>(?<ip>(?:' . IpHelper::IPV4_PATTERN . ')\|(?:' . IpHelper::IPV6_PATTERN . '))(?:\/(?<cidr>-?\d+))?)$/';
292		}
293
294	7	public function getOptions(): array
295		{
296		return [
297	7	'networks' => $this->networks,
298	7	'allowIpv4' => $this->allowIpv4,
299	7	'allowIpv6' => $this->allowIpv6,
300	7	'allowSubnet' => $this->allowSubnet,
301	7	'requireSubnet' => $this->requireSubnet,
302	7	'allowNegation' => $this->allowNegation,
303		'message' => [
304	7	'message' => $this->message,
305		],
306		'ipv4NotAllowedMessage' => [
307	7	'message' => $this->ipv4NotAllowedMessage,
308		],
309		'ipv6NotAllowedMessage' => [
310	7	'message' => $this->ipv6NotAllowedMessage,
311		],
312		'wrongCidrMessage' => [
313	7	'message' => $this->wrongCidrMessage,
314		],
315		'noSubnetMessage' => [
316	7	'message' => $this->noSubnetMessage,
317		],
318		'hasSubnetMessage' => [
319	7	'message' => $this->hasSubnetMessage,
320		],
321		'notInRangeMessage' => [
322	7	'message' => $this->notInRangeMessage,
323		],
324	7	'ranges' => $this->ranges,
325	7	'skipOnEmpty' => $this->skipOnEmpty,
326	7	'skipOnError' => $this->skipOnError,
327		];
328		}
329		}
330

yiisoft / validator

Pull Request — master (#222)

Ip::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Many Parameters

Long Method

Many Parameters

Duplication Side-by-Side

Filter issues like