http_request: factor out curlinfo_strbuf
[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;
29508e1e 105
29508e1e
NH
106extern char curl_errorstr[CURL_ERROR_SIZE];
107
e8dc37e0
MH
108static inline int missing__target(int code, int result)
109{
110 return /* file:// URL -- do we ever use one??? */
111 (result == CURLE_FILE_COULDNT_READ_FILE) ||
112 /* http:// and https:// URL */
113 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
114 /* ftp:// URL */
115 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
116 ;
117}
118
119#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
120
5424bc55
TRC
121/* Helpers for modifying and creating URLs */
122extern void append_remote_object_url(struct strbuf *buf, const char *url,
123 const char *hex,
124 int only_two_digit_prefix);
125extern char *get_remote_object_url(const char *url, const char *hex,
126 int only_two_digit_prefix);
127
e929cd20
MH
128/* Options for http_request_*() */
129#define HTTP_NO_CACHE 1
6d052d78 130#define HTTP_KEEP_ERROR 2
e929cd20
MH
131
132/* Return values for http_request_*() */
133#define HTTP_OK 0
134#define HTTP_MISSING_TARGET 1
135#define HTTP_ERROR 2
136#define HTTP_START_FAILED 3
42653c09
SC
137#define HTTP_REAUTH 4
138#define HTTP_NOAUTH 5
e929cd20
MH
139
140/*
a7793a74 141 * Requests a URL and stores the result in a strbuf.
e929cd20
MH
142 *
143 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
144 */
4656bf47 145int http_get_strbuf(const char *url, struct strbuf *content_type, struct strbuf *result, int options);
e929cd20 146
c13b2633 147extern int http_fetch_ref(const char *base, struct ref *ref);
d7e92806 148
b8caac2b
TRC
149/* Helpers for fetching packs */
150extern int http_get_info_packs(const char *base_url,
151 struct packed_git **packs_head);
152
9cba13ca 153struct http_pack_request {
2264dfa5
TRC
154 char *url;
155 struct packed_git *target;
156 struct packed_git **lst;
157 FILE *packfile;
2264dfa5
TRC
158 char tmpfile[PATH_MAX];
159 struct curl_slist *range_header;
160 struct active_request_slot *slot;
161};
162
163extern struct http_pack_request *new_http_pack_request(
164 struct packed_git *target, const char *base_url);
165extern int finish_http_pack_request(struct http_pack_request *preq);
166extern void release_http_pack_request(struct http_pack_request *preq);
167
5424bc55 168/* Helpers for fetching object */
9cba13ca 169struct http_object_request {
5424bc55 170 char *url;
5424bc55
TRC
171 char tmpfile[PATH_MAX];
172 int localfile;
173 CURLcode curl_result;
174 char errorstr[CURL_ERROR_SIZE];
175 long http_code;
176 unsigned char sha1[20];
177 unsigned char real_sha1[20];
178 git_SHA_CTX c;
ef49a7a0 179 git_zstream stream;
5424bc55
TRC
180 int zret;
181 int rename;
182 struct active_request_slot *slot;
183};
184
185extern struct http_object_request *new_http_object_request(
186 const char *base_url, unsigned char *sha1);
187extern void process_http_object_request(struct http_object_request *freq);
188extern int finish_http_object_request(struct http_object_request *freq);
189extern void abort_http_object_request(struct http_object_request *freq);
190extern void release_http_object_request(struct http_object_request *freq);
191
29508e1e 192#endif /* HTTP_H */