]>
Commit | Line | Data |
---|---|---|
29508e1e NH |
1 | #ifndef HTTP_H |
2 | #define HTTP_H | |
3 | ||
d88dbaa7 EN |
4 | struct packed_git; |
5 | ||
d88dbaa7 | 6 | #include "git-zlib.h" |
29508e1e NH |
7 | |
8 | #include <curl/curl.h> | |
9 | #include <curl/easy.h> | |
10 | ||
028c2976 | 11 | #include "strbuf.h" |
9fc6440d | 12 | #include "remote.h" |
028c2976 | 13 | |
29508e1e | 14 | #define DEFAULT_MAX_REQUESTS 5 |
29508e1e | 15 | |
9cba13ca | 16 | struct slot_results { |
c8568e13 NH |
17 | CURLcode curl_result; |
18 | long http_code; | |
0972ccd9 | 19 | long auth_avail; |
372370f1 | 20 | long http_connectcode; |
c8568e13 NH |
21 | }; |
22 | ||
9cba13ca | 23 | struct active_request_slot { |
29508e1e | 24 | CURL *curl; |
29508e1e NH |
25 | int in_use; |
26 | CURLcode curl_result; | |
27 | long http_code; | |
baa7b67d | 28 | int *finished; |
c8568e13 | 29 | struct slot_results *results; |
29508e1e NH |
30 | void *callback_data; |
31 | void (*callback_func)(void *data); | |
32 | struct active_request_slot *next; | |
33 | }; | |
34 | ||
9cba13ca | 35 | struct buffer { |
028c2976 MH |
36 | struct strbuf buf; |
37 | size_t posn; | |
29508e1e NH |
38 | }; |
39 | ||
40 | /* Curl request read/write callbacks */ | |
55454427 DL |
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); | |
fe7e44e1 | 44 | int seek_buffer(void *clientp, curl_off_t offset, int origin); |
29508e1e NH |
45 | |
46 | /* Slot lifecycle functions */ | |
55454427 DL |
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); | |
29508e1e | 51 | |
beed336c JK |
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 | ||
55454427 DL |
61 | void fill_active_slots(void); |
62 | void add_fill_function(void *data, int (*fill)(void *)); | |
63 | void step_active_slots(void); | |
29508e1e | 64 | |
55454427 | 65 | void http_init(struct remote *remote, const char *url, |
ad6dad09 | 66 | int proactive_auth); |
55454427 DL |
67 | void http_cleanup(void); |
68 | struct curl_slist *http_copy_default_headers(void); | |
29508e1e | 69 | |
c915f11e | 70 | extern long int git_curl_ipresolve; |
29508e1e | 71 | extern int active_requests; |
e9176745 | 72 | extern int http_is_verbose; |
37ee680d | 73 | extern ssize_t http_post_buffer; |
2501aff8 | 74 | extern struct credential http_auth; |
29508e1e | 75 | |
29508e1e NH |
76 | extern char curl_errorstr[CURL_ERROR_SIZE]; |
77 | ||
50d34137 JK |
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 | ||
e8dc37e0 MH |
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 | ||
a3722bcb JK |
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 | ||
5424bc55 | 107 | /* Helpers for modifying and creating URLs */ |
55454427 | 108 | void append_remote_object_url(struct strbuf *buf, const char *url, |
ad6dad09 DL |
109 | const char *hex, |
110 | int only_two_digit_prefix); | |
55454427 | 111 | char *get_remote_object_url(const char *url, const char *hex, |
ad6dad09 | 112 | int only_two_digit_prefix); |
5424bc55 | 113 | |
1bbcc224 JK |
114 | /* Options for http_get_*() */ |
115 | struct http_get_options { | |
116 | unsigned no_cache:1, | |
50d34137 | 117 | initial_request:1; |
e929cd20 | 118 | |
1bbcc224 JK |
119 | /* If non-NULL, returns the content-type of the response. */ |
120 | struct strbuf *content_type; | |
78868962 | 121 | |
e3131626 JK |
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 | ||
78868962 JK |
129 | /* |
130 | * If non-NULL, returns the URL we ended up at, including any | |
131 | * redirects we followed. | |
132 | */ | |
133 | struct strbuf *effective_url; | |
c93c92f3 JK |
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; | |
8ff14ed4 BW |
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; | |
1bbcc224 JK |
149 | }; |
150 | ||
151 | /* Return values for http_get_*() */ | |
e929cd20 MH |
152 | #define HTTP_OK 0 |
153 | #define HTTP_MISSING_TARGET 1 | |
154 | #define HTTP_ERROR 2 | |
155 | #define HTTP_START_FAILED 3 | |
42653c09 SC |
156 | #define HTTP_REAUTH 4 |
157 | #define HTTP_NOAUTH 5 | |
3e8084f1 | 158 | #define HTTP_NOMATCHPUBLICKEY 6 |
e929cd20 MH |
159 | |
160 | /* | |
a7793a74 | 161 | * Requests a URL and stores the result in a strbuf. |
e929cd20 MH |
162 | * |
163 | * If the result pointer is NULL, a HTTP HEAD request is made instead of GET. | |
164 | */ | |
1bbcc224 | 165 | int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options); |
e929cd20 | 166 | |
c1d024b8 DS |
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 | ||
55454427 | 176 | int http_fetch_ref(const char *base, struct ref *ref); |
d7e92806 | 177 | |
b8caac2b | 178 | /* Helpers for fetching packs */ |
55454427 | 179 | int http_get_info_packs(const char *base_url, |
ad6dad09 | 180 | struct packed_git **packs_head); |
b8caac2b | 181 | |
b0c4adcd LL |
182 | /* Helper for getting Accept-Language header */ |
183 | const char *http_get_accept_language_header(void); | |
184 | ||
9cba13ca | 185 | struct http_pack_request { |
2264dfa5 | 186 | char *url; |
8d5d2a34 JT |
187 | |
188 | /* | |
726b25a9 JT |
189 | * index-pack command to run. Must be terminated by NULL. |
190 | * | |
191 | * If NULL, defaults to {"index-pack", "--stdin", NULL}. | |
8d5d2a34 | 192 | */ |
726b25a9 JT |
193 | const char **index_pack_args; |
194 | unsigned preserve_index_pack_stdout : 1; | |
8d5d2a34 | 195 | |
2264dfa5 | 196 | FILE *packfile; |
390c6cbc | 197 | struct strbuf tmpfile; |
2264dfa5 TRC |
198 | struct active_request_slot *slot; |
199 | }; | |
200 | ||
55454427 | 201 | struct http_pack_request *new_http_pack_request( |
eb053492 | 202 | const unsigned char *packed_git_hash, const char *base_url); |
8d5d2a34 JT |
203 | struct http_pack_request *new_direct_http_pack_request( |
204 | const unsigned char *packed_git_hash, char *url); | |
55454427 DL |
205 | int finish_http_pack_request(struct http_pack_request *preq); |
206 | void release_http_pack_request(struct http_pack_request *preq); | |
2264dfa5 | 207 | |
eb053492 JT |
208 | /* |
209 | * Remove p from the given list, and invoke install_packed_git() on it. | |
210 | * | |
211 | * This is a convenience function for users that have obtained a list of packs | |
212 | * from http_get_info_packs() and have chosen a specific pack to fetch. | |
213 | */ | |
214 | void http_install_packfile(struct packed_git *p, | |
215 | struct packed_git **list_to_remove_from); | |
216 | ||
5424bc55 | 217 | /* Helpers for fetching object */ |
9cba13ca | 218 | struct http_object_request { |
5424bc55 | 219 | char *url; |
390c6cbc | 220 | struct strbuf tmpfile; |
5424bc55 TRC |
221 | int localfile; |
222 | CURLcode curl_result; | |
223 | char errorstr[CURL_ERROR_SIZE]; | |
224 | long http_code; | |
f0be0db1 JK |
225 | struct object_id oid; |
226 | struct object_id real_oid; | |
eed0e60f | 227 | git_hash_ctx c; |
ef49a7a0 | 228 | git_zstream stream; |
5424bc55 TRC |
229 | int zret; |
230 | int rename; | |
231 | struct active_request_slot *slot; | |
232 | }; | |
233 | ||
55454427 | 234 | struct http_object_request *new_http_object_request( |
f0be0db1 | 235 | const char *base_url, const struct object_id *oid); |
55454427 DL |
236 | void process_http_object_request(struct http_object_request *freq); |
237 | int finish_http_object_request(struct http_object_request *freq); | |
238 | void abort_http_object_request(struct http_object_request *freq); | |
239 | void release_http_object_request(struct http_object_request *freq); | |
5424bc55 | 240 | |
7167a62b JT |
241 | /* |
242 | * Instead of using environment variables to determine if curl tracing happens, | |
243 | * behave as if GIT_TRACE_CURL=1 and GIT_TRACE_CURL_NO_DATA=1 is set. Call this | |
244 | * before calling setup_curl_trace(). | |
245 | */ | |
246 | void http_trace_curl_no_data(void); | |
247 | ||
74c682d3 EP |
248 | /* setup routine for curl_easy_setopt CURLOPT_DEBUGFUNCTION */ |
249 | void setup_curl_trace(CURL *handle); | |
29508e1e | 250 | #endif /* HTTP_H */ |