google.inc in Location 7.3

Google geocoder.

File

geocoding/google.inc

<?php

/**
 * @file
 * Google geocoder.
 */

/**
 * Return the list of ISO3166 codes supported by this geocoder. 
 * 
 * Google now supports geocoding for all countries:
 * https://developers.google.com/maps/coverage
 */
function google_geocode_country_list() {
  $countries = location_get_iso3166_list();
  return array_keys($countries);
}

/**
 * Return general information about this geocoder.
 */
function google_geocode_info() {
  return array(
    'name' => t('Google Maps'),
    'url' => 'http://maps.google.com',
    'tos' => 'http://www.google.com/help/terms_local.html',
    'general' => TRUE,
  );
}

/**
 * Perform a geocode on a location array.
 *
 * @param array $location
 *   The location array to process.
 *
 * @return array
 *   an associative array with keys 'lat' and 'lon' containing the coordinates.
 */
function google_geocode_location($location = array()) {
  $delay_trigger =& drupal_static(__FUNCTION__);
  $delay = variable_get('location_geocode_google_delay', 0);
  if ($delay > 0 && $delay_trigger) {
    usleep($delay * 1000);
  }
  $query = array(
    'region' => $location['country'],
    'address' => _google_geocode_flatten($location),
    // Required by TOS.
    'sensor' => 'false',
  );
  if (!empty($location['country'])) {

    // If we have only a country code and nothing else,
    // pass in country component so that google doesn't mistake the country
    // code for some other short code, like administrative area.
    // @codingStandardsIgnoreStart
    $filtered_location = array_filter($location, function ($a) {

      // Handle locpick & settings arrays.
      // No actual location data should be in an array.
      if (is_array($a)) {
        return FALSE;
      }
      return is_string($a) ? trim($a) : $a;
    });

    // @codingStandardsIgnoreEnd
    if (count($filtered_location) == 1) {
      $query['components'] = _google_geocode_get_components($filtered_location);
    }
  }
  $key = variable_get('location_geocode_google_apikey', '');
  if (empty($key) && function_exists('gmap_get_key')) {
    $key = gmap_get_key();
  }
  if (!empty($key)) {
    $query['key'] = $key;
  }
  $url = url('https://maps.googleapis.com/maps/api/geocode/json', array(
    'query' => $query,
    'external' => TRUE,
  ));
  $http_reply = drupal_http_request($url);
  $delay_trigger = TRUE;
  $data = json_decode($http_reply->data);
  $status_code = $data->status;
  if ($status_code != 'OK') {
    watchdog('location', 'Google geocoding returned status code: %status_code for the query url: %url', array(
      '%status_code' => $data->status,
      '%url' => $url,
    ));
    return NULL;
  }
  $location = $data->results[0]->geometry->location;
  return array(
    'lat' => $location->lat,
    'lon' => $location->lng,
  );
}

/**
 * General settings for this geocoder.
 */
function google_geocode_settings() {
  $form = array();
  $form['location_geocode_google_apikey'] = array(
    '#type' => 'textfield',
    '#title' => t('Google Geocoding API Server Key'),
    '#size' => 64,
    '#maxlength' => 128,
    '#default_value' => variable_get('location_geocode_google_apikey', ''),
    '#description' => t('In order to use the Google Geocoding API web-service, you will need a Google Geocoding API Server Key.  You can obtain one at the !sign_up_link for the !google_maps_api.  Without a key daily requests from a single IP address will be automaticaly limited.  If you do not enter a key here this module will use the Google Maps API Key from gmap if one is present. NOTE: You will <em>not</em> have to re-enter your API key for each country for which you have selected Google Maps for geocoding.  This setting is global.', array(
      '!sign_up_link' => '<a href="http://console.developers.google.com/">sign-up page</a>',
      '!google_maps_api' => '<a href="http://developers.google.com/maps/documentation/geocoding/">Google Geocoding API</a>',
    )),
  );
  $form['location_geocode_google_delay'] = array(
    '#type' => 'textfield',
    '#title' => t('Delay between geocoding requests (is milliseconds)'),
    '#description' => t('To avoid a 620 error (denial of service) from Google, you can add a delay between geocoding requests. 200ms is recommended.'),
    '#default_value' => variable_get('location_geocode_google_delay', 0),
    '#size' => 10,
  );
  $country = arg(5);
  if ($country) {
    $form['location_geocode_' . $country . '_google_accuracy_code'] = array(
      '#type' => 'select',
      '#title' => t('Google Maps Geocoding Accuracy for %country', array(
        '%country' => $country,
      )),
      '#default_value' => variable_get('location_geocode_' . $country . '_google_accuracy_code', variable_get('location_geocode_google_minimum_accuracy', '3')),
      '#options' => location_google_geocode_accuracy_codes(),
      '#description' => t('The minimum required accuracy for the geolocation data to be saved.'),
    );
  }
  return $form;
}

/**
 * Returns address.
 */
function _google_geocode_flatten($location = array()) {

  // Check if its a valid address.
  if (empty($location)) {
    return '';
  }
  $address = '';
  if (!empty($location['street'])) {
    $address .= $location['street'];
  }
  if (!empty($location['city'])) {
    if (!empty($address)) {
      $address .= ', ';
    }
    $address .= $location['city'];
  }

  // Using province short code regularlyy gives no results.
  if (!empty($location['province_name'])) {
    if (!empty($address)) {
      $address .= ', ';
    }
    $address .= $location['province_name'];
  }
  if (!empty($location['postal_code'])) {
    if (!empty($address)) {
      $address .= ', ';
    }
    $address .= $location['postal_code'];
  }
  if (!empty($location['country'])) {
    if (!empty($address)) {
      $address .= ', ';
    }
    $address .= $location['country'];
  }
  return $address;
}

/**
 * Gets a components string to pass to the google geocode API.
 *
 * This is required to get more accurate results because sometimes when passing
 * in a small piece of information, like a country code only, it could also
 * match a different part of an address for another country as the highest
 * match.
 *
 * See https://developers.google.com/maps/documentation/geocoding/#ComponentFiltering
 * for details.
 *
 * @param array $location
 *   A location array.
 *
 * @return string
 *   A components string formatted as per the docs page linked to above.
 */
function _google_geocode_get_components($location = array()) {

  // Check if its a valid address.
  if (empty($location)) {
    return '';
  }
  $components = array();
  if (!empty($location['city'])) {
    $components[] = 'locality:' . $location['city'];
  }
  if (!empty($location['province_name'])) {
    $components[] = 'administrative_area:' . $location['province_name'];
  }
  if (!empty($location['postal_code'])) {
    $components[] = 'postal_code:' . $location['postal_code'];
  }
  if (!empty($location['country'])) {
    $components[] = 'country:' . $location['country'];
  }
  return implode('|', $components);
}

Functions

Name	Description
google_geocode_country_list	Return the list of ISO3166 codes supported by this geocoder.
google_geocode_info	Return general information about this geocoder.
google_geocode_location	Perform a geocode on a location array.
google_geocode_settings	General settings for this geocoder.
_google_geocode_flatten	Returns address.
_google_geocode_get_components	Gets a components string to pass to the google geocode API.