init-db, clone: change unnecessary global into passed parameter
[git.git] / http.h
blob3a409bccd4e6197874a97629c36b050ca923b944
1 #ifndef HTTP_H
2 #define HTTP_H
4 struct packed_git;
6 #include "git-zlib.h"
8 #include <curl/curl.h>
9 #include <curl/easy.h>
11 #include "strbuf.h"
12 #include "remote.h"
13 #include "url.h"
15 #define DEFAULT_MAX_REQUESTS 5
17 struct slot_results {
18 CURLcode curl_result;
19 long http_code;
20 long auth_avail;
21 long http_connectcode;
24 struct active_request_slot {
25 CURL *curl;
26 int in_use;
27 CURLcode curl_result;
28 long http_code;
29 int *finished;
30 struct slot_results *results;
31 void *callback_data;
32 void (*callback_func)(void *data);
33 struct active_request_slot *next;
36 struct buffer {
37 struct strbuf buf;
38 size_t posn;
41 /* Curl request read/write callbacks */
42 size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
43 size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
44 size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
45 int seek_buffer(void *clientp, curl_off_t offset, int origin);
47 /* Slot lifecycle functions */
48 struct active_request_slot *get_active_slot(void);
49 int start_active_slot(struct active_request_slot *slot);
50 void run_active_slot(struct active_request_slot *slot);
51 void finish_all_active_slots(void);
54 * This will run one slot to completion in a blocking manner, similar to how
55 * curl_easy_perform would work (but we don't want to use that, because
56 * we do not want to intermingle calls to curl_multi and curl_easy).
59 int run_one_slot(struct active_request_slot *slot,
60 struct slot_results *results);
62 void fill_active_slots(void);
63 void add_fill_function(void *data, int (*fill)(void *));
64 void step_active_slots(void);
66 void http_init(struct remote *remote, const char *url,
67 int proactive_auth);
68 void http_cleanup(void);
69 struct curl_slist *http_copy_default_headers(void);
71 extern long int git_curl_ipresolve;
72 extern int active_requests;
73 extern int http_is_verbose;
74 extern ssize_t http_post_buffer;
75 extern struct credential http_auth;
77 extern char curl_errorstr[CURL_ERROR_SIZE];
79 enum http_follow_config {
80 HTTP_FOLLOW_NONE,
81 HTTP_FOLLOW_ALWAYS,
82 HTTP_FOLLOW_INITIAL
84 extern enum http_follow_config http_follow_config;
86 static inline int missing__target(int code, int result)
88 return /* file:// URL -- do we ever use one??? */
89 (result == CURLE_FILE_COULDNT_READ_FILE) ||
90 /* http:// and https:// URL */
91 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
92 /* ftp:// URL */
93 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
97 #define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
100 * Normalize curl results to handle CURL_FAILONERROR (or lack thereof). Failing
101 * http codes have their "result" converted to CURLE_HTTP_RETURNED_ERROR, and
102 * an appropriate string placed in the errorstr buffer (pass curl_errorstr if
103 * you don't have a custom buffer).
105 void normalize_curl_result(CURLcode *result, long http_code, char *errorstr,
106 size_t errorlen);
108 /* Helpers for modifying and creating URLs */
109 void append_remote_object_url(struct strbuf *buf, const char *url,
110 const char *hex,
111 int only_two_digit_prefix);
112 char *get_remote_object_url(const char *url, const char *hex,
113 int only_two_digit_prefix);
115 /* Options for http_get_*() */
116 struct http_get_options {
117 unsigned no_cache:1,
118 initial_request:1;
120 /* If non-NULL, returns the content-type of the response. */
121 struct strbuf *content_type;
124 * If non-NULL, and content_type above is non-NULL, returns
125 * the charset parameter from the content-type. If none is
126 * present, returns an empty string.
128 struct strbuf *charset;
131 * If non-NULL, returns the URL we ended up at, including any
132 * redirects we followed.
134 struct strbuf *effective_url;
137 * If both base_url and effective_url are non-NULL, the base URL will
138 * be munged to reflect any redirections going from the requested url
139 * to effective_url. See the definition of update_url_from_redirect
140 * for details.
142 struct strbuf *base_url;
145 * If not NULL, contains additional HTTP headers to be sent with the
146 * request. The strings in the list must not be freed until after the
147 * request has completed.
149 struct string_list *extra_headers;
152 /* Return values for http_get_*() */
153 #define HTTP_OK 0
154 #define HTTP_MISSING_TARGET 1
155 #define HTTP_ERROR 2
156 #define HTTP_START_FAILED 3
157 #define HTTP_REAUTH 4
158 #define HTTP_NOAUTH 5
159 #define HTTP_NOMATCHPUBLICKEY 6
162 * Requests a URL and stores the result in a strbuf.
164 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
166 int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
169 * Downloads a URL and stores the result in the given file.
171 * If a previous interrupted download is detected (i.e. a previous temporary
172 * file is still around) the download is resumed.
174 int http_get_file(const char *url, const char *filename,
175 struct http_get_options *options);
177 int http_fetch_ref(const char *base, struct ref *ref);
179 /* Helpers for fetching packs */
180 int http_get_info_packs(const char *base_url,
181 struct packed_git **packs_head);
183 /* Helper for getting Accept-Language header */
184 const char *http_get_accept_language_header(void);
186 struct http_pack_request {
187 char *url;
190 * index-pack command to run. Must be terminated by NULL.
192 * If NULL, defaults to {"index-pack", "--stdin", NULL}.
194 const char **index_pack_args;
195 unsigned preserve_index_pack_stdout : 1;
197 FILE *packfile;
198 struct strbuf tmpfile;
199 struct active_request_slot *slot;
202 struct http_pack_request *new_http_pack_request(
203 const unsigned char *packed_git_hash, const char *base_url);
204 struct http_pack_request *new_direct_http_pack_request(
205 const unsigned char *packed_git_hash, char *url);
206 int finish_http_pack_request(struct http_pack_request *preq);
207 void release_http_pack_request(struct http_pack_request *preq);
210 * Remove p from the given list, and invoke install_packed_git() on it.
212 * This is a convenience function for users that have obtained a list of packs
213 * from http_get_info_packs() and have chosen a specific pack to fetch.
215 void http_install_packfile(struct packed_git *p,
216 struct packed_git **list_to_remove_from);
218 /* Helpers for fetching object */
219 struct http_object_request {
220 char *url;
221 struct strbuf tmpfile;
222 int localfile;
223 CURLcode curl_result;
224 char errorstr[CURL_ERROR_SIZE];
225 long http_code;
226 struct object_id oid;
227 struct object_id real_oid;
228 git_hash_ctx c;
229 git_zstream stream;
230 int zret;
231 int rename;
232 struct active_request_slot *slot;
235 struct http_object_request *new_http_object_request(
236 const char *base_url, const struct object_id *oid);
237 void process_http_object_request(struct http_object_request *freq);
238 int finish_http_object_request(struct http_object_request *freq);
239 void abort_http_object_request(struct http_object_request *freq);
240 void release_http_object_request(struct http_object_request *freq);
243 * Instead of using environment variables to determine if curl tracing happens,
244 * behave as if GIT_TRACE_CURL=1 and GIT_TRACE_CURL_NO_DATA=1 is set. Call this
245 * before calling setup_curl_trace().
247 void http_trace_curl_no_data(void);
249 /* setup routine for curl_easy_setopt CURLOPT_DEBUGFUNCTION */
250 void setup_curl_trace(CURL *handle);
251 #endif /* HTTP_H */