X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/514db2ce38f8fb0ad74c7922441c82b2b6cb61e3..c2cf03332f51a9fa992220124635f737399fba91:/src/download.c?ds=sidebyside diff --git a/src/download.c b/src/download.c index f68b7b7b..ef75b02f 100644 --- a/src/download.c +++ b/src/download.c @@ -1,8 +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 @@ -38,12 +40,17 @@ #include #include +#ifdef HAVE_MAGIC_H +#include +#endif +#include "compression.h" #include "download.h" #include "curl_download.h" #include "preferences.h" #include "globals.h" +#include "vik_compat.h" static gboolean check_file_first_line(FILE* f, gchar *patterns[]) { @@ -104,21 +111,37 @@ 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 VikLayerParamScale params_scales[] = { + {1, 365, 1, 0}, /* download_tile_age */ }; +static VikLayerParamData convert_to_display ( VikLayerParamData value ) +{ + // From seconds into days + return VIK_LPD_UINT ( value.u / 86400 ); +} + +static VikLayerParamData convert_to_internal ( VikLayerParamData value ) +{ + // From days into seconds + return VIK_LPD_UINT ( 86400 * value.u ); +} + 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 }, + { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_NAMESPACE "download_tile_age", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Tile age (days):"), VIK_LAYER_WIDGET_SPINBUTTON, ¶ms_scales[0], NULL, NULL, NULL, convert_to_display, convert_to_internal }, }; void a_download_init (void) { VikLayerParamData tmp; - tmp.u = VIK_CONFIG_DEFAULT_TILE_AGE; + tmp.u = VIK_CONFIG_DEFAULT_TILE_AGE / 86400; // Now in days a_preferences_register(prefs, tmp, VIKING_PREFERENCES_GROUP_KEY); + file_list_mutex = vik_mutex_new(); +} - file_list_mutex = g_mutex_new(); +void a_download_uninit (void) +{ + vik_mutex_free(file_list_mutex); } static gboolean lock_file(const char *fn) @@ -142,7 +165,84 @@ static void unlock_file(const char *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) + +static void uncompress_zip ( gchar *name ) +{ + GError *error = NULL; + GMappedFile *mf; + + if ((mf = g_mapped_file_new ( name, FALSE, &error )) == NULL) { + g_critical(_("Couldn't map file %s: %s"), name, error->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 ); + } +} + +/** + * 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; @@ -156,7 +256,7 @@ static int download( const char *hostname, const char *uri, const char *fn, Down 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; + return DOWNLOAD_NOT_REQUIRED; } time_t tile_age = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "download_tile_age")->u; @@ -166,7 +266,7 @@ static int download( const char *hostname, const char *uri, const char *fn, Down time_t file_time = buf.st_mtime; if ( (time(NULL) - file_time) < tile_age ) { /* File cache is too recent, so return */ - return -3; + return DOWNLOAD_NOT_REQUIRED; } if (options->check_file_server_time) { @@ -201,7 +301,7 @@ static int download( const char *hostname, const char *uri, const char *fn, Down g_free ( tmpfilename ); if (options->use_etag) g_free ( file_options.etag ); - return -4; + return DOWNLOAD_FILE_WRITE_ERROR; } f = g_fopen ( tmpfilename, "w+b" ); /* truncate file and open it */ if ( ! f ) { @@ -209,20 +309,24 @@ static int download( const char *hostname, const char *uri, const char *fn, Down g_free ( tmpfilename ); if (options->use_etag) g_free ( file_options.etag ); - return -4; + return DOWNLOAD_FILE_WRITE_ERROR; } /* 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) { + 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; } fclose ( f ); @@ -238,9 +342,12 @@ static int download( const char *hostname, const char *uri, const char *fn, Down g_free ( file_options.etag ); g_free ( file_options.new_etag ); } - return -1; + return result; } + if ( options->convert_file ) + options->convert_file ( tmpfilename ); + if (options->use_etag) { if (file_options.new_etag) { /* server returned an etag value */ @@ -251,7 +358,7 @@ static int download( const char *hostname, const char *uri, const char *fn, Down } } - if (ret == DOWNLOAD_NO_NEWER_FILE) { + 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 */ @@ -259,7 +366,9 @@ static int download( const char *hostname, const char *uri, const char *fn, Down utimes ( fn, NULL ); /* update mtime of local copy */ #endif } else { - g_rename ( tmpfilename, fn ); /* move completely-downloaded file to permanent location */ + /* move completely-downloaded file to permanent location */ + if ( g_rename ( tmpfilename, fn ) ) + g_warning ("%s: file rename failed [%s] to [%s]", __FUNCTION__, tmpfilename, fn ); } unlock_file ( tmpfilename ); g_free ( tmpfilename ); @@ -268,18 +377,19 @@ static int download( const char *hostname, const char *uri, const char *fn, Down g_free ( file_options.etag ); g_free ( file_options.new_etag ); } - return 0; + return DOWNLOAD_SUCCESS; } -/* 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 ) +/** + * 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 ); } -int a_ftp_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *opt, void *handle ) +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, TRUE, handle ); } @@ -293,3 +403,37 @@ 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; +}