X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/65c1e0b03ad3fa552f965ace461be98ebd4e9fc1..754b2771ce0de9b290e798f12def2b13245c03fd:/src/osm-traces.c?ds=sidebyside diff --git a/src/osm-traces.c b/src/osm-traces.c index fb756fe4..850884c3 100644 --- a/src/osm-traces.c +++ b/src/osm-traces.c @@ -25,9 +25,9 @@ #include #include #include +#include #include -#include #include #include @@ -61,6 +61,22 @@ static gchar *password = NULL; */ static GMutex *login_mutex = NULL; +/** + * Different type of trace visibility. + */ +typedef struct _OsmTraceVis_t { + const gchar *combostr; + const gchar *apistr; +} OsmTraceVis_t; + +static const OsmTraceVis_t OsmTraceVis[] = { + { N_("Identifiable (public w/ timestamps)"), "identifiable" }, + { N_("Trackable (private w/ timestamps)"), "trackable" }, + { N_("Public"), "public" }, + { N_("Private"), "private" }, + { NULL, NULL }, +}; + /** * Struct hosting needed info. */ @@ -68,14 +84,14 @@ typedef struct _OsmTracesInfo { gchar *name; gchar *description; gchar *tags; - gboolean public; + 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 }, + { VIKING_OSM_TRACES_PARAMS_NAMESPACE "username", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("OSM username:"), VIK_LAYER_WIDGET_ENTRY, NULL, NULL, NULL }, + { VIKING_OSM_TRACES_PARAMS_NAMESPACE "password", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("OSM password:"), VIK_LAYER_WIDGET_PASSWORD, NULL, NULL, NULL }, }; /** @@ -88,7 +104,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; } @@ -106,7 +121,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) @@ -121,7 +136,7 @@ static void set_login(const gchar *user_, const gchar *password_) g_mutex_unlock(login_mutex); } -static gchar *get_login() +gchar *osm_get_login() { gchar *user_pass = NULL; g_mutex_lock(login_mutex); @@ -133,7 +148,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 = ""; @@ -145,14 +160,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, - gboolean public) + * 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; @@ -160,11 +179,12 @@ void osm_traces_upload_file(const char *user, struct curl_slist *headers = NULL; struct curl_httppost *post=NULL; struct curl_httppost *last=NULL; - gchar *public_string; 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); @@ -179,13 +199,9 @@ void osm_traces_upload_file(const char *user, curl_formadd(&post, &last, CURLFORM_COPYNAME, "tags", CURLFORM_COPYCONTENTS, tags, CURLFORM_END); - if (public) - public_string = "1"; - else - public_string = "0"; curl_formadd(&post, &last, - CURLFORM_COPYNAME, "public", - CURLFORM_COPYCONTENTS, public_string, CURLFORM_END); + CURLFORM_COPYNAME, "visibility", + CURLFORM_COPYCONTENTS, vistype->apistr, CURLFORM_END); curl_formadd(&post, &last, CURLFORM_COPYNAME, "file", CURLFORM_FILE, file, @@ -214,22 +230,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; } /** @@ -237,8 +258,9 @@ 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 }; + /* 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 }; FILE *file = NULL; gchar *filename = NULL; int fd; @@ -260,16 +282,15 @@ static void osm_traces_upload_thread ( OsmTracesInfo *oti, gpointer threaddata ) file = fdopen(fd, "w"); /* 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); + a_gpx_write_track_file(oti->trk, file, &options); } else { /* Upload the whole VikTrwLayer */ - a_gpx_write_file_options(&options, oti->vtl, file); + a_gpx_write_file(oti->vtl, file, &options); } /* We can close the file */ @@ -278,23 +299,90 @@ static void osm_traces_upload_thread ( OsmTracesInfo *oti, gpointer threaddata ) file = NULL; /* finally, upload it */ - osm_traces_upload_file(user, password, filename, - oti->name, oti->description, oti->tags, oti->public); - + gint ans = osm_traces_upload_file(user, 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 ); + } + // From the background so should use the signalling method to update display: + // TODO: This only works with statically assigned strings ATM + vik_window_signal_statusbar_update ( (VikWindow*)VIK_GTK_WINDOW_FROM_LAYER(oti->vtl), msg, VIK_STATUSBAR_INFO ); + // Thus can't free the memory yet... + // Luckily OSM traces isn't heavily used so this is not a significant memory leak + //g_free (msg); + // But this is better than potentially crashing from multi thread GUI updates + } /* Removing temporary file */ 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 (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); + + 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); +} + /** * 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 ) +static void osm_traces_upload_viktrwlayer ( VikTrwLayer *vtl, VikTrack *trk ) { GtkWidget *dia = gtk_dialog_new_with_buttons (_("OSM upload"), VIK_GTK_WINDOW_FROM_LAYER(vtl), @@ -305,104 +393,81 @@ 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; - GtkWidget *public; - GtkTooltips* dialog_tips; - - dialog_tips = gtk_tooltips_new(); + GtkComboBox *visibility; + 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_widget_show_all ( user_label ); - gtk_widget_show_all ( user_entry ); - gtk_tooltips_set_tip (dialog_tips, user_entry, - _("The email used as login"), - _("Enter the email you use to login into www.openstreetmap.org.")); + 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_widget_show_all ( password_label ); - gtk_widget_show_all ( password_entry ); - gtk_tooltips_set_tip (dialog_tips, password_entry, - _("The password used to login"), - _("Enter the password you use to login into www.openstreetmap.org.")); + 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_widget_show_all ( name_label ); - gtk_widget_show_all ( name_entry ); - gtk_tooltips_set_tip (dialog_tips, name_entry, - _("The name of the file on OSM"), - _("This is the name of the file created on the server. " - "This is not the name of the local file.")); + 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." + "This is not the name of the local file.")); 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); - gtk_widget_show_all ( description_label ); - gtk_widget_show_all ( description_entry ); - gtk_tooltips_set_tip (dialog_tips, description_entry, - _("The description of the trace"), - ""); + gtk_widget_set_tooltip_text(GTK_WIDGET(description_entry), + _("The description of the trace")); 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); - gtk_widget_show_all ( tags_label ); - gtk_widget_show_all ( tags_entry ); - gtk_tooltips_set_tip (dialog_tips, tags_entry, - _("The tags associated to the trace"), - ""); - - public = gtk_check_button_new_with_label(_("Public")); - /* Set public by default */ - gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(public), TRUE); - gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), public, FALSE, FALSE, 0); - gtk_widget_show_all ( public ); - gtk_tooltips_set_tip (dialog_tips, public, - _("Indicates if the trace is public or not"), - ""); + gtk_widget_set_tooltip_text(GTK_WIDGET(tags_entry), + _("The tags associated to the trace")); + + visibility = GTK_COMBO_BOX(gtk_combo_box_new_text ()); + 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); + + /* 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 ); if ( gtk_dialog_run ( GTK_DIALOG(dia) ) == GTK_RESPONSE_ACCEPT ) { 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)); @@ -410,9 +475,9 @@ 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->public = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(public)); + info->vistype = &OsmTraceVis[gtk_combo_box_get_active(visibility)]; info->vtl = VIK_TRW_LAYER(g_object_ref(vtl)); - info->track_name = (track_name == NULL) ? NULL : g_strdup(track_name); + info->trk = trk; title = g_strdup_printf(_("Uploading %s to OSM"), info->name); @@ -440,7 +505,12 @@ void osm_traces_upload_cb ( gpointer layer_and_vlp[2], guint file_type ) /** * Function called by the entry menu of a single track */ -void osm_traces_upload_track_cb ( gpointer pass_along[6] ) +// TODO: Fix this dodgy usage of magic 8 ball array sized numbering +// At least have some common definition somewhere... +void osm_traces_upload_track_cb ( gpointer pass_along[8] ) { - osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(pass_along[0]), pass_along[3]); + if ( pass_along[7] ) { + VikTrack *trk = VIK_TRACK(pass_along[7]); + osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(pass_along[0]), trk); + } }