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 #include "url.h"
  12
  13 /*
  14  * We detect based on the cURL version if multi-transfer is
  15  * usable in this implementation and define this symbol accordingly.
  16  * This is not something Makefile should set nor users should pass
  17  * via CFLAGS.
  18  */
  19 #undef USE_CURL_MULTI
  20
  21 #if LIBCURL_VERSION_NUM >= 0x071000
  22 #define USE_CURL_MULTI
  23 #define DEFAULT_MAX_REQUESTS 5
  24 #endif
  25
  26 #if LIBCURL_VERSION_NUM < 0x070704
  27 #define curl_global_cleanup() do { /* nothing */ } while (0)
  28 #endif
  29 #if LIBCURL_VERSION_NUM < 0x070800
  30 #define curl_global_init(a) do { /* nothing */ } while (0)
  31 #endif
  32
  33 #if (LIBCURL_VERSION_NUM < 0x070c04) || (LIBCURL_VERSION_NUM == 0x071000)
  34 #define NO_CURL_EASY_DUPHANDLE
  35 #endif
  36
  37 #if LIBCURL_VERSION_NUM < 0x070a03
  38 #define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
  39 #endif
  40
  41 #if LIBCURL_VERSION_NUM < 0x070c03
  42 #define NO_CURL_IOCTL
  43 #endif
  44
  45 /*
  46  * CURLOPT_USE_SSL was known as CURLOPT_FTP_SSL up to 7.16.4,
  47  * and the constants were known as CURLFTPSSL_*
  48 */
  49 #if !defined(CURLOPT_USE_SSL) && defined(CURLOPT_FTP_SSL)
  50 #define CURLOPT_USE_SSL CURLOPT_FTP_SSL
  51 #define CURLUSESSL_TRY CURLFTPSSL_TRY
  52 #endif
  53
  54 struct slot_results {
  55         CURLcode curl_result;
  56         long http_code;
  57 };
  58
  59 struct active_request_slot {
  60         CURL *curl;
  61         int in_use;
  62         CURLcode curl_result;
  63         long http_code;
  64         int *finished;
  65         struct slot_results *results;
  66         void *callback_data;
  67         void (*callback_func)(void *data);
  68         struct active_request_slot *next;
  69 };
  70
  71 struct buffer {
  72         struct strbuf buf;
  73         size_t posn;
  74 };
  75
  76 /* Curl request read/write callbacks */
  77 extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  78 extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  79 extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  80 #ifndef NO_CURL_IOCTL
  81 extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
  82 #endif
  83
  84 /* Slot lifecycle functions */
  85 extern struct active_request_slot *get_active_slot(void);
  86 extern int start_active_slot(struct active_request_slot *slot);
  87 extern void run_active_slot(struct active_request_slot *slot);
  88 extern void finish_active_slot(struct active_request_slot *slot);
  89 extern void finish_all_active_slots(void);
  90 extern int handle_curl_result(struct slot_results *results);
  91
  92 #ifdef USE_CURL_MULTI
  93 extern void fill_active_slots(void);
  94 extern void add_fill_function(void *data, int (*fill)(void *));
  95 extern void step_active_slots(void);
  96 #endif
  97
  98 extern void http_init(struct remote *remote, const char *url,
  99                       int proactive_auth);
 100 extern void http_cleanup(void);
 101
 102 extern int active_requests;
 103 extern int http_is_verbose;
 104 extern size_t http_post_buffer;
 105
 106 extern char curl_errorstr[CURL_ERROR_SIZE];
 107
 108 static inline int missing__target(int code, int result)
 109 {
 110         return  /* file:// URL -- do we ever use one??? */
 111                 (result == CURLE_FILE_COULDNT_READ_FILE) ||
 112                 /* http:// and https:// URL */
 113                 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
 114                 /* ftp:// URL */
 115                 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
 116                 ;
 117 }
 118
 119 #define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
 120
 121 /* Helpers for modifying and creating URLs */
 122 extern void append_remote_object_url(struct strbuf *buf, const char *url,
 123                                      const char *hex,
 124                                      int only_two_digit_prefix);
 125 extern char *get_remote_object_url(const char *url, const char *hex,
 126                                    int only_two_digit_prefix);
 127
 128 /* Options for http_request_*() */
 129 #define HTTP_NO_CACHE           1
 130 #define HTTP_KEEP_ERROR         2
 131
 132 /* Return values for http_request_*() */
 133 #define HTTP_OK                 0
 134 #define HTTP_MISSING_TARGET     1
 135 #define HTTP_ERROR              2
 136 #define HTTP_START_FAILED       3
 137 #define HTTP_REAUTH     4
 138 #define HTTP_NOAUTH     5
 139
 140 /*
 141  * Requests a URL and stores the result in a strbuf.
 142  *
 143  * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
 144  */
 145 int http_get_strbuf(const char *url, struct strbuf *content_type, struct strbuf *result, int options);
 146
 147 extern int http_fetch_ref(const char *base, struct ref *ref);
 148
 149 /* Helpers for fetching packs */
 150 extern int http_get_info_packs(const char *base_url,
 151         struct packed_git **packs_head);
 152
 153 struct http_pack_request {
 154         char *url;
 155         struct packed_git *target;
 156         struct packed_git **lst;
 157         FILE *packfile;
 158         char tmpfile[PATH_MAX];
 159         struct curl_slist *range_header;
 160         struct active_request_slot *slot;
 161 };
 162
 163 extern struct http_pack_request *new_http_pack_request(
 164         struct packed_git *target, const char *base_url);
 165 extern int finish_http_pack_request(struct http_pack_request *preq);
 166 extern void release_http_pack_request(struct http_pack_request *preq);
 167
 168 /* Helpers for fetching object */
 169 struct http_object_request {
 170         char *url;
 171         char tmpfile[PATH_MAX];
 172         int localfile;
 173         CURLcode curl_result;
 174         char errorstr[CURL_ERROR_SIZE];
 175         long http_code;
 176         unsigned char sha1[20];
 177         unsigned char real_sha1[20];
 178         git_SHA_CTX c;
 179         git_zstream stream;
 180         int zret;
 181         int rename;
 182         struct active_request_slot *slot;
 183 };
 184
 185 extern struct http_object_request *new_http_object_request(
 186         const char *base_url, unsigned char *sha1);
 187 extern void process_http_object_request(struct http_object_request *freq);
 188 extern int finish_http_object_request(struct http_object_request *freq);
 189 extern void abort_http_object_request(struct http_object_request *freq);
 190 extern void release_http_object_request(struct http_object_request *freq);
 191
 192 #endif /* HTTP_H */