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
27 #include <sys/types.h>
32 #include <curl/curl.h>
33 #include <curl/types.h>
34 #include <curl/easy.h>
37 #include <glib/gstdio.h>
38 #include <glib/gi18n.h>
41 #include "viktrwlayer.h"
42 #include "osm-traces.h"
44 #include "background.h"
47 * Login to use for OSM uploading.
49 static gchar *user = NULL;
52 * Password to use for OSM uploading.
54 static gchar *password = NULL;
57 * Mutex to protect auth. token
59 static GMutex *login_mutex = NULL;
62 * Struct hosting needed info.
64 typedef struct _OsmTracesInfo {
74 * Free an OsmTracesInfo struct.
76 static void oti_free(OsmTracesInfo *oti)
79 /* Fields have been g_strdup'ed */
80 g_free(oti->name); oti->name = NULL;
81 g_free(oti->description); oti->description = NULL;
82 g_free(oti->tags); oti->tags = NULL;
83 g_free(oti->track_name); oti->track_name = NULL;
85 g_object_unref(oti->vtl); oti->vtl = NULL;
87 /* Main struct has been g_malloc'ed */
91 static const gchar *get_default_user()
93 const gchar *default_user = NULL;
95 /* Retrieve "standard" EMAIL varenv */
96 default_user = g_getenv("EMAIL");
101 static void set_login(const gchar *user_, const gchar *password_)
104 if (login_mutex == NULL)
106 login_mutex = g_mutex_new();
108 g_mutex_lock(login_mutex);
109 g_free(user); user = NULL;
110 g_free(password); password = NULL;
111 user = g_strdup(user_);
112 password = g_strdup(password_);
113 g_mutex_unlock(login_mutex);
116 static gchar *get_login()
118 gchar *user_pass = NULL;
119 g_mutex_lock(login_mutex);
120 user_pass = g_strdup_printf("%s:%s", user, password);
121 g_mutex_unlock(login_mutex);
128 void osm_traces_upload_file(const char *user,
129 const char *password,
131 const char *filename,
132 const char *description,
138 char curl_error_buffer[CURL_ERROR_SIZE];
139 struct curl_slist *headers = NULL;
140 struct curl_httppost *post=NULL;
141 struct curl_httppost *last=NULL;
142 gchar *public_string;
144 char *base_url = "http://www.openstreetmap.org/api/0.5/gpx/create";
146 gchar *user_pass = get_login();
148 g_debug("%s: %s %s %s %s %s %s", __FUNCTION__,
149 user, password, file, filename, description, tags);
152 curl = curl_easy_init();
154 /* Filling the form */
155 curl_formadd(&post, &last,
156 CURLFORM_COPYNAME, "description",
157 CURLFORM_COPYCONTENTS, description, CURLFORM_END);
158 curl_formadd(&post, &last,
159 CURLFORM_COPYNAME, "tags",
160 CURLFORM_COPYCONTENTS, tags, CURLFORM_END);
165 curl_formadd(&post, &last,
166 CURLFORM_COPYNAME, "public",
167 CURLFORM_COPYCONTENTS, public_string, CURLFORM_END);
168 curl_formadd(&post, &last,
169 CURLFORM_COPYNAME, "file",
171 CURLFORM_FILENAME, filename,
172 CURLFORM_CONTENTTYPE, "text/xml", CURLFORM_END);
174 /* Prepare request */
175 /* As explained in http://wiki.openstreetmap.org/index.php/User:LA2 */
176 /* Expect: header seems to produce incompatibilites between curl and httpd */
177 headers = curl_slist_append(headers, "Expect: ");
178 curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
179 curl_easy_setopt(curl, CURLOPT_HTTPPOST, post);
180 curl_easy_setopt(curl, CURLOPT_URL, base_url);
181 curl_easy_setopt(curl, CURLOPT_USERPWD, user_pass);
182 curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
183 curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, &curl_error_buffer);
185 /* Execute request */
186 res = curl_easy_perform(curl);
190 res = curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &code);
193 g_debug("received valid curl response: %ld", code);
195 g_warning(_("failed to upload data: HTTP response is %ld"), code);
198 g_error(_("curl_easy_getinfo failed: %d"), res);
202 g_warning(_("curl request failed: %s"), curl_error_buffer);
206 g_free(user_pass); user_pass = NULL;
209 curl_easy_cleanup(curl);
213 * uploading function executed by the background" thread
215 static void osm_traces_upload_thread ( OsmTracesInfo *oti, gpointer threaddata )
217 /* Due to OSM limits, we have to enforce ele and time fields */
218 static GpxWritingOptions options = { TRUE, TRUE };
220 gchar *filename = NULL;
222 GError *error = NULL;
225 g_assert(oti != NULL);
227 /* Opening temporary file */
228 fd = g_file_open_tmp("viking_osm_upload_XXXXXX.gpx", &filename, &error);
230 g_error(_("failed to open temporary file: %s"), strerror(errno));
233 g_clear_error(&error);
234 g_debug("%s: temporary file = %s", __FUNCTION__, filename);
237 file = fdopen(fd, "w");
239 /* writing gpx file */
240 if (oti->track_name != NULL)
242 /* Upload only the selected track */
243 VikTrack *track = vik_trw_layer_get_track(oti->vtl, oti->track_name);
244 a_gpx_write_track_file_options(&options, oti->track_name, track, file);
248 /* Upload the whole VikTrwLayer */
249 a_gpx_write_file_options(&options, oti->vtl, file);
252 /* We can close the file */
253 /* This also close the associated fd */
256 /* finally, upload it */
257 osm_traces_upload_file(user, password, filename,
258 oti->name, oti->description, oti->tags, oti->public);
260 /* Removing temporary file */
261 ret = g_unlink(filename);
263 g_error(_("failed to unlink temporary file: %s"), strerror(errno));
268 * Uploading a VikTrwLayer
270 * @param vtl VikTrwLayer
271 * @param track_name if not null, the name of the track to upload
273 static void osm_traces_upload_viktrwlayer ( VikTrwLayer *vtl, const gchar *track_name )
275 GtkWidget *dia = gtk_dialog_new_with_buttons (_("OSM upload"),
276 VIK_GTK_WINDOW_FROM_LAYER(vtl),
277 GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
284 const gchar *name = NULL;
285 GtkWidget *user_label, *user_entry;
286 GtkWidget *password_label, *password_entry;
287 GtkWidget *name_label, *name_entry;
288 GtkWidget *description_label, *description_entry;
289 GtkWidget *tags_label, *tags_entry;
291 GtkTooltips* dialog_tips;
293 dialog_tips = gtk_tooltips_new();
295 user_label = gtk_label_new(_("Email:"));
296 user_entry = gtk_entry_new();
298 gtk_entry_set_text(GTK_ENTRY(user_entry), user);
301 const gchar *default_user = get_default_user();
302 if (default_user != NULL)
303 gtk_entry_set_text(GTK_ENTRY(user_entry), default_user);
305 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), user_label, FALSE, FALSE, 0);
306 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), user_entry, FALSE, FALSE, 0);
307 gtk_widget_show_all ( user_label );
308 gtk_widget_show_all ( user_entry );
309 gtk_tooltips_set_tip (dialog_tips, user_entry,
310 _("The email used as login"),
311 _("Enter the email you use to login into www.openstreetmap.org."));
313 password_label = gtk_label_new(_("Password:"));
314 password_entry = gtk_entry_new();
315 if (password != NULL)
316 gtk_entry_set_text(GTK_ENTRY(password_entry), password);
317 /* This is a password -> invisible */
318 gtk_entry_set_visibility(GTK_ENTRY(password_entry), FALSE);
319 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), password_label, FALSE, FALSE, 0);
320 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), password_entry, FALSE, FALSE, 0);
321 gtk_widget_show_all ( password_label );
322 gtk_widget_show_all ( password_entry );
323 gtk_tooltips_set_tip (dialog_tips, password_entry,
324 _("The password used to login"),
325 _("Enter the password you use to login into www.openstreetmap.org."));
327 name_label = gtk_label_new(_("File's name:"));
328 name_entry = gtk_entry_new();
329 if (track_name != NULL)
332 name = vik_layer_get_name(VIK_LAYER(vtl));
333 gtk_entry_set_text(GTK_ENTRY(name_entry), name);
334 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), name_label, FALSE, FALSE, 0);
335 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), name_entry, FALSE, FALSE, 0);
336 gtk_widget_show_all ( name_label );
337 gtk_widget_show_all ( name_entry );
338 gtk_tooltips_set_tip (dialog_tips, name_entry,
339 _("The name of the file on OSM"),
340 _("This is the name of the file created on the server. "
341 "This is not the name of the local file."));
343 description_label = gtk_label_new(_("Description:"));
344 description_entry = gtk_entry_new();
345 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), description_label, FALSE, FALSE, 0);
346 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), description_entry, FALSE, FALSE, 0);
347 gtk_widget_show_all ( description_label );
348 gtk_widget_show_all ( description_entry );
349 gtk_tooltips_set_tip (dialog_tips, description_entry,
350 _("The description of the trace"),
353 tags_label = gtk_label_new(_("Tags:"));
354 tags_entry = gtk_entry_new();
355 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), tags_label, FALSE, FALSE, 0);
356 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), tags_entry, FALSE, FALSE, 0);
357 gtk_widget_show_all ( tags_label );
358 gtk_widget_show_all ( tags_entry );
359 gtk_tooltips_set_tip (dialog_tips, tags_entry,
360 _("The tags associated to the trace"),
363 public = gtk_check_button_new_with_label(_("Public"));
364 /* Set public by default */
365 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(public), TRUE);
366 gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), public, FALSE, FALSE, 0);
367 gtk_widget_show_all ( public );
368 gtk_tooltips_set_tip (dialog_tips, public,
369 _("Indicates if the trace is public or not"),
372 if ( gtk_dialog_run ( GTK_DIALOG(dia) ) == GTK_RESPONSE_ACCEPT )
376 /* overwrite authentication info */
377 set_login(gtk_entry_get_text(GTK_ENTRY(user_entry)),
378 gtk_entry_get_text(GTK_ENTRY(password_entry)));
380 /* Storing data for the future thread */
381 OsmTracesInfo *info = g_malloc(sizeof(OsmTracesInfo));
382 info->name = g_strdup(gtk_entry_get_text(GTK_ENTRY(name_entry)));
383 info->description = g_strdup(gtk_entry_get_text(GTK_ENTRY(description_entry)));
384 /* TODO Normalize tags: they will be used as URL part */
385 info->tags = g_strdup(gtk_entry_get_text(GTK_ENTRY(tags_entry)));
386 info->public = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(public));
387 info->vtl = VIK_TRW_LAYER(g_object_ref(vtl));
388 info->track_name = (track_name == NULL) ? NULL : g_strdup(track_name);
390 title = g_strdup_printf(_("Uploading %s to OSM"), info->name);
392 /* launch the thread */
393 a_background_thread(VIK_GTK_WINDOW_FROM_LAYER(vtl), /* parent window */
394 title, /* description string */
395 (vik_thr_func) osm_traces_upload_thread, /* function to call within thread */
396 info, /* pass along data */
397 (vik_thr_free_func) oti_free, /* function to free pass along data */
398 (vik_thr_free_func) NULL,
400 g_free ( title ); title = NULL;
402 gtk_widget_destroy ( dia );
406 * Function called by the entry menu of a TrwLayer
408 void osm_traces_upload_cb ( gpointer layer_and_vlp[2], guint file_type )
410 osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(layer_and_vlp[0]), NULL);
414 * Function called by the entry menu of a single track
416 void osm_traces_upload_track_cb ( gpointer pass_along[6] )
418 osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(pass_along[0]), pass_along[3]);