Merge branch 'esr/maint-doc-fast-import'
[git.git] / http.h
blob0a80d303e369b4adf77ca131c732ba39a990610d
1 #ifndef HTTP_H
2 #define HTTP_H
4 #include "cache.h"
6 #include <curl/curl.h>
7 #include <curl/easy.h>
9 #include "strbuf.h"
10 #include "remote.h"
11 #include "url.h"
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.
19 #undef USE_CURL_MULTI
21 #if LIBCURL_VERSION_NUM >= 0x071000
22 #define USE_CURL_MULTI
23 #define DEFAULT_MAX_REQUESTS 5
24 #endif
26 #if LIBCURL_VERSION_NUM < 0x070704
27 #define curl_global_cleanup() do { /* nothing */ } while (0)
28 #endif
29 #if LIBCURL_VERSION_NUM < 0x070800
30 #define curl_global_init(a) do { /* nothing */ } while (0)
31 #endif
33 #if (LIBCURL_VERSION_NUM < 0x070c04) || (LIBCURL_VERSION_NUM == 0x071000)
34 #define NO_CURL_EASY_DUPHANDLE
35 #endif
37 #if LIBCURL_VERSION_NUM < 0x070a03
38 #define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
39 #endif
41 #if LIBCURL_VERSION_NUM < 0x070c03
42 #define NO_CURL_IOCTL
43 #endif
45 struct slot_results {
46 CURLcode curl_result;
47 long http_code;
50 struct active_request_slot {
51 CURL *curl;
52 int in_use;
53 CURLcode curl_result;
54 long http_code;
55 int *finished;
56 struct slot_results *results;
57 void *callback_data;
58 void (*callback_func)(void *data);
59 struct active_request_slot *next;
62 struct buffer {
63 struct strbuf buf;
64 size_t posn;
67 /* Curl request read/write callbacks */
68 extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
69 extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
70 extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
71 #ifndef NO_CURL_IOCTL
72 extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
73 #endif
75 /* Slot lifecycle functions */
76 extern struct active_request_slot *get_active_slot(void);
77 extern int start_active_slot(struct active_request_slot *slot);
78 extern void run_active_slot(struct active_request_slot *slot);
79 extern void finish_active_slot(struct active_request_slot *slot);
80 extern void finish_all_active_slots(void);
81 extern int handle_curl_result(struct slot_results *results);
83 #ifdef USE_CURL_MULTI
84 extern void fill_active_slots(void);
85 extern void add_fill_function(void *data, int (*fill)(void *));
86 extern void step_active_slots(void);
87 #endif
89 extern void http_init(struct remote *remote, const char *url,
90 int proactive_auth);
91 extern void http_cleanup(void);
93 extern int active_requests;
94 extern int http_is_verbose;
95 extern size_t http_post_buffer;
97 extern char curl_errorstr[CURL_ERROR_SIZE];
99 static inline int missing__target(int code, int result)
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)
110 #define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
112 /* Helpers for modifying and creating URLs */
113 extern void append_remote_object_url(struct strbuf *buf, const char *url,
114 const char *hex,
115 int only_two_digit_prefix);
116 extern char *get_remote_object_url(const char *url, const char *hex,
117 int only_two_digit_prefix);
119 /* Options for http_request_*() */
120 #define HTTP_NO_CACHE 1
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
127 #define HTTP_REAUTH 4
128 #define HTTP_NOAUTH 5
131 * Requests a URL and stores the result in a strbuf.
133 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
135 int http_get_strbuf(const char *url, struct strbuf *result, int options);
138 * Prints an error message using error() containing url and curl_errorstr,
139 * and returns ret.
141 int http_error(const char *url, int ret);
143 extern int http_fetch_ref(const char *base, struct ref *ref);
145 /* Helpers for fetching packs */
146 extern int http_get_info_packs(const char *base_url,
147 struct packed_git **packs_head);
149 struct http_pack_request {
150 char *url;
151 struct packed_git *target;
152 struct packed_git **lst;
153 FILE *packfile;
154 char tmpfile[PATH_MAX];
155 struct curl_slist *range_header;
156 struct active_request_slot *slot;
159 extern struct http_pack_request *new_http_pack_request(
160 struct packed_git *target, const char *base_url);
161 extern int finish_http_pack_request(struct http_pack_request *preq);
162 extern void release_http_pack_request(struct http_pack_request *preq);
164 /* Helpers for fetching object */
165 struct http_object_request {
166 char *url;
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;
175 git_zstream stream;
176 int zret;
177 int rename;
178 struct active_request_slot *slot;
181 extern struct http_object_request *new_http_object_request(
182 const char *base_url, unsigned char *sha1);
183 extern void process_http_object_request(struct http_object_request *freq);
184 extern int finish_http_object_request(struct http_object_request *freq);
185 extern void abort_http_object_request(struct http_object_request *freq);
186 extern void release_http_object_request(struct http_object_request *freq);
188 #endif /* HTTP_H */