IP::getNumberOfHosts() - Code Metrics - Inspection of "remove some more duplication" - eduVPN/vpn-server-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7d41ca...d0cd6b )

by François

created 2016-05-20 19:50 UTC

IP::getNumberOfHosts() A

↳ Parent: IP

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	6
rs	9.4285
cc	1
eloc	3
nc	1
nop	0

<?php
/**
 * Copyright 2016 François Kooman <[email protected]>.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace fkooman\VPN\Server;

use InvalidArgumentException;

class IP
{
    /** @var string */
    private $ipAddress;

    /** @var int */
    private $ipPrefix;

    /** @var int */
    private $ipFamily;

    public function __construct($ipAddressPrefix)
    {
        // detect if there is a prefix
        $hasPrefix = false !== strpos($ipAddressPrefix, '/');
        if ($hasPrefix) {
            list($ipAddress, $ipPrefix) = explode('/', $ipAddressPrefix);
        } else {
            $ipAddress = $ipAddressPrefix;
            $ipPrefix = null;
        }

        // validate the IP address
        if (false === filter_var($ipAddress, FILTER_VALIDATE_IP)) {
            throw new IPException('invalid IP address');
        }

        $is6 = false !== strpos($ipAddress, ':');
        if ($is6) {
            if (is_null($ipPrefix)) {
                $ipPrefix = 128;
            }

            if (!is_numeric($ipPrefix) || 0 > $ipPrefix || 128 < $ipPrefix) {

                throw new IPException('IP prefix must be a number between 0 and 128');
            }
            // normalize the IPv6 address
            $ipAddress = inet_ntop(inet_pton($ipAddress));
        } else {
            if (is_null($ipPrefix)) {
                $ipPrefix = 32;
            }
            if (!is_numeric($ipPrefix) || 0 > $ipPrefix || 32 < $ipPrefix) {

                throw new IPException('IP prefix must be a number between 0 and 32');
            }
        }

        $this->ipAddress = $ipAddress;
        $this->ipPrefix = (int) $ipPrefix;
        $this->ipFamily = $is6 ? 6 : 4;
    }

    public function getAddress()
    {
        return $this->ipAddress;
    }

    public function getPrefix()
    {
        return $this->ipPrefix;
    }

    public function getAddressPrefix()
    {
        return sprintf('%s/%d', $this->getAddress(), $this->getPrefix());
    }

    public function getFamily()
    {
        return $this->ipFamily;
    }

    /**
     * IPv4 only.
     */
    public function getNetmask()
    {
        $this->requireIPv4();

        return long2ip(-1 << (32 - $this->getPrefix()));
    }

    /**
     * IPv4 only.
     */
    public function getNetwork()
    {
        $this->requireIPv4();

        return long2ip(ip2long($this->getAddress()) & ip2long($this->getNetmask()));
    }

    /**
     * IPv4 only.
     */
    public function getNumberOfHosts()
    {
        $this->requireIPv4();

        return pow(2, 32 - $this->getPrefix()) - 2;
    }

    public function split($networkCount)
    {
        if (!is_int($networkCount)) {
            throw new InvalidArgumentException('parameter must be integer');
        }

        if (0 !== ($networkCount & ($networkCount - 1))) {
            throw new InvalidArgumentException('parameter must be power of 2');
        }

        if (4 === $this->getFamily()) {
            return $this->split4($networkCount);
        }

        return $this->split6($networkCount);
    }

    private function split4($networkCount)
    {
        if (pow(2, 32 - $this->getPrefix() - 2) < $networkCount) {
            throw new IPException('network too small to split in this many networks');
        }

        $prefix = $this->getPrefix() + log($networkCount, 2);
        $splitRanges = [];
        for ($i = 0; $i < $networkCount; ++$i) {
            $noHosts = pow(2, 32 - $prefix);
            $networkAddress = long2ip($i * $noHosts + ip2long($this->getAddress()));
            $splitRanges[] = new self($networkAddress.'/'.$prefix);
        }

        return $splitRanges;
    }

    private function split6($networkCount)
    {
        // NOTE: if networkCount == 1, then there will be one /64 returned, and not 
        // the whole net!
        if (64 <= $this->getPrefix()) {
            throw new IPException('network too small to split up, must be bigger than /64');
        }

        if (0 !== $this->getPrefix() % 4) {
            throw new IPException('network prefix length must be divisible by 4');
        }

        if (pow(2, 64 - $this->getPrefix()) < $networkCount) {
            throw new IPException('network too small to split in this many networks');
        }

        $hexAddress = bin2hex(inet_pton($this->getAddress()));
        // strip the last digits based on prefix size
        $hexAddress = substr($hexAddress, 0, 16 - ((64 - $this->getPrefix()) / 4));

        $splitRanges = [];
        for ($i = 0; $i < $networkCount; ++$i) {
            // pad with zeros until there is enough space for or network number
            $paddedHexAddress = str_pad($hexAddress, 16 - strlen(dechex($i)), '0');
            // append the network number
            $hexAddressWithNetwork = $paddedHexAddress.dechex($i);
            // pad it to the end and convert back to IPv6 address
            $splitRanges[] = new self(sprintf('%s/64', inet_ntop(hex2bin(str_pad($hexAddressWithNetwork, 32, '0')))));
        }

        return $splitRanges;
    }

    public function __toString()
    {
        return $this->getAddressPrefix();
    }

    private function requireIPv4()
    {
        if (4 !== $this->getFamily()) {
            throw new IPException('method only for IPv4');
        }
    }
}


1		<?php
2		/**
3		* Copyright 2016 François Kooman <[email protected]>.
4		*
5		* Licensed under the Apache License, Version 2.0 (the "License");
6		* you may not use this file except in compliance with the License.
7		* You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17
18		namespace fkooman\VPN\Server;
19
20		use InvalidArgumentException;
21
22		class IP
23		{
24		/** @var string */
25		private $ipAddress;
26
27		/** @var int */
28		private $ipPrefix;
29
30		/** @var int */
31		private $ipFamily;
32
33		public function __construct($ipAddressPrefix)
34		{
35		// detect if there is a prefix
36		$hasPrefix = false !== strpos($ipAddressPrefix, '/');
37		if ($hasPrefix) {
38		list($ipAddress, $ipPrefix) = explode('/', $ipAddressPrefix);
39		} else {
40		$ipAddress = $ipAddressPrefix;
41		$ipPrefix = null;
42		}
43
44		// validate the IP address
45		if (false === filter_var($ipAddress, FILTER_VALIDATE_IP)) {
46		throw new IPException('invalid IP address');
47		}
48
49		$is6 = false !== strpos($ipAddress, ':');
50		if ($is6) {
51		if (is_null($ipPrefix)) {
52		$ipPrefix = 128;
53		}
54
55	View Code Duplication	if (!is_numeric($ipPrefix) \|\| 0 > $ipPrefix \|\| 128 < $ipPrefix) {
		0 ignored issues – show Duplication introduced 2016-05-18 12:21 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
56		throw new IPException('IP prefix must be a number between 0 and 128');
57		}
58		// normalize the IPv6 address
59		$ipAddress = inet_ntop(inet_pton($ipAddress));
60		} else {
61		if (is_null($ipPrefix)) {
62		$ipPrefix = 32;
63		}
64	View Code Duplication	if (!is_numeric($ipPrefix) \|\| 0 > $ipPrefix \|\| 32 < $ipPrefix) {
		0 ignored issues – show Duplication introduced 2016-05-18 12:21 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
65		throw new IPException('IP prefix must be a number between 0 and 32');
66		}
67		}
68
69		$this->ipAddress = $ipAddress;
70		$this->ipPrefix = (int) $ipPrefix;
71		$this->ipFamily = $is6 ? 6 : 4;
72		}
73
74		public function getAddress()
75		{
76		return $this->ipAddress;
77		}
78
79		public function getPrefix()
80		{
81		return $this->ipPrefix;
82		}
83
84		public function getAddressPrefix()
85		{
86		return sprintf('%s/%d', $this->getAddress(), $this->getPrefix());
87		}
88
89		public function getFamily()
90		{
91		return $this->ipFamily;
92		}
93
94		/**
95		* IPv4 only.
96		*/
97		public function getNetmask()
98		{
99		$this->requireIPv4();
100
101		return long2ip(-1 << (32 - $this->getPrefix()));
102		}
103
104		/**
105		* IPv4 only.
106		*/
107		public function getNetwork()
108		{
109		$this->requireIPv4();
110
111		return long2ip(ip2long($this->getAddress()) & ip2long($this->getNetmask()));
112		}
113
114		/**
115		* IPv4 only.
116		*/
117		public function getNumberOfHosts()
118		{
119		$this->requireIPv4();
120
121		return pow(2, 32 - $this->getPrefix()) - 2;
122		}
123
124		public function split($networkCount)
125		{
126		if (!is_int($networkCount)) {
127		throw new InvalidArgumentException('parameter must be integer');
128		}
129
130		if (0 !== ($networkCount & ($networkCount - 1))) {
131		throw new InvalidArgumentException('parameter must be power of 2');
132		}
133
134		if (4 === $this->getFamily()) {
135		return $this->split4($networkCount);
136		}
137
138		return $this->split6($networkCount);
139		}
140
141		private function split4($networkCount)
142		{
143		if (pow(2, 32 - $this->getPrefix() - 2) < $networkCount) {
144		throw new IPException('network too small to split in this many networks');
145		}
146
147		$prefix = $this->getPrefix() + log($networkCount, 2);
148		$splitRanges = [];
149		for ($i = 0; $i < $networkCount; ++$i) {
150		$noHosts = pow(2, 32 - $prefix);
151		$networkAddress = long2ip($i * $noHosts + ip2long($this->getAddress()));
152		$splitRanges[] = new self($networkAddress.'/'.$prefix);
153		}
154
155		return $splitRanges;
156		}
157
158		private function split6($networkCount)
159		{
160		// NOTE: if networkCount == 1, then there will be one /64 returned, and not
161		// the whole net!
162		if (64 <= $this->getPrefix()) {
163		throw new IPException('network too small to split up, must be bigger than /64');
164		}
165
166		if (0 !== $this->getPrefix() % 4) {
167		throw new IPException('network prefix length must be divisible by 4');
168		}
169
170		if (pow(2, 64 - $this->getPrefix()) < $networkCount) {
171		throw new IPException('network too small to split in this many networks');
172		}
173
174		$hexAddress = bin2hex(inet_pton($this->getAddress()));
175		// strip the last digits based on prefix size
176		$hexAddress = substr($hexAddress, 0, 16 - ((64 - $this->getPrefix()) / 4));
177
178		$splitRanges = [];
179		for ($i = 0; $i < $networkCount; ++$i) {
180		// pad with zeros until there is enough space for or network number
181		$paddedHexAddress = str_pad($hexAddress, 16 - strlen(dechex($i)), '0');
182		// append the network number
183		$hexAddressWithNetwork = $paddedHexAddress.dechex($i);
184		// pad it to the end and convert back to IPv6 address
185		$splitRanges[] = new self(sprintf('%s/64', inet_ntop(hex2bin(str_pad($hexAddressWithNetwork, 32, '0')))));
186		}
187
188		return $splitRanges;
189		}
190
191		public function __toString()
192		{
193		return $this->getAddressPrefix();
194		}
195
196		private function requireIPv4()
197		{
198		if (4 !== $this->getFamily()) {
199		throw new IPException('method only for IPv4');
200		}
201		}
202		}
203

eduVPN / vpn-server-api

GitHub Access Token became invalid

Push — master ( 7d41ca...d0cd6b )

IP::getNumberOfHosts() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like