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  * Copyright (C) 2013, Rob Norris <rw_norris@hotmail.com>
   6  *
   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.
  11  *
  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.
  16  *
  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
  20  *
  21  */
  22 #ifdef HAVE_CONFIG_H
  23 #include "config.h"
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <string.h>
  28 #include <glib/gprintf.h>
  29 #include <glib/gi18n.h>
  30
  31 #include "viking.h"
  32 #include "babel.h"
  33 #include "gpx.h"
  34 #include "acquire.h"
  35
  36 /************************ FILTER LIST *******************/
  37 // extern VikDataSourceInterface vik_datasource_gps_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   gboolean creating_new_layer;
  68   VikTrwLayer *vtl;
  69   gpointer options;
  70 } w_and_interface_t;
  71
  72
  73 /*********************************************************
  74  * Definitions and routines for acquiring data from Data Sources in general
  75  *********************************************************/
  76
  77 static void progress_func ( BabelProgressCode c, gpointer data, acq_dialog_widgets_t *w )
  78 {
  79   if ( w->source_interface->is_thread ) {
  80     gdk_threads_enter ();
  81     if ( !w->running ) {
  82       if ( w->source_interface->cleanup_func )
  83         w->source_interface->cleanup_func ( w->user_data );
  84       gdk_threads_leave ();
  85       g_thread_exit ( NULL );
  86     }
  87     gdk_threads_leave ();
  88   }
  89
  90   if ( w->source_interface->progress_func )
  91     w->source_interface->progress_func ( c, data, w );
  92 }
  93
  94 /**
  95  * Some common things to do on completion of a datasource process
  96  *  . Update layer
  97  *  . Update dialog info
  98  *  . Update main dsisplay
  99  */
 100 static void on_complete_process (w_and_interface_t *wi)
 101 {
 102   if (wi->w->running) {
 103     gtk_label_set_text ( GTK_LABEL(wi->w->status), _("Done.") );
 104     if ( wi->creating_new_layer ) {
 105       /* Only create the layer if it actually contains anything useful */
 106       // TODO: create function for this operation to hide detail:
 107       if ( ! vik_trw_layer_is_empty ( wi->vtl ) ) {
 108         vik_layer_post_read ( VIK_LAYER(wi->vtl), wi->w->vvp, TRUE );
 109         vik_aggregate_layer_add_layer( vik_layers_panel_get_top_layer(wi->w->vlp), VIK_LAYER(wi->vtl));
 110       }
 111       else
 112         gtk_label_set_text ( GTK_LABEL(wi->w->status), _("No data.") );
 113     }
 114     /* View this data if available and is desired */
 115     if ( wi->vtl && wi->w->source_interface->autoview ) {
 116       vik_trw_layer_auto_set_view ( wi->vtl, vik_layers_panel_get_viewport(wi->w->vlp) );
 117     }
 118     if ( wi->w->source_interface->keep_dialog_open ) {
 119       gtk_dialog_set_response_sensitive ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_ACCEPT, TRUE );
 120       gtk_dialog_set_response_sensitive ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_REJECT, FALSE );
 121     } else {
 122       gtk_dialog_response ( GTK_DIALOG(wi->w->dialog), GTK_RESPONSE_ACCEPT );
 123     }
 124     // Main display update
 125     if ( wi->vtl )
 126       vik_layers_panel_emit_update ( wi->w->vlp );
 127   } else {
 128     /* cancelled */
 129     if ( wi->creating_new_layer )
 130       g_object_unref(wi->vtl);
 131   }
 132 }
 133
 134 /* this routine is the worker thread.  there is only one simultaneous download allowed */
 135 static void get_from_anything ( w_and_interface_t *wi )
 136 {
 137   gchar *cmd = wi->cmd;
 138   gchar *extra = wi->extra;
 139   gboolean result = TRUE;
 140
 141   VikDataSourceInterface *source_interface = wi->w->source_interface;
 142
 143   if ( source_interface->process_func )
 144     result = source_interface->process_func ( wi->vtl, cmd, extra, (BabelStatusFunc) progress_func, wi->w, wi->options );
 145
 146   g_free ( cmd );
 147   g_free ( extra );
 148   g_free ( wi->options );
 149
 150   if (wi->w->running && !result) {
 151     gdk_threads_enter();
 152     gtk_label_set_text ( GTK_LABEL(wi->w->status), _("Error: acquisition failed.") );
 153     if ( wi->creating_new_layer )
 154       g_object_unref ( G_OBJECT ( wi->vtl ) );
 155     gdk_threads_leave();
 156   }
 157   else {
 158     gdk_threads_enter();
 159     on_complete_process ( wi );
 160     gdk_threads_leave();
 161   }
 162
 163   if ( source_interface->cleanup_func )
 164     source_interface->cleanup_func ( wi->w->user_data );
 165
 166   if ( wi->w->running ) {
 167     wi->w->running = FALSE;
 168   }
 169   else {
 170     g_free ( wi->w );
 171     g_free ( wi );
 172     wi = NULL;
 173   }
 174
 175   g_thread_exit ( NULL );
 176 }
 177
 178
 179 static gchar *write_tmp_trwlayer ( VikTrwLayer *vtl )
 180 {
 181   int fd_src;
 182   gchar *name_src;
 183   FILE *f;
 184   g_assert ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0);
 185   g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
 186   f = fdopen(fd_src, "w");
 187   a_gpx_write_file(vtl, f, NULL);
 188   fclose(f);
 189   f = NULL;
 190   return name_src;
 191 }
 192
 193 /* TODO: write with name of old track */
 194 static gchar *write_tmp_track ( VikTrack *track )
 195 {
 196   int fd_src;
 197   gchar *name_src;
 198   FILE *f;
 199   g_assert ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0);
 200   g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
 201   f = fdopen(fd_src, "w");
 202   a_gpx_write_track_file(track, f, NULL); /* Thank you Guilhem! Just when I needed this function... -- Evan */
 203   fclose(f);
 204   f = NULL;
 205   return name_src;
 206 }
 207
 208 /* TODO: cleanup, getr rid of redundancy */
 209
 210 /* depending on type of filter, often only vtl or track will be given.
 211  * the other can be NULL.
 212  */
 213 static void acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface,
 214                       VikTrwLayer *vtl, VikTrack *track )
 215 {
 216   /* for manual dialogs */
 217   GtkWidget *dialog = NULL;
 218   GtkWidget *status;
 219   gchar *cmd = NULL;
 220   gchar *extra = NULL;
 221   gchar *cmd_off = NULL;
 222   gchar *extra_off = NULL;
 223   acq_dialog_widgets_t *w;
 224   gpointer user_data;
 225   gpointer options = NULL;
 226
 227   /* for UI builder */
 228   gpointer pass_along_data;
 229   VikLayerParamData *paramdatas = NULL;
 230
 231   w_and_interface_t *wi;
 232
 233   /*** INIT AND CHECK EXISTENCE ***/
 234   if ( source_interface->init_func )
 235     user_data = source_interface->init_func();
 236   else
 237     user_data = NULL;
 238   pass_along_data = user_data;
 239
 240   if ( source_interface->check_existence_func ) {
 241     gchar *error_str = source_interface->check_existence_func();
 242     if ( error_str ) {
 243       a_dialog_error_msg ( GTK_WINDOW(vw), error_str );
 244       g_free ( error_str );
 245       return;
 246     }
 247   }
 248
 249   /* BUILD UI & GET OPTIONS IF NECESSARY. */
 250
 251   /* POSSIBILITY 0: NO OPTIONS. DO NOTHING HERE. */
 252   /* POSSIBILITY 1: ADD_SETUP_WIDGETS_FUNC */
 253   if ( source_interface->add_setup_widgets_func ) {
 254     dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
 255
 256     gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
 257     GtkWidget *response_w = NULL;
 258 #if GTK_CHECK_VERSION (2, 20, 0)
 259     response_w = gtk_dialog_get_widget_for_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
 260 #endif
 261
 262     source_interface->add_setup_widgets_func(dialog, vvp, user_data);
 263     gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
 264
 265     if ( response_w )
 266       gtk_widget_grab_focus ( response_w );
 267
 268     if ( gtk_dialog_run ( GTK_DIALOG(dialog) ) != GTK_RESPONSE_ACCEPT ) {
 269       source_interface->cleanup_func(user_data);
 270       gtk_widget_destroy(dialog);
 271       return;
 272     }
 273   }
 274   /* POSSIBILITY 2: UI BUILDER */
 275   else if ( source_interface->params ) {
 276     paramdatas = a_uibuilder_run_dialog ( source_interface->window_title, GTK_WINDOW(vw),
 277                         source_interface->params, source_interface->params_count,
 278                         source_interface->params_groups, source_interface->params_groups_count,
 279                         source_interface->params_defaults );
 280     if ( paramdatas )
 281       pass_along_data = paramdatas;
 282     else
 283       return; /* TODO: do we have to free anything here? */
 284   }
 285
 286   /* CREATE INPUT DATA & GET COMMAND STRING */
 287
 288   if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER ) {
 289     gchar *name_src = write_tmp_trwlayer ( vtl );
 290
 291     ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
 292         ( pass_along_data, &cmd, &extra, name_src );
 293
 294     g_free ( name_src );
 295     /* TODO: delete the tmp file? or delete it only after we're done with it? */
 296   } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK ) {
 297     gchar *name_src = write_tmp_trwlayer ( vtl );
 298     gchar *name_src_track = write_tmp_track ( track );
 299
 300     ((VikDataSourceGetCmdStringFuncWithInputInput) source_interface->get_cmd_string_func)
 301         ( pass_along_data, &cmd, &extra, name_src, name_src_track );
 302
 303     g_free ( name_src );
 304     g_free ( name_src_track );
 305   } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRACK ) {
 306     gchar *name_src_track = write_tmp_track ( track );
 307
 308     ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
 309         ( pass_along_data, &cmd, &extra, name_src_track );
 310
 311     g_free ( name_src_track );
 312   } else if ( source_interface->get_cmd_string_func )
 313     source_interface->get_cmd_string_func ( pass_along_data, &cmd, &extra, &options );
 314
 315   /* Get data for Off command */
 316   if ( source_interface->off_func ) {
 317     source_interface->off_func ( pass_along_data, &cmd_off, &extra_off );
 318   }
 319
 320   /* cleanup for option dialogs */
 321   if ( source_interface->add_setup_widgets_func ) {
 322     gtk_widget_destroy(dialog);
 323     dialog = NULL;
 324   } else if ( source_interface->params ) {
 325     a_uibuilder_free_paramdatas ( paramdatas, source_interface->params, source_interface->params_count );
 326   }
 327
 328   w = g_malloc(sizeof(*w));
 329   wi = g_malloc(sizeof(*wi));
 330   wi->w = w;
 331   wi->w->source_interface = source_interface;
 332   wi->cmd = cmd;
 333   wi->extra = extra; /* usually input data type (?) */
 334   wi->options = options;
 335   wi->vtl = vtl;
 336   wi->creating_new_layer = (!vtl);
 337
 338   dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
 339   gtk_dialog_set_response_sensitive ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT, FALSE );
 340   gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
 341
 342   w->dialog = dialog;
 343   w->running = TRUE;
 344   status = gtk_label_new (_("Working..."));
 345   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), status, FALSE, FALSE, 5 );
 346   gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
 347   // May not want to see the dialog at all
 348   if ( source_interface->is_thread || source_interface->keep_dialog_open )
 349     gtk_widget_show_all(dialog);
 350   w->status = status;
 351
 352   w->vw = vw;
 353   w->vlp = vlp;
 354   w->vvp = vvp;
 355   if ( source_interface->add_progress_widgets_func ) {
 356     source_interface->add_progress_widgets_func ( dialog, user_data );
 357   }
 358   w->user_data = user_data;
 359
 360   if (source_interface->mode == VIK_DATASOURCE_ADDTOLAYER) {
 361     VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
 362     if ( IS_VIK_TRW_LAYER(current_selected) ) {
 363       wi->vtl = VIK_TRW_LAYER(current_selected);
 364       wi->creating_new_layer = FALSE;
 365     }
 366   }
 367   else if ( source_interface->mode == VIK_DATASOURCE_MANUAL_LAYER_MANAGEMENT ) {
 368     // Don't create in acquire - as datasource will perform the necessary actions
 369     wi->creating_new_layer = FALSE;
 370     VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
 371     if ( IS_VIK_TRW_LAYER(current_selected) )
 372       wi->vtl = VIK_TRW_LAYER(current_selected);
 373   }
 374   if ( wi->creating_new_layer ) {
 375     wi->vtl = VIK_TRW_LAYER ( vik_layer_create ( VIK_LAYER_TRW, w->vvp, NULL, FALSE ) );
 376     vik_layer_rename ( VIK_LAYER ( wi->vtl ), _(source_interface->layer_title) );
 377   }
 378
 379   if ( source_interface->is_thread ) {
 380     if ( cmd ) {
 381       g_thread_create((GThreadFunc)get_from_anything, wi, FALSE, NULL );
 382       gtk_dialog_run ( GTK_DIALOG(dialog) );
 383       if (w->running) {
 384         // Cancel and mark for thread to finish
 385         w->running = FALSE;
 386         // NB Thread will free memory
 387       } else {
 388         if ( cmd_off ) {
 389           /* Turn off */
 390           a_babel_convert_from (NULL, cmd_off, extra_off, NULL, NULL, NULL);
 391           g_free ( cmd_off );
 392         }
 393         if ( extra_off )
 394           g_free ( extra_off );
 395
 396         // Thread finished by normal completion - free memory
 397         g_free ( w );
 398         g_free ( wi );
 399       }
 400     }
 401     else {
 402       // This shouldn't happen...
 403       gtk_label_set_text ( GTK_LABEL(w->status), _("Unable to create command\nAcquire method failed.") );
 404       gtk_dialog_run (GTK_DIALOG (dialog));
 405     }
 406   }
 407   else {
 408     // bypass thread method malarkly - you'll just have to wait...
 409     if ( source_interface->process_func ) {
 410       gboolean result = source_interface->process_func ( wi->vtl, cmd, extra, (BabelStatusFunc) progress_func, w, options );
 411       if ( !result )
 412         a_dialog_msg ( GTK_WINDOW(vw), GTK_MESSAGE_ERROR, _("Error: acquisition failed."), NULL );
 413     }
 414     g_free ( cmd );
 415     g_free ( extra );
 416     g_free ( options );
 417
 418     on_complete_process ( wi );
 419     // Actually show it if necessary
 420     if ( wi->w->source_interface->keep_dialog_open )
 421       gtk_dialog_run ( GTK_DIALOG(dialog) );
 422
 423     g_free ( w );
 424     g_free ( wi );
 425   }
 426
 427   gtk_widget_destroy ( dialog );
 428 }
 429
 430 /**
 431  * a_acquire:
 432  *
 433  * Process the given VikDataSourceInterface for sources with no input data.
 434  */
 435 void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface ) {
 436   acquire ( vw, vlp, vvp, source_interface, NULL, NULL );
 437 }
 438
 439 static void acquire_trwlayer_callback ( GObject *menuitem, gpointer *pass_along )
 440 {
 441   VikDataSourceInterface *iface = g_object_get_data ( menuitem, "vik_acq_iface" );
 442   VikWindow *vw =       pass_along[0];
 443   VikLayersPanel *vlp = pass_along[1];
 444   VikViewport *vvp =    pass_along[2];
 445   VikTrwLayer *vtl =    pass_along[3];
 446   VikTrack *tr =        pass_along[4];
 447
 448   acquire ( vw, vlp, vvp, iface, vtl, tr );
 449 }
 450
 451 static GtkWidget *acquire_build_menu ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp,
 452                                 VikTrwLayer *vtl, VikTrack *track, /* both passed to acquire, although for many filters only one ness */
 453                                 const gchar *menu_title, vik_datasource_inputtype_t inputtype )
 454 {
 455   static gpointer pass_along[5];
 456   GtkWidget *menu_item=NULL, *menu=NULL;
 457   GtkWidget *item=NULL;
 458   int i;
 459
 460   pass_along[0] = vw;
 461   pass_along[1] = vlp;
 462   pass_along[2] = vvp;
 463   pass_along[3] = vtl;
 464   pass_along[4] = track;
 465
 466   for ( i = 0; i < N_FILTERS; i++ ) {
 467     if ( filters[i]->inputtype == inputtype ) {
 468       if ( ! menu_item ) { /* do this just once, but return NULL if no filters */
 469         menu = gtk_menu_new();
 470         menu_item = gtk_menu_item_new_with_mnemonic ( menu_title );
 471         gtk_menu_item_set_submenu (GTK_MENU_ITEM (menu_item), menu );
 472       }
 473
 474       item = gtk_menu_item_new_with_label ( filters[i]->window_title );
 475       g_object_set_data ( G_OBJECT(item), "vik_acq_iface", (gpointer) filters[i] );
 476       g_signal_connect ( G_OBJECT(item), "activate", G_CALLBACK(acquire_trwlayer_callback), pass_along );
 477       gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
 478       gtk_widget_show ( item );
 479     }
 480   }
 481
 482   return menu_item;
 483 }
 484
 485 /**
 486  * a_acquire_trwlayer_menu:
 487  *
 488  * Create a sub menu intended for rightclicking on a TRWLayer's menu called "Filter".
 489  *
 490  * Returns: %NULL if no filters.
 491  */
 492 GtkWidget *a_acquire_trwlayer_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
 493 {
 494   return acquire_build_menu ( vw, vlp, vvp, vtl, NULL, _("_Filter"), VIK_DATASOURCE_INPUTTYPE_TRWLAYER );
 495 }
 496
 497 /**
 498  * a_acquire_trwlayer_track_menu:
 499  *
 500  * Create a sub menu intended for rightclicking on a TRWLayer's menu called "Filter with Track "TRACKNAME"...".
 501  *
 502  * Returns: %NULL if no filters or no filter track has been set.
 503  */
 504 GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
 505 {
 506   if ( filter_track == NULL )
 507     return NULL;
 508   else {
 509     gchar *menu_title = g_strdup_printf ( _("Filter with %s"), filter_track->name );
 510     GtkWidget *rv = acquire_build_menu ( vw, vlp, vvp, vtl, filter_track,
 511                         menu_title, VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK );
 512     g_free ( menu_title );
 513     return rv;
 514   }
 515 }
 516
 517 /**
 518  * a_acquire_track_menu:
 519  *
 520  * Create a sub menu intended for rightclicking on a track's menu called "Filter".
 521  *
 522  * Returns: %NULL if no applicable filters
 523  */
 524 GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr)
 525 {
 526   return acquire_build_menu ( vw, vlp, vvp, NULL, tr, _("Filter"), VIK_DATASOURCE_INPUTTYPE_TRACK );
 527 }
 528
 529 /**
 530  * a_acquire_set_filter_track:
 531  *
 532  * Sets application-wide track to use with filter. references the track.
 533  */
 534 void a_acquire_set_filter_track ( VikTrack *tr )
 535 {
 536   if ( filter_track )
 537     vik_track_free ( filter_track );
 538
 539   filter_track = tr;
 540   vik_track_ref ( tr );
 541 }