http.h

   1 #ifndef HTTP_H
   2 #define HTTP_H
   3
   4 #include "cache.h"
   5
   6 #include <curl/curl.h>
   7 #include <curl/easy.h>
   8
   9 #include "strbuf.h"
  10 #include "remote.h"
  11
  12 /*
  13  * We detect based on the cURL version if multi-transfer is
  14  * usable in this implementation and define this symbol accordingly.
  15  * This is not something Makefile should set nor users should pass
  16  * via CFLAGS.
  17  */
  18 #undef USE_CURL_MULTI
  19
  20 #if LIBCURL_VERSION_NUM >= 0x071000
  21 #define USE_CURL_MULTI
  22 #define DEFAULT_MAX_REQUESTS 5
  23 #endif
  24
  25 #if LIBCURL_VERSION_NUM < 0x070704
  26 #define curl_global_cleanup() do { /* nothing */ } while(0)
  27 #endif
  28 #if LIBCURL_VERSION_NUM < 0x070800
  29 #define curl_global_init(a) do { /* nothing */ } while(0)
  30 #endif
  31
  32 #if (LIBCURL_VERSION_NUM < 0x070c04) || (LIBCURL_VERSION_NUM == 0x071000)
  33 #define NO_CURL_EASY_DUPHANDLE
  34 #endif
  35
  36 #if LIBCURL_VERSION_NUM < 0x070a03
  37 #define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
  38 #endif
  39
  40 struct slot_results
  41 {
  42         CURLcode curl_result;
  43         long http_code;
  44 };
  45
  46 struct active_request_slot
  47 {
  48         CURL *curl;
  49         FILE *local;
  50         int in_use;
  51         CURLcode curl_result;
  52         long http_code;
  53         int *finished;
  54         struct slot_results *results;
  55         void *callback_data;
  56         void (*callback_func)(void *data);
  57         struct active_request_slot *next;
  58 };
  59
  60 struct buffer
  61 {
  62         struct strbuf buf;
  63         size_t posn;
  64 };
  65
  66 /* Curl request read/write callbacks */
  67 extern size_t fread_buffer(void *ptr, size_t eltsize, size_t nmemb,
  68                            struct buffer *buffer);
  69 extern size_t fwrite_buffer(const void *ptr, size_t eltsize,
  70                             size_t nmemb, struct strbuf *buffer);
  71 extern size_t fwrite_null(const void *ptr, size_t eltsize,
  72                           size_t nmemb, struct strbuf *buffer);
  73
  74 /* Slot lifecycle functions */
  75 extern struct active_request_slot *get_active_slot(void);
  76 extern int start_active_slot(struct active_request_slot *slot);
  77 extern void run_active_slot(struct active_request_slot *slot);
  78 extern void finish_all_active_slots(void);
  79 extern void release_active_slot(struct active_request_slot *slot);
  80
  81 #ifdef USE_CURL_MULTI
  82 extern void fill_active_slots(void);
  83 extern void add_fill_function(void *data, int (*fill)(void *));
  84 extern void step_active_slots(void);
  85 #endif
  86
  87 extern void http_init(struct remote *remote);
  88 extern void http_cleanup(void);
  89
  90 extern int data_received;
  91 extern int active_requests;
  92
  93 extern char curl_errorstr[CURL_ERROR_SIZE];
  94
  95 static inline int missing__target(int code, int result)
  96 {
  97         return  /* file:// URL -- do we ever use one??? */
  98                 (result == CURLE_FILE_COULDNT_READ_FILE) ||
  99                 /* http:// and https:// URL */
 100                 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
 101                 /* ftp:// URL */
 102                 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
 103                 ;
 104 }
 105
 106 #define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
 107
 108 extern int http_fetch_ref(const char *base, struct ref *ref);
 109
 110 #endif /* HTTP_H */