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