X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/8c0604067586d37324e75ee2939038ecde370fa1..db771541ff9b86b3ef5e204d5d5d659ccf66e7e6:/src/file.c diff --git a/src/file.c b/src/file.c index 6a8e75f3..d2692a35 100644 --- a/src/file.c +++ b/src/file.c @@ -2,6 +2,8 @@ * viking -- GPS Data and Topo Analyzer, Explorer, and Manager * * Copyright (C) 2003-2005, Evan Battaglia + * Copyright (C) 2012, Guilhem Bonnefille + * Copyright (C) 2012-2013, Rob Norris * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -24,7 +26,10 @@ #endif #include "viking.h" +#include "jpg.h" #include "gpx.h" +#include "geojson.h" +#include "babel.h" #include #include @@ -32,25 +37,22 @@ #ifdef HAVE_UNISTD_H #include #endif +#ifdef WINDOWS +#define realpath(X,Y) _fullpath(Y,X,MAX_PATH) +#endif #include #include +#include -/* Relax some dependencies */ -#if ! GLIB_CHECK_VERSION(2,12,0) -static gboolean return_true (gpointer a, gpointer b, gpointer c) { return TRUE; } -static g_hash_table_remove_all (GHashTable *ght) { g_hash_table_foreach_remove ( ght, (GHRFunc) return_true, FALSE ); } -#endif +#include "file.h" +#include "misc/strtod.h" #define TEST_BOOLEAN(str) (! ((str)[0] == '\0' || (str)[0] == '0' || (str)[0] == 'n' || (str)[0] == 'N' || (str)[0] == 'f' || (str)[0] == 'F') ) #define VIK_MAGIC "#VIK" #define GPX_MAGIC "name ) == 0 ) - return i; - return -1; -} - -void file_write_layer_param ( FILE *f, const gchar *name, guint8 type, VikLayerParamData data ) { +void file_write_layer_param ( FILE *f, const gchar *name, VikLayerParamType type, VikLayerParamData data ) { /* string lists are handled differently. We get a GList (that shouldn't * be freed) back for get_param and if it is null we shouldn't write * anything at all (otherwise we'd read in a list with an empty string, @@ -130,8 +123,9 @@ void file_write_layer_param ( FILE *f, const gchar *name, guint8 type, VikLayerP case VIK_LAYER_PARAM_UINT: fprintf ( f, "%d\n", data.u ); break; case VIK_LAYER_PARAM_INT: fprintf ( f, "%d\n", data.i ); break; case VIK_LAYER_PARAM_BOOLEAN: fprintf ( f, "%c\n", data.b ? 't' : 'f' ); break; - case VIK_LAYER_PARAM_STRING: fprintf ( f, "%s\n", data.s ); break; + case VIK_LAYER_PARAM_STRING: fprintf ( f, "%s\n", data.s ? data.s : "" ); break; case VIK_LAYER_PARAM_COLOR: fprintf ( f, "#%.2x%.2x%.2x\n", (int)(data.c.red/256),(int)(data.c.green/256),(int)(data.c.blue/256)); break; + default: break; } } } @@ -151,7 +145,7 @@ static void write_layer_params_and_data ( VikLayer *l, FILE *f ) guint16 i, params_count = vik_layer_get_interface(l->type)->params_count; for ( i = 0; i < params_count; i++ ) { - data = get_param(l,i); + data = get_param(l, i, TRUE); file_write_layer_param(f, params[i].name, params[i].type, data); } } @@ -172,7 +166,8 @@ static void file_write ( VikAggregateLayer *top, FILE *f, gpointer vp ) Stack *stack = NULL; VikLayer *current_layer; struct LatLon ll; - gchar *modestring; + VikViewportDrawMode mode; + gchar *modestring = NULL; push(&stack); stack->data = (gpointer) vik_aggregate_layer_get_children(VIK_AGGREGATE_LAYER(top)); @@ -181,19 +176,25 @@ static void file_write ( VikAggregateLayer *top, FILE *f, gpointer vp ) /* crazhy CRAZHY */ vik_coord_to_latlon ( vik_viewport_get_center ( VIK_VIEWPORT(vp) ), &ll ); - switch ( vik_viewport_get_drawmode ( VIK_VIEWPORT(vp) ) ) { + mode = vik_viewport_get_drawmode ( VIK_VIEWPORT(vp) ); + switch ( mode ) { case VIK_VIEWPORT_DRAWMODE_UTM: modestring = "utm"; break; case VIK_VIEWPORT_DRAWMODE_EXPEDIA: modestring = "expedia"; break; - case VIK_VIEWPORT_DRAWMODE_GOOGLE: modestring = "google"; break; - case VIK_VIEWPORT_DRAWMODE_KH: modestring = "kh"; break; - default: modestring = "mercator"; + case VIK_VIEWPORT_DRAWMODE_MERCATOR: modestring = "mercator"; break; + case VIK_VIEWPORT_DRAWMODE_LATLON: modestring = "latlon"; break; + default: + g_critical("Houston, we've had a problem. mode=%d", mode); } - fprintf ( f, "#VIKING GPS Data file " VIKING_URL "\n\nxmpp=%f\nympp=%f\nlat=%f\nlon=%f\nmode=%s\ncolor=%s\ndrawscale=%s\ndrawcentermark=%s", + fprintf ( f, "#VIKING GPS Data file " VIKING_URL "\n" ); + fprintf ( f, "FILE_VERSION=%d\n", VIKING_FILE_VERSION ); + fprintf ( f, "\nxmpp=%f\nympp=%f\nlat=%f\nlon=%f\nmode=%s\ncolor=%s\nhighlightcolor=%s\ndrawscale=%s\ndrawcentermark=%s\ndrawhighlight=%s\n", vik_viewport_get_xmpp ( VIK_VIEWPORT(vp) ), vik_viewport_get_ympp ( VIK_VIEWPORT(vp) ), ll.lat, ll.lon, modestring, vik_viewport_get_background_color(VIK_VIEWPORT(vp)), + vik_viewport_get_highlight_color(VIK_VIEWPORT(vp)), vik_viewport_get_draw_scale(VIK_VIEWPORT(vp)) ? "t" : "f", - vik_viewport_get_draw_centermark(VIK_VIEWPORT(vp)) ? "t" : "f" ); + vik_viewport_get_draw_centermark(VIK_VIEWPORT(vp)) ? "t" : "f", + vik_viewport_get_draw_highlight(VIK_VIEWPORT(vp)) ? "t" : "f" ); if ( ! VIK_LAYER(top)->visible ) fprintf ( f, "visible=f\n" ); @@ -201,7 +202,7 @@ static void file_write ( VikAggregateLayer *top, FILE *f, gpointer vp ) while (stack && stack->data) { current_layer = VIK_LAYER(((GList *)stack->data)->data); - fprintf ( f, "\n~Layer %s\n", vik_layer_get_interface(current_layer->type)->name ); + fprintf ( f, "\n~Layer %s\n", vik_layer_get_interface(current_layer->type)->fixed_layer_name ); write_layer_params_and_data ( current_layer, f ); if ( current_layer->type == VIK_LAYER_AGGREGATE && !vik_aggregate_layer_is_empty(VIK_AGGREGATE_LAYER(current_layer)) ) { @@ -256,10 +257,18 @@ static void string_list_set_param (gint i, GList *list, gpointer *layer_and_vp) { VikLayerParamData x; x.sl = list; - vik_layer_set_param ( VIK_LAYER(layer_and_vp[0]), i, x, layer_and_vp[1] ); + vik_layer_set_param ( VIK_LAYER(layer_and_vp[0]), i, x, layer_and_vp[1], TRUE ); } -static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) +/** + * Read in a Viking file and return how successful the parsing was + * ATM this will always work, in that even if there are parsing problems + * then there will be no new values to override the defaults + * + * TODO flow up line number(s) / error messages of problems encountered... + * + */ +static gboolean file_read ( VikAggregateLayer *top, FILE *f, const gchar *dirpath, VikViewport *vp ) { Stack *stack; struct LatLon ll = { 0.0, 0.0 }; @@ -273,6 +282,8 @@ static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) GHashTable *string_lists = g_hash_table_new(g_direct_hash,g_direct_equal); + gboolean successful_read = TRUE; + push(&stack); stack->under = NULL; stack->data = (gpointer) top; @@ -309,6 +320,7 @@ static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) int parent_type = VIK_LAYER(stack->data)->type; if ( ( ! stack->data ) || ((parent_type != VIK_LAYER_AGGREGATE) && (parent_type != VIK_LAYER_GPS)) ) { + successful_read = FALSE; g_warning ( "Line %ld: Layer command inside non-Aggregate Layer (type %d)", line_num, parent_type ); push(&stack); /* inside INVALID layer */ stack->data = NULL; @@ -316,10 +328,11 @@ static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) } else { - gint16 type = layer_type_from_string ( line+6 ); + VikLayerTypeEnum type = vik_layer_type_from_string ( line+6 ); push(&stack); - if ( type == -1 ) + if ( type == VIK_LAYER_NUM_TYPES ) { + successful_read = FALSE; g_warning ( "Line %ld: Unknown type %s", line_num, line+6 ); stack->data = NULL; } @@ -331,7 +344,7 @@ static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) } else { - stack->data = (gpointer) vik_layer_create ( type, vp, NULL, FALSE ); + stack->data = (gpointer) vik_layer_create ( type, vp, FALSE ); params = vik_layer_get_interface(type)->params; params_count = vik_layer_get_interface(type)->params_count; } @@ -339,8 +352,10 @@ static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) } else if ( str_starts_with ( line, "EndLayer", 8, FALSE ) ) { - if ( stack->under == NULL ) + if ( stack->under == NULL ) { + successful_read = FALSE; g_warning ( "Line %ld: Mismatched ~EndLayer command", line_num ); + } else { /* add any string lists we've accumulated */ @@ -353,14 +368,16 @@ static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) if ( stack->data && stack->under->data ) { if (VIK_LAYER(stack->under->data)->type == VIK_LAYER_AGGREGATE) { - vik_aggregate_layer_add_layer ( VIK_AGGREGATE_LAYER(stack->under->data), VIK_LAYER(stack->data) ); + vik_aggregate_layer_add_layer ( VIK_AGGREGATE_LAYER(stack->under->data), VIK_LAYER(stack->data), FALSE ); vik_layer_post_read ( VIK_LAYER(stack->data), vp, TRUE ); } else if (VIK_LAYER(stack->under->data)->type == VIK_LAYER_GPS) { /* TODO: anything else needs to be done here ? */ } - else + else { + successful_read = FALSE; g_warning ( "Line %ld: EndLayer command inside non-Aggregate Layer (type %d)", line_num, VIK_LAYER(stack->data)->type ); + } } pop(&stack); } @@ -368,9 +385,11 @@ static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) else if ( str_starts_with ( line, "LayerData", 9, FALSE ) ) { if ( stack->data && vik_layer_get_interface(VIK_LAYER(stack->data)->type)->read_file_data ) - vik_layer_get_interface(VIK_LAYER(stack->data)->type)->read_file_data ( VIK_LAYER(stack->data), f ); + { /* must read until hits ~EndLayerData */ - + if ( ! vik_layer_get_interface(VIK_LAYER(stack->data)->type)->read_file_data ( VIK_LAYER(stack->data), f, dirpath ) ) + successful_read = FALSE; + } else { /* simply skip layer data over */ while ( fgets ( buffer, 4096, f ) ) @@ -392,6 +411,7 @@ static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) } else { + successful_read = FALSE; g_warning ( "Line %ld: Unknown tilde command", line_num ); } } @@ -406,30 +426,49 @@ static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) if ( line[i] == '=' ) eq_pos = i; - if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "xmpp", eq_pos ) == 0) /* "hard coded" params: global & for all layer-types */ - vik_viewport_set_xmpp ( VIK_VIEWPORT(vp), strtod ( line+5, NULL ) ); + if ( stack->under == NULL && eq_pos == 12 && strncasecmp ( line, "FILE_VERSION", eq_pos ) == 0) { + gint version = strtol(line+13, NULL, 10); + g_debug ( "%s: reading file version %d", __FUNCTION__, version ); + if ( version > VIKING_FILE_VERSION ) + successful_read = FALSE; + // However we'll still carry and attempt to read whatever we can + } + else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "xmpp", eq_pos ) == 0) /* "hard coded" params: global & for all layer-types */ + vik_viewport_set_xmpp ( VIK_VIEWPORT(vp), strtod_i8n ( line+5, NULL ) ); else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "ympp", eq_pos ) == 0) - vik_viewport_set_ympp ( VIK_VIEWPORT(vp), strtod ( line+5, NULL ) ); + vik_viewport_set_ympp ( VIK_VIEWPORT(vp), strtod_i8n ( line+5, NULL ) ); else if ( stack->under == NULL && eq_pos == 3 && strncasecmp ( line, "lat", eq_pos ) == 0 ) - ll.lat = strtod ( line+4, NULL ); + ll.lat = strtod_i8n ( line+4, NULL ); else if ( stack->under == NULL && eq_pos == 3 && strncasecmp ( line, "lon", eq_pos ) == 0 ) - ll.lon = strtod ( line+4, NULL ); + ll.lon = strtod_i8n ( line+4, NULL ); else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "utm" ) == 0) vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_UTM); else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "expedia" ) == 0) vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_EXPEDIA ); else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "google" ) == 0) - vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_GOOGLE ); + { + successful_read = FALSE; + g_warning ( _("Draw mode '%s' no more supported"), "google" ); + } else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "kh" ) == 0) - vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_KH ); + { + successful_read = FALSE; + g_warning ( _("Draw mode '%s' no more supported"), "kh" ); + } else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "mercator" ) == 0) vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_MERCATOR ); + else if ( stack->under == NULL && eq_pos == 4 && strncasecmp ( line, "mode", eq_pos ) == 0 && strcasecmp ( line+5, "latlon" ) == 0) + vik_viewport_set_drawmode ( VIK_VIEWPORT(vp), VIK_VIEWPORT_DRAWMODE_LATLON ); else if ( stack->under == NULL && eq_pos == 5 && strncasecmp ( line, "color", eq_pos ) == 0 ) vik_viewport_set_background_color ( VIK_VIEWPORT(vp), line+6 ); + else if ( stack->under == NULL && eq_pos == 14 && strncasecmp ( line, "highlightcolor", eq_pos ) == 0 ) + vik_viewport_set_highlight_color ( VIK_VIEWPORT(vp), line+15 ); else if ( stack->under == NULL && eq_pos == 9 && strncasecmp ( line, "drawscale", eq_pos ) == 0 ) vik_viewport_set_draw_scale ( VIK_VIEWPORT(vp), TEST_BOOLEAN(line+10) ); else if ( stack->under == NULL && eq_pos == 14 && strncasecmp ( line, "drawcentermark", eq_pos ) == 0 ) vik_viewport_set_draw_centermark ( VIK_VIEWPORT(vp), TEST_BOOLEAN(line+15) ); + else if ( stack->under == NULL && eq_pos == 13 && strncasecmp ( line, "drawhighlight", eq_pos ) == 0 ) + vik_viewport_set_draw_highlight ( VIK_VIEWPORT(vp), TEST_BOOLEAN(line+14) ); else if ( stack->under && eq_pos == 4 && strncasecmp ( line, "name", eq_pos ) == 0 ) vik_layer_rename ( VIK_LAYER(stack->data), line+5 ); else if ( eq_pos == 7 && strncasecmp ( line, "visible", eq_pos ) == 0 ) @@ -443,6 +482,7 @@ static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) if ( ! params ) { + successful_read = FALSE; g_warning ( "Line %ld: No options for this kind of layer", line_num ); continue; } @@ -453,14 +493,15 @@ static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) VikLayerParamData x; line += eq_pos+1; if ( params[i].type == VIK_LAYER_PARAM_STRING_LIST ) { - GList *l = g_list_append ( g_hash_table_lookup ( string_lists, (gpointer) ((gint) i) ), g_strdup(line) ); - g_hash_table_replace ( string_lists, (gpointer) ((gint)i), l ); + GList *l = g_list_append ( g_hash_table_lookup ( string_lists, GINT_TO_POINTER ((gint) i) ), + g_strdup(line) ); + g_hash_table_replace ( string_lists, GINT_TO_POINTER ((gint)i), l ); /* add the value to a list, possibly making a new list. * this will be passed to the layer when we read an ~EndLayer */ } else { switch ( params[i].type ) { - case VIK_LAYER_PARAM_DOUBLE: x.d = strtod(line, NULL); break; + case VIK_LAYER_PARAM_DOUBLE: x.d = strtod_i8n(line, NULL); break; case VIK_LAYER_PARAM_UINT: x.u = strtoul(line, NULL, 10); break; case VIK_LAYER_PARAM_INT: x.i = strtol(line, NULL, 10); break; case VIK_LAYER_PARAM_BOOLEAN: x.b = TEST_BOOLEAN(line); break; @@ -469,16 +510,24 @@ static void file_read ( VikAggregateLayer *top, FILE *f, VikViewport *vp ) /* STRING or STRING_LIST -- if STRING_LIST, just set param to add a STRING */ default: x.s = line; } - vik_layer_set_param ( VIK_LAYER(stack->data), i, x, vp ); + vik_layer_set_param ( VIK_LAYER(stack->data), i, x, vp, TRUE ); } found_match = TRUE; break; } - if ( ! found_match ) + if ( ! found_match ) { + // ATM don't flow up this issue because at least one internal parameter has changed from version 1.3 + // and don't what to worry users about raising such issues + // TODO Maybe hold old values here - compare the line value against them and if a match + // generate a different style of message in the GUI... + // successful_read = FALSE; g_warning ( "Line %ld: Unknown parameter. Line:\n%s", line_num, line ); + } } - else + else { + successful_read = FALSE; g_warning ( "Line %ld: Invalid parameter or parameter outside of layer.", line_num ); + } } /* could be: [Layer Type=Bla] @@ -493,14 +542,14 @@ name=this { if ( stack->under && stack->under->data && stack->data ) { - vik_aggregate_layer_add_layer ( VIK_AGGREGATE_LAYER(stack->under->data), VIK_LAYER(stack->data) ); + vik_aggregate_layer_add_layer ( VIK_AGGREGATE_LAYER(stack->under->data), VIK_LAYER(stack->data), FALSE ); vik_layer_post_read ( VIK_LAYER(stack->data), vp, TRUE ); } pop(&stack); } if ( ll.lat != 0.0 || ll.lon != 0.0 ) - vik_viewport_set_center_latlon ( VIK_VIEWPORT(vp), &ll ); + vik_viewport_set_center_latlon ( VIK_VIEWPORT(vp), &ll, TRUE ); if ( ( ! VIK_LAYER(top)->visible ) && VIK_LAYER(top)->realized ) vik_treeview_item_set_visible ( VIK_LAYER(top)->vt, &(VIK_LAYER(top)->iter), FALSE ); @@ -508,6 +557,8 @@ name=this /* delete anything we've forgotten about -- should only happen when file ends before an EndLayer */ g_hash_table_foreach ( string_lists, string_list_delete, NULL ); g_hash_table_destroy ( string_lists ); + + return successful_read; } /* @@ -526,7 +577,7 @@ if "[LayerData]" /* ---------------------------------------------------- */ -static FILE *xfopen ( const char *fn, const char *mode ) +static FILE *xfopen ( const char *fn ) { if ( strcmp(fn,"-") == 0 ) return stdin; @@ -542,54 +593,173 @@ static void xfclose ( FILE *f ) } } -/* 0 on failure, 1 on success (vik file) 2 on success (other file) */ -gshort a_file_load ( VikAggregateLayer *top, VikViewport *vp, const gchar *filename ) +/* + * Function to determine if a filename is a 'viking' type file + */ +gboolean check_file_magic_vik ( const gchar *filename ) +{ + gboolean result = FALSE; + FILE *ff = xfopen ( filename ); + if ( ff ) { + result = check_magic ( ff, VIK_MAGIC ); + xfclose ( ff ); + } + return result; +} + +/** + * append_file_ext: + * + * Append a file extension, if not already present. + * + * Returns: a newly allocated string + */ +gchar *append_file_ext ( const gchar *filename, VikFileType_t type ) { - FILE *f = xfopen ( filename, "r" ); + gchar *new_name = NULL; + const gchar *ext = NULL; + + /* Select an extension */ + switch (type) + { + case FILE_TYPE_GPX: + ext = ".gpx"; + break; + case FILE_TYPE_KML: + ext = ".kml"; + break; + case FILE_TYPE_GEOJSON: + ext = ".geojson"; + break; + case FILE_TYPE_GPSMAPPER: + case FILE_TYPE_GPSPOINT: + default: + /* Do nothing, ext already set to NULL */ + break; + } + + /* Do */ + if ( ext != NULL && ! a_file_check_ext ( filename, ext ) ) + new_name = g_strconcat ( filename, ext, NULL ); + else + /* Simply duplicate */ + new_name = g_strdup ( filename ); + + return new_name; +} - g_assert ( vp ); +VikLoadType_t a_file_load ( VikAggregateLayer *top, VikViewport *vp, const gchar *filename_or_uri ) +{ + g_return_val_if_fail ( vp != NULL, LOAD_TYPE_READ_FAILURE ); + + char *filename = (char *)filename_or_uri; + if (strncmp(filename, "file://", 7) == 0) { + // Consider replacing this with: + // filename = g_filename_from_uri ( entry, NULL, NULL ); + // Since this doesn't support URIs properly (i.e. will failure if is it has %20 characters in it) + filename = filename + 7; + g_debug ( "Loading file %s from URI %s", filename, filename_or_uri ); + } + FILE *f = xfopen ( filename ); if ( ! f ) - return 0; + return LOAD_TYPE_READ_FAILURE; + + VikLoadType_t load_answer = LOAD_TYPE_OTHER_SUCCESS; + gchar *dirpath = g_path_get_dirname ( filename ); + // Attempt loading the primary file type first - our internal .vik file: if ( check_magic ( f, VIK_MAGIC ) ) { - file_read ( top, f, vp ); - if ( f != stdin ) - xfclose(f); - return 1; + if ( file_read ( top, f, dirpath, vp ) ) + load_answer = LOAD_TYPE_VIK_SUCCESS; + else + load_answer = LOAD_TYPE_VIK_FAILURE_NON_FATAL; + } + else if ( a_jpg_magic_check ( filename ) ) { + if ( ! a_jpg_load_file ( top, filename, vp ) ) + load_answer = LOAD_TYPE_UNSUPPORTED_FAILURE; } else { - VikCoord new_center; - VikLayer *vtl = vik_layer_create ( VIK_LAYER_TRW, vp, NULL, FALSE ); - vik_layer_rename ( vtl, a_file_basename ( filename ) ); - - if ( check_magic ( f, GPX_MAGIC ) ) - a_gpx_read_file ( VIK_TRW_LAYER(vtl), f ); - else - a_gpspoint_read_file ( VIK_TRW_LAYER(vtl), f ); + // For all other file types which consist of tracks, routes and/or waypoints, + // must be loaded into a new TrackWaypoint layer (hence it be created) + gboolean success = TRUE; // Detect load failures - mainly to remove the layer created as it's not required - vik_layer_post_read ( vtl, vp, TRUE ); + VikLayer *vtl = vik_layer_create ( VIK_LAYER_TRW, vp, FALSE ); + vik_layer_rename ( vtl, a_file_basename ( filename ) ); - vik_aggregate_layer_add_layer ( top, vtl ); + // In fact both kml & gpx files start the same as they are in xml + if ( a_file_check_ext ( filename, ".kml" ) && check_magic ( f, GPX_MAGIC ) ) { + // Implicit Conversion + if ( ! ( success = a_babel_convert_from ( VIK_TRW_LAYER(vtl), "-i kml", filename, NULL, NULL, NULL ) ) ) { + load_answer = LOAD_TYPE_GPSBABEL_FAILURE; + } + } + // NB use a extension check first, as a GPX file header may have a Byte Order Mark (BOM) in it + // - which currently confuses our check_magic function + else if ( a_file_check_ext ( filename, ".gpx" ) || check_magic ( f, GPX_MAGIC ) ) { + if ( ! ( success = a_gpx_read_file ( VIK_TRW_LAYER(vtl), f ) ) ) { + load_answer = LOAD_TYPE_GPX_FAILURE; + } + } + else { + // Try final supported file type + if ( ! ( success = a_gpspoint_read_file ( VIK_TRW_LAYER(vtl), f, dirpath ) ) ) { + // Failure here means we don't know how to handle the file + load_answer = LOAD_TYPE_UNSUPPORTED_FAILURE; + } + } + g_free ( dirpath ); - if ( vik_trw_layer_find_center ( VIK_TRW_LAYER(vtl), &new_center ) ) - vik_viewport_set_center_coord ( VIK_VIEWPORT(vp), &new_center ); - xfclose(f); - return 2; + // Clean up when we can't handle the file + if ( ! success ) { + // free up layer + g_object_unref ( vtl ); + } + else { + // Complete the setup from the successful load + vik_layer_post_read ( vtl, vp, TRUE ); + vik_aggregate_layer_add_layer ( top, vtl, FALSE ); + vik_trw_layer_auto_set_view ( VIK_TRW_LAYER(vtl), vp ); + } } + xfclose(f); + return load_answer; } gboolean a_file_save ( VikAggregateLayer *top, gpointer vp, const gchar *filename ) { - FILE *f = g_fopen(filename, "w"); + FILE *f; + + if (strncmp(filename, "file://", 7) == 0) + filename = filename + 7; + + f = g_fopen(filename, "w"); if ( ! f ) return FALSE; + // Enable relative paths in .vik files to work + gchar *cwd = g_get_current_dir(); + gchar *dir = g_path_get_dirname ( filename ); + if ( dir ) { + if ( g_chdir ( dir ) ) { + g_warning ( "Could not change directory to %s", dir ); + } + g_free (dir); + } + file_write ( top, f, vp ); + // Restore previous working directory + if ( cwd ) { + if ( g_chdir ( cwd ) ) { + g_warning ( "Could not return to directory %s", cwd ); + } + g_free (cwd); + } + fclose(f); f = NULL; @@ -597,61 +767,247 @@ gboolean a_file_save ( VikAggregateLayer *top, gpointer vp, const gchar *filenam } -const gchar *a_file_basename ( const gchar *filename ) +/* example: + gboolean is_gpx = a_file_check_ext ( "a/b/c.gpx", ".gpx" ); +*/ +gboolean a_file_check_ext ( const gchar *filename, const gchar *fileext ) { - const gchar *t = filename + strlen(filename) - 1; - while ( --t > filename ) - if ( *(t-1) == FILE_SEP ) - break; - if ( t >= filename ) - return t; - return filename; + g_return_val_if_fail ( filename != NULL, FALSE ); + g_return_val_if_fail ( fileext && fileext[0]=='.', FALSE ); + const gchar *basename = a_file_basename(filename); + if (!basename) + return FALSE; + + const char * dot = strrchr(basename, '.'); + if (dot && !strcmp(dot, fileext)) + return TRUE; + + return FALSE; } -gboolean a_file_export ( VikTrwLayer *vtl, const gchar *filename, gshort file_type ) +/** + * a_file_export: + * @vtl: The TrackWaypoint to export data from + * @filename: The name of the file to be written + * @file_type: Choose one of the supported file types for the export + * @trk: If specified then only export this track rather than the whole layer + * @write_hidden: Whether to write invisible items + * + * A general export command to convert from Viking TRW layer data to an external supported format. + * The write_hidden option is provided mainly to be able to transfer selected items when uploading to a GPS + */ +gboolean a_file_export ( VikTrwLayer *vtl, const gchar *filename, VikFileType_t file_type, VikTrack *trk, gboolean write_hidden ) { + GpxWritingOptions options = { FALSE, FALSE, write_hidden, FALSE }; FILE *f = g_fopen ( filename, "w" ); if ( f ) { - if ( file_type == FILE_TYPE_GPSMAPPER ) - a_gpsmapper_write_file ( vtl, f ); - else if ( file_type == FILE_TYPE_GPX ) - a_gpx_write_file ( vtl, f ); - else - a_gpspoint_write_file ( vtl, f ); + gboolean result = TRUE; + + if ( trk ) { + switch ( file_type ) { + case FILE_TYPE_GPX: + // trk defined so can set the option + options.is_route = trk->is_route; + a_gpx_write_track_file ( trk, f, &options ); + break; + default: + g_critical("Houston, we've had a problem. file_type=%d", file_type); + } + } else { + switch ( file_type ) { + case FILE_TYPE_GPSMAPPER: + a_gpsmapper_write_file ( vtl, f ); + break; + case FILE_TYPE_GPX: + a_gpx_write_file ( vtl, f, &options ); + break; + case FILE_TYPE_GPSPOINT: + a_gpspoint_write_file ( vtl, f ); + break; + case FILE_TYPE_GEOJSON: + result = a_geojson_write_file ( vtl, f ); + break; + case FILE_TYPE_KML: + fclose ( f ); + f = NULL; + switch ( a_vik_get_kml_export_units () ) { + case VIK_KML_EXPORT_UNITS_STATUTE: + return a_babel_convert_to ( vtl, NULL, "-o kml", filename, NULL, NULL ); + break; + case VIK_KML_EXPORT_UNITS_NAUTICAL: + return a_babel_convert_to ( vtl, NULL, "-o kml,units=n", filename, NULL, NULL ); + break; + default: + // VIK_KML_EXPORT_UNITS_METRIC: + return a_babel_convert_to ( vtl, NULL, "-o kml,units=m", filename, NULL, NULL ); + break; + } + break; + default: + g_critical("Houston, we've had a problem. file_type=%d", file_type); + } + } fclose ( f ); f = NULL; - return TRUE; + return result; } return FALSE; } -const gchar *a_get_viking_dir() +/** + * a_file_export_babel: + */ +gboolean a_file_export_babel ( VikTrwLayer *vtl, const gchar *filename, const gchar *format, + gboolean tracks, gboolean routes, gboolean waypoints ) { - static gchar *viking_dir = NULL; + gchar *args = g_strdup_printf("%s %s %s -o %s", + tracks ? "-t" : "", + routes ? "-r" : "", + waypoints ? "-w" : "", + format); + gboolean result = a_babel_convert_to ( vtl, NULL, args, filename, NULL, NULL ); + g_free(args); + return result; +} - // TODO: use g_get_user_config_dir ? +/** + * Just a wrapper around realpath, which itself is platform dependent + */ +char *file_realpath ( const char *path, char *real ) +{ + return realpath ( path, real ); +} - if (!viking_dir) { - const gchar *home = g_getenv("HOME"); - if (!home || g_access(home, W_OK)) - home = g_get_home_dir (); -#ifdef HAVE_MKDTEMP - if (!home || g_access(home, W_OK)) - { - static gchar temp[] = {"/tmp/vikXXXXXX"}; - home = mkdtemp(temp); - } +#ifndef MAXPATHLEN +#define MAXPATHLEN 1024 #endif - if (!home || g_access(home, W_OK)) - /* Fatal error */ - g_critical("Unable to find a base directory"); - - /* Build the name of the directory */ - viking_dir = g_build_filename(home, ".viking", NULL); - if (g_file_test(viking_dir, G_FILE_TEST_EXISTS) == FALSE) - g_mkdir(viking_dir, 0755); +/** + * Always return the canonical filename in a newly allocated string + */ +char *file_realpath_dup ( const char *path ) +{ + char real[MAXPATHLEN]; + + g_return_val_if_fail(path != NULL, NULL); + + if (file_realpath(path, real)) + return g_strdup(real); + + return g_strdup(path); +} + +/** + * Permission granted to use this code after personal correspondance + * Slightly reworked for better cross platform use, glibisms, function rename and a compacter format + * + * FROM http://www.codeguru.com/cpp/misc/misc/fileanddirectorynaming/article.php/c263 + */ + +// GetRelativeFilename(), by Rob Fisher. +// rfisher@iee.org +// http://come.to/robfisher + +// The number of characters at the start of an absolute filename. e.g. in DOS, +// absolute filenames start with "X:\" so this value should be 3, in UNIX they start +// with "\" so this value should be 1. +#ifdef WINDOWS +#define ABSOLUTE_NAME_START 3 +#else +#define ABSOLUTE_NAME_START 1 +#endif + +// Given the absolute current directory and an absolute file name, returns a relative file name. +// For example, if the current directory is C:\foo\bar and the filename C:\foo\whee\text.txt is given, +// GetRelativeFilename will return ..\whee\text.txt. + +const gchar *file_GetRelativeFilename ( gchar *currentDirectory, gchar *absoluteFilename ) +{ + gint afMarker = 0, rfMarker = 0; + gint cdLen = 0, afLen = 0; + gint i = 0; + gint levels = 0; + static gchar relativeFilename[MAXPATHLEN+1]; + + cdLen = strlen(currentDirectory); + afLen = strlen(absoluteFilename); + + // make sure the names are not too long or too short + if (cdLen > MAXPATHLEN || cdLen < ABSOLUTE_NAME_START+1 || + afLen > MAXPATHLEN || afLen < ABSOLUTE_NAME_START+1) { + return NULL; + } + + // Handle DOS names that are on different drives: + if (currentDirectory[0] != absoluteFilename[0]) { + // not on the same drive, so only absolute filename will do + strcpy(relativeFilename, absoluteFilename); + return relativeFilename; + } + + // they are on the same drive, find out how much of the current directory + // is in the absolute filename + i = ABSOLUTE_NAME_START; + while (i < afLen && i < cdLen && currentDirectory[i] == absoluteFilename[i]) { + i++; } - return viking_dir; + if (i == cdLen && (absoluteFilename[i] == G_DIR_SEPARATOR || absoluteFilename[i-1] == G_DIR_SEPARATOR)) { + // the whole current directory name is in the file name, + // so we just trim off the current directory name to get the + // current file name. + if (absoluteFilename[i] == G_DIR_SEPARATOR) { + // a directory name might have a trailing slash but a relative + // file name should not have a leading one... + i++; + } + + strcpy(relativeFilename, &absoluteFilename[i]); + return relativeFilename; + } + + // The file is not in a child directory of the current directory, so we + // need to step back the appropriate number of parent directories by + // using "..\"s. First find out how many levels deeper we are than the + // common directory + afMarker = i; + levels = 1; + + // count the number of directory levels we have to go up to get to the + // common directory + while (i < cdLen) { + i++; + if (currentDirectory[i] == G_DIR_SEPARATOR) { + // make sure it's not a trailing slash + i++; + if (currentDirectory[i] != '\0') { + levels++; + } + } + } + + // move the absolute filename marker back to the start of the directory name + // that it has stopped in. + while (afMarker > 0 && absoluteFilename[afMarker-1] != G_DIR_SEPARATOR) { + afMarker--; + } + + // check that the result will not be too long + if (levels * 3 + afLen - afMarker > MAXPATHLEN) { + return NULL; + } + + // add the appropriate number of "..\"s. + rfMarker = 0; + for (i = 0; i < levels; i++) { + relativeFilename[rfMarker++] = '.'; + relativeFilename[rfMarker++] = '.'; + relativeFilename[rfMarker++] = G_DIR_SEPARATOR; + } + + // copy the rest of the filename into the result string + strcpy(&relativeFilename[rfMarker], &absoluteFilename[afMarker]); + + return relativeFilename; } +/* END http://www.codeguru.com/cpp/misc/misc/fileanddirectorynaming/article.php/c263 */