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 // extern VikDataSourceInterface vik_datasource_google_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 gchar *filter_track_name = NULL;
  60
  61 /********************************************************/
  62
  63 /* passed along to worker thread */
  64 typedef struct {
  65   acq_dialog_widgets_t *w;
  66   gchar *cmd;
  67   gchar *extra;
  68 } w_and_interface_t;
  69
  70
  71 /*********************************************************
  72  * Definitions and routines for acquiring data from Data Sources in general
  73  *********************************************************/
  74
  75 static void progress_func ( BabelProgressCode c, gpointer data, acq_dialog_widgets_t *w )
  76 {
  77   gdk_threads_enter ();
  78   if (!w->ok) {
  79     if ( w->source_interface->cleanup_func )
  80       w->source_interface->cleanup_func( w->user_data );
  81     g_free ( w );
  82     gdk_threads_leave();
  83     g_thread_exit ( NULL );
  84   }
  85   gdk_threads_leave ();
  86
  87   if ( w->source_interface->progress_func )
  88     w->source_interface->progress_func ( (gpointer) c, data, w );
  89 }
  90
  91
  92 /* this routine is the worker thread.  there is only one simultaneous download allowed */
  93 static void get_from_anything ( w_and_interface_t *wi )
  94 {
  95   gchar *cmd = wi->cmd;
  96   gchar *extra = wi->extra;
  97   gboolean result = TRUE;
  98   VikTrwLayer *vtl = NULL;
  99
 100   gboolean creating_new_layer = TRUE;
 101
 102   acq_dialog_widgets_t *w = wi->w;
 103   VikDataSourceInterface *source_interface = wi->w->source_interface;
 104   g_free ( wi );
 105   wi = NULL;
 106
 107   gdk_threads_enter();
 108   if (source_interface->mode == VIK_DATASOURCE_ADDTOLAYER) {
 109     VikLayer *current_selected = vik_layers_panel_get_selected ( w->vlp );
 110     if ( IS_VIK_TRW_LAYER(current_selected) ) {
 111       vtl = VIK_TRW_LAYER(current_selected);
 112       creating_new_layer = FALSE;
 113     }
 114   }
 115   if ( creating_new_layer ) {
 116     vtl = VIK_TRW_LAYER ( vik_layer_create ( VIK_LAYER_TRW, w->vvp, NULL, FALSE ) );
 117     vik_layer_rename ( VIK_LAYER ( vtl ), _(source_interface->layer_title) );
 118     gtk_label_set_text ( GTK_LABEL(w->status), _("Working...") );
 119   }
 120   gdk_threads_leave();
 121
 122   // TODO consider removing 'type' and make everything run via the specficied process function
 123   switch ( source_interface->type ) {
 124   case VIK_DATASOURCE_GPSBABEL_DIRECT:
 125     result = a_babel_convert_from (vtl, cmd, (BabelStatusFunc) progress_func, extra, w);
 126     break;
 127   case VIK_DATASOURCE_URL:
 128     result = a_babel_convert_from_url (vtl, cmd, extra, (BabelStatusFunc) progress_func, w);
 129     break;
 130   case VIK_DATASOURCE_SHELL_CMD:
 131     result = a_babel_convert_from_shellcommand ( vtl, cmd, extra, (BabelStatusFunc) progress_func, w);
 132     break;
 133   case VIK_DATASOURCE_INTERNAL:
 134     if ( source_interface->process_func )
 135       result = source_interface->process_func ( vtl, cmd, extra, (BabelStatusFunc) progress_func, w );
 136     break;
 137   default:
 138     g_critical("Houston, we've had a problem.");
 139   }
 140
 141   g_free ( cmd );
 142   g_free ( extra );
 143
 144   if (!result) {
 145     gdk_threads_enter();
 146     gtk_label_set_text ( GTK_LABEL(w->status), _("Error: acquisition failed.") );
 147     if ( creating_new_layer )
 148       g_object_unref ( G_OBJECT ( vtl ) );
 149     gdk_threads_leave();
 150   }
 151   else {
 152     gdk_threads_enter();
 153     if (w->ok) {
 154       gtk_label_set_text ( GTK_LABEL(w->status), _("Done.") );
 155       if ( creating_new_layer ) {
 156         /* Only create the layer if it actually contains anything useful */
 157         if ( g_hash_table_size (vik_trw_layer_get_tracks(vtl)) ||
 158              g_hash_table_size (vik_trw_layer_get_waypoints(vtl)) )
 159           vik_aggregate_layer_add_layer( vik_layers_panel_get_top_layer(w->vlp), VIK_LAYER(vtl));
 160         else
 161           gtk_label_set_text ( GTK_LABEL(w->status), _("No data.") );
 162       }
 163       /* View this data if available and is desired */
 164       if ( vtl && source_interface->autoview ) {
 165         vik_trw_layer_auto_set_view ( vtl, vik_layers_panel_get_viewport(w->vlp) );
 166         vik_layers_panel_emit_update (w->vlp);
 167       }
 168       if ( source_interface->keep_dialog_open ) {
 169         gtk_dialog_set_response_sensitive ( GTK_DIALOG(w->dialog), GTK_RESPONSE_ACCEPT, TRUE );
 170         gtk_dialog_set_response_sensitive ( GTK_DIALOG(w->dialog), GTK_RESPONSE_REJECT, FALSE );
 171       } else {
 172         gtk_dialog_response ( GTK_DIALOG(w->dialog), GTK_RESPONSE_ACCEPT );
 173       }
 174     } else {
 175       /* canceled */
 176       if ( creating_new_layer )
 177         g_object_unref(vtl);
 178     }
 179   }
 180   if ( source_interface->cleanup_func )
 181     source_interface->cleanup_func ( w->user_data );
 182
 183   if ( w->ok ) {
 184     w->ok = FALSE;
 185   } else {
 186     g_free ( w );
 187   }
 188
 189   gdk_threads_leave();
 190   g_thread_exit ( NULL );
 191 }
 192
 193
 194 static gchar *write_tmp_trwlayer ( VikTrwLayer *vtl )
 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   f = fdopen(fd_src, "w");
 201   a_gpx_write_file(vtl, f);
 202   fclose(f);
 203   f = NULL;
 204   return name_src;
 205 }
 206
 207 /* TODO: write with name of old track */
 208 static gchar *write_tmp_track ( VikTrack *track )
 209 {
 210   int fd_src;
 211   gchar *name_src;
 212   FILE *f;
 213   g_assert ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0);
 214   f = fdopen(fd_src, "w");
 215   a_gpx_write_track_file("track", track, f); /* Thank you Guilhem! Just when I needed this function... -- Evan */
 216   fclose(f);
 217   f = NULL;
 218   return name_src;
 219 }
 220
 221 /* TODO: cleanup, getr rid of redundancy */
 222
 223 /* depending on type of filter, often only vtl or track will be given.
 224  * the other can be NULL.
 225  */
 226 static void acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface,
 227                       VikTrwLayer *vtl, VikTrack *track )
 228 {
 229   /* for manual dialogs */
 230   GtkWidget *dialog = NULL;
 231   GtkWidget *status;
 232   gchar *cmd = NULL;
 233   gchar *extra = NULL;
 234   gchar *cmd_off = NULL;
 235   gchar *extra_off = NULL;
 236   acq_dialog_widgets_t *w;
 237   gpointer user_data;
 238
 239   /* for UI builder */
 240   gpointer pass_along_data;
 241   VikLayerParamData *paramdatas = NULL;
 242
 243   w_and_interface_t *wi;
 244
 245   /*** INIT AND CHECK EXISTENCE ***/
 246   if ( source_interface->init_func )
 247     user_data = source_interface->init_func();
 248   else
 249     user_data = NULL;
 250   pass_along_data = user_data;
 251
 252   if ( source_interface->check_existence_func ) {
 253     gchar *error_str = source_interface->check_existence_func();
 254     if ( error_str ) {
 255       a_dialog_error_msg ( GTK_WINDOW(vw), error_str );
 256       g_free ( error_str );
 257       return;
 258     }
 259   }
 260
 261   /* BUILD UI & GET OPTIONS IF NECESSARY. */
 262
 263   /* POSSIBILITY 0: NO OPTIONS. DO NOTHING HERE. */
 264   /* POSSIBILITY 1: ADD_SETUP_WIDGETS_FUNC */
 265   if ( source_interface->add_setup_widgets_func ) {
 266     dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
 267
 268     gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
 269     GtkWidget *response_w = NULL;
 270 #if GTK_CHECK_VERSION (2, 20, 0)
 271     response_w = gtk_dialog_get_widget_for_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
 272 #endif
 273
 274     source_interface->add_setup_widgets_func(dialog, vvp, user_data);
 275     gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
 276
 277     if ( response_w )
 278       gtk_widget_grab_focus ( response_w );
 279
 280     if ( gtk_dialog_run ( GTK_DIALOG(dialog) ) != GTK_RESPONSE_ACCEPT ) {
 281       source_interface->cleanup_func(user_data);
 282       gtk_widget_destroy(dialog);
 283       return;
 284     }
 285   }
 286   /* POSSIBILITY 2: UI BUILDER */
 287   else if ( source_interface->params ) {
 288     paramdatas = a_uibuilder_run_dialog ( source_interface->window_title, GTK_WINDOW(vw),
 289                         source_interface->params, source_interface->params_count,
 290                         source_interface->params_groups, source_interface->params_groups_count,
 291                         source_interface->params_defaults );
 292     if ( paramdatas )
 293       pass_along_data = paramdatas;
 294     else
 295       return; /* TODO: do we have to free anything here? */
 296   }
 297
 298   /* CREATE INPUT DATA & GET COMMAND STRING */
 299
 300   if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER ) {
 301     gchar *name_src = write_tmp_trwlayer ( vtl );
 302
 303     ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
 304         ( pass_along_data, &cmd, &extra, name_src );
 305
 306     g_free ( name_src );
 307     /* TODO: delete the tmp file? or delete it only after we're done with it? */
 308   } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK ) {
 309     gchar *name_src = write_tmp_trwlayer ( vtl );
 310     gchar *name_src_track = write_tmp_track ( track );
 311
 312     ((VikDataSourceGetCmdStringFuncWithInputInput) source_interface->get_cmd_string_func)
 313         ( pass_along_data, &cmd, &extra, name_src, name_src_track );
 314
 315     g_free ( name_src );
 316     g_free ( name_src_track );
 317   } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRACK ) {
 318     gchar *name_src_track = write_tmp_track ( track );
 319
 320     ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
 321         ( pass_along_data, &cmd, &extra, name_src_track );
 322
 323     g_free ( name_src_track );
 324   } else if ( source_interface->get_cmd_string_func )
 325       source_interface->get_cmd_string_func ( pass_along_data, &cmd, &extra );
 326
 327   /* Get data for Off command */
 328   if ( source_interface->off_func ) {
 329     source_interface->off_func ( pass_along_data, &cmd_off, &extra_off );
 330   }
 331
 332   /* cleanup for option dialogs */
 333   if ( source_interface->add_setup_widgets_func ) {
 334     gtk_widget_destroy(dialog);
 335     dialog = NULL;
 336   } else if ( source_interface->params ) {
 337     a_uibuilder_free_paramdatas ( paramdatas, source_interface->params, source_interface->params_count );
 338   }
 339
 340   /*** LET'S DO IT! ***/
 341
 342   if ( ! cmd )
 343     return;
 344
 345   w = g_malloc(sizeof(*w));
 346   wi = g_malloc(sizeof(*wi));
 347   wi->w = w;
 348   wi->w->source_interface = source_interface;
 349   wi->cmd = cmd;
 350   wi->extra = extra; /* usually input data type (?) */
 351
 352   dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
 353   gtk_dialog_set_response_sensitive ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT, FALSE );
 354   gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
 355
 356
 357   w->dialog = dialog;
 358   w->ok = TRUE;
 359   status = gtk_label_new (_("Status: detecting gpsbabel"));
 360   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), status, FALSE, FALSE, 5 );
 361   gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
 362   gtk_widget_show_all(status);
 363   w->status = status;
 364
 365   w->vw = vw;
 366   w->vlp = vlp;
 367   w->vvp = vvp;
 368   if ( source_interface->add_progress_widgets_func ) {
 369     source_interface->add_progress_widgets_func ( dialog, user_data );
 370   }
 371   w->user_data = user_data;
 372
 373
 374   g_thread_create((GThreadFunc)get_from_anything, wi, FALSE, NULL );
 375
 376   gtk_dialog_run ( GTK_DIALOG(dialog) );
 377   if ( w->ok )
 378     w->ok = FALSE; /* tell thread to stop. TODO: add mutex */
 379   else {
 380     if ( cmd_off ) {
 381       /* Turn off */
 382       a_babel_convert_from (NULL, cmd_off, NULL, extra_off, NULL);
 383     }
 384     g_free ( w ); /* thread has finished; free w */
 385   }
 386   gtk_widget_destroy ( dialog );
 387 }
 388
 389 void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface ) {
 390   acquire ( vw, vlp, vvp, source_interface, NULL, NULL );
 391 }
 392
 393 static void acquire_trwlayer_callback ( GObject *menuitem, gpointer *pass_along )
 394 {
 395   VikDataSourceInterface *iface = g_object_get_data ( menuitem, "vik_acq_iface" );
 396   VikWindow *vw =       pass_along[0];
 397   VikLayersPanel *vlp = pass_along[1];
 398   VikViewport *vvp =    pass_along[2];
 399   VikTrwLayer *vtl =    pass_along[3];
 400   VikTrack *tr =        pass_along[4];
 401
 402   acquire ( vw, vlp, vvp, iface, vtl, tr );
 403 }
 404
 405 static GtkWidget *acquire_build_menu ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp,
 406                                 VikTrwLayer *vtl, VikTrack *track, /* both passed to acquire, although for many filters only one ness */
 407                                 const gchar *menu_title, vik_datasource_inputtype_t inputtype )
 408 {
 409   static gpointer pass_along[5];
 410   GtkWidget *menu_item=NULL, *menu=NULL;
 411   GtkWidget *item=NULL;
 412   int i;
 413
 414   pass_along[0] = vw;
 415   pass_along[1] = vlp;
 416   pass_along[2] = vvp;
 417   pass_along[3] = vtl;
 418   pass_along[4] = track;
 419
 420   for ( i = 0; i < N_FILTERS; i++ ) {
 421     if ( filters[i]->inputtype == inputtype ) {
 422       if ( ! menu_item ) { /* do this just once, but return NULL if no filters */
 423         menu = gtk_menu_new();
 424         menu_item = gtk_menu_item_new_with_mnemonic ( menu_title );
 425         gtk_menu_item_set_submenu (GTK_MENU_ITEM (menu_item), menu );
 426       }
 427
 428       item = gtk_menu_item_new_with_label ( filters[i]->window_title );
 429       g_object_set_data ( G_OBJECT(item), "vik_acq_iface", (gpointer) filters[i] );
 430       g_signal_connect ( G_OBJECT(item), "activate", G_CALLBACK(acquire_trwlayer_callback), pass_along );
 431       gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
 432       gtk_widget_show ( item );
 433     }
 434   }
 435
 436   return menu_item;
 437 }
 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 GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
 445 {
 446   if ( filter_track == NULL )
 447     return NULL;
 448   else {
 449     gchar *menu_title = g_strdup_printf ( "Filter with %s", filter_track_name );
 450     GtkWidget *rv = acquire_build_menu ( vw, vlp, vvp, vtl, filter_track,
 451                         menu_title, VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK );
 452     g_free ( menu_title );
 453     return rv;
 454   }
 455 }
 456
 457 GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr)
 458 {
 459   return acquire_build_menu ( vw, vlp, vvp, NULL, tr, "Filter", VIK_DATASOURCE_INPUTTYPE_TRACK );
 460 }
 461
 462 void a_acquire_set_filter_track ( VikTrack *tr, const gchar *name )
 463 {
 464   if ( filter_track )
 465     vik_track_free ( filter_track );
 466   if ( filter_track_name )
 467     g_free ( filter_track_name );
 468
 469   filter_track = tr;
 470   vik_track_ref ( tr );
 471
 472   filter_track_name = g_strdup(name);
 473 }