2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2007, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
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.
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.
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
29 #include <curl/curl.h>
30 #include <curl/types.h>
31 #include <curl/easy.h>
34 #include <glib/gstdio.h>
35 #include <glib/gi18n.h>
38 #include "viktrwlayer.h"
39 #include "osm-traces.h"
41 #include "background.h"
42 #include "preferences.h"
44 /* params will be osm_traces.username, osm_traces.password */
45 /* we have to make sure these don't collide. */
46 #define VIKING_OSM_TRACES_PARAMS_GROUP_KEY "osm_traces"
47 #define VIKING_OSM_TRACES_PARAMS_NAMESPACE "osm_traces."
50 * Login to use for OSM uploading.
52 static gchar *user = NULL;
55 * Password to use for OSM uploading.
57 static gchar *password = NULL;
60 * Mutex to protect auth. token
62 static GMutex *login_mutex = NULL;
65 * Different type of trace visibility.
67 typedef struct _OsmTraceVis_t {
68 const gchar *combostr;
72 static const OsmTraceVis_t OsmTraceVis[] = {
73 { N_("Identifiable (public w/ timestamps)"), "identifiable" },
74 { N_("Trackable (private w/ timestamps)"), "trackable" },
75 { N_("Public"), "public" },
76 { N_("Private"), "private" },
81 * Struct hosting needed info.
83 typedef struct _OsmTracesInfo {
87 const OsmTraceVis_t *vistype;
92 static VikLayerParam prefs[] = {
93 { VIKING_OSM_TRACES_PARAMS_NAMESPACE "username", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("OSM username:"), VIK_LAYER_WIDGET_ENTRY },
94 { VIKING_OSM_TRACES_PARAMS_NAMESPACE "password", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("OSM password:"), VIK_LAYER_WIDGET_PASSWORD },
98 * Free an OsmTracesInfo struct.
100 static void oti_free(OsmTracesInfo *oti)
103 /* Fields have been g_strdup'ed */
104 g_free(oti->name); oti->name = NULL;
105 g_free(oti->description); oti->description = NULL;
106 g_free(oti->tags); oti->tags = NULL;
107 g_free(oti->track_name); oti->track_name = NULL;
109 g_object_unref(oti->vtl); oti->vtl = NULL;
111 /* Main struct has been g_malloc'ed */
115 static const gchar *get_default_user()
117 const gchar *default_user = NULL;
119 /* Retrieve "standard" EMAIL varenv */
120 default_user = g_getenv("EMAIL");
125 static void set_login(const gchar *user_, const gchar *password_)
128 if (login_mutex == NULL)
130 login_mutex = g_mutex_new();
132 g_mutex_lock(login_mutex);
133 g_free(user); user = NULL;
134 g_free(password); password = NULL;
135 user = g_strdup(user_);
136 password = g_strdup(password_);
137 g_mutex_unlock(login_mutex);
140 static gchar *get_login()
142 gchar *user_pass = NULL;
143 g_mutex_lock(login_mutex);
144 user_pass = g_strdup_printf("%s:%s", user, password);
145 g_mutex_unlock(login_mutex);
150 void osm_traces_init () {
152 a_preferences_register_group ( VIKING_OSM_TRACES_PARAMS_GROUP_KEY, "OpenStreetMap traces" );
154 VikLayerParamData tmp;
156 a_preferences_register(prefs, tmp, VIKING_OSM_TRACES_PARAMS_GROUP_KEY);
158 a_preferences_register(prefs+1, tmp, VIKING_OSM_TRACES_PARAMS_GROUP_KEY);
165 void osm_traces_upload_file(const char *user,
166 const char *password,
168 const char *filename,
169 const char *description,
171 const OsmTraceVis_t *vistype)
175 char curl_error_buffer[CURL_ERROR_SIZE];
176 struct curl_slist *headers = NULL;
177 struct curl_httppost *post=NULL;
178 struct curl_httppost *last=NULL;
180 char *base_url = "http://www.openstreetmap.org/api/0.6/gpx/create";
182 gchar *user_pass = get_login();
184 g_debug("%s: %s %s %s %s %s %s", __FUNCTION__,
185 user, password, file, filename, description, tags);
188 curl = curl_easy_init();
190 /* Filling the form */
191 curl_formadd(&post, &last,
192 CURLFORM_COPYNAME, "description",
193 CURLFORM_COPYCONTENTS, description, CURLFORM_END);
194 curl_formadd(&post, &last,
195 CURLFORM_COPYNAME, "tags",
196 CURLFORM_COPYCONTENTS, tags, CURLFORM_END);
197 curl_formadd(&post, &last,
198 CURLFORM_COPYNAME, "visibility",
199 CURLFORM_COPYCONTENTS, vistype->apistr, CURLFORM_END);
200 curl_formadd(&post, &last,
201 CURLFORM_COPYNAME, "file",
203 CURLFORM_FILENAME, filename,
204 CURLFORM_CONTENTTYPE, "text/xml", CURLFORM_END);
206 /* Prepare request */
207 /* As explained in http://wiki.openstreetmap.org/index.php/User:LA2 */
208 /* Expect: header seems to produce incompatibilites between curl and httpd */
209 headers = curl_slist_append(headers, "Expect: ");
210 curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
211 curl_easy_setopt(curl, CURLOPT_HTTPPOST, post);
212 curl_easy_setopt(curl, CURLOPT_URL, base_url);
213 curl_easy_setopt(curl, CURLOPT_USERPWD, user_pass);
214 curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
215 curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, curl_error_buffer);
217 curl_easy_setopt ( curl, CURLOPT_VERBOSE, 1 );
219 /* Execute request */
220 res = curl_easy_perform(curl);
224 res = curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &code);
227 g_debug("received valid curl response: %ld", code);
229 g_warning(_("failed to upload data: HTTP response is %ld"), code);
232 g_error(_("curl_easy_getinfo failed: %d"), res);
236 g_warning(_("curl request failed: %s"), curl_error_buffer);
240 g_free(user_pass); user_pass = NULL;
243 curl_easy_cleanup(curl);
247 * uploading function executed by the background" thread
249 static void osm_traces_upload_thread ( OsmTracesInfo *oti, gpointer threaddata )
251 /* Due to OSM limits, we have to enforce ele and time fields */
252 static GpxWritingOptions options = { TRUE, TRUE };
254 gchar *filename = NULL;
256 GError *error = NULL;
259 g_assert(oti != NULL);
261 /* Opening temporary file */
262 fd = g_file_open_tmp("viking_osm_upload_XXXXXX.gpx", &filename, &error);
264 g_error(_("failed to open temporary file: %s"), strerror(errno));
267 g_clear_error(&error);
268 g_debug("%s: temporary file = %s", __FUNCTION__, filename);
271 file = fdopen(fd, "w");
273 /* writing gpx file */
274 if (oti->track_name != NULL)
276 /* Upload only the selected track */
277 VikTrack *track = vik_trw_layer_get_track(oti->vtl, oti->track_name);
278 a_gpx_write_track_file_options(&options, oti->track_name, track, file);
282 /* Upload the whole VikTrwLayer */
283 a_gpx_write_file_options(&options, oti->vtl, file);
286 /* We can close the file */
287 /* This also close the associated fd */
291 /* finally, upload it */
292 osm_traces_upload_file(user, password, filename,
293 oti->name, oti->description, oti->tags, oti->vistype);
295 /* Removing temporary file */
296 ret = g_unlink(filename);
298 g_error(_("failed to unlink temporary file: %s"), strerror(errno));
303 * Uploading a VikTrwLayer
305 * @param vtl VikTrwLayer
306 * @param track_name if not null, the name of the track to upload
308 static void osm_traces_upload_viktrwlayer ( VikTrwLayer *vtl, const gchar *track_name )
310 GtkWidget *dia = gtk_dialog_new_with_buttons (_("OSM upload"),
311 VIK_GTK_WINDOW_FROM_LAYER(vtl),
312 GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
319 const gchar *default_user = get_default_user();
320 const gchar *pref_user = a_preferences_get(VIKING_OSM_TRACES_PARAMS_NAMESPACE "username")->s;
321 const gchar *pref_password = a_preferences_get(VIKING_OSM_TRACES_PARAMS_NAMESPACE "password")->s;
322 const gchar *name = NULL;
323 GtkWidget *user_label, *user_entry;
324 GtkWidget *password_label, *password_entry;
325 GtkWidget *name_label, *name_entry;
326 GtkWidget *description_label, *description_entry;
327 GtkWidget *tags_label, *tags_entry;
328 GtkComboBox *visibility;
329 const OsmTraceVis_t *vis_t;
331 user_label = gtk_label_new(_("Email:"));
332 user_entry = gtk_entry_new();
333 if (user != NULL && user[0] != '\0')
334 gtk_entry_set_text(GTK_ENTRY(user_entry), user);
335 else if (pref_user != NULL && pref_user[0] != '\0')
336 gtk_entry_set_text(GTK_ENTRY(user_entry), pref_user);
337 else if (default_user != NULL)
338 gtk_entry_set_text(GTK_ENTRY(user_entry), default_user);
339 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), user_label, FALSE, FALSE, 0);
340 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), user_entry, FALSE, FALSE, 0);
341 gtk_widget_set_tooltip_markup(GTK_WIDGET(user_entry),
342 _("The email used as login\n"
343 "<small>Enter the email you use to login into www.openstreetmap.org.</small>"));
345 password_label = gtk_label_new(_("Password:"));
346 password_entry = gtk_entry_new();
347 if (password != NULL && password[0] != '\0')
348 gtk_entry_set_text(GTK_ENTRY(password_entry), password);
349 else if (pref_password != NULL)
350 gtk_entry_set_text(GTK_ENTRY(password_entry), pref_password);
351 /* This is a password -> invisible */
352 gtk_entry_set_visibility(GTK_ENTRY(password_entry), FALSE);
353 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), password_label, FALSE, FALSE, 0);
354 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), password_entry, FALSE, FALSE, 0);
355 gtk_widget_set_tooltip_markup(GTK_WIDGET(password_entry),
356 _("The password used to login\n"
357 "<small>Enter the password you use to login into www.openstreetmap.org.</small>"));
359 name_label = gtk_label_new(_("File's name:"));
360 name_entry = gtk_entry_new();
361 if (track_name != NULL)
364 name = vik_layer_get_name(VIK_LAYER(vtl));
365 gtk_entry_set_text(GTK_ENTRY(name_entry), name);
366 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), name_label, FALSE, FALSE, 0);
367 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), name_entry, FALSE, FALSE, 0);
368 gtk_widget_set_tooltip_markup(GTK_WIDGET(name_entry),
369 _("The name of the file on OSM\n"
370 "<small>This is the name of the file created on the server."
371 "This is not the name of the local file.</small>"));
373 description_label = gtk_label_new(_("Description:"));
374 description_entry = gtk_entry_new();
375 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), description_label, FALSE, FALSE, 0);
376 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), description_entry, FALSE, FALSE, 0);
377 gtk_widget_set_tooltip_text(GTK_WIDGET(description_entry),
378 _("The description of the trace"));
380 tags_label = gtk_label_new(_("Tags:"));
381 tags_entry = gtk_entry_new();
382 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), tags_label, FALSE, FALSE, 0);
383 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), tags_entry, FALSE, FALSE, 0);
384 gtk_widget_set_tooltip_text(GTK_WIDGET(tags_entry),
385 _("The tags associated to the trace"));
387 visibility = GTK_COMBO_BOX(gtk_combo_box_new_text ());
388 for (vis_t = OsmTraceVis; vis_t->combostr != NULL; vis_t++)
389 gtk_combo_box_append_text(visibility, vis_t->combostr);
390 /* Set identifiable by default */
391 gtk_combo_box_set_active(visibility, 0);
392 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), GTK_WIDGET(visibility), FALSE, FALSE, 0);
394 gtk_widget_show_all ( dia );
395 gtk_widget_grab_focus ( description_entry );
397 if ( gtk_dialog_run ( GTK_DIALOG(dia) ) == GTK_RESPONSE_ACCEPT )
401 /* overwrite authentication info */
402 set_login(gtk_entry_get_text(GTK_ENTRY(user_entry)),
403 gtk_entry_get_text(GTK_ENTRY(password_entry)));
405 /* Storing data for the future thread */
406 OsmTracesInfo *info = g_malloc(sizeof(OsmTracesInfo));
407 info->name = g_strdup(gtk_entry_get_text(GTK_ENTRY(name_entry)));
408 info->description = g_strdup(gtk_entry_get_text(GTK_ENTRY(description_entry)));
409 /* TODO Normalize tags: they will be used as URL part */
410 info->tags = g_strdup(gtk_entry_get_text(GTK_ENTRY(tags_entry)));
411 info->vistype = &OsmTraceVis[gtk_combo_box_get_active(visibility)];
412 info->vtl = VIK_TRW_LAYER(g_object_ref(vtl));
413 info->track_name = (track_name == NULL) ? NULL : g_strdup(track_name);
415 title = g_strdup_printf(_("Uploading %s to OSM"), info->name);
417 /* launch the thread */
418 a_background_thread(VIK_GTK_WINDOW_FROM_LAYER(vtl), /* parent window */
419 title, /* description string */
420 (vik_thr_func) osm_traces_upload_thread, /* function to call within thread */
421 info, /* pass along data */
422 (vik_thr_free_func) oti_free, /* function to free pass along data */
423 (vik_thr_free_func) NULL,
425 g_free ( title ); title = NULL;
427 gtk_widget_destroy ( dia );
431 * Function called by the entry menu of a TrwLayer
433 void osm_traces_upload_cb ( gpointer layer_and_vlp[2], guint file_type )
435 osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(layer_and_vlp[0]), NULL);
439 * Function called by the entry menu of a single track
441 void osm_traces_upload_track_cb ( gpointer pass_along[6] )
443 osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(pass_along[0]), pass_along[3]);