Merge pull request #20 from huobos/zh_CN

[andy/viking.git] / src / download.h

diff --git a/src/download.h b/src/download.h
index 89ce75e3b1928c9221e520321e4c060ceac2d329..e2339e279cf2b892243669c790a32d6981d60405 100644 (file)
--- a/src/download.h
+++ b/src/download.h
@@ -2,6 +2,7 @@
  * 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>
  *
  * 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
@@ -24,11 +25,16 @@
 
 #include <stdio.h>
 
+G_BEGIN_DECLS
+
 /* File content check */
 typedef gboolean (*VikFileContentCheckerFunc) (FILE*);
 gboolean a_check_map_file(FILE*);
 gboolean a_check_html_file(FILE*);
 gboolean a_check_kml_file(FILE*);
+// Convert
+void a_try_decompress_file (gchar *name);
+typedef void (*VikFileContentConvertFunc) (gchar*); // filename (temporary)
 
 typedef struct {
   /**
@@ -37,6 +43,11 @@ typedef struct {
    */
   gboolean check_file_server_time;
 
+  /**
+   * Set if the server handle ETag
+   */
+  gboolean use_etag;
+
   /**
    * The REFERER string to use.
    * Could be NULL.
@@ -54,19 +65,39 @@ typedef struct {
    */
   VikFileContentCheckerFunc check_file;
 
-} DownloadOptions;
+  /**
+   * If need to authenticate on download
+   *  format: 'username:password'
+   */
+  gchar *user_pass;
+
+  /**
+   * File manipulation if necessary such as uncompressing the downloaded file.
+   */
+  VikFileContentConvertFunc convert_file;
+
+} DownloadFileOptions;
 
 void a_download_init(void);
+void a_download_uninit(void);
+
+typedef enum {
+  DOWNLOAD_PARAMETERS_ERROR = -8, // Configuration issue
+  DOWNLOAD_FILE_WRITE_ERROR = -4, // Can't write downloaded file :(
+  DOWNLOAD_HTTP_ERROR = -2,
+  DOWNLOAD_CONTENT_ERROR = -1,
+  DOWNLOAD_SUCCESS = 0,
+  DOWNLOAD_NOT_REQUIRED = 1, // Also 'successful'. e.g. Because file already exists and no time checks used
+} DownloadResult_t;
 
 /* TODO: convert to Glib */
-int a_http_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadOptions *opt, void *handle );
-int a_ftp_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadOptions *opt, void *handle );
+DownloadResult_t a_http_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadFileOptions *opt, void *handle );
+DownloadResult_t a_ftp_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadFileOptions *opt, void *handle );
 void *a_download_handle_init ();
 void a_download_handle_cleanup ( void *handle );
 
-/* Error messages returned by download functions */
-enum { DOWNLOAD_NO_ERROR = 0,
-       DOWNLOAD_NO_NEWER_FILE,
-       DOWNLOAD_ERROR };
+gchar *a_download_uri_to_tmp_file ( const gchar *uri, DownloadFileOptions *options );
+
+G_END_DECLS
 
 #endif