src/acquire.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25 #include <stdio.h>
  26 #include <string.h>
  27 #include <glib/gprintf.h>
  28 #include <glib/gi18n.h>
  29
  30 #include "viking.h"
  31 #include "babel.h"
  32 #include "gpx.h"
  33 #include "acquire.h"
  34
  35 /************************ FILTER LIST *******************/
  36 // extern VikDataSourceInterface vik_datasource_gps_interface;
  37
  38 /*** Input is TRWLayer ***/
  39 extern VikDataSourceInterface vik_datasource_bfilter_simplify_interface;
  40 extern VikDataSourceInterface vik_datasource_bfilter_dup_interface;
  41
  42 /*** Input is a track and a TRWLayer ***/
  43 extern VikDataSourceInterface vik_datasource_bfilter_polygon_interface;
  44 extern VikDataSourceInterface vik_datasource_bfilter_exclude_polygon_interface;
  45
  46 /*** Input is a track ***/
  47
  48 const VikDataSourceInterface *filters[] = {
  49   &vik_datasource_bfilter_simplify_interface,
  50   &vik_datasource_bfilter_dup_interface,
  51   &vik_datasource_bfilter_polygon_interface,
  52   &vik_datasource_bfilter_exclude_polygon_interface,
  53 };
  54
  55 const guint N_FILTERS = sizeof(filters) / sizeof(filters[0]);
  56
  57 VikTrack *filter_track = NULL;
  58
  59 /********************************************************/
  60
  61 /* passed along to worker thread */
  62 typedef struct {
  63   acq_dialog_widgets_t *w;
  64   gchar *cmd;
  65   gchar *extra;
  66 } w_and_interface_t;
  67
  68
  69 /*********************************************************
  70  * Definitions and routines for acquiring data from Data Sources in general
  71  *********************************************************/
  72
  73 static void progress_func ( BabelProgressCode c, gpointer data, acq_dialog_widgets_t *w )
  74 {
  75   gdk_threads_enter ();
  76   if (!w->ok) {
  77     if ( w->source_interface->cleanup_func )
  78       w->source_interface->cleanup_func( w->user_data );
  79     g_free ( w );
  80     gdk_threads_leave();
  81     g_thread_exit ( NULL );
  82   }
  83   gdk_threads_leave ();
  84
  85   if ( w->source_interface->progress_func )
  86     w->source_interface->progress_func ( (gpointer) c, data, w );
  87 }
  88
  89
  90 /* this routine is the worker thread.  there is only one simultaneous download allowed */
  91 static void get_from_anything ( w_and_interface_t *wi )
  92 {
  93   gchar *cmd = wi->cmd;
  94   gchar *extra = wi->extra;
  95   gboolean result = TRUE;
  96   VikTrwLayer *vtl = NULL;
  97
  98   gboolean creating_new_layer = TRUE;
  99
 100   acq_dialog_widgets_t *w = wi->w;
 101   VikDataSourceInterface *source_interface = wi->w->source_interface;
 102   g_free ( wi );
 103   wi = NULL;
 104
 105   gdk_threads_enter();
 106   if (source_interface->mode == VIK_DATASOURCE_ADDTOLAYER) {
 107     VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
 108     if ( IS_VIK_TRW_LAYER(current_selected) ) {
 109       vtl = VIK_TRW_LAYER(current_selected);
 110       creating_new_layer = FALSE;
 111     }
 112   }
 113   if ( creating_new_layer ) {
 114     vtl = VIK_TRW_LAYER ( vik_layer_create ( VIK_LAYER_TRW, w->vvp, NULL, FALSE ) );
 115     vik_layer_rename ( VIK_LAYER ( vtl ), _(source_interface->layer_title) );
 116     gtk_label_set_text ( GTK_LABEL(w->status), _("Working...") );
 117   }
 118   gdk_threads_leave();
 119
 120   // TODO consider removing 'type' and make everything run via the specficied process function
 121   switch ( source_interface->type ) {
 122   case VIK_DATASOURCE_GPSBABEL_DIRECT:
 123     result = a_babel_convert_from (vtl, cmd, extra, (BabelStatusFunc) progress_func, w);
 124     break;
 125   case VIK_DATASOURCE_URL:
 126     result = a_babel_convert_from_url (vtl, cmd, extra, (BabelStatusFunc) progress_func, w);
 127     break;
 128   case VIK_DATASOURCE_SHELL_CMD:
 129     result = a_babel_convert_from_shellcommand ( vtl, cmd, extra, (BabelStatusFunc) progress_func, w);
 130     break;
 131   case VIK_DATASOURCE_INTERNAL:
 132     if ( source_interface->process_func )
 133       result = source_interface->process_func ( vtl, cmd, extra, (BabelStatusFunc) progress_func, w );
 134     break;
 135   default:
 136     g_critical("Houston, we've had a problem.");
 137   }
 138
 139   g_free ( cmd );
 140   g_free ( extra );
 141
 142   if (!result) {
 143     gdk_threads_enter();
 144     gtk_label_set_text ( GTK_LABEL(w->status), _("Error: acquisition failed.") );
 145     if ( creating_new_layer )
 146       g_object_unref ( G_OBJECT ( vtl ) );
 147     gdk_threads_leave();
 148   }
 149   else {
 150     gdk_threads_enter();
 151     if (w->ok) {
 152       gtk_label_set_text ( GTK_LABEL(w->status), _("Done.") );
 153       if ( creating_new_layer ) {
 154         /* Only create the layer if it actually contains anything useful */
 155         // TODO: create function for this operation to hide detail:
 156         if ( g_hash_table_size (vik_trw_layer_get_tracks(vtl)) ||
 157              g_hash_table_size (vik_trw_layer_get_waypoints(vtl)) ||
 158              g_hash_table_size (vik_trw_layer_get_routes(vtl)) ) {
 159           vik_layer_post_read ( VIK_LAYER(vtl), w->vvp, TRUE );
 160           vik_aggregate_layer_add_layer( vik_layers_panel_get_top_layer(w->vlp), VIK_LAYER(vtl));
 161         }
 162         else
 163           gtk_label_set_text ( GTK_LABEL(w->status), _("No data.") );
 164       }
 165       /* View this data if available and is desired */
 166       if ( vtl && source_interface->autoview ) {
 167         vik_trw_layer_auto_set_view ( vtl, vik_layers_panel_get_viewport(w->vlp) );
 168         vik_layers_panel_emit_update (w->vlp);
 169       }
 170       if ( source_interface->keep_dialog_open ) {
 171         gtk_dialog_set_response_sensitive ( GTK_DIALOG(w->dialog), GTK_RESPONSE_ACCEPT, TRUE );
 172         gtk_dialog_set_response_sensitive ( GTK_DIALOG(w->dialog), GTK_RESPONSE_REJECT, FALSE );
 173       } else {
 174         gtk_dialog_response ( GTK_DIALOG(w->dialog), GTK_RESPONSE_ACCEPT );
 175       }
 176     } else {
 177       /* canceled */
 178       if ( creating_new_layer )
 179         g_object_unref(vtl);
 180     }
 181   }
 182   if ( source_interface->cleanup_func )
 183     source_interface->cleanup_func ( w->user_data );
 184
 185   if ( w->ok ) {
 186     w->ok = FALSE;
 187   } else {
 188     g_free ( w );
 189   }
 190
 191   gdk_threads_leave();
 192   g_thread_exit ( NULL );
 193 }
 194
 195
 196 static gchar *write_tmp_trwlayer ( VikTrwLayer *vtl )
 197 {
 198   int fd_src;
 199   gchar *name_src;
 200   FILE *f;
 201   g_assert ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0);
 202   g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
 203   f = fdopen(fd_src, "w");
 204   a_gpx_write_file(vtl, f, NULL);
 205   fclose(f);
 206   f = NULL;
 207   return name_src;
 208 }
 209
 210 /* TODO: write with name of old track */
 211 static gchar *write_tmp_track ( VikTrack *track )
 212 {
 213   int fd_src;
 214   gchar *name_src;
 215   FILE *f;
 216   g_assert ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0);
 217   g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
 218   f = fdopen(fd_src, "w");
 219   a_gpx_write_track_file(track, f, NULL); /* Thank you Guilhem! Just when I needed this function... -- Evan */
 220   fclose(f);
 221   f = NULL;
 222   return name_src;
 223 }
 224
 225 /* TODO: cleanup, getr rid of redundancy */
 226
 227 /* depending on type of filter, often only vtl or track will be given.
 228  * the other can be NULL.
 229  */
 230 static void acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface,
 231                       VikTrwLayer *vtl, VikTrack *track )
 232 {
 233   /* for manual dialogs */
 234   GtkWidget *dialog = NULL;
 235   GtkWidget *status;
 236   gchar *cmd = NULL;
 237   gchar *extra = NULL;
 238   gchar *cmd_off = NULL;
 239   gchar *extra_off = NULL;
 240   acq_dialog_widgets_t *w;
 241   gpointer user_data;
 242
 243   /* for UI builder */
 244   gpointer pass_along_data;
 245   VikLayerParamData *paramdatas = NULL;
 246
 247   w_and_interface_t *wi;
 248
 249   /*** INIT AND CHECK EXISTENCE ***/
 250   if ( source_interface->init_func )
 251     user_data = source_interface->init_func();
 252   else
 253     user_data = NULL;
 254   pass_along_data = user_data;
 255
 256   if ( source_interface->check_existence_func ) {
 257     gchar *error_str = source_interface->check_existence_func();
 258     if ( error_str ) {
 259       a_dialog_error_msg ( GTK_WINDOW(vw), error_str );
 260       g_free ( error_str );
 261       return;
 262     }
 263   }
 264
 265   /* BUILD UI & GET OPTIONS IF NECESSARY. */
 266
 267   /* POSSIBILITY 0: NO OPTIONS. DO NOTHING HERE. */
 268   /* POSSIBILITY 1: ADD_SETUP_WIDGETS_FUNC */
 269   if ( source_interface->add_setup_widgets_func ) {
 270     dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
 271
 272     gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
 273     GtkWidget *response_w = NULL;
 274 #if GTK_CHECK_VERSION (2, 20, 0)
 275     response_w = gtk_dialog_get_widget_for_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
 276 #endif
 277
 278     source_interface->add_setup_widgets_func(dialog, vvp, user_data);
 279     gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
 280
 281     if ( response_w )
 282       gtk_widget_grab_focus ( response_w );
 283
 284     if ( gtk_dialog_run ( GTK_DIALOG(dialog) ) != GTK_RESPONSE_ACCEPT ) {
 285       source_interface->cleanup_func(user_data);
 286       gtk_widget_destroy(dialog);
 287       return;
 288     }
 289   }
 290   /* POSSIBILITY 2: UI BUILDER */
 291   else if ( source_interface->params ) {
 292     paramdatas = a_uibuilder_run_dialog ( source_interface->window_title, GTK_WINDOW(vw),
 293                         source_interface->params, source_interface->params_count,
 294                         source_interface->params_groups, source_interface->params_groups_count,
 295                         source_interface->params_defaults );
 296     if ( paramdatas )
 297       pass_along_data = paramdatas;
 298     else
 299       return; /* TODO: do we have to free anything here? */
 300   }
 301
 302   /* CREATE INPUT DATA & GET COMMAND STRING */
 303
 304   if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER ) {
 305     gchar *name_src = write_tmp_trwlayer ( vtl );
 306
 307     ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
 308         ( pass_along_data, &cmd, &extra, name_src );
 309
 310     g_free ( name_src );
 311     /* TODO: delete the tmp file? or delete it only after we're done with it? */
 312   } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK ) {
 313     gchar *name_src = write_tmp_trwlayer ( vtl );
 314     gchar *name_src_track = write_tmp_track ( track );
 315
 316     ((VikDataSourceGetCmdStringFuncWithInputInput) source_interface->get_cmd_string_func)
 317         ( pass_along_data, &cmd, &extra, name_src, name_src_track );
 318
 319     g_free ( name_src );
 320     g_free ( name_src_track );
 321   } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRACK ) {
 322     gchar *name_src_track = write_tmp_track ( track );
 323
 324     ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
 325         ( pass_along_data, &cmd, &extra, name_src_track );
 326
 327     g_free ( name_src_track );
 328   } else if ( source_interface->get_cmd_string_func )
 329       source_interface->get_cmd_string_func ( pass_along_data, &cmd, &extra );
 330
 331   /* Get data for Off command */
 332   if ( source_interface->off_func ) {
 333     source_interface->off_func ( pass_along_data, &cmd_off, &extra_off );
 334   }
 335
 336   /* cleanup for option dialogs */
 337   if ( source_interface->add_setup_widgets_func ) {
 338     gtk_widget_destroy(dialog);
 339     dialog = NULL;
 340   } else if ( source_interface->params ) {
 341     a_uibuilder_free_paramdatas ( paramdatas, source_interface->params, source_interface->params_count );
 342   }
 343
 344   /*** LET'S DO IT! ***/
 345
 346   if ( ! cmd )
 347     return;
 348
 349   w = g_malloc(sizeof(*w));
 350   wi = g_malloc(sizeof(*wi));
 351   wi->w = w;
 352   wi->w->source_interface = source_interface;
 353   wi->cmd = cmd;
 354   wi->extra = extra; /* usually input data type (?) */
 355
 356   dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
 357   gtk_dialog_set_response_sensitive ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT, FALSE );
 358   gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
 359
 360
 361   w->dialog = dialog;
 362   w->ok = TRUE;
 363   status = gtk_label_new (_("Status: detecting gpsbabel"));
 364   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), status, FALSE, FALSE, 5 );
 365   gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
 366   gtk_widget_show_all(status);
 367   w->status = status;
 368
 369   w->vw = vw;
 370   w->vlp = vlp;
 371   w->vvp = vvp;
 372   if ( source_interface->add_progress_widgets_func ) {
 373     source_interface->add_progress_widgets_func ( dialog, user_data );
 374   }
 375   w->user_data = user_data;
 376
 377
 378   g_thread_create((GThreadFunc)get_from_anything, wi, FALSE, NULL );
 379
 380   gtk_dialog_run ( GTK_DIALOG(dialog) );
 381   if ( w->ok )
 382     w->ok = FALSE; /* tell thread to stop. TODO: add mutex */
 383   else {
 384     if ( cmd_off ) {
 385       /* Turn off */
 386       a_babel_convert_from (NULL, cmd_off, extra_off, NULL, NULL);
 387     }
 388     g_free ( w ); /* thread has finished; free w */
 389   }
 390   gtk_widget_destroy ( dialog );
 391 }
 392
 393 void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface ) {
 394   acquire ( vw, vlp, vvp, source_interface, NULL, NULL );
 395 }
 396
 397 static void acquire_trwlayer_callback ( GObject *menuitem, gpointer *pass_along )
 398 {
 399   VikDataSourceInterface *iface = g_object_get_data ( menuitem, "vik_acq_iface" );
 400   VikWindow *vw =       pass_along[0];
 401   VikLayersPanel *vlp = pass_along[1];
 402   VikViewport *vvp =    pass_along[2];
 403   VikTrwLayer *vtl =    pass_along[3];
 404   VikTrack *tr =        pass_along[4];
 405
 406   acquire ( vw, vlp, vvp, iface, vtl, tr );
 407 }
 408
 409 static GtkWidget *acquire_build_menu ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp,
 410                                 VikTrwLayer *vtl, VikTrack *track, /* both passed to acquire, although for many filters only one ness */
 411                                 const gchar *menu_title, vik_datasource_inputtype_t inputtype )
 412 {
 413   static gpointer pass_along[5];
 414   GtkWidget *menu_item=NULL, *menu=NULL;
 415   GtkWidget *item=NULL;
 416   int i;
 417
 418   pass_along[0] = vw;
 419   pass_along[1] = vlp;
 420   pass_along[2] = vvp;
 421   pass_along[3] = vtl;
 422   pass_along[4] = track;
 423
 424   for ( i = 0; i < N_FILTERS; i++ ) {
 425     if ( filters[i]->inputtype == inputtype ) {
 426       if ( ! menu_item ) { /* do this just once, but return NULL if no filters */
 427         menu = gtk_menu_new();
 428         menu_item = gtk_menu_item_new_with_mnemonic ( menu_title );
 429         gtk_menu_item_set_submenu (GTK_MENU_ITEM (menu_item), menu );
 430       }
 431
 432       item = gtk_menu_item_new_with_label ( filters[i]->window_title );
 433       g_object_set_data ( G_OBJECT(item), "vik_acq_iface", (gpointer) filters[i] );
 434       g_signal_connect ( G_OBJECT(item), "activate", G_CALLBACK(acquire_trwlayer_callback), pass_along );
 435       gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
 436       gtk_widget_show ( item );
 437     }
 438   }
 439
 440   return menu_item;
 441 }
 442
 443 GtkWidget *a_acquire_trwlayer_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
 444 {
 445   return acquire_build_menu ( vw, vlp, vvp, vtl, NULL, _("_Filter"), VIK_DATASOURCE_INPUTTYPE_TRWLAYER );
 446 }
 447
 448 GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
 449 {
 450   if ( filter_track == NULL )
 451     return NULL;
 452   else {
 453     gchar *menu_title = g_strdup_printf ( _("Filter with %s"), filter_track->name );
 454     GtkWidget *rv = acquire_build_menu ( vw, vlp, vvp, vtl, filter_track,
 455                         menu_title, VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK );
 456     g_free ( menu_title );
 457     return rv;
 458   }
 459 }
 460
 461 GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr)
 462 {
 463   return acquire_build_menu ( vw, vlp, vvp, NULL, tr, _("Filter"), VIK_DATASOURCE_INPUTTYPE_TRACK );
 464 }
 465
 466 void a_acquire_set_filter_track ( VikTrack *tr )
 467 {
 468   if ( filter_track )
 469     vik_track_free ( filter_track );
 470
 471   filter_track = tr;
 472   vik_track_ref ( tr );
 473 }