[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."

#define VIK_SETTINGS_OSM_TRACE_VIS "osm_trace_visibility"
static gint last_active = -1;

/**
 * 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[] = {
  { VIK_LAYER_NUM_TYPES, VIKING_OSM_TRACES_PARAMS_NAMESPACE "username", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("OSM username:"), VIK_LAYER_WIDGET_ENTRY, NULL, NULL, NULL },
  { VIK_LAYER_NUM_TYPES, VIKING_OSM_TRACES_PARAMS_NAMESPACE "password", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("OSM password:"), VIK_LAYER_WIDGET_PASSWORD, NULL, NULL, NULL },
};

/**
 * 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;
}

void osm_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);
}

gchar *osm_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 = osm_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
   also don't upload invisible tracks */
  static GpxWritingOptions options = { TRUE, TRUE, FALSE, FALSE };
  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(oti->trk, file, &options);
  }
  else
  {
    /* Upload the whole VikTrwLayer */
    a_gpx_write_file(oti->vtl, file, &options);
  }
  
  /* 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 );
    }
    vik_window_statusbar_update ( (VikWindow*)VIK_GTK_WINDOW_FROM_LAYER(oti->vtl), msg, VIK_STATUSBAR_INFO );
    g_free (msg);
  }
  /* Removing temporary file */
  ret = g_unlink(filename);
  if (ret != 0) {
    g_critical(_("failed to unlink temporary file: %s"), strerror(errno));
  }
}

/**
 *
 */
void osm_login_widgets (GtkWidget *user_entry, GtkWidget *password_entry)
{
  if (!user_entry || !password_entry)
    return;

  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;

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

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

/**
 * 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 *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;
  GtkWidget *visibility;
  const OsmTraceVis_t *vis_t;

  user_label = gtk_label_new(_("Email:"));
  user_entry = gtk_entry_new();
  gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), user_label, FALSE, FALSE, 0);
  gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), 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();
  gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), password_label, FALSE, FALSE, 0);
  gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), 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>"));

  osm_login_widgets ( user_entry, password_entry );

  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_get_content_area(GTK_DIALOG(dia))), name_label, FALSE, FALSE, 0);
  gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), 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_get_content_area(GTK_DIALOG(dia))), description_label, FALSE, FALSE, 0);
  gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), 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_get_content_area(GTK_DIALOG(dia))), tags_label, FALSE, FALSE, 0);
  gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), tags_entry, FALSE, FALSE, 0);
  gtk_widget_set_tooltip_text(GTK_WIDGET(tags_entry),
                        _("The tags associated to the trace"));

  visibility = vik_combo_box_text_new();
  for (vis_t = OsmTraceVis; vis_t->combostr != NULL; vis_t++)
    vik_combo_box_text_append (visibility, vis_t->combostr);

  // Set identifiable by default or use the settings for the value
  if ( last_active < 0 ) {
    gint find_entry = -1;
    gint wanted_entry = -1;
    gchar *vis = NULL;
    if ( a_settings_get_string ( VIK_SETTINGS_OSM_TRACE_VIS, &vis ) ) {
      // Use setting
      if ( vis ) {
        for (vis_t = OsmTraceVis; vis_t->apistr != NULL; vis_t++) {
          find_entry++;
          if (!strcmp(vis, vis_t->apistr)) {
            wanted_entry = find_entry;
          }
        }
      }
      // If not found set it to the first entry, otherwise use the entry
      last_active = ( wanted_entry < 0 ) ? 0 : wanted_entry;
    }
    else
      last_active = 0;
  }
  gtk_combo_box_set_active(GTK_COMBO_BOX(visibility), last_active);
  gtk_box_pack_start(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dia))), 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 */
    osm_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(GTK_COMBO_BOX(visibility))];
    info->vtl         = VIK_TRW_LAYER(g_object_ref(vtl));
    info->trk         = trk;

    // Save visibility value for default reuse
    last_active = gtk_combo_box_get_active(GTK_COMBO_BOX(visibility));
    a_settings_set_string ( VIK_SETTINGS_OSM_TRACE_VIS, OsmTraceVis[last_active].apistr );

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