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