]> git.street.me.uk Git - andy/viking.git/blame - src/osm-traces.c
Correct OSM URL
[andy/viking.git] / src / osm-traces.c
CommitLineData
3e7553ae
GB
1/*
2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
3 *
4 * Copyright (C) 2007, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
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
3e7553ae
GB
24
25#include <stdio.h>
26#include <string.h>
27#include <sys/types.h>
28#include <sys/stat.h>
29#include <unistd.h>
30#include <errno.h>
31
32#include <curl/curl.h>
33#include <curl/types.h>
34#include <curl/easy.h>
35
36#include <glib.h>
37#include <glib/gstdio.h>
4c77d5e0 38#include <glib/gi18n.h>
3e7553ae
GB
39
40#include "viking.h"
41#include "viktrwlayer.h"
42#include "osm-traces.h"
43#include "gpx.h"
44#include "background.h"
45
46/**
47 * Login to use for OSM uploading.
48 */
49static gchar *user = NULL;
50
51/**
52 * Password to use for OSM uploading.
53 */
54static gchar *password = NULL;
55
56/**
57 * Mutex to protect auth. token
58 */
59static GMutex *login_mutex = NULL;
60
61/**
62 * Struct hosting needed info.
63 */
64typedef struct _OsmTracesInfo {
65 gchar *name;
66 gchar *description;
67 gchar *tags;
68 gboolean public;
69 VikTrwLayer *vtl;
5092de80 70 gchar *track_name;
3e7553ae
GB
71} OsmTracesInfo;
72
73/**
74 * Free an OsmTracesInfo struct.
75 */
76static void oti_free(OsmTracesInfo *oti)
77{
78 if (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;
5092de80 83 g_free(oti->track_name); oti->track_name = NULL;
3e7553ae
GB
84
85 g_object_unref(oti->vtl); oti->vtl = NULL;
86 }
87 /* Main struct has been g_malloc'ed */
88 g_free(oti);
89}
90
624318ca 91static const gchar *get_default_user()
51c15f41
GB
92{
93 const gchar *default_user = NULL;
94
95 /* Retrieve "standard" EMAIL varenv */
96 default_user = g_getenv("EMAIL");
97
98 return default_user;
99}
100
3e7553ae
GB
101static void set_login(const gchar *user_, const gchar *password_)
102{
103 /* Allocate mutex */
104 if (login_mutex == NULL)
105 {
106 login_mutex = g_mutex_new();
107 }
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);
114}
115
116static gchar *get_login()
117{
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);
122 return user_pass;
123}
124
125/*
126 * Upload a file
127 */
128void osm_traces_upload_file(const char *user,
129 const char *password,
130 const char *file,
131 const char *filename,
132 const char *description,
133 const char *tags,
134 gboolean public)
135{
136 CURL *curl;
137 CURLcode res;
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;
143
5c5f3289 144 char *base_url = "http://www.openstreetmap.org/api/0.5/gpx/create";
3e7553ae
GB
145
146 gchar *user_pass = get_login();
147
148 g_debug("%s: %s %s %s %s %s %s", __FUNCTION__,
149 user, password, file, filename, description, tags);
150
151 /* Init CURL */
152 curl = curl_easy_init();
153
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);
3e7553ae
GB
161 if (public)
162 public_string = "1";
163 else
164 public_string = "0";
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",
170 CURLFORM_FILE, file,
171 CURLFORM_FILENAME, filename,
172 CURLFORM_CONTENTTYPE, "text/xml", CURLFORM_END);
173
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);
184
185 /* Execute request */
186 res = curl_easy_perform(curl);
187 if (res == CURLE_OK)
188 {
189 long code;
190 res = curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &code);
191 if (res == CURLE_OK)
192 {
193 g_debug("received valid curl response: %ld", code);
194 if (code != 200)
4c77d5e0 195 g_warning(_("failed to upload data: HTTP response is %ld"), code);
3e7553ae
GB
196 }
197 else
4c77d5e0 198 g_error(_("curl_easy_getinfo failed: %d"), res);
3e7553ae
GB
199 }
200 else
201 {
4c77d5e0 202 g_warning(_("curl request failed: %s"), curl_error_buffer);
3e7553ae
GB
203 }
204
205 /* Memory */
206 g_free(user_pass); user_pass = NULL;
207
208 curl_formfree(post);
209 curl_easy_cleanup(curl);
210}
211
212/**
213 * uploading function executed by the background" thread
214 */
215static void osm_traces_upload_thread ( OsmTracesInfo *oti, gpointer threaddata )
216{
0b72c435
OK
217 /* Due to OSM limits, we have to enforce ele and time fields */
218 static GpxWritingOptions options = { TRUE, TRUE };
3e7553ae
GB
219 FILE *file = NULL;
220 gchar *filename = NULL;
221 int fd;
222 GError *error = NULL;
223 int ret;
224
225 g_assert(oti != NULL);
226
227 /* Opening temporary file */
228 fd = g_file_open_tmp("viking_osm_upload_XXXXXX.gpx", &filename, &error);
229 if (fd < 0) {
4c77d5e0 230 g_error(_("failed to open temporary file: %s"), strerror(errno));
3e7553ae
GB
231 return;
232 }
233 g_clear_error(&error);
234 g_debug("%s: temporary file = %s", __FUNCTION__, filename);
235
236 /* Creating FILE* */
237 file = fdopen(fd, "w");
238
239 /* writing gpx file */
5092de80
GB
240 if (oti->track_name != NULL)
241 {
242 /* Upload only the selected track */
243 VikTrack *track = vik_trw_layer_get_track(oti->vtl, oti->track_name);
0b72c435 244 a_gpx_write_track_file_options(&options, oti->track_name, track, file);
5092de80
GB
245 }
246 else
0b72c435 247 {
5092de80 248 /* Upload the whole VikTrwLayer */
0b72c435
OK
249 a_gpx_write_file_options(&options, oti->vtl, file);
250 }
3e7553ae
GB
251
252 /* We can close the file */
253 /* This also close the associated fd */
254 fclose(file);
255
256 /* finally, upload it */
257 osm_traces_upload_file(user, password, filename,
258 oti->name, oti->description, oti->tags, oti->public);
259
260 /* Removing temporary file */
261 ret = g_unlink(filename);
262 if (ret != 0) {
4c77d5e0 263 g_error(_("failed to unlink temporary file: %s"), strerror(errno));
3e7553ae
GB
264 }
265}
266
267/**
268 * Uploading a VikTrwLayer
5092de80
GB
269 *
270 * @param vtl VikTrwLayer
271 * @param track_name if not null, the name of the track to upload
3e7553ae 272 */
5092de80 273static void osm_traces_upload_viktrwlayer ( VikTrwLayer *vtl, const gchar *track_name )
3e7553ae 274{
4c77d5e0 275 GtkWidget *dia = gtk_dialog_new_with_buttons (_("OSM upload"),
3e7553ae
GB
276 VIK_GTK_WINDOW_FROM_LAYER(vtl),
277 GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
278 GTK_STOCK_CANCEL,
279 GTK_RESPONSE_REJECT,
280 GTK_STOCK_OK,
281 GTK_RESPONSE_ACCEPT,
282 NULL);
283
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;
290 GtkWidget *public;
291 GtkTooltips* dialog_tips;
292
293 dialog_tips = gtk_tooltips_new();
294
4c77d5e0 295 user_label = gtk_label_new(_("Email:"));
3e7553ae
GB
296 user_entry = gtk_entry_new();
297 if (user != NULL)
298 gtk_entry_set_text(GTK_ENTRY(user_entry), user);
51c15f41
GB
299 else
300 {
301 const gchar *default_user = get_default_user();
302 if (default_user != NULL)
303 gtk_entry_set_text(GTK_ENTRY(user_entry), default_user);
304 }
3e7553ae
GB
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,
4c77d5e0
GB
310 _("The email used as login"),
311 _("Enter the email you use to login into www.openstreetmap.org."));
3e7553ae 312
4c77d5e0 313 password_label = gtk_label_new(_("Password:"));
3e7553ae
GB
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,
4c77d5e0
GB
324 _("The password used to login"),
325 _("Enter the password you use to login into www.openstreetmap.org."));
3e7553ae 326
4c77d5e0 327 name_label = gtk_label_new(_("File's name:"));
3e7553ae 328 name_entry = gtk_entry_new();
5092de80
GB
329 if (track_name != NULL)
330 name = track_name;
331 else
332 name = vik_layer_get_name(VIK_LAYER(vtl));
3e7553ae
GB
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,
4c77d5e0
GB
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."));
3e7553ae 342
4c77d5e0 343 description_label = gtk_label_new(_("Description:"));
3e7553ae
GB
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,
4c77d5e0 350 _("The description of the trace"),
3e7553ae
GB
351 "");
352
4c77d5e0 353 tags_label = gtk_label_new(_("Tags:"));
3e7553ae
GB
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,
4c77d5e0 360 _("The tags associated to the trace"),
3e7553ae
GB
361 "");
362
4c77d5e0 363 public = gtk_check_button_new_with_label(_("Public"));
3e7553ae
GB
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,
4c77d5e0 369 _("Indicates if the trace is public or not"),
3e7553ae
GB
370 "");
371
372 if ( gtk_dialog_run ( GTK_DIALOG(dia) ) == GTK_RESPONSE_ACCEPT )
373 {
374 gchar *title = NULL;
375
376 /* overwrite authentication info */
377 set_login(gtk_entry_get_text(GTK_ENTRY(user_entry)),
378 gtk_entry_get_text(GTK_ENTRY(password_entry)));
379
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));
5092de80 388 info->track_name = (track_name == NULL) ? NULL : g_strdup(track_name);
3e7553ae 389
4c77d5e0 390 title = g_strdup_printf(_("Uploading %s to OSM"), info->name);
3e7553ae
GB
391
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,
399 1 );
400 g_free ( title ); title = NULL;
401 }
402 gtk_widget_destroy ( dia );
403}
404
405/**
5092de80 406 * Function called by the entry menu of a TrwLayer
3e7553ae
GB
407 */
408void osm_traces_upload_cb ( gpointer layer_and_vlp[2], guint file_type )
409{
5092de80
GB
410 osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(layer_and_vlp[0]), NULL);
411}
412
413/**
414 * Function called by the entry menu of a single track
415 */
416void osm_traces_upload_track_cb ( gpointer pass_along[6] )
417{
418 osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(pass_along[0]), pass_along[3]);
3e7553ae 419}