]>
Commit | Line | Data |
---|---|---|
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 | /* | |
14 | * We detect based on the cURL version if multi-transfer is | |
15 | * usable in this implementation and define this symbol accordingly. | |
16 | * This shouldn't be set by the Makefile or by the user (e.g. via CFLAGS). | |
17 | */ | |
18 | #undef USE_CURL_MULTI | |
19 | ||
20 | #if LIBCURL_VERSION_NUM >= 0x071000 | |
21 | #define USE_CURL_MULTI | |
22 | #define DEFAULT_MAX_REQUESTS 5 | |
23 | #endif | |
24 | ||
25 | #if LIBCURL_VERSION_NUM < 0x070704 | |
26 | #define curl_global_cleanup() do { /* nothing */ } while (0) | |
27 | #endif | |
28 | ||
29 | #if LIBCURL_VERSION_NUM < 0x070800 | |
30 | #define curl_global_init(a) do { /* nothing */ } while (0) | |
31 | #elif LIBCURL_VERSION_NUM >= 0x070c00 | |
32 | #define curl_global_init(a) curl_global_init_mem(a, xmalloc, free, \ | |
33 | xrealloc, xstrdup, xcalloc) | |
34 | #endif | |
35 | ||
36 | #if (LIBCURL_VERSION_NUM < 0x070c04) || (LIBCURL_VERSION_NUM == 0x071000) | |
37 | #define NO_CURL_EASY_DUPHANDLE | |
38 | #endif | |
39 | ||
40 | #if LIBCURL_VERSION_NUM < 0x070a03 | |
41 | #define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND | |
42 | #endif | |
43 | ||
44 | #if LIBCURL_VERSION_NUM < 0x070c03 | |
45 | #define NO_CURL_IOCTL | |
46 | #endif | |
47 | ||
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 | ||
57 | struct slot_results { | |
58 | CURLcode curl_result; | |
59 | long http_code; | |
60 | long auth_avail; | |
61 | long http_connectcode; | |
62 | }; | |
63 | ||
64 | struct active_request_slot { | |
65 | CURL *curl; | |
66 | int in_use; | |
67 | CURLcode curl_result; | |
68 | long http_code; | |
69 | int *finished; | |
70 | struct slot_results *results; | |
71 | void *callback_data; | |
72 | void (*callback_func)(void *data); | |
73 | struct active_request_slot *next; | |
74 | }; | |
75 | ||
76 | struct buffer { | |
77 | struct strbuf buf; | |
78 | size_t posn; | |
79 | }; | |
80 | ||
81 | /* Curl request read/write callbacks */ | |
82 | size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf); | |
83 | size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf); | |
84 | size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf); | |
85 | #ifndef NO_CURL_IOCTL | |
86 | curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp); | |
87 | #endif | |
88 | ||
89 | /* Slot lifecycle functions */ | |
90 | struct active_request_slot *get_active_slot(void); | |
91 | int start_active_slot(struct active_request_slot *slot); | |
92 | void run_active_slot(struct active_request_slot *slot); | |
93 | void finish_all_active_slots(void); | |
94 | ||
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 | */ | |
101 | int run_one_slot(struct active_request_slot *slot, | |
102 | struct slot_results *results); | |
103 | ||
104 | #ifdef USE_CURL_MULTI | |
105 | void fill_active_slots(void); | |
106 | void add_fill_function(void *data, int (*fill)(void *)); | |
107 | void step_active_slots(void); | |
108 | #endif | |
109 | ||
110 | void http_init(struct remote *remote, const char *url, | |
111 | int proactive_auth); | |
112 | void http_cleanup(void); | |
113 | struct curl_slist *http_copy_default_headers(void); | |
114 | ||
115 | extern long int git_curl_ipresolve; | |
116 | extern int active_requests; | |
117 | extern int http_is_verbose; | |
118 | extern ssize_t http_post_buffer; | |
119 | extern struct credential http_auth; | |
120 | ||
121 | extern char curl_errorstr[CURL_ERROR_SIZE]; | |
122 | ||
123 | enum http_follow_config { | |
124 | HTTP_FOLLOW_NONE, | |
125 | HTTP_FOLLOW_ALWAYS, | |
126 | HTTP_FOLLOW_INITIAL | |
127 | }; | |
128 | extern enum http_follow_config http_follow_config; | |
129 | ||
130 | static 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 | ||
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 | */ | |
149 | void normalize_curl_result(CURLcode *result, long http_code, char *errorstr, | |
150 | size_t errorlen); | |
151 | ||
152 | /* Helpers for modifying and creating URLs */ | |
153 | void append_remote_object_url(struct strbuf *buf, const char *url, | |
154 | const char *hex, | |
155 | int only_two_digit_prefix); | |
156 | char *get_remote_object_url(const char *url, const char *hex, | |
157 | int only_two_digit_prefix); | |
158 | ||
159 | /* Options for http_get_*() */ | |
160 | struct http_get_options { | |
161 | unsigned no_cache:1, | |
162 | initial_request:1; | |
163 | ||
164 | /* If non-NULL, returns the content-type of the response. */ | |
165 | struct strbuf *content_type; | |
166 | ||
167 | /* | |
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 | /* | |
175 | * If non-NULL, returns the URL we ended up at, including any | |
176 | * redirects we followed. | |
177 | */ | |
178 | struct strbuf *effective_url; | |
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; | |
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; | |
194 | }; | |
195 | ||
196 | /* Return values for http_get_*() */ | |
197 | #define HTTP_OK 0 | |
198 | #define HTTP_MISSING_TARGET 1 | |
199 | #define HTTP_ERROR 2 | |
200 | #define HTTP_START_FAILED 3 | |
201 | #define HTTP_REAUTH 4 | |
202 | #define HTTP_NOAUTH 5 | |
203 | ||
204 | /* | |
205 | * Requests a URL and stores the result in a strbuf. | |
206 | * | |
207 | * If the result pointer is NULL, a HTTP HEAD request is made instead of GET. | |
208 | */ | |
209 | int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options); | |
210 | ||
211 | int http_fetch_ref(const char *base, struct ref *ref); | |
212 | ||
213 | /* Helpers for fetching packs */ | |
214 | int http_get_info_packs(const char *base_url, | |
215 | struct packed_git **packs_head); | |
216 | ||
217 | struct http_pack_request { | |
218 | char *url; | |
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 | ||
228 | FILE *packfile; | |
229 | struct strbuf tmpfile; | |
230 | struct active_request_slot *slot; | |
231 | }; | |
232 | ||
233 | struct http_pack_request *new_http_pack_request( | |
234 | const unsigned char *packed_git_hash, const char *base_url); | |
235 | struct http_pack_request *new_direct_http_pack_request( | |
236 | const unsigned char *packed_git_hash, char *url); | |
237 | int finish_http_pack_request(struct http_pack_request *preq); | |
238 | void release_http_pack_request(struct http_pack_request *preq); | |
239 | ||
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 | */ | |
246 | void http_install_packfile(struct packed_git *p, | |
247 | struct packed_git **list_to_remove_from); | |
248 | ||
249 | /* Helpers for fetching object */ | |
250 | struct http_object_request { | |
251 | char *url; | |
252 | struct strbuf tmpfile; | |
253 | int localfile; | |
254 | CURLcode curl_result; | |
255 | char errorstr[CURL_ERROR_SIZE]; | |
256 | long http_code; | |
257 | struct object_id oid; | |
258 | struct object_id real_oid; | |
259 | git_hash_ctx c; | |
260 | git_zstream stream; | |
261 | int zret; | |
262 | int rename; | |
263 | struct active_request_slot *slot; | |
264 | }; | |
265 | ||
266 | struct http_object_request *new_http_object_request( | |
267 | const char *base_url, const struct object_id *oid); | |
268 | void process_http_object_request(struct http_object_request *freq); | |
269 | int finish_http_object_request(struct http_object_request *freq); | |
270 | void abort_http_object_request(struct http_object_request *freq); | |
271 | void release_http_object_request(struct http_object_request *freq); | |
272 | ||
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 | */ | |
278 | void http_trace_curl_no_data(void); | |
279 | ||
280 | /* setup routine for curl_easy_setopt CURLOPT_DEBUGFUNCTION */ | |
281 | void setup_curl_trace(CURL *handle); | |
282 | #endif /* HTTP_H */ |