src/vikutils.c

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
   2 /*
   3  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   4  *
   5  * Copyright (C) 2013, Rob Norris <rw_norris@hotmail.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  *
  21  */
  22 /*
  23  * Dependencies in this file can be on anything.
  24  * For functions with simple system dependencies put it in util.c
  25  */
  26 #include <math.h>
  27 #include <glib/gstdio.h>
  28 #include <glib/gi18n.h>
  29 #include <gtk/gtk.h>
  30
  31 #include "viking.h"
  32 #include "vikutils.h"
  33 #include "globals.h"
  34 #include "download.h"
  35 #include "preferences.h"
  36 #include "vikmapslayer.h"
  37 #include "settings.h"
  38 #include "util.h"
  39 #include "dir.h"
  40 #include "misc/kdtree.h"
  41
  42 #define FMT_MAX_NUMBER_CODES 9
  43
  44 /**
  45  * vu_trackpoint_formatted_message:
  46  * @format_code:  String describing the message to generate
  47  * @trkpt:        The trackpoint for which the message is generated about
  48  * @trkpt_prev:   A trackpoint (presumed previous) for interpolating values with the other trackpoint (such as speed)
  49  * @trk:          The track in which the trackpoints reside
  50  *
  51  *  TODO: One day replace this cryptic format code with some kind of tokenizer parsing
  52  *    thus would make it more user friendly and maybe even GUI controlable.
  53  * However for now at least there is some semblance of user control
  54  */
  55 gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkpt, VikTrackpoint *trkpt_prev, VikTrack *trk )
  56 {
  57         if ( !trkpt )
  58                 return NULL;
  59
  60         gint len = 0;
  61         if ( format_code )
  62                 len = strlen ( format_code );
  63         if ( len > FMT_MAX_NUMBER_CODES )
  64                 len = FMT_MAX_NUMBER_CODES;
  65
  66         gchar* values[FMT_MAX_NUMBER_CODES];
  67         int i;
  68         for ( i = 0; i < FMT_MAX_NUMBER_CODES; i++ ) {
  69                 values[i] = '\0';
  70         }
  71
  72         gchar *speed_units_str = NULL;
  73         vik_units_speed_t speed_units = a_vik_get_units_speed ();
  74         switch (speed_units) {
  75         case VIK_UNITS_SPEED_MILES_PER_HOUR:
  76                 speed_units_str = g_strdup ( _("mph") );
  77                 break;
  78         case VIK_UNITS_SPEED_METRES_PER_SECOND:
  79                 speed_units_str = g_strdup ( _("m/s") );
  80                 break;
  81         case VIK_UNITS_SPEED_KNOTS:
  82                 speed_units_str = g_strdup ( _("knots") );
  83                 break;
  84         default:
  85                 // VIK_UNITS_SPEED_KILOMETRES_PER_HOUR:
  86                 speed_units_str = g_strdup ( _("km/h") );
  87                 break;
  88         }
  89
  90         gchar *separator = g_strdup ( " | " );
  91
  92         for ( i = 0; i < len; i++ ) {
  93                 switch ( g_ascii_toupper ( format_code[i] ) ) {
  94                 case 'G': values[i] = g_strdup ( _("GPSD") ); break; // GPS Preamble
  95                 case 'K': values[i] = g_strdup ( _("Trkpt") ); break; // Trkpt Preamble
  96
  97                 case 'S': {
  98                         gdouble speed = 0.0;
  99                         gchar *speedtype = NULL;
 100                         if ( isnan(trkpt->speed) && trkpt_prev ) {
 101                                 if ( trkpt->has_timestamp && trkpt_prev->has_timestamp ) {
 102                                         if ( trkpt->timestamp == trkpt_prev->timestamp ) {
 103
 104                                                 // Work out from previous trackpoint location and time difference
 105                                                 speed = vik_coord_diff(&(trkpt->coord), &(trkpt_prev->coord)) / ABS(trkpt->timestamp - trkpt_prev->timestamp);
 106
 107                                                 switch (speed_units) {
 108                                                 case VIK_UNITS_SPEED_KILOMETRES_PER_HOUR:
 109                                                         speed = VIK_MPS_TO_KPH(speed);
 110                                                         break;
 111                                                 case VIK_UNITS_SPEED_MILES_PER_HOUR:
 112                                                         speed = VIK_MPS_TO_MPH(speed);
 113                                                         break;
 114                                                 case VIK_UNITS_SPEED_KNOTS:
 115                                                         speed = VIK_MPS_TO_KNOTS(speed);
 116                                                         break;
 117                                                 default:
 118                                                         // VIK_UNITS_SPEED_METRES_PER_SECOND:
 119                                                         // Already in m/s so nothing to do
 120                                                         break;
 121                                                 }
 122                                                 speedtype = g_strdup ( "*" ); // Interpolated
 123                                         }
 124                                         else
 125                                                 speedtype = g_strdup ( "**" );
 126                                 }
 127                                 else
 128                                         speedtype = g_strdup ( "**" );
 129                         }
 130                         else {
 131                                 speed = trkpt->speed;
 132                                 speedtype = g_strdup ( "" );
 133                         }
 134
 135                         values[i] = g_strdup_printf ( _("%sSpeed%s %.1f%s"), separator, speedtype, speed, speed_units_str );
 136                         g_free ( speedtype );
 137                         break;
 138                 }
 139
 140                 case 'A': {
 141                         vik_units_height_t height_units = a_vik_get_units_height ();
 142                         switch (height_units) {
 143                         case VIK_UNITS_HEIGHT_FEET:
 144                                 values[i] = g_strdup_printf ( _("%sAlt %dfeet"), separator, (int)round(VIK_METERS_TO_FEET(trkpt->altitude)) );
 145                                 break;
 146                         default:
 147                                 //VIK_UNITS_HEIGHT_METRES:
 148                                 values[i] = g_strdup_printf ( _("%sAlt %dm"), separator, (int)round(trkpt->altitude) );
 149                                 break;
 150                         }
 151                         break;
 152                 }
 153
 154                 case 'C': {
 155                         gint heading = isnan(trkpt->course) ? 0 : (gint)round(trkpt->course);
 156                         values[i] = g_strdup_printf ( _("%sCourse %03d\302\260" ), separator, heading );
 157                         break;
 158                 }
 159
 160                 case 'P': {
 161                         if ( trkpt_prev ) {
 162                                 gint diff = (gint) round ( vik_coord_diff ( &(trkpt->coord), &(trkpt_prev->coord) ) );
 163
 164                                 gchar *dist_units_str = NULL;
 165                                 vik_units_distance_t dist_units = a_vik_get_units_distance ();
 166                                 // expect the difference between track points to be small hence use metres or yards
 167                                 switch (dist_units) {
 168                                 case VIK_UNITS_DISTANCE_MILES:
 169                                         dist_units_str = g_strdup ( _("yards") );
 170                                         break;
 171                                 default:
 172                                         // VIK_UNITS_DISTANCE_KILOMETRES:
 173                                         dist_units_str = g_strdup ( _("m") );
 174                                         break;
 175                                 }
 176
 177                                 values[i] = g_strdup_printf ( _("%sDistance diff %d%s"), separator, diff, dist_units_str );
 178
 179                                 g_free ( dist_units_str );
 180                         }
 181                         break;
 182                 }
 183
 184                 case 'T': {
 185                         gchar *msg;
 186                         if ( trkpt->has_timestamp ) {
 187                                 // Compact date time format
 188                                 msg = vu_get_time_string ( &(trkpt->timestamp), "%x %X", &(trkpt->coord), NULL );
 189                         }
 190                         else
 191                                 msg = g_strdup ("--");
 192                         values[i] = g_strdup_printf ( _("%sTime %s"), separator, msg );
 193                         g_free ( msg );
 194                         break;
 195                 }
 196
 197                 case 'M': {
 198                         if ( trkpt_prev ) {
 199                                 if ( trkpt->has_timestamp && trkpt_prev->has_timestamp ) {
 200                                         time_t t_diff = trkpt->timestamp - trkpt_prev->timestamp;
 201                                         values[i] = g_strdup_printf ( _("%sTime diff %lds"), separator, t_diff );
 202                                 }
 203                         }
 204                         break;
 205                 }
 206
 207                 case 'X': values[i] = g_strdup_printf ( _("%sNo. of Sats %d"), separator, trkpt->nsats ); break;
 208
 209                 case 'D': {
 210                         if ( trk ) {
 211                                 // Distance from start (along the track)
 212                                 gdouble distd = vik_track_get_length_to_trackpoint (trk, trkpt);
 213                                 gchar *dist_units_str = NULL;
 214                                 vik_units_distance_t dist_units = a_vik_get_units_distance ();
 215                                 // expect the difference between track points to be small hence use metres or yards
 216                                 switch (dist_units) {
 217                                 case VIK_UNITS_DISTANCE_MILES:
 218                                         dist_units_str = g_strdup ( _("miles") );
 219                                         distd = VIK_METERS_TO_MILES(distd);
 220                                         break;
 221                                 default:
 222                                         // VIK_UNITS_DISTANCE_KILOMETRES:
 223                                         dist_units_str = g_strdup ( _("km") );
 224                                         distd = distd / 1000.0;
 225                                         break;
 226                                 }
 227                                 values[i] = g_strdup_printf ( _("%sDistance along %.2f%s"), separator, distd, dist_units_str );
 228                                 g_free ( dist_units_str );
 229                         }
 230                         break;
 231                 }
 232
 233                 case 'L': {
 234                         // Location (Lat/Long)
 235                         gchar *lat = NULL, *lon = NULL;
 236                         struct LatLon ll;
 237                         vik_coord_to_latlon (&(trkpt->coord), &ll);
 238                         a_coords_latlon_to_string ( &ll, &lat, &lon );
 239                         values[i] = g_strdup_printf ( "%s%s %s", separator, lat, lon );
 240                         g_free ( lat );
 241                         g_free ( lon );
 242                         break;
 243                 }
 244
 245                 case 'N': // Name of track
 246                         values[i] = g_strdup_printf ( _("%sTrack: %s"), separator, trk->name );
 247                         break;
 248
 249                 case 'E': // Name of trackpoint if available
 250                         if ( trkpt->name )
 251                                 values[i] = g_strdup_printf ( "%s%s", separator, trkpt->name );
 252                         else
 253                                 values[i] = g_strdup ( "" );
 254                         break;
 255
 256                 default:
 257                         break;
 258                 }
 259         }
 260
 261         g_free ( separator );
 262         g_free ( speed_units_str );
 263
 264         gchar *msg = g_strconcat ( values[0], values[1], values[2], values[3], values[4], values[5], values[6], values[7], values[8], NULL );
 265
 266         for ( i = 0; i < FMT_MAX_NUMBER_CODES; i++ ) {
 267                 if ( values[i] != '\0' )
 268                         g_free ( values[i] );
 269         }
 270
 271         return msg;
 272 }
 273
 274 typedef struct {
 275         GtkWindow *window; // Layer needed for redrawing
 276         gchar *version;    // Image list
 277 } new_version_thread_data;
 278
 279 static gboolean new_version_available_message ( new_version_thread_data *nvtd )
 280 {
 281         // Only a simple goto website option is offered
 282         // Trying to do an installation update is platform specific
 283         if ( a_dialog_yes_or_no ( nvtd->window,
 284                                 _("There is a newer version of Viking available: %s\n\nDo you wish to go to Viking's website now?"), nvtd->version ) )
 285                 // NB 'VIKING_URL' redirects to the Wiki, here we want to go the main site.
 286                 open_url ( nvtd->window, "http://sourceforge.net/projects/viking/" );
 287
 288         g_free ( nvtd->version );
 289         g_free ( nvtd );
 290         return FALSE;
 291 }
 292
 293 #define VIK_SETTINGS_VERSION_CHECKED_DATE "version_checked_date"
 294
 295 static void latest_version_thread ( GtkWindow *window )
 296 {
 297         // Need to allow a few redirects, as SF file is often served from different server
 298         DownloadMapOptions options = { FALSE, FALSE, NULL, 5, NULL, NULL, NULL };
 299         gchar *filename = a_download_uri_to_tmp_file ( "http://sourceforge.net/projects/viking/files/VERSION", &options );
 300         //gchar *filename = g_strdup ( "VERSION" );
 301         if ( !filename ) {
 302                 return;
 303         }
 304
 305         GMappedFile *mf = g_mapped_file_new ( filename, FALSE, NULL );
 306         if ( !mf )
 307                 return;
 308
 309         gchar *text = g_mapped_file_get_contents ( mf );
 310
 311         gint latest_version = viking_version_to_number ( text );
 312         gint my_version = viking_version_to_number ( VIKING_VERSION );
 313
 314         g_debug ( "The lastest version is: %s", text );
 315
 316         if ( my_version < latest_version ) {
 317                 new_version_thread_data *nvtd = g_malloc ( sizeof(new_version_thread_data) );
 318                 nvtd->window = window;
 319                 nvtd->version = g_strdup ( text );
 320                 gdk_threads_add_idle ( (GSourceFunc) new_version_available_message, nvtd );
 321         }
 322         else
 323                 g_debug ( "Running the lastest version: %s", VIKING_VERSION );
 324
 325         g_mapped_file_unref ( mf );
 326         if ( filename ) {
 327                 g_remove ( filename );
 328                 g_free ( filename );
 329         }
 330
 331         // Update last checked time
 332         GTimeVal time;
 333         g_get_current_time ( &time );
 334         a_settings_set_string ( VIK_SETTINGS_VERSION_CHECKED_DATE, g_time_val_to_iso8601(&time) );
 335 }
 336
 337 #define VIK_SETTINGS_VERSION_CHECK_PERIOD "version_check_period_days"
 338
 339 /**
 340  * vu_check_latest_version:
 341  * @window: Somewhere where we may need use the display to inform the user about the version status
 342  *
 343  * Periodically checks the released latest VERSION file on the website to compare with the running version
 344  *
 345  */
 346 void vu_check_latest_version ( GtkWindow *window )
 347 {
 348         if ( ! a_vik_get_check_version () )
 349                 return;
 350
 351         gboolean do_check = FALSE;
 352
 353         gint check_period;
 354         if ( ! a_settings_get_integer ( VIK_SETTINGS_VERSION_CHECK_PERIOD, &check_period ) ) {
 355                 check_period = 14;
 356         }
 357
 358         // Get last checked date...
 359         GDate *gdate_last = g_date_new();
 360         GDate *gdate_now = g_date_new();
 361         GTimeVal time_last;
 362         gchar *last_checked_date = NULL;
 363
 364         // When no previous date available - set to do the version check
 365         if ( a_settings_get_string ( VIK_SETTINGS_VERSION_CHECKED_DATE, &last_checked_date) ) {
 366                 if ( g_time_val_from_iso8601 ( last_checked_date, &time_last ) ) {
 367                         g_date_set_time_val ( gdate_last, &time_last );
 368                 }
 369                 else
 370                         do_check = TRUE;
 371         }
 372         else
 373                 do_check = TRUE;
 374
 375         GTimeVal time_now;
 376         g_get_current_time ( &time_now );
 377         g_date_set_time_val ( gdate_now, &time_now );
 378
 379         if ( ! do_check ) {
 380                 // Dates available so do the comparison
 381                 g_date_add_days ( gdate_last, check_period );
 382                 if ( g_date_compare ( gdate_last, gdate_now ) < 0 )
 383                         do_check = TRUE;
 384         }
 385
 386         g_date_free ( gdate_last );
 387         g_date_free ( gdate_now );
 388
 389         if ( do_check ) {
 390 #if GLIB_CHECK_VERSION (2, 32, 0)
 391                 g_thread_try_new ( "latest_version_thread", (GThreadFunc)latest_version_thread, window, NULL );
 392 #else
 393                 g_thread_create ( (GThreadFunc)latest_version_thread, window, FALSE, NULL );
 394 #endif
 395         }
 396 }
 397
 398 /**
 399  * vu_set_auto_features_on_first_run:
 400  *
 401  *  Ask the user's opinion to set some of Viking's default behaviour
 402  */
 403 void vu_set_auto_features_on_first_run ( void )
 404 {
 405         gboolean auto_features = FALSE;
 406         if ( a_vik_very_first_run () ) {
 407
 408                 GtkWidget *win = gtk_window_new ( GTK_WINDOW_TOPLEVEL );
 409
 410                 if ( a_dialog_yes_or_no ( GTK_WINDOW(win),
 411                                           _("This appears to be Viking's very first run.\n\nDo you wish to enable automatic internet features?\n\nIndividual settings can be controlled in the Preferences."), NULL ) )
 412                         auto_features = TRUE;
 413         }
 414
 415         if ( auto_features ) {
 416                 // Set Maps to autodownload
 417                 // Ensure the default is true
 418                 maps_layer_set_autodownload_default ( TRUE );
 419
 420                 // Simplistic repeat of preference settings
 421                 //  Only the name & type are important for setting a preference via this 'external' way
 422
 423                 // Enable auto add map +
 424                 // Enable IP lookup
 425                 VikLayerParam pref_add_map[] = { { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_STARTUP_NAMESPACE "add_default_map_layer", VIK_LAYER_PARAM_BOOLEAN, VIK_LAYER_GROUP_NONE, NULL, VIK_LAYER_WIDGET_CHECKBUTTON, NULL, NULL, NULL, NULL, NULL, NULL, }, };
 426                 VikLayerParam pref_startup_method[] = { { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_STARTUP_NAMESPACE "startup_method", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, NULL, VIK_LAYER_WIDGET_COMBOBOX, NULL, NULL, NULL, NULL, NULL, NULL}, };
 427
 428                 VikLayerParamData vlp_data;
 429                 vlp_data.b = TRUE;
 430                 a_preferences_run_setparam ( vlp_data, pref_add_map );
 431
 432                 vlp_data.u = VIK_STARTUP_METHOD_AUTO_LOCATION;
 433                 a_preferences_run_setparam ( vlp_data, pref_startup_method );
 434
 435                 // Only on Windows make checking for the latest version on by default
 436                 // For other systems it's expected a Package manager or similar controls the installation, so leave it off
 437 #ifdef WINDOWS
 438                 VikLayerParam pref_startup_version_check[] = { { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_STARTUP_NAMESPACE "check_version", VIK_LAYER_PARAM_BOOLEAN, VIK_LAYER_GROUP_NONE, NULL, VIK_LAYER_WIDGET_CHECKBUTTON, NULL, NULL, NULL, NULL, }, };
 439                 vlp_data.b = TRUE;
 440                 a_preferences_run_setparam ( vlp_data, pref_startup_version_check );
 441 #endif
 442
 443                 // Ensure settings are saved for next time
 444                 a_preferences_save_to_file ();
 445         }
 446 }
 447
 448 /**
 449  * vu_get_canonical_filename:
 450  *
 451  * Returns: Canonical absolute filename
 452  *
 453  * Any time a path may contain a relative component, so need to prepend that directory it is relative to
 454  * Then resolve the full path to get the normal canonical filename
 455  */
 456 gchar *vu_get_canonical_filename ( VikLayer *vl, const gchar *filename )
 457 {
 458   gchar *canonical = NULL;
 459   if ( !filename )
 460     return NULL;
 461
 462   if ( g_path_is_absolute ( filename ) )
 463     canonical = g_strdup ( filename );
 464   else {
 465     const gchar *vw_filename = vik_window_get_filename ( VIK_WINDOW_FROM_WIDGET (vl->vvp) );
 466     gchar *dirpath = NULL;
 467     if ( vw_filename )
 468       dirpath = g_path_get_dirname ( vw_filename );
 469     else
 470       dirpath = g_get_current_dir(); // Fallback - if here then probably can't create the correct path
 471
 472     gchar *full = NULL;
 473     if ( g_path_is_absolute ( dirpath ) )
 474       full = g_strconcat ( dirpath, G_DIR_SEPARATOR_S, filename, NULL );
 475     else
 476       full = g_strconcat ( g_get_current_dir(), G_DIR_SEPARATOR_S, dirpath, G_DIR_SEPARATOR_S, filename, NULL );
 477
 478     canonical = file_realpath_dup ( full ); // resolved
 479     g_free ( full );
 480     g_free ( dirpath );
 481   }
 482
 483   return canonical;
 484 }
 485
 486 static struct kdtree *kd = NULL;
 487
 488 static void load_ll_tz_dir ( const gchar *dir )
 489 {
 490         gchar *lltz = g_build_filename ( dir, "latlontz.txt", NULL );
 491         if ( g_access(lltz, R_OK) == 0 ) {
 492                 gchar buffer[4096];
 493                 long line_num = 0;
 494                 FILE *ff = g_fopen ( lltz, "r" );
 495
 496                 while ( fgets ( buffer, 4096, ff ) ) {
 497                         line_num++;
 498                         gchar **components = g_strsplit (buffer, " ", 3);
 499                         guint nn = g_strv_length ( components );
 500                         if ( nn == 3 ) {
 501                                 double pt[2] = { g_ascii_strtod (components[0], NULL), g_ascii_strtod (components[1], NULL) };
 502                                 gchar *timezone = g_strchomp ( components[2] );
 503                                 if ( kd_insert ( kd, pt, timezone ) )
 504                                         g_critical ( "Insertion problem of %s for line %ld of latlontz.txt", timezone, line_num );
 505                                 // NB Don't free timezone as it's part of the kdtree data now
 506                                 g_free ( components[0] );
 507                                 g_free ( components[1] );
 508                         } else {
 509                                 g_warning ( "Line %ld of latlontz.txt does not have 3 parts", line_num );
 510                         }
 511                         g_free ( components );
 512                 }
 513                 fclose ( ff );
 514         }
 515         g_free ( lltz );
 516 }
 517
 518 /**
 519  * vu_setup_lat_lon_tz_lookup:
 520  *
 521  * Can be called multiple times but only initializes the lookup once
 522  */
 523 void vu_setup_lat_lon_tz_lookup ()
 524 {
 525         // Only setup once
 526         if ( kd )
 527                 return;
 528
 529         kd = kd_create(2);
 530
 531         // Look in the directories of data path
 532         gchar **data_dirs = a_get_viking_data_path();
 533         // Process directories in reverse order for priority
 534         guint n_data_dirs = g_strv_length ( data_dirs );
 535         for (; n_data_dirs > 0; n_data_dirs--) {
 536                 load_ll_tz_dir(data_dirs[n_data_dirs-1]);
 537         }
 538         g_strfreev ( data_dirs );
 539 }
 540
 541 /**
 542  * vu_finalize_lat_lon_tz_lookup:
 543  *
 544  * Clear memory used by the lookup.
 545  *  only call on program exit
 546  */
 547 void vu_finalize_lat_lon_tz_lookup ()
 548 {
 549         if ( kd ) {
 550                 kd_data_destructor ( kd, g_free );
 551                 kd_free ( kd );
 552         }
 553 }
 554
 555 static double dist_sq( double *a1, double *a2, int dims ) {
 556   double dist_sq = 0, diff;
 557   while( --dims >= 0 ) {
 558     diff = (a1[dims] - a2[dims]);
 559     dist_sq += diff*diff;
 560   }
 561   return dist_sq;
 562 }
 563
 564 static gchar* time_string_adjusted ( time_t *time, gint offset_s )
 565 {
 566         time_t *mytime = time;
 567         *mytime = *mytime + offset_s;
 568         gchar *str = g_malloc ( 64 );
 569         // Append asterisks to indicate use of simplistic model (i.e. no TZ)
 570         strftime ( str, 64, "%a %X %x **", gmtime(mytime) );
 571         return str;
 572 }
 573
 574 static gchar* time_string_tz ( time_t *time, const gchar *format, GTimeZone *tz )
 575 {
 576         GDateTime *utc = g_date_time_new_from_unix_utc (*time);
 577         GDateTime *local = g_date_time_to_timezone ( utc, tz );
 578         if ( !local ) {
 579                 g_date_time_unref ( utc );
 580                 return NULL;
 581         }
 582         gchar *str = g_date_time_format ( local, format );
 583
 584         g_date_time_unref ( local );
 585         g_date_time_unref ( utc );
 586         return str;
 587 }
 588
 589 #define VIK_SETTINGS_NEAREST_TZ_FACTOR "utils_nearest_tz_factor"
 590 /**
 591  * vu_get_tz_at_location:
 592  *
 593  * @vc:     Position for which the time zone is desired
 594  *
 595  * Returns: TimeZone string of the nearest known location. String may be NULL.
 596  *
 597  * Use the k-d tree method (http://en.wikipedia.org/wiki/Kd-tree) to quickly retreive
 598  *  the nearest location to the given position.
 599  */
 600 gchar* vu_get_tz_at_location ( const VikCoord* vc )
 601 {
 602         gchar *tz = NULL;
 603         if ( !vc || !kd )
 604                 return tz;
 605
 606         struct LatLon ll;
 607         vik_coord_to_latlon ( vc, &ll );
 608         double pt[2] = { ll.lat, ll.lon };
 609
 610         gdouble nearest;
 611         if ( !a_settings_get_double(VIK_SETTINGS_NEAREST_TZ_FACTOR, &nearest) )
 612                 nearest = 1.0;
 613
 614         struct kdres *presults = kd_nearest_range ( kd, pt, nearest );
 615         while( !kd_res_end( presults ) ) {
 616                 double pos[2];
 617                 gchar *ans = (gchar*)kd_res_item ( presults, pos );
 618                 // compute the distance of the current result from the pt
 619                 double dist = sqrt( dist_sq( pt, pos, 2 ) );
 620                 if ( dist < nearest ) {
 621                         //printf( "NEARER node at (%.3f, %.3f, %.3f) is %.3f away is %s\n", pos[0], pos[1], pos[2], dist, ans );
 622                         nearest = dist;
 623                         tz = ans;
 624                 }
 625                 kd_res_next ( presults );
 626         }
 627         g_debug ( "TZ lookup found %d results - picked %s", kd_res_size(presults), tz );
 628         kd_res_free ( presults );
 629
 630         return tz;
 631 }
 632
 633 /**
 634  * vu_get_time_string:
 635  *
 636  * @time_t: The time of which the string is wanted
 637  * @format  The format of the time string - such as "%c"
 638  * @vc:     Position of object for the time output - maybe NULL
 639  *          (only applicable for VIK_TIME_REF_WORLD)
 640  * @tz:     TimeZone string - maybe NULL.
 641  *          (only applicable for VIK_TIME_REF_WORLD)
 642  *          Useful to pass in the cached value from vu_get_tz_at_location() to save looking it up again for the same position
 643  *
 644  * Returns: A string of the time according to the time display property
 645  */
 646 gchar* vu_get_time_string ( time_t *time, const gchar *format, const VikCoord* vc, const gchar *tz )
 647 {
 648         if ( !format ) return NULL;
 649         gchar *str = NULL;
 650         switch ( a_vik_get_time_ref_frame() ) {
 651                 case VIK_TIME_REF_UTC:
 652                         str = g_malloc ( 64 );
 653                         strftime ( str, 64, format, gmtime(time) ); // Always 'GMT'
 654                         break;
 655                 case VIK_TIME_REF_WORLD:
 656                         if ( vc && !tz ) {
 657                                 // No timezone specified so work it out
 658                                 gchar *mytz = vu_get_tz_at_location ( vc );
 659                                 if ( mytz ) {
 660                                         GTimeZone *gtz = g_time_zone_new ( mytz );
 661                                         str = time_string_tz ( time, format, gtz );
 662                                         g_time_zone_unref ( gtz );
 663                                 }
 664                                 else {
 665                                         // No results (e.g. could be in the middle of a sea)
 666                                         // Fallback to simplistic method that doesn't take into account Timezones of countries.
 667                                         struct LatLon ll;
 668                                         vik_coord_to_latlon ( vc, &ll );
 669                                         str = time_string_adjusted ( time, round ( ll.lon / 15.0 ) * 3600 );
 670                                 }
 671                         }
 672                         else {
 673                                 // Use specified timezone
 674                                 GTimeZone *gtz = g_time_zone_new ( tz );
 675                                 str = time_string_tz ( time, format, gtz );
 676                                 g_time_zone_unref ( gtz );
 677                         }
 678                         break;
 679                 default: // VIK_TIME_REF_LOCALE
 680                         str = g_malloc ( 64 );
 681                         strftime ( str, 64, format, localtime(time) );
 682                         break;
 683         }
 684         return str;
 685 }