[andy/viking.git] / src / download.c

/*
 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
 *
 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
 * 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 <ctype.h>
#include <errno.h>
#include <string.h>
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#ifdef HAVE_UTIME_H
#include <utime.h>
#endif
#include <glib.h>
#include <glib/gstdio.h>
#include <glib/gi18n.h>


#include "download.h"

#include "curl_download.h"
#include "preferences.h"
#include "globals.h"

static gboolean check_file_first_line(FILE* f, gchar *patterns[])
{
  gchar **s;
  gchar *bp;
  fpos_t pos;
  gchar buf[33];
  size_t nr;

  memset(buf, 0, sizeof(buf));
  fgetpos(f, &pos);
  rewind(f);
  nr = fread(buf, 1, sizeof(buf) - 1, f);
  fsetpos(f, &pos);
  for (bp = buf; (bp < (buf + sizeof(buf) - 1)) && (nr > (bp - buf)); bp++) {
    if (!(isspace(*bp)))
      break;
  }
  if ((bp >= (buf + sizeof(buf) -1)) || ((bp - buf) >= nr))
    return FALSE;
  for (s = patterns; *s; s++) {
    if (strncasecmp(*s, bp, strlen(*s)) == 0)
      return TRUE;
  }
  return FALSE;
}

gboolean a_check_html_file(FILE* f)
{
  gchar * html_str[] = {
    "<html",
    "<!DOCTYPE html",
    "<head",
    "<title",
    NULL
  };

  return check_file_first_line(f, html_str);
}

gboolean a_check_map_file(FILE* f)
{
  /* FIXME no more true since a_check_kml_file */
  return !a_check_html_file(f);
}

gboolean a_check_kml_file(FILE* f)
{
  gchar * kml_str[] = {
    "<?xml",
    NULL
  };

  return check_file_first_line(f, kml_str);
}

static GList *file_list = NULL;
static GMutex *file_list_mutex = NULL;

/* spin button scales */
VikLayerParamScale params_scales[] = {
  {1, 86400*7, 60, 0},		/* download_tile_age */
};

static VikLayerParam prefs[] = {
  { VIKING_PREFERENCES_NAMESPACE "download_tile_age", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Tile age (s):"), VIK_LAYER_WIDGET_SPINBUTTON, params_scales + 0, NULL },
};

void a_download_init (void)
{
	VikLayerParamData tmp;
	tmp.u = VIK_CONFIG_DEFAULT_TILE_AGE;
	a_preferences_register(prefs, tmp, VIKING_PREFERENCES_GROUP_KEY);

	file_list_mutex = g_mutex_new();
}

static gboolean lock_file(const char *fn)
{
	gboolean locked = FALSE;
	g_mutex_lock(file_list_mutex);
	if (g_list_find_custom(file_list, fn, (GCompareFunc)g_strcmp0) == NULL)
	{
		// The filename is not yet locked
		file_list = g_list_append(file_list, (gpointer)fn),
		locked = TRUE;
	}
	g_mutex_unlock(file_list_mutex);
	return locked;
}

static void unlock_file(const char *fn)
{
	g_mutex_lock(file_list_mutex);
	file_list = g_list_remove(file_list, (gconstpointer)fn);
	g_mutex_unlock(file_list_mutex);
}

static int download( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *options, gboolean ftp, void *handle)
{
  FILE *f;
  int ret;
  gchar *tmpfilename;
  gboolean failure = FALSE;
  DownloadFileOptions file_options = {0, NULL, NULL};

  /* Check file */
  if ( g_file_test ( fn, G_FILE_TEST_EXISTS ) == TRUE )
  {
    if (options == NULL || (!options->check_file_server_time &&
                            !options->use_etag)) {
      /* Nothing to do as file already exists and we don't want to check server */
      return -3;
    }

    time_t tile_age = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "download_tile_age")->u;
    /* Get the modified time of this file */
    struct stat buf;
    g_stat ( fn, &buf );
    time_t file_time = buf.st_mtime;
    if ( (time(NULL) - file_time) < tile_age ) {
      /* File cache is too recent, so return */
      return -3;
    }

    if (options->check_file_server_time) {
      file_options.time_condition = file_time;
    }
    if (options->use_etag) {
      gchar *etag_filename = g_strdup_printf("%s.etag", fn);
      gsize etag_length = 0;
      g_file_get_contents (etag_filename, &(file_options.etag), &etag_length, NULL);
      g_free (etag_filename);
      etag_filename = NULL;

      /* check if etag is short enough */
      if (etag_length > 100) {
        g_free(file_options.etag);
        file_options.etag = NULL;
      }

      /* TODO: should check that etag is a valid string */
    }

  } else {
    gchar *dir = g_path_get_dirname ( fn );
    g_mkdir_with_parents ( dir , 0777 );
    g_free ( dir );
  }

  tmpfilename = g_strdup_printf("%s.tmp", fn);
  if (!lock_file ( tmpfilename ) )
  {
    g_debug("%s: Couldn't take lock on temporary file \"%s\"\n", __FUNCTION__, tmpfilename);
    g_free ( tmpfilename );
    if (options->use_etag)
      g_free ( file_options.etag );
    return -4;
  }
  f = g_fopen ( tmpfilename, "w+b" );  /* truncate file and open it */
  if ( ! f ) {
    g_warning("Couldn't open temporary file \"%s\": %s", tmpfilename, g_strerror(errno));
    g_free ( tmpfilename );
    if (options->use_etag)
      g_free ( file_options.etag );
    return -4;
  }

  /* Call the backend function */
  ret = curl_download_get_url ( hostname, uri, f, options, ftp, &file_options, handle );

  if (ret != DOWNLOAD_NO_ERROR && ret != DOWNLOAD_NO_NEWER_FILE) {
    g_debug("%s: download failed: curl_download_get_url=%d", __FUNCTION__, ret);
    failure = TRUE;
  }

  if (!failure && options != NULL && options->check_file != NULL && ! options->check_file(f)) {
    g_debug("%s: file content checking failed", __FUNCTION__);
    failure = TRUE;
  }

  fclose ( f );
  f = NULL;

  if (failure)
  {
    g_warning(_("Download error: %s"), fn);
    g_remove ( tmpfilename );
    unlock_file ( tmpfilename );
    g_free ( tmpfilename );
    if (options->use_etag) {
      g_free ( file_options.etag );
      g_free ( file_options.new_etag );
    }
    return -1;
  }

  if (options->use_etag) {
    if (file_options.new_etag) {
      /* server returned an etag value */
      gchar *etag_filename = g_strdup_printf("%s.etag", fn);
      g_file_set_contents (etag_filename, file_options.new_etag, -1, NULL);
      g_free (etag_filename);
      etag_filename = NULL;
    }
  }

  if (ret == DOWNLOAD_NO_NEWER_FILE)  {
    g_remove ( tmpfilename );
#if GLIB_CHECK_VERSION(2,18,0)
    g_utime ( fn, NULL ); /* update mtime of local copy */
#else
    utimes ( fn, NULL ); /* update mtime of local copy */
#endif
  } else {
    g_rename ( tmpfilename, fn ); /* move completely-downloaded file to permanent location */
  }
  unlock_file ( tmpfilename );
  g_free ( tmpfilename );

  if (options->use_etag) {
    g_free ( file_options.etag );
    g_free ( file_options.new_etag );
  }
  return 0;
}

/* success = 0, -1 = couldn't connect, -2 HTTP error, -3 file exists, -4 couldn't write to file... */
/* uri: like "/uri.html?whatever" */
/* only reason for the "wrapper" is so we can do redirects. */
int a_http_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *opt, void *handle )
{
  return download ( hostname, uri, fn, opt, FALSE, handle );
}

int a_ftp_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *opt, void *handle )
{
  return download ( hostname, uri, fn, opt, TRUE, handle );
}

void * a_download_handle_init ()
{
  return curl_download_handle_init ();
}

void a_download_handle_cleanup ( void *handle )
{
  curl_download_handle_cleanup ( handle );
}
Commit	Line	Data
85611cd9 GB	1	/*
	2	* viking -- GPS Data and Topo Analyzer, Explorer, and Manager
	3	*
	4	* Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
a482007a	5	* Copyright (C) 2007, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
85611cd9 GB	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	20	*
	21	*/
	22
3292ba8b GB	23	#ifdef HAVE_CONFIG_H
	24	#include "config.h"
	25	#endif
	26
932f8f22	27	#include <stdio.h>
6e78a423	28	#include <ctype.h>
6a4a29aa	29	#include <errno.h>
6e78a423	30	#include <string.h>
7de36baf	31	#ifdef HAVE_SYS_TYPES_H
6a4a29aa	32	#include <sys/types.h>
7de36baf GB	33	#endif
7de36baf GB	34	#ifdef HAVE_UTIME_H
6a4a29aa	35	#include <utime.h>
7de36baf	36	#endif
f83131b9 MA	37	#include <glib.h>
f83131b9 MA	38	#include <glib/gstdio.h>
4c77d5e0	39	#include <glib/gi18n.h>
932f8f22	40
6a4a29aa	41
85611cd9	42	#include "download.h"
3292ba8b	43
3292ba8b	44	#include "curl_download.h"
6693f5f9 GB	45	#include "preferences.h"
6693f5f9 GB	46	#include "globals.h"
85611cd9	47
388cf5a4	48	static gboolean check_file_first_line(FILE* f, gchar *patterns[])
6e78a423	49	{
533bbf34 MA	50	gchar **s;
533bbf34 MA	51	gchar *bp;
6e78a423	52	fpos_t pos;
533bbf34	53	gchar buf[33];
6e78a423	54	size_t nr;
6e78a423	55
c44594ee	56	memset(buf, 0, sizeof(buf));
6e78a423 QT	57	fgetpos(f, &pos);
	58	rewind(f);
	59	nr = fread(buf, 1, sizeof(buf) - 1, f);
	60	fsetpos(f, &pos);
	61	for (bp = buf; (bp < (buf + sizeof(buf) - 1)) && (nr > (bp - buf)); bp++) {
	62	if (!(isspace(*bp)))
	63	break;
	64	}
	65	if ((bp >= (buf + sizeof(buf) -1)) \|\| ((bp - buf) >= nr))
1ac37c09	66	return FALSE;
388cf5a4	67	for (s = patterns; *s; s++) {
1918a993	68	if (strncasecmp(s, bp, strlen(s)) == 0)
1ac37c09	69	return TRUE;
6e78a423	70	}
1ac37c09 GB	71	return FALSE;
	72	}
	73
388cf5a4 GB	74	gboolean a_check_html_file(FILE* f)
	75	{
	76	gchar * html_str[] = {
	77	"<html",
	78	"<!DOCTYPE html",
	79	"<head",
	80	"<title",
	81	NULL
	82	};
	83
	84	return check_file_first_line(f, html_str);
	85	}
	86
1ac37c09 GB	87	gboolean a_check_map_file(FILE* f)
1ac37c09 GB	88	{
388cf5a4	89	/* FIXME no more true since a_check_kml_file */
1ac37c09	90	return !a_check_html_file(f);
6e78a423 QT	91	}
6e78a423 QT	92
ae941b4c HMJ	93	gboolean a_check_kml_file(FILE* f)
ae941b4c HMJ	94	{
388cf5a4	95	gchar * kml_str[] = {
ae941b4c HMJ	96	"<?xml",
	97	NULL
	98	};
	99
388cf5a4	100	return check_file_first_line(f, kml_str);
ae941b4c HMJ	101	}
ae941b4c HMJ	102
4b992365 GB	103	static GList *file_list = NULL;
	104	static GMutex *file_list_mutex = NULL;
	105
6693f5f9 GB	106	/* spin button scales */
6693f5f9 GB	107	VikLayerParamScale params_scales[] = {
43812138	108	{1, 864007, 60, 0}, / download_tile_age */
6693f5f9 GB	109	};
	110
	111	static VikLayerParam prefs[] = {
	112	{ VIKING_PREFERENCES_NAMESPACE "download_tile_age", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Tile age (s):"), VIK_LAYER_WIDGET_SPINBUTTON, params_scales + 0, NULL },
	113	};
	114
4b992365 GB	115	void a_download_init (void)
4b992365 GB	116	{
6693f5f9 GB	117	VikLayerParamData tmp;
	118	tmp.u = VIK_CONFIG_DEFAULT_TILE_AGE;
	119	a_preferences_register(prefs, tmp, VIKING_PREFERENCES_GROUP_KEY);
	120
4b992365 GB	121	file_list_mutex = g_mutex_new();
	122	}
	123
	124	static gboolean lock_file(const char *fn)
	125	{
	126	gboolean locked = FALSE;
	127	g_mutex_lock(file_list_mutex);
2894744e	128	if (g_list_find_custom(file_list, fn, (GCompareFunc)g_strcmp0) == NULL)
4b992365 GB	129	{
	130	// The filename is not yet locked
	131	file_list = g_list_append(file_list, (gpointer)fn),
	132	locked = TRUE;
	133	}
	134	g_mutex_unlock(file_list_mutex);
	135	return locked;
	136	}
	137
	138	static void unlock_file(const char *fn)
	139	{
	140	g_mutex_lock(file_list_mutex);
	141	file_list = g_list_remove(file_list, (gconstpointer)fn);
	142	g_mutex_unlock(file_list_mutex);
	143	}
	144
b529dc9c	145	static int download( const char hostname, const char uri, const char fn, DownloadMapOptions options, gboolean ftp, void *handle)
932f8f22 GB	146	{
	147	FILE *f;
	148	int ret;
533bbf34	149	gchar *tmpfilename;
1ac37c09	150	gboolean failure = FALSE;
ab716260	151	DownloadFileOptions file_options = {0, NULL, NULL};
932f8f22 GB	152
932f8f22 GB	153	/* Check file */
45acf79e	154	if ( g_file_test ( fn, G_FILE_TEST_EXISTS ) == TRUE )
932f8f22	155	{
8853eed9 JJ	156	if (options == NULL \|\| (!options->check_file_server_time &&
	157	!options->use_etag)) {
	158	/* Nothing to do as file already exists and we don't want to check server */
6a4a29aa JJ	159	return -3;
6a4a29aa JJ	160	}
8853eed9	161
57ecf9cb JJ	162	time_t tile_age = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "download_tile_age")->u;
	163	/* Get the modified time of this file */
	164	struct stat buf;
	165	g_stat ( fn, &buf );
	166	time_t file_time = buf.st_mtime;
	167	if ( (time(NULL) - file_time) < tile_age ) {
	168	/* File cache is too recent, so return */
	169	return -3;
	170	}
	171
8853eed9	172	if (options->check_file_server_time) {
57ecf9cb	173	file_options.time_condition = file_time;
6a4a29aa	174	}
55246377	175	if (options->use_etag) {
f91cc826	176	gchar *etag_filename = g_strdup_printf("%s.etag", fn);
9137c580	177	gsize etag_length = 0;
f91cc826	178	g_file_get_contents (etag_filename, &(file_options.etag), &etag_length, NULL);
9137c580 GB	179	g_free (etag_filename);
9137c580 GB	180	etag_filename = NULL;
f91cc826 JJ	181
f91cc826 JJ	182	/* check if etag is short enough */
9137c580	183	if (etag_length > 100) {
f91cc826	184	g_free(file_options.etag);
9137c580 GB	185	file_options.etag = NULL;
9137c580 GB	186	}
f91cc826 JJ	187
f91cc826 JJ	188	/* TODO: should check that etag is a valid string */
55246377	189	}
f91cc826	190
932f8f22	191	} else {
a1618d62 MA	192	gchar *dir = g_path_get_dirname ( fn );
	193	g_mkdir_with_parents ( dir , 0777 );
	194	g_free ( dir );
3335ae4e EB	195	}
	196
	197	tmpfilename = g_strdup_printf("%s.tmp", fn);
4b992365 GB	198	if (!lock_file ( tmpfilename ) )
	199	{
	200	g_debug("%s: Couldn't take lock on temporary file \"%s\"\n", __FUNCTION__, tmpfilename);
	201	g_free ( tmpfilename );
9137c580 GB	202	if (options->use_etag)
9137c580 GB	203	g_free ( file_options.etag );
4b992365 GB	204	return -4;
	205	}
	206	f = g_fopen ( tmpfilename, "w+b" ); /* truncate file and open it */
3335ae4e	207	if ( ! f ) {
4b992365	208	g_warning("Couldn't open temporary file \"%s\": %s", tmpfilename, g_strerror(errno));
3335ae4e	209	g_free ( tmpfilename );
9137c580 GB	210	if (options->use_etag)
9137c580 GB	211	g_free ( file_options.etag );
3335ae4e	212	return -4;
932f8f22 GB	213	}
	214
	215	/* Call the backend function */
9a021e4f	216	ret = curl_download_get_url ( hostname, uri, f, options, ftp, &file_options, handle );
6a4a29aa JJ	217
6a4a29aa JJ	218	if (ret != DOWNLOAD_NO_ERROR && ret != DOWNLOAD_NO_NEWER_FILE) {
1ac37c09 GB	219	g_debug("%s: download failed: curl_download_get_url=%d", __FUNCTION__, ret);
	220	failure = TRUE;
	221	}
	222
	223	if (!failure && options != NULL && options->check_file != NULL && ! options->check_file(f)) {
	224	g_debug("%s: file content checking failed", __FUNCTION__);
	225	failure = TRUE;
	226	}
932f8f22	227
1ec35593 MA	228	fclose ( f );
	229	f = NULL;
	230
1ac37c09	231	if (failure)
932f8f22	232	{
4258f4e2	233	g_warning(_("Download error: %s"), fn);
8c060406	234	g_remove ( tmpfilename );
4b992365	235	unlock_file ( tmpfilename );
3335ae4e	236	g_free ( tmpfilename );
55246377 JJ	237	if (options->use_etag) {
	238	g_free ( file_options.etag );
	239	g_free ( file_options.new_etag );
	240	}
932f8f22 GB	241	return -1;
	242	}
	243
55246377 JJ	244	if (options->use_etag) {
	245	if (file_options.new_etag) {
	246	/* server returned an etag value */
f91cc826 JJ	247	gchar *etag_filename = g_strdup_printf("%s.etag", fn);
f91cc826 JJ	248	g_file_set_contents (etag_filename, file_options.new_etag, -1, NULL);
9137c580 GB	249	g_free (etag_filename);
9137c580 GB	250	etag_filename = NULL;
55246377 JJ	251	}
	252	}
	253
d4939f80	254	if (ret == DOWNLOAD_NO_NEWER_FILE) {
6a4a29aa	255	g_remove ( tmpfilename );
7de36baf GB	256	#if GLIB_CHECK_VERSION(2,18,0)
	257	g_utime ( fn, NULL ); /* update mtime of local copy */
	258	#else
d4939f80	259	utimes ( fn, NULL ); /* update mtime of local copy */
7de36baf	260	#endif
4945e425	261	} else {
6a4a29aa	262	g_rename ( tmpfilename, fn ); /* move completely-downloaded file to permanent location */
4945e425	263	}
4b992365	264	unlock_file ( tmpfilename );
6a4a29aa	265	g_free ( tmpfilename );
1ec35593	266
55246377 JJ	267	if (options->use_etag) {
	268	g_free ( file_options.etag );
	269	g_free ( file_options.new_etag );
	270	}
6a4a29aa	271	return 0;
932f8f22 GB	272	}
932f8f22 GB	273
85611cd9 GB	274	/* success = 0, -1 = couldn't connect, -2 HTTP error, -3 file exists, -4 couldn't write to file... */
	275	/* uri: like "/uri.html?whatever" */
	276	/* only reason for the "wrapper" is so we can do redirects. */
b529dc9c	277	int a_http_download_get_url ( const char hostname, const char uri, const char fn, DownloadMapOptions opt, void *handle )
85611cd9	278	{
825413ba	279	return download ( hostname, uri, fn, opt, FALSE, handle );
0c1044e9 EB	280	}
0c1044e9 EB	281
b529dc9c	282	int a_ftp_download_get_url ( const char hostname, const char uri, const char fn, DownloadMapOptions opt, void *handle )
0c1044e9	283	{
825413ba SW	284	return download ( hostname, uri, fn, opt, TRUE, handle );
	285	}
	286
	287	void * a_download_handle_init ()
	288	{
	289	return curl_download_handle_init ();
	290	}
	291
	292	void a_download_handle_cleanup ( void *handle )
	293	{
	294	curl_download_handle_cleanup ( handle );
85611cd9	295	}