+/* -*- 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 <gtoevan@gmx.net>
* Copyright (C) 2007, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
+ * Copyright (C) 2013, Rob Norris <rw_norris@hotmail.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
#include <glib/gstdio.h>
#include <glib/gi18n.h>
-
+#include "file_magic.h"
+#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[])
{
size_t nr;
memset(buf, 0, sizeof(buf));
- fgetpos(f, &pos);
+ if ( !fgetpos(f, &pos) )
+ return FALSE;
rewind(f);
nr = fread(buf, 1, sizeof(buf) - 1, f);
- fsetpos(f, &pos);
+ if ( !fgetpos(f, &pos) )
+ return FALSE;
for (bp = buf; (bp < (buf + sizeof(buf) - 1)) && (nr > (bp - buf)); bp++) {
if (!(isspace(*bp)))
break;
static GMutex *file_list_mutex = NULL;
/* spin button scales */
-VikLayerParamScale params_scales[] = {
- {1, 86400*7, 60, 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)
g_mutex_unlock(file_list_mutex);
}
-static int download( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *options, gboolean ftp, void *handle)
+/**
+ * Unzip a file - replacing the file with the unzipped contents of the self
+ */
+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 overwrites 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)
+{
+ if ( file_magic_check (name, "application/zip", ".zip") ) {
+ uncompress_zip ( name );
+ }
+ else if ( file_magic_check (name, "application/x-bzip2", ".bz2") ) {
+ gchar* bz2_name = uncompress_bzip2 ( name );
+ if ( bz2_name ) {
+ if ( g_remove ( name ) )
+ g_critical ("%s: remove file failed [%s]", __FUNCTION__, name );
+ if ( g_rename (bz2_name, name) )
+ g_critical ("%s: file rename failed [%s] to [%s]", __FUNCTION__, bz2_name, name );
+ }
+ }
+}
+
+#define VIKING_ETAG_XATTR "xattr::viking.etag"
+
+static gboolean get_etag_xattr(const char *fn, CurlDownloadOptions *cdo)
+{
+ gboolean result = FALSE;
+ GFileInfo *fileinfo;
+ GFile *file;
+
+ file = g_file_new_for_path(fn);
+ fileinfo = g_file_query_info(file, VIKING_ETAG_XATTR, G_FILE_QUERY_INFO_NONE, NULL, NULL);
+ if (fileinfo) {
+ const char *etag = g_file_info_get_attribute_string(fileinfo, VIKING_ETAG_XATTR);
+ if (etag) {
+ cdo->etag = g_strdup(etag);
+ result = !!cdo->etag;
+ }
+ g_object_unref(fileinfo);
+ }
+ g_object_unref(file);
+
+ if (result)
+ g_debug("%s: Get etag (xattr) from %s: %s", __FUNCTION__, fn, cdo->etag);
+
+ return result;
+}
+
+static gboolean get_etag_file(const char *fn, CurlDownloadOptions *cdo)
+{
+ gboolean result = FALSE;
+ gchar *etag_filename;
+
+ etag_filename = g_strdup_printf("%s.etag", fn);
+ if (etag_filename) {
+ result = g_file_get_contents(etag_filename, &cdo->etag, NULL, NULL);
+ g_free(etag_filename);
+ }
+
+ if (result)
+ g_debug("%s: Get etag (file) from %s: %s", __FUNCTION__, fn, cdo->etag);
+
+ return result;
+}
+
+static void get_etag(const char *fn, CurlDownloadOptions *cdo)
+{
+ /* first try to get etag from xattr, then fall back to plain file */
+ if (!get_etag_xattr(fn, cdo) && !get_etag_file(fn, cdo)) {
+ g_debug("%s: Failed to get etag from %s", __FUNCTION__, fn);
+ return;
+ }
+
+ /* check if etag is short enough */
+ if (strlen(cdo->etag) > 100) {
+ g_free(cdo->etag);
+ cdo->etag = NULL;
+ }
+
+ /* TODO: should check that etag is a valid string */
+}
+
+static gboolean set_etag_xattr(const char *fn, CurlDownloadOptions *cdo)
+{
+ gboolean result = FALSE;
+ GFile *file;
+
+ file = g_file_new_for_path(fn);
+ result = g_file_set_attribute_string(file, VIKING_ETAG_XATTR, cdo->new_etag, G_FILE_QUERY_INFO_NONE, NULL, NULL);
+ g_object_unref(file);
+
+ if (result)
+ g_debug("%s: Set etag (xattr) on %s: %s", __FUNCTION__, fn, cdo->new_etag);
+
+ return result;
+}
+
+static gboolean set_etag_file(const char *fn, CurlDownloadOptions *cdo)
+{
+ gboolean result = FALSE;
+ gchar *etag_filename;
+
+ etag_filename = g_strdup_printf("%s.etag", fn);
+ if (etag_filename) {
+ result = g_file_set_contents(etag_filename, cdo->new_etag, -1, NULL);
+ g_free(etag_filename);
+ }
+
+ if (result)
+ g_debug("%s: Set etag (file) on %s: %s", __FUNCTION__, fn, cdo->new_etag);
+
+ return result;
+}
+
+static void set_etag(const char *fn, const char *fntmp, CurlDownloadOptions *cdo)
+{
+ /* first try to store etag in extended attribute, then fall back to plain file */
+ if (!set_etag_xattr(fntmp, cdo) && !set_etag_file(fn, cdo)) {
+ g_debug("%s: Failed to set etag on %s", __FUNCTION__, fn);
+ }
+}
+
+static DownloadResult_t download( const char *hostname, const char *uri, const char *fn, DownloadFileOptions *options, gboolean ftp, void *handle)
{
FILE *f;
- int ret;
gchar *tmpfilename;
gboolean failure = FALSE;
- DownloadFileOptions file_options = {0, NULL, NULL};
+ CurlDownloadOptions cdo = {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;
+ 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 );
+ GStatBuf buf;
+ (void)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;
+ return DOWNLOAD_NOT_REQUIRED;
}
- if (options->check_file_server_time) {
- file_options.time_condition = file_time;
+ if (options != NULL && options->check_file_server_time) {
+ cdo.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 */
+ if (options != NULL && options->use_etag) {
+ get_etag(fn, &cdo);
}
} else {
gchar *dir = g_path_get_dirname ( fn );
- g_mkdir_with_parents ( dir , 0777 );
+ if ( g_mkdir_with_parents ( dir , 0777 ) != 0)
+ g_warning ("%s: Failed to mkdir %s", __FUNCTION__, dir );
g_free ( dir );
}
+ // Early test for valid hostname & uri to avoid unnecessary tmp file
+ if ( !hostname && !uri ) {
+ g_warning ( "%s: Parameter error - neither hostname nor uri defined", __FUNCTION__ );
+ return DOWNLOAD_PARAMETERS_ERROR;
+ }
+
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;
+ g_free ( cdo.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 );
if (options->use_etag)
- g_free ( file_options.etag );
- return -4;
+ g_free ( cdo.etag );
+ return DOWNLOAD_FILE_WRITE_ERROR;
}
/* Call the backend function */
- ret = curl_download_get_url ( hostname, uri, f, options, ftp, &file_options, handle );
+ CURL_download_t ret = curl_download_get_url ( hostname, uri, f, options, ftp, &cdo, 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 );
if (failure)
{
g_warning(_("Download error: %s"), fn);
- g_remove ( tmpfilename );
+ if ( g_remove ( tmpfilename ) != 0 )
+ g_warning( ("Failed to remove: %s"), tmpfilename);
unlock_file ( tmpfilename );
g_free ( tmpfilename );
- if (options->use_etag) {
- g_free ( file_options.etag );
- g_free ( file_options.new_etag );
+ if ( options != NULL && options->use_etag ) {
+ g_free ( cdo.etag );
+ g_free ( cdo.new_etag );
}
- return -1;
+ return result;
}
- 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) {
+ (void)g_remove ( tmpfilename );
+ // update mtime of local copy
+ // Not security critical, thus potential Time of Check Time of Use race condition is not bad
+ // coverity[toctou]
+ if ( g_utime ( fn, NULL ) != 0 )
+ g_warning ( "%s couldn't set time on: %s", __FUNCTION__, fn );
+ } else {
+ if ( options != NULL && options->convert_file )
+ options->convert_file ( tmpfilename );
+
+ if ( options != NULL && options->use_etag ) {
+ if ( cdo.new_etag ) {
+ /* server returned an etag value */
+ set_etag(fn, tmpfilename, &cdo);
+ }
}
- }
- 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 */
+ /* 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 );
- if (options->use_etag) {
- g_free ( file_options.etag );
- g_free ( file_options.new_etag );
+ if ( options != NULL && options->use_etag ) {
+ g_free ( cdo.etag );
+ g_free ( cdo.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, DownloadFileOptions *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, DownloadFileOptions *opt, void *handle )
{
return download ( hostname, uri, fn, opt, TRUE, handle );
}
* 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 )
+gchar *a_download_uri_to_tmp_file ( const gchar *uri, DownloadFileOptions *options )
{
FILE *tmp_file;
int tmp_fd;
}
tmp_file = fdopen(tmp_fd, "r+");
+ if ( !tmp_file )
+ return NULL;
if ( curl_download_uri ( uri, tmp_file, options, NULL, NULL ) ) {
// error
fclose ( tmp_file );
- g_remove ( tmpname );
+ (void)g_remove ( tmpname );
g_free ( tmpname );
return NULL;
}
projects / andy / viking.git / blobdiff