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
  38 /*** Input is TRWLayer ***/
  39 extern VikDataSourceInterface vik_datasource_bfilter_simplify_interface;
  40 extern VikDataSourceInterface vik_datasource_bfilter_dup_interface;
  41
  42 /*** Input is a track and a TRWLayer ***/
  43 extern VikDataSourceInterface vik_datasource_bfilter_polygon_interface;
  44 extern VikDataSourceInterface vik_datasource_bfilter_exclude_polygon_interface;
  45
  46 /*** Input is a track ***/
  47
  48 const VikDataSourceInterface *filters[] = {
  49   &vik_datasource_bfilter_simplify_interface,
  50   &vik_datasource_bfilter_dup_interface,
  51   &vik_datasource_bfilter_polygon_interface,
  52   &vik_datasource_bfilter_exclude_polygon_interface,
  53 };
  54
  55 const guint N_FILTERS = sizeof(filters) / sizeof(filters[0]);
  56
  57 VikTrack *filter_track = NULL;
  58
  59 /********************************************************/
  60
  61 /* passed along to worker thread */
  62 typedef struct {
  63   acq_dialog_widgets_t *w;
  64   gchar *cmd;
  65   gchar *extra;
  66 } w_and_interface_t;
  67
  68
  69 /*********************************************************
  70  * Definitions and routines for acquiring data from Data Sources in general
  71  *********************************************************/
  72
  73 static void progress_func ( BabelProgressCode c, gpointer data, acq_dialog_widgets_t *w )
  74 {
  75   gdk_threads_enter ();
  76   if (!w->ok) {
  77     if ( w->source_interface->cleanup_func )
  78       w->source_interface->cleanup_func( w->user_data );
  79     g_free ( w );
  80     gdk_threads_leave();
  81     g_thread_exit ( NULL );
  82   }
  83   gdk_threads_leave ();
  84
  85   if ( w->source_interface->progress_func )
  86     w->source_interface->progress_func ( c, data, w );
  87 }
  88
  89
  90 /* this routine is the worker thread.  there is only one simultaneous download allowed */
  91 static void get_from_anything ( w_and_interface_t *wi )
  92 {
  93   gchar *cmd = wi->cmd;
  94   gchar *extra = wi->extra;
  95   gboolean result = TRUE;
  96   VikTrwLayer *vtl = NULL;
  97
  98   gboolean creating_new_layer = TRUE;
  99
 100   acq_dialog_widgets_t *w = wi->w;
 101   VikDataSourceInterface *source_interface = wi->w->source_interface;
 102   g_free ( wi );
 103   wi = NULL;
 104
 105   gdk_threads_enter();
 106   if (source_interface->mode == VIK_DATASOURCE_ADDTOLAYER) {
 107     VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
 108     if ( IS_VIK_TRW_LAYER(current_selected) ) {
 109       vtl = VIK_TRW_LAYER(current_selected);
 110       creating_new_layer = FALSE;
 111     }
 112   }
 113   if ( creating_new_layer ) {
 114     vtl = VIK_TRW_LAYER ( vik_layer_create ( VIK_LAYER_TRW, w->vvp, NULL, FALSE ) );
 115     vik_layer_rename ( VIK_LAYER ( vtl ), _(source_interface->layer_title) );
 116     gtk_label_set_text ( GTK_LABEL(w->status), _("Working...") );
 117   }
 118   gdk_threads_leave();
 119
 120   if ( source_interface->process_func )
 121     result = source_interface->process_func ( vtl, cmd, extra, (BabelStatusFunc) progress_func, w );
 122
 123   g_free ( cmd );
 124   g_free ( extra );
 125
 126   if (!result) {
 127     gdk_threads_enter();
 128     gtk_label_set_text ( GTK_LABEL(w->status), _("Error: acquisition failed.") );
 129     if ( creating_new_layer )
 130       g_object_unref ( G_OBJECT ( vtl ) );
 131     gdk_threads_leave();
 132   }
 133   else {
 134     gdk_threads_enter();
 135     if (w->ok) {
 136       gtk_label_set_text ( GTK_LABEL(w->status), _("Done.") );
 137       if ( creating_new_layer ) {
 138         /* Only create the layer if it actually contains anything useful */
 139         // TODO: create function for this operation to hide detail:
 140         if ( g_hash_table_size (vik_trw_layer_get_tracks(vtl)) ||
 141              g_hash_table_size (vik_trw_layer_get_waypoints(vtl)) ||
 142              g_hash_table_size (vik_trw_layer_get_routes(vtl)) ) {
 143           vik_layer_post_read ( VIK_LAYER(vtl), w->vvp, TRUE );
 144           vik_aggregate_layer_add_layer( vik_layers_panel_get_top_layer(w->vlp), VIK_LAYER(vtl));
 145         }
 146         else
 147           gtk_label_set_text ( GTK_LABEL(w->status), _("No data.") );
 148       }
 149       /* View this data if available and is desired */
 150       if ( vtl && source_interface->autoview ) {
 151         vik_trw_layer_auto_set_view ( vtl, vik_layers_panel_get_viewport(w->vlp) );
 152         vik_layers_panel_emit_update (w->vlp);
 153       }
 154       if ( source_interface->keep_dialog_open ) {
 155         gtk_dialog_set_response_sensitive ( GTK_DIALOG(w->dialog), GTK_RESPONSE_ACCEPT, TRUE );
 156         gtk_dialog_set_response_sensitive ( GTK_DIALOG(w->dialog), GTK_RESPONSE_REJECT, FALSE );
 157       } else {
 158         gtk_dialog_response ( GTK_DIALOG(w->dialog), GTK_RESPONSE_ACCEPT );
 159       }
 160     } else {
 161       /* canceled */
 162       if ( creating_new_layer )
 163         g_object_unref(vtl);
 164     }
 165   }
 166   if ( source_interface->cleanup_func )
 167     source_interface->cleanup_func ( w->user_data );
 168
 169   if ( w->ok ) {
 170     w->ok = FALSE;
 171   } else {
 172     g_free ( w );
 173   }
 174
 175   gdk_threads_leave();
 176   g_thread_exit ( NULL );
 177 }
 178
 179
 180 static gchar *write_tmp_trwlayer ( VikTrwLayer *vtl )
 181 {
 182   int fd_src;
 183   gchar *name_src;
 184   FILE *f;
 185   g_assert ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0);
 186   g_debug ("%s: temporary file: %s", __FUNCTION__, name_src);
 187   f = fdopen(fd_src, "w");
 188   a_gpx_write_file(vtl, f, NULL);
 189   fclose(f);
 190   f = NULL;
 191   return name_src;
 192 }
 193
 194 /* TODO: write with name of old track */
 195 static gchar *write_tmp_track ( VikTrack *track )
 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_track_file(track, f, NULL); /* Thank you Guilhem! Just when I needed this function... -- Evan */
 204   fclose(f);
 205   f = NULL;
 206   return name_src;
 207 }
 208
 209 /* TODO: cleanup, getr rid of redundancy */
 210
 211 /* depending on type of filter, often only vtl or track will be given.
 212  * the other can be NULL.
 213  */
 214 static void acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface,
 215                       VikTrwLayer *vtl, VikTrack *track )
 216 {
 217   /* for manual dialogs */
 218   GtkWidget *dialog = NULL;
 219   GtkWidget *status;
 220   gchar *cmd = NULL;
 221   gchar *extra = NULL;
 222   gchar *cmd_off = NULL;
 223   gchar *extra_off = NULL;
 224   acq_dialog_widgets_t *w;
 225   gpointer user_data;
 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 );
 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   /*** LET'S DO IT! ***/
 329
 330   if ( ! cmd )
 331     return;
 332
 333   w = g_malloc(sizeof(*w));
 334   wi = g_malloc(sizeof(*wi));
 335   wi->w = w;
 336   wi->w->source_interface = source_interface;
 337   wi->cmd = cmd;
 338   wi->extra = extra; /* usually input data type (?) */
 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
 345   w->dialog = dialog;
 346   w->ok = TRUE;
 347   status = gtk_label_new (_("Status: detecting gpsbabel"));
 348   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), status, FALSE, FALSE, 5 );
 349   gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
 350   gtk_widget_show_all(status);
 351   w->status = status;
 352
 353   w->vw = vw;
 354   w->vlp = vlp;
 355   w->vvp = vvp;
 356   if ( source_interface->add_progress_widgets_func ) {
 357     source_interface->add_progress_widgets_func ( dialog, user_data );
 358   }
 359   w->user_data = user_data;
 360
 361
 362   g_thread_create((GThreadFunc)get_from_anything, wi, FALSE, NULL );
 363
 364   gtk_dialog_run ( GTK_DIALOG(dialog) );
 365   if ( w->ok )
 366     w->ok = FALSE; /* tell thread to stop. TODO: add mutex */
 367   else {
 368     if ( cmd_off ) {
 369       /* Turn off */
 370       a_babel_convert_from (NULL, cmd_off, extra_off, NULL, NULL);
 371     }
 372     g_free ( w ); /* thread has finished; free w */
 373   }
 374   gtk_widget_destroy ( dialog );
 375 }
 376
 377 /**
 378  * a_acquire:
 379  *
 380  * Process the given VikDataSourceInterface for sources with no input data.
 381  */
 382 void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface ) {
 383   acquire ( vw, vlp, vvp, source_interface, NULL, NULL );
 384 }
 385
 386 static void acquire_trwlayer_callback ( GObject *menuitem, gpointer *pass_along )
 387 {
 388   VikDataSourceInterface *iface = g_object_get_data ( menuitem, "vik_acq_iface" );
 389   VikWindow *vw =       pass_along[0];
 390   VikLayersPanel *vlp = pass_along[1];
 391   VikViewport *vvp =    pass_along[2];
 392   VikTrwLayer *vtl =    pass_along[3];
 393   VikTrack *tr =        pass_along[4];
 394
 395   acquire ( vw, vlp, vvp, iface, vtl, tr );
 396 }
 397
 398 static GtkWidget *acquire_build_menu ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp,
 399                                 VikTrwLayer *vtl, VikTrack *track, /* both passed to acquire, although for many filters only one ness */
 400                                 const gchar *menu_title, vik_datasource_inputtype_t inputtype )
 401 {
 402   static gpointer pass_along[5];
 403   GtkWidget *menu_item=NULL, *menu=NULL;
 404   GtkWidget *item=NULL;
 405   int i;
 406
 407   pass_along[0] = vw;
 408   pass_along[1] = vlp;
 409   pass_along[2] = vvp;
 410   pass_along[3] = vtl;
 411   pass_along[4] = track;
 412
 413   for ( i = 0; i < N_FILTERS; i++ ) {
 414     if ( filters[i]->inputtype == inputtype ) {
 415       if ( ! menu_item ) { /* do this just once, but return NULL if no filters */
 416         menu = gtk_menu_new();
 417         menu_item = gtk_menu_item_new_with_mnemonic ( menu_title );
 418         gtk_menu_item_set_submenu (GTK_MENU_ITEM (menu_item), menu );
 419       }
 420
 421       item = gtk_menu_item_new_with_label ( filters[i]->window_title );
 422       g_object_set_data ( G_OBJECT(item), "vik_acq_iface", (gpointer) filters[i] );
 423       g_signal_connect ( G_OBJECT(item), "activate", G_CALLBACK(acquire_trwlayer_callback), pass_along );
 424       gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
 425       gtk_widget_show ( item );
 426     }
 427   }
 428
 429   return menu_item;
 430 }
 431
 432 /**
 433  * a_acquire_trwlayer_menu:
 434  *
 435  * Create a sub menu intended for rightclicking on a TRWLayer's menu called "Filter".
 436  *
 437  * Returns: %NULL if no filters.
 438  */
 439 GtkWidget *a_acquire_trwlayer_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
 440 {
 441   return acquire_build_menu ( vw, vlp, vvp, vtl, NULL, _("_Filter"), VIK_DATASOURCE_INPUTTYPE_TRWLAYER );
 442 }
 443
 444 /**
 445  * a_acquire_trwlayer_track_menu:
 446  *
 447  * Create a sub menu intended for rightclicking on a TRWLayer's menu called "Filter with Track "TRACKNAME"...".
 448  *
 449  * Returns: %NULL if no filters or no filter track has been set.
 450  */
 451 GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
 452 {
 453   if ( filter_track == NULL )
 454     return NULL;
 455   else {
 456     gchar *menu_title = g_strdup_printf ( _("Filter with %s"), filter_track->name );
 457     GtkWidget *rv = acquire_build_menu ( vw, vlp, vvp, vtl, filter_track,
 458                         menu_title, VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK );
 459     g_free ( menu_title );
 460     return rv;
 461   }
 462 }
 463
 464 /**
 465  * a_acquire_track_menu:
 466  *
 467  * Create a sub menu intended for rightclicking on a track's menu called "Filter".
 468  *
 469  * Returns: %NULL if no applicable filters
 470  */
 471 GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr)
 472 {
 473   return acquire_build_menu ( vw, vlp, vvp, NULL, tr, _("Filter"), VIK_DATASOURCE_INPUTTYPE_TRACK );
 474 }
 475
 476 /**
 477  * a_acquire_set_filter_track:
 478  *
 479  * Sets application-wide track to use with filter. references the track.
 480  */
 481 void a_acquire_set_filter_track ( VikTrack *tr )
 482 {
 483   if ( filter_track )
 484     vik_track_free ( filter_track );
 485
 486   filter_track = tr;
 487   vik_track_ref ( tr );
 488 }