Changeset 5137

Timestamp:

03/09/2017 09:18:35 PM (8 years ago)

Author:

iandunn

Message:

Events API: Refactor get_location() for single point of return

This is necessary so that the final value can be cached, which will be done in r5138.

Location:

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

Files:

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

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

@@ -183 +183 @@
 }
 
+/**
+ * Determine a location for the given IPv4 address
+ *
+ * @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.
+ *
+ * @param string $dotted_ip
+ *
+ * @return null|object `null` on failure; an object on success
+ */
 function guess_location_from_ip( $dotted_ip ) {
     global $wpdb;
@@ -203 +214 @@
     // For a country request, no lat/long are returned.
     if ( isset( $args['country'] ) ) {
-        return array(
+        $location = array(
             'country' => $args['country'],
         );
@@ -209 +220 @@
 
     $country_code = null;
-    if ( isset( $args['locale'] ) && preg_match( '/^[a-z]+[-_]([a-z]+)$/i', $args['locale'], $match ) ) {
+    if ( ! $location && ( isset( $args['locale'] ) && preg_match( '/^[a-z]+[-_]([a-z]+)$/i', $args['locale'], $match ) ) ) {
         $country_code = $match[1];
     }
 
     // Location was provided by the user:
-    if ( isset( $args['location_name'] ) ) {
+    if ( ! $location && isset( $args['location_name'] ) ) {
         $guess = guess_location_from_city( $args['location_name'], $args['timezone'] ?? '', $country_code  );
 
         if ( $guess ) {
-            return array(
+            $location = array(
                 'description' => $guess->name,
                 'latitude' => $guess->latitude,
@@ -224 +235 @@
                 'country' => $guess->country,
             );
-        }
-
-        $guess = guess_location_from_country( $args['location_name'] );
+        } else {
+            $guess = guess_location_from_country( $args['location_name'] );
+
+            if ( ! $location && $guess ) {
+                $location = array(
+                    'country' => $guess,
+                );
+            }
+        }
+    }
+
+    // IP:
+    if ( ! $location && isset( $args['ip'] ) ) {
+        $guess = guess_location_from_ip( $args['ip'] );
 
         if ( $guess ) {
-            return array(
-                'country' => $guess,
-            );
-        }
-    }
-
-    // IP:
-    if ( isset( $args['ip'] ) ) {
-        $guess = guess_location_from_ip( $args['ip'] );
-        if ( $guess ) {
-            return array(
+            $location = array(
                 'description' => $guess->ip_city,
                 'latitude' => $guess->ip_latitude,
@@ -249 +261 @@
 
     if (
-        ! empty( $args['latitude'] )  && is_numeric( $args['latitude'] ) &&
-        ! empty( $args['longitude'] ) && is_numeric( $args['longitude'] )
+        ! $location && (
+            ! empty( $args['latitude'] )  && is_numeric( $args['latitude'] ) &&
+            ! empty( $args['longitude'] ) && is_numeric( $args['longitude'] )
+        )
     ) {
         $city = get_city_from_coordinates( $args['latitude'], $args['longitude'] );
 
-        return array(
+        $location = array(
             'description' => $city ? $city : "{$args['latitude']}, {$args['longitude']}",
             'latitude'  => $args['latitude'],
@@ -261 +275 @@
     }
 
-    // If any of these are specified, and no localitity was guessed based on the above checks, bail with no location.
-    if ( isset( $args['location_name'] ) || isset( $args['ip'] ) || ! empty( $args['latitude'] ) || ! empty( $args['longitude'] ) ) {
-        return false;
-    }
-
-    // No specific location details.
-    return array();
+    if ( ! $location ) {
+        if ( isset( $args['location_name'] ) || isset( $args['ip'] ) || ! empty( $args['latitude'] ) || ! empty( $args['longitude'] ) ) {
+            // If any of these are specified, and no localitity was guessed based on the above checks, bail with no location.
+            $location = false;
+        } else {
+            // No specific location details.
+            $location = array();
+        }
+    }
+
+    return $location;
 }
 

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

@@ -156 +156 @@
         ),
 
+        /*
+         * No input was provided
+         */
+        'input-empty' => array(
+            'input'    => array(),
+            'expected' => array(),
+        ),
+
 
         /*