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 "ui_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  * @climb:        Vertical speed (Out of band (i.e. not in a trackpoint) value for display currently only for GPSD usage)
  51  *
  52  *  TODO: One day replace this cryptic format code with some kind of tokenizer parsing
  53  *    thus would make it more user friendly and maybe even GUI controlable.
  54  * However for now at least there is some semblance of user control
  55  */
  56 gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkpt, VikTrackpoint *trkpt_prev, VikTrack *trk, gdouble climb )
  57 {
  58         if ( !trkpt )
  59                 return NULL;
  60
  61         gint len = 0;
  62         if ( format_code )
  63                 len = strlen ( format_code );
  64         if ( len > FMT_MAX_NUMBER_CODES )
  65                 len = FMT_MAX_NUMBER_CODES;
  66
  67         gchar* values[FMT_MAX_NUMBER_CODES];
  68         int i;
  69         for ( i = 0; i < FMT_MAX_NUMBER_CODES; i++ ) {
  70                 values[i] = '\0';
  71         }
  72
  73         gchar *speed_units_str = NULL;
  74         vik_units_speed_t speed_units = a_vik_get_units_speed ();
  75         switch (speed_units) {
  76         case VIK_UNITS_SPEED_MILES_PER_HOUR:
  77                 speed_units_str = g_strdup ( _("mph") );
  78                 break;
  79         case VIK_UNITS_SPEED_METRES_PER_SECOND:
  80                 speed_units_str = g_strdup ( _("m/s") );
  81                 break;
  82         case VIK_UNITS_SPEED_KNOTS:
  83                 speed_units_str = g_strdup ( _("knots") );
  84                 break;
  85         default:
  86                 // VIK_UNITS_SPEED_KILOMETRES_PER_HOUR:
  87                 speed_units_str = g_strdup ( _("km/h") );
  88                 break;
  89         }
  90
  91         gchar *separator = g_strdup ( " | " );
  92
  93         for ( i = 0; i < len; i++ ) {
  94                 switch ( g_ascii_toupper ( format_code[i] ) ) {
  95                 case 'G': values[i] = g_strdup ( _("GPSD") ); break; // GPS Preamble
  96                 case 'K': values[i] = g_strdup ( _("Trkpt") ); break; // Trkpt Preamble
  97
  98                 case 'S': {
  99                         gdouble speed = 0.0;
 100                         gchar *speedtype = NULL;
 101                         if ( isnan(trkpt->speed) && trkpt_prev ) {
 102                                 if ( trkpt->has_timestamp && trkpt_prev->has_timestamp ) {
 103                                         if ( trkpt->timestamp != trkpt_prev->timestamp ) {
 104
 105                                                 // Work out from previous trackpoint location and time difference
 106                                                 speed = vik_coord_diff(&(trkpt->coord), &(trkpt_prev->coord)) / ABS(trkpt->timestamp - trkpt_prev->timestamp);
 107                                                 speedtype = g_strdup ( "*" ); // Interpolated
 108                                         }
 109                                         else
 110                                                 speedtype = g_strdup ( "**" );
 111                                 }
 112                                 else
 113                                         speedtype = g_strdup ( "**" );
 114                         }
 115                         else {
 116                                 speed = trkpt->speed;
 117                                 speedtype = g_strdup ( "" );
 118                         }
 119                         switch (speed_units) {
 120                         case VIK_UNITS_SPEED_KILOMETRES_PER_HOUR:
 121                                 speed = VIK_MPS_TO_KPH(speed);
 122                                 break;
 123                         case VIK_UNITS_SPEED_MILES_PER_HOUR:
 124                                 speed = VIK_MPS_TO_MPH(speed);
 125                                 break;
 126                         case VIK_UNITS_SPEED_KNOTS:
 127                                 speed = VIK_MPS_TO_KNOTS(speed);
 128                                 break;
 129                         default:
 130                                 // VIK_UNITS_SPEED_METRES_PER_SECOND:
 131                                 // Already in m/s so nothing to do
 132                                 break;
 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 'B': {
 141                         gdouble speed = 0.0;
 142                         gchar *speedtype = NULL;
 143                         if ( isnan(climb) && trkpt_prev ) {
 144                                 if ( trkpt->has_timestamp && trkpt_prev->has_timestamp ) {
 145                                         if ( trkpt->timestamp != trkpt_prev->timestamp ) {
 146                                                 // Work out from previous trackpoint altitudes and time difference
 147                                                 // 'speed' can be negative if going downhill
 148                                                 speed = (trkpt->altitude - trkpt_prev->altitude) / ABS(trkpt->timestamp - trkpt_prev->timestamp);
 149                                                 speedtype = g_strdup ( "*" ); // Interpolated
 150                                         }
 151                                         else
 152                                                 speedtype = g_strdup ( "**" ); // Unavailable
 153                                 }
 154                                 else
 155                                         speedtype = g_strdup ( "**" );
 156                         }
 157                         else {
 158                                 speed = climb;
 159                                 speedtype = g_strdup ( "" );
 160                         }
 161                         switch (speed_units) {
 162                         case VIK_UNITS_SPEED_KILOMETRES_PER_HOUR:
 163                                 speed = VIK_MPS_TO_KPH(speed);
 164                                 break;
 165                         case VIK_UNITS_SPEED_MILES_PER_HOUR:
 166                                 speed = VIK_MPS_TO_MPH(speed);
 167                                 break;
 168                         case VIK_UNITS_SPEED_KNOTS:
 169                                 speed = VIK_MPS_TO_KNOTS(speed);
 170                                 break;
 171                         default:
 172                                 // VIK_UNITS_SPEED_METRES_PER_SECOND:
 173                                 // Already in m/s so nothing to do
 174                                 break;
 175                         }
 176                         // Go for 2dp as expect low values for vertical speeds
 177                         values[i] = g_strdup_printf ( _("%sClimb%s %.2f%s"), separator, speedtype, speed, speed_units_str );
 178                         g_free ( speedtype );
 179                         break;
 180                 }
 181
 182                 case 'A': {
 183                         vik_units_height_t height_units = a_vik_get_units_height ();
 184                         switch (height_units) {
 185                         case VIK_UNITS_HEIGHT_FEET:
 186                                 values[i] = g_strdup_printf ( _("%sAlt %dfeet"), separator, (int)round(VIK_METERS_TO_FEET(trkpt->altitude)) );
 187                                 break;
 188                         default:
 189                                 //VIK_UNITS_HEIGHT_METRES:
 190                                 values[i] = g_strdup_printf ( _("%sAlt %dm"), separator, (int)round(trkpt->altitude) );
 191                                 break;
 192                         }
 193                         break;
 194                 }
 195
 196                 case 'C': {
 197                         gint heading = isnan(trkpt->course) ? 0 : (gint)round(trkpt->course);
 198                         values[i] = g_strdup_printf ( _("%sCourse %03d\302\260" ), separator, heading );
 199                         break;
 200                 }
 201
 202                 case 'P': {
 203                         if ( trkpt_prev ) {
 204                                 gint diff = (gint) round ( vik_coord_diff ( &(trkpt->coord), &(trkpt_prev->coord) ) );
 205
 206                                 gchar *dist_units_str = NULL;
 207                                 vik_units_distance_t dist_units = a_vik_get_units_distance ();
 208                                 // expect the difference between track points to be small hence use metres or yards
 209                                 switch (dist_units) {
 210                                 case VIK_UNITS_DISTANCE_MILES:
 211                                 case VIK_UNITS_DISTANCE_NAUTICAL_MILES:
 212                                         dist_units_str = g_strdup ( _("yards") );
 213                                         break;
 214                                 default:
 215                                         // VIK_UNITS_DISTANCE_KILOMETRES:
 216                                         dist_units_str = g_strdup ( _("m") );
 217                                         break;
 218                                 }
 219
 220                                 values[i] = g_strdup_printf ( _("%sDistance diff %d%s"), separator, diff, dist_units_str );
 221
 222                                 g_free ( dist_units_str );
 223                         }
 224                         break;
 225                 }
 226
 227                 case 'T': {
 228                         gchar *msg;
 229                         if ( trkpt->has_timestamp ) {
 230                                 // Compact date time format
 231                                 msg = vu_get_time_string ( &(trkpt->timestamp), "%x %X", &(trkpt->coord), NULL );
 232                         }
 233                         else
 234                                 msg = g_strdup ("--");
 235                         values[i] = g_strdup_printf ( _("%sTime %s"), separator, msg );
 236                         g_free ( msg );
 237                         break;
 238                 }
 239
 240                 case 'M': {
 241                         if ( trkpt_prev ) {
 242                                 if ( trkpt->has_timestamp && trkpt_prev->has_timestamp ) {
 243                                         time_t t_diff = trkpt->timestamp - trkpt_prev->timestamp;
 244                                         values[i] = g_strdup_printf ( _("%sTime diff %lds"), separator, t_diff );
 245                                 }
 246                         }
 247                         break;
 248                 }
 249
 250                 case 'X': values[i] = g_strdup_printf ( _("%sNo. of Sats %d"), separator, trkpt->nsats ); break;
 251
 252                 case 'F': {
 253                         if ( trk ) {
 254                                 // Distance to the end 'Finish' (along the track)
 255                                 gdouble distd = vik_track_get_length_to_trackpoint (trk, trkpt);
 256                                 gdouble diste = vik_track_get_length_including_gaps ( trk );
 257                                 gdouble dist = diste - distd;
 258                                 gchar *dist_units_str = NULL;
 259                                 vik_units_distance_t dist_units = a_vik_get_units_distance ();
 260                                 switch (dist_units) {
 261                                 case VIK_UNITS_DISTANCE_MILES:
 262                                         dist_units_str = g_strdup ( _("miles") );
 263                                         dist = VIK_METERS_TO_MILES(dist);
 264                                         break;
 265                                 case VIK_UNITS_DISTANCE_NAUTICAL_MILES:
 266                                         dist_units_str = g_strdup ( _("NM") );
 267                                         dist = VIK_METERS_TO_NAUTICAL_MILES(dist);
 268                                         break;
 269                                 default:
 270                                         // VIK_UNITS_DISTANCE_KILOMETRES:
 271                                         dist_units_str = g_strdup ( _("km") );
 272                                         dist = dist / 1000.0;
 273                                         break;
 274                                 }
 275                                 values[i] = g_strdup_printf ( _("%sTo End %.2f%s"), separator, dist, dist_units_str );
 276                                 g_free ( dist_units_str );
 277                         }
 278                         break;
 279                 }
 280
 281                 case 'D': {
 282                         if ( trk ) {
 283                                 // Distance from start (along the track)
 284                                 gdouble distd = vik_track_get_length_to_trackpoint (trk, trkpt);
 285                                 gchar *dist_units_str = NULL;
 286                                 vik_units_distance_t dist_units = a_vik_get_units_distance ();
 287                                 switch (dist_units) {
 288                                 case VIK_UNITS_DISTANCE_MILES:
 289                                         dist_units_str = g_strdup ( _("miles") );
 290                                         distd = VIK_METERS_TO_MILES(distd);
 291                                         break;
 292                                 case VIK_UNITS_DISTANCE_NAUTICAL_MILES:
 293                                         dist_units_str = g_strdup ( _("NM") );
 294                                         distd = VIK_METERS_TO_NAUTICAL_MILES(distd);
 295                                         break;
 296                                 default:
 297                                         // VIK_UNITS_DISTANCE_KILOMETRES:
 298                                         dist_units_str = g_strdup ( _("km") );
 299                                         distd = distd / 1000.0;
 300                                         break;
 301                                 }
 302                                 values[i] = g_strdup_printf ( _("%sDistance along %.2f%s"), separator, distd, dist_units_str );
 303                                 g_free ( dist_units_str );
 304                         }
 305                         break;
 306                 }
 307
 308                 case 'L': {
 309                         // Location (Lat/Long)
 310                         gchar *lat = NULL, *lon = NULL;
 311                         struct LatLon ll;
 312                         vik_coord_to_latlon (&(trkpt->coord), &ll);
 313                         a_coords_latlon_to_string ( &ll, &lat, &lon );
 314                         values[i] = g_strdup_printf ( "%s%s %s", separator, lat, lon );
 315                         g_free ( lat );
 316                         g_free ( lon );
 317                         break;
 318                 }
 319
 320                 case 'N': // Name of track
 321                         values[i] = g_strdup_printf ( _("%sTrack: %s"), separator, trk->name );
 322                         break;
 323
 324                 case 'E': // Name of trackpoint if available
 325                         if ( trkpt->name )
 326                                 values[i] = g_strdup_printf ( "%s%s", separator, trkpt->name );
 327                         else
 328                                 values[i] = g_strdup ( "" );
 329                         break;
 330
 331                 default:
 332                         break;
 333                 }
 334         }
 335
 336         g_free ( separator );
 337         g_free ( speed_units_str );
 338
 339         gchar *msg = g_strconcat ( values[0], values[1], values[2], values[3], values[4], values[5], values[6], values[7], values[8], NULL );
 340
 341         for ( i = 0; i < FMT_MAX_NUMBER_CODES; i++ ) {
 342                 if ( values[i] != '\0' )
 343                         g_free ( values[i] );
 344         }
 345
 346         return msg;
 347 }
 348
 349 typedef struct {
 350         GtkWindow *window; // Layer needed for redrawing
 351         gchar *version;    // Image list
 352 } new_version_thread_data;
 353
 354 static gboolean new_version_available_message ( new_version_thread_data *nvtd )
 355 {
 356         // Only a simple goto website option is offered
 357         // Trying to do an installation update is platform specific
 358         if ( a_dialog_yes_or_no ( nvtd->window,
 359                                 _("There is a newer version of Viking available: %s\n\nDo you wish to go to Viking's website now?"), nvtd->version ) )
 360                 // NB 'VIKING_URL' redirects to the Wiki, here we want to go the main site.
 361                 open_url ( nvtd->window, "http://sourceforge.net/projects/viking/" );
 362
 363         g_free ( nvtd->version );
 364         g_free ( nvtd );
 365         return FALSE;
 366 }
 367
 368 #define VIK_SETTINGS_VERSION_CHECKED_DATE "version_checked_date"
 369
 370 static void latest_version_thread ( GtkWindow *window )
 371 {
 372         // Need to allow a few redirects, as SF file is often served from different server
 373         DownloadMapOptions options = { FALSE, FALSE, NULL, 5, NULL, NULL, NULL };
 374         gchar *filename = a_download_uri_to_tmp_file ( "http://sourceforge.net/projects/viking/files/VERSION", &options );
 375         //gchar *filename = g_strdup ( "VERSION" );
 376         if ( !filename ) {
 377                 return;
 378         }
 379
 380         GMappedFile *mf = g_mapped_file_new ( filename, FALSE, NULL );
 381         if ( !mf )
 382                 return;
 383
 384         gchar *text = g_mapped_file_get_contents ( mf );
 385
 386         gint latest_version = viking_version_to_number ( text );
 387         gint my_version = viking_version_to_number ( VIKING_VERSION );
 388
 389         g_debug ( "The lastest version is: %s", text );
 390
 391         if ( my_version < latest_version ) {
 392                 new_version_thread_data *nvtd = g_malloc ( sizeof(new_version_thread_data) );
 393                 nvtd->window = window;
 394                 nvtd->version = g_strdup ( text );
 395                 gdk_threads_add_idle ( (GSourceFunc) new_version_available_message, nvtd );
 396         }
 397         else
 398                 g_debug ( "Running the lastest version: %s", VIKING_VERSION );
 399
 400         g_mapped_file_unref ( mf );
 401         if ( filename ) {
 402                 g_remove ( filename );
 403                 g_free ( filename );
 404         }
 405
 406         // Update last checked time
 407         GTimeVal time;
 408         g_get_current_time ( &time );
 409         a_settings_set_string ( VIK_SETTINGS_VERSION_CHECKED_DATE, g_time_val_to_iso8601(&time) );
 410 }
 411
 412 #define VIK_SETTINGS_VERSION_CHECK_PERIOD "version_check_period_days"
 413
 414 /**
 415  * vu_check_latest_version:
 416  * @window: Somewhere where we may need use the display to inform the user about the version status
 417  *
 418  * Periodically checks the released latest VERSION file on the website to compare with the running version
 419  *
 420  */
 421 void vu_check_latest_version ( GtkWindow *window )
 422 {
 423         if ( ! a_vik_get_check_version () )
 424                 return;
 425
 426         gboolean do_check = FALSE;
 427
 428         gint check_period;
 429         if ( ! a_settings_get_integer ( VIK_SETTINGS_VERSION_CHECK_PERIOD, &check_period ) ) {
 430                 check_period = 14;
 431         }
 432
 433         // Get last checked date...
 434         GDate *gdate_last = g_date_new();
 435         GDate *gdate_now = g_date_new();
 436         GTimeVal time_last;
 437         gchar *last_checked_date = NULL;
 438
 439         // When no previous date available - set to do the version check
 440         if ( a_settings_get_string ( VIK_SETTINGS_VERSION_CHECKED_DATE, &last_checked_date) ) {
 441                 if ( g_time_val_from_iso8601 ( last_checked_date, &time_last ) ) {
 442                         g_date_set_time_val ( gdate_last, &time_last );
 443                 }
 444                 else
 445                         do_check = TRUE;
 446         }
 447         else
 448                 do_check = TRUE;
 449
 450         GTimeVal time_now;
 451         g_get_current_time ( &time_now );
 452         g_date_set_time_val ( gdate_now, &time_now );
 453
 454         if ( ! do_check ) {
 455                 // Dates available so do the comparison
 456                 g_date_add_days ( gdate_last, check_period );
 457                 if ( g_date_compare ( gdate_last, gdate_now ) < 0 )
 458                         do_check = TRUE;
 459         }
 460
 461         g_date_free ( gdate_last );
 462         g_date_free ( gdate_now );
 463
 464         if ( do_check ) {
 465 #if GLIB_CHECK_VERSION (2, 32, 0)
 466                 g_thread_try_new ( "latest_version_thread", (GThreadFunc)latest_version_thread, window, NULL );
 467 #else
 468                 g_thread_create ( (GThreadFunc)latest_version_thread, window, FALSE, NULL );
 469 #endif
 470         }
 471 }
 472
 473 /**
 474  * vu_set_auto_features_on_first_run:
 475  *
 476  *  Ask the user's opinion to set some of Viking's default behaviour
 477  */
 478 void vu_set_auto_features_on_first_run ( void )
 479 {
 480         gboolean auto_features = FALSE;
 481         gboolean set_defaults = FALSE;
 482
 483         if ( a_vik_very_first_run () ) {
 484
 485                 GtkWidget *win = gtk_window_new ( GTK_WINDOW_TOPLEVEL );
 486
 487                 if ( a_dialog_yes_or_no ( GTK_WINDOW(win),
 488                                           _("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 ) )
 489                         auto_features = TRUE;
 490
 491                 // Default to more standard cache layout for new users (well new installs at least)
 492                 maps_layer_set_cache_default ( VIK_MAPS_CACHE_LAYOUT_OSM );
 493                 set_defaults = TRUE;
 494         }
 495
 496         if ( auto_features ) {
 497                 // Set Maps to autodownload
 498                 // Ensure the default is true
 499                 maps_layer_set_autodownload_default ( TRUE );
 500                 set_defaults = TRUE;
 501
 502                 // Simplistic repeat of preference settings
 503                 //  Only the name & type are important for setting a preference via this 'external' way
 504
 505                 // Enable auto add map +
 506                 // Enable IP lookup
 507                 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, }, };
 508                 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}, };
 509
 510                 VikLayerParamData vlp_data;
 511                 vlp_data.b = TRUE;
 512                 a_preferences_run_setparam ( vlp_data, pref_add_map );
 513
 514                 vlp_data.u = VIK_STARTUP_METHOD_AUTO_LOCATION;
 515                 a_preferences_run_setparam ( vlp_data, pref_startup_method );
 516
 517                 // Only on Windows make checking for the latest version on by default
 518                 // For other systems it's expected a Package manager or similar controls the installation, so leave it off
 519 #ifdef WINDOWS
 520                 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, }, };
 521                 vlp_data.b = TRUE;
 522                 a_preferences_run_setparam ( vlp_data, pref_startup_version_check );
 523 #endif
 524
 525                 // Ensure settings are saved for next time
 526                 a_preferences_save_to_file ();
 527         }
 528
 529         // Ensure defaults are saved if changed
 530         if ( set_defaults )
 531                 a_layer_defaults_save ();
 532 }
 533
 534 /**
 535  * vu_get_canonical_filename:
 536  *
 537  * Returns: Canonical absolute filename
 538  *
 539  * Any time a path may contain a relative component, so need to prepend that directory it is relative to
 540  * Then resolve the full path to get the normal canonical filename
 541  */
 542 gchar *vu_get_canonical_filename ( VikLayer *vl, const gchar *filename )
 543 {
 544   gchar *canonical = NULL;
 545   if ( !filename )
 546     return NULL;
 547
 548   if ( g_path_is_absolute ( filename ) )
 549     canonical = g_strdup ( filename );
 550   else {
 551     const gchar *vw_filename = vik_window_get_filename ( VIK_WINDOW_FROM_WIDGET (vl->vvp) );
 552     gchar *dirpath = NULL;
 553     if ( vw_filename )
 554       dirpath = g_path_get_dirname ( vw_filename );
 555     else
 556       dirpath = g_get_current_dir(); // Fallback - if here then probably can't create the correct path
 557
 558     gchar *full = NULL;
 559     if ( g_path_is_absolute ( dirpath ) )
 560       full = g_strconcat ( dirpath, G_DIR_SEPARATOR_S, filename, NULL );
 561     else
 562       full = g_strconcat ( g_get_current_dir(), G_DIR_SEPARATOR_S, dirpath, G_DIR_SEPARATOR_S, filename, NULL );
 563
 564     canonical = file_realpath_dup ( full ); // resolved
 565     g_free ( full );
 566     g_free ( dirpath );
 567   }
 568
 569   return canonical;
 570 }
 571
 572 static struct kdtree *kd = NULL;
 573
 574 static void load_ll_tz_dir ( const gchar *dir )
 575 {
 576         gchar *lltz = g_build_filename ( dir, "latlontz.txt", NULL );
 577         if ( g_access(lltz, R_OK) == 0 ) {
 578                 gchar buffer[4096];
 579                 long line_num = 0;
 580                 FILE *ff = g_fopen ( lltz, "r" );
 581
 582                 while ( fgets ( buffer, 4096, ff ) ) {
 583                         line_num++;
 584                         gchar **components = g_strsplit (buffer, " ", 3);
 585                         guint nn = g_strv_length ( components );
 586                         if ( nn == 3 ) {
 587                                 double pt[2] = { g_ascii_strtod (components[0], NULL), g_ascii_strtod (components[1], NULL) };
 588                                 gchar *timezone = g_strchomp ( components[2] );
 589                                 if ( kd_insert ( kd, pt, timezone ) )
 590                                         g_critical ( "Insertion problem of %s for line %ld of latlontz.txt", timezone, line_num );
 591                                 // NB Don't free timezone as it's part of the kdtree data now
 592                                 g_free ( components[0] );
 593                                 g_free ( components[1] );
 594                         } else {
 595                                 g_warning ( "Line %ld of latlontz.txt does not have 3 parts", line_num );
 596                         }
 597                         g_free ( components );
 598                 }
 599                 fclose ( ff );
 600         }
 601         g_free ( lltz );
 602 }
 603
 604 /**
 605  * vu_setup_lat_lon_tz_lookup:
 606  *
 607  * Can be called multiple times but only initializes the lookup once
 608  */
 609 void vu_setup_lat_lon_tz_lookup ()
 610 {
 611         // Only setup once
 612         if ( kd )
 613                 return;
 614
 615         kd = kd_create(2);
 616
 617         // Look in the directories of data path
 618         gchar **data_dirs = a_get_viking_data_path();
 619         // Process directories in reverse order for priority
 620         guint n_data_dirs = g_strv_length ( data_dirs );
 621         for (; n_data_dirs > 0; n_data_dirs--) {
 622                 load_ll_tz_dir(data_dirs[n_data_dirs-1]);
 623         }
 624         g_strfreev ( data_dirs );
 625 }
 626
 627 /**
 628  * vu_finalize_lat_lon_tz_lookup:
 629  *
 630  * Clear memory used by the lookup.
 631  *  only call on program exit
 632  */
 633 void vu_finalize_lat_lon_tz_lookup ()
 634 {
 635         if ( kd ) {
 636                 kd_data_destructor ( kd, g_free );
 637                 kd_free ( kd );
 638         }
 639 }
 640
 641 static double dist_sq( double *a1, double *a2, int dims ) {
 642   double dist_sq = 0, diff;
 643   while( --dims >= 0 ) {
 644     diff = (a1[dims] - a2[dims]);
 645     dist_sq += diff*diff;
 646   }
 647   return dist_sq;
 648 }
 649
 650 static gchar* time_string_adjusted ( time_t *time, gint offset_s )
 651 {
 652         time_t *mytime = time;
 653         *mytime = *mytime + offset_s;
 654         gchar *str = g_malloc ( 64 );
 655         // Append asterisks to indicate use of simplistic model (i.e. no TZ)
 656         strftime ( str, 64, "%a %X %x **", gmtime(mytime) );
 657         return str;
 658 }
 659
 660 static gchar* time_string_tz ( time_t *time, const gchar *format, GTimeZone *tz )
 661 {
 662         GDateTime *utc = g_date_time_new_from_unix_utc (*time);
 663         GDateTime *local = g_date_time_to_timezone ( utc, tz );
 664         if ( !local ) {
 665                 g_date_time_unref ( utc );
 666                 return NULL;
 667         }
 668         gchar *str = g_date_time_format ( local, format );
 669
 670         g_date_time_unref ( local );
 671         g_date_time_unref ( utc );
 672         return str;
 673 }
 674
 675 #define VIK_SETTINGS_NEAREST_TZ_FACTOR "utils_nearest_tz_factor"
 676 /**
 677  * vu_get_tz_at_location:
 678  *
 679  * @vc:     Position for which the time zone is desired
 680  *
 681  * Returns: TimeZone string of the nearest known location. String may be NULL.
 682  *
 683  * Use the k-d tree method (http://en.wikipedia.org/wiki/Kd-tree) to quickly retreive
 684  *  the nearest location to the given position.
 685  */
 686 gchar* vu_get_tz_at_location ( const VikCoord* vc )
 687 {
 688         gchar *tz = NULL;
 689         if ( !vc || !kd )
 690                 return tz;
 691
 692         struct LatLon ll;
 693         vik_coord_to_latlon ( vc, &ll );
 694         double pt[2] = { ll.lat, ll.lon };
 695
 696         gdouble nearest;
 697         if ( !a_settings_get_double(VIK_SETTINGS_NEAREST_TZ_FACTOR, &nearest) )
 698                 nearest = 1.0;
 699
 700         struct kdres *presults = kd_nearest_range ( kd, pt, nearest );
 701         while( !kd_res_end( presults ) ) {
 702                 double pos[2];
 703                 gchar *ans = (gchar*)kd_res_item ( presults, pos );
 704                 // compute the distance of the current result from the pt
 705                 double dist = sqrt( dist_sq( pt, pos, 2 ) );
 706                 if ( dist < nearest ) {
 707                         //printf( "NEARER node at (%.3f, %.3f, %.3f) is %.3f away is %s\n", pos[0], pos[1], pos[2], dist, ans );
 708                         nearest = dist;
 709                         tz = ans;
 710                 }
 711                 kd_res_next ( presults );
 712         }
 713         g_debug ( "TZ lookup found %d results - picked %s", kd_res_size(presults), tz );
 714         kd_res_free ( presults );
 715
 716         return tz;
 717 }
 718
 719 /**
 720  * vu_get_time_string:
 721  *
 722  * @time_t: The time of which the string is wanted
 723  * @format  The format of the time string - such as "%c"
 724  * @vc:     Position of object for the time output - maybe NULL
 725  *          (only applicable for VIK_TIME_REF_WORLD)
 726  * @tz:     TimeZone string - maybe NULL.
 727  *          (only applicable for VIK_TIME_REF_WORLD)
 728  *          Useful to pass in the cached value from vu_get_tz_at_location() to save looking it up again for the same position
 729  *
 730  * Returns: A string of the time according to the time display property
 731  */
 732 gchar* vu_get_time_string ( time_t *time, const gchar *format, const VikCoord* vc, const gchar *tz )
 733 {
 734         if ( !format ) return NULL;
 735         gchar *str = NULL;
 736         switch ( a_vik_get_time_ref_frame() ) {
 737                 case VIK_TIME_REF_UTC:
 738                         str = g_malloc ( 64 );
 739                         strftime ( str, 64, format, gmtime(time) ); // Always 'GMT'
 740                         break;
 741                 case VIK_TIME_REF_WORLD:
 742                         if ( vc && !tz ) {
 743                                 // No timezone specified so work it out
 744                                 gchar *mytz = vu_get_tz_at_location ( vc );
 745                                 if ( mytz ) {
 746                                         GTimeZone *gtz = g_time_zone_new ( mytz );
 747                                         str = time_string_tz ( time, format, gtz );
 748                                         g_time_zone_unref ( gtz );
 749                                 }
 750                                 else {
 751                                         // No results (e.g. could be in the middle of a sea)
 752                                         // Fallback to simplistic method that doesn't take into account Timezones of countries.
 753                                         struct LatLon ll;
 754                                         vik_coord_to_latlon ( vc, &ll );
 755                                         str = time_string_adjusted ( time, round ( ll.lon / 15.0 ) * 3600 );
 756                                 }
 757                         }
 758                         else {
 759                                 // Use specified timezone
 760                                 GTimeZone *gtz = g_time_zone_new ( tz );
 761                                 str = time_string_tz ( time, format, gtz );
 762                                 g_time_zone_unref ( gtz );
 763                         }
 764                         break;
 765                 default: // VIK_TIME_REF_LOCALE
 766                         str = g_malloc ( 64 );
 767                         strftime ( str, 64, format, localtime(time) );
 768                         break;
 769         }
 770         return str;
 771 }
 772
 773 /**
 774  * vu_command_line:
 775  *
 776  * Apply any startup values that have been specified from the command line
 777  * Values are defaulted in such a manner not to be applied when they haven't been specified
 778  *
 779  */
 780 void vu_command_line ( VikWindow *vw, gdouble latitude, gdouble longitude, gint zoom_osm_level, gint map_id )
 781 {
 782         if ( !vw )
 783                 return;
 784
 785         VikViewport *vvp = vik_window_viewport(vw);
 786
 787         if ( latitude != 0.0 || longitude != 0.0 ) {
 788                 struct LatLon ll;
 789                 ll.lat = latitude;
 790                 ll.lon = longitude;
 791                 vik_viewport_set_center_latlon ( vvp, &ll, TRUE );
 792         }
 793
 794         if ( zoom_osm_level >= 0 ) {
 795                 // Convert OSM zoom level into Viking zoom level
 796                 gdouble mpp = exp ( (17-zoom_osm_level) * log(2) );
 797                 if ( mpp > 1.0 )
 798                         mpp = round (mpp);
 799                 vik_viewport_set_zoom ( vvp, mpp );
 800         }
 801
 802         if ( map_id >= 0 ) {
 803                 guint my_map_id = map_id;
 804                 if ( my_map_id == 0 )
 805                         my_map_id = vik_maps_layer_get_default_map_type ();
 806
 807                 // Don't add map layer if one already exists
 808                 GList *vmls = vik_layers_panel_get_all_layers_of_type(vik_window_layers_panel(vw), VIK_LAYER_MAPS, TRUE);
 809                 int num_maps = g_list_length(vmls);
 810                 gboolean add_map = TRUE;
 811
 812                 for (int i = 0; i < num_maps; i++) {
 813                         VikMapsLayer *vml = (VikMapsLayer*)(vmls->data);
 814                         gint id = vik_maps_layer_get_map_type(vml);
 815                         if ( my_map_id == id ) {
 816                                 add_map = FALSE;
 817                                 break;
 818                         }
 819                         vmls = vmls->next;
 820                 }
 821
 822                 if ( add_map ) {
 823                         VikMapsLayer *vml = VIK_MAPS_LAYER ( vik_layer_create(VIK_LAYER_MAPS, vvp, FALSE) );
 824                         vik_maps_layer_set_map_type ( vml, my_map_id );
 825                         vik_layer_rename ( VIK_LAYER(vml), _("Map") );
 826                         vik_aggregate_layer_add_layer ( vik_layers_panel_get_top_layer(vik_window_layers_panel(vw)), VIK_LAYER(vml), TRUE );
 827                         vik_layer_emit_update ( VIK_LAYER(vml) );
 828                 }
 829         }
 830 }
 831
 832 /**
 833  * Copy the displayed text of a widget (should be a GtkButton ATM)
 834  */
 835 static void vu_copy_label ( GtkWidget *widget )
 836 {
 837         a_clipboard_copy (VIK_CLIPBOARD_DATA_TEXT, 0, 0, 0, gtk_button_get_label(GTK_BUTTON(widget)), NULL );
 838 }
 839
 840 /**
 841  * Generate a single entry menu to allow copying the displayed text of a widget (should be a GtkButton ATM)
 842  */
 843 void vu_copy_label_menu ( GtkWidget *widget, guint button )
 844 {
 845         GtkWidget *menu = gtk_menu_new();
 846         GtkWidget *item = gtk_image_menu_item_new_from_stock ( GTK_STOCK_COPY, NULL );
 847         g_signal_connect_swapped ( G_OBJECT(item), "activate", G_CALLBACK(vu_copy_label), widget );
 848         gtk_menu_shell_append ( GTK_MENU_SHELL(menu), item );
 849         gtk_widget_show ( item );
 850         gtk_menu_popup ( GTK_MENU(menu), NULL, NULL, NULL, NULL, button, gtk_get_current_event_time() );
 851 }