]>
Commit | Line | Data |
---|---|---|
85611cd9 GB |
1 | /* |
2 | * viking -- GPS Data and Topo Analyzer, Explorer, and Manager | |
3 | * | |
4 | * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net> | |
a482007a | 5 | * Copyright (C) 2007, Guilhem Bonnefille <guilhem.bonnefille@gmail.com> |
85611cd9 GB |
6 | * |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation; either version 2 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program; if not, write to the Free Software | |
19 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
20 | * | |
21 | */ | |
22 | ||
23 | #ifndef _VIKING_DOWNLOAD_H | |
24 | #define _VIKING_DOWNLOAD_H | |
80214df2 | 25 | |
1ac37c09 GB |
26 | #include <stdio.h> |
27 | ||
722b5481 RN |
28 | G_BEGIN_DECLS |
29 | ||
1ac37c09 GB |
30 | /* File content check */ |
31 | typedef gboolean (*VikFileContentCheckerFunc) (FILE*); | |
32 | gboolean a_check_map_file(FILE*); | |
33 | gboolean a_check_html_file(FILE*); | |
ae941b4c | 34 | gboolean a_check_kml_file(FILE*); |
a3697549 RN |
35 | // Convert |
36 | void a_try_decompress_file (gchar *name); | |
37 | typedef void (*VikFileContentConvertFunc) (gchar*); // filename (temporary) | |
1ac37c09 | 38 | |
80214df2 | 39 | typedef struct { |
6a4a29aa JJ |
40 | /** |
41 | * Check if the server has a more recent file than the one we have before downloading it | |
42 | * This uses http header If-Modified-Since | |
43 | */ | |
6693f5f9 | 44 | gboolean check_file_server_time; |
6a4a29aa | 45 | |
74fbca98 JJ |
46 | /** |
47 | * Set if the server handle ETag | |
48 | */ | |
49 | gboolean use_etag; | |
50 | ||
a3188993 GB |
51 | /** |
52 | * The REFERER string to use. | |
53 | * Could be NULL. | |
54 | */ | |
55 | gchar *referer; | |
1a8143e6 BZ |
56 | |
57 | /** | |
58 | * follow_location specifies the number of retries | |
59 | * to follow a redirect while downloading a page. | |
60 | */ | |
61 | glong follow_location; | |
1ac37c09 GB |
62 | |
63 | /** | |
64 | * File content checker. | |
65 | */ | |
66 | VikFileContentCheckerFunc check_file; | |
6a4a29aa | 67 | |
0807f24b RN |
68 | /** |
69 | * If need to authenticate on download | |
70 | * format: 'username:password' | |
71 | */ | |
72 | gchar *user_pass; | |
73 | ||
a3697549 RN |
74 | /** |
75 | * File manipulation if necessary such as uncompressing the downloaded file. | |
76 | */ | |
77 | VikFileContentConvertFunc convert_file; | |
78 | ||
b529dc9c | 79 | } DownloadMapOptions; |
80214df2 | 80 | |
9a021e4f JJ |
81 | typedef struct { |
82 | /** | |
83 | * Time sent to server on header If-Modified-Since | |
84 | */ | |
85 | time_t time_condition; | |
ab716260 JJ |
86 | /** |
87 | * Etag sent by server on previous download | |
88 | */ | |
89 | char *etag; | |
90 | /** | |
91 | * Etag sent by server on this download | |
92 | */ | |
93 | char *new_etag; | |
9a021e4f JJ |
94 | |
95 | } DownloadFileOptions; | |
96 | ||
4b992365 GB |
97 | void a_download_init(void); |
98 | ||
4e815e90 RN |
99 | typedef enum { |
100 | DOWNLOAD_FILE_WRITE_ERROR = -4, // Can't write downloaded file :( | |
101 | DOWNLOAD_HTTP_ERROR = -2, | |
102 | DOWNLOAD_CONTENT_ERROR = -1, | |
103 | DOWNLOAD_SUCCESS = 0, | |
104 | DOWNLOAD_NOT_REQUIRED = 1, // Also 'successful'. e.g. Because file already exists and no time checks used | |
105 | } DownloadResult_t; | |
106 | ||
85611cd9 | 107 | /* TODO: convert to Glib */ |
4e815e90 RN |
108 | DownloadResult_t a_http_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *opt, void *handle ); |
109 | DownloadResult_t a_ftp_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *opt, void *handle ); | |
825413ba SW |
110 | void *a_download_handle_init (); |
111 | void a_download_handle_cleanup ( void *handle ); | |
85611cd9 | 112 | |
e09b94fe RN |
113 | gchar *a_download_uri_to_tmp_file ( const gchar *uri, DownloadMapOptions *options ); |
114 | ||
722b5481 RN |
115 | G_END_DECLS |
116 | ||
85611cd9 | 117 | #endif |