Merge branch 'tb/document-status-u-tradeoff' into maint
[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
9cba13ca 45struct slot_results {
c8568e13
NH
46 CURLcode curl_result;
47 long http_code;
48};
49
9cba13ca 50struct active_request_slot {
29508e1e 51 CURL *curl;
29508e1e
NH
52 int in_use;
53 CURLcode curl_result;
54 long http_code;
baa7b67d 55 int *finished;
c8568e13 56 struct slot_results *results;
29508e1e
NH
57 void *callback_data;
58 void (*callback_func)(void *data);
59 struct active_request_slot *next;
60};
61
9cba13ca 62struct buffer {
028c2976
MH
63 struct strbuf buf;
64 size_t posn;
29508e1e
NH
65};
66
67/* Curl request read/write callbacks */
a04ff3ec
DM
68extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
69extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
70extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
3944ba0c
MS
71#ifndef NO_CURL_IOCTL
72extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
73#endif
29508e1e
NH
74
75/* Slot lifecycle functions */
76extern struct active_request_slot *get_active_slot(void);
77extern int start_active_slot(struct active_request_slot *slot);
78extern void run_active_slot(struct active_request_slot *slot);
de1a2fdd 79extern void finish_active_slot(struct active_request_slot *slot);
29508e1e 80extern void finish_all_active_slots(void);
1960897e 81extern int handle_curl_result(struct slot_results *results);
29508e1e
NH
82
83#ifdef USE_CURL_MULTI
84extern void fill_active_slots(void);
fc57b6aa 85extern void add_fill_function(void *data, int (*fill)(void *));
29508e1e
NH
86extern void step_active_slots(void);
87#endif
88
a4ddbc33
JK
89extern void http_init(struct remote *remote, const char *url,
90 int proactive_auth);
29508e1e
NH
91extern void http_cleanup(void);
92
29508e1e 93extern int active_requests;
e9176745 94extern int http_is_verbose;
de1a2fdd 95extern size_t http_post_buffer;
29508e1e 96
29508e1e
NH
97extern char curl_errorstr[CURL_ERROR_SIZE];
98
e8dc37e0
MH
99static inline int missing__target(int code, int result)
100{
101 return /* file:// URL -- do we ever use one??? */
102 (result == CURLE_FILE_COULDNT_READ_FILE) ||
103 /* http:// and https:// URL */
104 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
105 /* ftp:// URL */
106 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
107 ;
108}
109
110#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
111
5424bc55
TRC
112/* Helpers for modifying and creating URLs */
113extern void append_remote_object_url(struct strbuf *buf, const char *url,
114 const char *hex,
115 int only_two_digit_prefix);
116extern char *get_remote_object_url(const char *url, const char *hex,
117 int only_two_digit_prefix);
118
e929cd20
MH
119/* Options for http_request_*() */
120#define HTTP_NO_CACHE 1
121
122/* Return values for http_request_*() */
123#define HTTP_OK 0
124#define HTTP_MISSING_TARGET 1
125#define HTTP_ERROR 2
126#define HTTP_START_FAILED 3
42653c09
SC
127#define HTTP_REAUTH 4
128#define HTTP_NOAUTH 5
e929cd20
MH
129
130/*
a7793a74 131 * Requests a URL and stores the result in a strbuf.
e929cd20
MH
132 *
133 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
134 */
4656bf47 135int http_get_strbuf(const char *url, struct strbuf *content_type, struct strbuf *result, int options);
e929cd20 136
e929cd20
MH
137/*
138 * Prints an error message using error() containing url and curl_errorstr,
139 * and returns ret.
140 */
141int http_error(const char *url, int ret);
142
c13b2633 143extern int http_fetch_ref(const char *base, struct ref *ref);
d7e92806 144
b8caac2b
TRC
145/* Helpers for fetching packs */
146extern int http_get_info_packs(const char *base_url,
147 struct packed_git **packs_head);
148
9cba13ca 149struct http_pack_request {
2264dfa5
TRC
150 char *url;
151 struct packed_git *target;
152 struct packed_git **lst;
153 FILE *packfile;
2264dfa5
TRC
154 char tmpfile[PATH_MAX];
155 struct curl_slist *range_header;
156 struct active_request_slot *slot;
157};
158
159extern struct http_pack_request *new_http_pack_request(
160 struct packed_git *target, const char *base_url);
161extern int finish_http_pack_request(struct http_pack_request *preq);
162extern void release_http_pack_request(struct http_pack_request *preq);
163
5424bc55 164/* Helpers for fetching object */
9cba13ca 165struct http_object_request {
5424bc55 166 char *url;
5424bc55
TRC
167 char tmpfile[PATH_MAX];
168 int localfile;
169 CURLcode curl_result;
170 char errorstr[CURL_ERROR_SIZE];
171 long http_code;
172 unsigned char sha1[20];
173 unsigned char real_sha1[20];
174 git_SHA_CTX c;
ef49a7a0 175 git_zstream stream;
5424bc55
TRC
176 int zret;
177 int rename;
178 struct active_request_slot *slot;
179};
180
181extern struct http_object_request *new_http_object_request(
182 const char *base_url, unsigned char *sha1);
183extern void process_http_object_request(struct http_object_request *freq);
184extern int finish_http_object_request(struct http_object_request *freq);
185extern void abort_http_object_request(struct http_object_request *freq);
186extern void release_http_object_request(struct http_object_request *freq);
187
29508e1e 188#endif /* HTTP_H */