]> git.street.me.uk Git - andy/viking.git/blobdiff - src/vikutils.c
Enable Cache conversion in the Python tool viking-cache.py
[andy/viking.git] / src / vikutils.c
index e14e9b7821d4e1874893423628245d7a49186595..364adfce0e69cbb2ad409a554dde0dc4775db6eb 100644 (file)
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  */
+/*
+ * Dependencies in this file can be on anything.
+ * For functions with simple system dependencies put it in util.c
+ */
 #include <math.h>
+#include <glib/gstdio.h>
 #include <glib/gi18n.h>
+#include <gtk/gtk.h>
 
 #include "viking.h"
 #include "vikutils.h"
+#include "globals.h"
+#include "download.h"
+#include "preferences.h"
+#include "vikmapslayer.h"
+#include "settings.h"
+#include "util.h"
+#include "ui_util.h"
+#include "dir.h"
+#include "misc/kdtree.h"
 
 #define FMT_MAX_NUMBER_CODES 9
 
@@ -83,7 +98,7 @@ gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkp
                case 'S': {
                        gdouble speed = 0.0;
                        gchar *speedtype = NULL;
-                       if ( !isnan(trkpt->speed) && trkpt_prev ) {
+                       if ( isnan(trkpt->speed) && trkpt_prev ) {
                                if ( trkpt->has_timestamp && trkpt_prev->has_timestamp ) {
                                        if ( trkpt->timestamp == trkpt_prev->timestamp ) {
 
@@ -152,6 +167,7 @@ gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkp
                                // expect the difference between track points to be small hence use metres or yards
                                switch (dist_units) {
                                case VIK_UNITS_DISTANCE_MILES:
+                               case VIK_UNITS_DISTANCE_NAUTICAL_MILES:
                                        dist_units_str = g_strdup ( _("yards") );
                                        break;
                                default:
@@ -168,15 +184,15 @@ gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkp
                }
 
                case 'T': {
-                       gchar tmp[64];
-                       tmp[0] = '\0';
+                       gchar *msg;
                        if ( trkpt->has_timestamp ) {
                                // Compact date time format
-                               strftime (tmp, sizeof(tmp), "%x %X", localtime(&(trkpt->timestamp)));
+                               msg = vu_get_time_string ( &(trkpt->timestamp), "%x %X", &(trkpt->coord), NULL );
                        }
                        else
-                               g_snprintf (tmp, sizeof(tmp), "--");
-                       values[i] = g_strdup_printf ( _("%sTime %s"), separator, tmp );
+                               msg = g_strdup ("--");
+                       values[i] = g_strdup_printf ( _("%sTime %s"), separator, msg );
+                       g_free ( msg );
                        break;
                }
 
@@ -192,18 +208,50 @@ gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkp
 
                case 'X': values[i] = g_strdup_printf ( _("%sNo. of Sats %d"), separator, trkpt->nsats ); break;
 
+               case 'F': {
+                       if ( trk ) {
+                               // Distance to the end 'Finish' (along the track)
+                               gdouble distd = vik_track_get_length_to_trackpoint (trk, trkpt);
+                               gdouble diste = vik_track_get_length_including_gaps ( trk );
+                               gdouble dist = diste - distd;
+                               gchar *dist_units_str = NULL;
+                               vik_units_distance_t dist_units = a_vik_get_units_distance ();
+                               switch (dist_units) {
+                               case VIK_UNITS_DISTANCE_MILES:
+                                       dist_units_str = g_strdup ( _("miles") );
+                                       dist = VIK_METERS_TO_MILES(dist);
+                                       break;
+                               case VIK_UNITS_DISTANCE_NAUTICAL_MILES:
+                                       dist_units_str = g_strdup ( _("NM") );
+                                       dist = VIK_METERS_TO_NAUTICAL_MILES(dist);
+                                       break;
+                               default:
+                                       // VIK_UNITS_DISTANCE_KILOMETRES:
+                                       dist_units_str = g_strdup ( _("km") );
+                                       dist = dist / 1000.0;
+                                       break;
+                               }
+                               values[i] = g_strdup_printf ( _("%sTo End %.2f%s"), separator, dist, dist_units_str );
+                               g_free ( dist_units_str );
+                       }
+                       break;
+               }
+
                case 'D': {
                        if ( trk ) {
                                // Distance from start (along the track)
                                gdouble distd = vik_track_get_length_to_trackpoint (trk, trkpt);
                                gchar *dist_units_str = NULL;
                                vik_units_distance_t dist_units = a_vik_get_units_distance ();
-                               // expect the difference between track points to be small hence use metres or yards
                                switch (dist_units) {
                                case VIK_UNITS_DISTANCE_MILES:
                                        dist_units_str = g_strdup ( _("miles") );
                                        distd = VIK_METERS_TO_MILES(distd);
                                        break;
+                               case VIK_UNITS_DISTANCE_NAUTICAL_MILES:
+                                       dist_units_str = g_strdup ( _("NM") );
+                                       distd = VIK_METERS_TO_NAUTICAL_MILES(distd);
+                                       break;
                                default:
                                        // VIK_UNITS_DISTANCE_KILOMETRES:
                                        dist_units_str = g_strdup ( _("km") );
@@ -256,3 +304,427 @@ gchar* vu_trackpoint_formatted_message ( gchar *format_code, VikTrackpoint *trkp
        
        return msg;
 }
+
+typedef struct {
+       GtkWindow *window; // Layer needed for redrawing
+       gchar *version;    // Image list
+} new_version_thread_data;
+
+static gboolean new_version_available_message ( new_version_thread_data *nvtd )
+{
+       // Only a simple goto website option is offered
+       // Trying to do an installation update is platform specific
+       if ( a_dialog_yes_or_no ( nvtd->window,
+                               _("There is a newer version of Viking available: %s\n\nDo you wish to go to Viking's website now?"), nvtd->version ) )
+               // NB 'VIKING_URL' redirects to the Wiki, here we want to go the main site.
+               open_url ( nvtd->window, "http://sourceforge.net/projects/viking/" );
+
+       g_free ( nvtd->version );
+       g_free ( nvtd );
+       return FALSE;
+}
+
+#define VIK_SETTINGS_VERSION_CHECKED_DATE "version_checked_date"
+
+static void latest_version_thread ( GtkWindow *window )
+{
+       // Need to allow a few redirects, as SF file is often served from different server
+       DownloadMapOptions options = { FALSE, FALSE, NULL, 5, NULL, NULL, NULL };
+       gchar *filename = a_download_uri_to_tmp_file ( "http://sourceforge.net/projects/viking/files/VERSION", &options );
+       //gchar *filename = g_strdup ( "VERSION" );
+       if ( !filename ) {
+               return;
+       }
+
+       GMappedFile *mf = g_mapped_file_new ( filename, FALSE, NULL );
+       if ( !mf )
+               return;
+
+       gchar *text = g_mapped_file_get_contents ( mf );
+
+       gint latest_version = viking_version_to_number ( text );
+       gint my_version = viking_version_to_number ( VIKING_VERSION );
+
+       g_debug ( "The lastest version is: %s", text );
+
+       if ( my_version < latest_version ) {
+               new_version_thread_data *nvtd = g_malloc ( sizeof(new_version_thread_data) );
+               nvtd->window = window;
+               nvtd->version = g_strdup ( text );
+               gdk_threads_add_idle ( (GSourceFunc) new_version_available_message, nvtd );
+       }
+       else
+               g_debug ( "Running the lastest version: %s", VIKING_VERSION );
+
+       g_mapped_file_unref ( mf );
+       if ( filename ) {
+               g_remove ( filename );
+               g_free ( filename );
+       }
+
+       // Update last checked time
+       GTimeVal time;
+       g_get_current_time ( &time );
+       a_settings_set_string ( VIK_SETTINGS_VERSION_CHECKED_DATE, g_time_val_to_iso8601(&time) );
+}
+
+#define VIK_SETTINGS_VERSION_CHECK_PERIOD "version_check_period_days"
+
+/**
+ * vu_check_latest_version:
+ * @window: Somewhere where we may need use the display to inform the user about the version status
+ *
+ * Periodically checks the released latest VERSION file on the website to compare with the running version
+ *
+ */
+void vu_check_latest_version ( GtkWindow *window )
+{
+       if ( ! a_vik_get_check_version () )
+               return;
+
+       gboolean do_check = FALSE;
+
+       gint check_period;
+       if ( ! a_settings_get_integer ( VIK_SETTINGS_VERSION_CHECK_PERIOD, &check_period ) ) {
+               check_period = 14;
+       }
+
+       // Get last checked date...
+       GDate *gdate_last = g_date_new();
+       GDate *gdate_now = g_date_new();
+       GTimeVal time_last;
+       gchar *last_checked_date = NULL;
+
+       // When no previous date available - set to do the version check
+       if ( a_settings_get_string ( VIK_SETTINGS_VERSION_CHECKED_DATE, &last_checked_date) ) {
+               if ( g_time_val_from_iso8601 ( last_checked_date, &time_last ) ) {
+                       g_date_set_time_val ( gdate_last, &time_last );
+               }
+               else
+                       do_check = TRUE;
+       }
+       else
+               do_check = TRUE;
+
+       GTimeVal time_now;
+       g_get_current_time ( &time_now );
+       g_date_set_time_val ( gdate_now, &time_now );
+
+       if ( ! do_check ) {
+               // Dates available so do the comparison
+               g_date_add_days ( gdate_last, check_period );
+               if ( g_date_compare ( gdate_last, gdate_now ) < 0 )
+                       do_check = TRUE;
+       }
+
+       g_date_free ( gdate_last );
+       g_date_free ( gdate_now );
+
+       if ( do_check ) {
+#if GLIB_CHECK_VERSION (2, 32, 0)
+               g_thread_try_new ( "latest_version_thread", (GThreadFunc)latest_version_thread, window, NULL );
+#else
+               g_thread_create ( (GThreadFunc)latest_version_thread, window, FALSE, NULL );
+#endif
+       }
+}
+
+/**
+ * vu_set_auto_features_on_first_run:
+ *
+ *  Ask the user's opinion to set some of Viking's default behaviour
+ */
+void vu_set_auto_features_on_first_run ( void )
+{
+       gboolean auto_features = FALSE;
+       gboolean set_defaults = FALSE;
+
+       if ( a_vik_very_first_run () ) {
+
+               GtkWidget *win = gtk_window_new ( GTK_WINDOW_TOPLEVEL );
+
+               if ( a_dialog_yes_or_no ( GTK_WINDOW(win),
+                                         _("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 ) )
+                       auto_features = TRUE;
+
+               // Default to more standard cache layout for new users (well new installs at least)
+               maps_layer_set_cache_default ( VIK_MAPS_CACHE_LAYOUT_OSM );
+               set_defaults = TRUE;
+       }
+
+       if ( auto_features ) {
+               // Set Maps to autodownload
+               // Ensure the default is true
+               maps_layer_set_autodownload_default ( TRUE );
+               set_defaults = TRUE;
+
+               // Simplistic repeat of preference settings
+               //  Only the name & type are important for setting a preference via this 'external' way
+
+               // Enable auto add map +
+               // Enable IP lookup
+               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, }, };
+               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}, };
+
+               VikLayerParamData vlp_data;
+               vlp_data.b = TRUE;
+               a_preferences_run_setparam ( vlp_data, pref_add_map );
+
+               vlp_data.u = VIK_STARTUP_METHOD_AUTO_LOCATION;
+               a_preferences_run_setparam ( vlp_data, pref_startup_method );
+
+               // Only on Windows make checking for the latest version on by default
+               // For other systems it's expected a Package manager or similar controls the installation, so leave it off
+#ifdef WINDOWS
+               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, }, };
+               vlp_data.b = TRUE;
+               a_preferences_run_setparam ( vlp_data, pref_startup_version_check );
+#endif
+
+               // Ensure settings are saved for next time
+               a_preferences_save_to_file ();
+       }
+
+       // Ensure defaults are saved if changed
+       if ( set_defaults )
+               a_layer_defaults_save ();
+}
+
+/**
+ * vu_get_canonical_filename:
+ *
+ * Returns: Canonical absolute filename
+ *
+ * Any time a path may contain a relative component, so need to prepend that directory it is relative to
+ * Then resolve the full path to get the normal canonical filename
+ */
+gchar *vu_get_canonical_filename ( VikLayer *vl, const gchar *filename )
+{
+  gchar *canonical = NULL;
+  if ( !filename )
+    return NULL;
+
+  if ( g_path_is_absolute ( filename ) )
+    canonical = g_strdup ( filename );
+  else {
+    const gchar *vw_filename = vik_window_get_filename ( VIK_WINDOW_FROM_WIDGET (vl->vvp) );
+    gchar *dirpath = NULL;
+    if ( vw_filename )
+      dirpath = g_path_get_dirname ( vw_filename );
+    else
+      dirpath = g_get_current_dir(); // Fallback - if here then probably can't create the correct path
+
+    gchar *full = NULL;
+    if ( g_path_is_absolute ( dirpath ) )
+      full = g_strconcat ( dirpath, G_DIR_SEPARATOR_S, filename, NULL );
+    else
+      full = g_strconcat ( g_get_current_dir(), G_DIR_SEPARATOR_S, dirpath, G_DIR_SEPARATOR_S, filename, NULL );
+
+    canonical = file_realpath_dup ( full ); // resolved
+    g_free ( full );
+    g_free ( dirpath );
+  }
+
+  return canonical;
+}
+
+static struct kdtree *kd = NULL;
+
+static void load_ll_tz_dir ( const gchar *dir )
+{
+       gchar *lltz = g_build_filename ( dir, "latlontz.txt", NULL );
+       if ( g_access(lltz, R_OK) == 0 ) {
+               gchar buffer[4096];
+               long line_num = 0;
+               FILE *ff = g_fopen ( lltz, "r" );
+
+               while ( fgets ( buffer, 4096, ff ) ) {
+                       line_num++;
+                       gchar **components = g_strsplit (buffer, " ", 3);
+                       guint nn = g_strv_length ( components );
+                       if ( nn == 3 ) {
+                               double pt[2] = { g_ascii_strtod (components[0], NULL), g_ascii_strtod (components[1], NULL) };
+                               gchar *timezone = g_strchomp ( components[2] );
+                               if ( kd_insert ( kd, pt, timezone ) )
+                                       g_critical ( "Insertion problem of %s for line %ld of latlontz.txt", timezone, line_num );
+                               // NB Don't free timezone as it's part of the kdtree data now
+                               g_free ( components[0] );
+                               g_free ( components[1] );
+                       } else {
+                               g_warning ( "Line %ld of latlontz.txt does not have 3 parts", line_num );
+                       }
+                       g_free ( components );
+               }
+               fclose ( ff );
+       }
+       g_free ( lltz );
+}
+
+/**
+ * vu_setup_lat_lon_tz_lookup:
+ *
+ * Can be called multiple times but only initializes the lookup once
+ */
+void vu_setup_lat_lon_tz_lookup ()
+{
+       // Only setup once
+       if ( kd )
+               return;
+
+       kd = kd_create(2);
+
+       // Look in the directories of data path
+       gchar **data_dirs = a_get_viking_data_path();
+       // Process directories in reverse order for priority
+       guint n_data_dirs = g_strv_length ( data_dirs );
+       for (; n_data_dirs > 0; n_data_dirs--) {
+               load_ll_tz_dir(data_dirs[n_data_dirs-1]);
+       }
+       g_strfreev ( data_dirs );
+}
+
+/**
+ * vu_finalize_lat_lon_tz_lookup:
+ *
+ * Clear memory used by the lookup.
+ *  only call on program exit
+ */
+void vu_finalize_lat_lon_tz_lookup ()
+{
+       if ( kd ) {
+               kd_data_destructor ( kd, g_free );
+               kd_free ( kd );
+       }
+}
+
+static double dist_sq( double *a1, double *a2, int dims ) {
+  double dist_sq = 0, diff;
+  while( --dims >= 0 ) {
+    diff = (a1[dims] - a2[dims]);
+    dist_sq += diff*diff;
+  }
+  return dist_sq;
+}
+
+static gchar* time_string_adjusted ( time_t *time, gint offset_s )
+{
+       time_t *mytime = time;
+       *mytime = *mytime + offset_s;
+       gchar *str = g_malloc ( 64 );
+       // Append asterisks to indicate use of simplistic model (i.e. no TZ)
+       strftime ( str, 64, "%a %X %x **", gmtime(mytime) );
+       return str;
+}
+
+static gchar* time_string_tz ( time_t *time, const gchar *format, GTimeZone *tz )
+{
+       GDateTime *utc = g_date_time_new_from_unix_utc (*time);
+       GDateTime *local = g_date_time_to_timezone ( utc, tz );
+       if ( !local ) {
+               g_date_time_unref ( utc );
+               return NULL;
+       }
+       gchar *str = g_date_time_format ( local, format );
+
+       g_date_time_unref ( local );
+       g_date_time_unref ( utc );
+       return str;
+}
+
+#define VIK_SETTINGS_NEAREST_TZ_FACTOR "utils_nearest_tz_factor"
+/**
+ * vu_get_tz_at_location:
+ *
+ * @vc:     Position for which the time zone is desired
+ *
+ * Returns: TimeZone string of the nearest known location. String may be NULL.
+ *
+ * Use the k-d tree method (http://en.wikipedia.org/wiki/Kd-tree) to quickly retreive
+ *  the nearest location to the given position.
+ */
+gchar* vu_get_tz_at_location ( const VikCoord* vc )
+{
+       gchar *tz = NULL;
+       if ( !vc || !kd )
+               return tz;
+
+       struct LatLon ll;
+       vik_coord_to_latlon ( vc, &ll );
+       double pt[2] = { ll.lat, ll.lon };
+
+       gdouble nearest;
+       if ( !a_settings_get_double(VIK_SETTINGS_NEAREST_TZ_FACTOR, &nearest) )
+               nearest = 1.0;
+
+       struct kdres *presults = kd_nearest_range ( kd, pt, nearest );
+       while( !kd_res_end( presults ) ) {
+               double pos[2];
+               gchar *ans = (gchar*)kd_res_item ( presults, pos );
+               // compute the distance of the current result from the pt
+               double dist = sqrt( dist_sq( pt, pos, 2 ) );
+               if ( dist < nearest ) {
+                       //printf( "NEARER node at (%.3f, %.3f, %.3f) is %.3f away is %s\n", pos[0], pos[1], pos[2], dist, ans );
+                       nearest = dist;
+                       tz = ans;
+               }
+               kd_res_next ( presults );
+       }
+       g_debug ( "TZ lookup found %d results - picked %s", kd_res_size(presults), tz );
+       kd_res_free ( presults );
+
+       return tz;
+}
+
+/**
+ * vu_get_time_string:
+ *
+ * @time_t: The time of which the string is wanted
+ * @format  The format of the time string - such as "%c"
+ * @vc:     Position of object for the time output - maybe NULL
+ *          (only applicable for VIK_TIME_REF_WORLD)
+ * @tz:     TimeZone string - maybe NULL.
+ *          (only applicable for VIK_TIME_REF_WORLD)
+ *          Useful to pass in the cached value from vu_get_tz_at_location() to save looking it up again for the same position
+ *
+ * Returns: A string of the time according to the time display property
+ */
+gchar* vu_get_time_string ( time_t *time, const gchar *format, const VikCoord* vc, const gchar *tz )
+{
+       if ( !format ) return NULL;
+       gchar *str = NULL;
+       switch ( a_vik_get_time_ref_frame() ) {
+               case VIK_TIME_REF_UTC:
+                       str = g_malloc ( 64 );
+                       strftime ( str, 64, format, gmtime(time) ); // Always 'GMT'
+                       break;
+               case VIK_TIME_REF_WORLD:
+                       if ( vc && !tz ) {
+                               // No timezone specified so work it out
+                               gchar *mytz = vu_get_tz_at_location ( vc );
+                               if ( mytz ) {
+                                       GTimeZone *gtz = g_time_zone_new ( mytz );
+                                       str = time_string_tz ( time, format, gtz );
+                                       g_time_zone_unref ( gtz );
+                               }
+                               else {
+                                       // No results (e.g. could be in the middle of a sea)
+                                       // Fallback to simplistic method that doesn't take into account Timezones of countries.
+                                       struct LatLon ll;
+                                       vik_coord_to_latlon ( vc, &ll );
+                                       str = time_string_adjusted ( time, round ( ll.lon / 15.0 ) * 3600 );
+                               }
+                       }
+                       else {
+                               // Use specified timezone
+                               GTimeZone *gtz = g_time_zone_new ( tz );
+                               str = time_string_tz ( time, format, gtz );
+                               g_time_zone_unref ( gtz );
+                       }
+                       break;
+               default: // VIK_TIME_REF_LOCALE
+                       str = g_malloc ( 64 );
+                       strftime ( str, 64, format, localtime(time) );
+                       break;
+       }
+       return str;
+}