<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[5501] sites/trunk/api.wordpress.org/public_html/events/1.0: Events: Support IPv6 address geolocation.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/5501">5501</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/5501","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-05-19 18:53:29 +0000 (Fri, 19 May 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Events: Support IPv6 address geolocation.
See <a href="http://meta.trac.wordpress.org/ticket/2823">#2823</a>
Props coreymckrill</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlevents10indexphp">sites/trunk/api.wordpress.org/public_html/events/1.0/index.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlevents10teststestindexphp">sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmlevents10indexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/events/1.0/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2017-05-18 07:07:40 UTC (rev 5500)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2017-05-19 18:53:29 UTC (rev 5501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -384,12 +384,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * NOTE: The location that is found here cannot be returned to the client.
</span><span class="cx" style="display: block; padding: 0 10px"> * See `rebuild_location_from_geonames()`.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @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
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @param string $dotted_ip
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return null|object `null` on failure; an object on success
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -397,14 +391,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function guess_location_from_ip( $dotted_ip ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $long_ip = ip2long( $dotted_ip );
- if ( $long_ip === false )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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 ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $row = $wpdb->get_row( $wpdb->prepare( "
</span><span class="cx" style="display: block; padding: 0 10px"> SELECT ip_city, ip_latitude, ip_longitude, country_short
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- FROM ip2location
- WHERE ip_to >= %d
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ FROM $from
+ WHERE $where
</ins><span class="cx" style="display: block; padding: 0 10px"> ORDER BY ip_to ASC
</span><span class="cx" style="display: block; padding: 0 10px"> LIMIT 1",
</span><span class="cx" style="display: block; padding: 0 10px"> $long_ip
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -419,6 +425,53 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Rebuild the location given to the client from the event source data
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * We cannot publicly expose location data that we retrieve from the `ip2location` database, because that would
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmlevents10teststestindexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php 2017-05-18 07:07:40 UTC (rev 5500)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php 2017-05-19 18:53:29 UTC (rev 5501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -718,7 +718,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Only the IP is given
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Only the IPv4 address is given
+ *
+ * See https://awebanalysis.com/en/ipv4-directory/
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> 'ip-africa' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'input' => array( 'ip' => '41.191.232.22' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -785,9 +787,82 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'internal' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /*
+ * 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,
+ ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $cases;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $cases;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> run_tests();
</span></span></pre>
</div>
</div>
</body>
</html>