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