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