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