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