t/t7003: replace \t with literal tab in sed expression
[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"
028c2976 11
4f5f998f
JH
12/*
13 * We detect based on the cURL version if multi-transfer is
14 * usable in this implementation and define this symbol accordingly.
15 * This is not something Makefile should set nor users should pass
16 * via CFLAGS.
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
26#define curl_global_cleanup() do { /* nothing */ } while(0)
27#endif
28#if LIBCURL_VERSION_NUM < 0x070800
29#define curl_global_init(a) do { /* nothing */ } while(0)
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
c8568e13
NH
44struct slot_results
45{
46 CURLcode curl_result;
47 long http_code;
48};
49
29508e1e
NH
50struct active_request_slot
51{
52 CURL *curl;
53 FILE *local;
54 int in_use;
55 CURLcode curl_result;
56 long http_code;
baa7b67d 57 int *finished;
c8568e13 58 struct slot_results *results;
29508e1e
NH
59 void *callback_data;
60 void (*callback_func)(void *data);
61 struct active_request_slot *next;
62};
63
64struct buffer
65{
028c2976
MH
66 struct strbuf buf;
67 size_t posn;
29508e1e
NH
68};
69
70/* Curl request read/write callbacks */
f444e528
JH
71extern size_t fread_buffer(void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
72extern size_t fwrite_buffer(const void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
73extern size_t fwrite_null(const void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
3944ba0c
MS
74#ifndef NO_CURL_IOCTL
75extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
76#endif
29508e1e
NH
77
78/* Slot lifecycle functions */
79extern struct active_request_slot *get_active_slot(void);
80extern int start_active_slot(struct active_request_slot *slot);
81extern void run_active_slot(struct active_request_slot *slot);
de1a2fdd 82extern void finish_active_slot(struct active_request_slot *slot);
29508e1e
NH
83extern void finish_all_active_slots(void);
84
85#ifdef USE_CURL_MULTI
86extern void fill_active_slots(void);
fc57b6aa 87extern void add_fill_function(void *data, int (*fill)(void *));
29508e1e
NH
88extern void step_active_slots(void);
89#endif
90
9fc6440d 91extern void http_init(struct remote *remote);
29508e1e
NH
92extern void http_cleanup(void);
93
94extern int data_received;
95extern int active_requests;
e9176745 96extern int http_is_verbose;
de1a2fdd 97extern size_t http_post_buffer;
29508e1e 98
29508e1e
NH
99extern char curl_errorstr[CURL_ERROR_SIZE];
100
e8dc37e0
MH
101static inline int missing__target(int code, int result)
102{
103 return /* file:// URL -- do we ever use one??? */
104 (result == CURLE_FILE_COULDNT_READ_FILE) ||
105 /* http:// and https:// URL */
106 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
107 /* ftp:// URL */
108 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
109 ;
110}
111
112#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
113
5424bc55
TRC
114/* Helpers for modifying and creating URLs */
115extern void append_remote_object_url(struct strbuf *buf, const char *url,
116 const char *hex,
117 int only_two_digit_prefix);
118extern char *get_remote_object_url(const char *url, const char *hex,
119 int only_two_digit_prefix);
eb9d47cf 120extern void end_url_with_slash(struct strbuf *buf, const char *url);
5424bc55 121
e929cd20
MH
122/* Options for http_request_*() */
123#define HTTP_NO_CACHE 1
124
125/* Return values for http_request_*() */
126#define HTTP_OK 0
127#define HTTP_MISSING_TARGET 1
128#define HTTP_ERROR 2
129#define HTTP_START_FAILED 3
42653c09
SC
130#define HTTP_REAUTH 4
131#define HTTP_NOAUTH 5
e929cd20
MH
132
133/*
134 * Requests an url and stores the result in a strbuf.
135 *
136 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
137 */
138int http_get_strbuf(const char *url, struct strbuf *result, int options);
139
e929cd20
MH
140/*
141 * Prints an error message using error() containing url and curl_errorstr,
142 * and returns ret.
143 */
144int http_error(const char *url, int ret);
145
c13b2633 146extern int http_fetch_ref(const char *base, struct ref *ref);
d7e92806 147
b8caac2b
TRC
148/* Helpers for fetching packs */
149extern int http_get_info_packs(const char *base_url,
150 struct packed_git **packs_head);
151
2264dfa5
TRC
152struct http_pack_request
153{
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
TRC
168/* Helpers for fetching object */
169struct http_object_request
170{
171 char *url;
5424bc55
TRC
172 char tmpfile[PATH_MAX];
173 int localfile;
174 CURLcode curl_result;
175 char errorstr[CURL_ERROR_SIZE];
176 long http_code;
177 unsigned char sha1[20];
178 unsigned char real_sha1[20];
179 git_SHA_CTX c;
180 z_stream stream;
181 int zret;
182 int rename;
183 struct active_request_slot *slot;
184};
185
186extern struct http_object_request *new_http_object_request(
187 const char *base_url, unsigned char *sha1);
188extern void process_http_object_request(struct http_object_request *freq);
189extern int finish_http_object_request(struct http_object_request *freq);
190extern void abort_http_object_request(struct http_object_request *freq);
191extern void release_http_object_request(struct http_object_request *freq);
192
29508e1e 193#endif /* HTTP_H */