Changeset 5501

Timestamp:

05/19/2017 06:53:29 PM (7 years ago)

Author:

iandunn

Message:

Events: Support IPv6 address geolocation.

See #2823
Props coreymckrill

Location:

sites/trunk/api.wordpress.org/public_html/events/1.0

Files:

• index.php (modified) (3 diffs)
• tests/test-index.php (modified) (2 diffs)

sites/trunk/api.wordpress.org/public_html/events/1.0/index.php

@@ -385 +385 @@
  *       See `rebuild_location_from_geonames()`.
  *
- * @todo - Add support for IPv6 addresses. Otherwise, this will quickly lose effectiveness. As of March 2017, IPv6
- *         adoption is at 16% globally and rising relatively fast. Some countries are as high as 30%.
- *         See https://www.google.com/intl/en/ipv6/statistics.html#tab=ipv6-adoption for current stats.
- *
- * @todo - Core sends anonymized IPs like `2a03:2880:2110:df07::`, so make sure those work when implementing IPv6
- *
  * @param string $dotted_ip
  *
@@ -398 +392 @@
     global $wpdb;
 
-    $long_ip = ip2long( $dotted_ip );
-    if ( $long_ip === false )
+    $long_ip = false;
+
+    if ( filter_var( $dotted_ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 ) ) {
+        $long_ip = ip2long( $dotted_ip );
+        $from    = 'ip2location';
+        $where   = 'ip_to >= %d';
+    } else if ( filter_var( $dotted_ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6 ) ) {
+        $long_ip = _ip2long_v6( $dotted_ip );
+        $from    = 'ipv62location';
+        $where   = "ip_to >= CAST( %s AS DECIMAL( 39, 0 ) )";
+    }
+
+    if ( false === $long_ip || ! isset( $from, $where ) ) {
         return;
+    }
 
     $row = $wpdb->get_row( $wpdb->prepare( "
         SELECT ip_city, ip_latitude, ip_longitude, country_short
-        FROM ip2location
-        WHERE ip_to >= %d
+        FROM $from
+        WHERE $where
         ORDER BY ip_to ASC
         LIMIT 1",
@@ -417 +423 @@
 
     return $row;
+}
+
+/**
+ * Convert an IPv6 address to an IP number than can be queried in the ip2location database.
+ *
+ * PHP doesn't handle integers large enough to accommodate IPv6 numbers (128 bit), so the number needs
+ * to be cast as a string.
+ *
+ * @link https://en.wikipedia.org/wiki/IPv6
+ * @link http://php.net/manual/en/language.types.integer.php
+ *
+ * The code in this function is based on an answer here: http://lite.ip2location.com/faqs
+ *
+ * Uses `inet_pton()` which correctly parses truncated IPv6 addresses such as `2a03:2880:2110:df07::`.
+ * That is important, because Core will send anonymized addresses instead of complete ones.
+ *
+ * @access private
+ *
+ * @param string $address The IPv6 address to convert.
+ *
+ * @return string|bool `false` if invalid address. Otherwise an IP number cast as a string.
+ */
+function _ip2long_v6( $address ) {
+    $int = inet_pton( $address );
+
+    if ( false === $int ) {
+        return false;
+    }
+
+    $bits     = 15;
+    $ipv6long = 0;
+
+    while ( $bits >= 0 ) {
+        $bin = sprintf( "%08b", ( ord( $int[ $bits ] ) ) );
+
+        if ( $ipv6long ) {
+            $ipv6long = $bin . $ipv6long;
+        } else {
+            $ipv6long = $bin;
+        }
+
+        $bits--;
+    }
+
+    $ipv6long = gmp_strval( gmp_init( $ipv6long, 2 ), 10 );
+
+    return $ipv6long;
 }
 

sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php

@@ -719 +719 @@
 
         /*
-         * Only the IP is given
+         * Only the IPv4 address is given
+         *
+         * See https://awebanalysis.com/en/ipv4-directory/
          */
         'ip-africa' => array(
@@ -786 +788 @@
             ),
         ),
+
+        /*
+         * Only an IPv6 address is given
+         *
+         * See https://www.google.com/intl/en/ipv6/statistics.html#tab=per-country-ipv6-adoption&tab=per-country-ipv6-adoption
+         * See https://awebanalysis.com/en/ipv6-directory/
+         * See https://www.google.com/search?q=australia+site%3Ahttps%3A%2F%2Fawebanalysis.com%2Fen%2Fipv6-directory%2F
+         */
+        'ipv6-africa' => array(
+            'input'    => array( 'ip' => '2c0f:f8f0:ffff:ffff:ffff:ffff:ffff:ffff' ),
+            'expected' => array(
+                'description' => 'harare',
+                'latitude'    => '-17.829',
+                'longitude'   => '31.054',
+                'country'     => 'ZW',
+                'internal'    => true,
+            ),
+        ),
+
+        'ipv6-asia-anonymized' => array(
+            'input'    => array( 'ip' => '2405:200:1000::' ),
+            'expected' => array(
+                'description' => 'mumbai',
+                'latitude'    => '19.014',
+                'longitude'   => '72.848',
+                'country'     => 'IN',
+                'internal'    => true,
+            ),
+        ),
+
+        'ipv6-europe-anonymized' => array(
+            'input'    => array( 'ip' => '2a02:578:1000::' ),
+            'expected' => array(
+                'description' => 'sint-niklaas',
+                'latitude'    => '51.165',
+                'longitude'   => '4.144',
+                'country'     => 'BE',
+                'internal'    => true,
+            ),
+        ),
+
+        'ipv6-north-america-anonymized' => array(
+            'input'    => array( 'ip' => '2605:a600::' ),
+            'expected' => array(
+                'description' => 'mountain view',
+                'latitude'    => '37.386',
+                'longitude'   => '-122.084',
+                'country'     => 'US',
+                'internal'    => true,
+            ),
+        ),
+
+        'ipv6-oceania-collapsed-prefix' => array(
+            'input'    => array( 'ip' => '::ffff:0190:c500' ),
+            'expected' => array(
+                'description' => 'quedjinup',
+                'latitude'    => '-33.634',
+                'longitude'   => '115.084',
+                'country'     => 'AU',
+                'internal'    => true,
+            ),
+        ),
+
+        'ipv6-south-america' => array(
+            'input'    => array( 'ip' => '2001:1388:6643:2736:10f1:897c:428c:1b3b' ),
+            'expected' => array(
+                'description' => 'ayacucho',
+                'latitude'    => '-13.158',
+                'longitude'   => '-74.224',
+                'country'     => 'PE',
+                'internal'    => true,
+            ),
+        ),
     );
 
-     return $cases;
+    return $cases;
 }