fix synxtax
[lhc/web/wiklou.git] / includes / IP.php
index 9567f1e..db712c3 100644 (file)
@@ -1,8 +1,5 @@
 <?php
 /*
- * Collection of public static functions to play with IP address
- * and IP blocks.
- *
  * @Author "Ashar Voultoiz" <hashar@altern.org>
  * @License GPL v2 or later
  */
@@ -25,8 +22,17 @@ 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
+ * and IP blocks.
+ */
 class IP {
        /**
         * Given a string, determine if it as valid IP
@@ -36,12 +42,18 @@ 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);
        }
@@ -89,36 +101,35 @@ class IP {
                $ip = explode(':', self::sanitizeIP( $ip ) );
                $r_ip = '';
                foreach ($ip as $v) {
-                       $r_ip .= wfBaseConvert( $v, 16, 2, 16);
+                       $r_ip .= str_pad( $v, 4, 0, STR_PAD_LEFT );
         }
-               return wfBaseConvert($r_ip, 2, 10);
+        $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 
         */     
        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) );
-               // Expand zero abbreviations
-               if ( substr_count($ip, '::') ) {
+               $ip = strtoupper( $ip );
+               // Expand zero abbreviations
+               if ( strpos( $ip, '::' ) !== false ) {
                $ip = str_replace('::', str_repeat(':0', 8 - substr_count($ip, ':')) . ':', $ip);
        }
        // For IPs that start with "::", correct the final IP so that it starts with '0' and not ':'
-       if ( strpos( $ip, ':' ) === 0 ) $ip = "0$ip";
+       if ( $ip[0] == ':' ) $ip = "0$ip";
        // Remove leading zereos from each bloc as needed
-       $ip = explode( ':', $ip );
-       for ( $n=0; $n < count($ip); $n++ ) {
-               $ip[$n] = preg_replace( '/^0+' . RE_IPV6_WORD . '/', '$1', $ip[$n] );
-       }
-       $ip = implode( ':', $ip );
+       $ip = preg_replace( '/(^|:)0+' . RE_IPV6_WORD . '/', '$1$2', $ip );
        return $ip;
        }
        
@@ -128,14 +139,15 @@ class IP {
         * @return string 
         */
        public static function toOctet( $ip_int ) {
-               // Convert integer to binary
-               $ip_int = wfBaseConvert($ip_int, 10, 2, 128);
+               // Convert to padded uppercase hex
+               $ip_hex = wfBaseConvert($ip_int, 10, 16, 32, false);
                // Seperate into 8 octets
-               $ip_oct = wfBaseConvert( substr( $ip_int, 0, 16 ), 2, 16, 1, false );
+               $ip_oct = substr( $ip_hex, 0, 4 );
                for ($n=1; $n < 8; $n++) {
-                       // Convert to uppercase hex, and add ":" marks, with NO leading zeroes
-                       $ip_oct .= ':' . wfBaseConvert( substr($ip_int, 16*$n, 16), 2, 16, 1, false );
+                       $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;
        }
 
@@ -167,7 +179,6 @@ class IP {
                        $network = false;
                        $bits = false;
                }
-               
                return array( $network, $bits );
        }
        
@@ -197,6 +208,8 @@ class IP {
                                $end = str_pad( substr( $end, 0, $bits ), 128, 1, STR_PAD_RIGHT );
                                # Convert to hex
                                $end = wfBaseConvert( $end, 2, 16, 32, false );
+                               # see toHex() comment
+                               $start = "v6-$start"; $end = "v6-$end";
                        }
                } elseif ( strpos( $range, '-' ) !== false ) {
                        # Explicit range
@@ -208,6 +221,8 @@ class IP {
                                $start = wfBaseConvert( $start, 10, 16, 32, false );
                                $end = wfBaseConvert( $end, 10, 16, 32, false );
                        }
+                       # see toHex() comment
+                       $start = "v6-$start"; $end = "v6-$end";
                } else {
                        # Single IP
                        $start = $end = self::toHex( $range );
@@ -277,7 +292,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 ) {
@@ -305,13 +320,13 @@ class IP {
        public static function toHex( $ip ) {
                $n = self::toUnsigned( $ip );
                if ( $n !== false ) {
-                       $n = ( self::isIPv6($ip) ) ? 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;
        }
 
        /**
-        * Given an IP address in dotted-quad notation, returns an unsigned integer.
+        * Given an IP address in dotted-quad/octet notation, returns an unsigned integer.
         * Like ip2long() except that it actually works and has a consistent error return value.
         * Comes from ProxyTools.php
         * @param $ip Quad dotted IP address.
@@ -382,12 +397,16 @@ class IP {
 
        /**
         * Given a string range in a number of formats, return the start and end of 
-        * the range in hexadecimal. For IPv4.
+        * 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                                      Single IP
         * @return array(string, int)
         */
        public static function parseRange( $range ) {
@@ -433,8 +452,8 @@ class IP {
      */
     public static function isInRange( $addr, $range ) {
     // Convert to IPv6 if needed
-        $unsignedIP = self::toUnsigned( $addr );
-        list( $start, $end ) = self::parseRange($range );
+        $unsignedIP = self::toHex( $addr );
+        list( $start, $end ) = self::parseRange( $range );
         return (($unsignedIP >= $start) && ($unsignedIP <= $end));
     }
 
@@ -449,22 +468,29 @@ 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
     }
 }
 
-?>
+