X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/883e5ed69ff56cd354fb44371744876b388e0fe3..45b0031e267e0c8ee003498a0bc5b76de59ea854:/src/babel.c diff --git a/src/babel.c b/src/babel.c index e84666df..518dbb34 100644 --- a/src/babel.c +++ b/src/babel.c @@ -3,6 +3,7 @@ * * Copyright (C) 2003-2005, Evan Battaglia * Copyright (C) 2006, Quy Tonthat + * Copyright (C) 2013, Guilhem Bonnefille * * 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 @@ -37,24 +38,49 @@ #include "gpx.h" #include "babel.h" #include -#ifdef HAVE_SYS_WAIT_H -#include -#endif #ifdef HAVE_UNISTD_H #include #endif +#include #include #include /* TODO in the future we could have support for other shells (change command strings), or not use a shell at all */ #define BASH_LOCATION "/bin/bash" +/** + * List of supported protocols. + */ +const gchar *PROTOS[] = { "http://", "https://", "ftp://", NULL }; + +/** + * Path to gpsbabel + */ +static gchar *gpsbabel_loc = NULL; + +/** + * Path to unbuffer + */ +static gchar *unbuffer_loc = NULL; + +/** + * List of file formats supported by gpsbabel. + */ +GList *a_babel_file_list; + +/** + * List of device supported by gpsbabel. + */ +GList *a_babel_device_list; + /** * a_babel_convert: * @vt: The TRW layer to modify. All data will be deleted, and replaced by what gpsbabel outputs. * @babelargs: A string containing gpsbabel command line filter options. No file types or names should * be specified. * @cb: A callback function. + * @user_data: passed along to cb + * @not_used: Must use NULL * * This function modifies data in a trw layer using gpsbabel filters. This routine is synchronous; * that is, it will block the calling program until the conversion is done. To avoid blocking, call @@ -62,90 +88,50 @@ * * Returns: %TRUE on success */ -gboolean a_babel_convert( VikTrwLayer *vt, const char *babelargs, BabelStatusFunc cb, gpointer user_data ) +gboolean a_babel_convert( VikTrwLayer *vt, const char *babelargs, BabelStatusFunc cb, gpointer user_data, gpointer not_used ) { int fd_src; FILE *f; - gchar *name_src; + gchar *name_src = NULL; gboolean ret = FALSE; gchar *bargs = g_strconcat(babelargs, " -i gpx", NULL); if ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0) { + g_debug ("%s: temporary file: %s", __FUNCTION__, name_src); f = fdopen(fd_src, "w"); - a_gpx_write_file(vt, f); + a_gpx_write_file(vt, f, NULL); fclose(f); f = NULL; - ret = a_babel_convert_from ( vt, bargs, cb, name_src, user_data ); + ret = a_babel_convert_from ( vt, bargs, name_src, cb, user_data, not_used ); + g_remove(name_src); + g_free(name_src); } g_free(bargs); - g_remove(name_src); - g_free(name_src); return ret; } -#ifdef WINDOWS -static gboolean babel_general_convert( BabelStatusFunc cb, gchar **args, gpointer user_data ) +/** + * Perform any cleanup actions once GPSBabel has completed running + */ +static void babel_watch ( GPid pid, + gint status, + gpointer user_data ) { - gboolean ret; - FILE *f; - gchar *cmd; - gchar **args2; - - STARTUPINFO si; - PROCESS_INFORMATION pi; - - ZeroMemory( &si, sizeof(si) ); - ZeroMemory( &pi, sizeof(pi) ); - si.cb = sizeof(si); - si.dwFlags = STARTF_USESHOWWINDOW; - si.wShowWindow = SW_HIDE; - - cmd = g_strjoinv( " ", args); - args2 = g_strsplit(cmd, "\\", 0); - g_free(cmd); - cmd = g_strjoinv( "\\\\", args2); - g_free(args2); - args2 = g_strsplit(cmd, "/", 0); - g_free(cmd); - cmd = g_strjoinv( "\\\\", args2); - - if( !CreateProcess( - NULL, // No module name (use command line). - (LPTSTR)cmd, // Command line. - NULL, // Process handle not inheritable. - NULL, // Thread handle not inheritable. - FALSE, // Set handle inheritance to FALSE. - 0, // No creation flags. - NULL, // Use parent's environment block. - NULL, // Use parent's starting directory. - &si, // Pointer to STARTUPINFO structure. - &pi ) // Pointer to PROCESS_INFORMATION structure. - ){ - g_warning( "CreateProcess failed"); - ret = FALSE; - } - else { - WaitForSingleObject(pi.hProcess, INFINITE); - WaitForSingleObject(pi.hThread, INFINITE); - - CloseHandle(pi.hThread); - CloseHandle(pi.hProcess); - - if ( cb ) - cb(BABEL_DONE, NULL, user_data); - - ret = TRUE; - } - - g_strfreev( args2 ); - g_free( cmd ); - - return ret; + g_spawn_close_pid ( pid ); } -/* Windows */ -#else -/* Posix */ + +/** + * babel_general_convert: + * @args: The command line arguments passed to GPSBabel + * @cb: callback that is run for each line of GPSBabel output and at completion of the run + * callback may be NULL + * @user_data: passed along to cb + * + * The function to actually invoke the GPSBabel external command + * + * Returns: %TRUE on successful invocation of GPSBabel command + */ static gboolean babel_general_convert( BabelStatusFunc cb, gchar **args, gpointer user_data ) { gboolean ret = FALSE; @@ -153,8 +139,8 @@ static gboolean babel_general_convert( BabelStatusFunc cb, gchar **args, gpointe GError *error = NULL; gint babel_stdout; - if (!g_spawn_async_with_pipes (NULL, args, NULL, 0, NULL, NULL, &pid, NULL, &babel_stdout, NULL, &error)) { - g_warning("Error : %s", error->message); + if (!g_spawn_async_with_pipes (NULL, args, NULL, G_SPAWN_DO_NOT_REAP_CHILD, NULL, NULL, &pid, NULL, &babel_stdout, NULL, &error)) { + g_warning ("Async command failed: %s", error->message); g_error_free(error); ret = FALSE; } else { @@ -172,18 +158,21 @@ static gboolean babel_general_convert( BabelStatusFunc cb, gchar **args, gpointe cb(BABEL_DONE, NULL, user_data); fclose(diag); diag = NULL; - waitpid(pid, NULL, 0); - g_spawn_close_pid(pid); + + g_child_watch_add ( pid, (GChildWatchFunc) babel_watch, NULL ); ret = TRUE; } return ret; } -#endif /* Posix */ /** * babel_general_convert_from: + * @vtl: The TrackWaypoint Layer to save the data into + * If it is null it signifies that no data is to be processed, + * however the gpsbabel command is still ran as it can be for non-data related options eg: + * for use with the power off command - 'command_off' * @cb: callback that is run upon new data from STDOUT (?) * (TODO: STDERR would be nice since we usually redirect STDOUT) * @user_data: passed along to cb @@ -200,18 +189,18 @@ static gboolean babel_general_convert_from( VikTrwLayer *vt, BabelStatusFunc cb, gboolean ret = FALSE; FILE *f = NULL; - /* No data required */ - if ( vt == NULL ) - return TRUE; - if (babel_general_convert(cb, args, user_data)) { + /* No data actually required but still need to have run gpsbabel anyway + - eg using the device power command_off */ + if ( vt == NULL ) + return TRUE; + f = g_fopen(name_dst, "r"); if (f) { - a_gpx_read_file ( vt, f ); + ret = a_gpx_read_file ( vt, f ); fclose(f); f = NULL; - ret = TRUE; } } @@ -224,6 +213,8 @@ static gboolean babel_general_convert_from( VikTrwLayer *vt, BabelStatusFunc cb, * @babelargs: A string containing gpsbabel command line options. In addition to any filters, this string * must include the input file type (-i) option. * @cb: Optional callback function. Same usage as in a_babel_convert(). + * @user_data: passed along to cb + * @not_used: Must use NULL * * Loads data into a trw layer from a file, using gpsbabel. This routine is synchronous; * that is, it will block the calling program until the conversion is done. To avoid blocking, call @@ -231,22 +222,19 @@ static gboolean babel_general_convert_from( VikTrwLayer *vt, BabelStatusFunc cb, * * Returns: %TRUE on success */ -gboolean a_babel_convert_from( VikTrwLayer *vt, const char *babelargs, BabelStatusFunc cb, const char *from, gpointer user_data ) +gboolean a_babel_convert_from( VikTrwLayer *vt, const char *babelargs, const char *from, BabelStatusFunc cb, gpointer user_data, gpointer not_used ) { int i,j; int fd_dst; - gchar *name_dst; + gchar *name_dst = NULL; gboolean ret = FALSE; gchar *args[64]; if ((fd_dst = g_file_open_tmp("tmp-viking.XXXXXX", &name_dst, NULL)) >= 0) { - gchar *gpsbabel_loc; + g_debug ("%s: temporary file: %s", __FUNCTION__, name_dst); close(fd_dst); - gpsbabel_loc = g_find_program_in_path("gpsbabel"); - if (gpsbabel_loc ) { - gchar *unbuffer_loc = g_find_program_in_path("unbuffer"); gchar **sub_args = g_strsplit(babelargs, " ", 0); i = 0; @@ -268,20 +256,23 @@ gboolean a_babel_convert_from( VikTrwLayer *vt, const char *babelargs, BabelStat ret = babel_general_convert_from ( vt, cb, args, name_dst, user_data ); - g_free ( unbuffer_loc ); g_strfreev(sub_args); } else - g_warning("gpsbabel not found in PATH"); - g_free(gpsbabel_loc); + g_critical("gpsbabel not found in PATH"); + g_remove(name_dst); + g_free(name_dst); } - g_remove(name_dst); - g_free(name_dst); return ret; } /** * a_babel_convert_from_shellcommand: + * @vt: The #VikTrwLayer where to insert the collected data + * @input_cmd: the command to run + * @cb: Optional callback function. Same usage as in a_babel_convert(). + * @user_data: passed along to cb + * @not_used: Must use NULL * * Runs the input command in a shell (bash) and optionally uses GPSBabel to convert from input_file_type. * If input_file_type is %NULL, doesn't use GPSBabel. Input must be GPX (or Geocaching *.loc) @@ -289,17 +280,19 @@ gboolean a_babel_convert_from( VikTrwLayer *vt, const char *babelargs, BabelStat * Uses babel_general_convert_from() to actually run the command. This function * prepares the command and temporary file, and sets up the arguments for bash. */ -gboolean a_babel_convert_from_shellcommand ( VikTrwLayer *vt, const char *input_cmd, const char *input_file_type, BabelStatusFunc cb, gpointer user_data ) +gboolean a_babel_convert_from_shellcommand ( VikTrwLayer *vt, const char *input_cmd, const char *input_file_type, BabelStatusFunc cb, gpointer user_data, gpointer not_used ) { int fd_dst; - gchar *name_dst; + gchar *name_dst = NULL; gboolean ret = FALSE; gchar **args; if ((fd_dst = g_file_open_tmp("tmp-viking.XXXXXX", &name_dst, NULL)) >= 0) { + g_debug ("%s: temporary file: %s", __FUNCTION__, name_dst); gchar *shell_command; if ( input_file_type ) - shell_command = g_strdup_printf("%s | gpsbabel -i %s -f - -o gpx -F %s", input_cmd, input_file_type, name_dst); + shell_command = g_strdup_printf("%s | %s -i %s -f - -o gpx -F %s", + input_cmd, gpsbabel_loc, input_file_type, name_dst); else shell_command = g_strdup_printf("%s > %s", input_cmd, name_dst); @@ -315,34 +308,62 @@ gboolean a_babel_convert_from_shellcommand ( VikTrwLayer *vt, const char *input_ ret = babel_general_convert_from ( vt, cb, args, name_dst, user_data ); g_free ( args ); g_free ( shell_command ); + g_remove(name_dst); + g_free(name_dst); } - g_remove(name_dst); - g_free(name_dst); return ret; } -gboolean a_babel_convert_from_url ( VikTrwLayer *vt, const char *url, const char *input_type, BabelStatusFunc cb, gpointer user_data ) +/** + * a_babel_convert_from_url: + * @vt: The #VikTrwLayer where to insert the collected data + * @url: the URL to fetch + * @cb: Optional callback function. Same usage as in a_babel_convert(). + * @user_data: passed along to cb + * @options: download options. Maybe NULL. + * + * Download the file pointed by the URL and optionally uses GPSBabel to convert from input_file_type. + * If input_file_type is %NULL, doesn't use GPSBabel. Input must be GPX. + * + * Returns: %TRUE on successful invocation of GPSBabel or read of the GPX + * + */ +gboolean a_babel_convert_from_url ( VikTrwLayer *vt, const char *url, const char *input_type, BabelStatusFunc cb, gpointer user_data, DownloadMapOptions *options ) { - static DownloadMapOptions options = { FALSE, FALSE, NULL, 0, a_check_kml_file}; + // If no download options specified, use defaults: + DownloadMapOptions myoptions = { FALSE, FALSE, NULL, 2, NULL, NULL, NULL }; + if ( options ) + myoptions = *options; gint fd_src; int fetch_ret; gboolean ret = FALSE; - gchar *name_src; - gchar *babelargs; + gchar *name_src = NULL; + gchar *babelargs = NULL; g_debug("%s: input_type=%s url=%s", __FUNCTION__, input_type, url); if ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0) { + g_debug ("%s: temporary file: %s", __FUNCTION__, name_src); close(fd_src); g_remove(name_src); - babelargs = g_strdup_printf(" -i %s", input_type); - - fetch_ret = a_http_download_get_url(url, "", name_src, &options, NULL); - if (fetch_ret == 0) - ret = a_babel_convert_from( vt, babelargs, NULL, name_src, NULL); - + fetch_ret = a_http_download_get_url(url, "", name_src, &myoptions, NULL); + if (fetch_ret == 0) { + if (input_type != NULL) { + babelargs = g_strdup_printf(" -i %s", input_type); + ret = a_babel_convert_from( vt, babelargs, name_src, NULL, NULL, NULL ); + } else { + /* Process directly the retrieved file */ + g_debug("%s: directly read GPX file %s", __FUNCTION__, name_src); + FILE *f = g_fopen(name_src, "r"); + if (f) { + ret = a_gpx_read_file ( vt, f ); + fclose(f); + f = NULL; + } + } + } g_remove(name_src); g_free(babelargs); g_free(name_src); @@ -351,32 +372,83 @@ gboolean a_babel_convert_from_url ( VikTrwLayer *vt, const char *url, const char return ret; } -static gboolean babel_general_convert_to( VikTrwLayer *vt, BabelStatusFunc cb, gchar **args, const gchar *name_src, gpointer user_data ) +/** + * a_babel_convert_from_url_or_shell: + * @vt: The #VikTrwLayer where to insert the collected data + * @url: the URL to fetch + * @cb: Optional callback function. Same usage as in a_babel_convert(). + * @user_data: passed along to cb + * @options: download options. Maybe NULL. + * + * Download the file pointed by the URL and optionally uses GPSBabel to convert from input_file_type. + * If input_file_type is %NULL, doesn't use GPSBabel. Input must be GPX. + * + * Returns: %TRUE on successful invocation of GPSBabel or read of the GPX + * + */ +gboolean a_babel_convert_from_url_or_shell ( VikTrwLayer *vt, const char *input, const char *input_type, BabelStatusFunc cb, gpointer user_data, DownloadMapOptions *options ) +{ + + /* Check nature of input */ + gboolean isUrl = FALSE; + int i = 0; + for (i = 0 ; PROTOS[i] != NULL ; i++) + { + const gchar *proto = PROTOS[i]; + if (strncmp (input, proto, strlen(proto)) == 0) + { + /* Procotol matches: save result */ + isUrl = TRUE; + } + } + + /* Do the job */ + if (isUrl) + return a_babel_convert_from_url (vt, input, input_type, cb, user_data, options); + else + return a_babel_convert_from_shellcommand (vt, input, input_type, cb, user_data, options); +} + +static gboolean babel_general_convert_to( VikTrwLayer *vt, VikTrack *trk, BabelStatusFunc cb, gchar **args, const gchar *name_src, gpointer user_data ) { - if (!a_file_export(vt, name_src, FILE_TYPE_GPX, NULL)) { - g_warning("%s(): error exporting to %s", __FUNCTION__, name_src); - return(FALSE); + // Now strips out invisible tracks and waypoints + if (!a_file_export(vt, name_src, FILE_TYPE_GPX, trk, FALSE)) { + g_critical("Error exporting to %s", name_src); + return FALSE; } return babel_general_convert (cb, args, user_data); } -gboolean a_babel_convert_to( VikTrwLayer *vt, const char *babelargs, BabelStatusFunc cb, const char *to, gpointer user_data ) +/** + * a_babel_convert_to: + * @vt: The TRW layer from which data is taken. + * @track: Operate on the individual track if specified. Use NULL when operating on a TRW layer + * @babelargs: A string containing gpsbabel command line options. In addition to any filters, this string + * must include the input file type (-i) option. + * @to: Filename or device the data is written to. + * @cb: Optional callback function. Same usage as in a_babel_convert. + * @user_data: passed along to cb + * + * Exports data using gpsbabel. This routine is synchronous; + * that is, it will block the calling program until the conversion is done. To avoid blocking, call + * this routine from a worker thread. + * + * Returns: %TRUE on successful invocation of GPSBabel command + */ +gboolean a_babel_convert_to( VikTrwLayer *vt, VikTrack *track, const char *babelargs, const char *to, BabelStatusFunc cb, gpointer user_data ) { int i,j; int fd_src; - gchar *name_src; + gchar *name_src = NULL; gboolean ret = FALSE; gchar *args[64]; if ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0) { - gchar *gpsbabel_loc; + g_debug ("%s: temporary file: %s", __FUNCTION__, name_src); close(fd_src); - gpsbabel_loc = g_find_program_in_path("gpsbabel"); - if (gpsbabel_loc ) { - gchar *unbuffer_loc = g_find_program_in_path("unbuffer"); gchar **sub_args = g_strsplit(babelargs, " ", 0); i = 0; @@ -395,16 +467,157 @@ gboolean a_babel_convert_to( VikTrwLayer *vt, const char *babelargs, BabelStatus args[i++] = (char *)to; args[i] = NULL; - ret = babel_general_convert_to ( vt, cb, args, name_src, user_data ); + ret = babel_general_convert_to ( vt, track, cb, args, name_src, user_data ); - g_free ( unbuffer_loc ); g_strfreev(sub_args); } else - g_warning("gpsbabel not found in PATH"); - g_free(gpsbabel_loc); + g_critical("gpsbabel not found in PATH"); + g_remove(name_src); + g_free(name_src); + } + + return ret; +} + +static void set_mode(BabelMode mode, gchar *smode) +{ + mode.waypointsRead = smode[0] == 'r'; + mode.waypointsWrite = smode[1] == 'w'; + mode.tracksRead = smode[2] == 'r'; + mode.tracksWrite = smode[3] == 'w'; + mode.routesRead = smode[4] == 'r'; + mode.routesWrite = smode[5] == 'w'; +} + +/** + * load_feature_parse_line: + * + * Load a single feature stored in the given line. + */ +static void load_feature_parse_line (gchar *line) +{ + gchar **tokens = g_strsplit ( line, "\t", 0 ); + if ( tokens != NULL + && tokens[0] != NULL ) { + if ( strcmp("serial", tokens[0]) == 0 ) { + if ( tokens[1] != NULL + && tokens[2] != NULL + && tokens[3] != NULL + && tokens[4] != NULL ) { + BabelDevice *device = g_malloc ( sizeof (BabelDevice) ); + set_mode (device->mode, tokens[1]); + device->name = g_strdup (tokens[2]); + device->label = g_strndup (tokens[4], 50); // Limit really long label text + a_babel_device_list = g_list_append (a_babel_device_list, device); + g_debug ("New gpsbabel device: %s", device->name); + } else { + g_warning ( "Unexpected gpsbabel format string: %s", line); + } + } else if ( strcmp("file", tokens[0]) == 0 ) { + if ( tokens[1] != NULL + && tokens[2] != NULL + && tokens[3] != NULL + && tokens[4] != NULL ) { + BabelFile *file = g_malloc ( sizeof (BabelFile) ); + set_mode (file->mode, tokens[1]); + file->name = g_strdup (tokens[2]); + file->ext = g_strdup (tokens[3]); + file->label = g_strdup (tokens[4]); + a_babel_file_list = g_list_append (a_babel_file_list, file); + g_debug ("New gpsbabel file: %s", file->name); + } else { + g_warning ( "Unexpected gpsbabel format string: %s", line); + } + } /* else: ignore */ + } else { + g_warning ( "Unexpected gpsbabel format string: %s", line); } + g_strfreev ( tokens ); +} + +static void load_feature_cb (BabelProgressCode code, gpointer line, gpointer user_data) +{ + if (line != NULL) + load_feature_parse_line (line); +} + +static gboolean load_feature () +{ + int i; + gboolean ret = FALSE; + gchar *args[4]; + + if ( gpsbabel_loc ) { + i = 0; + if ( unbuffer_loc ) + args[i++] = unbuffer_loc; + args[i++] = gpsbabel_loc; + args[i++] = "-^3"; + args[i] = NULL; + + ret = babel_general_convert (load_feature_cb, args, NULL); + } else + g_critical("gpsbabel not found in PATH"); - g_remove(name_src); - g_free(name_src); return ret; } + +/** + * a_babel_init: + * + * Initialises babel module. + * Mainly check existence of gpsbabel progam + * and load all features available in ths version. + */ +void a_babel_init () +{ + /* TODO allow to set gpsbabel path via command line */ + gpsbabel_loc = g_find_program_in_path( "gpsbabel" ); + if ( !gpsbabel_loc ) + g_critical( "gpsbabel not found in PATH" ); + + // Unlikely to package unbuffer on Windows so ATM don't even bother trying + // Highly unlikely unbuffer is available on a Windows system otherwise +#ifndef WINDOWS + unbuffer_loc = g_find_program_in_path( "unbuffer" ); + if ( !unbuffer_loc ) + g_warning( "unbuffer not found in PATH" ); +#endif + + load_feature (); +} + +/** + * a_babel_uninit: + * + * Free resources acquired by a_babel_init. + */ +void a_babel_uninit () +{ + g_free ( gpsbabel_loc ); + g_free ( unbuffer_loc ); + + if ( a_babel_file_list ) { + GList *gl; + for (gl = a_babel_file_list; gl != NULL; gl = g_list_next(gl)) { + BabelFile *file = gl->data; + g_free ( file->name ); + g_free ( file->ext ); + g_free ( file->label ); + g_free ( gl->data ); + } + g_list_free ( a_babel_file_list ); + } + + if ( a_babel_device_list ) { + GList *gl; + for (gl = a_babel_device_list; gl != NULL; gl = g_list_next(gl)) { + BabelDevice *device = gl->data; + g_free ( device->name ); + g_free ( device->label ); + g_free ( gl->data ); + } + g_list_free ( a_babel_device_list ); + } + +}