stash: make sure to write refreshed cache
[git/git.git] / http.h
CommitLineData
29508e1e
NH
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
028c2976 9#include "strbuf.h"
9fc6440d 10#include "remote.h"
1966d9f3 11#include "url.h"
028c2976 12
4f5f998f
JH
13/*
14 * We detect based on the cURL version if multi-transfer is
15 * usable in this implementation and define this symbol accordingly.
01689909 16 * This shouldn't be set by the Makefile or by the user (e.g. via CFLAGS).
4f5f998f
JH
17 */
18#undef USE_CURL_MULTI
19
9cf04301 20#if LIBCURL_VERSION_NUM >= 0x071000
29508e1e
NH
21#define USE_CURL_MULTI
22#define DEFAULT_MAX_REQUESTS 5
23#endif
24
25#if LIBCURL_VERSION_NUM < 0x070704
98746061 26#define curl_global_cleanup() do { /* nothing */ } while (0)
29508e1e
NH
27#endif
28#if LIBCURL_VERSION_NUM < 0x070800
98746061 29#define curl_global_init(a) do { /* nothing */ } while (0)
29508e1e
NH
30#endif
31
500ebb01 32#if (LIBCURL_VERSION_NUM < 0x070c04) || (LIBCURL_VERSION_NUM == 0x071000)
29508e1e
NH
33#define NO_CURL_EASY_DUPHANDLE
34#endif
35
c774b2dc
AH
36#if LIBCURL_VERSION_NUM < 0x070a03
37#define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
38#endif
39
3944ba0c
MS
40#if LIBCURL_VERSION_NUM < 0x070c03
41#define NO_CURL_IOCTL
42#endif
43
4bc444eb
MV
44/*
45 * CURLOPT_USE_SSL was known as CURLOPT_FTP_SSL up to 7.16.4,
46 * and the constants were known as CURLFTPSSL_*
47*/
48#if !defined(CURLOPT_USE_SSL) && defined(CURLOPT_FTP_SSL)
49#define CURLOPT_USE_SSL CURLOPT_FTP_SSL
50#define CURLUSESSL_TRY CURLFTPSSL_TRY
51#endif
52
9cba13ca 53struct slot_results {
c8568e13
NH
54 CURLcode curl_result;
55 long http_code;
0972ccd9 56 long auth_avail;
372370f1 57 long http_connectcode;
c8568e13
NH
58};
59
9cba13ca 60struct active_request_slot {
29508e1e 61 CURL *curl;
29508e1e
NH
62 int in_use;
63 CURLcode curl_result;
64 long http_code;
baa7b67d 65 int *finished;
c8568e13 66 struct slot_results *results;
29508e1e
NH
67 void *callback_data;
68 void (*callback_func)(void *data);
69 struct active_request_slot *next;
70};
71
9cba13ca 72struct buffer {
028c2976
MH
73 struct strbuf buf;
74 size_t posn;
29508e1e
NH
75};
76
77/* Curl request read/write callbacks */
55454427
DL
78size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
79size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
80size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
3944ba0c 81#ifndef NO_CURL_IOCTL
55454427 82curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
3944ba0c 83#endif
29508e1e
NH
84
85/* Slot lifecycle functions */
55454427
DL
86struct active_request_slot *get_active_slot(void);
87int start_active_slot(struct active_request_slot *slot);
88void run_active_slot(struct active_request_slot *slot);
89void finish_all_active_slots(void);
29508e1e 90
beed336c
JK
91/*
92 * This will run one slot to completion in a blocking manner, similar to how
93 * curl_easy_perform would work (but we don't want to use that, because
94 * we do not want to intermingle calls to curl_multi and curl_easy).
95 *
96 */
97int run_one_slot(struct active_request_slot *slot,
98 struct slot_results *results);
99
29508e1e 100#ifdef USE_CURL_MULTI
55454427
DL
101void fill_active_slots(void);
102void add_fill_function(void *data, int (*fill)(void *));
103void step_active_slots(void);
29508e1e
NH
104#endif
105
55454427 106void http_init(struct remote *remote, const char *url,
ad6dad09 107 int proactive_auth);
55454427
DL
108void http_cleanup(void);
109struct curl_slist *http_copy_default_headers(void);
29508e1e 110
c915f11e 111extern long int git_curl_ipresolve;
29508e1e 112extern int active_requests;
e9176745 113extern int http_is_verbose;
37ee680d 114extern ssize_t http_post_buffer;
2501aff8 115extern struct credential http_auth;
29508e1e 116
29508e1e
NH
117extern char curl_errorstr[CURL_ERROR_SIZE];
118
50d34137
JK
119enum http_follow_config {
120 HTTP_FOLLOW_NONE,
121 HTTP_FOLLOW_ALWAYS,
122 HTTP_FOLLOW_INITIAL
123};
124extern enum http_follow_config http_follow_config;
125
e8dc37e0
MH
126static inline int missing__target(int code, int result)
127{
128 return /* file:// URL -- do we ever use one??? */
129 (result == CURLE_FILE_COULDNT_READ_FILE) ||
130 /* http:// and https:// URL */
131 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
132 /* ftp:// URL */
133 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
134 ;
135}
136
137#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
138
a3722bcb
JK
139/*
140 * Normalize curl results to handle CURL_FAILONERROR (or lack thereof). Failing
141 * http codes have their "result" converted to CURLE_HTTP_RETURNED_ERROR, and
142 * an appropriate string placed in the errorstr buffer (pass curl_errorstr if
143 * you don't have a custom buffer).
144 */
145void normalize_curl_result(CURLcode *result, long http_code, char *errorstr,
146 size_t errorlen);
147
5424bc55 148/* Helpers for modifying and creating URLs */
55454427 149void append_remote_object_url(struct strbuf *buf, const char *url,
ad6dad09
DL
150 const char *hex,
151 int only_two_digit_prefix);
55454427 152char *get_remote_object_url(const char *url, const char *hex,
ad6dad09 153 int only_two_digit_prefix);
5424bc55 154
1bbcc224
JK
155/* Options for http_get_*() */
156struct http_get_options {
157 unsigned no_cache:1,
50d34137 158 initial_request:1;
e929cd20 159
1bbcc224
JK
160 /* If non-NULL, returns the content-type of the response. */
161 struct strbuf *content_type;
78868962 162
e3131626
JK
163 /*
164 * If non-NULL, and content_type above is non-NULL, returns
165 * the charset parameter from the content-type. If none is
166 * present, returns an empty string.
167 */
168 struct strbuf *charset;
169
78868962
JK
170 /*
171 * If non-NULL, returns the URL we ended up at, including any
172 * redirects we followed.
173 */
174 struct strbuf *effective_url;
c93c92f3
JK
175
176 /*
177 * If both base_url and effective_url are non-NULL, the base URL will
178 * be munged to reflect any redirections going from the requested url
179 * to effective_url. See the definition of update_url_from_redirect
180 * for details.
181 */
182 struct strbuf *base_url;
8ff14ed4
BW
183
184 /*
185 * If not NULL, contains additional HTTP headers to be sent with the
186 * request. The strings in the list must not be freed until after the
187 * request has completed.
188 */
189 struct string_list *extra_headers;
1bbcc224
JK
190};
191
192/* Return values for http_get_*() */
e929cd20
MH
193#define HTTP_OK 0
194#define HTTP_MISSING_TARGET 1
195#define HTTP_ERROR 2
196#define HTTP_START_FAILED 3
42653c09
SC
197#define HTTP_REAUTH 4
198#define HTTP_NOAUTH 5
e929cd20
MH
199
200/*
a7793a74 201 * Requests a URL and stores the result in a strbuf.
e929cd20
MH
202 *
203 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
204 */
1bbcc224 205int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
e929cd20 206
55454427 207int http_fetch_ref(const char *base, struct ref *ref);
d7e92806 208
b8caac2b 209/* Helpers for fetching packs */
55454427 210int http_get_info_packs(const char *base_url,
ad6dad09 211 struct packed_git **packs_head);
b8caac2b 212
9cba13ca 213struct http_pack_request {
2264dfa5
TRC
214 char *url;
215 struct packed_git *target;
216 struct packed_git **lst;
217 FILE *packfile;
390c6cbc 218 struct strbuf tmpfile;
2264dfa5
TRC
219 struct active_request_slot *slot;
220};
221
55454427 222struct http_pack_request *new_http_pack_request(
2264dfa5 223 struct packed_git *target, const char *base_url);
55454427
DL
224int finish_http_pack_request(struct http_pack_request *preq);
225void release_http_pack_request(struct http_pack_request *preq);
2264dfa5 226
5424bc55 227/* Helpers for fetching object */
9cba13ca 228struct http_object_request {
5424bc55 229 char *url;
390c6cbc 230 struct strbuf tmpfile;
5424bc55
TRC
231 int localfile;
232 CURLcode curl_result;
233 char errorstr[CURL_ERROR_SIZE];
234 long http_code;
f0be0db1
JK
235 struct object_id oid;
236 struct object_id real_oid;
eed0e60f 237 git_hash_ctx c;
ef49a7a0 238 git_zstream stream;
5424bc55
TRC
239 int zret;
240 int rename;
241 struct active_request_slot *slot;
242};
243
55454427 244struct http_object_request *new_http_object_request(
f0be0db1 245 const char *base_url, const struct object_id *oid);
55454427
DL
246void process_http_object_request(struct http_object_request *freq);
247int finish_http_object_request(struct http_object_request *freq);
248void abort_http_object_request(struct http_object_request *freq);
249void release_http_object_request(struct http_object_request *freq);
5424bc55 250
74c682d3
EP
251/* setup routine for curl_easy_setopt CURLOPT_DEBUGFUNCTION */
252void setup_curl_trace(CURL *handle);
29508e1e 253#endif /* HTTP_H */