<?php

[0] Fix | Delete

[1] Fix | Delete

// SPDX-FileCopyrightText: 2004-2023 Ryan Parman, Sam Sneddon, Ryan McCue

[2] Fix | Delete

// SPDX-License-Identifier: BSD-3-Clause

[3] Fix | Delete

[4] Fix | Delete

declare(strict_types=1);

[5] Fix | Delete

[6] Fix | Delete

namespace SimplePie\Net;

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Class to validate and to work with IPv6 addresses.

[10] Fix | Delete

*

[11] Fix | Delete

* @copyright 2003-2005 The PHP Group

[12] Fix | Delete

* @license http://www.opensource.org/licenses/bsd-license.php

[13] Fix | Delete

* @link http://pear.php.net/package/Net_IPv6

[14] Fix | Delete

* @author Alexander Merz <alexander.merz@web.de>

[15] Fix | Delete

* @author elfrink at introweb dot nl

[16] Fix | Delete

* @author Josh Peck <jmp at joshpeck dot org>

[17] Fix | Delete

* @author Sam Sneddon <geoffers@gmail.com>

[18] Fix | Delete

*/

[19] Fix | Delete

class IPv6

[20] Fix | Delete

{

[21] Fix | Delete

/**

[22] Fix | Delete

* Uncompresses an IPv6 address

[23] Fix | Delete

*

[24] Fix | Delete

* RFC 4291 allows you to compress consecutive zero pieces in an address to

[25] Fix | Delete

* '::'. This method expects a valid IPv6 address and expands the '::' to

[26] Fix | Delete

* the required number of zero pieces.

[27] Fix | Delete

*

[28] Fix | Delete

* Example: FF01::101 -> FF01:0:0:0:0:0:0:101

[29] Fix | Delete

* ::1 -> 0:0:0:0:0:0:0:1

[30] Fix | Delete

*

[31] Fix | Delete

* @author Alexander Merz <alexander.merz@web.de>

[32] Fix | Delete

* @author elfrink at introweb dot nl

[33] Fix | Delete

* @author Josh Peck <jmp at joshpeck dot org>

[34] Fix | Delete

* @copyright 2003-2005 The PHP Group

[35] Fix | Delete

* @license http://www.opensource.org/licenses/bsd-license.php

[36] Fix | Delete

* @param string $ip An IPv6 address

[37] Fix | Delete

* @return string The uncompressed IPv6 address

[38] Fix | Delete

*/

[39] Fix | Delete

public static function uncompress(string $ip)

[40] Fix | Delete

{

[41] Fix | Delete

$c1 = -1;

[42] Fix | Delete

$c2 = -1;

[43] Fix | Delete

if (substr_count($ip, '::') === 1) {

[44] Fix | Delete

[$ip1, $ip2] = explode('::', $ip);

[45] Fix | Delete

if ($ip1 === '') {

[46] Fix | Delete

$c1 = -1;

[47] Fix | Delete

} else {

[48] Fix | Delete

$c1 = substr_count($ip1, ':');

[49] Fix | Delete

}

[50] Fix | Delete

if ($ip2 === '') {

[51] Fix | Delete

$c2 = -1;

[52] Fix | Delete

} else {

[53] Fix | Delete

$c2 = substr_count($ip2, ':');

[54] Fix | Delete

}

[55] Fix | Delete

if (strpos($ip2, '.') !== false) {

[56] Fix | Delete

$c2++;

[57] Fix | Delete

}

[58] Fix | Delete

// ::

[59] Fix | Delete

if ($c1 === -1 && $c2 === -1) {

[60] Fix | Delete

$ip = '0:0:0:0:0:0:0:0';

[61] Fix | Delete

}

[62] Fix | Delete

// ::xxx

[63] Fix | Delete

elseif ($c1 === -1) {

[64] Fix | Delete

$fill = str_repeat('0:', 7 - $c2);

[65] Fix | Delete

$ip = str_replace('::', $fill, $ip);

[66] Fix | Delete

}

[67] Fix | Delete

// xxx::

[68] Fix | Delete

elseif ($c2 === -1) {

[69] Fix | Delete

$fill = str_repeat(':0', 7 - $c1);

[70] Fix | Delete

$ip = str_replace('::', $fill, $ip);

[71] Fix | Delete

}

[72] Fix | Delete

// xxx::xxx

[73] Fix | Delete

else {

[74] Fix | Delete

$fill = ':' . str_repeat('0:', 6 - $c2 - $c1);

[75] Fix | Delete

$ip = str_replace('::', $fill, $ip);

[76] Fix | Delete

}

[77] Fix | Delete

}

[78] Fix | Delete

return $ip;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Compresses an IPv6 address

[83] Fix | Delete

*

[84] Fix | Delete

* RFC 4291 allows you to compress consecutive zero pieces in an address to

[85] Fix | Delete

* '::'. This method expects a valid IPv6 address and compresses consecutive

[86] Fix | Delete

* zero pieces to '::'.

[87] Fix | Delete

*

[88] Fix | Delete

* Example: FF01:0:0:0:0:0:0:101 -> FF01::101

[89] Fix | Delete

* 0:0:0:0:0:0:0:1 -> ::1

[90] Fix | Delete

*

[91] Fix | Delete

* @see uncompress()

[92] Fix | Delete

* @param string $ip An IPv6 address

[93] Fix | Delete

* @return string The compressed IPv6 address

[94] Fix | Delete

*/

[95] Fix | Delete

public static function compress(string $ip)

[96] Fix | Delete

{

[97] Fix | Delete

// Prepare the IP to be compressed

[98] Fix | Delete

$ip = self::uncompress($ip);

[99] Fix | Delete

$ip_parts = self::split_v6_v4($ip);

[100] Fix | Delete

[101] Fix | Delete

// Replace all leading zeros

[102] Fix | Delete

$ip_parts[0] = (string) preg_replace('/(^|:)0+([0-9])/', '\1\2', $ip_parts[0]);

[103] Fix | Delete

[104] Fix | Delete

// Find bunches of zeros

[105] Fix | Delete

if (preg_match_all('/(?:^|:)(?:0(?::|$))+/', $ip_parts[0], $matches, PREG_OFFSET_CAPTURE)) {

[106] Fix | Delete

$max = 0;

[107] Fix | Delete

$pos = null;

[108] Fix | Delete

foreach ($matches[0] as $match) {

[109] Fix | Delete

if (strlen($match[0]) > $max) {

[110] Fix | Delete

$max = strlen($match[0]);

[111] Fix | Delete

$pos = $match[1];

[112] Fix | Delete

}

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

assert($pos !== null, 'For PHPStan: Since the regex matched, there is at least one match. And because the pattern is non-empty, the loop will always end with $pos ≥ 1.');

[116] Fix | Delete

$ip_parts[0] = substr_replace($ip_parts[0], '::', $pos, $max);

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

if ($ip_parts[1] !== '') {

[120] Fix | Delete

return implode(':', $ip_parts);

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

return $ip_parts[0];

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

/**

[127] Fix | Delete

* Splits an IPv6 address into the IPv6 and IPv4 representation parts

[128] Fix | Delete

*

[129] Fix | Delete

* RFC 4291 allows you to represent the last two parts of an IPv6 address

[130] Fix | Delete

* using the standard IPv4 representation

[131] Fix | Delete

*

[132] Fix | Delete

* Example: 0:0:0:0:0:0:13.1.68.3

[133] Fix | Delete

* 0:0:0:0:0:FFFF:129.144.52.38

[134] Fix | Delete

*

[135] Fix | Delete

* @param string $ip An IPv6 address

[136] Fix | Delete

* @return array{string, string} [0] contains the IPv6 represented part, and [1] the IPv4 represented part

[137] Fix | Delete

*/

[138] Fix | Delete

private static function split_v6_v4(string $ip): array

[139] Fix | Delete

{

[140] Fix | Delete

if (strpos($ip, '.') !== false) {

[141] Fix | Delete

$pos = strrpos($ip, ':');

[142] Fix | Delete

assert($pos !== false, 'For PHPStan: IPv6 address must contain colon, since split_v6_v4 is only ever called after uncompress.');

[143] Fix | Delete

$ipv6_part = substr($ip, 0, $pos);

[144] Fix | Delete

$ipv4_part = substr($ip, $pos + 1);

[145] Fix | Delete

return [$ipv6_part, $ipv4_part];

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

return [$ip, ''];

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

/**

[152] Fix | Delete

* Checks an IPv6 address

[153] Fix | Delete

*

[154] Fix | Delete

* Checks if the given IP is a valid IPv6 address

[155] Fix | Delete

*

[156] Fix | Delete

* @param string $ip An IPv6 address

[157] Fix | Delete

* @return bool true if $ip is a valid IPv6 address

[158] Fix | Delete

*/

[159] Fix | Delete

public static function check_ipv6(string $ip)

[160] Fix | Delete

{

[161] Fix | Delete

$ip = self::uncompress($ip);

[162] Fix | Delete

[$ipv6, $ipv4] = self::split_v6_v4($ip);

[163] Fix | Delete

$ipv6 = explode(':', $ipv6);

[164] Fix | Delete

$ipv4 = explode('.', $ipv4);

[165] Fix | Delete

if (count($ipv6) === 8 && count($ipv4) === 1 || count($ipv6) === 6 && count($ipv4) === 4) {

[166] Fix | Delete

foreach ($ipv6 as $ipv6_part) {

[167] Fix | Delete

// The section can't be empty

[168] Fix | Delete

if ($ipv6_part === '') {

[169] Fix | Delete

return false;

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

// Nor can it be over four characters

[173] Fix | Delete

if (strlen($ipv6_part) > 4) {

[174] Fix | Delete

return false;

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

// Remove leading zeros (this is safe because of the above)

[178] Fix | Delete

$ipv6_part = ltrim($ipv6_part, '0');

[179] Fix | Delete

if ($ipv6_part === '') {

[180] Fix | Delete

$ipv6_part = '0';

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

// Check the value is valid

[184] Fix | Delete

$value = hexdec($ipv6_part);

[185] Fix | Delete

if ($value < 0 || $value > 0xFFFF) {

[186] Fix | Delete

return false;

[187] Fix | Delete

}

[188] Fix | Delete

assert(is_int($value), 'For PHPStan: $value is only float when $ipv6_part > PHP_INT_MAX');

[189] Fix | Delete

if (dechex($value) !== strtolower($ipv6_part)) {

[190] Fix | Delete

return false;

[191] Fix | Delete

}

[192] Fix | Delete

}

[193] Fix | Delete

if (count($ipv4) === 4) {

[194] Fix | Delete

foreach ($ipv4 as $ipv4_part) {

[195] Fix | Delete

$value = (int) $ipv4_part;

[196] Fix | Delete

if ((string) $value !== $ipv4_part || $value < 0 || $value > 0xFF) {

[197] Fix | Delete

return false;

[198] Fix | Delete

}

[199] Fix | Delete

}

[200] Fix | Delete

}

[201] Fix | Delete

return true;

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

return false;

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

/**

[208] Fix | Delete

* Checks if the given IP is a valid IPv6 address

[209] Fix | Delete

*

[210] Fix | Delete

* @codeCoverageIgnore

[211] Fix | Delete

* @deprecated Use {@see IPv6::check_ipv6()} instead

[212] Fix | Delete

* @see check_ipv6

[213] Fix | Delete

* @param string $ip An IPv6 address

[214] Fix | Delete

* @return bool true if $ip is a valid IPv6 address

[215] Fix | Delete

*/

[216] Fix | Delete

public static function checkIPv6(string $ip)

[217] Fix | Delete

{

[218] Fix | Delete

return self::check_ipv6($ip);

[219] Fix | Delete

}

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

class_alias('SimplePie\Net\IPv6', 'SimplePie_Net_IPv6');

[223] Fix | Delete

[224] Fix | Delete