X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/1918a9938c9bd96b339bb04763f18ecf79ed7552..3f31bec4a6927651bc562e8b21aa0c7354328e1b:/src/download.c?ds=sidebyside diff --git a/src/download.c b/src/download.c index 46a88b2d..d640d222 100644 --- a/src/download.c +++ b/src/download.c @@ -1,7 +1,10 @@ +/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */ /* * viking -- GPS Data and Topo Analyzer, Explorer, and Manager * * Copyright (C) 2003-2005, Evan Battaglia + * Copyright (C) 2007, Guilhem Bonnefille + * Copyright (C) 2013, Rob Norris * * 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 @@ -24,61 +27,39 @@ #endif #include -#include #include +#include #include -#include -#include -#include +#ifdef HAVE_SYS_TYPES_H #include +#endif +#ifdef HAVE_UTIME_H +#include +#endif +#include +#include +#include + +#ifdef HAVE_MAGIC_H +#include +#endif +#include "compression.h" #include "download.h" #include "curl_download.h" +#include "preferences.h" +#include "globals.h" -#ifdef WINDOWS - -#include -#define access(a,b) _access(a,b) -#define close(a) closesocket(a) - -char *dirname ( char * dir ) -{ - char *tmp = dir + strlen(dir) - 1; - while ( tmp != dir && *tmp != '\\' ) - tmp--; - *tmp = '\0'; - return dir; -} - -#else - -#include -#include - -/* dirname */ -#include - -#endif - -static int check_map_file(FILE* f) +static gboolean check_file_first_line(FILE* f, gchar *patterns[]) { - char **s; - char *bp; - int res = 0; /* good */ + gchar **s; + gchar *bp; fpos_t pos; - char buf[33]; + gchar buf[33]; size_t nr; - char * html_str[] = { - "= (buf + sizeof(buf) -1)) || ((bp - buf) >= nr)) - return(res); - for (s = html_str; *s; s++) { + return FALSE; + for (s = patterns; *s; s++) { if (strncasecmp(*s, bp, strlen(*s)) == 0) - return(-1); + return TRUE; } - return(res); + return FALSE; +} + +gboolean a_check_html_file(FILE* f) +{ + gchar * html_str[] = { + "message); + g_error_free(error); + return; + } + gchar *file_contents = g_mapped_file_get_contents ( mf ); + + void *unzip_mem = NULL; + gulong ucsize; + + if ((unzip_mem = unzip_file (file_contents, &ucsize)) == NULL) { + g_mapped_file_unref ( mf ); + return; + } + + // This overwrires any previous file contents + if ( ! g_file_set_contents ( name, unzip_mem, ucsize, &error ) ) { + g_critical ( "Couldn't write file '%s', because of %s", name, error->message ); + g_error_free ( error ); + } } -static int download( const char *hostname, const char *uri, const char *fn, DownloadOptions *options) +/** + * a_try_decompress_file: + * @name: The potentially compressed filename + * + * Perform magic to decide how which type of decompression to attempt + */ +void a_try_decompress_file (gchar *name) +{ +#ifdef HAVE_MAGIC_H + magic_t myt = magic_open ( MAGIC_CONTINUE|MAGIC_ERROR|MAGIC_MIME ); + gboolean zip = FALSE; + gboolean bzip2 = FALSE; + if ( myt ) { +#ifdef WINDOWS + // We have to 'package' the magic database ourselves :( + // --> %PROGRAM FILES%\Viking\magic.mgc + magic_load ( myt, "magic.mgc" ); +#else + // Use system default + magic_load ( myt, NULL ); +#endif + const char* magic = magic_file (myt, name); + g_debug ("%s: magic output: %s", __FUNCTION__, magic ); + + if ( g_strcmp0 (magic, "application/zip; charset=binary") == 0 ) + zip = TRUE; + + if ( g_strcmp0 (magic, "application/x-bzip2; charset=binary") == 0 ) + bzip2 = TRUE; + + magic_close ( myt ); + } + + if ( !(zip || bzip2) ) + return; + + if ( zip ) { + uncompress_zip ( name ); + } + else if ( bzip2 ) { + gchar* bz2_name = uncompress_bzip2 ( name ); + g_remove ( name ); + g_rename ( bz2_name, name ); + } + + return; +#endif +} + +static DownloadResult_t download( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *options, gboolean ftp, void *handle) { FILE *f; int ret; - char *tmpfilename; + gchar *tmpfilename; + gboolean failure = FALSE; + DownloadFileOptions file_options = {0, NULL, NULL}; /* Check file */ - if ( access ( fn, F_OK ) == 0 ) + if ( g_file_test ( fn, G_FILE_TEST_EXISTS ) == TRUE ) { - /* File exists: return */ - return -3; - } else { - if ( errno == ENOENT) - { - char *tmp = g_strdup ( fn ); -#ifdef WINDOWS - mkdir( dirname ( dirname ( tmp ) ) ); - g_free ( tmp ); tmp = g_strdup ( fn ); - mkdir( dirname ( tmp ) ); -#else - mkdir( dirname ( dirname ( tmp ) ), 0777 ); - g_free ( tmp ); tmp = g_strdup ( fn ); - mkdir( dirname ( tmp ), 0777 ); -#endif - g_free ( tmp ); + 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 DOWNLOAD_NOT_REQUIRED; + } + + 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 DOWNLOAD_NOT_REQUIRED; + } + + if (options->check_file_server_time) { + file_options.time_condition = file_time; } - /* create placeholder file */ - if ( ! (f = fopen ( fn, "w+b" )) ) /* immediately open file so other threads won't -- prevents race condition */ - return -4; - fclose ( f ); + 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); - f = fopen ( tmpfilename, "w+b" ); + 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 DOWNLOAD_FILE_WRITE_ERROR; + } + 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 ); - remove ( fn ); /* couldn't create temporary. delete 0-byte file. */ - return -4; + if (options->use_etag) + g_free ( file_options.etag ); + return DOWNLOAD_FILE_WRITE_ERROR; } /* Call the backend function */ - ret = curl_download_get_url ( hostname, uri, f, options ); + ret = curl_download_get_url ( hostname, uri, f, options, ftp, &file_options, handle ); + + DownloadResult_t result = DOWNLOAD_SUCCESS; + + if (ret != CURL_DOWNLOAD_NO_ERROR && ret != CURL_DOWNLOAD_NO_NEWER_FILE) { + g_debug("%s: download failed: curl_download_get_url=%d", __FUNCTION__, ret); + failure = TRUE; + result = DOWNLOAD_HTTP_ERROR; + } + + if (!failure && options != NULL && options->check_file != NULL && ! options->check_file(f)) { + g_debug("%s: file content checking failed", __FUNCTION__); + failure = TRUE; + result = DOWNLOAD_CONTENT_ERROR; + } - if (ret == -1 || ret == 1 || ret == -2 || check_map_file(f)) + fclose ( f ); + f = NULL; + + if (failure) { - g_warning("Download error: %s\n", fn); - fclose ( f ); - remove ( tmpfilename ); + g_warning(_("Download error: %s"), fn); + g_remove ( tmpfilename ); + unlock_file ( tmpfilename ); g_free ( tmpfilename ); - remove ( fn ); /* couldn't create temporary. delete 0-byte file. */ - return -1; + if (options->use_etag) { + g_free ( file_options.etag ); + g_free ( file_options.new_etag ); + } + return result; } - fclose ( f ); - rename ( tmpfilename, fn ); /* move completely-downloaded file to permanent location */ + if ( options->convert_file ) + options->convert_file ( tmpfilename ); + + 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 == CURL_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 ); - return ret; + + if (options->use_etag) { + g_free ( file_options.etag ); + g_free ( file_options.new_etag ); + } + return DOWNLOAD_SUCCESS; +} + +/** + * uri: like "/uri.html?whatever" + * only reason for the "wrapper" is so we can do redirects. + */ +DownloadResult_t 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 ); } -/* 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, DownloadOptions *opt ) +DownloadResult_t a_ftp_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *opt, void *handle ) { - return download ( hostname, uri, fn, opt ); + 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 ); +} + +/** + * a_download_url_to_tmp_file: + * @uri: The URI (Uniform Resource Identifier) + * @options: Download options (maybe NULL) + * + * returns name of the temporary file created - NULL if unsuccessful + * this string needs to be freed once used + * the file needs to be removed once used + */ +gchar *a_download_uri_to_tmp_file ( const gchar *uri, DownloadMapOptions *options ) +{ + FILE *tmp_file; + int tmp_fd; + gchar *tmpname; + + if ( (tmp_fd = g_file_open_tmp ("viking-download.XXXXXX", &tmpname, NULL)) == -1 ) { + g_critical (_("couldn't open temp file")); + return NULL; + } + + tmp_file = fdopen(tmp_fd, "r+"); + + if ( curl_download_uri ( uri, tmp_file, options, NULL, NULL ) ) { + // error + fclose ( tmp_file ); + g_remove ( tmpname ); + g_free ( tmpname ); + return NULL; + } + fclose ( tmp_file ); + + return tmpname; }