]> git.street.me.uk Git - andy/viking.git/blobdiff - src/download.c
Save bfilter values used for subsequent reuse in a session.
[andy/viking.git] / src / download.c
index 2e80ba56a4db05bfc1a950f97d6fa998de4f4c5f..9b1fe0f2b3f14ac2bc6d892f8353eb4f8e586d6d 100644 (file)
@@ -50,6 +50,7 @@
 #include "curl_download.h"
 #include "preferences.h"
 #include "globals.h"
+#include "vik_compat.h"
 
 static gboolean check_file_first_line(FILE* f, gchar *patterns[])
 {
@@ -60,10 +61,12 @@ 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;
@@ -135,8 +138,12 @@ void a_download_init (void)
        VikLayerParamData tmp;
        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)
@@ -160,7 +167,9 @@ static void unlock_file(const char *fn)
        g_mutex_unlock(file_list_mutex);
 }
 
-
+/**
+ * Unzip a file - replacing the file with the unzipped contents of the self
+ */
 static void uncompress_zip ( gchar *name )
 {
        GError *error = NULL;
@@ -181,7 +190,7 @@ static void uncompress_zip ( gchar *name )
                return;
        }
 
-       // This overwrires any previous file contents
+       // 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 );
@@ -197,19 +206,36 @@ static void uncompress_zip ( gchar *name )
 void a_try_decompress_file (gchar *name)
 {
 #ifdef HAVE_MAGIC_H
+#ifdef MAGIC_VERSION
+       // Or magic_version() if available - probably need libmagic 5.18 or so
+       //  (can't determine exactly which version the versioning became available)
+       g_debug ("%s: magic version: %d", __FUNCTION__, MAGIC_VERSION );
+#endif
        magic_t myt = magic_open ( MAGIC_CONTINUE|MAGIC_ERROR|MAGIC_MIME );
        gboolean zip = FALSE;
        gboolean bzip2 = FALSE;
        if ( myt ) {
-               magic_load ( myt, NULL );
-               const char* magic = magic_file (myt, name);
-               g_debug ("%s: magic output: %s", __FUNCTION__, magic );
+#ifdef WINDOWS
+               // We have to 'package' the magic database ourselves :(
+               //  --> %PROGRAM FILES%\Viking\magic.mgc
+               int ml = magic_load ( myt, ".\\magic.mgc" );
+#else
+               // Use system default
+               int ml = magic_load ( myt, NULL );
+#endif
+               if ( ml == 0 ) {
+                       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/zip; charset=binary") == 0 )
+                               zip = TRUE;
 
-               if ( g_strcmp0 (magic, "application/x-bzip2; charset=binary") == 0 )
-                       bzip2 = TRUE;
+                       if ( g_strcmp0 (magic, "application/x-bzip2; charset=binary") == 0 )
+                               bzip2 = TRUE;
+               }
+               else {
+                       g_critical ("%s: magic load database failure", __FUNCTION__ );
+               }
 
                magic_close ( myt );
        }
@@ -222,15 +248,119 @@ void a_try_decompress_file (gchar *name)
        }
        else if ( bzip2 ) {
                gchar* bz2_name = uncompress_bzip2 ( name );
-               g_remove ( name );
-               g_rename ( bz2_name, 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 );
+               }
        }
 
        return;
 #endif
 }
 
-static int download( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *options, gboolean ftp, void *handle)
+#define VIKING_ETAG_XATTR "xattr::viking.etag"
+
+static gboolean get_etag_xattr(const char *fn, DownloadFileOptions *file_options)
+{
+  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) {
+      file_options->etag = g_strdup(etag);
+      result = !!file_options->etag;
+    }
+    g_object_unref(fileinfo);
+  }
+  g_object_unref(file);
+
+  if (result)
+    g_debug("%s: Get etag (xattr) from %s: %s", __FUNCTION__, fn, file_options->etag);
+
+  return result;
+}
+
+static gboolean get_etag_file(const char *fn, DownloadFileOptions *file_options)
+{
+  gboolean result = FALSE;
+  gchar *etag_filename;
+
+  etag_filename = g_strdup_printf("%s.etag", fn);
+  if (etag_filename) {
+    result = g_file_get_contents(etag_filename, &file_options->etag, NULL, NULL);
+    g_free(etag_filename);
+  }
+
+  if (result)
+    g_debug("%s: Get etag (file) from %s: %s", __FUNCTION__, fn, file_options->etag);
+
+  return result;
+}
+
+static void get_etag(const char *fn, DownloadFileOptions *file_options)
+{
+  /* first try to get etag from xattr, then fall back to plain file  */
+  if (!get_etag_xattr(fn, file_options) && !get_etag_file(fn, file_options)) {
+    g_debug("%s: Failed to get etag from %s", __FUNCTION__, fn);
+    return;
+  }
+
+  /* check if etag is short enough */
+  if (strlen(file_options->etag) > 100) {
+    g_free(file_options->etag);
+    file_options->etag = NULL;
+  }
+
+  /* TODO: should check that etag is a valid string */
+}
+
+static gboolean set_etag_xattr(const char *fn, DownloadFileOptions *file_options)
+{
+  gboolean result = FALSE;
+  GFile *file;
+
+  file = g_file_new_for_path(fn);
+  result = g_file_set_attribute_string(file, VIKING_ETAG_XATTR, file_options->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, file_options->new_etag);
+
+  return result;
+}
+
+static gboolean set_etag_file(const char *fn, DownloadFileOptions *file_options)
+{
+  gboolean result = FALSE;
+  gchar *etag_filename;
+
+  etag_filename = g_strdup_printf("%s.etag", fn);
+  if (etag_filename) {
+    result = g_file_set_contents(etag_filename, file_options->new_etag, -1, NULL);
+    g_free(etag_filename);
+  }
+
+  if (result)
+    g_debug("%s: Set etag (file) on %s: %s", __FUNCTION__, fn, file_options->new_etag);
+
+  return result;
+}
+
+static void set_etag(const char *fn, const char *fntmp, DownloadFileOptions *file_options)
+{
+  /* first try to store etag in extended attribute, then fall back to plain file */
+  if (!set_etag_xattr(fntmp, file_options) && !set_etag_file(fn, file_options)) {
+    g_debug("%s: Failed to set etag on %s", __FUNCTION__, fn);
+  }
+}
+
+static DownloadResult_t download( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *options, gboolean ftp, void *handle)
 {
   FILE *f;
   int ret;
@@ -244,41 +374,30 @@ 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;
     /* Get the modified time of this file */
     struct stat buf;
-    g_stat ( fn, &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) {
+    if (options != NULL && options->check_file_server_time) {
       file_options.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, &file_options);
     }
 
   } 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 );
   }
 
@@ -289,7 +408,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 ) {
@@ -297,20 +416,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 );
@@ -319,58 +442,59 @@ static int download( const char *hostname, const char *uri, const char *fn, Down
   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) {
+    if ( options != NULL && options->use_etag ) {
       g_free ( file_options.etag );
       g_free ( file_options.new_etag );
     }
-    return -1;
+    return result;
   }
 
-  if ( options->convert_file )
-         options->convert_file ( tmpfilename );
+  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->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 ( options != NULL && options->use_etag ) {
+      if (file_options.new_etag) {
+        /* server returned an etag value */
+        set_etag(fn, tmpfilename, &file_options);
+      }
     }
-  }
 
-  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) {
+  if ( options != NULL && options->use_etag ) {
     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 );
 }
@@ -406,11 +530,13 @@ gchar *a_download_uri_to_tmp_file ( const gchar *uri, DownloadMapOptions *option
   }
 
   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;
   }