🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.29.3 / . / http.h
blob: 5de792ef3fe1dd8597c9b890a120eeacd2eb4994 [file] [log] [blame]
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]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
Mike Hommey028c2972007-12-09 19:30:59[diff] [blame]9#include "strbuf.h"
Mike Hommey9fc64402008-02-27 20:35:50[diff] [blame]10#include "remote.h"
Tay Ray Chuan1966d9f2010-11-25 08:21:04[diff] [blame]11#include "url.h"
Mike Hommey028c2972007-12-09 19:30:59[diff] [blame]12
Junio C Hamano4f5f9982008-01-22 01:34:43[diff] [blame]13/*
14 * We detect based on the cURL version if multi-transfer is
15 * usable in this implementation and define this symbol accordingly.
Justin Lebar01689902014-03-31 22:11:46[diff] [blame]16 * This shouldn't be set by the Makefile or by the user (e.g. via CFLAGS).
Junio C Hamano4f5f9982008-01-22 01:34:43[diff] [blame]17 */
18#undef USE_CURL_MULTI
19
Alexandre Julliard9cf04302007-05-02 12:53:23[diff] [blame]20#if LIBCURL_VERSION_NUM >= 0x071000
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]21#define USE_CURL_MULTI
22#define DEFAULT_MAX_REQUESTS 5
23#endif
24
25#if LIBCURL_VERSION_NUM < 0x070704
Jonathan Nieder98746062010-08-12 22:11:15[diff] [blame]26#define curl_global_cleanup() do { /* nothing */ } while (0)
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]27#endif
Carlo Marcelo Arenas Belón93b980e2019-08-15 19:13:14[diff] [blame]28
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]29#if LIBCURL_VERSION_NUM < 0x070800
Jonathan Nieder98746062010-08-12 22:11:15[diff] [blame]30#define curl_global_init(a) do { /* nothing */ } while (0)
Carlo Marcelo Arenas Belón93b980e2019-08-15 19:13:14[diff] [blame]31#elif LIBCURL_VERSION_NUM >= 0x070c00
32#define curl_global_init(a) curl_global_init_mem(a, xmalloc, free, \
33 xrealloc, xstrdup, xcalloc)
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]34#endif
35
Junio C Hamano500ebb02006-12-27 21:59:26[diff] [blame]36#if (LIBCURL_VERSION_NUM < 0x070c04) || (LIBCURL_VERSION_NUM == 0x071000)
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]37#define NO_CURL_EASY_DUPHANDLE
38#endif
39
Art Haasc774b2d2006-09-19 12:20:19[diff] [blame]40#if LIBCURL_VERSION_NUM < 0x070a03
41#define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
42#endif
43
Martin Storsjö3944ba02009-04-01 16:48:24[diff] [blame]44#if LIBCURL_VERSION_NUM < 0x070c03
45#define NO_CURL_IOCTL
46#endif
47
Modestas Vainius4bc444e2013-04-07 19:10:39[diff] [blame]48/*
49 * CURLOPT_USE_SSL was known as CURLOPT_FTP_SSL up to 7.16.4,
50 * and the constants were known as CURLFTPSSL_*
51*/
52#if !defined(CURLOPT_USE_SSL) && defined(CURLOPT_FTP_SSL)
53#define CURLOPT_USE_SSL CURLOPT_FTP_SSL
54#define CURLUSESSL_TRY CURLFTPSSL_TRY
55#endif
56
Jonathan Nieder9cba13c2011-03-16 07:08:34[diff] [blame]57struct slot_results {
Nick Hengeveldc8568e12006-01-31 19:06:55[diff] [blame]58 CURLcode curl_result;
59 long http_code;
Jeff King0972ccd2013-10-31 06:35:31[diff] [blame]60 long auth_avail;
Knut Franke372370f2016-01-26 13:02:48[diff] [blame]61 long http_connectcode;
Nick Hengeveldc8568e12006-01-31 19:06:55[diff] [blame]62};
63
Jonathan Nieder9cba13c2011-03-16 07:08:34[diff] [blame]64struct active_request_slot {
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]65 CURL *curl;
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]66 int in_use;
67 CURLcode curl_result;
68 long http_code;
Nick Hengeveldbaa7b672006-03-11 04:18:01[diff] [blame]69 int *finished;
Nick Hengeveldc8568e12006-01-31 19:06:55[diff] [blame]70 struct slot_results *results;
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]71 void *callback_data;
72 void (*callback_func)(void *data);
73 struct active_request_slot *next;
74};
75
Jonathan Nieder9cba13c2011-03-16 07:08:34[diff] [blame]76struct buffer {
Mike Hommey028c2972007-12-09 19:30:59[diff] [blame]77 struct strbuf buf;
78 size_t posn;
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]79};
80
81/* Curl request read/write callbacks */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]82size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
83size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
84size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
Martin Storsjö3944ba02009-04-01 16:48:24[diff] [blame]85#ifndef NO_CURL_IOCTL
Denton Liu55454422019-04-29 08:28:14[diff] [blame]86curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
Martin Storsjö3944ba02009-04-01 16:48:24[diff] [blame]87#endif
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]88
89/* Slot lifecycle functions */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]90struct active_request_slot *get_active_slot(void);
91int start_active_slot(struct active_request_slot *slot);
92void run_active_slot(struct active_request_slot *slot);
93void finish_all_active_slots(void);
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]94
Jeff Kingbeed3362014-02-18 10:34:20[diff] [blame]95/*
96 * This will run one slot to completion in a blocking manner, similar to how
97 * curl_easy_perform would work (but we don't want to use that, because
98 * we do not want to intermingle calls to curl_multi and curl_easy).
99 *
100 */
101int run_one_slot(struct active_request_slot *slot,
102 struct slot_results *results);
103
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]104#ifdef USE_CURL_MULTI
Denton Liu55454422019-04-29 08:28:14[diff] [blame]105void fill_active_slots(void);
106void add_fill_function(void *data, int (*fill)(void *));
107void step_active_slots(void);
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]108#endif
109
Denton Liu55454422019-04-29 08:28:14[diff] [blame]110void http_init(struct remote *remote, const char *url,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]111 int proactive_auth);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]112void http_cleanup(void);
113struct curl_slist *http_copy_default_headers(void);
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]114
Eric Wongc915f112016-02-03 04:09:14[diff] [blame]115extern long int git_curl_ipresolve;
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]116extern int active_requests;
Tay Ray Chuane9176742009-06-06 08:43:41[diff] [blame]117extern int http_is_verbose;
David Turner37ee6802017-04-11 18:13:57[diff] [blame]118extern ssize_t http_post_buffer;
Jeff King2501aff2013-09-28 08:31:45[diff] [blame]119extern struct credential http_auth;
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]120
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]121extern char curl_errorstr[CURL_ERROR_SIZE];
122
Jeff King50d34132016-12-06 18:24:41[diff] [blame]123enum http_follow_config {
124 HTTP_FOLLOW_NONE,
125 HTTP_FOLLOW_ALWAYS,
126 HTTP_FOLLOW_INITIAL
127};
128extern enum http_follow_config http_follow_config;
129
Mike Hommeye8dc37e2007-12-10 21:36:09[diff] [blame]130static inline int missing__target(int code, int result)
131{
132 return /* file:// URL -- do we ever use one??? */
133 (result == CURLE_FILE_COULDNT_READ_FILE) ||
134 /* http:// and https:// URL */
135 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
136 /* ftp:// URL */
137 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
138 ;
139}
140
141#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
142
Jeff Kinga3722bc2019-03-24 12:08:38[diff] [blame]143/*
144 * Normalize curl results to handle CURL_FAILONERROR (or lack thereof). Failing
145 * http codes have their "result" converted to CURLE_HTTP_RETURNED_ERROR, and
146 * an appropriate string placed in the errorstr buffer (pass curl_errorstr if
147 * you don't have a custom buffer).
148 */
149void normalize_curl_result(CURLcode *result, long http_code, char *errorstr,
150 size_t errorlen);
151
Tay Ray Chuan5424bc52009-06-06 08:44:02[diff] [blame]152/* Helpers for modifying and creating URLs */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]153void append_remote_object_url(struct strbuf *buf, const char *url,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]154 const char *hex,
155 int only_two_digit_prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]156char *get_remote_object_url(const char *url, const char *hex,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]157 int only_two_digit_prefix);
Tay Ray Chuan5424bc52009-06-06 08:44:02[diff] [blame]158
Jeff King1bbcc222013-09-28 08:31:23[diff] [blame]159/* Options for http_get_*() */
160struct http_get_options {
161 unsigned no_cache:1,
Jeff King50d34132016-12-06 18:24:41[diff] [blame]162 initial_request:1;
Mike Hommeye929cd22009-06-06 08:43:53[diff] [blame]163
Jeff King1bbcc222013-09-28 08:31:23[diff] [blame]164 /* If non-NULL, returns the content-type of the response. */
165 struct strbuf *content_type;
Jeff King78868962013-09-28 08:32:02[diff] [blame]166
167 /*
Jeff Kinge3131622014-05-22 09:30:05[diff] [blame]168 * If non-NULL, and content_type above is non-NULL, returns
169 * the charset parameter from the content-type. If none is
170 * present, returns an empty string.
171 */
172 struct strbuf *charset;
173
174 /*
Jeff King78868962013-09-28 08:32:02[diff] [blame]175 * If non-NULL, returns the URL we ended up at, including any
176 * redirects we followed.
177 */
178 struct strbuf *effective_url;
Jeff Kingc93c92f2013-09-28 08:34:05[diff] [blame]179
180 /*
181 * If both base_url and effective_url are non-NULL, the base URL will
182 * be munged to reflect any redirections going from the requested url
183 * to effective_url. See the definition of update_url_from_redirect
184 * for details.
185 */
186 struct strbuf *base_url;
Brandon Williams8ff14ed2018-03-15 17:31:38[diff] [blame]187
188 /*
189 * If not NULL, contains additional HTTP headers to be sent with the
190 * request. The strings in the list must not be freed until after the
191 * request has completed.
192 */
193 struct string_list *extra_headers;
Jeff King1bbcc222013-09-28 08:31:23[diff] [blame]194};
195
196/* Return values for http_get_*() */
Mike Hommeye929cd22009-06-06 08:43:53[diff] [blame]197#define HTTP_OK 0
198#define HTTP_MISSING_TARGET 1
199#define HTTP_ERROR 2
200#define HTTP_START_FAILED 3
Scott Chacon42653c02010-04-01 22:14:35[diff] [blame]201#define HTTP_REAUTH 4
202#define HTTP_NOAUTH 5
Mike Hommeye929cd22009-06-06 08:43:53[diff] [blame]203
204/*
Jim Meyeringa7793a72012-03-28 08:41:54[diff] [blame]205 * Requests a URL and stores the result in a strbuf.
Mike Hommeye929cd22009-06-06 08:43:53[diff] [blame]206 *
207 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
208 */
Jeff King1bbcc222013-09-28 08:31:23[diff] [blame]209int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
Mike Hommeye929cd22009-06-06 08:43:53[diff] [blame]210
Denton Liu55454422019-04-29 08:28:14[diff] [blame]211int http_fetch_ref(const char *base, struct ref *ref);
Mike Hommeyd7e92802007-12-10 23:08:25[diff] [blame]212
Tay Ray Chuanb8caac22009-06-06 08:43:59[diff] [blame]213/* Helpers for fetching packs */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]214int http_get_info_packs(const char *base_url,
Denton Liuad6dad02019-04-29 08:28:23[diff] [blame]215 struct packed_git **packs_head);
Tay Ray Chuanb8caac22009-06-06 08:43:59[diff] [blame]216
Jonathan Nieder9cba13c2011-03-16 07:08:34[diff] [blame]217struct http_pack_request {
Tay Ray Chuan2264dfa2009-06-06 08:44:01[diff] [blame]218 char *url;
Jonathan Tan8d5d2a32020-06-10 20:57:18[diff] [blame]219
220 /*
221 * If this is true, finish_http_pack_request() will pass "--keep" to
222 * index-pack, resulting in the creation of a keep file, and will not
223 * suppress its stdout (that is, the "keep\t<hash>\n" line will be
224 * printed to stdout).
225 */
226 unsigned generate_keep : 1;
227
Tay Ray Chuan2264dfa2009-06-06 08:44:01[diff] [blame]228 FILE *packfile;
Jeff King390c6cb2018-05-19 01:56:37[diff] [blame]229 struct strbuf tmpfile;
Tay Ray Chuan2264dfa2009-06-06 08:44:01[diff] [blame]230 struct active_request_slot *slot;
231};
232
Denton Liu55454422019-04-29 08:28:14[diff] [blame]233struct http_pack_request *new_http_pack_request(
Jonathan Taneb053492020-06-10 20:57:16[diff] [blame]234 const unsigned char *packed_git_hash, const char *base_url);
Jonathan Tan8d5d2a32020-06-10 20:57:18[diff] [blame]235struct http_pack_request *new_direct_http_pack_request(
236 const unsigned char *packed_git_hash, char *url);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]237int finish_http_pack_request(struct http_pack_request *preq);
238void release_http_pack_request(struct http_pack_request *preq);
Tay Ray Chuan2264dfa2009-06-06 08:44:01[diff] [blame]239
Jonathan Taneb053492020-06-10 20:57:16[diff] [blame]240/*
241 * Remove p from the given list, and invoke install_packed_git() on it.
242 *
243 * This is a convenience function for users that have obtained a list of packs
244 * from http_get_info_packs() and have chosen a specific pack to fetch.
245 */
246void http_install_packfile(struct packed_git *p,
247 struct packed_git **list_to_remove_from);
248
Tay Ray Chuan5424bc52009-06-06 08:44:02[diff] [blame]249/* Helpers for fetching object */
Jonathan Nieder9cba13c2011-03-16 07:08:34[diff] [blame]250struct http_object_request {
Tay Ray Chuan5424bc52009-06-06 08:44:02[diff] [blame]251 char *url;
Jeff King390c6cb2018-05-19 01:56:37[diff] [blame]252 struct strbuf tmpfile;
Tay Ray Chuan5424bc52009-06-06 08:44:02[diff] [blame]253 int localfile;
254 CURLcode curl_result;
255 char errorstr[CURL_ERROR_SIZE];
256 long http_code;
Jeff Kingf0be0db2019-01-07 08:34:40[diff] [blame]257 struct object_id oid;
258 struct object_id real_oid;
brian m. carlsoneed0e602019-02-19 00:05:14[diff] [blame]259 git_hash_ctx c;
Junio C Hamanoef49a7a2011-06-10 18:52:15[diff] [blame]260 git_zstream stream;
Tay Ray Chuan5424bc52009-06-06 08:44:02[diff] [blame]261 int zret;
262 int rename;
263 struct active_request_slot *slot;
264};
265
Denton Liu55454422019-04-29 08:28:14[diff] [blame]266struct http_object_request *new_http_object_request(
Jeff Kingf0be0db2019-01-07 08:34:40[diff] [blame]267 const char *base_url, const struct object_id *oid);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]268void process_http_object_request(struct http_object_request *freq);
269int finish_http_object_request(struct http_object_request *freq);
270void abort_http_object_request(struct http_object_request *freq);
271void release_http_object_request(struct http_object_request *freq);
Tay Ray Chuan5424bc52009-06-06 08:44:02[diff] [blame]272
Jonathan Tan7167a622020-05-11 17:43:10[diff] [blame]273/*
274 * Instead of using environment variables to determine if curl tracing happens,
275 * behave as if GIT_TRACE_CURL=1 and GIT_TRACE_CURL_NO_DATA=1 is set. Call this
276 * before calling setup_curl_trace().
277 */
278void http_trace_curl_no_data(void);
279
Elia Pinto74c682d2016-05-23 13:44:02[diff] [blame]280/* setup routine for curl_easy_setopt CURLOPT_DEBUGFUNCTION */
281void setup_curl_trace(CURL *handle);
Nick Hengeveld29508e12005-11-18 19:02:58[diff] [blame]282#endif /* HTTP_H */