trace.c, git.c: remove unnecessary parameter to trace_repo_setup()
[git/debian.git] / http.h
blob77c042706c6597e347d1b8cc05d3f5972e2de117
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"
13 #define DEFAULT_MAX_REQUESTS 5
15 struct slot_results {
16 CURLcode curl_result;
17 long http_code;
18 long auth_avail;
19 long http_connectcode;
22 struct active_request_slot {
23 CURL *curl;
24 int in_use;
25 CURLcode curl_result;
26 long http_code;
27 int *finished;
28 struct slot_results *results;
29 void *callback_data;
30 void (*callback_func)(void *data);
31 struct active_request_slot *next;
34 struct buffer {
35 struct strbuf buf;
36 size_t posn;
39 /* Curl request read/write callbacks */
40 size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
41 size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
42 size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
43 int seek_buffer(void *clientp, curl_off_t offset, int origin);
45 /* Slot lifecycle functions */
46 struct active_request_slot *get_active_slot(void);
47 int start_active_slot(struct active_request_slot *slot);
48 void run_active_slot(struct active_request_slot *slot);
49 void finish_all_active_slots(void);
52 * This will run one slot to completion in a blocking manner, similar to how
53 * curl_easy_perform would work (but we don't want to use that, because
54 * we do not want to intermingle calls to curl_multi and curl_easy).
57 int run_one_slot(struct active_request_slot *slot,
58 struct slot_results *results);
60 void fill_active_slots(void);
61 void add_fill_function(void *data, int (*fill)(void *));
62 void step_active_slots(void);
64 void http_init(struct remote *remote, const char *url,
65 int proactive_auth);
66 void http_cleanup(void);
67 struct curl_slist *http_copy_default_headers(void);
69 extern long int git_curl_ipresolve;
70 extern int active_requests;
71 extern int http_is_verbose;
72 extern ssize_t http_post_buffer;
73 extern struct credential http_auth;
75 extern char curl_errorstr[CURL_ERROR_SIZE];
77 enum http_follow_config {
78 HTTP_FOLLOW_NONE,
79 HTTP_FOLLOW_ALWAYS,
80 HTTP_FOLLOW_INITIAL
82 extern enum http_follow_config http_follow_config;
84 static inline int missing__target(int code, int result)
86 return /* file:// URL -- do we ever use one??? */
87 (result == CURLE_FILE_COULDNT_READ_FILE) ||
88 /* http:// and https:// URL */
89 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
90 /* ftp:// URL */
91 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
95 #define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
98 * Normalize curl results to handle CURL_FAILONERROR (or lack thereof). Failing
99 * http codes have their "result" converted to CURLE_HTTP_RETURNED_ERROR, and
100 * an appropriate string placed in the errorstr buffer (pass curl_errorstr if
101 * you don't have a custom buffer).
103 void normalize_curl_result(CURLcode *result, long http_code, char *errorstr,
104 size_t errorlen);
106 /* Helpers for modifying and creating URLs */
107 void append_remote_object_url(struct strbuf *buf, const char *url,
108 const char *hex,
109 int only_two_digit_prefix);
110 char *get_remote_object_url(const char *url, const char *hex,
111 int only_two_digit_prefix);
113 /* Options for http_get_*() */
114 struct http_get_options {
115 unsigned no_cache:1,
116 initial_request:1;
118 /* If non-NULL, returns the content-type of the response. */
119 struct strbuf *content_type;
122 * If non-NULL, and content_type above is non-NULL, returns
123 * the charset parameter from the content-type. If none is
124 * present, returns an empty string.
126 struct strbuf *charset;
129 * If non-NULL, returns the URL we ended up at, including any
130 * redirects we followed.
132 struct strbuf *effective_url;
135 * If both base_url and effective_url are non-NULL, the base URL will
136 * be munged to reflect any redirections going from the requested url
137 * to effective_url. See the definition of update_url_from_redirect
138 * for details.
140 struct strbuf *base_url;
143 * If not NULL, contains additional HTTP headers to be sent with the
144 * request. The strings in the list must not be freed until after the
145 * request has completed.
147 struct string_list *extra_headers;
150 /* Return values for http_get_*() */
151 #define HTTP_OK 0
152 #define HTTP_MISSING_TARGET 1
153 #define HTTP_ERROR 2
154 #define HTTP_START_FAILED 3
155 #define HTTP_REAUTH 4
156 #define HTTP_NOAUTH 5
157 #define HTTP_NOMATCHPUBLICKEY 6
160 * Requests a URL and stores the result in a strbuf.
162 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
164 int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
167 * Downloads a URL and stores the result in the given file.
169 * If a previous interrupted download is detected (i.e. a previous temporary
170 * file is still around) the download is resumed.
172 int http_get_file(const char *url, const char *filename,
173 struct http_get_options *options);
175 int http_fetch_ref(const char *base, struct ref *ref);
177 /* Helpers for fetching packs */
178 int http_get_info_packs(const char *base_url,
179 struct packed_git **packs_head);
181 /* Helper for getting Accept-Language header */
182 const char *http_get_accept_language_header(void);
184 struct http_pack_request {
185 char *url;
188 * index-pack command to run. Must be terminated by NULL.
190 * If NULL, defaults to {"index-pack", "--stdin", NULL}.
192 const char **index_pack_args;
193 unsigned preserve_index_pack_stdout : 1;
195 FILE *packfile;
196 struct strbuf tmpfile;
197 struct active_request_slot *slot;
200 struct http_pack_request *new_http_pack_request(
201 const unsigned char *packed_git_hash, const char *base_url);
202 struct http_pack_request *new_direct_http_pack_request(
203 const unsigned char *packed_git_hash, char *url);
204 int finish_http_pack_request(struct http_pack_request *preq);
205 void release_http_pack_request(struct http_pack_request *preq);
208 * Remove p from the given list, and invoke install_packed_git() on it.
210 * This is a convenience function for users that have obtained a list of packs
211 * from http_get_info_packs() and have chosen a specific pack to fetch.
213 void http_install_packfile(struct packed_git *p,
214 struct packed_git **list_to_remove_from);
216 /* Helpers for fetching object */
217 struct http_object_request {
218 char *url;
219 struct strbuf tmpfile;
220 int localfile;
221 CURLcode curl_result;
222 char errorstr[CURL_ERROR_SIZE];
223 long http_code;
224 struct object_id oid;
225 struct object_id real_oid;
226 git_hash_ctx c;
227 git_zstream stream;
228 int zret;
229 int rename;
230 struct active_request_slot *slot;
233 struct http_object_request *new_http_object_request(
234 const char *base_url, const struct object_id *oid);
235 void process_http_object_request(struct http_object_request *freq);
236 int finish_http_object_request(struct http_object_request *freq);
237 void abort_http_object_request(struct http_object_request *freq);
238 void release_http_object_request(struct http_object_request *freq);
241 * Instead of using environment variables to determine if curl tracing happens,
242 * behave as if GIT_TRACE_CURL=1 and GIT_TRACE_CURL_NO_DATA=1 is set. Call this
243 * before calling setup_curl_trace().
245 void http_trace_curl_no_data(void);
247 /* setup routine for curl_easy_setopt CURLOPT_DEBUGFUNCTION */
248 void setup_curl_trace(CURL *handle);
249 #endif /* HTTP_H */