From 7107fac0440735b4ba18120312e0c99dc61073ec Mon Sep 17 00:00:00 2001 From: Glaisher Date: Mon, 7 Mar 2016 22:32:21 +0500 Subject: [PATCH] Add note that IP::isInRange() can return unexpected results for invalid args Also change to use @note tags in IP class. Bug: T124117 Change-Id: Ia81bb1669f55ebfc559121f5d7166be9e3fa2b6f --- includes/utils/IP.php | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/includes/utils/IP.php b/includes/utils/IP.php index bcc2ed3828..4a2205eebb 100644 --- a/includes/utils/IP.php +++ b/includes/utils/IP.php @@ -73,7 +73,7 @@ class IP { /** * Determine if a string is as valid IP address or network (CIDR prefix). * SIIT IPv4-translated addresses are rejected. - * Note: canonicalize() tries to convert translated addresses to IPv4. + * @note canonicalize() tries to convert translated addresses to IPv4. * * @param string $ip Possible IP address * @return bool @@ -84,7 +84,7 @@ class IP { /** * Given a string, determine if it as valid IP in IPv6 only. - * Note: Unlike isValid(), this looks for networks too. + * @note Unlike isValid(), this looks for networks too. * * @param string $ip Possible IP address * @return bool @@ -95,7 +95,7 @@ class IP { /** * Given a string, determine if it as valid IP in IPv4 only. - * Note: Unlike isValid(), this looks for networks too. + * @note Unlike isValid(), this looks for networks too. * * @param string $ip Possible IP address * @return bool @@ -107,7 +107,7 @@ class IP { /** * Validate an IP address. Ranges are NOT considered valid. * SIIT IPv4-translated addresses are rejected. - * Note: canonicalize() tries to convert translated addresses to IPv4. + * @note canonicalize() tries to convert translated addresses to IPv4. * * @param string $ip * @return bool True if it is valid @@ -120,7 +120,7 @@ class IP { /** * Validate an IP Block (valid address WITH a valid prefix). * SIIT IPv4-translated addresses are rejected. - * Note: canonicalize() tries to convert translated addresses to IPv4. + * @note canonicalize() tries to convert translated addresses to IPv4. * * @param string $ipblock * @return bool True if it is valid @@ -633,6 +633,9 @@ class IP { * @param string $addr The address to check against the given range. * @param string $range The range to check the given address against. * @return bool Whether or not the given address is in the given range. + * + * @note This can return unexpected results for invalid arguments! + * Make sure you pass a valid IP address and IP range. */ public static function isInRange( $addr, $range ) { $hexIP = self::toHex( $addr ); -- 2.20.1