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