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