http.h

   1 #ifndef HTTP_H
   2 #define HTTP_H
   3
   4 struct packed_git;
   5
   6 #include "cache.h"
   7 #include "git-zlib.h"
   8
   9 #include <curl/curl.h>
  10 #include <curl/easy.h>
  11
  12 #include "strbuf.h"
  13 #include "remote.h"
  14 #include "url.h"
  15
  16 #define DEFAULT_MAX_REQUESTS 5
  17
  18 struct slot_results {
  19         CURLcode curl_result;
  20         long http_code;
  21         long auth_avail;
  22         long http_connectcode;
  23 };
  24
  25 struct active_request_slot {
  26         CURL *curl;
  27         int in_use;
  28         CURLcode curl_result;
  29         long http_code;
  30         int *finished;
  31         struct slot_results *results;
  32         void *callback_data;
  33         void (*callback_func)(void *data);
  34         struct active_request_slot *next;
  35 };
  36
  37 struct buffer {
  38         struct strbuf buf;
  39         size_t posn;
  40 };
  41
  42 /* Curl request read/write callbacks */
  43 size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  44 size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  45 size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  46 int seek_buffer(void *clientp, curl_off_t offset, int origin);
  47
  48 /* Slot lifecycle functions */
  49 struct active_request_slot *get_active_slot(void);
  50 int start_active_slot(struct active_request_slot *slot);
  51 void run_active_slot(struct active_request_slot *slot);
  52 void finish_all_active_slots(void);
  53
  54 /*
  55  * This will run one slot to completion in a blocking manner, similar to how
  56  * curl_easy_perform would work (but we don't want to use that, because
  57  * we do not want to intermingle calls to curl_multi and curl_easy).
  58  *
  59  */
  60 int run_one_slot(struct active_request_slot *slot,
  61                  struct slot_results *results);
  62
  63 void fill_active_slots(void);
  64 void add_fill_function(void *data, int (*fill)(void *));
  65 void step_active_slots(void);
  66
  67 void http_init(struct remote *remote, const char *url,
  68                int proactive_auth);
  69 void http_cleanup(void);
  70 struct curl_slist *http_copy_default_headers(void);
  71
  72 extern long int git_curl_ipresolve;
  73 extern int active_requests;
  74 extern int http_is_verbose;
  75 extern ssize_t http_post_buffer;
  76 extern struct credential http_auth;
  77
  78 extern char curl_errorstr[CURL_ERROR_SIZE];
  79
  80 enum http_follow_config {
  81         HTTP_FOLLOW_NONE,
  82         HTTP_FOLLOW_ALWAYS,
  83         HTTP_FOLLOW_INITIAL
  84 };
  85 extern enum http_follow_config http_follow_config;
  86
  87 static inline int missing__target(int code, int result)
  88 {
  89         return  /* file:// URL -- do we ever use one??? */
  90                 (result == CURLE_FILE_COULDNT_READ_FILE) ||
  91                 /* http:// and https:// URL */
  92                 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
  93                 /* ftp:// URL */
  94                 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
  95                 ;
  96 }
  97
  98 #define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
  99
 100 /*
 101  * Normalize curl results to handle CURL_FAILONERROR (or lack thereof). Failing
 102  * http codes have their "result" converted to CURLE_HTTP_RETURNED_ERROR, and
 103  * an appropriate string placed in the errorstr buffer (pass curl_errorstr if
 104  * you don't have a custom buffer).
 105  */
 106 void normalize_curl_result(CURLcode *result, long http_code, char *errorstr,
 107                            size_t errorlen);
 108
 109 /* Helpers for modifying and creating URLs */
 110 void append_remote_object_url(struct strbuf *buf, const char *url,
 111                               const char *hex,
 112                               int only_two_digit_prefix);
 113 char *get_remote_object_url(const char *url, const char *hex,
 114                             int only_two_digit_prefix);
 115
 116 /* Options for http_get_*() */
 117 struct http_get_options {
 118         unsigned no_cache:1,
 119                  initial_request:1;
 120
 121         /* If non-NULL, returns the content-type of the response. */
 122         struct strbuf *content_type;
 123
 124         /*
 125          * If non-NULL, and content_type above is non-NULL, returns
 126          * the charset parameter from the content-type. If none is
 127          * present, returns an empty string.
 128          */
 129         struct strbuf *charset;
 130
 131         /*
 132          * If non-NULL, returns the URL we ended up at, including any
 133          * redirects we followed.
 134          */
 135         struct strbuf *effective_url;
 136
 137         /*
 138          * If both base_url and effective_url are non-NULL, the base URL will
 139          * be munged to reflect any redirections going from the requested url
 140          * to effective_url. See the definition of update_url_from_redirect
 141          * for details.
 142          */
 143         struct strbuf *base_url;
 144
 145         /*
 146          * If not NULL, contains additional HTTP headers to be sent with the
 147          * request. The strings in the list must not be freed until after the
 148          * request has completed.
 149          */
 150         struct string_list *extra_headers;
 151 };
 152
 153 /* Return values for http_get_*() */
 154 #define HTTP_OK                 0
 155 #define HTTP_MISSING_TARGET     1
 156 #define HTTP_ERROR              2
 157 #define HTTP_START_FAILED       3
 158 #define HTTP_REAUTH     4
 159 #define HTTP_NOAUTH     5
 160 #define HTTP_NOMATCHPUBLICKEY   6
 161
 162 /*
 163  * Requests a URL and stores the result in a strbuf.
 164  *
 165  * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
 166  */
 167 int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
 168
 169 /*
 170  * Downloads a URL and stores the result in the given file.
 171  *
 172  * If a previous interrupted download is detected (i.e. a previous temporary
 173  * file is still around) the download is resumed.
 174  */
 175 int http_get_file(const char *url, const char *filename,
 176                   struct http_get_options *options);
 177
 178 int http_fetch_ref(const char *base, struct ref *ref);
 179
 180 /* Helpers for fetching packs */
 181 int http_get_info_packs(const char *base_url,
 182                         struct packed_git **packs_head);
 183
 184 /* Helper for getting Accept-Language header */
 185 const char *http_get_accept_language_header(void);
 186
 187 struct http_pack_request {
 188         char *url;
 189
 190         /*
 191          * index-pack command to run. Must be terminated by NULL.
 192          *
 193          * If NULL, defaults to {"index-pack", "--stdin", NULL}.
 194          */
 195         const char **index_pack_args;
 196         unsigned preserve_index_pack_stdout : 1;
 197
 198         FILE *packfile;
 199         struct strbuf tmpfile;
 200         struct active_request_slot *slot;
 201 };
 202
 203 struct http_pack_request *new_http_pack_request(
 204         const unsigned char *packed_git_hash, const char *base_url);
 205 struct http_pack_request *new_direct_http_pack_request(
 206         const unsigned char *packed_git_hash, char *url);
 207 int finish_http_pack_request(struct http_pack_request *preq);
 208 void release_http_pack_request(struct http_pack_request *preq);
 209
 210 /*
 211  * Remove p from the given list, and invoke install_packed_git() on it.
 212  *
 213  * This is a convenience function for users that have obtained a list of packs
 214  * from http_get_info_packs() and have chosen a specific pack to fetch.
 215  */
 216 void http_install_packfile(struct packed_git *p,
 217                            struct packed_git **list_to_remove_from);
 218
 219 /* Helpers for fetching object */
 220 struct http_object_request {
 221         char *url;
 222         struct strbuf tmpfile;
 223         int localfile;
 224         CURLcode curl_result;
 225         char errorstr[CURL_ERROR_SIZE];
 226         long http_code;
 227         struct object_id oid;
 228         struct object_id real_oid;
 229         git_hash_ctx c;
 230         git_zstream stream;
 231         int zret;
 232         int rename;
 233         struct active_request_slot *slot;
 234 };
 235
 236 struct http_object_request *new_http_object_request(
 237         const char *base_url, const struct object_id *oid);
 238 void process_http_object_request(struct http_object_request *freq);
 239 int finish_http_object_request(struct http_object_request *freq);
 240 void abort_http_object_request(struct http_object_request *freq);
 241 void release_http_object_request(struct http_object_request *freq);
 242
 243 /*
 244  * Instead of using environment variables to determine if curl tracing happens,
 245  * behave as if GIT_TRACE_CURL=1 and GIT_TRACE_CURL_NO_DATA=1 is set. Call this
 246  * before calling setup_curl_trace().
 247  */
 248 void http_trace_curl_no_data(void);
 249
 250 /* setup routine for curl_easy_setopt CURLOPT_DEBUGFUNCTION */
 251 void setup_curl_trace(CURL *handle);
 252 #endif /* HTTP_H */