src/curl_download.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2007, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
   5  * Copyright (C) 2007, Quy Tonthat <qtonthat@gmail.com>
   6  * Copyright (C) 2009-2010, Jocelyn Jaubert <jocelyn.jaubert@gmail.com>
   7  * Copyright (C) 2010, Sven Wegener <sven.wegener@stealer.net>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  *
  23  */
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include "config.h"
  27 #endif
  28
  29 #include <stdio.h>
  30
  31 #ifdef HAVE_UNISTD_H
  32 #include <unistd.h>
  33 #endif
  34
  35 #include <glib.h>
  36 #include <glib/gstdio.h>
  37 #include <glib/gi18n.h>
  38 #include <glib/gprintf.h>
  39 #include <gtk/gtk.h>
  40
  41 #include <curl/curl.h>
  42
  43 #include "background.h"
  44 #include "file.h"
  45 #include "globals.h"
  46 #include "curl_download.h"
  47
  48 gchar *curl_download_user_agent = NULL;
  49
  50 /*
  51  * Even if writing to FILE* is supported by libcurl by default,
  52  * it seems that it is non-portable (win32 DLL specific).
  53  *
  54  * So, we provide our own trivial CURLOPT_WRITEFUNCTION.
  55  */
  56 static size_t curl_write_func(void *ptr, size_t size, size_t nmemb, FILE *stream)
  57 {
  58   return fwrite(ptr, size, nmemb, stream);
  59 }
  60
  61 static size_t curl_get_etag_func(char *ptr, size_t size, size_t nmemb, void *stream)
  62 {
  63 #define ETAG_KEYWORD "ETag: "
  64 #define ETAG_LEN (sizeof(ETAG_KEYWORD)-1)
  65   size_t len = size*nmemb;
  66   char *str = g_strstr_len((const char*)ptr, len, ETAG_KEYWORD);
  67   if (str) {
  68     char *etag_str = str + ETAG_LEN;
  69     char *end_str = g_strstr_len(etag_str, len - ETAG_LEN, "\r\n");
  70     if (etag_str && end_str) {
  71       stream = (void*) g_strndup(etag_str, end_str - etag_str);
  72       g_debug("%s: ETAG found: %s", __FUNCTION__, (gchar*)stream);
  73     }
  74   }
  75   return nmemb;
  76 }
  77
  78 static int curl_progress_func(void *clientp, double dltotal, double dlnow, double ultotal, double ulnow)
  79 {
  80   return a_background_testcancel(NULL);
  81 }
  82
  83 static gchar *get_cookie_file(gboolean init)
  84 {
  85   static gchar *cookie_file = NULL;
  86   static GMutex *mutex = NULL;
  87
  88   if (init) { /* to make sure  it's thread safe */
  89     mutex = g_mutex_new();
  90     static gchar *cookie_fn = "cookies.txt";
  91     const gchar *viking_dir = a_get_viking_dir();
  92     cookie_file = g_build_filename(viking_dir, cookie_fn, NULL);
  93     g_unlink(cookie_file);
  94     return NULL;
  95   }
  96
  97   g_assert(cookie_file != NULL);
  98
  99   g_mutex_lock(mutex);
 100   if (g_file_test(cookie_file, G_FILE_TEST_EXISTS) == FALSE) {  /* file not there */
 101     gchar * name_tmp = NULL;
 102     FILE * out_file = tmpfile();
 103     if (out_file == NULL) {
 104       // Something wrong with previous call (unsuported?)
 105       name_tmp = g_strdup_printf("%s.tmp", cookie_file);
 106       out_file = g_fopen(name_tmp, "w+b");
 107     }
 108     CURLcode res;
 109     CURL *curl = curl_easy_init();
 110     if (vik_verbose)
 111       curl_easy_setopt ( curl, CURLOPT_VERBOSE, 1 );
 112     curl_easy_setopt(curl, CURLOPT_URL, "http://maps.google.com/"); /* google.com sets "PREF" cookie */
 113     curl_easy_setopt ( curl, CURLOPT_WRITEDATA, out_file );
 114     curl_easy_setopt ( curl, CURLOPT_WRITEFUNCTION, curl_write_func);
 115     curl_easy_setopt(curl, CURLOPT_COOKIEJAR, cookie_file);
 116     res = curl_easy_perform(curl);
 117     if (res != CURLE_OK) {
 118       g_warning(_("%s() Curl perform failed: %s"), __PRETTY_FUNCTION__,
 119           curl_easy_strerror(res));
 120       g_unlink(cookie_file);
 121     }
 122     curl_easy_cleanup(curl);
 123     fclose(out_file);
 124     out_file = NULL;
 125     if (name_tmp != NULL) {
 126       g_remove(name_tmp);
 127       g_free(name_tmp);
 128       name_tmp = NULL;
 129     }
 130   }
 131   g_mutex_unlock(mutex);
 132
 133   return(cookie_file);
 134 }
 135
 136 /* This should to be called from main() to make sure thread safe */
 137 void curl_download_init()
 138 {
 139   curl_global_init(CURL_GLOBAL_ALL);
 140   get_cookie_file(TRUE);
 141   curl_download_user_agent = g_strdup_printf ("%s/%s %s", PACKAGE, VERSION, curl_version());
 142 }
 143
 144 /* This should to be called from main() to make sure thread safe */
 145 void curl_download_uninit()
 146 {
 147   curl_global_cleanup();
 148 }
 149
 150 int curl_download_uri ( const char *uri, FILE *f, DownloadMapOptions *options, DownloadFileOptions *file_options, void *handle )
 151 {
 152   CURL *curl;
 153   struct curl_slist *curl_send_headers = NULL;
 154   CURLcode res = CURLE_FAILED_INIT;
 155   const gchar *cookie_file;
 156
 157   g_debug("%s: uri=%s", __PRETTY_FUNCTION__, uri);
 158
 159   curl = handle ? handle : curl_easy_init ();
 160   if ( !curl ) {
 161     return DOWNLOAD_ERROR;
 162   }
 163   if (vik_verbose)
 164     curl_easy_setopt ( curl, CURLOPT_VERBOSE, 1 );
 165   curl_easy_setopt ( curl, CURLOPT_NOSIGNAL, 1 ); // Yep, we're a multi-threaded program so don't let signals mess it up!
 166   curl_easy_setopt ( curl, CURLOPT_URL, uri );
 167   curl_easy_setopt ( curl, CURLOPT_WRITEDATA, f );
 168   curl_easy_setopt ( curl, CURLOPT_WRITEFUNCTION, curl_write_func);
 169   curl_easy_setopt ( curl, CURLOPT_NOPROGRESS, 0 );
 170   curl_easy_setopt ( curl, CURLOPT_PROGRESSDATA, NULL );
 171   curl_easy_setopt ( curl, CURLOPT_PROGRESSFUNCTION, curl_progress_func);
 172   if (options != NULL) {
 173     if(options->referer != NULL)
 174       curl_easy_setopt ( curl, CURLOPT_REFERER, options->referer);
 175     if(options->follow_location != 0) {
 176       curl_easy_setopt ( curl, CURLOPT_FOLLOWLOCATION, 1);
 177       curl_easy_setopt ( curl, CURLOPT_MAXREDIRS, options->follow_location);
 178     }
 179     if (file_options != NULL) {
 180       if(options->check_file_server_time && file_options->time_condition != 0) {
 181         /* if file exists, check against server if file is recent enough */
 182         curl_easy_setopt ( curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);
 183         curl_easy_setopt ( curl, CURLOPT_TIMEVALUE, file_options->time_condition);
 184       }
 185       if (options->use_etag) {
 186         if (file_options->etag != NULL) {
 187           /* add an header on the HTTP request */
 188           char str[60];
 189           g_snprintf(str, 60, "If-None-Match: %s", file_options->etag);
 190           curl_send_headers = curl_slist_append(curl_send_headers, str);
 191           curl_easy_setopt ( curl, CURLOPT_HTTPHEADER , curl_send_headers);
 192         }
 193         /* store the new etag from the server in an option value */
 194         curl_easy_setopt ( curl, CURLOPT_WRITEHEADER, &(file_options->new_etag));
 195         curl_easy_setopt ( curl, CURLOPT_HEADERFUNCTION, curl_get_etag_func);
 196       }
 197     }
 198   }
 199   curl_easy_setopt ( curl, CURLOPT_USERAGENT, curl_download_user_agent );
 200   if ((cookie_file = get_cookie_file(FALSE)) != NULL)
 201     curl_easy_setopt(curl, CURLOPT_COOKIEFILE, cookie_file);
 202   res = curl_easy_perform ( curl );
 203
 204   if (res == 0) {
 205     glong response;
 206     curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &response);
 207     if (response == 304) {         // 304 = Not Modified
 208       res = DOWNLOAD_NO_NEWER_FILE;
 209     } else if (response == 200 ||  // http: 200 = Ok
 210                response == 226) {  // ftp:  226 = sucess
 211       gdouble size;
 212       /* verify if curl sends us any data - this is a workaround on using CURLOPT_TIMECONDITION
 213          when the server has a (incorrect) time earlier than the time on the file we already have */
 214       curl_easy_getinfo(curl, CURLINFO_SIZE_DOWNLOAD, &size);
 215       if (size == 0)
 216         res = DOWNLOAD_ERROR;
 217       else
 218         res = DOWNLOAD_NO_ERROR;
 219     } else {
 220       g_warning("%s: http response: %ld for uri %s\n", __FUNCTION__, response, uri);
 221       res = DOWNLOAD_ERROR;
 222     }
 223   } else {
 224     res = DOWNLOAD_ERROR;
 225   }
 226   if (!handle)
 227      curl_easy_cleanup ( curl );
 228   if (curl_send_headers) {
 229     curl_slist_free_all(curl_send_headers);
 230     curl_send_headers = NULL;
 231     curl_easy_setopt ( curl, CURLOPT_HTTPHEADER , NULL);
 232   }
 233   return res;
 234 }
 235
 236 int curl_download_get_url ( const char *hostname, const char *uri, FILE *f, DownloadMapOptions *options, gboolean ftp, DownloadFileOptions *file_options, void *handle )
 237 {
 238   int ret;
 239   gchar *full = NULL;
 240
 241   /* Compose the full url */
 242   full = g_strdup_printf ( "%s://%s%s", (ftp?"ftp":"http"), hostname, uri );
 243   ret = curl_download_uri ( full, f, options, file_options, handle );
 244   g_free ( full );
 245   full = NULL;
 246
 247   return ret;
 248 }
 249
 250 void * curl_download_handle_init ()
 251 {
 252   return curl_easy_init();
 253 }
 254
 255 void curl_download_handle_cleanup ( void *handle )
 256 {
 257   curl_easy_cleanup(handle);
 258 }