2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
5 * Copyright (C) 2007, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
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.
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.
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
31 #ifdef HAVE_SYS_TYPES_H
32 #include <sys/types.h>
38 #include <glib/gstdio.h>
39 #include <glib/gi18n.h>
44 #include "curl_download.h"
45 #include "preferences.h"
48 static gboolean check_file_first_line(FILE* f, gchar *patterns[])
56 memset(buf, 0, sizeof(buf));
59 nr = fread(buf, 1, sizeof(buf) - 1, f);
61 for (bp = buf; (bp < (buf + sizeof(buf) - 1)) && (nr > (bp - buf)); bp++) {
65 if ((bp >= (buf + sizeof(buf) -1)) || ((bp - buf) >= nr))
67 for (s = patterns; *s; s++) {
68 if (strncasecmp(*s, bp, strlen(*s)) == 0)
74 gboolean a_check_html_file(FILE* f)
76 gchar * html_str[] = {
84 return check_file_first_line(f, html_str);
87 gboolean a_check_map_file(FILE* f)
89 /* FIXME no more true since a_check_kml_file */
90 return !a_check_html_file(f);
93 gboolean a_check_kml_file(FILE* f)
100 return check_file_first_line(f, kml_str);
103 static GList *file_list = NULL;
104 static GMutex *file_list_mutex = NULL;
106 /* spin button scales */
107 VikLayerParamScale params_scales[] = {
108 {1, 86400*7, 60, 0}, /* download_tile_age */
111 static VikLayerParam prefs[] = {
112 { VIKING_PREFERENCES_NAMESPACE "download_tile_age", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Tile age (s):"), VIK_LAYER_WIDGET_SPINBUTTON, ¶ms_scales[0], NULL, NULL },
115 void a_download_init (void)
117 VikLayerParamData tmp;
118 tmp.u = VIK_CONFIG_DEFAULT_TILE_AGE;
119 a_preferences_register(prefs, tmp, VIKING_PREFERENCES_GROUP_KEY);
121 file_list_mutex = g_mutex_new();
124 static gboolean lock_file(const char *fn)
126 gboolean locked = FALSE;
127 g_mutex_lock(file_list_mutex);
128 if (g_list_find_custom(file_list, fn, (GCompareFunc)g_strcmp0) == NULL)
130 // The filename is not yet locked
131 file_list = g_list_append(file_list, (gpointer)fn),
134 g_mutex_unlock(file_list_mutex);
138 static void unlock_file(const char *fn)
140 g_mutex_lock(file_list_mutex);
141 file_list = g_list_remove(file_list, (gconstpointer)fn);
142 g_mutex_unlock(file_list_mutex);
145 static int download( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *options, gboolean ftp, void *handle)
150 gboolean failure = FALSE;
151 DownloadFileOptions file_options = {0, NULL, NULL};
154 if ( g_file_test ( fn, G_FILE_TEST_EXISTS ) == TRUE )
156 if (options == NULL || (!options->check_file_server_time &&
157 !options->use_etag)) {
158 /* Nothing to do as file already exists and we don't want to check server */
162 time_t tile_age = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "download_tile_age")->u;
163 /* Get the modified time of this file */
166 time_t file_time = buf.st_mtime;
167 if ( (time(NULL) - file_time) < tile_age ) {
168 /* File cache is too recent, so return */
172 if (options->check_file_server_time) {
173 file_options.time_condition = file_time;
175 if (options->use_etag) {
176 gchar *etag_filename = g_strdup_printf("%s.etag", fn);
177 gsize etag_length = 0;
178 g_file_get_contents (etag_filename, &(file_options.etag), &etag_length, NULL);
179 g_free (etag_filename);
180 etag_filename = NULL;
182 /* check if etag is short enough */
183 if (etag_length > 100) {
184 g_free(file_options.etag);
185 file_options.etag = NULL;
188 /* TODO: should check that etag is a valid string */
192 gchar *dir = g_path_get_dirname ( fn );
193 g_mkdir_with_parents ( dir , 0777 );
197 tmpfilename = g_strdup_printf("%s.tmp", fn);
198 if (!lock_file ( tmpfilename ) )
200 g_debug("%s: Couldn't take lock on temporary file \"%s\"\n", __FUNCTION__, tmpfilename);
201 g_free ( tmpfilename );
202 if (options->use_etag)
203 g_free ( file_options.etag );
206 f = g_fopen ( tmpfilename, "w+b" ); /* truncate file and open it */
208 g_warning("Couldn't open temporary file \"%s\": %s", tmpfilename, g_strerror(errno));
209 g_free ( tmpfilename );
210 if (options->use_etag)
211 g_free ( file_options.etag );
215 /* Call the backend function */
216 ret = curl_download_get_url ( hostname, uri, f, options, ftp, &file_options, handle );
218 if (ret != DOWNLOAD_NO_ERROR && ret != DOWNLOAD_NO_NEWER_FILE) {
219 g_debug("%s: download failed: curl_download_get_url=%d", __FUNCTION__, ret);
223 if (!failure && options != NULL && options->check_file != NULL && ! options->check_file(f)) {
224 g_debug("%s: file content checking failed", __FUNCTION__);
233 g_warning(_("Download error: %s"), fn);
234 g_remove ( tmpfilename );
235 unlock_file ( tmpfilename );
236 g_free ( tmpfilename );
237 if (options->use_etag) {
238 g_free ( file_options.etag );
239 g_free ( file_options.new_etag );
244 if (options->use_etag) {
245 if (file_options.new_etag) {
246 /* server returned an etag value */
247 gchar *etag_filename = g_strdup_printf("%s.etag", fn);
248 g_file_set_contents (etag_filename, file_options.new_etag, -1, NULL);
249 g_free (etag_filename);
250 etag_filename = NULL;
254 if (ret == DOWNLOAD_NO_NEWER_FILE) {
255 g_remove ( tmpfilename );
256 #if GLIB_CHECK_VERSION(2,18,0)
257 g_utime ( fn, NULL ); /* update mtime of local copy */
259 utimes ( fn, NULL ); /* update mtime of local copy */
262 g_rename ( tmpfilename, fn ); /* move completely-downloaded file to permanent location */
264 unlock_file ( tmpfilename );
265 g_free ( tmpfilename );
267 if (options->use_etag) {
268 g_free ( file_options.etag );
269 g_free ( file_options.new_etag );
274 /* success = 0, -1 = couldn't connect, -2 HTTP error, -3 file exists, -4 couldn't write to file... */
275 /* uri: like "/uri.html?whatever" */
276 /* only reason for the "wrapper" is so we can do redirects. */
277 int a_http_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *opt, void *handle )
279 return download ( hostname, uri, fn, opt, FALSE, handle );
282 int a_ftp_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *opt, void *handle )
284 return download ( hostname, uri, fn, opt, TRUE, handle );
287 void * a_download_handle_init ()
289 return curl_download_handle_init ();
292 void a_download_handle_cleanup ( void *handle )
294 curl_download_handle_cleanup ( handle );
298 * a_download_url_to_tmp_file:
299 * @uri: The URI (Uniform Resource Identifier)
300 * @options: Download options (maybe NULL)
302 * returns name of the temporary file created - NULL if unsuccessful
303 * this string needs to be freed once used
304 * the file needs to be removed once used
306 gchar *a_download_uri_to_tmp_file ( const gchar *uri, DownloadMapOptions *options )
312 if ( (tmp_fd = g_file_open_tmp ("viking-download.XXXXXX", &tmpname, NULL)) == -1 ) {
313 g_critical (_("couldn't open temp file"));
317 tmp_file = fdopen(tmp_fd, "r+");
319 if ( curl_download_uri ( uri, tmp_file, options, NULL, NULL ) ) {
322 g_remove ( tmpname );