diff --git a/README.txt b/README.txt index 8488a00..81dedac 100644 --- a/README.txt +++ b/README.txt @@ -1,11 +1,11 @@ - ( - ( ( ( )\ ) ( ( - )\))( ))\ ( ( ( (()/( ))\ )( -((_))\ /((_))\ )\ )\ ((_))((_|()\ - (()(_|_)) ((_) ((_|(_) _| (_)) ((_) -/ _` |/ -_) _ \/ _/ _ \/ _` / -_)| '_| -\__, |\___\___/\__\___/\__,_\___||_| -|___/ + ( + ( ( ( )\ ) ( ( + )\))( ))\ ( ( ( (()/( ))\ )( +((_))\ /((_))\ )\ )\ ((_))((_|()\ + (()(_|_)) ((_) ((_|(_) _| (_)) ((_) +/ _` |/ -_) _ \/ _/ _ \/ _` / -_)| '_| +\__, |\___\___/\__\___/\__,_\___||_| +|___/ CONTENTS OF THIS FILE --------------------- @@ -20,7 +20,7 @@ ABOUT GEOCODER Geocoder is a Drupal 7 module that will extract geographical data (geocode) from just about anything you throw at it such as addresses, GPX files, Geotags from EXIF data in photos, and KML files. -A convenient way to allow users to enter an address and have it automatically geocoded is to use it in combination with the Addressfield (http://drupal.org/project/addressfield) and Geofield (http://drupal.org/project/geofield) modules. +A convenient way to allow users to enter an address and have it automatically geocoded is to use it in combination with the Addressfield (http://drupal.org/project/addressfield) and Geofield (http://drupal.org/project/geofield) modules. Geocoder uses the external geocoding services from Google, Yahoo and Yandex. diff --git a/geocoder.drush.inc b/geocoder.drush.inc index f7bf0ec..caad478 100644 --- a/geocoder.drush.inc +++ b/geocoder.drush.inc @@ -5,16 +5,16 @@ */ function geocoder_drush_command() { $items = array(); - + // the key in the $items array is the name of the command. $items['geocoder-backfill'] = array( 'callback' => 'geocoder_drush_backfill', 'description' => "Geocodes all nodes that have a geocoder widget but no geodata.", 'options' => array( - 'force' => 'Force the geocode to run, even if there is already geodata', + 'force' => 'Force the geocode to run, even if there is already geodata', ), ); - + return $items; } @@ -29,21 +29,21 @@ function geocoder_drush_backfill() { $field_info = field_info_field($field_name); if ($field_instance['widget']['type'] === 'geocoder') { $entity_load = $entity_info['load hook']; - + $query = db_select($entity_info['base table']) ->fields($entity_info['base table'], array($entity_info['entity keys']['id'])) ->condition($entity_info['entity keys']['bundle'], $bundle_name); - + $results = $query->execute(); while ($id = $results->fetchField()) { $entity = $entity_load($id); $langcode = field_language($entity_type, $entity, $field_name); $items = field_get_items($entity_type, $entity, $field_name, $langcode); - + if ($force_reload) { $entity->original = array(); } - + // Check for values and if there are no values, reload the entity if ($field_info['type'] == 'geofield') { if ($force_reload || (empty($items['wkt']) && empty($items['geom']))) node_save($entity); //TODO: fix for all entities diff --git a/geocoder.module b/geocoder.module index a4ff05c..6d6a0c2 100644 --- a/geocoder.module +++ b/geocoder.module @@ -4,7 +4,7 @@ * @file * Module file for geocoder module. */ - + include_once('geocoder.widget.inc'); include_once('geocoder.services.inc'); @@ -12,29 +12,29 @@ include_once('geocoder.services.inc'); * The Geocoder API call. * * Given a handler and data, geocode the data into a geometry object using the handler. - * + * * @param string $handler * The geocoder handler to use. Call geocoder_handler_info() to get a list - * + * * @param mixed $data * Data to be passed into the handler for geocoding. For example a address string. - * + * * @param array $options * Additional options to pass to the handler. Exact key / values to pass depend on the handler. - * + * * @param int $cache_type * (optional) The type of caching to use. Defaults to 2 (static and persistent) * 0 or FALSE is no-caching at all * 1 is static-cache but no persistent-cache * 2 is both static-cache AND persistent-cache - * - * @pram bool $cache_reset + * + * @param bool $cache_reset * (optional) Empty the static-cache and re-fill the persistent-cache. Defaults to FALSE. - * - * @return geometry + * + * @return Geometry * Returns a geoPHP geometry object. Generally a Point. * See http://drupal.org/project/geoPHP and https://github.com/phayes/geoPHP/wiki/API-Reference - * + * * @example: * geocoder('google','4925 Gair Ave, Terrace, BC'); * geocoder('google','New York City',array('geometry_type' => 'bounds')); @@ -42,25 +42,25 @@ include_once('geocoder.services.inc'); function geocoder($handler, $data, $options = array(), $cache_type = 2, $cache_reset = FALSE) { ctools_include('plugins'); static $static_cache = array(); - + if ($cache_reset) { $static_cache = array(); } - + if ($cache_type) { $cache_id = $handler . '_' . md5(serialize(array($data, $options))); if (!empty($static_cache[$cache_id])) { return $static_cache[$cache_id]; } } - + $processor = ctools_get_plugins('geocoder', 'geocoder_handler', $handler); $geometry = call_user_func($processor['callback'], $data, $options); - + if ($cache_type) { $static_cache[$cache_id] = $geometry; } - + return $geometry; } @@ -94,9 +94,9 @@ function geocoder_menu() { /** * Geocoder Handler Information - * + * * Return a list of all handlers that might geocode something for you. - * Optionally you may pass a field-type and get back a list of + * Optionally you may pass a field-type and get back a list of * handlers that are compatible with that field. */ function geocoder_handler_info($field_type = NULL) { @@ -120,7 +120,7 @@ function geocoder_handler_info($field_type = NULL) { /** * Fetch geocoder handler - * + * * Given a name, fetch the full handler definition */ function geocoder_get_handler($handler_name) { @@ -133,7 +133,7 @@ function geocoder_get_handler($handler_name) { /** * Get supported field types - * + * * Get a list of supported field types along with the processors that support them */ function geocoder_supported_field_types() { @@ -148,7 +148,7 @@ function geocoder_supported_field_types() { } } } - + return $supported; } @@ -177,15 +177,15 @@ function geocoder_ctools_plugin_type() { ); } -// These functions have to do with providing AJAX / AHAH +// These functions have to do with providing AJAX / AHAH // service functionality so that users can make use of // geocoder interactively via JavaScript. /** * Implements hook_permission(). - * - * We define permissions for accessing geocoder over AJAX / services. - * There is one global permission which gives access to everything, + * + * We define permissions for accessing geocoder over AJAX / services. + * There is one global permission which gives access to everything, * and one permission per handler. The site-administrator can therefore * fine tune which handlers are accessible. Note that to use AJAX with * geocoder these permissions need to be set. @@ -207,39 +207,39 @@ function geocoder_permission() { /** * Geocoder service check permissions - * + * * Given a handler, check to see if the user has * permission to execute it via AJAX / services - */ + */ function geocoder_service_check_perms($handler) { return (user_access('geocoder_service_all_handlers') || user_access('geocoder_service_handler_' . $handler)); } /** * Page callback for AJAX / Geocoder service - * + * * This service can be accessed at /geocoder/service/ * and takes the query-parameter "data". Optinally a "output" * paramater may also be passed. "output" corresponds to * geoPHP output formats. - * + * * Some examples: * /geocoder/service/google?data=4925 Gair Ave, Terrace, BC * /geocoder/service/wkt?data=POINT(10 10) - * /geocoder/service/yahoo?data=94112&output=wkt - */ + * /geocoder/service/yahoo?data=94112&output=wkt + */ function geocoder_service_callback($handler) { if (!isset($_GET['data'])) { throw new Exception(t('No data parameter found')); exit(); } - + $format = isset($_GET['output']) ? $_GET['output'] : 'json'; - + geophp_load(); geocoder_service_check_request($handler, $format); $geom = geocoder($handler, $_GET['data']); - + header('Content-Type: ' . geocoder_service_get_content_type($format)); print $geom->out($format); exit(); @@ -247,11 +247,11 @@ function geocoder_service_callback($handler) { /** * Get Content-Type for an output format - * + * * Given an output format, this helper function passes * a compatible HTTP content-type to be placed in the - * header. - */ + * header. + */ function geocoder_service_get_content_type($format) { $types = array( 'json' => 'application/json', @@ -267,11 +267,11 @@ function geocoder_service_get_content_type($format) { /** * Geocoder Service Check Request - * + * * Check to make sure the request to the service is valid. This - * checks to make sure the handler and the format exists, and + * checks to make sure the handler and the format exists, and * also checks permission - */ + */ function geocoder_service_check_request($handler, $format, $check_ac = TRUE) { if (!geocoder_get_handler($handler)) { drupal_set_message(t('Could not find handler @handler', array('@handler' => $handler)), 'error'); diff --git a/geocoder.services.inc b/geocoder.services.inc index a0ac4f4..9f9e94e 100644 --- a/geocoder.services.inc +++ b/geocoder.services.inc @@ -66,7 +66,7 @@ function geocoder_services_access($handler, $data, $output) { function geocoder_services_geocode($handler, $data, $format = 'default') { geophp_load(); geocoder_service_check_request($handler, $format); - + $geom = geocoder($handler, $data); if (!$format || $format == 'default') { $result = $geom->out('json'); @@ -79,12 +79,12 @@ function geocoder_services_geocode($handler, $data, $format = 'default') { function geocoder_services_capabilities() { geophp_load(); - + $handlers = array(); foreach (geocoder_handler_info() as $hid => $handler) { $handlers[$hid] = $handler['title'] . ' - ' . $handler['description']; } - + $object = new stdClass(); $object->handlers = $handlers; $object->output = geoPHP::getAdapterMap(); diff --git a/geocoder.widget.inc b/geocoder.widget.inc index 8fe8e51..c46554c 100644 --- a/geocoder.widget.inc +++ b/geocoder.widget.inc @@ -21,7 +21,7 @@ function geocoder_field_widget_info() { */ function geocoder_field_widget_settings_form($this_field, $instance) { $settings = $instance['widget']['settings']; - + $entity_fields = field_info_instances($instance['entity_type'], $instance['bundle']); $all_fields = field_info_fields(); $supported_field_types = geocoder_supported_field_types(); @@ -30,7 +30,7 @@ function geocoder_field_widget_settings_form($this_field, $instance) { $field_types = array(); $valid_fields = array(); $available_handlers = array(); - + // Add in the title/name //@@TODO Do this programatically by getting entity_info switch ($instance['entity_type']) { @@ -52,7 +52,7 @@ function geocoder_field_widget_settings_form($this_field, $instance) { $entity_fields['name']['label'] = t('Name'); break; } - + // Get a list of all valid fields that we both support and are part of this entity foreach ($all_fields as $field) { if (array_key_exists($field['field_name'], $entity_fields)) { @@ -66,7 +66,7 @@ function geocoder_field_widget_settings_form($this_field, $instance) { } } } - + $form['geocoder_field'] = array( '#type' => 'select', '#title' => t('Geocode from field'), @@ -75,7 +75,7 @@ function geocoder_field_widget_settings_form($this_field, $instance) { '#description' => t('Select which field you would like to geocode from.'), '#required' => TRUE, ); - + $form['geocoder_handler'] = array( '#type' => 'select', '#title' => t('Geocoder'), @@ -86,11 +86,11 @@ function geocoder_field_widget_settings_form($this_field, $instance) { '#description' => t('Select which type of geocoding handler you would like to use'), '#required' => TRUE, ); - + $form['handler_settings'] = array( '#tree' => TRUE, ); - + // Add the handler settings forms foreach ($processors as $handler_id => $handler) { if (isset($handler['settings_callback']) || isset($handler['terms_of_service'])) { @@ -118,7 +118,7 @@ function geocoder_field_widget_settings_form($this_field, $instance) { } } } - + $form['delta_handling'] = array( '#type' => 'select', '#title' => t('Multi-value input handling'), @@ -133,11 +133,11 @@ function geocoder_field_widget_settings_form($this_field, $instance) { ), '#required' => TRUE, ); - + // Add javascript to sync allowed values. Note that we are not using AJAX because we do not have access to the raw form_state here drupal_add_js(array('geocoder_widget_settings' => array('handlers' => $handlers_by_type, 'types' => $field_types)), 'setting'); drupal_add_js(drupal_get_path('module', 'geocoder') . '/geocoder.admin.js', 'file'); - + return $form; } @@ -165,7 +165,7 @@ function geocoder_field_attach_presave($entity_type, $entity) { /** * Get a field's value based on geocoded data. - * + * * @param $entity_type * Type of entity * @para field_instance @@ -174,7 +174,7 @@ function geocoder_field_attach_presave($entity_type, $entity) { * Optionally, the entity. You must pass either the entity or $source_field_values * @param $source_field_values * Array of deltas / source field values. You must pass either this or $entity. - * + * * @return * Three possibilities could be returned by this function: * - FALSE: do nothing. @@ -195,7 +195,7 @@ function geocoder_widget_get_field_value($entity_type, $field_instance, $entity $field_name = is_array($field_instance['widget']['settings']['geocoder_field']) ? reset($field_instance['widget']['settings']['geocoder_field']) : $field_instance['widget']['settings']['geocoder_field']; $target_info = field_info_field($field_instance['field_name']); $target_type = $target_info['type']; - + // Determine the source type, if it's a entity-key, we mock it as a "text" field if (in_array($field_name, $entity_info['entity keys']) && $entity) { $field_info = array('type' => 'text', 'entity_key' => TRUE); @@ -204,7 +204,7 @@ function geocoder_widget_get_field_value($entity_type, $field_instance, $entity $field_info = field_info_field($field_name); $field_info['entity_key'] = FALSE; } - + // Get the source values if (!$source_field_values) { if ($field_info['entity_key'] && $entity) { @@ -218,7 +218,7 @@ function geocoder_widget_get_field_value($entity_type, $field_instance, $entity return FALSE; } } - + // Remove source values that are not valid. if ($source_field_values) { foreach ($source_field_values as $delta => $item) { @@ -246,12 +246,12 @@ function geocoder_widget_get_field_value($entity_type, $field_instance, $entity } } } - + // Get the handler-specific-settings if (isset($field_instance['widget']['settings']['handler_settings'][$handler['name']])) { $handler_settings = $field_instance['widget']['settings']['handler_settings'][$handler['name']]; } - + // Determine how we deal with deltas (multi-value fields) if (empty($field_instance['widget']['settings']['delta_handling'])) { $delta_handling = 'default'; @@ -259,15 +259,15 @@ function geocoder_widget_get_field_value($entity_type, $field_instance, $entity else { $delta_handling = $field_instance['widget']['settings']['delta_handling']; } - + // Check to see if we should be concatenating if ($delta_handling == 'c_to_s' || $delta_handling == 'c_to_m') { $source_field_values = geocoder_widget_get_field_concat($source_field_values); } - + if (is_array($source_field_values) && count($source_field_values)) { $values = array(); - + // Geocode geometries $geometries = array(); foreach ($source_field_values as $delta => $item) { @@ -292,7 +292,7 @@ function geocoder_widget_get_field_value($entity_type, $field_instance, $entity return FALSE; } } - + if (empty($geometries)) { // This field has no data, so set the field to an empty array in // order to delete its saved data. @@ -302,7 +302,7 @@ function geocoder_widget_get_field_value($entity_type, $field_instance, $entity else { // Resolve multiple-values - get back values from our delta-resolver $values = geocoder_widget_resolve_deltas($geometries, $delta_handling, $target_type); - + // Set the values - geofields do not support languages return array(LANGUAGE_NONE => $values); } @@ -313,7 +313,7 @@ function geocoder_widget_get_field_value($entity_type, $field_instance, $entity /** * Get field items and info - * + * * We always pass the full field-item array (with all columns) to the handler, but there is some preprocessing * that we need to do for the special case of entity-labels and multi-field contactenation * For these two special cases we "mock-up" a text-field and pass it back for geocoding @@ -331,20 +331,20 @@ function geocoder_widget_get_field_concat($items) { /** * Geocder Widget - Resolve Deltas - * - * Given a list of geometries, and user configuration on how to handle deltas, + * + * Given a list of geometries, and user configuration on how to handle deltas, * we created a list of items to be inserted into the fields. */ function geocoder_widget_resolve_deltas($geometries, $delta_handling = 'default', $field_type) { $values = array(); - + // Default delta handling: just pass one delta to the next if ($delta_handling == 'default') { foreach ($geometries as $geometry) { $values[] = geocoder_widget_values_from_geometry($geometry, $field_type); } } - + // Single-to-multiple handling - if we can, explode out the component geometries if ($delta_handling == 's_to_m' || $delta_handling == 'c_to_m') { $type = $geometries[0]->geometryType(); @@ -358,21 +358,21 @@ function geocoder_widget_resolve_deltas($geometries, $delta_handling = 'default' $values[] = geocoder_widget_values_from_geometry($geometries[0], $field_type); } } - + // For multiple-to-single handling, run it though geometryReduce if ($delta_handling == 'm_to_s' || $delta_handling == 'c_to_s') { $reduced_geom = geoPHP::geometryReduce($geometries); $values[] = geocoder_widget_values_from_geometry($reduced_geom, $field_type); } - + return $values; } /** * Geocder Widget - Field values from geometry - * + * * Given a geometry and the field type, return back a values array for that field. - * The passed back array represents a single delta. + * The passed back array represents a single delta. */ function geocoder_widget_values_from_geometry($geometry, $field_type) { if ($field_type == 'geofield') return geofield_get_values_from_geometry($geometry); @@ -380,7 +380,7 @@ function geocoder_widget_values_from_geometry($geometry, $field_type) { $centroid = $geometry->centroid(); $lat = $centroid->y(); $lng = $centroid->x(); - + return array( 'lat' => $lat, 'lng' => $lng, @@ -412,9 +412,9 @@ function geocoder_widget_parse_addressfield($field_item) { if (!empty($field_item['sub_administrative_area'])) $address .= $field_item['sub_administrative_area'] . ','; if (!empty($field_item['country'])) $address .= $field_item['country'] . ','; if (!empty($field_item['postal_code'])) $address .= $field_item['postal_code'] . ','; - + $address = rtrim($address, ', '); - + return $address; } @@ -433,7 +433,7 @@ function geocoder_widget_parse_locationfield($field_item) { } if (!empty($field_item['country'])) $address .= $field_item['country'] . ','; if (!empty($field_item['postal_code'])) $address .= $field_item['postal_code'] . ','; - + $address = rtrim($address, ', '); return $address; @@ -460,4 +460,4 @@ function geocoder_widget_array_recursive_diff($aArray1, $aArray2) { } } return $aReturn; -} +} diff --git a/plugins/geocoder_handler/exif.inc b/plugins/geocoder_handler/exif.inc index e8e5bfe..19b1040 100644 --- a/plugins/geocoder_handler/exif.inc +++ b/plugins/geocoder_handler/exif.inc @@ -19,7 +19,7 @@ function geocoder_exif($url, $options = array()) { return FALSE; } } - + // The user has permission to access the file. Geocode it. geophp_load(); if ($data = exif_read_data($url)) { diff --git a/plugins/geocoder_handler/google.inc b/plugins/geocoder_handler/google.inc index 5b1ddb9..9853f0e 100755 --- a/plugins/geocoder_handler/google.inc +++ b/plugins/geocoder_handler/google.inc @@ -1,5 +1,4 @@ 'select', '#title' => 'Geometry Type', @@ -150,16 +149,16 @@ function geocoder_google_form($default_values = array()) { 'bounds' => 'Bounding Box', 'viewport' => 'Viewport', ), - '#default_value' => isset($default_values['geometry_type']) ? $default_values['geometry_type'] : 'point', + '#default_value' => isset($default_values['geometry_type']) ? $default_values['geometry_type'] : 'point', ); $form['all_results'] = array( '#type' => 'checkbox', '#title' => 'Geocode all alternative results', '#default_value' => isset($default_values['all_results']) ? $default_values['all_results'] : FALSE, - '#description' => 'Often an ambiguous address (such as "Springfield USA") can result in multiple hits. By default we only return the first (best guess) result. Check this to return all results as a Multi-Geometry (MultiPoint or MultiPolygon).', + '#description' => 'Often an ambiguous address (such as "Springfield USA") can result in multiple hits. By default we only return the first (best guess) result. Check this to return all results as a Multi-Geometry (MultiPoint or MultiPolygon).', ); - + $form['reject_results'] = array( '#type' => 'checkboxes', '#title' => 'Reject Results', @@ -172,6 +171,6 @@ function geocoder_google_form($default_values = array()) { '#default_value' => isset($default_values['reject_results']) ? $default_values['reject_results'] : array(), '#description' => 'Reject results that do not meet a certain level of quality or precision. Check all types of results to reject.', ); - + return $form; } diff --git a/plugins/geocoder_handler/gpx.inc b/plugins/geocoder_handler/gpx.inc index 64d3573..1f4a0ae 100644 --- a/plugins/geocoder_handler/gpx.inc +++ b/plugins/geocoder_handler/gpx.inc @@ -1,5 +1,4 @@ -