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 struct slot_results {
  46         CURLcode curl_result;
  47         long http_code;
  48 };
  49
  50 struct active_request_slot {
  51         CURL *curl;
  52         int in_use;
  53         CURLcode curl_result;
  54         long http_code;
  55         int *finished;
  56         struct slot_results *results;
  57         void *callback_data;
  58         void (*callback_func)(void *data);
  59         struct active_request_slot *next;
  60 };
  61
  62 struct buffer {
  63         struct strbuf buf;
  64         size_t posn;
  65 };
  66
  67 /* Curl request read/write callbacks */
  68 extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  69 extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  70 extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  71 #ifndef NO_CURL_IOCTL
  72 extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
  73 #endif
  74
  75 /* Slot lifecycle functions */
  76 extern struct active_request_slot *get_active_slot(void);
  77 extern int start_active_slot(struct active_request_slot *slot);
  78 extern void run_active_slot(struct active_request_slot *slot);
  79 extern void finish_active_slot(struct active_request_slot *slot);
  80 extern void finish_all_active_slots(void);
  81 extern int handle_curl_result(struct active_request_slot *slot,
  82                               struct slot_results *results);
  83
  84 #ifdef USE_CURL_MULTI
  85 extern void fill_active_slots(void);
  86 extern void add_fill_function(void *data, int (*fill)(void *));
  87 extern void step_active_slots(void);
  88 #endif
  89
  90 extern void http_init(struct remote *remote, const char *url,
  91                       int proactive_auth);
  92 extern void http_cleanup(void);
  93
  94 extern int active_requests;
  95 extern int http_is_verbose;
  96 extern size_t http_post_buffer;
  97
  98 extern char curl_errorstr[CURL_ERROR_SIZE];
  99
 100 static inline int missing__target(int code, int result)
 101 {
 102         return  /* file:// URL -- do we ever use one??? */
 103                 (result == CURLE_FILE_COULDNT_READ_FILE) ||
 104                 /* http:// and https:// URL */
 105                 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
 106                 /* ftp:// URL */
 107                 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
 108                 ;
 109 }
 110
 111 #define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
 112
 113 /* Helpers for modifying and creating URLs */
 114 extern void append_remote_object_url(struct strbuf *buf, const char *url,
 115                                      const char *hex,
 116                                      int only_two_digit_prefix);
 117 extern char *get_remote_object_url(const char *url, const char *hex,
 118                                    int only_two_digit_prefix);
 119
 120 /* Options for http_request_*() */
 121 #define HTTP_NO_CACHE           1
 122
 123 /* Return values for http_request_*() */
 124 #define HTTP_OK                 0
 125 #define HTTP_MISSING_TARGET     1
 126 #define HTTP_ERROR              2
 127 #define HTTP_START_FAILED       3
 128 #define HTTP_REAUTH     4
 129 #define HTTP_NOAUTH     5
 130
 131 /*
 132  * Requests a URL and stores the result in a strbuf.
 133  *
 134  * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
 135  */
 136 int http_get_strbuf(const char *url, struct strbuf *result, int options);
 137
 138 /*
 139  * Prints an error message using error() containing url and curl_errorstr,
 140  * and returns ret.
 141  */
 142 int http_error(const char *url, int ret);
 143
 144 extern int http_fetch_ref(const char *base, struct ref *ref);
 145
 146 /* Helpers for fetching packs */
 147 extern int http_get_info_packs(const char *base_url,
 148         struct packed_git **packs_head);
 149
 150 struct http_pack_request {
 151         char *url;
 152         struct packed_git *target;
 153         struct packed_git **lst;
 154         FILE *packfile;
 155         char tmpfile[PATH_MAX];
 156         struct curl_slist *range_header;
 157         struct active_request_slot *slot;
 158 };
 159
 160 extern struct http_pack_request *new_http_pack_request(
 161         struct packed_git *target, const char *base_url);
 162 extern int finish_http_pack_request(struct http_pack_request *preq);
 163 extern void release_http_pack_request(struct http_pack_request *preq);
 164
 165 /* Helpers for fetching object */
 166 struct http_object_request {
 167         char *url;
 168         char tmpfile[PATH_MAX];
 169         int localfile;
 170         CURLcode curl_result;
 171         char errorstr[CURL_ERROR_SIZE];
 172         long http_code;
 173         unsigned char sha1[20];
 174         unsigned char real_sha1[20];
 175         git_SHA_CTX c;
 176         git_zstream stream;
 177         int zret;
 178         int rename;
 179         struct active_request_slot *slot;
 180 };
 181
 182 extern struct http_object_request *new_http_object_request(
 183         const char *base_url, unsigned char *sha1);
 184 extern void process_http_object_request(struct http_object_request *freq);
 185 extern int finish_http_object_request(struct http_object_request *freq);
 186 extern void abort_http_object_request(struct http_object_request *freq);
 187 extern void release_http_object_request(struct http_object_request *freq);
 188
 189 #endif /* HTTP_H */