src/osm-traces.c

   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  */
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25 #include <stdio.h>
  26 #include <string.h>
  27 #include <errno.h>
  28 #include <time.h>
  29
  30 #include <curl/curl.h>
  31 #include <curl/easy.h>
  32
  33 #include <glib.h>
  34 #include <glib/gstdio.h>
  35 #include <glib/gi18n.h>
  36
  37 #include "viking.h"
  38 #include "viktrwlayer.h"
  39 #include "osm-traces.h"
  40 #include "gpx.h"
  41 #include "background.h"
  42 #include "preferences.h"
  43
  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."
  48
  49 /**
  50  * Login to use for OSM uploading.
  51  */
  52 static gchar *user = NULL;
  53
  54 /**
  55  * Password to use for OSM uploading.
  56  */
  57 static gchar *password = NULL;
  58
  59 /**
  60  * Mutex to protect auth. token
  61  */
  62 static GMutex *login_mutex = NULL;
  63
  64 /**
  65  * Different type of trace visibility.
  66  */
  67 typedef struct _OsmTraceVis_t {
  68         const gchar *combostr;
  69         const gchar *apistr;
  70 } OsmTraceVis_t;
  71
  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" },
  77         { NULL, NULL },
  78 };
  79
  80 /**
  81  * Struct hosting needed info.
  82  */
  83 typedef struct _OsmTracesInfo {
  84   gchar *name;
  85   gchar *description;
  86   gchar *tags;
  87   const OsmTraceVis_t *vistype;
  88   VikTrwLayer *vtl;
  89   gchar *track_name;
  90 } OsmTracesInfo;
  91
  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 },
  95 };
  96
  97 /**
  98  * Free an OsmTracesInfo struct.
  99  */
 100 static void oti_free(OsmTracesInfo *oti)
 101 {
 102   if (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;
 108
 109     g_object_unref(oti->vtl); oti->vtl = NULL;
 110   }
 111   /* Main struct has been g_malloc'ed */
 112   g_free(oti);
 113 }
 114
 115 static const gchar *get_default_user()
 116 {
 117   const gchar *default_user = NULL;
 118
 119   /* Retrieve "standard" EMAIL varenv */
 120   default_user = g_getenv("EMAIL");
 121
 122   return default_user;
 123 }
 124
 125 static void set_login(const gchar *user_, const gchar *password_)
 126 {
 127   /* Allocate mutex */
 128   if (login_mutex == NULL)
 129   {
 130     login_mutex = g_mutex_new();
 131   }
 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);
 138 }
 139
 140 static gchar *get_login()
 141 {
 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);
 146   return user_pass;
 147 }
 148
 149 /* initialisation */
 150 void osm_traces_init () {
 151   /* Preferences */
 152   a_preferences_register_group ( VIKING_OSM_TRACES_PARAMS_GROUP_KEY, _("OpenStreetMap Traces") );
 153
 154   VikLayerParamData tmp;
 155   tmp.s = "";
 156   a_preferences_register(prefs, tmp, VIKING_OSM_TRACES_PARAMS_GROUP_KEY);
 157   tmp.s = "";
 158   a_preferences_register(prefs+1, tmp, VIKING_OSM_TRACES_PARAMS_GROUP_KEY);
 159
 160 }
 161
 162 /*
 163  * Upload a file
 164  * returns a basic status:
 165  *   < 0  : curl error
 166  *   == 0 : OK
 167  *   > 0  : HTTP error
 168   */
 169 static gint osm_traces_upload_file(const char *user,
 170                                    const char *password,
 171                                    const char *file,
 172                                    const char *filename,
 173                                    const char *description,
 174                                    const char *tags,
 175                                    const OsmTraceVis_t *vistype)
 176 {
 177   CURL *curl;
 178   CURLcode res;
 179   char curl_error_buffer[CURL_ERROR_SIZE];
 180   struct curl_slist *headers = NULL;
 181   struct curl_httppost *post=NULL;
 182   struct curl_httppost *last=NULL;
 183
 184   char *base_url = "http://www.openstreetmap.org/api/0.6/gpx/create";
 185
 186   gchar *user_pass = get_login();
 187
 188   gint result = 0; // Default to it worked!
 189
 190   g_debug("%s: %s %s %s %s %s %s", __FUNCTION__,
 191           user, password, file, filename, description, tags);
 192
 193   /* Init CURL */
 194   curl = curl_easy_init();
 195
 196   /* Filling the form */
 197   curl_formadd(&post, &last,
 198                CURLFORM_COPYNAME, "description",
 199                CURLFORM_COPYCONTENTS, description, CURLFORM_END);
 200   curl_formadd(&post, &last,
 201                CURLFORM_COPYNAME, "tags",
 202                CURLFORM_COPYCONTENTS, tags, CURLFORM_END);
 203   curl_formadd(&post, &last,
 204                CURLFORM_COPYNAME, "visibility",
 205                CURLFORM_COPYCONTENTS, vistype->apistr, CURLFORM_END);
 206   curl_formadd(&post, &last,
 207                CURLFORM_COPYNAME, "file",
 208                CURLFORM_FILE, file,
 209                CURLFORM_FILENAME, filename,
 210                CURLFORM_CONTENTTYPE, "text/xml", CURLFORM_END);
 211
 212   /* Prepare request */
 213   /* As explained in http://wiki.openstreetmap.org/index.php/User:LA2 */
 214   /* Expect: header seems to produce incompatibilites between curl and httpd */
 215   headers = curl_slist_append(headers, "Expect: ");
 216   curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
 217   curl_easy_setopt(curl, CURLOPT_HTTPPOST, post);
 218   curl_easy_setopt(curl, CURLOPT_URL, base_url);
 219   curl_easy_setopt(curl, CURLOPT_USERPWD, user_pass);
 220   curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
 221   curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, curl_error_buffer);
 222   if (vik_verbose)
 223     curl_easy_setopt ( curl, CURLOPT_VERBOSE, 1 );
 224
 225   /* Execute request */
 226   res = curl_easy_perform(curl);
 227   if (res == CURLE_OK)
 228   {
 229     long code;
 230     res = curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &code);
 231     if (res == CURLE_OK)
 232     {
 233       g_debug("received valid curl response: %ld", code);
 234       if (code != 200) {
 235         g_warning(_("failed to upload data: HTTP response is %ld"), code);
 236         result = code;
 237       }
 238     }
 239     else {
 240       g_error(_("curl_easy_getinfo failed: %d"), res);
 241       result = -1;
 242     }
 243   }
 244   else {
 245     g_warning(_("curl request failed: %s"), curl_error_buffer);
 246     result = -2;
 247   }
 248
 249   /* Memory */
 250   g_free(user_pass); user_pass = NULL;
 251
 252   curl_formfree(post);
 253   curl_easy_cleanup(curl);
 254   return result;
 255 }
 256
 257 /**
 258  * uploading function executed by the background" thread
 259  */
 260 static void osm_traces_upload_thread ( OsmTracesInfo *oti, gpointer threaddata )
 261 {
 262   /* Due to OSM limits, we have to enforce ele and time fields */
 263   static GpxWritingOptions options = { TRUE, TRUE };
 264   FILE *file = NULL;
 265   gchar *filename = NULL;
 266   int fd;
 267   GError *error = NULL;
 268   int ret;
 269
 270   g_assert(oti != NULL);
 271
 272   /* Opening temporary file */
 273   fd = g_file_open_tmp("viking_osm_upload_XXXXXX.gpx", &filename, &error);
 274   if (fd < 0) {
 275     g_error(_("failed to open temporary file: %s"), strerror(errno));
 276     return;
 277   }
 278   g_clear_error(&error);
 279   g_debug("%s: temporary file = %s", __FUNCTION__, filename);
 280
 281   /* Creating FILE* */
 282   file = fdopen(fd, "w");
 283
 284   /* writing gpx file */
 285   if (oti->track_name != NULL)
 286   {
 287     /* Upload only the selected track */
 288     VikTrack *track = vik_trw_layer_get_track(oti->vtl, oti->track_name);
 289     a_gpx_write_track_file_options(&options, oti->track_name, track, file);
 290   }
 291   else
 292   {
 293     /* Upload the whole VikTrwLayer */
 294     a_gpx_write_file_options(&options, oti->vtl, file);
 295   }
 296
 297   /* We can close the file */
 298   /* This also close the associated fd */
 299   fclose(file);
 300   file = NULL;
 301
 302   /* finally, upload it */
 303   gint ans = osm_traces_upload_file(user, password, filename,
 304                    oti->name, oti->description, oti->tags, oti->vistype);
 305
 306   //
 307   // Show result in statusbar or failure in dialog for user feedback
 308   //
 309
 310   // Get current time to put into message to show when result was generated
 311   //  since need to show difference between operations (when displayed on statusbar)
 312   // NB If on dialog then don't need time.
 313   time_t timenow;
 314   struct tm* timeinfo;
 315   time ( &timenow );
 316   timeinfo = localtime ( &timenow );
 317   gchar timestr[80];
 318   // Compact time only - as days/date isn't very useful here
 319   strftime ( timestr, sizeof(timestr), "%X)", timeinfo );
 320
 321   //
 322   // Test to see if window it was invoked on is still valid
 323   // Not sure if this test really works! (i.e. if the window was closed in the mean time)
 324   //
 325   if ( IS_VIK_WINDOW ((VikWindow *)VIK_GTK_WINDOW_FROM_LAYER(oti->vtl)) ) {
 326     gchar* msg;
 327     if ( ans == 0 ) {
 328       // Success
 329       msg = g_strdup_printf ( "%s (@%s)", _("Uploaded to OSM"), timestr );
 330       vik_statusbar_set_message ( vik_window_get_statusbar ( (VikWindow *)VIK_GTK_WINDOW_FROM_LAYER(oti->vtl) ), VIK_STATUSBAR_INFO, msg );
 331     }
 332     // Use UPPER CASE for bad news :(
 333     else if ( ans < 0 ) {
 334       msg = g_strdup_printf ( "%s (@%s)", _("FAILED TO UPLOAD DATA TO OSM - CURL PROBLEM"), timestr );
 335       vik_statusbar_set_message ( vik_window_get_statusbar ( (VikWindow *)VIK_GTK_WINDOW_FROM_LAYER(oti->vtl) ), VIK_STATUSBAR_INFO, msg );
 336       //a_dialog_error_msg ( VIK_GTK_WINDOW_FROM_LAYER(oti->vtl), msg );
 337     }
 338     else {
 339       msg = g_strdup_printf ( "%s : %s %d (@%s)", _("FAILED TO UPLOAD DATA TO OSM"), _("HTTP response code"), ans, timestr );
 340       vik_statusbar_set_message ( vik_window_get_statusbar ( (VikWindow *)VIK_GTK_WINDOW_FROM_LAYER(oti->vtl) ), VIK_STATUSBAR_INFO, msg );
 341       VikTrwLayer *vtl = oti->vtl;
 342       // Crashes here - multi-thread issue...
 343       //a_dialog_error_msg ( VIK_GTK_WINDOW_FROM_LAYER(vtl), msg );
 344     }
 345     g_free (msg);
 346   }
 347   /* Removing temporary file */
 348   ret = g_unlink(filename);
 349   if (ret != 0) {
 350     g_error(_("failed to unlink temporary file: %s"), strerror(errno));
 351   }
 352 }
 353
 354 /**
 355  * Uploading a VikTrwLayer
 356  *
 357  * @param vtl VikTrwLayer
 358  * @param track_name if not null, the name of the track to upload
 359  */
 360 static void osm_traces_upload_viktrwlayer ( VikTrwLayer *vtl, const gchar *track_name )
 361 {
 362   GtkWidget *dia = gtk_dialog_new_with_buttons (_("OSM upload"),
 363                                                  VIK_GTK_WINDOW_FROM_LAYER(vtl),
 364                                                  GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
 365                                                  GTK_STOCK_CANCEL,
 366                                                  GTK_RESPONSE_REJECT,
 367                                                  GTK_STOCK_OK,
 368                                                  GTK_RESPONSE_ACCEPT,
 369                                                  NULL);
 370
 371   const gchar *default_user = get_default_user();
 372   const gchar *pref_user = a_preferences_get(VIKING_OSM_TRACES_PARAMS_NAMESPACE "username")->s;
 373   const gchar *pref_password = a_preferences_get(VIKING_OSM_TRACES_PARAMS_NAMESPACE "password")->s;
 374   const gchar *name = NULL;
 375   GtkWidget *user_label, *user_entry;
 376   GtkWidget *password_label, *password_entry;
 377   GtkWidget *name_label, *name_entry;
 378   GtkWidget *description_label, *description_entry;
 379   GtkWidget *tags_label, *tags_entry;
 380   GtkComboBox *visibility;
 381   const OsmTraceVis_t *vis_t;
 382
 383   user_label = gtk_label_new(_("Email:"));
 384   user_entry = gtk_entry_new();
 385   if (user != NULL && user[0] != '\0')
 386     gtk_entry_set_text(GTK_ENTRY(user_entry), user);
 387   else if (pref_user != NULL && pref_user[0] != '\0')
 388     gtk_entry_set_text(GTK_ENTRY(user_entry), pref_user);
 389   else if (default_user != NULL)
 390     gtk_entry_set_text(GTK_ENTRY(user_entry), default_user);
 391   gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), user_label, FALSE, FALSE, 0);
 392   gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), user_entry, FALSE, FALSE, 0);
 393   gtk_widget_set_tooltip_markup(GTK_WIDGET(user_entry),
 394                         _("The email used as login\n"
 395                         "<small>Enter the email you use to login into www.openstreetmap.org.</small>"));
 396
 397   password_label = gtk_label_new(_("Password:"));
 398   password_entry = gtk_entry_new();
 399   if (password != NULL && password[0] != '\0')
 400     gtk_entry_set_text(GTK_ENTRY(password_entry), password);
 401   else if (pref_password != NULL)
 402     gtk_entry_set_text(GTK_ENTRY(password_entry), pref_password);
 403   /* This is a password -> invisible */
 404   gtk_entry_set_visibility(GTK_ENTRY(password_entry), FALSE);
 405   gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), password_label, FALSE, FALSE, 0);
 406   gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), password_entry, FALSE, FALSE, 0);
 407   gtk_widget_set_tooltip_markup(GTK_WIDGET(password_entry),
 408                         _("The password used to login\n"
 409                         "<small>Enter the password you use to login into www.openstreetmap.org.</small>"));
 410
 411   name_label = gtk_label_new(_("File's name:"));
 412   name_entry = gtk_entry_new();
 413   if (track_name != NULL)
 414     name = track_name;
 415   else
 416     name = vik_layer_get_name(VIK_LAYER(vtl));
 417   gtk_entry_set_text(GTK_ENTRY(name_entry), name);
 418   gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), name_label, FALSE, FALSE, 0);
 419   gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), name_entry, FALSE, FALSE, 0);
 420   gtk_widget_set_tooltip_markup(GTK_WIDGET(name_entry),
 421                         _("The name of the file on OSM\n"
 422                         "<small>This is the name of the file created on the server."
 423                         "This is not the name of the local file.</small>"));
 424
 425   description_label = gtk_label_new(_("Description:"));
 426   description_entry = gtk_entry_new();
 427   gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), description_label, FALSE, FALSE, 0);
 428   gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), description_entry, FALSE, FALSE, 0);
 429   gtk_widget_set_tooltip_text(GTK_WIDGET(description_entry),
 430                         _("The description of the trace"));
 431
 432   tags_label = gtk_label_new(_("Tags:"));
 433   tags_entry = gtk_entry_new();
 434   gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), tags_label, FALSE, FALSE, 0);
 435   gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), tags_entry, FALSE, FALSE, 0);
 436   gtk_widget_set_tooltip_text(GTK_WIDGET(tags_entry),
 437                         _("The tags associated to the trace"));
 438
 439   visibility = GTK_COMBO_BOX(gtk_combo_box_new_text ());
 440   for (vis_t = OsmTraceVis; vis_t->combostr != NULL; vis_t++)
 441         gtk_combo_box_append_text(visibility, vis_t->combostr);
 442   /* Set identifiable by default */
 443   gtk_combo_box_set_active(visibility, 0);
 444   gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dia)->vbox), GTK_WIDGET(visibility), FALSE, FALSE, 0);
 445
 446   /* User should think about it first... */
 447   gtk_dialog_set_default_response ( GTK_DIALOG(dia), GTK_RESPONSE_REJECT );
 448
 449   gtk_widget_show_all ( dia );
 450   gtk_widget_grab_focus ( description_entry );
 451
 452   if ( gtk_dialog_run ( GTK_DIALOG(dia) ) == GTK_RESPONSE_ACCEPT )
 453   {
 454     gchar *title = NULL;
 455
 456     /* overwrite authentication info */
 457     set_login(gtk_entry_get_text(GTK_ENTRY(user_entry)),
 458               gtk_entry_get_text(GTK_ENTRY(password_entry)));
 459
 460     /* Storing data for the future thread */
 461     OsmTracesInfo *info = g_malloc(sizeof(OsmTracesInfo));
 462     info->name        = g_strdup(gtk_entry_get_text(GTK_ENTRY(name_entry)));
 463     info->description = g_strdup(gtk_entry_get_text(GTK_ENTRY(description_entry)));
 464     /* TODO Normalize tags: they will be used as URL part */
 465     info->tags        = g_strdup(gtk_entry_get_text(GTK_ENTRY(tags_entry)));
 466     info->vistype     = &OsmTraceVis[gtk_combo_box_get_active(visibility)];
 467     info->vtl         = VIK_TRW_LAYER(g_object_ref(vtl));
 468     info->track_name  = (track_name == NULL) ? NULL : g_strdup(track_name);
 469
 470     title = g_strdup_printf(_("Uploading %s to OSM"), info->name);
 471
 472     /* launch the thread */
 473     a_background_thread(VIK_GTK_WINDOW_FROM_LAYER(vtl),          /* parent window */
 474                         title,                                   /* description string */
 475                         (vik_thr_func) osm_traces_upload_thread, /* function to call within thread */
 476                         info,                                    /* pass along data */
 477                         (vik_thr_free_func) oti_free,            /* function to free pass along data */
 478                         (vik_thr_free_func) NULL,
 479                         1 );
 480     g_free ( title ); title = NULL;
 481   }
 482   gtk_widget_destroy ( dia );
 483 }
 484
 485 /**
 486  * Function called by the entry menu of a TrwLayer
 487  */
 488 void osm_traces_upload_cb ( gpointer layer_and_vlp[2], guint file_type )
 489 {
 490   osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(layer_and_vlp[0]), NULL);
 491 }
 492
 493 /**
 494  * Function called by the entry menu of a single track
 495  */
 496 void osm_traces_upload_track_cb ( gpointer pass_along[6] )
 497 {
 498   osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(pass_along[0]), pass_along[3]);
 499 }