2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
5 * Copyright (C) 2006, Quy Tonthat <qtonthat@gmail.com>
6 * Copyright (C) 2013, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
7 * Copyright (C) 2015, Rob Norris <rw_norris@hotmail.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 * @short_description: running external programs and redirecting to TRWLayers.
29 * GPSBabel may not be necessary for everything,
30 * one can use shell_command option but this will be OS platform specific
40 #include "preferences.h"
47 #include <glib/gstdio.h>
48 #include <glib/gi18n.h>
50 /* TODO in the future we could have support for other shells (change command strings), or not use a shell at all */
51 #define BASH_LOCATION "/bin/bash"
56 static gchar *gpsbabel_loc = NULL;
61 static gchar *unbuffer_loc = NULL;
64 * List of file formats supported by gpsbabel.
66 GList *a_babel_file_list;
69 * List of device supported by gpsbabel.
71 GList *a_babel_device_list;
74 * Run a function on all file formats supporting a given mode.
76 void a_babel_foreach_file_with_mode (BabelMode mode, GFunc func, gpointer user_data)
79 for ( current = g_list_first (a_babel_file_list) ;
81 current = g_list_next (current) )
83 BabelFile *currentFile = current->data;
84 /* Check compatibility of modes */
85 gboolean compat = TRUE;
86 if (mode.waypointsRead && ! currentFile->mode.waypointsRead) compat = FALSE;
87 if (mode.waypointsWrite && ! currentFile->mode.waypointsWrite) compat = FALSE;
88 if (mode.tracksRead && ! currentFile->mode.tracksRead) compat = FALSE;
89 if (mode.tracksWrite && ! currentFile->mode.tracksWrite) compat = FALSE;
90 if (mode.routesRead && ! currentFile->mode.routesRead) compat = FALSE;
91 if (mode.routesWrite && ! currentFile->mode.routesWrite) compat = FALSE;
94 func (currentFile, user_data);
99 * a_babel_foreach_file_read_any:
100 * @func: The function to be called on any file format with a read method
101 * @user_data: Data passed into the function
103 * Run a function on all file formats with any kind of read method
104 * (which is almost all but not quite - e.g. with GPSBabel v1.4.4 - PalmDoc is write only waypoints)
106 void a_babel_foreach_file_read_any (GFunc func, gpointer user_data)
109 for ( current = g_list_first (a_babel_file_list) ;
111 current = g_list_next (current) )
113 BabelFile *currentFile = current->data;
114 // Call function when any read mode found
115 if ( currentFile->mode.waypointsRead ||
116 currentFile->mode.tracksRead ||
117 currentFile->mode.routesRead)
118 func (currentFile, user_data);
124 * @vt: The TRW layer to modify. All data will be deleted, and replaced by what gpsbabel outputs.
125 * @babelargs: A string containing gpsbabel command line filter options. No file types or names should
127 * @cb: A callback function.
128 * @user_data: passed along to cb
129 * @not_used: Must use NULL
131 * This function modifies data in a trw layer using gpsbabel filters. This routine is synchronous;
132 * that is, it will block the calling program until the conversion is done. To avoid blocking, call
133 * this routine from a worker thread.
135 * Returns: %TRUE on success
137 gboolean a_babel_convert( VikTrwLayer *vt, const char *babelargs, BabelStatusFunc cb, gpointer user_data, gpointer not_used )
139 gboolean ret = FALSE;
140 gchar *bargs = g_strconcat(babelargs, " -i gpx", NULL);
141 gchar *name_src = a_gpx_write_tmp_file ( vt, NULL );
144 ProcessOptions po = { bargs, name_src, NULL, NULL, NULL };
145 ret = a_babel_convert_from ( vt, &po, cb, user_data, not_used );
155 * Perform any cleanup actions once GPSBabel has completed running
157 static void babel_watch ( GPid pid,
161 g_spawn_close_pid ( pid );
165 * babel_general_convert:
166 * @args: The command line arguments passed to GPSBabel
167 * @cb: callback that is run for each line of GPSBabel output and at completion of the run
168 * callback may be NULL
169 * @user_data: passed along to cb
171 * The function to actually invoke the GPSBabel external command
173 * Returns: %TRUE on successful invocation of GPSBabel command
175 static gboolean babel_general_convert( BabelStatusFunc cb, gchar **args, gpointer user_data )
177 gboolean ret = FALSE;
179 GError *error = NULL;
183 for ( guint i=0; args[i]; i++ )
184 g_debug ("%s: %s", __FUNCTION__, args[i] );
187 if (!g_spawn_async_with_pipes (NULL, args, NULL, G_SPAWN_DO_NOT_REAP_CHILD, NULL, NULL, &pid, NULL, &babel_stdout, NULL, &error)) {
188 g_warning ("Async command failed: %s", error->message);
195 diag = fdopen(babel_stdout, "r");
196 setvbuf(diag, NULL, _IONBF, 0);
198 while (fgets(line, sizeof(line), diag)) {
200 cb(BABEL_DIAG_OUTPUT, line, user_data);
203 cb(BABEL_DONE, NULL, user_data);
207 g_child_watch_add ( pid, (GChildWatchFunc) babel_watch, NULL );
216 * babel_general_convert_from:
217 * @vtl: The TrackWaypoint Layer to save the data into
218 * If it is null it signifies that no data is to be processed,
219 * however the gpsbabel command is still ran as it can be for non-data related options eg:
220 * for use with the power off command - 'command_off'
221 * @cb: callback that is run upon new data from STDOUT (?)
222 * (TODO: STDERR would be nice since we usually redirect STDOUT)
223 * @user_data: passed along to cb
225 * Runs args[0] with the arguments and uses the GPX module
226 * to import the GPX data into layer vt. Assumes that upon
227 * running the command, the data will appear in the (usually
228 * temporary) file name_dst.
230 * Returns: %TRUE on success
232 static gboolean babel_general_convert_from( VikTrwLayer *vt, BabelStatusFunc cb, gchar **args, const gchar *name_dst, gpointer user_data )
234 gboolean ret = FALSE;
237 if (babel_general_convert(cb, args, user_data)) {
239 /* No data actually required but still need to have run gpsbabel anyway
240 - eg using the device power command_off */
244 f = g_fopen(name_dst, "r");
246 ret = a_gpx_read_file ( vt, f );
256 * a_babel_convert_from_filter:
257 * @vt: The TRW layer to place data into. Duplicate items will be overwritten.
258 * @babelargs: A string containing gpsbabel command line options. This string
259 * must include the input file type (-i) option.
260 * @from the file name to convert from
261 * @babelfilters: A string containing gpsbabel filter command line options
262 * @cb: Optional callback function. Same usage as in a_babel_convert().
263 * @user_data: passed along to cb
264 * @not_used: Must use NULL
266 * Loads data into a trw layer from a file, using gpsbabel. This routine is synchronous;
267 * that is, it will block the calling program until the conversion is done. To avoid blocking, call
268 * this routine from a worker thread.
270 * Returns: %TRUE on success
272 gboolean a_babel_convert_from_filter( VikTrwLayer *vt, const char *babelargs, const char *from, const char *babelfilters, BabelStatusFunc cb, gpointer user_data, gpointer not_used )
276 gchar *name_dst = NULL;
277 gboolean ret = FALSE;
280 if ((fd_dst = g_file_open_tmp("tmp-viking.XXXXXX", &name_dst, NULL)) >= 0) {
281 g_debug ("%s: temporary file: %s", __FUNCTION__, name_dst);
285 gchar **sub_args = g_strsplit(babelargs, " ", 0);
286 gchar **sub_filters = NULL;
290 args[i++] = unbuffer_loc;
291 args[i++] = gpsbabel_loc;
292 for (j = 0; sub_args[j]; j++) {
293 /* some version of gpsbabel can not take extra blank arg */
294 if (sub_args[j][0] != '\0')
295 args[i++] = sub_args[j];
298 args[i++] = (char *)from;
300 sub_filters = g_strsplit(babelfilters, " ", 0);
301 for (j = 0; sub_filters[j]; j++) {
302 /* some version of gpsbabel can not take extra blank arg */
303 if (sub_filters[j][0] != '\0')
304 args[i++] = sub_filters[j];
310 args[i++] = name_dst;
313 ret = babel_general_convert_from ( vt, cb, args, name_dst, user_data );
315 g_strfreev(sub_args);
317 g_strfreev(sub_filters);
319 g_critical("gpsbabel not found in PATH");
320 (void)g_remove(name_dst);
328 * a_babel_convert_from_shellcommand:
329 * @vt: The #VikTrwLayer where to insert the collected data
330 * @input_cmd: the command to run
332 * @cb: Optional callback function. Same usage as in a_babel_convert().
333 * @user_data: passed along to cb
334 * @not_used: Must use NULL
336 * Runs the input command in a shell (bash) and optionally uses GPSBabel to convert from input_file_type.
337 * If input_file_type is %NULL, doesn't use GPSBabel. Input must be GPX (or Geocaching *.loc)
339 * Uses babel_general_convert_from() to actually run the command. This function
340 * prepares the command and temporary file, and sets up the arguments for bash.
342 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 )
345 gchar *name_dst = NULL;
346 gboolean ret = FALSE;
349 if ((fd_dst = g_file_open_tmp("tmp-viking.XXXXXX", &name_dst, NULL)) >= 0) {
350 g_debug ("%s: temporary file: %s", __FUNCTION__, name_dst);
351 gchar *shell_command;
352 if ( input_file_type )
353 shell_command = g_strdup_printf("%s | %s -i %s -f - -o gpx -F %s",
354 input_cmd, gpsbabel_loc, input_file_type, name_dst);
356 shell_command = g_strdup_printf("%s > %s", input_cmd, name_dst);
358 g_debug("%s: %s", __FUNCTION__, shell_command);
361 args = g_malloc(sizeof(gchar *)*4);
362 args[0] = BASH_LOCATION;
364 args[2] = shell_command;
367 ret = babel_general_convert_from ( vt, cb, args, name_dst, user_data );
369 g_free ( shell_command );
370 (void)g_remove(name_dst);
378 * a_babel_convert_from_url_filter:
379 * @vt: The #VikTrwLayer where to insert the collected data
380 * @url: the URL to fetch
381 * @input_type: If input_type is %NULL, input must be GPX.
382 * @babelfilters: The filter arguments to pass to gpsbabel
383 * @cb: Optional callback function. Same usage as in a_babel_convert().
384 * @user_data: Passed along to cb
385 * @options: Download options. If %NULL then default download options will be used.
387 * Download the file pointed by the URL and optionally uses GPSBabel to convert from input_type.
388 * If input_type and babelfilters are %NULL, gpsbabel is not used.
390 * Returns: %TRUE on successful invocation of GPSBabel or read of the GPX
393 gboolean a_babel_convert_from_url_filter ( VikTrwLayer *vt, const char *url, const char *input_type, const char *babelfilters, BabelStatusFunc cb, gpointer user_data, DownloadMapOptions *options )
395 // If no download options specified, use defaults:
396 DownloadMapOptions myoptions = { FALSE, FALSE, NULL, 2, NULL, NULL, NULL };
398 myoptions = *options;
401 gboolean ret = FALSE;
402 gchar *name_src = NULL;
403 gchar *babelargs = NULL;
405 g_debug("%s: input_type=%s url=%s", __FUNCTION__, input_type, url);
407 if ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0) {
408 g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
410 (void)g_remove(name_src);
412 fetch_ret = a_http_download_get_url(url, "", name_src, &myoptions, NULL);
413 if (fetch_ret == DOWNLOAD_SUCCESS) {
414 if (input_type != NULL || babelfilters != NULL) {
415 babelargs = (input_type) ? g_strdup_printf(" -i %s", input_type) : g_strdup("");
416 ret = a_babel_convert_from_filter( vt, babelargs, name_src, babelfilters, NULL, NULL, NULL );
418 /* Process directly the retrieved file */
419 g_debug("%s: directly read GPX file %s", __FUNCTION__, name_src);
420 FILE *f = g_fopen(name_src, "r");
422 ret = a_gpx_read_file ( vt, f );
428 (void)util_remove(name_src);
437 * a_babel_convert_from:
438 * @vt: The TRW layer to place data into. Duplicate items will be overwritten.
439 * @process_options: The options to control the appropriate processing function. See #ProcessOptions for more detail
440 * @cb: Optional callback function. Same usage as in a_babel_convert().
441 * @user_data: passed along to cb
442 * @download_options: If downloading from a URL use these options (may be NULL)
444 * Loads data into a trw layer from a file, using gpsbabel. This routine is synchronous;
445 * that is, it will block the calling program until the conversion is done. To avoid blocking, call
446 * this routine from a worker thread.
448 * Returns: %TRUE on success
450 gboolean a_babel_convert_from ( VikTrwLayer *vt, ProcessOptions *process_options, BabelStatusFunc cb, gpointer user_data, gpointer download_options )
452 if ( !process_options ) return FALSE;
453 if ( process_options->url )
454 return a_babel_convert_from_url_filter ( vt, process_options->url, process_options->input_file_type, process_options->babel_filters, cb, user_data, download_options );
455 if ( process_options->babelargs )
456 return a_babel_convert_from_filter ( vt, process_options->babelargs, process_options->filename, process_options->babel_filters, cb, user_data, download_options );
457 if ( process_options->shell_command )
458 return a_babel_convert_from_shellcommand ( vt, process_options->shell_command, process_options->filename, cb, user_data, download_options );
462 static gboolean babel_general_convert_to( VikTrwLayer *vt, VikTrack *trk, BabelStatusFunc cb, gchar **args, const gchar *name_src, gpointer user_data )
464 // Now strips out invisible tracks and waypoints
465 if (!a_file_export(vt, name_src, FILE_TYPE_GPX, trk, FALSE)) {
466 g_critical("Error exporting to %s", name_src);
470 return babel_general_convert (cb, args, user_data);
474 * a_babel_convert_to:
475 * @vt: The TRW layer from which data is taken.
476 * @track: Operate on the individual track if specified. Use NULL when operating on a TRW layer
477 * @babelargs: A string containing gpsbabel command line options. In addition to any filters, this string
478 * must include the input file type (-i) option.
479 * @to: Filename or device the data is written to.
480 * @cb: Optional callback function. Same usage as in a_babel_convert.
481 * @user_data: passed along to cb
483 * Exports data using gpsbabel. This routine is synchronous;
484 * that is, it will block the calling program until the conversion is done. To avoid blocking, call
485 * this routine from a worker thread.
487 * Returns: %TRUE on successful invocation of GPSBabel command
489 gboolean a_babel_convert_to( VikTrwLayer *vt, VikTrack *track, const char *babelargs, const char *to, BabelStatusFunc cb, gpointer user_data )
493 gchar *name_src = NULL;
494 gboolean ret = FALSE;
497 if ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0) {
498 g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
502 gchar **sub_args = g_strsplit(babelargs, " ", 0);
506 args[i++] = unbuffer_loc;
507 args[i++] = gpsbabel_loc;
510 for (j = 0; sub_args[j]; j++)
511 /* some version of gpsbabel can not take extra blank arg */
512 if (sub_args[j][0] != '\0')
513 args[i++] = sub_args[j];
515 args[i++] = name_src;
517 args[i++] = (char *)to;
520 ret = babel_general_convert_to ( vt, track, cb, args, name_src, user_data );
522 g_strfreev(sub_args);
524 g_critical("gpsbabel not found in PATH");
525 (void)g_remove(name_src);
532 static void set_mode(BabelMode *mode, gchar *smode)
534 mode->waypointsRead = smode[0] == 'r';
535 mode->waypointsWrite = smode[1] == 'w';
536 mode->tracksRead = smode[2] == 'r';
537 mode->tracksWrite = smode[3] == 'w';
538 mode->routesRead = smode[4] == 'r';
539 mode->routesWrite = smode[5] == 'w';
543 * load_feature_parse_line:
545 * Load a single feature stored in the given line.
547 static void load_feature_parse_line (gchar *line)
549 gchar **tokens = g_strsplit ( line, "\t", 0 );
551 && tokens[0] != NULL ) {
552 if ( strcmp("serial", tokens[0]) == 0 ) {
553 if ( tokens[1] != NULL
556 && tokens[4] != NULL ) {
557 BabelDevice *device = g_malloc ( sizeof (BabelDevice) );
558 set_mode (&(device->mode), tokens[1]);
559 device->name = g_strdup (tokens[2]);
560 device->label = g_strndup (tokens[4], 50); // Limit really long label text
561 a_babel_device_list = g_list_append (a_babel_device_list, device);
562 g_debug ("New gpsbabel device: %s, %d%d%d%d%d%d(%s)",
564 device->mode.waypointsRead, device->mode.waypointsWrite,
565 device->mode.tracksRead, device->mode.tracksWrite,
566 device->mode.routesRead, device->mode.routesWrite,
569 g_warning ( "Unexpected gpsbabel format string: %s", line);
571 } else if ( strcmp("file", tokens[0]) == 0 ) {
572 if ( tokens[1] != NULL
575 && tokens[4] != NULL ) {
576 BabelFile *file = g_malloc ( sizeof (BabelFile) );
577 set_mode (&(file->mode), tokens[1]);
578 file->name = g_strdup (tokens[2]);
579 file->ext = g_strdup (tokens[3]);
580 file->label = g_strdup (tokens[4]);
581 a_babel_file_list = g_list_append (a_babel_file_list, file);
582 g_debug ("New gpsbabel file: %s, %d%d%d%d%d%d(%s)",
584 file->mode.waypointsRead, file->mode.waypointsWrite,
585 file->mode.tracksRead, file->mode.tracksWrite,
586 file->mode.routesRead, file->mode.routesWrite,
589 g_warning ( "Unexpected gpsbabel format string: %s", line);
593 g_warning ( "Unexpected gpsbabel format string: %s", line);
595 g_strfreev ( tokens );
598 static void load_feature_cb (BabelProgressCode code, gpointer line, gpointer user_data)
601 load_feature_parse_line (line);
604 static gboolean load_feature ()
607 gboolean ret = FALSE;
610 if ( gpsbabel_loc ) {
613 args[i++] = unbuffer_loc;
614 args[i++] = gpsbabel_loc;
618 ret = babel_general_convert (load_feature_cb, args, NULL);
620 g_critical("gpsbabel not found in PATH");
625 static VikLayerParam prefs[] = {
626 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_IO_NAMESPACE "gpsbabel", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("GPSBabel:"), VIK_LAYER_WIDGET_FILEENTRY, NULL, NULL,
627 N_("Allow setting the specific instance of GPSBabel. You must restart Viking for this value to take effect."), NULL, NULL, NULL },
633 * Just setup preferences first
638 VikLayerParamData vlpd;
640 // Basic guesses - could use %ProgramFiles% but this is simpler:
641 if ( g_file_test ( "C:\\Program Files (x86)\\GPSBabel\\gpsbabel.exe", G_FILE_TEST_EXISTS ) )
642 // 32 bit location on a 64 bit system
643 vlpd.s = "C:\\Program Files (x86)\\GPSBabel\\gpsbabel.exe";
645 vlpd.s = "C:\\Program Files\\GPSBabel\\gpsbabel.exe";
649 a_preferences_register(&prefs[0], vlpd, VIKING_PREFERENCES_IO_GROUP_KEY);
655 * Initialises babel module.
656 * Mainly check existence of gpsbabel progam
657 * and load all features available in that version.
659 void a_babel_post_init ()
661 // Read the current preference
662 const gchar *gpsbabel = a_preferences_get(VIKING_PREFERENCES_IO_NAMESPACE "gpsbabel")->s;
663 // If setting is still the UNIX default then lookup in the path - otherwise attempt to use the specified value directly.
664 if ( g_strcmp0 ( gpsbabel, "gpsbabel" ) == 0 ) {
665 gpsbabel_loc = g_find_program_in_path( "gpsbabel" );
667 g_critical( "gpsbabel not found in PATH" );
670 gpsbabel_loc = (gchar*)gpsbabel;
672 // Unlikely to package unbuffer on Windows so ATM don't even bother trying
673 // Highly unlikely unbuffer is available on a Windows system otherwise
675 unbuffer_loc = g_find_program_in_path( "unbuffer" );
677 g_warning( "unbuffer not found in PATH" );
686 * Free resources acquired by a_babel_init.
688 void a_babel_uninit ()
690 g_free ( gpsbabel_loc );
691 g_free ( unbuffer_loc );
693 if ( a_babel_file_list ) {
695 for (gl = a_babel_file_list; gl != NULL; gl = g_list_next(gl)) {
696 BabelFile *file = gl->data;
697 g_free ( file->name );
698 g_free ( file->ext );
699 g_free ( file->label );
702 g_list_free ( a_babel_file_list );
705 if ( a_babel_device_list ) {
707 for (gl = a_babel_device_list; gl != NULL; gl = g_list_next(gl)) {
708 BabelDevice *device = gl->data;
709 g_free ( device->name );
710 g_free ( device->label );
713 g_list_free ( a_babel_device_list );
721 * Indicates if babel is available or not.
723 * Returns: true if babel available
725 gboolean a_babel_available ()
727 return a_babel_device_list != NULL;