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 shouldn't be set by the Makefile or by the user (e.g. 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 #if LIBCURL_VERSION_NUM < 0x070c03
  41 #define NO_CURL_IOCTL
  42 #endif
  43
  44 /*
  45  * CURLOPT_USE_SSL was known as CURLOPT_FTP_SSL up to 7.16.4,
  46  * and the constants were known as CURLFTPSSL_*
  47 */
  48 #if !defined(CURLOPT_USE_SSL) && defined(CURLOPT_FTP_SSL)
  49 #define CURLOPT_USE_SSL CURLOPT_FTP_SSL
  50 #define CURLUSESSL_TRY CURLFTPSSL_TRY
  51 #endif
  52
  53 struct slot_results {
  54         CURLcode curl_result;
  55         long http_code;
  56         long auth_avail;
  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 /*
  93  * This will run one slot to completion in a blocking manner, similar to how
  94  * curl_easy_perform would work (but we don't want to use that, because
  95  * we do not want to intermingle calls to curl_multi and curl_easy).
  96  *
  97  */
  98 int run_one_slot(struct active_request_slot *slot,
  99                  struct slot_results *results);
 100
 101 #ifdef USE_CURL_MULTI
 102 extern void fill_active_slots(void);
 103 extern void add_fill_function(void *data, int (*fill)(void *));
 104 extern void step_active_slots(void);
 105 #endif
 106
 107 extern void http_init(struct remote *remote, const char *url,
 108                       int proactive_auth);
 109 extern void http_cleanup(void);
 110
 111 extern int active_requests;
 112 extern int http_is_verbose;
 113 extern size_t http_post_buffer;
 114 extern struct credential http_auth;
 115
 116 extern char curl_errorstr[CURL_ERROR_SIZE];
 117
 118 static inline int missing__target(int code, int result)
 119 {
 120         return  /* file:// URL -- do we ever use one??? */
 121                 (result == CURLE_FILE_COULDNT_READ_FILE) ||
 122                 /* http:// and https:// URL */
 123                 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
 124                 /* ftp:// URL */
 125                 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
 126                 ;
 127 }
 128
 129 #define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
 130
 131 /* Helpers for modifying and creating URLs */
 132 extern void append_remote_object_url(struct strbuf *buf, const char *url,
 133                                      const char *hex,
 134                                      int only_two_digit_prefix);
 135 extern char *get_remote_object_url(const char *url, const char *hex,
 136                                    int only_two_digit_prefix);
 137
 138 /* Options for http_get_*() */
 139 struct http_get_options {
 140         unsigned no_cache:1,
 141                  keep_error:1;
 142
 143         /* If non-NULL, returns the content-type of the response. */
 144         struct strbuf *content_type;
 145
 146         /*
 147          * If non-NULL, and content_type above is non-NULL, returns
 148          * the charset parameter from the content-type. If none is
 149          * present, returns an empty string.
 150          */
 151         struct strbuf *charset;
 152
 153         /*
 154          * If non-NULL, returns the URL we ended up at, including any
 155          * redirects we followed.
 156          */
 157         struct strbuf *effective_url;
 158
 159         /*
 160          * If both base_url and effective_url are non-NULL, the base URL will
 161          * be munged to reflect any redirections going from the requested url
 162          * to effective_url. See the definition of update_url_from_redirect
 163          * for details.
 164          */
 165         struct strbuf *base_url;
 166 };
 167
 168 /* Return values for http_get_*() */
 169 #define HTTP_OK                 0
 170 #define HTTP_MISSING_TARGET     1
 171 #define HTTP_ERROR              2
 172 #define HTTP_START_FAILED       3
 173 #define HTTP_REAUTH     4
 174 #define HTTP_NOAUTH     5
 175
 176 /*
 177  * Requests a URL and stores the result in a strbuf.
 178  *
 179  * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
 180  */
 181 int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
 182
 183 extern int http_fetch_ref(const char *base, struct ref *ref);
 184
 185 /* Helpers for fetching packs */
 186 extern int http_get_info_packs(const char *base_url,
 187         struct packed_git **packs_head);
 188
 189 struct http_pack_request {
 190         char *url;
 191         struct packed_git *target;
 192         struct packed_git **lst;
 193         FILE *packfile;
 194         char tmpfile[PATH_MAX];
 195         struct curl_slist *range_header;
 196         struct active_request_slot *slot;
 197 };
 198
 199 extern struct http_pack_request *new_http_pack_request(
 200         struct packed_git *target, const char *base_url);
 201 extern int finish_http_pack_request(struct http_pack_request *preq);
 202 extern void release_http_pack_request(struct http_pack_request *preq);
 203
 204 /* Helpers for fetching object */
 205 struct http_object_request {
 206         char *url;
 207         char tmpfile[PATH_MAX];
 208         int localfile;
 209         CURLcode curl_result;
 210         char errorstr[CURL_ERROR_SIZE];
 211         long http_code;
 212         unsigned char sha1[20];
 213         unsigned char real_sha1[20];
 214         git_SHA_CTX c;
 215         git_zstream stream;
 216         int zret;
 217         int rename;
 218         struct active_request_slot *slot;
 219 };
 220
 221 extern struct http_object_request *new_http_object_request(
 222         const char *base_url, unsigned char *sha1);
 223 extern void process_http_object_request(struct http_object_request *freq);
 224 extern int finish_http_object_request(struct http_object_request *freq);
 225 extern void abort_http_object_request(struct http_object_request *freq);
 226 extern void release_http_object_request(struct http_object_request *freq);
 227
 228 #endif /* HTTP_H */