1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
3 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
5 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
6 * Copyright (C) 2007, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
7 * Copyright (C) 2013, Rob Norris <rw_norris@hotmail.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33 #ifdef HAVE_SYS_TYPES_H
34 #include <sys/types.h>
40 #include <glib/gstdio.h>
41 #include <glib/gi18n.h>
46 #include "compression.h"
50 #include "curl_download.h"
51 #include "preferences.h"
53 #include "vik_compat.h"
55 static gboolean check_file_first_line(FILE* f, gchar *patterns[])
63 memset(buf, 0, sizeof(buf));
64 if ( !fgetpos(f, &pos) )
67 nr = fread(buf, 1, sizeof(buf) - 1, f);
68 if ( !fgetpos(f, &pos) )
70 for (bp = buf; (bp < (buf + sizeof(buf) - 1)) && (nr > (bp - buf)); bp++) {
74 if ((bp >= (buf + sizeof(buf) -1)) || ((bp - buf) >= nr))
76 for (s = patterns; *s; s++) {
77 if (strncasecmp(*s, bp, strlen(*s)) == 0)
83 gboolean a_check_html_file(FILE* f)
85 gchar * html_str[] = {
93 return check_file_first_line(f, html_str);
96 gboolean a_check_map_file(FILE* f)
98 /* FIXME no more true since a_check_kml_file */
99 return !a_check_html_file(f);
102 gboolean a_check_kml_file(FILE* f)
104 gchar * kml_str[] = {
109 return check_file_first_line(f, kml_str);
112 static GList *file_list = NULL;
113 static GMutex *file_list_mutex = NULL;
115 /* spin button scales */
116 static VikLayerParamScale params_scales[] = {
117 {1, 365, 1, 0}, /* download_tile_age */
120 static VikLayerParamData convert_to_display ( VikLayerParamData value )
122 // From seconds into days
123 return VIK_LPD_UINT ( value.u / 86400 );
126 static VikLayerParamData convert_to_internal ( VikLayerParamData value )
128 // From days into seconds
129 return VIK_LPD_UINT ( 86400 * value.u );
132 static VikLayerParam prefs[] = {
133 { 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 },
136 void a_download_init (void)
138 VikLayerParamData tmp;
139 tmp.u = VIK_CONFIG_DEFAULT_TILE_AGE / 86400; // Now in days
140 a_preferences_register(prefs, tmp, VIKING_PREFERENCES_GROUP_KEY);
141 file_list_mutex = vik_mutex_new();
144 void a_download_uninit (void)
146 vik_mutex_free(file_list_mutex);
149 static gboolean lock_file(const char *fn)
151 gboolean locked = FALSE;
152 g_mutex_lock(file_list_mutex);
153 if (g_list_find_custom(file_list, fn, (GCompareFunc)g_strcmp0) == NULL)
155 // The filename is not yet locked
156 file_list = g_list_append(file_list, (gpointer)fn),
159 g_mutex_unlock(file_list_mutex);
163 static void unlock_file(const char *fn)
165 g_mutex_lock(file_list_mutex);
166 file_list = g_list_remove(file_list, (gconstpointer)fn);
167 g_mutex_unlock(file_list_mutex);
171 * Unzip a file - replacing the file with the unzipped contents of the self
173 static void uncompress_zip ( gchar *name )
175 GError *error = NULL;
178 if ((mf = g_mapped_file_new ( name, FALSE, &error )) == NULL) {
179 g_critical(_("Couldn't map file %s: %s"), name, error->message);
183 gchar *file_contents = g_mapped_file_get_contents ( mf );
185 void *unzip_mem = NULL;
188 if ((unzip_mem = unzip_file (file_contents, &ucsize)) == NULL) {
189 g_mapped_file_unref ( mf );
193 // This overwrites any previous file contents
194 if ( ! g_file_set_contents ( name, unzip_mem, ucsize, &error ) ) {
195 g_critical ( "Couldn't write file '%s', because of %s", name, error->message );
196 g_error_free ( error );
201 * a_try_decompress_file:
202 * @name: The potentially compressed filename
204 * Perform magic to decide how which type of decompression to attempt
206 void a_try_decompress_file (gchar *name)
210 // Or magic_version() if available - probably need libmagic 5.18 or so
211 // (can't determine exactly which version the versioning became available)
212 g_debug ("%s: magic version: %d", __FUNCTION__, MAGIC_VERSION );
214 magic_t myt = magic_open ( MAGIC_CONTINUE|MAGIC_ERROR|MAGIC_MIME );
215 gboolean zip = FALSE;
216 gboolean bzip2 = FALSE;
219 // We have to 'package' the magic database ourselves :(
220 // --> %PROGRAM FILES%\Viking\magic.mgc
221 int ml = magic_load ( myt, ".\\magic.mgc" );
223 // Use system default
224 int ml = magic_load ( myt, NULL );
227 const char* magic = magic_file (myt, name);
228 g_debug ("%s: magic output: %s", __FUNCTION__, magic );
230 if ( g_ascii_strncasecmp(magic, "application/zip", 15) == 0 )
233 if ( g_ascii_strncasecmp(magic, "application/x-bzip2", 19) == 0 )
237 g_critical ("%s: magic load database failure", __FUNCTION__ );
243 if ( !(zip || bzip2) )
247 uncompress_zip ( name );
250 gchar* bz2_name = uncompress_bzip2 ( name );
252 if ( g_remove ( name ) )
253 g_critical ("%s: remove file failed [%s]", __FUNCTION__, name );
254 if ( g_rename (bz2_name, name) )
255 g_critical ("%s: file rename failed [%s] to [%s]", __FUNCTION__, bz2_name, name );
263 #define VIKING_ETAG_XATTR "xattr::viking.etag"
265 static gboolean get_etag_xattr(const char *fn, CurlDownloadOptions *cdo)
267 gboolean result = FALSE;
271 file = g_file_new_for_path(fn);
272 fileinfo = g_file_query_info(file, VIKING_ETAG_XATTR, G_FILE_QUERY_INFO_NONE, NULL, NULL);
274 const char *etag = g_file_info_get_attribute_string(fileinfo, VIKING_ETAG_XATTR);
276 cdo->etag = g_strdup(etag);
277 result = !!cdo->etag;
279 g_object_unref(fileinfo);
281 g_object_unref(file);
284 g_debug("%s: Get etag (xattr) from %s: %s", __FUNCTION__, fn, cdo->etag);
289 static gboolean get_etag_file(const char *fn, CurlDownloadOptions *cdo)
291 gboolean result = FALSE;
292 gchar *etag_filename;
294 etag_filename = g_strdup_printf("%s.etag", fn);
296 result = g_file_get_contents(etag_filename, &cdo->etag, NULL, NULL);
297 g_free(etag_filename);
301 g_debug("%s: Get etag (file) from %s: %s", __FUNCTION__, fn, cdo->etag);
306 static void get_etag(const char *fn, CurlDownloadOptions *cdo)
308 /* first try to get etag from xattr, then fall back to plain file */
309 if (!get_etag_xattr(fn, cdo) && !get_etag_file(fn, cdo)) {
310 g_debug("%s: Failed to get etag from %s", __FUNCTION__, fn);
314 /* check if etag is short enough */
315 if (strlen(cdo->etag) > 100) {
320 /* TODO: should check that etag is a valid string */
323 static gboolean set_etag_xattr(const char *fn, CurlDownloadOptions *cdo)
325 gboolean result = FALSE;
328 file = g_file_new_for_path(fn);
329 result = g_file_set_attribute_string(file, VIKING_ETAG_XATTR, cdo->new_etag, G_FILE_QUERY_INFO_NONE, NULL, NULL);
330 g_object_unref(file);
333 g_debug("%s: Set etag (xattr) on %s: %s", __FUNCTION__, fn, cdo->new_etag);
338 static gboolean set_etag_file(const char *fn, CurlDownloadOptions *cdo)
340 gboolean result = FALSE;
341 gchar *etag_filename;
343 etag_filename = g_strdup_printf("%s.etag", fn);
345 result = g_file_set_contents(etag_filename, cdo->new_etag, -1, NULL);
346 g_free(etag_filename);
350 g_debug("%s: Set etag (file) on %s: %s", __FUNCTION__, fn, cdo->new_etag);
355 static void set_etag(const char *fn, const char *fntmp, CurlDownloadOptions *cdo)
357 /* first try to store etag in extended attribute, then fall back to plain file */
358 if (!set_etag_xattr(fntmp, cdo) && !set_etag_file(fn, cdo)) {
359 g_debug("%s: Failed to set etag on %s", __FUNCTION__, fn);
363 static DownloadResult_t download( const char *hostname, const char *uri, const char *fn, DownloadFileOptions *options, gboolean ftp, void *handle)
368 gboolean failure = FALSE;
369 CurlDownloadOptions cdo = {0, NULL, NULL};
372 if ( g_file_test ( fn, G_FILE_TEST_EXISTS ) == TRUE )
374 if (options == NULL || (!options->check_file_server_time &&
375 !options->use_etag)) {
376 /* Nothing to do as file already exists and we don't want to check server */
377 return DOWNLOAD_NOT_REQUIRED;
380 time_t tile_age = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "download_tile_age")->u;
381 /* Get the modified time of this file */
383 (void)g_stat ( fn, &buf );
384 time_t file_time = buf.st_mtime;
385 if ( (time(NULL) - file_time) < tile_age ) {
386 /* File cache is too recent, so return */
387 return DOWNLOAD_NOT_REQUIRED;
390 if (options != NULL && options->check_file_server_time) {
391 cdo.time_condition = file_time;
393 if (options != NULL && options->use_etag) {
398 gchar *dir = g_path_get_dirname ( fn );
399 if ( g_mkdir_with_parents ( dir , 0777 ) != 0)
400 g_warning ("%s: Failed to mkdir %s", __FUNCTION__, dir );
404 tmpfilename = g_strdup_printf("%s.tmp", fn);
405 if (!lock_file ( tmpfilename ) )
407 g_debug("%s: Couldn't take lock on temporary file \"%s\"\n", __FUNCTION__, tmpfilename);
408 g_free ( tmpfilename );
409 if (options->use_etag)
411 return DOWNLOAD_FILE_WRITE_ERROR;
413 f = g_fopen ( tmpfilename, "w+b" ); /* truncate file and open it */
415 g_warning("Couldn't open temporary file \"%s\": %s", tmpfilename, g_strerror(errno));
416 g_free ( tmpfilename );
417 if (options->use_etag)
419 return DOWNLOAD_FILE_WRITE_ERROR;
422 /* Call the backend function */
423 ret = curl_download_get_url ( hostname, uri, f, options, ftp, &cdo, handle );
425 DownloadResult_t result = DOWNLOAD_SUCCESS;
427 if (ret != CURL_DOWNLOAD_NO_ERROR && ret != CURL_DOWNLOAD_NO_NEWER_FILE) {
428 g_debug("%s: download failed: curl_download_get_url=%d", __FUNCTION__, ret);
430 result = DOWNLOAD_HTTP_ERROR;
433 if (!failure && options != NULL && options->check_file != NULL && ! options->check_file(f)) {
434 g_debug("%s: file content checking failed", __FUNCTION__);
436 result = DOWNLOAD_CONTENT_ERROR;
444 g_warning(_("Download error: %s"), fn);
445 if ( g_remove ( tmpfilename ) != 0 )
446 g_warning( ("Failed to remove: %s"), tmpfilename);
447 unlock_file ( tmpfilename );
448 g_free ( tmpfilename );
449 if ( options != NULL && options->use_etag ) {
451 g_free ( cdo.new_etag );
456 if (ret == CURL_DOWNLOAD_NO_NEWER_FILE) {
457 (void)g_remove ( tmpfilename );
458 // update mtime of local copy
459 // Not security critical, thus potential Time of Check Time of Use race condition is not bad
461 if ( g_utime ( fn, NULL ) != 0 )
462 g_warning ( "%s couldn't set time on: %s", __FUNCTION__, fn );
464 if ( options != NULL && options->convert_file )
465 options->convert_file ( tmpfilename );
467 if ( options != NULL && options->use_etag ) {
468 if ( cdo.new_etag ) {
469 /* server returned an etag value */
470 set_etag(fn, tmpfilename, &cdo);
474 /* move completely-downloaded file to permanent location */
475 if ( g_rename ( tmpfilename, fn ) )
476 g_warning ("%s: file rename failed [%s] to [%s]", __FUNCTION__, tmpfilename, fn );
478 unlock_file ( tmpfilename );
479 g_free ( tmpfilename );
481 if ( options != NULL && options->use_etag ) {
483 g_free ( cdo.new_etag );
485 return DOWNLOAD_SUCCESS;
489 * uri: like "/uri.html?whatever"
490 * only reason for the "wrapper" is so we can do redirects.
492 DownloadResult_t a_http_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadFileOptions *opt, void *handle )
494 return download ( hostname, uri, fn, opt, FALSE, handle );
497 DownloadResult_t a_ftp_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadFileOptions *opt, void *handle )
499 return download ( hostname, uri, fn, opt, TRUE, handle );
502 void * a_download_handle_init ()
504 return curl_download_handle_init ();
507 void a_download_handle_cleanup ( void *handle )
509 curl_download_handle_cleanup ( handle );
513 * a_download_url_to_tmp_file:
514 * @uri: The URI (Uniform Resource Identifier)
515 * @options: Download options (maybe NULL)
517 * returns name of the temporary file created - NULL if unsuccessful
518 * this string needs to be freed once used
519 * the file needs to be removed once used
521 gchar *a_download_uri_to_tmp_file ( const gchar *uri, DownloadFileOptions *options )
527 if ( (tmp_fd = g_file_open_tmp ("viking-download.XXXXXX", &tmpname, NULL)) == -1 ) {
528 g_critical (_("couldn't open temp file"));
532 tmp_file = fdopen(tmp_fd, "r+");
536 if ( curl_download_uri ( uri, tmp_file, options, NULL, NULL ) ) {
539 (void)g_remove ( tmpname );