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

/*
 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
 *
 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
 *
 * 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, 10, 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(file_list, fn) == 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;
    }

    if (options->check_file_server_time) {
      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 );
      file_options.time_condition = buf.st_mtime;
      if ( (time(NULL) - file_options.time_condition) < tile_age )
				/* File cache is too recent, so return */
				return -3;
    }
    if (options->use_etag) {
      file_options.etag = g_strdup_printf ("");
    }
  } 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 );
    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 );
    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 );
    }
    g_remove ( fn ); /* couldn't create temporary. delete 0-byte file. */
    return -1;
  }

  if (options->use_etag) {
    if (file_options.new_etag) {
      /* server returned an etag value */
      printf("got etag %s\n", file_options.new_etag);
    }
  }

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