Changeset 5491

Timestamp:

05/16/2017 09:08:27 PM (8 years ago)

Author:

iandunn

Message:

Events: Replace IP geolocated data with venue location data

See #2823

Location:

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

Files:

• index.php (modified) (5 diffs)
• tests/test-index.php (modified) (6 diffs)

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

@@ -126 +126 @@
 
         $events = get_events( $event_args );
+
+        if ( isset( $location['internal'] ) && $location['internal'] ) {
+            $location = rebuild_location_from_event_source( $events );
+        }
     }
 
@@ -353 +357 @@
  * Determine a location for the given IPv4 address
  *
+ * NOTE: The location that is found here cannot be returned to the client.
+ *       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%.
@@ -385 +392 @@
 
     return $row;
+}
+
+/**
+ * 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;
 }
 
@@ -496 +534 @@
                 'longitude'   => $guess->ip_longitude,
                 'country'     => $guess->country_short,
+                'internal'    => true, // this location cannot be shared publicly, see `rebuild_location_from_geonames()`
             );
         }
@@ -698 +737 @@
             $bounded_box = get_bounded_coordinates( $args['nearby']['latitude'], $args['nearby']['longitude'], $distance );
             $nearby_where[] = '( `type` = %s AND `latitude` BETWEEN %f AND %f AND `longitude` BETWEEN %f AND %f )';
-            $sql_values[] = $type;          
+            $sql_values[] = $type;
             $sql_values[] = $bounded_box['latitude']['min'];
             $sql_values[] = $bounded_box['latitude']['max'];

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

@@ -718 +718 @@
                 'longitude'   => '31.054',
                 'country'     => 'ZW',
+                'internal'    => true,
             ),
         ),
@@ -728 +729 @@
                 'longitude'   => '35.945',
                 'country'     => 'JO',
+                'internal'    => true,
             ),
         ),
@@ -738 +740 @@
                 'longitude'   => '-5.900',
                 'country'     => 'GB',
+                'internal'    => true,
             ),
         ),
@@ -748 +751 @@
                 'longitude'   => '-99.033',
                 'country'     => 'MX',
+                'internal'    => true,
             ),
         ),
@@ -758 +762 @@
                 'longitude'   => '174.767',
                 'country'     => 'NZ',
+                'internal'    => true,
             ),
         ),
@@ -768 +773 @@
                 'longitude'   => '-77.028',
                 'country'     => 'PE',
+                'internal'    => true,
             ),
         ),