Git 1.9.0
[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;
0972ccd9 57 long auth_avail;
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);
de1a2fdd 89extern void finish_active_slot(struct active_request_slot *slot);
29508e1e 90extern void finish_all_active_slots(void);
1960897e 91extern int handle_curl_result(struct slot_results *results);
29508e1e
NH
92
93#ifdef USE_CURL_MULTI
94extern void fill_active_slots(void);
fc57b6aa 95extern void add_fill_function(void *data, int (*fill)(void *));
29508e1e
NH
96extern void step_active_slots(void);
97#endif
98
a4ddbc33
JK
99extern void http_init(struct remote *remote, const char *url,
100 int proactive_auth);
29508e1e
NH
101extern void http_cleanup(void);
102
29508e1e 103extern int active_requests;
e9176745 104extern int http_is_verbose;
de1a2fdd 105extern size_t http_post_buffer;
2501aff8 106extern struct credential http_auth;
29508e1e 107
29508e1e
NH
108extern char curl_errorstr[CURL_ERROR_SIZE];
109
e8dc37e0
MH
110static inline int missing__target(int code, int result)
111{
112 return /* file:// URL -- do we ever use one??? */
113 (result == CURLE_FILE_COULDNT_READ_FILE) ||
114 /* http:// and https:// URL */
115 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
116 /* ftp:// URL */
117 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
118 ;
119}
120
121#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
122
5424bc55
TRC
123/* Helpers for modifying and creating URLs */
124extern void append_remote_object_url(struct strbuf *buf, const char *url,
125 const char *hex,
126 int only_two_digit_prefix);
127extern char *get_remote_object_url(const char *url, const char *hex,
128 int only_two_digit_prefix);
129
1bbcc224
JK
130/* Options for http_get_*() */
131struct http_get_options {
132 unsigned no_cache:1,
133 keep_error:1;
e929cd20 134
1bbcc224
JK
135 /* If non-NULL, returns the content-type of the response. */
136 struct strbuf *content_type;
78868962
JK
137
138 /*
139 * If non-NULL, returns the URL we ended up at, including any
140 * redirects we followed.
141 */
142 struct strbuf *effective_url;
c93c92f3
JK
143
144 /*
145 * If both base_url and effective_url are non-NULL, the base URL will
146 * be munged to reflect any redirections going from the requested url
147 * to effective_url. See the definition of update_url_from_redirect
148 * for details.
149 */
150 struct strbuf *base_url;
1bbcc224
JK
151};
152
153/* Return values for http_get_*() */
e929cd20
MH
154#define HTTP_OK 0
155#define HTTP_MISSING_TARGET 1
156#define HTTP_ERROR 2
157#define HTTP_START_FAILED 3
42653c09
SC
158#define HTTP_REAUTH 4
159#define HTTP_NOAUTH 5
e929cd20
MH
160
161/*
a7793a74 162 * Requests a URL and stores the result in a strbuf.
e929cd20
MH
163 *
164 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
165 */
1bbcc224 166int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
e929cd20 167
c13b2633 168extern int http_fetch_ref(const char *base, struct ref *ref);
d7e92806 169
b8caac2b
TRC
170/* Helpers for fetching packs */
171extern int http_get_info_packs(const char *base_url,
172 struct packed_git **packs_head);
173
9cba13ca 174struct http_pack_request {
2264dfa5
TRC
175 char *url;
176 struct packed_git *target;
177 struct packed_git **lst;
178 FILE *packfile;
2264dfa5
TRC
179 char tmpfile[PATH_MAX];
180 struct curl_slist *range_header;
181 struct active_request_slot *slot;
182};
183
184extern struct http_pack_request *new_http_pack_request(
185 struct packed_git *target, const char *base_url);
186extern int finish_http_pack_request(struct http_pack_request *preq);
187extern void release_http_pack_request(struct http_pack_request *preq);
188
5424bc55 189/* Helpers for fetching object */
9cba13ca 190struct http_object_request {
5424bc55 191 char *url;
5424bc55
TRC
192 char tmpfile[PATH_MAX];
193 int localfile;
194 CURLcode curl_result;
195 char errorstr[CURL_ERROR_SIZE];
196 long http_code;
197 unsigned char sha1[20];
198 unsigned char real_sha1[20];
199 git_SHA_CTX c;
ef49a7a0 200 git_zstream stream;
5424bc55
TRC
201 int zret;
202 int rename;
203 struct active_request_slot *slot;
204};
205
206extern struct http_object_request *new_http_object_request(
207 const char *base_url, unsigned char *sha1);
208extern void process_http_object_request(struct http_object_request *freq);
209extern int finish_http_object_request(struct http_object_request *freq);
210extern void abort_http_object_request(struct http_object_request *freq);
211extern void release_http_object_request(struct http_object_request *freq);
212
29508e1e 213#endif /* HTTP_H */