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;
  98   VikTrwLayer *vtl;
  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   switch ( source_interface->type ) {
 123   case VIK_DATASOURCE_GPSBABEL_DIRECT:
 124     result = a_babel_convert_from (vtl, cmd, (BabelStatusFunc) progress_func, extra, w);
 125     break;
 126   case VIK_DATASOURCE_URL:
 127     result = a_babel_convert_from_url (vtl, cmd, extra, (BabelStatusFunc) progress_func, w);
 128     break;
 129   case VIK_DATASOURCE_SHELL_CMD:
 130     result = a_babel_convert_from_shellcommand ( vtl, cmd, extra, (BabelStatusFunc) progress_func, w);
 131     break;
 132   default:
 133     g_critical("Houston, we've had a problem.");
 134   }
 135
 136   g_free ( cmd );
 137   g_free ( extra );
 138
 139   if (!result) {
 140     gdk_threads_enter();
 141     gtk_label_set_text ( GTK_LABEL(w->status), _("Error: acquisition failed.") );
 142     if ( creating_new_layer )
 143       g_object_unref ( G_OBJECT ( vtl ) );
 144     gdk_threads_leave();
 145   }
 146   else {
 147     gdk_threads_enter();
 148     if (w->ok) {
 149       gtk_label_set_text ( GTK_LABEL(w->status), _("Done.") );
 150       if ( creating_new_layer )
 151         vik_aggregate_layer_add_layer( vik_layers_panel_get_top_layer(w->vlp), VIK_LAYER(vtl));
 152       if ( source_interface->keep_dialog_open ) {
 153         gtk_dialog_set_response_sensitive ( GTK_DIALOG(w->dialog), GTK_RESPONSE_ACCEPT, TRUE );
 154         gtk_dialog_set_response_sensitive ( GTK_DIALOG(w->dialog), GTK_RESPONSE_REJECT, FALSE );
 155       } else {
 156         gtk_dialog_response ( GTK_DIALOG(w->dialog), GTK_RESPONSE_ACCEPT );
 157       }
 158     } else {
 159       /* canceled */
 160       if ( creating_new_layer )
 161         g_object_unref(vtl);
 162     }
 163   }
 164   if ( source_interface->cleanup_func )
 165     source_interface->cleanup_func ( w->user_data );
 166
 167   if ( w->ok ) {
 168     w->ok = FALSE;
 169   } else {
 170     g_free ( w );
 171   }
 172
 173   gdk_threads_leave();
 174   g_thread_exit ( NULL );
 175 }
 176
 177
 178 static gchar *write_tmp_trwlayer ( VikTrwLayer *vtl )
 179 {
 180   int fd_src;
 181   gchar *name_src;
 182   FILE *f;
 183   g_assert ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0);
 184   f = fdopen(fd_src, "w");
 185   a_gpx_write_file(vtl, f);
 186   fclose(f);
 187   f = NULL;
 188   return name_src;
 189 }
 190
 191 /* TODO: write with name of old track */
 192 static gchar *write_tmp_track ( VikTrack *track )
 193 {
 194   int fd_src;
 195   gchar *name_src;
 196   FILE *f;
 197   g_assert ((fd_src = g_file_open_tmp("tmp-viking.XXXXXX", &name_src, NULL)) >= 0);
 198   f = fdopen(fd_src, "w");
 199   a_gpx_write_track_file("track", track, f); /* 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, *extra;
 217   acq_dialog_widgets_t *w;
 218   gpointer user_data;
 219
 220   /* for UI builder */
 221   gpointer pass_along_data;
 222   VikLayerParamData *paramdatas = NULL;
 223
 224   w_and_interface_t *wi;
 225
 226   /*** INIT AND CHECK EXISTENCE ***/
 227   if ( source_interface->init_func )
 228     user_data = source_interface->init_func();
 229   else
 230     user_data = NULL;
 231   pass_along_data = user_data;
 232
 233   if ( source_interface->check_existence_func ) {
 234     gchar *error_str = source_interface->check_existence_func();
 235     if ( error_str ) {
 236       a_dialog_error_msg ( GTK_WINDOW(vw), error_str );
 237       g_free ( error_str );
 238       return;
 239     }
 240   }
 241
 242   /* BUILD UI & GET OPTIONS IF NECESSARY. */
 243
 244   /* POSSIBILITY 0: NO OPTIONS. DO NOTHING HERE. */
 245   /* POSSIBILITY 1: ADD_SETUP_WIDGETS_FUNC */
 246   if ( source_interface->add_setup_widgets_func ) {
 247     dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
 248
 249     source_interface->add_setup_widgets_func(dialog, vvp, user_data);
 250     gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
 251
 252     if ( gtk_dialog_run ( GTK_DIALOG(dialog) ) != GTK_RESPONSE_ACCEPT ) {
 253       source_interface->cleanup_func(user_data);
 254       gtk_widget_destroy(dialog);
 255       return;
 256     }
 257   }
 258   /* POSSIBILITY 2: UI BUILDER */
 259   else if ( source_interface->params ) {
 260     paramdatas = a_uibuilder_run_dialog ( GTK_WINDOW(vw),
 261                         source_interface->params, source_interface->params_count,
 262                         source_interface->params_groups, source_interface->params_groups_count,
 263                         source_interface->params_defaults );
 264     if ( paramdatas )
 265       pass_along_data = paramdatas;
 266     else
 267       return; /* TODO: do we have to free anything here? */
 268   }
 269
 270   /* CREATE INPUT DATA & GET COMMAND STRING */
 271
 272   if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER ) {
 273     gchar *name_src = write_tmp_trwlayer ( vtl );
 274
 275     ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
 276         ( pass_along_data, &cmd, &extra, name_src );
 277
 278     g_free ( name_src );
 279     /* TODO: delete the tmp file? or delete it only after we're done with it? */
 280   } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK ) {
 281     gchar *name_src = write_tmp_trwlayer ( vtl );
 282     gchar *name_src_track = write_tmp_track ( track );
 283
 284     ((VikDataSourceGetCmdStringFuncWithInputInput) source_interface->get_cmd_string_func)
 285         ( pass_along_data, &cmd, &extra, name_src, name_src_track );
 286
 287     g_free ( name_src );
 288     g_free ( name_src_track );
 289   } else if ( source_interface->inputtype == VIK_DATASOURCE_INPUTTYPE_TRACK ) {
 290     gchar *name_src_track = write_tmp_track ( track );
 291
 292     ((VikDataSourceGetCmdStringFuncWithInput) source_interface->get_cmd_string_func)
 293         ( pass_along_data, &cmd, &extra, name_src_track );
 294
 295     g_free ( name_src_track );
 296   } else
 297     source_interface->get_cmd_string_func ( pass_along_data, &cmd, &extra );
 298
 299   /* cleanup for option dialogs */
 300   if ( source_interface->add_setup_widgets_func ) {
 301     gtk_widget_destroy(dialog);
 302     dialog = NULL;
 303   } else if ( source_interface->params ) {
 304     a_uibuilder_free_paramdatas ( paramdatas, source_interface->params, source_interface->params_count );
 305   }
 306
 307   /*** LET'S DO IT! ***/
 308
 309   if ( ! cmd )
 310     return;
 311
 312   w = g_malloc(sizeof(*w));
 313   wi = g_malloc(sizeof(*wi));
 314   wi->w = w;
 315   wi->w->source_interface = source_interface;
 316   wi->cmd = cmd;
 317   wi->extra = extra; /* usually input data type (?) */
 318
 319   dialog = gtk_dialog_new_with_buttons ( "", GTK_WINDOW(vw), 0, GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT, NULL );
 320   gtk_dialog_set_response_sensitive ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT, FALSE );
 321   gtk_window_set_title ( GTK_WINDOW(dialog), _(source_interface->window_title) );
 322
 323
 324   w->dialog = dialog;
 325   w->ok = TRUE;
 326   status = gtk_label_new (_("Status: detecting gpsbabel"));
 327   gtk_box_pack_start ( GTK_BOX(GTK_DIALOG(dialog)->vbox), status, FALSE, FALSE, 5 );
 328   gtk_widget_show_all(status);
 329   w->status = status;
 330
 331   w->vw = vw;
 332   w->vlp = vlp;
 333   w->vvp = vvp;
 334   if ( source_interface->add_progress_widgets_func ) {
 335     source_interface->add_progress_widgets_func ( dialog, user_data );
 336   }
 337   w->user_data = user_data;
 338
 339
 340   g_thread_create((GThreadFunc)get_from_anything, wi, FALSE, NULL );
 341
 342   gtk_dialog_run ( GTK_DIALOG(dialog) );
 343   if ( w->ok )
 344     w->ok = FALSE; /* tell thread to stop. TODO: add mutex */
 345   else {
 346     g_free ( w ); /* thread has finished; free w */
 347   }
 348   gtk_widget_destroy ( dialog );
 349 }
 350
 351 void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface ) {
 352   acquire ( vw, vlp, vvp, source_interface, NULL, NULL );
 353 }
 354
 355 static void acquire_trwlayer_callback ( GObject *menuitem, gpointer *pass_along )
 356 {
 357   VikDataSourceInterface *iface = g_object_get_data ( menuitem, "vik_acq_iface" );
 358   VikWindow *vw =       pass_along[0];
 359   VikLayersPanel *vlp = pass_along[1];
 360   VikViewport *vvp =    pass_along[2];
 361   VikTrwLayer *vtl =    pass_along[3];
 362   VikTrack *tr =        pass_along[4];
 363
 364   acquire ( vw, vlp, vvp, iface, vtl, tr );
 365 }
 366
 367 static GtkWidget *acquire_build_menu ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp,
 368                                 VikTrwLayer *vtl, VikTrack *track, /* both passed to acquire, although for many filters only one ness */
 369                                 const gchar *menu_title, vik_datasource_inputtype_t inputtype )
 370 {
 371   static gpointer pass_along[4];
 372   GtkWidget *menu_item=NULL, *menu=NULL;
 373   GtkWidget *item=NULL;
 374   int i;
 375
 376   pass_along[0] = vw;
 377   pass_along[1] = vlp;
 378   pass_along[2] = vvp;
 379   pass_along[3] = vtl;
 380   pass_along[4] = track;
 381
 382   for ( i = 0; i < N_FILTERS; i++ ) {
 383     if ( filters[i]->inputtype == inputtype ) {
 384       if ( ! menu_item ) { /* do this just once, but return NULL if no filters */
 385         menu = gtk_menu_new();
 386         menu_item = gtk_menu_item_new_with_label ( menu_title );
 387         gtk_menu_item_set_submenu (GTK_MENU_ITEM (menu_item), menu );
 388       }
 389
 390       item = gtk_menu_item_new_with_label ( filters[i]->window_title );
 391       g_object_set_data ( G_OBJECT(item), "vik_acq_iface", (gpointer) filters[i] );
 392       g_signal_connect ( G_OBJECT(item), "activate", G_CALLBACK(acquire_trwlayer_callback), pass_along );
 393       gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
 394       gtk_widget_show ( item );
 395     }
 396   }
 397
 398   return menu_item;
 399 }
 400
 401 GtkWidget *a_acquire_trwlayer_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
 402 {
 403   return acquire_build_menu ( vw, vlp, vvp, vtl, NULL, "Filter", VIK_DATASOURCE_INPUTTYPE_TRWLAYER );
 404 }
 405
 406 GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl)
 407 {
 408   if ( filter_track == NULL )
 409     return NULL;
 410   else {
 411     gchar *menu_title = g_strdup_printf ( "Filter with %s", filter_track_name );
 412     GtkWidget *rv = acquire_build_menu ( vw, vlp, vvp, vtl, filter_track,
 413                         menu_title, VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK );
 414     g_free ( menu_title );
 415     return rv;
 416   }
 417 }
 418
 419 GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr)
 420 {
 421   return acquire_build_menu ( vw, vlp, vvp, NULL, tr, "Filter", VIK_DATASOURCE_INPUTTYPE_TRACK );
 422 }
 423
 424 void a_acquire_set_filter_track ( VikTrack *tr, const gchar *name )
 425 {
 426   if ( filter_track )
 427     vik_track_free ( filter_track );
 428   if ( filter_track_name )
 429     g_free ( filter_track_name );
 430
 431   filter_track = tr;
 432   vik_track_ref ( tr );
 433
 434   filter_track_name = g_strdup(name);
 435 }