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