]> git.street.me.uk Git - andy/viking.git/blobdiff - src/download.c
Merge pull request #20 from huobos/zh_CN
[andy/viking.git] / src / download.c
index 5c3de258d70ebbeb089fb9fdf7def1d647e2cf69..798bdba2213419a94033c9fa1b2a2de028232dd0 100644 (file)
 #include <glib/gstdio.h>
 #include <glib/gi18n.h>
 
-#ifdef HAVE_MAGIC_H
-#include <magic.h>
-#endif
+#include "file_magic.h"
 #include "compression.h"
-
 #include "download.h"
 
 #include "curl_download.h"
@@ -205,48 +202,10 @@ 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 ) {
-#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/x-bzip2; charset=binary") == 0 )
-                               bzip2 = TRUE;
-               }
-               else {
-                       g_critical ("%s: magic load database failure", __FUNCTION__ );
-               }
-
-               magic_close ( myt );
-       }
-
-       if ( !(zip || bzip2) )
-               return;
-
-       if ( zip ) {
+       if ( file_magic_check (name, "application/zip", ".zip") ) {
                uncompress_zip ( name );
        }
-       else if ( bzip2 ) {
+       else if ( file_magic_check (name, "application/x-bzip2", ".bz2") ) {
                gchar* bz2_name = uncompress_bzip2 ( name );
                if ( bz2_name ) {
                        if ( g_remove ( name ) )
@@ -255,18 +214,114 @@ void a_try_decompress_file (gchar *name)
                                g_critical ("%s: file rename failed [%s] to [%s]", __FUNCTION__, bz2_name, name );
                }
        }
+}
 
-       return;
-#endif
+#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 DownloadResult_t download( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *options, gboolean ftp, void *handle)
+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 )
@@ -279,7 +334,7 @@ static DownloadResult_t download( const char *hostname, const char *uri, const c
 
     time_t tile_age = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "download_tile_age")->u;
     /* Get the modified time of this file */
-    struct stat buf;
+    GStatBuf buf;
     (void)g_stat ( fn, &buf );
     time_t file_time = buf.st_mtime;
     if ( (time(NULL) - file_time) < tile_age ) {
@@ -288,22 +343,10 @@ static DownloadResult_t download( const char *hostname, const char *uri, const c
     }
 
     if (options != NULL && options->check_file_server_time) {
-      file_options.time_condition = file_time;
+      cdo.time_condition = file_time;
     }
     if (options != NULL && 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 */
+      get_etag(fn, &cdo);
     }
 
   } else {
@@ -313,13 +356,19 @@ static DownloadResult_t download( const char *hostname, const char *uri, const c
     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 );
+      g_free ( cdo.etag );
     return DOWNLOAD_FILE_WRITE_ERROR;
   }
   f = g_fopen ( tmpfilename, "w+b" );  /* truncate file and open it */
@@ -327,12 +376,12 @@ static DownloadResult_t download( const char *hostname, const char *uri, const c
     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 );
+      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 );
 
   DownloadResult_t result = DOWNLOAD_SUCCESS;
 
@@ -359,25 +408,12 @@ static DownloadResult_t download( const char *hostname, const char *uri, const c
     unlock_file ( tmpfilename );
     g_free ( tmpfilename );
     if ( options != NULL && options->use_etag ) {
-      g_free ( file_options.etag );
-      g_free ( file_options.new_etag );
+      g_free ( cdo.etag );
+      g_free ( cdo.new_etag );
     }
     return result;
   }
 
-  if ( options != NULL && options->convert_file )
-    options->convert_file ( tmpfilename );
-
-  if ( options != NULL && 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
@@ -386,6 +422,16 @@ static DownloadResult_t download( const char *hostname, const char *uri, const c
      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);
+      }
+    }
+
      /* move completely-downloaded file to permanent location */
      if ( g_rename ( tmpfilename, fn ) )
         g_warning ("%s: file rename failed [%s] to [%s]", __FUNCTION__, tmpfilename, fn );
@@ -394,8 +440,8 @@ static DownloadResult_t download( const char *hostname, const char *uri, const c
   g_free ( tmpfilename );
 
   if ( options != NULL && options->use_etag ) {
-    g_free ( file_options.etag );
-    g_free ( file_options.new_etag );
+    g_free ( cdo.etag );
+    g_free ( cdo.new_etag );
   }
   return DOWNLOAD_SUCCESS;
 }
@@ -404,12 +450,12 @@ static DownloadResult_t download( const char *hostname, const char *uri, const c
  * 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 )
+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 );
 }
 
-DownloadResult_t 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 );
 }
@@ -433,7 +479,7 @@ void a_download_handle_cleanup ( void *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;