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