<!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>[5491] sites/trunk/api.wordpress.org/public_html/events/1.0: Events: Replace IP geolocated data with venue location data</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/5491">5491</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/5491","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-16 21:08:27 +0000 (Tue, 16 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: Replace IP geolocated data with venue location data
See <a href="http://meta.trac.wordpress.org/ticket/2823">#2823</a></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-16 21:08:22 UTC (rev 5490)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2017-05-16 21:08:27 UTC (rev 5491)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,6 +125,10 @@
</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"> $events = get_events( $event_args );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( isset( $location['internal'] ) && $location['internal'] ) {
+ $location = rebuild_location_from_event_source( $events );
+ }
</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"> return compact( 'error', 'location', 'events', 'ttl' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -352,6 +356,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Determine a location for the given IPv4 address
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * NOTE: The location that is found here cannot be returned to the client.
+ * See `rebuild_location_from_geonames()`.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @todo - Add support for IPv6 addresses. Otherwise, this will quickly lose effectiveness. As of March 2017, IPv6
</span><span class="cx" style="display: block; padding: 0 10px"> * adoption is at 16% globally and rising relatively fast. Some countries are as high as 30%.
</span><span class="cx" style="display: block; padding: 0 10px"> * See https://www.google.com/intl/en/ipv6/statistics.html#tab=ipv6-adoption for current stats.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -387,6 +394,37 @@
</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">+ * Rebuild the location given to the client from the event source data
+ *
+ * We cannot publicly expose location data that we retrieve from the `ip2location` database, because that would
+ * violate their licensing terms. We can only use the information internally, for the purposes of completing the
+ * program's business logic (determining nearby events).
+ *
+ * Once we have nearby events, though, we can take advantage of the data that's available in the `wporg_events` table.
+ * That table contains the locations details for the event's venue, which was sourced from the respective APIs
+ * (WordCamp.org, Meetup.com, etc). We can return the venue's location data without violating any terms.
+ *
+ * See https://meta.trac.wordpress.org/ticket/2823#comment:15
+ * See https://meta.trac.wordpress.org/ticket/2823#comment:21
+ *
+ * @param array $events
+ *
+ * @return array
+ */
+function rebuild_location_from_event_source( $events ) {
+ $location = array();
+
+ foreach ( $events as $event ) {
+ if ( ! empty( $event['location']['location'] ) && ! empty( $event['location']['latitude'] ) ) {
+ $location = $event['location'];
+ break;
+ }
+ }
+
+ return $location;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Determine a location for the given parameters
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -495,6 +533,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'latitude' => $guess->ip_latitude,
</span><span class="cx" style="display: block; padding: 0 10px"> 'longitude' => $guess->ip_longitude,
</span><span class="cx" style="display: block; padding: 0 10px"> 'country' => $guess->country_short,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'internal' => true, // this location cannot be shared publicly, see `rebuild_location_from_geonames()`
</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"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -697,7 +736,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $bounded_box = get_bounded_coordinates( $args['nearby']['latitude'], $args['nearby']['longitude'], $distance );
</span><span class="cx" style="display: block; padding: 0 10px"> $nearby_where[] = '( `type` = %s AND `latitude` BETWEEN %f AND %f AND `longitude` BETWEEN %f AND %f )';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $sql_values[] = $type;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $sql_values[] = $type;
</ins><span class="cx" style="display: block; padding: 0 10px"> $sql_values[] = $bounded_box['latitude']['min'];
</span><span class="cx" style="display: block; padding: 0 10px"> $sql_values[] = $bounded_box['latitude']['max'];
</span><span class="cx" style="display: block; padding: 0 10px"> $sql_values[] = $bounded_box['longitude']['min'];
</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-16 21:08:22 UTC (rev 5490)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php 2017-05-16 21:08:27 UTC (rev 5491)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -717,6 +717,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'latitude' => '-17.829',
</span><span class="cx" style="display: block; padding: 0 10px"> 'longitude' => '31.054',
</span><span class="cx" style="display: block; padding: 0 10px"> 'country' => 'ZW',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'internal' => true,
</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">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -727,6 +728,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'latitude' => '31.955',
</span><span class="cx" style="display: block; padding: 0 10px"> 'longitude' => '35.945',
</span><span class="cx" style="display: block; padding: 0 10px"> 'country' => 'JO',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'internal' => true,
</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">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -737,6 +739,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'latitude' => '54.617',
</span><span class="cx" style="display: block; padding: 0 10px"> 'longitude' => '-5.900',
</span><span class="cx" style="display: block; padding: 0 10px"> 'country' => 'GB',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'internal' => true,
</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">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -747,6 +750,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'latitude' => '19.414',
</span><span class="cx" style="display: block; padding: 0 10px"> 'longitude' => '-99.033',
</span><span class="cx" style="display: block; padding: 0 10px"> 'country' => 'MX',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'internal' => true,
</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">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -757,6 +761,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'latitude' => '-36.867',
</span><span class="cx" style="display: block; padding: 0 10px"> 'longitude' => '174.767',
</span><span class="cx" style="display: block; padding: 0 10px"> 'country' => 'NZ',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'internal' => true,
</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">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -767,6 +772,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'latitude' => '-12.043',
</span><span class="cx" style="display: block; padding: 0 10px"> 'longitude' => '-77.028',
</span><span class="cx" style="display: block; padding: 0 10px"> 'country' => 'PE',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'internal' => true,
</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"> );
</span></span></pre>
</div>
</div>
</body>
</html>