http: hoist credential request out of handle_curl_result
[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.
16 * This is not something Makefile should set nor users should pass
17 * via CFLAGS.
18 */
19#undef USE_CURL_MULTI
20
9cf04301 21#if LIBCURL_VERSION_NUM >= 0x071000
29508e1e
NH
22#define USE_CURL_MULTI
23#define DEFAULT_MAX_REQUESTS 5
24#endif
25
26#if LIBCURL_VERSION_NUM < 0x070704
98746061 27#define curl_global_cleanup() do { /* nothing */ } while (0)
29508e1e
NH
28#endif
29#if LIBCURL_VERSION_NUM < 0x070800
98746061 30#define curl_global_init(a) do { /* nothing */ } while (0)
29508e1e
NH
31#endif
32
500ebb01 33#if (LIBCURL_VERSION_NUM < 0x070c04) || (LIBCURL_VERSION_NUM == 0x071000)
29508e1e
NH
34#define NO_CURL_EASY_DUPHANDLE
35#endif
36
c774b2dc
AH
37#if LIBCURL_VERSION_NUM < 0x070a03
38#define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
39#endif
40
3944ba0c
MS
41#if LIBCURL_VERSION_NUM < 0x070c03
42#define NO_CURL_IOCTL
43#endif
44
4bc444eb
MV
45/*
46 * CURLOPT_USE_SSL was known as CURLOPT_FTP_SSL up to 7.16.4,
47 * and the constants were known as CURLFTPSSL_*
48*/
49#if !defined(CURLOPT_USE_SSL) && defined(CURLOPT_FTP_SSL)
50#define CURLOPT_USE_SSL CURLOPT_FTP_SSL
51#define CURLUSESSL_TRY CURLFTPSSL_TRY
52#endif
53
9cba13ca 54struct slot_results {
c8568e13
NH
55 CURLcode curl_result;
56 long http_code;
57};
58
9cba13ca 59struct active_request_slot {
29508e1e 60 CURL *curl;
29508e1e
NH
61 int in_use;
62 CURLcode curl_result;
63 long http_code;
baa7b67d 64 int *finished;
c8568e13 65 struct slot_results *results;
29508e1e
NH
66 void *callback_data;
67 void (*callback_func)(void *data);
68 struct active_request_slot *next;
69};
70
9cba13ca 71struct buffer {
028c2976
MH
72 struct strbuf buf;
73 size_t posn;
29508e1e
NH
74};
75
76/* Curl request read/write callbacks */
a04ff3ec
DM
77extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
78extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
79extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
3944ba0c
MS
80#ifndef NO_CURL_IOCTL
81extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
82#endif
29508e1e
NH
83
84/* Slot lifecycle functions */
85extern struct active_request_slot *get_active_slot(void);
86extern int start_active_slot(struct active_request_slot *slot);
87extern void run_active_slot(struct active_request_slot *slot);
de1a2fdd 88extern void finish_active_slot(struct active_request_slot *slot);
29508e1e 89extern void finish_all_active_slots(void);
1960897e 90extern int handle_curl_result(struct slot_results *results);
29508e1e
NH
91
92#ifdef USE_CURL_MULTI
93extern void fill_active_slots(void);
fc57b6aa 94extern void add_fill_function(void *data, int (*fill)(void *));
29508e1e
NH
95extern void step_active_slots(void);
96#endif
97
a4ddbc33
JK
98extern void http_init(struct remote *remote, const char *url,
99 int proactive_auth);
29508e1e
NH
100extern void http_cleanup(void);
101
29508e1e 102extern int active_requests;
e9176745 103extern int http_is_verbose;
de1a2fdd 104extern size_t http_post_buffer;
2501aff8 105extern struct credential http_auth;
29508e1e 106
29508e1e
NH
107extern char curl_errorstr[CURL_ERROR_SIZE];
108
e8dc37e0
MH
109static inline int missing__target(int code, int result)
110{
111 return /* file:// URL -- do we ever use one??? */
112 (result == CURLE_FILE_COULDNT_READ_FILE) ||
113 /* http:// and https:// URL */
114 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
115 /* ftp:// URL */
116 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
117 ;
118}
119
120#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
121
5424bc55
TRC
122/* Helpers for modifying and creating URLs */
123extern void append_remote_object_url(struct strbuf *buf, const char *url,
124 const char *hex,
125 int only_two_digit_prefix);
126extern char *get_remote_object_url(const char *url, const char *hex,
127 int only_two_digit_prefix);
128
1bbcc224
JK
129/* Options for http_get_*() */
130struct http_get_options {
131 unsigned no_cache:1,
132 keep_error:1;
e929cd20 133
1bbcc224
JK
134 /* If non-NULL, returns the content-type of the response. */
135 struct strbuf *content_type;
136};
137
138/* Return values for http_get_*() */
e929cd20
MH
139#define HTTP_OK 0
140#define HTTP_MISSING_TARGET 1
141#define HTTP_ERROR 2
142#define HTTP_START_FAILED 3
42653c09
SC
143#define HTTP_REAUTH 4
144#define HTTP_NOAUTH 5
e929cd20
MH
145
146/*
a7793a74 147 * Requests a URL and stores the result in a strbuf.
e929cd20
MH
148 *
149 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
150 */
1bbcc224 151int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
e929cd20 152
c13b2633 153extern int http_fetch_ref(const char *base, struct ref *ref);
d7e92806 154
b8caac2b
TRC
155/* Helpers for fetching packs */
156extern int http_get_info_packs(const char *base_url,
157 struct packed_git **packs_head);
158
9cba13ca 159struct http_pack_request {
2264dfa5
TRC
160 char *url;
161 struct packed_git *target;
162 struct packed_git **lst;
163 FILE *packfile;
2264dfa5
TRC
164 char tmpfile[PATH_MAX];
165 struct curl_slist *range_header;
166 struct active_request_slot *slot;
167};
168
169extern struct http_pack_request *new_http_pack_request(
170 struct packed_git *target, const char *base_url);
171extern int finish_http_pack_request(struct http_pack_request *preq);
172extern void release_http_pack_request(struct http_pack_request *preq);
173
5424bc55 174/* Helpers for fetching object */
9cba13ca 175struct http_object_request {
5424bc55 176 char *url;
5424bc55
TRC
177 char tmpfile[PATH_MAX];
178 int localfile;
179 CURLcode curl_result;
180 char errorstr[CURL_ERROR_SIZE];
181 long http_code;
182 unsigned char sha1[20];
183 unsigned char real_sha1[20];
184 git_SHA_CTX c;
ef49a7a0 185 git_zstream stream;
5424bc55
TRC
186 int zret;
187 int rename;
188 struct active_request_slot *slot;
189};
190
191extern struct http_object_request *new_http_object_request(
192 const char *base_url, unsigned char *sha1);
193extern void process_http_object_request(struct http_object_request *freq);
194extern int finish_http_object_request(struct http_object_request *freq);
195extern void abort_http_object_request(struct http_object_request *freq);
196extern void release_http_object_request(struct http_object_request *freq);
197
29508e1e 198#endif /* HTTP_H */