X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/c9ee385c638ffa5266b9cc703620939ac03a7c07..00de8de3e9c61db157855abdc793c403ab24ab0e:/src/osm-traces.c diff --git a/src/osm-traces.c b/src/osm-traces.c index 343607e2..33df22c7 100644 --- a/src/osm-traces.c +++ b/src/osm-traces.c @@ -25,9 +25,9 @@ #include #include #include +#include #include -#include #include #include @@ -46,15 +46,18 @@ #define VIKING_OSM_TRACES_PARAMS_GROUP_KEY "osm_traces" #define VIKING_OSM_TRACES_PARAMS_NAMESPACE "osm_traces." +#define VIK_SETTINGS_OSM_TRACE_VIS "osm_trace_visibility" +static gint last_active = -1; + /** * Login to use for OSM uploading. */ -static gchar *user = NULL; +static gchar *osm_user = NULL; /** * Password to use for OSM uploading. */ -static gchar *password = NULL; +static gchar *osm_password = NULL; /** * Mutex to protect auth. token @@ -84,14 +87,15 @@ typedef struct _OsmTracesInfo { gchar *name; gchar *description; gchar *tags; + gboolean anonymize_times; // ATM only available on a single track. const OsmTraceVis_t *vistype; VikTrwLayer *vtl; - gchar *track_name; + VikTrack *trk; } OsmTracesInfo; static VikLayerParam prefs[] = { - { VIKING_OSM_TRACES_PARAMS_NAMESPACE "username", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("OSM username:"), VIK_LAYER_WIDGET_ENTRY }, - { VIKING_OSM_TRACES_PARAMS_NAMESPACE "password", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("OSM password:"), VIK_LAYER_WIDGET_PASSWORD }, + { VIK_LAYER_NUM_TYPES, VIKING_OSM_TRACES_PARAMS_NAMESPACE "username", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("OSM username:"), VIK_LAYER_WIDGET_ENTRY, NULL, NULL, NULL, NULL, NULL, NULL }, + { VIK_LAYER_NUM_TYPES, VIKING_OSM_TRACES_PARAMS_NAMESPACE "password", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("OSM password:"), VIK_LAYER_WIDGET_PASSWORD, NULL, NULL, NULL, NULL, NULL, NULL }, }; /** @@ -104,7 +108,6 @@ static void oti_free(OsmTracesInfo *oti) g_free(oti->name); oti->name = NULL; g_free(oti->description); oti->description = NULL; g_free(oti->tags); oti->tags = NULL; - g_free(oti->track_name); oti->track_name = NULL; g_object_unref(oti->vtl); oti->vtl = NULL; } @@ -122,7 +125,7 @@ static const gchar *get_default_user() return default_user; } -static void set_login(const gchar *user_, const gchar *password_) +void osm_set_login(const gchar *user, const gchar *password) { /* Allocate mutex */ if (login_mutex == NULL) @@ -130,18 +133,18 @@ static void set_login(const gchar *user_, const gchar *password_) login_mutex = g_mutex_new(); } g_mutex_lock(login_mutex); - g_free(user); user = NULL; - g_free(password); password = NULL; - user = g_strdup(user_); - password = g_strdup(password_); + g_free(osm_user); osm_user = NULL; + g_free(osm_password); osm_password = NULL; + osm_user = g_strdup(user); + osm_password = g_strdup(password); g_mutex_unlock(login_mutex); } -static gchar *get_login() +gchar *osm_get_login() { gchar *user_pass = NULL; g_mutex_lock(login_mutex); - user_pass = g_strdup_printf("%s:%s", user, password); + user_pass = g_strdup_printf("%s:%s", osm_user, osm_password); g_mutex_unlock(login_mutex); return user_pass; } @@ -149,7 +152,7 @@ static gchar *get_login() /* initialisation */ void osm_traces_init () { /* Preferences */ - a_preferences_register_group ( VIKING_OSM_TRACES_PARAMS_GROUP_KEY, "OpenStreetMap traces" ); + a_preferences_register_group ( VIKING_OSM_TRACES_PARAMS_GROUP_KEY, _("OpenStreetMap Traces") ); VikLayerParamData tmp; tmp.s = ""; @@ -161,14 +164,18 @@ void osm_traces_init () { /* * Upload a file - */ -void osm_traces_upload_file(const char *user, - const char *password, - const char *file, - const char *filename, - const char *description, - const char *tags, - const OsmTraceVis_t *vistype) + * returns a basic status: + * < 0 : curl error + * == 0 : OK + * > 0 : HTTP error + */ +static gint osm_traces_upload_file(const char *user, + const char *password, + const char *file, + const char *filename, + const char *description, + const char *tags, + const OsmTraceVis_t *vistype) { CURL *curl; CURLcode res; @@ -179,7 +186,9 @@ void osm_traces_upload_file(const char *user, char *base_url = "http://www.openstreetmap.org/api/0.6/gpx/create"; - gchar *user_pass = get_login(); + gchar *user_pass = osm_get_login(); + + gint result = 0; // Default to it worked! g_debug("%s: %s %s %s %s %s %s", __FUNCTION__, user, password, file, filename, description, tags); @@ -225,22 +234,27 @@ void osm_traces_upload_file(const char *user, if (res == CURLE_OK) { g_debug("received valid curl response: %ld", code); - if (code != 200) + if (code != 200) { g_warning(_("failed to upload data: HTTP response is %ld"), code); + result = code; + } } - else - g_error(_("curl_easy_getinfo failed: %d"), res); - } - else - { - g_warning(_("curl request failed: %s"), curl_error_buffer); + else { + g_critical(_("curl_easy_getinfo failed: %d"), res); + result = -1; } + } + else { + g_warning(_("curl request failed: %s"), curl_error_buffer); + result = -2; + } /* Memory */ g_free(user_pass); user_pass = NULL; curl_formfree(post); - curl_easy_cleanup(curl); + curl_easy_cleanup(curl); + return result; } /** @@ -248,64 +262,118 @@ void osm_traces_upload_file(const char *user, */ static void osm_traces_upload_thread ( OsmTracesInfo *oti, gpointer threaddata ) { - /* Due to OSM limits, we have to enforce ele and time fields */ - static GpxWritingOptions options = { TRUE, TRUE }; - FILE *file = NULL; - gchar *filename = NULL; - int fd; - GError *error = NULL; - int ret; + /* Due to OSM limits, we have to enforce ele and time fields + also don't upload invisible tracks */ + static GpxWritingOptions options = { TRUE, TRUE, FALSE, FALSE }; - g_assert(oti != NULL); - - /* Opening temporary file */ - fd = g_file_open_tmp("viking_osm_upload_XXXXXX.gpx", &filename, &error); - if (fd < 0) { - g_error(_("failed to open temporary file: %s"), strerror(errno)); + if (!oti) return; - } - g_clear_error(&error); - g_debug("%s: temporary file = %s", __FUNCTION__, filename); - /* Creating FILE* */ - file = fdopen(fd, "w"); + gchar *filename = NULL; /* writing gpx file */ - if (oti->track_name != NULL) + if (oti->trk != NULL) { /* Upload only the selected track */ - VikTrack *track = vik_trw_layer_get_track(oti->vtl, oti->track_name); - a_gpx_write_track_file_options(&options, oti->track_name, track, file); + if ( oti->anonymize_times ) + { + VikTrack *trk = vik_track_copy(oti->trk, TRUE); + vik_track_anonymize_times(trk); + filename = a_gpx_write_track_tmp_file(trk, &options); + vik_track_free(trk); + } + else + filename = a_gpx_write_track_tmp_file (oti->trk, &options); } else { /* Upload the whole VikTrwLayer */ - a_gpx_write_file_options(&options, oti->vtl, file); + filename = a_gpx_write_tmp_file (oti->vtl, &options); } - /* We can close the file */ - /* This also close the associated fd */ - fclose(file); - file = NULL; + if ( !filename ) + return; /* finally, upload it */ - osm_traces_upload_file(user, password, filename, - oti->name, oti->description, oti->tags, oti->vistype); - + gint ans = osm_traces_upload_file(osm_user, osm_password, filename, + oti->name, oti->description, oti->tags, oti->vistype); + + // + // Show result in statusbar or failure in dialog for user feedback + // + + // Get current time to put into message to show when result was generated + // since need to show difference between operations (when displayed on statusbar) + // NB If on dialog then don't need time. + time_t timenow; + struct tm* timeinfo; + time ( &timenow ); + timeinfo = localtime ( &timenow ); + gchar timestr[80]; + // Compact time only - as days/date isn't very useful here + strftime ( timestr, sizeof(timestr), "%X)", timeinfo ); + + // + // Test to see if window it was invoked on is still valid + // Not sure if this test really works! (i.e. if the window was closed in the mean time) + // + if ( IS_VIK_WINDOW ((VikWindow *)VIK_GTK_WINDOW_FROM_LAYER(oti->vtl)) ) { + gchar* msg; + if ( ans == 0 ) { + // Success + msg = g_strdup_printf ( "%s (@%s)", _("Uploaded to OSM"), timestr ); + } + // Use UPPER CASE for bad news :( + else if ( ans < 0 ) { + msg = g_strdup_printf ( "%s (@%s)", _("FAILED TO UPLOAD DATA TO OSM - CURL PROBLEM"), timestr ); + } + else { + msg = g_strdup_printf ( "%s : %s %d (@%s)", _("FAILED TO UPLOAD DATA TO OSM"), _("HTTP response code"), ans, timestr ); + } + vik_window_statusbar_update ( (VikWindow*)VIK_GTK_WINDOW_FROM_LAYER(oti->vtl), msg, VIK_STATUSBAR_INFO ); + g_free (msg); + } /* Removing temporary file */ - ret = g_unlink(filename); + int ret = g_unlink(filename); if (ret != 0) { - g_error(_("failed to unlink temporary file: %s"), strerror(errno)); + g_critical(_("failed to unlink temporary file: %s"), strerror(errno)); } } +/** + * + */ +void osm_login_widgets (GtkWidget *user_entry, GtkWidget *password_entry) +{ + if (!user_entry || !password_entry) + return; + + const gchar *default_user = get_default_user(); + const gchar *pref_user = a_preferences_get(VIKING_OSM_TRACES_PARAMS_NAMESPACE "username")->s; + const gchar *pref_password = a_preferences_get(VIKING_OSM_TRACES_PARAMS_NAMESPACE "password")->s; + + if (osm_user != NULL && osm_user[0] != '\0') + gtk_entry_set_text(GTK_ENTRY(user_entry), osm_user); + else if (pref_user != NULL && pref_user[0] != '\0') + gtk_entry_set_text(GTK_ENTRY(user_entry), pref_user); + else if (default_user != NULL) + gtk_entry_set_text(GTK_ENTRY(user_entry), default_user); + + if (osm_password != NULL && osm_password[0] != '\0') + gtk_entry_set_text(GTK_ENTRY(password_entry), osm_password); + else if (pref_password != NULL) + gtk_entry_set_text(GTK_ENTRY(password_entry), pref_password); + /* This is a password -> invisible */ + gtk_entry_set_visibility(GTK_ENTRY(password_entry), FALSE); +} + /** * Uploading a VikTrwLayer * * @param vtl VikTrwLayer - * @param track_name if not null, the name of the track to upload + * @param trk if not null, the track to upload */ -static void osm_traces_upload_viktrwlayer ( VikTrwLayer *vtl, const gchar *track_name ) +void osm_traces_upload_viktrwlayer ( VikTrwLayer *vtl, VikTrack *trk ) { GtkWidget *dia = gtk_dialog_new_with_buttons (_("OSM upload"), VIK_GTK_WINDOW_FROM_LAYER(vtl), @@ -316,55 +384,43 @@ static void osm_traces_upload_viktrwlayer ( VikTrwLayer *vtl, const gchar *track GTK_RESPONSE_ACCEPT, NULL); - const gchar *default_user = get_default_user(); - const gchar *pref_user = a_preferences_get(VIKING_OSM_TRACES_PARAMS_NAMESPACE "username")->s; - const gchar *pref_password = a_preferences_get(VIKING_OSM_TRACES_PARAMS_NAMESPACE "password")->s; const gchar *name = NULL; GtkWidget *user_label, *user_entry; GtkWidget *password_label, *password_entry; GtkWidget *name_label, *name_entry; GtkWidget *description_label, *description_entry; GtkWidget *tags_label, *tags_entry; - GtkComboBox *visibility; + GtkWidget *visibility; + GtkWidget *anonymize_checkbutton = NULL; const OsmTraceVis_t *vis_t; user_label = gtk_label_new(_("Email:")); user_entry = gtk_entry_new(); - if (user != NULL && user[0] != '\0') - gtk_entry_set_text(GTK_ENTRY(user_entry), user); - else if (pref_user != NULL && pref_user[0] != '\0') - gtk_entry_set_text(GTK_ENTRY(user_entry), pref_user); - else if (default_user != NULL) - gtk_entry_set_text(GTK_ENTRY(user_entry), default_user); - gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), user_label, FALSE, FALSE, 0); - gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), user_entry, FALSE, FALSE, 0); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), user_label, FALSE, FALSE, 0); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), user_entry, FALSE, FALSE, 0); gtk_widget_set_tooltip_markup(GTK_WIDGET(user_entry), _("The email used as login\n" "Enter the email you use to login into www.openstreetmap.org.")); password_label = gtk_label_new(_("Password:")); password_entry = gtk_entry_new(); - if (password != NULL && password[0] != '\0') - gtk_entry_set_text(GTK_ENTRY(password_entry), password); - else if (pref_password != NULL) - gtk_entry_set_text(GTK_ENTRY(password_entry), pref_password); - /* This is a password -> invisible */ - gtk_entry_set_visibility(GTK_ENTRY(password_entry), FALSE); - gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), password_label, FALSE, FALSE, 0); - gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), password_entry, FALSE, FALSE, 0); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), password_label, FALSE, FALSE, 0); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), password_entry, FALSE, FALSE, 0); gtk_widget_set_tooltip_markup(GTK_WIDGET(password_entry), _("The password used to login\n" "Enter the password you use to login into www.openstreetmap.org.")); + osm_login_widgets ( user_entry, password_entry ); + name_label = gtk_label_new(_("File's name:")); name_entry = gtk_entry_new(); - if (track_name != NULL) - name = track_name; + if (trk != NULL) + name = trk->name; else name = vik_layer_get_name(VIK_LAYER(vtl)); gtk_entry_set_text(GTK_ENTRY(name_entry), name); - gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), name_label, FALSE, FALSE, 0); - gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), name_entry, FALSE, FALSE, 0); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), name_label, FALSE, FALSE, 0); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), name_entry, FALSE, FALSE, 0); gtk_widget_set_tooltip_markup(GTK_WIDGET(name_entry), _("The name of the file on OSM\n" "This is the name of the file created on the server." @@ -372,24 +428,70 @@ static void osm_traces_upload_viktrwlayer ( VikTrwLayer *vtl, const gchar *track description_label = gtk_label_new(_("Description:")); description_entry = gtk_entry_new(); - gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), description_label, FALSE, FALSE, 0); - gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), description_entry, FALSE, FALSE, 0); + const gchar *description = NULL; + if (trk != NULL) + description = trk->description; + else { + VikTRWMetadata *md = vik_trw_layer_get_metadata (vtl); + description = md ? md->description : NULL; + } + if (description) + gtk_entry_set_text(GTK_ENTRY(description_entry), description); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), description_label, FALSE, FALSE, 0); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), description_entry, FALSE, FALSE, 0); gtk_widget_set_tooltip_text(GTK_WIDGET(description_entry), _("The description of the trace")); + if (trk != NULL) { + GtkWidget *label = gtk_label_new(_("Anonymize Times:")); + anonymize_checkbutton = gtk_check_button_new (); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), label, FALSE, FALSE, 0); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), anonymize_checkbutton, FALSE, FALSE, 0); + gtk_widget_set_tooltip_text(GTK_WIDGET(anonymize_checkbutton), + _("Anonymize times of the trace.\n" + "You may choose to make the trace identifiable, yet mask the actual real time values")); + } + tags_label = gtk_label_new(_("Tags:")); tags_entry = gtk_entry_new(); - gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), tags_label, FALSE, FALSE, 0); - gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), tags_entry, FALSE, FALSE, 0); + VikTRWMetadata *md = vik_trw_layer_get_metadata (vtl); + if (md->keywords) + gtk_entry_set_text(GTK_ENTRY(tags_entry), md->keywords); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), tags_label, FALSE, FALSE, 0); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), tags_entry, FALSE, FALSE, 0); gtk_widget_set_tooltip_text(GTK_WIDGET(tags_entry), _("The tags associated to the trace")); - visibility = GTK_COMBO_BOX(gtk_combo_box_new_text ()); + visibility = vik_combo_box_text_new(); for (vis_t = OsmTraceVis; vis_t->combostr != NULL; vis_t++) - gtk_combo_box_append_text(visibility, vis_t->combostr); - /* Set identifiable by default */ - gtk_combo_box_set_active(visibility, 0); - gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), GTK_WIDGET(visibility), FALSE, FALSE, 0); + vik_combo_box_text_append (visibility, vis_t->combostr); + + // Set identifiable by default or use the settings for the value + if ( last_active < 0 ) { + gint find_entry = -1; + gint wanted_entry = -1; + gchar *vis = NULL; + if ( a_settings_get_string ( VIK_SETTINGS_OSM_TRACE_VIS, &vis ) ) { + // Use setting + if ( vis ) { + for (vis_t = OsmTraceVis; vis_t->apistr != NULL; vis_t++) { + find_entry++; + if (!strcmp(vis, vis_t->apistr)) { + wanted_entry = find_entry; + } + } + } + // If not found set it to the first entry, otherwise use the entry + last_active = ( wanted_entry < 0 ) ? 0 : wanted_entry; + } + else + last_active = 0; + } + gtk_combo_box_set_active(GTK_COMBO_BOX(visibility), last_active); + gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), GTK_WIDGET(visibility), FALSE, FALSE, 0); + + /* User should think about it first... */ + gtk_dialog_set_default_response ( GTK_DIALOG(dia), GTK_RESPONSE_REJECT ); gtk_widget_show_all ( dia ); gtk_widget_grab_focus ( description_entry ); @@ -399,8 +501,8 @@ static void osm_traces_upload_viktrwlayer ( VikTrwLayer *vtl, const gchar *track gchar *title = NULL; /* overwrite authentication info */ - set_login(gtk_entry_get_text(GTK_ENTRY(user_entry)), - gtk_entry_get_text(GTK_ENTRY(password_entry))); + osm_set_login(gtk_entry_get_text(GTK_ENTRY(user_entry)), + gtk_entry_get_text(GTK_ENTRY(password_entry))); /* Storing data for the future thread */ OsmTracesInfo *info = g_malloc(sizeof(OsmTracesInfo)); @@ -408,9 +510,17 @@ static void osm_traces_upload_viktrwlayer ( VikTrwLayer *vtl, const gchar *track info->description = g_strdup(gtk_entry_get_text(GTK_ENTRY(description_entry))); /* TODO Normalize tags: they will be used as URL part */ info->tags = g_strdup(gtk_entry_get_text(GTK_ENTRY(tags_entry))); - info->vistype = &OsmTraceVis[gtk_combo_box_get_active(visibility)]; + info->vistype = &OsmTraceVis[gtk_combo_box_get_active(GTK_COMBO_BOX(visibility))]; info->vtl = VIK_TRW_LAYER(g_object_ref(vtl)); - info->track_name = (track_name == NULL) ? NULL : g_strdup(track_name); + info->trk = trk; + if (trk != NULL && anonymize_checkbutton != NULL ) + info->anonymize_times = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(anonymize_checkbutton)); + else + info->anonymize_times = FALSE; + + // Save visibility value for default reuse + last_active = gtk_combo_box_get_active(GTK_COMBO_BOX(visibility)); + a_settings_set_string ( VIK_SETTINGS_OSM_TRACE_VIS, OsmTraceVis[last_active].apistr ); title = g_strdup_printf(_("Uploading %s to OSM"), info->name); @@ -426,19 +536,3 @@ static void osm_traces_upload_viktrwlayer ( VikTrwLayer *vtl, const gchar *track } gtk_widget_destroy ( dia ); } - -/** - * Function called by the entry menu of a TrwLayer - */ -void osm_traces_upload_cb ( gpointer layer_and_vlp[2], guint file_type ) -{ - osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(layer_and_vlp[0]), NULL); -} - -/** - * Function called by the entry menu of a single track - */ -void osm_traces_upload_track_cb ( gpointer pass_along[6] ) -{ - osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(pass_along[0]), pass_along[3]); -}