remote-curl: rename shadowed options variable
[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 */
a04ff3ec
DM
78extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
79extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
80extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
3944ba0c
MS
81#ifndef NO_CURL_IOCTL
82extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
83#endif
29508e1e
NH
84
85/* Slot lifecycle functions */
86extern struct active_request_slot *get_active_slot(void);
87extern int start_active_slot(struct active_request_slot *slot);
88extern void run_active_slot(struct active_request_slot *slot);
89extern void finish_all_active_slots(void);
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
NH
100#ifdef USE_CURL_MULTI
101extern void fill_active_slots(void);
fc57b6aa 102extern void add_fill_function(void *data, int (*fill)(void *));
29508e1e
NH
103extern void step_active_slots(void);
104#endif
105
a4ddbc33
JK
106extern void http_init(struct remote *remote, const char *url,
107 int proactive_auth);
29508e1e 108extern void http_cleanup(void);
8cb01e2f 109extern struct 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;
de1a2fdd 114extern size_t http_post_buffer;
2501aff8 115extern struct credential http_auth;
29508e1e 116
29508e1e
NH
117extern char curl_errorstr[CURL_ERROR_SIZE];
118
e8dc37e0
MH
119static inline int missing__target(int code, int result)
120{
121 return /* file:// URL -- do we ever use one??? */
122 (result == CURLE_FILE_COULDNT_READ_FILE) ||
123 /* http:// and https:// URL */
124 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
125 /* ftp:// URL */
126 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
127 ;
128}
129
130#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
131
5424bc55
TRC
132/* Helpers for modifying and creating URLs */
133extern void append_remote_object_url(struct strbuf *buf, const char *url,
134 const char *hex,
135 int only_two_digit_prefix);
136extern char *get_remote_object_url(const char *url, const char *hex,
137 int only_two_digit_prefix);
138
1bbcc224
JK
139/* Options for http_get_*() */
140struct http_get_options {
141 unsigned no_cache:1,
142 keep_error:1;
e929cd20 143
1bbcc224
JK
144 /* If non-NULL, returns the content-type of the response. */
145 struct strbuf *content_type;
78868962 146
e3131626
JK
147 /*
148 * If non-NULL, and content_type above is non-NULL, returns
149 * the charset parameter from the content-type. If none is
150 * present, returns an empty string.
151 */
152 struct strbuf *charset;
153
78868962
JK
154 /*
155 * If non-NULL, returns the URL we ended up at, including any
156 * redirects we followed.
157 */
158 struct strbuf *effective_url;
c93c92f3
JK
159
160 /*
161 * If both base_url and effective_url are non-NULL, the base URL will
162 * be munged to reflect any redirections going from the requested url
163 * to effective_url. See the definition of update_url_from_redirect
164 * for details.
165 */
166 struct strbuf *base_url;
1bbcc224
JK
167};
168
169/* Return values for http_get_*() */
e929cd20
MH
170#define HTTP_OK 0
171#define HTTP_MISSING_TARGET 1
172#define HTTP_ERROR 2
173#define HTTP_START_FAILED 3
42653c09
SC
174#define HTTP_REAUTH 4
175#define HTTP_NOAUTH 5
e929cd20
MH
176
177/*
a7793a74 178 * Requests a URL and stores the result in a strbuf.
e929cd20
MH
179 *
180 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
181 */
1bbcc224 182int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
e929cd20 183
c13b2633 184extern int http_fetch_ref(const char *base, struct ref *ref);
d7e92806 185
b8caac2b
TRC
186/* Helpers for fetching packs */
187extern int http_get_info_packs(const char *base_url,
188 struct packed_git **packs_head);
189
9cba13ca 190struct http_pack_request {
2264dfa5
TRC
191 char *url;
192 struct packed_git *target;
193 struct packed_git **lst;
194 FILE *packfile;
2264dfa5 195 char tmpfile[PATH_MAX];
2264dfa5
TRC
196 struct active_request_slot *slot;
197};
198
199extern struct http_pack_request *new_http_pack_request(
200 struct packed_git *target, const char *base_url);
201extern int finish_http_pack_request(struct http_pack_request *preq);
202extern void release_http_pack_request(struct http_pack_request *preq);
203
5424bc55 204/* Helpers for fetching object */
9cba13ca 205struct http_object_request {
5424bc55 206 char *url;
5424bc55
TRC
207 char tmpfile[PATH_MAX];
208 int localfile;
209 CURLcode curl_result;
210 char errorstr[CURL_ERROR_SIZE];
211 long http_code;
212 unsigned char sha1[20];
213 unsigned char real_sha1[20];
214 git_SHA_CTX c;
ef49a7a0 215 git_zstream stream;
5424bc55
TRC
216 int zret;
217 int rename;
218 struct active_request_slot *slot;
219};
220
221extern struct http_object_request *new_http_object_request(
222 const char *base_url, unsigned char *sha1);
223extern void process_http_object_request(struct http_object_request *freq);
224extern int finish_http_object_request(struct http_object_request *freq);
225extern void abort_http_object_request(struct http_object_request *freq);
226extern void release_http_object_request(struct http_object_request *freq);
227
29508e1e 228#endif /* HTTP_H */