[andy/viking.git] / src / osm-traces.c

/*
 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
 *
 * Copyright (C) 2007, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <time.h>

#include <curl/curl.h>
#include <curl/easy.h>

#include <glib.h>
#include <glib/gstdio.h>
#include <glib/gi18n.h>

#include "viking.h"
#include "viktrwlayer.h"
#include "osm-traces.h"
#include "gpx.h"
#include "background.h"
#include "preferences.h"

/* params will be osm_traces.username, osm_traces.password */
/* we have to make sure these don't collide. */
#define VIKING_OSM_TRACES_PARAMS_GROUP_KEY "osm_traces"
#define VIKING_OSM_TRACES_PARAMS_NAMESPACE "osm_traces."

/**
 * Login to use for OSM uploading.
 */
static gchar *user = NULL;

/**
 * Password to use for OSM uploading.
 */
static gchar *password = NULL;

/**
 * Mutex to protect auth. token
 */
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.
 */
typedef struct _OsmTracesInfo {
  gchar *name;
  gchar *description;
  gchar *tags;
  const OsmTraceVis_t *vistype;
  VikTrwLayer *vtl;
  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 },
};

/**
 * Free an OsmTracesInfo struct.
 */
static void oti_free(OsmTracesInfo *oti)
{
  if (oti) {
    /* Fields have been g_strdup'ed */
    g_free(oti->name); oti->name = NULL;
    g_free(oti->description); oti->description = NULL;
    g_free(oti->tags); oti->tags = NULL;
    
    g_object_unref(oti->vtl); oti->vtl = NULL;
  }
  /* Main struct has been g_malloc'ed */
  g_free(oti);
}

static const gchar *get_default_user()
{
  const gchar *default_user = NULL;

  /* Retrieve "standard" EMAIL varenv */
  default_user = g_getenv("EMAIL");

  return default_user;
}

static void set_login(const gchar *user_, const gchar *password_)
{
  /* Allocate mutex */
  if (login_mutex == NULL)
  {
    login_mutex = g_mutex_new();
  }
  g_mutex_lock(login_mutex);
  g_free(user); user = NULL;
  g_free(password); password = NULL;
  user        = g_strdup(user_);
  password    = g_strdup(password_);
  g_mutex_unlock(login_mutex);
}

static gchar *get_login()
{
  gchar *user_pass = NULL;
  g_mutex_lock(login_mutex);
  user_pass = g_strdup_printf("%s:%s", user, password);
  g_mutex_unlock(login_mutex);
  return user_pass;
}

/* initialisation */
void osm_traces_init () {
  /* Preferences */
  a_preferences_register_group ( VIKING_OSM_TRACES_PARAMS_GROUP_KEY, _("OpenStreetMap Traces") );

  VikLayerParamData tmp;
  tmp.s = "";
  a_preferences_register(prefs, tmp, VIKING_OSM_TRACES_PARAMS_GROUP_KEY);
  tmp.s = "";
  a_preferences_register(prefs+1, tmp, VIKING_OSM_TRACES_PARAMS_GROUP_KEY);

}

/*
 * Upload a file
 * 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;
  char curl_error_buffer[CURL_ERROR_SIZE];
  struct curl_slist *headers = NULL;
  struct curl_httppost *post=NULL;
  struct curl_httppost *last=NULL;

  char *base_url = "http://www.openstreetmap.org/api/0.6/gpx/create";

  gchar *user_pass = 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);

  /* Init CURL */
  curl = curl_easy_init();

  /* Filling the form */
  curl_formadd(&post, &last,
               CURLFORM_COPYNAME, "description",
               CURLFORM_COPYCONTENTS, description, CURLFORM_END);
  curl_formadd(&post, &last,
               CURLFORM_COPYNAME, "tags",
               CURLFORM_COPYCONTENTS, tags, CURLFORM_END);
  curl_formadd(&post, &last,
               CURLFORM_COPYNAME, "visibility",
               CURLFORM_COPYCONTENTS, vistype->apistr, CURLFORM_END);
  curl_formadd(&post, &last,
               CURLFORM_COPYNAME, "file",
               CURLFORM_FILE, file,
               CURLFORM_FILENAME, filename,
	       CURLFORM_CONTENTTYPE, "text/xml", CURLFORM_END);

  /* Prepare request */
  /* As explained in http://wiki.openstreetmap.org/index.php/User:LA2 */
  /* Expect: header seems to produce incompatibilites between curl and httpd */
  headers = curl_slist_append(headers, "Expect: ");
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_HTTPPOST, post);
  curl_easy_setopt(curl, CURLOPT_URL, base_url);
  curl_easy_setopt(curl, CURLOPT_USERPWD, user_pass);
  curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, curl_error_buffer);
  if (vik_verbose)
    curl_easy_setopt ( curl, CURLOPT_VERBOSE, 1 );

  /* Execute request */
  res = curl_easy_perform(curl);
  if (res == CURLE_OK)
  {
    long code;
    res = curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &code);
    if (res == CURLE_OK)
    {
      g_debug("received valid curl response: %ld", code);
      if (code != 200) {
        g_warning(_("failed to upload data: HTTP response is %ld"), code);
	result = code;
      }
    }
    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);
  return result;
}

/**
 * uploading function executed by the background" thread
 */
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 };
  FILE *file = NULL;
  gchar *filename = NULL;
  int fd;
  GError *error = NULL;
  int ret;

  g_assert(oti != NULL);

  /* Opening temporary file */
  fd = g_file_open_tmp("viking_osm_upload_XXXXXX.gpx", &filename, &error);
  if (fd < 0) {
    g_error(_("failed to open temporary file: %s"), strerror(errno));
    return;
  }
  g_clear_error(&error);
  g_debug("%s: temporary file = %s", __FUNCTION__, filename);

  /* Creating FILE* */
  file = fdopen(fd, "w");

  /* writing gpx file */
  if (oti->trk != NULL)
  {
    /* Upload only the selected track */
    a_gpx_write_track_file_options(&options, oti->trk, file);
  }
  else
  {
    /* Upload the whole VikTrwLayer */
    a_gpx_write_file_options(&options, oti->vtl, file);
  }
  
  /* We can close the file */
  /* This also close the associated fd */
  fclose(file);
  file = NULL;

  /* finally, upload it */
  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_critical(_("failed to unlink temporary file: %s"), strerror(errno));
  }
}

/**
 * Uploading a VikTrwLayer
 *
 * @param vtl VikTrwLayer
 * @param trk if not null, the track to upload
 */
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),
                                                 GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
                                                 GTK_STOCK_CANCEL,
                                                 GTK_RESPONSE_REJECT,
                                                 GTK_STOCK_OK,
                                                 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;
  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_set_tooltip_markup(GTK_WIDGET(user_entry),
                        _("The email used as login\n"
                        "<small>Enter the email you use to login into www.openstreetmap.org.</small>"));

  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_set_tooltip_markup(GTK_WIDGET(password_entry),
                        _("The password used to login\n"
                        "<small>Enter the password you use to login into www.openstreetmap.org.</small>"));

  name_label = gtk_label_new(_("File's name:"));
  name_entry = gtk_entry_new();
  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_set_tooltip_markup(GTK_WIDGET(name_entry),
                        _("The name of the file on OSM\n"
                        "<small>This is the name of the file created on the server."
			"This is not the name of the local file.</small>"));

  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_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_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)));

    /* Storing data for the future thread */
    OsmTracesInfo *info = g_malloc(sizeof(OsmTracesInfo));
    info->name        = g_strdup(gtk_entry_get_text(GTK_ENTRY(name_entry)));
    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->vistype     = &OsmTraceVis[gtk_combo_box_get_active(visibility)];
    info->vtl         = VIK_TRW_LAYER(g_object_ref(vtl));
    info->trk         = trk;

    title = g_strdup_printf(_("Uploading %s to OSM"), info->name);

    /* launch the thread */
    a_background_thread(VIK_GTK_WINDOW_FROM_LAYER(vtl),          /* parent window */
			title,                                   /* description string */
			(vik_thr_func) osm_traces_upload_thread, /* function to call within thread */
			info,                                    /* pass along data */
			(vik_thr_free_func) oti_free,            /* function to free pass along data */
			(vik_thr_free_func) NULL,
			1 );
    g_free ( title ); title = NULL;
  }
  gtk_widget_destroy ( dia );
}

/**
 * Function called by the entry menu of a TrwLayer
 */
void osm_traces_upload_cb ( gpointer layer_and_vlp[2], guint file_type )
{
  osm_traces_upload_viktrwlayer(VIK_TRW_LAYER(layer_and_vlp[0]), NULL);
}

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