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>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 * @short_description: running external programs and redirecting to TRWLayers.
27 * GPSBabel may not be necessary for everything -- for instance,
28 * use a_babel_convert_from_shellcommand() with input_file_type == %NULL
29 * for an external program that outputs GPX.
45 #include <glib/gstdio.h>
47 /* TODO in the future we could have support for other shells (change command strings), or not use a shell at all */
48 #define BASH_LOCATION "/bin/bash"
53 static gchar *gpsbabel_loc = NULL;
58 static gchar *unbuffer_loc = NULL;
61 * List of file formats supported by gpsbabel.
63 GList *a_babel_file_list;
66 * List of device supported by gpsbabel.
68 GList *a_babel_device_list;
72 * @vt: The TRW layer to modify. All data will be deleted, and replaced by what gpsbabel outputs.
73 * @babelargs: A string containing gpsbabel command line filter options. No file types or names should
75 * @cb: A callback function.
76 * @user_data: passed along to cb
77 * @not_used: Must use NULL
79 * This function modifies data in a trw layer using gpsbabel filters. This routine is synchronous;
80 * that is, it will block the calling program until the conversion is done. To avoid blocking, call
81 * this routine from a worker thread.
83 * Returns: %TRUE on success
85 gboolean a_babel_convert( VikTrwLayer *vt, const char *babelargs, BabelStatusFunc cb, gpointer user_data, gpointer not_used )
89 gchar *name_src = NULL;
91 gchar *bargs = g_strconcat(babelargs, " -i gpx", NULL);
93 if ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0) {
94 g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
95 f = fdopen(fd_src, "w");
96 a_gpx_write_file(vt, f, NULL);
99 ret = a_babel_convert_from ( vt, bargs, name_src, cb, user_data, not_used );
109 * Perform any cleanup actions once GPSBabel has completed running
111 static void babel_watch ( GPid pid,
115 g_spawn_close_pid ( pid );
119 * babel_general_convert:
120 * @args: The command line arguments passed to GPSBabel
121 * @cb: callback that is run for each line of GPSBabel output and at completion of the run
122 * callback may be NULL
123 * @user_data: passed along to cb
125 * The function to actually invoke the GPSBabel external command
127 * Returns: %TRUE on successful invocation of GPSBabel command
129 static gboolean babel_general_convert( BabelStatusFunc cb, gchar **args, gpointer user_data )
131 gboolean ret = FALSE;
133 GError *error = NULL;
136 if (!g_spawn_async_with_pipes (NULL, args, NULL, G_SPAWN_DO_NOT_REAP_CHILD, NULL, NULL, &pid, NULL, &babel_stdout, NULL, &error)) {
137 g_warning ("Async command failed: %s", error->message);
144 diag = fdopen(babel_stdout, "r");
145 setvbuf(diag, NULL, _IONBF, 0);
147 while (fgets(line, sizeof(line), diag)) {
149 cb(BABEL_DIAG_OUTPUT, line, user_data);
152 cb(BABEL_DONE, NULL, user_data);
156 g_child_watch_add ( pid, (GChildWatchFunc) babel_watch, NULL );
165 * babel_general_convert_from:
166 * @vtl: The TrackWaypoint Layer to save the data into
167 * If it is null it signifies that no data is to be processed,
168 * however the gpsbabel command is still ran as it can be for non-data related options eg:
169 * for use with the power off command - 'command_off'
170 * @cb: callback that is run upon new data from STDOUT (?)
171 * (TODO: STDERR would be nice since we usually redirect STDOUT)
172 * @user_data: passed along to cb
174 * Runs args[0] with the arguments and uses the GPX module
175 * to import the GPX data into layer vt. Assumes that upon
176 * running the command, the data will appear in the (usually
177 * temporary) file name_dst.
179 * Returns: %TRUE on success
181 static gboolean babel_general_convert_from( VikTrwLayer *vt, BabelStatusFunc cb, gchar **args, const gchar *name_dst, gpointer user_data )
183 gboolean ret = FALSE;
186 if (babel_general_convert(cb, args, user_data)) {
188 /* No data actually required but still need to have run gpsbabel anyway
189 - eg using the device power command_off */
193 f = g_fopen(name_dst, "r");
195 ret = a_gpx_read_file ( vt, f );
205 * a_babel_convert_from:
206 * @vt: The TRW layer to place data into. Duplicate items will be overwritten.
207 * @babelargs: A string containing gpsbabel command line options. In addition to any filters, this string
208 * must include the input file type (-i) option.
209 * @cb: Optional callback function. Same usage as in a_babel_convert().
210 * @user_data: passed along to cb
211 * @not_used: Must use NULL
213 * Loads data into a trw layer from a file, using gpsbabel. This routine is synchronous;
214 * that is, it will block the calling program until the conversion is done. To avoid blocking, call
215 * this routine from a worker thread.
217 * Returns: %TRUE on success
219 gboolean a_babel_convert_from( VikTrwLayer *vt, const char *babelargs, const char *from, BabelStatusFunc cb, gpointer user_data, gpointer not_used )
223 gchar *name_dst = NULL;
224 gboolean ret = FALSE;
227 if ((fd_dst = g_file_open_tmp("tmp-viking.XXXXXX", &name_dst, NULL)) >= 0) {
228 g_debug ("%s: temporary file: %s", __FUNCTION__, name_dst);
232 gchar **sub_args = g_strsplit(babelargs, " ", 0);
236 args[i++] = unbuffer_loc;
237 args[i++] = gpsbabel_loc;
238 for (j = 0; sub_args[j]; j++) {
239 /* some version of gpsbabel can not take extra blank arg */
240 if (sub_args[j][0] != '\0')
241 args[i++] = sub_args[j];
246 args[i++] = (char *)from;
248 args[i++] = name_dst;
251 ret = babel_general_convert_from ( vt, cb, args, name_dst, user_data );
253 g_strfreev(sub_args);
255 g_critical("gpsbabel not found in PATH");
264 * a_babel_convert_from_shellcommand:
265 * @vt: The #VikTrwLayer where to insert the collected data
266 * @input_cmd: the command to run
267 * @cb: Optional callback function. Same usage as in a_babel_convert().
268 * @user_data: passed along to cb
269 * @not_used: Must use NULL
271 * Runs the input command in a shell (bash) and optionally uses GPSBabel to convert from input_file_type.
272 * If input_file_type is %NULL, doesn't use GPSBabel. Input must be GPX (or Geocaching *.loc)
274 * Uses babel_general_convert_from() to actually run the command. This function
275 * prepares the command and temporary file, and sets up the arguments for bash.
277 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 )
280 gchar *name_dst = NULL;
281 gboolean ret = FALSE;
284 if ((fd_dst = g_file_open_tmp("tmp-viking.XXXXXX", &name_dst, NULL)) >= 0) {
285 g_debug ("%s: temporary file: %s", __FUNCTION__, name_dst);
286 gchar *shell_command;
287 if ( input_file_type )
288 shell_command = g_strdup_printf("%s | %s -i %s -f - -o gpx -F %s",
289 input_cmd, gpsbabel_loc, input_file_type, name_dst);
291 shell_command = g_strdup_printf("%s > %s", input_cmd, name_dst);
293 g_debug("%s: %s", __FUNCTION__, shell_command);
296 args = g_malloc(sizeof(gchar *)*4);
297 args[0] = BASH_LOCATION;
299 args[2] = shell_command;
302 ret = babel_general_convert_from ( vt, cb, args, name_dst, user_data );
304 g_free ( shell_command );
313 * a_babel_convert_from_url:
314 * @vt: The #VikTrwLayer where to insert the collected data
315 * @url: the URL to fetch
316 * @cb: Optional callback function. Same usage as in a_babel_convert().
317 * @user_data: passed along to cb
318 * @options: download options. Maybe NULL.
320 * Download the file pointed by the URL and optionally uses GPSBabel to convert from input_file_type.
321 * If input_file_type is %NULL, doesn't use GPSBabel. Input must be GPX.
323 * Returns: %TRUE on successful invocation of GPSBabel or read of the GPX
326 gboolean a_babel_convert_from_url ( VikTrwLayer *vt, const char *url, const char *input_type, BabelStatusFunc cb, gpointer user_data, DownloadMapOptions *options )
328 // If no download options specified, use defaults:
329 DownloadMapOptions myoptions = { FALSE, FALSE, NULL, 0, NULL, NULL };
331 myoptions = *options;
334 gboolean ret = FALSE;
335 gchar *name_src = NULL;
336 gchar *babelargs = NULL;
338 g_debug("%s: input_type=%s url=%s", __FUNCTION__, input_type, url);
340 if ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0) {
341 g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
345 fetch_ret = a_http_download_get_url(url, "", name_src, &myoptions, NULL);
346 if (fetch_ret == 0) {
347 if (input_type != NULL) {
348 babelargs = g_strdup_printf(" -i %s", input_type);
349 ret = a_babel_convert_from( vt, babelargs, name_src, NULL, NULL, NULL );
351 /* Process directly the retrieved file */
352 g_debug("%s: directly read GPX file %s", __FUNCTION__, name_src);
353 FILE *f = g_fopen(name_src, "r");
355 ret = a_gpx_read_file ( vt, f );
369 static gboolean babel_general_convert_to( VikTrwLayer *vt, VikTrack *trk, BabelStatusFunc cb, gchar **args, const gchar *name_src, gpointer user_data )
371 // Now strips out invisible tracks and waypoints
372 if (!a_file_export(vt, name_src, FILE_TYPE_GPX, trk, FALSE)) {
373 g_critical("Error exporting to %s", name_src);
377 return babel_general_convert (cb, args, user_data);
381 * a_babel_convert_to:
382 * @vt: The TRW layer from which data is taken.
383 * @track: Operate on the individual track if specified. Use NULL when operating on a TRW layer
384 * @babelargs: A string containing gpsbabel command line options. In addition to any filters, this string
385 * must include the input file type (-i) option.
386 * @to: Filename or device the data is written to.
387 * @cb: Optional callback function. Same usage as in a_babel_convert.
388 * @user_data: passed along to cb
390 * Exports data using gpsbabel. This routine is synchronous;
391 * that is, it will block the calling program until the conversion is done. To avoid blocking, call
392 * this routine from a worker thread.
394 * Returns: %TRUE on successful invocation of GPSBabel command
396 gboolean a_babel_convert_to( VikTrwLayer *vt, VikTrack *track, const char *babelargs, const char *to, BabelStatusFunc cb, gpointer user_data )
400 gchar *name_src = NULL;
401 gboolean ret = FALSE;
404 if ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0) {
405 g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
409 gchar **sub_args = g_strsplit(babelargs, " ", 0);
413 args[i++] = unbuffer_loc;
414 args[i++] = gpsbabel_loc;
417 for (j = 0; sub_args[j]; j++)
418 /* some version of gpsbabel can not take extra blank arg */
419 if (sub_args[j][0] != '\0')
420 args[i++] = sub_args[j];
422 args[i++] = name_src;
424 args[i++] = (char *)to;
427 ret = babel_general_convert_to ( vt, track, cb, args, name_src, user_data );
429 g_strfreev(sub_args);
431 g_critical("gpsbabel not found in PATH");
439 static void set_mode(BabelMode mode, gchar *smode)
441 mode.waypointsRead = smode[0] == 'r';
442 mode.waypointsWrite = smode[1] == 'w';
443 mode.tracksRead = smode[2] == 'r';
444 mode.tracksWrite = smode[3] == 'w';
445 mode.routesRead = smode[4] == 'r';
446 mode.routesWrite = smode[5] == 'w';
450 * load_feature_parse_line:
452 * Load a single feature stored in the given line.
454 static void load_feature_parse_line (gchar *line)
456 gchar **tokens = g_strsplit ( line, "\t", 0 );
458 && tokens[0] != NULL ) {
459 if ( strcmp("serial", tokens[0]) == 0 ) {
460 if ( tokens[1] != NULL
463 && tokens[4] != NULL ) {
464 BabelDevice *device = g_malloc ( sizeof (BabelDevice) );
465 set_mode (device->mode, tokens[1]);
466 device->name = g_strdup (tokens[2]);
467 device->label = g_strndup (tokens[4], 50); // Limit really long label text
468 a_babel_device_list = g_list_append (a_babel_device_list, device);
469 g_debug ("New gpsbabel device: %s", device->name);
471 g_warning ( "Unexpected gpsbabel format string: %s", line);
473 } else if ( strcmp("file", tokens[0]) == 0 ) {
474 if ( tokens[1] != NULL
477 && tokens[4] != NULL ) {
478 BabelFile *file = g_malloc ( sizeof (BabelFile) );
479 set_mode (file->mode, tokens[1]);
480 file->name = g_strdup (tokens[2]);
481 file->ext = g_strdup (tokens[3]);
482 file->label = g_strdup (tokens[4]);
483 a_babel_file_list = g_list_append (a_babel_file_list, file);
484 g_debug ("New gpsbabel file: %s", file->name);
486 g_warning ( "Unexpected gpsbabel format string: %s", line);
490 g_warning ( "Unexpected gpsbabel format string: %s", line);
492 g_strfreev ( tokens );
495 static void load_feature_cb (BabelProgressCode code, gpointer line, gpointer user_data)
498 load_feature_parse_line (line);
501 static gboolean load_feature ()
504 gboolean ret = FALSE;
507 if ( gpsbabel_loc ) {
510 args[i++] = unbuffer_loc;
511 args[i++] = gpsbabel_loc;
515 ret = babel_general_convert (load_feature_cb, args, NULL);
517 g_critical("gpsbabel not found in PATH");
525 * Initialises babel module.
526 * Mainly check existence of gpsbabel progam
527 * and load all features available in ths version.
531 /* TODO allow to set gpsbabel path via command line */
532 gpsbabel_loc = g_find_program_in_path( "gpsbabel" );
534 g_critical( "gpsbabel not found in PATH" );
536 // Unlikely to package unbuffer on Windows so ATM don't even bother trying
537 // Highly unlikely unbuffer is available on a Windows system otherwise
539 unbuffer_loc = g_find_program_in_path( "unbuffer" );
541 g_warning( "unbuffer not found in PATH" );
550 * Free resources acquired by a_babel_init.
552 void a_babel_uninit ()
554 g_free ( gpsbabel_loc );
555 g_free ( unbuffer_loc );
557 if ( a_babel_file_list ) {
559 for (gl = a_babel_file_list; gl != NULL; gl = g_list_next(gl)) {
560 BabelFile *file = gl->data;
561 g_free ( file->name );
562 g_free ( file->ext );
563 g_free ( file->label );
566 g_list_free ( a_babel_file_list );
569 if ( a_babel_device_list ) {
571 for (gl = a_babel_device_list; gl != NULL; gl = g_list_next(gl)) {
572 BabelDevice *device = gl->data;
573 g_free ( device->name );
574 g_free ( device->label );
577 g_list_free ( a_babel_device_list );