http.h

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