Fixed fatal error breakage (bug 19562)
[lhc/web/wiklou.git] / includes / IP.php
index d9906c5..a2a3547 100644 (file)
@@ -22,7 +22,12 @@ define( 'RE_IPV6_PREFIX', '(12[0-8]|1[01][0-9]|[1-9]?\d)');
 define( 'RE_IPV6_ADD', '(:(:' . RE_IPV6_WORD . '){1,7}|' . RE_IPV6_WORD . '(:{1,2}' . RE_IPV6_WORD . '|::$){1,7})' );
 define( 'RE_IPV6_BLOCK', RE_IPV6_ADD . '\/' . RE_IPV6_PREFIX );
 // This might be useful for regexps used elsewhere, matches any IPv6 or IPv6 address or network
-define( 'IP_ADDRESS_STRING', RE_IP_ADD . '(\/' . RE_IP_PREFIX . '|)|' . RE_IPV6_ADD . '(\/' . RE_IPV6_PREFIX . '|)');
+define( 'IP_ADDRESS_STRING',
+       '(?:' .
+               RE_IP_ADD . '(\/' . RE_IP_PREFIX . '|)' .
+       '|' .
+               RE_IPV6_ADD . '(\/' . RE_IPV6_PREFIX . '|)' .
+       ')' );
 
 /**
  * A collection of public static functions to play with IP address
@@ -37,27 +42,33 @@ class IP {
         */
        public static function isIPAddress( $ip ) {
                if ( !$ip ) return false;
+               if ( is_array( $ip ) ) {
+                 throw new MWException( "invalid value passed to " . __METHOD__ );
+               }
                // IPv6 IPs with two "::" strings are ambiguous and thus invalid
                return preg_match( '/^' . IP_ADDRESS_STRING . '$/', $ip) && ( substr_count($ip, '::') < 2 );
        }
-       
+
        public static function isIPv6( $ip ) {
                if ( !$ip ) return false;
+               if( is_array( $ip ) ) {
+                 throw new MWException( "invalid value passed to " . __METHOD__ );
+               }
                // IPv6 IPs with two "::" strings are ambiguous and thus invalid
                return preg_match( '/^' . RE_IPV6_ADD . '(\/' . RE_IPV6_PREFIX . '|)$/', $ip) && ( substr_count($ip, '::') < 2);
        }
-       
+
        public static function isIPv4( $ip ) {
                if ( !$ip ) return false;
                return preg_match( '/^' . RE_IP_ADD . '(\/' . RE_IP_PREFIX . '|)$/', $ip);
        }
-       
+
        /**
         * Given an IP address in dotted-quad notation, returns an IPv6 octet.
         * See http://www.answers.com/topic/ipv4-compatible-address
         * IPs with the first 92 bits as zeros are reserved from IPv6
         * @param $ip quad-dotted IP address.
-        * @return string 
+        * @return string
         */
        public static function IPv4toIPv6( $ip ) {
                if ( !$ip ) return null;
@@ -95,21 +106,22 @@ class IP {
         $r_ip = wfBaseConvert( $r_ip, 16, 10 );
                return $r_ip;
        }
-       
+
        /**
         * Given an IPv6 address in octet notation, returns the expanded octet.
         * IPv4 IPs will be trimmed, thats it...
         * @param $ip octet ipv6 IP address.
-        * @return string 
-        */     
+        * @return string
+        */
        public static function sanitizeIP( $ip ) {
-               if ( !$ip ) return null;
+               $ip = trim( $ip );
+               if ( $ip === '' ) return null;
                // Trim and return IPv4 addresses
-               if ( self::isIPv4($ip) ) return trim($ip);
+               if ( self::isIPv4($ip) ) return $ip;
                // Only IPv6 addresses can be expanded
                if ( !self::isIPv6($ip) ) return $ip;
                // Remove any whitespaces, convert to upper case
-               $ip = strtoupper( trim($ip) );
+               $ip = strtoupper( $ip );
                // Expand zero abbreviations
                if ( strpos( $ip, '::' ) !== false ) {
                $ip = str_replace('::', str_repeat(':0', 8 - substr_count($ip, ':')) . ':', $ip);
@@ -120,16 +132,16 @@ class IP {
        $ip = preg_replace( '/(^|:)0+' . RE_IPV6_WORD . '/', '$1$2', $ip );
        return $ip;
        }
-       
+
        /**
         * Given an unsigned integer, returns an IPv6 address in octet notation
         * @param $ip integer IP address.
-        * @return string 
+        * @return string
         */
        public static function toOctet( $ip_int ) {
                // Convert to padded uppercase hex
                $ip_hex = wfBaseConvert($ip_int, 10, 16, 32, false);
-               // Seperate into 8 octets
+               // Separate into 8 octets
                $ip_oct = substr( $ip_hex, 0, 4 );
                for ($n=1; $n < 8; $n++) {
                        $ip_oct .= ':' . substr($ip_hex, 4*$n, 4);
@@ -139,6 +151,52 @@ class IP {
                return $ip_oct;
        }
 
+       /**
+        * Convert an IPv4 or IPv6 hexadecimal representation back to readable format
+        */
+       public static function formatHex( $hex ) {
+               if ( substr( $hex, 0, 3 ) == 'v6-' ) {
+                       return self::hexToOctet( $hex );
+               } else {
+                       return self::hexToQuad( $hex );
+               }
+       }
+       
+       /**
+        * Given a hexadecimal number, returns to an IPv6 address in octet notation
+        * @param $ip string hex IP
+        * @return string
+        */
+       public static function hextoOctet( $ip_hex ) {
+               // Convert to padded uppercase hex
+               $ip_hex = str_pad( strtoupper($ip_hex), 32, '0');
+               // Separate into 8 octets
+               $ip_oct = substr( $ip_hex, 0, 4 );
+               for ($n=1; $n < 8; $n++) {
+                       $ip_oct .= ':' . substr($ip_hex, 4*$n, 4);
+               }
+               // NO leading zeroes
+               $ip_oct = preg_replace( '/(^|:)0+' . RE_IPV6_WORD . '/', '$1$2', $ip_oct );
+               return $ip_oct;
+       }
+       
+       /**
+        * Converts a hexadecimal number to an IPv4 address in octet notation
+        * @param $ip string Hex IP
+        * @return string
+        */ 
+       public static function hexToQuad( $ip ) {
+               // Converts a hexadecimal IP to nnn.nnn.nnn.nnn format
+               $s = '';
+               for ( $i = 0; $i < 4; $i++ ) {
+                       if ( $s !== '' ) {
+                               $s .= '.';
+                       }
+                       $s .= base_convert( substr( $ip, $i * 2, 2 ), 16, 10 );
+               }
+               return $s;
+       }
+
        /**
         * Convert a network specification in IPv6 CIDR notation to an integer network and a number of bits
         * @return array(string, int)
@@ -169,9 +227,9 @@ class IP {
                }
                return array( $network, $bits );
        }
-       
+
        /**
-        * Given a string range in a number of formats, return the start and end of 
+        * Given a string range in a number of formats, return the start and end of
         * the range in hexadecimal. For IPv6.
         *
         * Formats are:
@@ -197,7 +255,7 @@ class IP {
                                # Convert to hex
                                $end = wfBaseConvert( $end, 2, 16, 32, false );
                                # see toHex() comment
-                               $start = "ipv6-$start"; $end = "ipv6-$end";
+                               $start = "v6-$start"; $end = "v6-$end";
                        }
                } elseif ( strpos( $range, '-' ) !== false ) {
                        # Explicit range
@@ -210,7 +268,7 @@ class IP {
                                $end = wfBaseConvert( $end, 10, 16, 32, false );
                        }
                        # see toHex() comment
-                       $start = "ipv6-$start"; $end = "ipv6-$end";
+                       $start = "v6-$start"; $end = "v6-$end";
                } else {
                        # Single IP
                        $start = $end = self::toHex( $range );
@@ -221,7 +279,7 @@ class IP {
                        return array( $start, $end );
                }
     }
-       
+
        /**
         * Validate an IP address.
         * @return boolean True if it is valid.
@@ -280,7 +338,7 @@ class IP {
         * Split out an IP block as an array of 4 bytes and a mask,
         * return false if it can't be determined
         *
-        * @parameter $ip string A quad dotted/octet IP address
+        * @param $ip string A quad dotted/octet IP address
         * @return array
         */
        public static function toArray( $ipblock ) {
@@ -298,7 +356,7 @@ class IP {
         * Return a zero-padded hexadecimal representation of an IP address.
         *
         * Hexadecimal addresses are used because they can easily be extended to
-        * IPv6 support. To separate the ranges, the return value from this 
+        * IPv6 support. To separate the ranges, the return value from this
         * function for an IPv6 address will be prefixed with "v6-", a non-
         * hexadecimal string which sorts after the IPv4 addresses.
         *
@@ -308,7 +366,7 @@ class IP {
        public static function toHex( $ip ) {
                $n = self::toUnsigned( $ip );
                if ( $n !== false ) {
-                       $n = ( self::isIPv6($ip) ) ? "v6-" . wfBaseConvert( $n, 10, 16, 32, false ) : wfBaseConvert( $n, 10, 16, 8, false );
+                       $n = self::isIPv6($ip) ? "v6-" . wfBaseConvert( $n, 10, 16, 32, false ) : wfBaseConvert( $n, 10, 16, 8, false );
                }
                return $n;
        }
@@ -384,17 +442,17 @@ class IP {
        }
 
        /**
-        * Given a string range in a number of formats, return the start and end of 
+        * Given a string range in a number of formats, return the start and end of
         * the range in hexadecimal.
         *
         * Formats are:
         *     1.2.3.4/24          CIDR
         *     1.2.3.4 - 1.2.3.5   Explicit range
         *     1.2.3.4             Single IP
-        * 
+        *
         *     2001:0db8:85a3::7344/96                                   CIDR
         *     2001:0db8:85a3::7344 - 2001:0db8:85a3::7344   Explicit range
-        *     2001:0db8:85a3::7344/96                                   Single IP
+        *     2001:0db8:85a3::7344                                      Single IP
         * @return array(string, int)
         */
        public static function parseRange( $range ) {
@@ -414,12 +472,16 @@ class IP {
                } elseif ( strpos( $range, '-' ) !== false ) {
                        # Explicit range
                        list( $start, $end ) = array_map( 'trim', explode( '-', $range, 2 ) );
-                       $start = self::toUnsigned( $start ); $end = self::toUnsigned( $end );
-                       if ( $start > $end ) {
-                               $start = $end = false;
+                       if( self::isIPAddress( $start ) && self::isIPAddress( $end ) ) {
+                               $start = self::toUnsigned( $start ); $end = self::toUnsigned( $end );
+                               if ( $start > $end ) {
+                                       $start = $end = false;
+                               } else {
+                                       $start = sprintf( '%08X', $start );
+                                       $end = sprintf( '%08X', $end );
+                               }
                        } else {
-                               $start = sprintf( '%08X', $start );
-                               $end = sprintf( '%08X', $end );
+                               $start = $end = false;
                        }
                } else {
                        # Single IP
@@ -427,7 +489,7 @@ class IP {
                }
                if ( $start === false || $end === false ) {
                        return array( false, false );
-               } else {                                
+               } else {
                        return array( $start, $end );
                }
     }
@@ -440,9 +502,10 @@ class IP {
      */
     public static function isInRange( $addr, $range ) {
     // Convert to IPv6 if needed
-        $unsignedIP = self::toHex( $addr );
+        $hexIP = self::toHex( $addr );
         list( $start, $end ) = self::parseRange( $range );
-        return (($unsignedIP >= $start) && ($unsignedIP <= $end));
+        return (strcmp($hexIP, $start) >= 0 &&
+               strcmp($hexIP, $end) <= 0);
     }
 
     /**
@@ -456,22 +519,27 @@ class IP {
      * @return valid dotted quad IPv4 address or null
      */
     public static function canonicalize( $addr ) {
-       if ( self::isValid( $addr ) )
-           return $addr;
+               if ( self::isValid( $addr ) )
+                       return $addr;
 
-       // IPv6 loopback address
-       $m = array();
-       if ( preg_match( '/^0*' . RE_IPV6_GAP . '1$/', $addr, $m ) )
-           return '127.0.0.1';
+               // Annoying IPv6 representations like ::ffff:1.2.3.4
+               if ( strpos($addr,':') !==false && strpos($addr,'.') !==false ) {
+                       $addr = str_replace( '.', ':', $addr );
+                       if( IP::isIPv6( $addr ) )
+                               return $addr;
+               }
+
+               // IPv6 loopback address
+               $m = array();
+               if ( preg_match( '/^0*' . RE_IPV6_GAP . '1$/', $addr, $m ) )
+                       return '127.0.0.1';
 
-       // IPv4-mapped and IPv4-compatible IPv6 addresses
-       if ( preg_match( '/^' . RE_IPV6_V4_PREFIX . '(' . RE_IP_ADD . ')$/i', $addr, $m ) )
-           return $m[1];
-       if ( preg_match( '/^' . RE_IPV6_V4_PREFIX . RE_IPV6_WORD . ':' . RE_IPV6_WORD . '$/i', $addr, $m ) )
-           return long2ip( ( hexdec( $m[1] ) << 16 ) + hexdec( $m[2] ) );
+               // IPv4-mapped and IPv4-compatible IPv6 addresses
+               if ( preg_match( '/^' . RE_IPV6_V4_PREFIX . '(' . RE_IP_ADD . ')$/i', $addr, $m ) )
+                   return $m[1];
+               if ( preg_match( '/^' . RE_IPV6_V4_PREFIX . RE_IPV6_WORD . ':' . RE_IPV6_WORD . '$/i', $addr, $m ) )
+                   return long2ip( ( hexdec( $m[1] ) << 16 ) + hexdec( $m[2] ) );
 
-       return null;  // give up
+               return null;  // give up
     }
 }
-
-?>