stash: remove now superfluos help for "stash push"
[git.git] / http.h
blobf7bd3b26b0da70e44402579e4912a1b20dcef16e
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 shouldn't be set by the Makefile or by the user (e.g. via CFLAGS).
18 #undef USE_CURL_MULTI
20 #if LIBCURL_VERSION_NUM >= 0x071000
21 #define USE_CURL_MULTI
22 #define DEFAULT_MAX_REQUESTS 5
23 #endif
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
32 #if (LIBCURL_VERSION_NUM < 0x070c04) || (LIBCURL_VERSION_NUM == 0x071000)
33 #define NO_CURL_EASY_DUPHANDLE
34 #endif
36 #if LIBCURL_VERSION_NUM < 0x070a03
37 #define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
38 #endif
40 #if LIBCURL_VERSION_NUM < 0x070c03
41 #define NO_CURL_IOCTL
42 #endif
45 * CURLOPT_USE_SSL was known as CURLOPT_FTP_SSL up to 7.16.4,
46 * and the constants were known as CURLFTPSSL_*
48 #if !defined(CURLOPT_USE_SSL) && defined(CURLOPT_FTP_SSL)
49 #define CURLOPT_USE_SSL CURLOPT_FTP_SSL
50 #define CURLUSESSL_TRY CURLFTPSSL_TRY
51 #endif
53 struct slot_results {
54 CURLcode curl_result;
55 long http_code;
56 long auth_avail;
57 long http_connectcode;
60 struct active_request_slot {
61 CURL *curl;
62 int in_use;
63 CURLcode curl_result;
64 long http_code;
65 int *finished;
66 struct slot_results *results;
67 void *callback_data;
68 void (*callback_func)(void *data);
69 struct active_request_slot *next;
72 struct buffer {
73 struct strbuf buf;
74 size_t posn;
77 /* Curl request read/write callbacks */
78 extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
79 extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
80 extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
81 #ifndef NO_CURL_IOCTL
82 extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
83 #endif
85 /* Slot lifecycle functions */
86 extern struct active_request_slot *get_active_slot(void);
87 extern int start_active_slot(struct active_request_slot *slot);
88 extern void run_active_slot(struct active_request_slot *slot);
89 extern void finish_all_active_slots(void);
92 * This will run one slot to completion in a blocking manner, similar to how
93 * curl_easy_perform would work (but we don't want to use that, because
94 * we do not want to intermingle calls to curl_multi and curl_easy).
97 int run_one_slot(struct active_request_slot *slot,
98 struct slot_results *results);
100 #ifdef USE_CURL_MULTI
101 extern void fill_active_slots(void);
102 extern void add_fill_function(void *data, int (*fill)(void *));
103 extern void step_active_slots(void);
104 #endif
106 extern void http_init(struct remote *remote, const char *url,
107 int proactive_auth);
108 extern void http_cleanup(void);
109 extern struct curl_slist *http_copy_default_headers(void);
111 extern long int git_curl_ipresolve;
112 extern int active_requests;
113 extern int http_is_verbose;
114 extern ssize_t http_post_buffer;
115 extern struct credential http_auth;
117 extern char curl_errorstr[CURL_ERROR_SIZE];
119 enum http_follow_config {
120 HTTP_FOLLOW_NONE,
121 HTTP_FOLLOW_ALWAYS,
122 HTTP_FOLLOW_INITIAL
124 extern enum http_follow_config http_follow_config;
126 static inline int missing__target(int code, int result)
128 return /* file:// URL -- do we ever use one??? */
129 (result == CURLE_FILE_COULDNT_READ_FILE) ||
130 /* http:// and https:// URL */
131 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
132 /* ftp:// URL */
133 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
137 #define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
139 /* Helpers for modifying and creating URLs */
140 extern void append_remote_object_url(struct strbuf *buf, const char *url,
141 const char *hex,
142 int only_two_digit_prefix);
143 extern char *get_remote_object_url(const char *url, const char *hex,
144 int only_two_digit_prefix);
146 /* Options for http_get_*() */
147 struct http_get_options {
148 unsigned no_cache:1,
149 keep_error:1,
150 initial_request:1;
152 /* If non-NULL, returns the content-type of the response. */
153 struct strbuf *content_type;
156 * If non-NULL, and content_type above is non-NULL, returns
157 * the charset parameter from the content-type. If none is
158 * present, returns an empty string.
160 struct strbuf *charset;
163 * If non-NULL, returns the URL we ended up at, including any
164 * redirects we followed.
166 struct strbuf *effective_url;
169 * If both base_url and effective_url are non-NULL, the base URL will
170 * be munged to reflect any redirections going from the requested url
171 * to effective_url. See the definition of update_url_from_redirect
172 * for details.
174 struct strbuf *base_url;
177 /* Return values for http_get_*() */
178 #define HTTP_OK 0
179 #define HTTP_MISSING_TARGET 1
180 #define HTTP_ERROR 2
181 #define HTTP_START_FAILED 3
182 #define HTTP_REAUTH 4
183 #define HTTP_NOAUTH 5
186 * Requests a URL and stores the result in a strbuf.
188 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
190 int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
192 extern int http_fetch_ref(const char *base, struct ref *ref);
194 /* Helpers for fetching packs */
195 extern int http_get_info_packs(const char *base_url,
196 struct packed_git **packs_head);
198 struct http_pack_request {
199 char *url;
200 struct packed_git *target;
201 struct packed_git **lst;
202 FILE *packfile;
203 char tmpfile[PATH_MAX];
204 struct active_request_slot *slot;
207 extern struct http_pack_request *new_http_pack_request(
208 struct packed_git *target, const char *base_url);
209 extern int finish_http_pack_request(struct http_pack_request *preq);
210 extern void release_http_pack_request(struct http_pack_request *preq);
212 /* Helpers for fetching object */
213 struct http_object_request {
214 char *url;
215 char tmpfile[PATH_MAX];
216 int localfile;
217 CURLcode curl_result;
218 char errorstr[CURL_ERROR_SIZE];
219 long http_code;
220 unsigned char sha1[20];
221 unsigned char real_sha1[20];
222 git_SHA_CTX c;
223 git_zstream stream;
224 int zret;
225 int rename;
226 struct active_request_slot *slot;
229 extern struct http_object_request *new_http_object_request(
230 const char *base_url, unsigned char *sha1);
231 extern void process_http_object_request(struct http_object_request *freq);
232 extern int finish_http_object_request(struct http_object_request *freq);
233 extern void abort_http_object_request(struct http_object_request *freq);
234 extern void release_http_object_request(struct http_object_request *freq);
236 /* setup routine for curl_easy_setopt CURLOPT_DEBUGFUNCTION */
237 void setup_curl_trace(CURL *handle);
238 #endif /* HTTP_H */