src/download.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include "config.h"
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <ctype.h>
  28 #include <errno.h>
  29 #include <string.h>
  30 #ifdef HAVE_SYS_TYPES_H
  31 #include <sys/types.h>
  32 #endif
  33 #ifdef HAVE_UTIME_H
  34 #include <utime.h>
  35 #endif
  36 #include <glib.h>
  37 #include <glib/gstdio.h>
  38 #include <glib/gi18n.h>
  39
  40
  41 #include "download.h"
  42
  43 #include "curl_download.h"
  44 #include "preferences.h"
  45 #include "globals.h"
  46
  47 static gboolean check_file_first_line(FILE* f, gchar *patterns[])
  48 {
  49   gchar **s;
  50   gchar *bp;
  51   fpos_t pos;
  52   gchar buf[33];
  53   size_t nr;
  54
  55   memset(buf, 0, sizeof(buf));
  56   fgetpos(f, &pos);
  57   rewind(f);
  58   nr = fread(buf, 1, sizeof(buf) - 1, f);
  59   fsetpos(f, &pos);
  60   for (bp = buf; (bp < (buf + sizeof(buf) - 1)) && (nr > (bp - buf)); bp++) {
  61     if (!(isspace(*bp)))
  62       break;
  63   }
  64   if ((bp >= (buf + sizeof(buf) -1)) || ((bp - buf) >= nr))
  65     return FALSE;
  66   for (s = patterns; *s; s++) {
  67     if (strncasecmp(*s, bp, strlen(*s)) == 0)
  68       return TRUE;
  69   }
  70   return FALSE;
  71 }
  72
  73 gboolean a_check_html_file(FILE* f)
  74 {
  75   gchar * html_str[] = {
  76     "<html",
  77     "<!DOCTYPE html",
  78     "<head",
  79     "<title",
  80     NULL
  81   };
  82
  83   return check_file_first_line(f, html_str);
  84 }
  85
  86 gboolean a_check_map_file(FILE* f)
  87 {
  88   /* FIXME no more true since a_check_kml_file */
  89   return !a_check_html_file(f);
  90 }
  91
  92 gboolean a_check_kml_file(FILE* f)
  93 {
  94   gchar * kml_str[] = {
  95     "<?xml",
  96     NULL
  97   };
  98
  99   return check_file_first_line(f, kml_str);
 100 }
 101
 102 static GList *file_list = NULL;
 103 static GMutex *file_list_mutex = NULL;
 104
 105 /* spin button scales */
 106 VikLayerParamScale params_scales[] = {
 107   {1, 86400*7, 10, 0},          /* download_tile_age */
 108 };
 109
 110 static VikLayerParam prefs[] = {
 111   { VIKING_PREFERENCES_NAMESPACE "download_tile_age", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Tile age (s):"), VIK_LAYER_WIDGET_SPINBUTTON, params_scales + 0, NULL },
 112 };
 113
 114 void a_download_init (void)
 115 {
 116         VikLayerParamData tmp;
 117         tmp.u = VIK_CONFIG_DEFAULT_TILE_AGE;
 118         a_preferences_register(prefs, tmp, VIKING_PREFERENCES_GROUP_KEY);
 119
 120         file_list_mutex = g_mutex_new();
 121 }
 122
 123 static gboolean lock_file(const char *fn)
 124 {
 125         gboolean locked = FALSE;
 126         g_mutex_lock(file_list_mutex);
 127         if (g_list_find(file_list, fn) == NULL)
 128         {
 129                 // The filename is not yet locked
 130                 file_list = g_list_append(file_list, (gpointer)fn),
 131                 locked = TRUE;
 132         }
 133         g_mutex_unlock(file_list_mutex);
 134         return locked;
 135 }
 136
 137 static void unlock_file(const char *fn)
 138 {
 139         g_mutex_lock(file_list_mutex);
 140         file_list = g_list_remove(file_list, (gconstpointer)fn);
 141         g_mutex_unlock(file_list_mutex);
 142 }
 143
 144 static int download( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *options, gboolean ftp, void *handle)
 145 {
 146   FILE *f;
 147   int ret;
 148   gchar *tmpfilename;
 149   gboolean failure = FALSE;
 150   DownloadFileOptions file_options = {0, NULL, NULL};
 151
 152   /* Check file */
 153   if ( g_file_test ( fn, G_FILE_TEST_EXISTS ) == TRUE )
 154   {
 155     if (options == NULL || (!options->check_file_server_time &&
 156                             !options->use_etag)) {
 157       /* Nothing to do as file already exists and we don't want to check server */
 158       return -3;
 159     }
 160
 161     time_t tile_age = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "download_tile_age")->u;
 162     /* Get the modified time of this file */
 163     struct stat buf;
 164     g_stat ( fn, &buf );
 165     time_t file_time = buf.st_mtime;
 166     if ( (time(NULL) - file_time) < tile_age ) {
 167       /* File cache is too recent, so return */
 168       return -3;
 169     }
 170
 171     if (options->check_file_server_time) {
 172       file_options.time_condition = file_time;
 173     }
 174     if (options->use_etag) {
 175       gchar *etag_filename = g_strdup_printf("%s.etag", fn);
 176       gsize etag_length;
 177       g_file_get_contents (etag_filename, &(file_options.etag), &etag_length, NULL);
 178
 179       /* check if etag is short enough */
 180       if (etag_length > 100)
 181         g_free(file_options.etag);
 182
 183       /* TODO: should check that etag is a valid string */
 184     }
 185
 186   } else {
 187     gchar *dir = g_path_get_dirname ( fn );
 188     g_mkdir_with_parents ( dir , 0777 );
 189     g_free ( dir );
 190   }
 191
 192   tmpfilename = g_strdup_printf("%s.tmp", fn);
 193   if (!lock_file ( tmpfilename ) )
 194   {
 195     g_debug("%s: Couldn't take lock on temporary file \"%s\"\n", __FUNCTION__, tmpfilename);
 196     g_free ( tmpfilename );
 197     return -4;
 198   }
 199   f = g_fopen ( tmpfilename, "w+b" );  /* truncate file and open it */
 200   if ( ! f ) {
 201     g_warning("Couldn't open temporary file \"%s\": %s", tmpfilename, g_strerror(errno));
 202     g_free ( tmpfilename );
 203     return -4;
 204   }
 205
 206   /* Call the backend function */
 207   ret = curl_download_get_url ( hostname, uri, f, options, ftp, &file_options, handle );
 208
 209   if (ret != DOWNLOAD_NO_ERROR && ret != DOWNLOAD_NO_NEWER_FILE) {
 210     g_debug("%s: download failed: curl_download_get_url=%d", __FUNCTION__, ret);
 211     failure = TRUE;
 212   }
 213
 214   if (!failure && options != NULL && options->check_file != NULL && ! options->check_file(f)) {
 215     g_debug("%s: file content checking failed", __FUNCTION__);
 216     failure = TRUE;
 217   }
 218
 219   fclose ( f );
 220   f = NULL;
 221
 222   if (failure)
 223   {
 224     g_warning(_("Download error: %s"), fn);
 225     g_remove ( tmpfilename );
 226     unlock_file ( tmpfilename );
 227     g_free ( tmpfilename );
 228     if (options->use_etag) {
 229       g_free ( file_options.etag );
 230       g_free ( file_options.new_etag );
 231     }
 232     g_remove ( fn ); /* couldn't create temporary. delete 0-byte file. */
 233     return -1;
 234   }
 235
 236   if (options->use_etag) {
 237     if (file_options.new_etag) {
 238       /* server returned an etag value */
 239       gchar *etag_filename = g_strdup_printf("%s.etag", fn);
 240       g_file_set_contents (etag_filename, file_options.new_etag, -1, NULL);
 241     }
 242   }
 243
 244   if (ret == DOWNLOAD_NO_NEWER_FILE)  {
 245     g_remove ( tmpfilename );
 246 #if GLIB_CHECK_VERSION(2,18,0)
 247     g_utime ( fn, NULL ); /* update mtime of local copy */
 248 #else
 249     utimes ( fn, NULL ); /* update mtime of local copy */
 250 #endif
 251   } else
 252     g_rename ( tmpfilename, fn ); /* move completely-downloaded file to permanent location */
 253   unlock_file ( tmpfilename );
 254   g_free ( tmpfilename );
 255
 256   if (options->use_etag) {
 257     g_free ( file_options.etag );
 258     g_free ( file_options.new_etag );
 259   }
 260   return 0;
 261 }
 262
 263 /* success = 0, -1 = couldn't connect, -2 HTTP error, -3 file exists, -4 couldn't write to file... */
 264 /* uri: like "/uri.html?whatever" */
 265 /* only reason for the "wrapper" is so we can do redirects. */
 266 int a_http_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *opt, void *handle )
 267 {
 268   return download ( hostname, uri, fn, opt, FALSE, handle );
 269 }
 270
 271 int a_ftp_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *opt, void *handle )
 272 {
 273   return download ( hostname, uri, fn, opt, TRUE, handle );
 274 }
 275
 276 void * a_download_handle_init ()
 277 {
 278   return curl_download_handle_init ();
 279 }
 280
 281 void a_download_handle_cleanup ( void *handle )
 282 {
 283   curl_download_handle_cleanup ( handle );
 284 }