enums: remove trailing ',' after last item in enum
[git/debian.git] / http.h
blob12ca5c892d61a063c856bcdef9154a103c0aa4bc
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
46 * CURLOPT_USE_SSL was known as CURLOPT_FTP_SSL up to 7.16.4,
47 * and the constants were known as CURLFTPSSL_*
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
54 struct slot_results {
55 CURLcode curl_result;
56 long http_code;
59 struct active_request_slot {
60 CURL *curl;
61 int in_use;
62 CURLcode curl_result;
63 long http_code;
64 int *finished;
65 struct slot_results *results;
66 void *callback_data;
67 void (*callback_func)(void *data);
68 struct active_request_slot *next;
71 struct buffer {
72 struct strbuf buf;
73 size_t posn;
76 /* Curl request read/write callbacks */
77 extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
78 extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
79 extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
80 #ifndef NO_CURL_IOCTL
81 extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
82 #endif
84 /* Slot lifecycle functions */
85 extern struct active_request_slot *get_active_slot(void);
86 extern int start_active_slot(struct active_request_slot *slot);
87 extern void run_active_slot(struct active_request_slot *slot);
88 extern void finish_active_slot(struct active_request_slot *slot);
89 extern void finish_all_active_slots(void);
90 extern int handle_curl_result(struct slot_results *results);
92 #ifdef USE_CURL_MULTI
93 extern void fill_active_slots(void);
94 extern void add_fill_function(void *data, int (*fill)(void *));
95 extern void step_active_slots(void);
96 #endif
98 extern void http_init(struct remote *remote, const char *url,
99 int proactive_auth);
100 extern void http_cleanup(void);
102 extern int active_requests;
103 extern int http_is_verbose;
104 extern size_t http_post_buffer;
105 extern struct credential http_auth;
107 extern char curl_errorstr[CURL_ERROR_SIZE];
109 static inline int missing__target(int code, int result)
111 return /* file:// URL -- do we ever use one??? */
112 (result == CURLE_FILE_COULDNT_READ_FILE) ||
113 /* http:// and https:// URL */
114 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
115 /* ftp:// URL */
116 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
120 #define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
122 /* Helpers for modifying and creating URLs */
123 extern void append_remote_object_url(struct strbuf *buf, const char *url,
124 const char *hex,
125 int only_two_digit_prefix);
126 extern char *get_remote_object_url(const char *url, const char *hex,
127 int only_two_digit_prefix);
129 /* Options for http_get_*() */
130 struct http_get_options {
131 unsigned no_cache:1,
132 keep_error:1;
134 /* If non-NULL, returns the content-type of the response. */
135 struct strbuf *content_type;
138 * If non-NULL, returns the URL we ended up at, including any
139 * redirects we followed.
141 struct strbuf *effective_url;
144 * If both base_url and effective_url are non-NULL, the base URL will
145 * be munged to reflect any redirections going from the requested url
146 * to effective_url. See the definition of update_url_from_redirect
147 * for details.
149 struct strbuf *base_url;
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
161 * Requests a URL and stores the result in a strbuf.
163 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
165 int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
167 extern int http_fetch_ref(const char *base, struct ref *ref);
169 /* Helpers for fetching packs */
170 extern int http_get_info_packs(const char *base_url,
171 struct packed_git **packs_head);
173 struct http_pack_request {
174 char *url;
175 struct packed_git *target;
176 struct packed_git **lst;
177 FILE *packfile;
178 char tmpfile[PATH_MAX];
179 struct curl_slist *range_header;
180 struct active_request_slot *slot;
183 extern struct http_pack_request *new_http_pack_request(
184 struct packed_git *target, const char *base_url);
185 extern int finish_http_pack_request(struct http_pack_request *preq);
186 extern void release_http_pack_request(struct http_pack_request *preq);
188 /* Helpers for fetching object */
189 struct http_object_request {
190 char *url;
191 char tmpfile[PATH_MAX];
192 int localfile;
193 CURLcode curl_result;
194 char errorstr[CURL_ERROR_SIZE];
195 long http_code;
196 unsigned char sha1[20];
197 unsigned char real_sha1[20];
198 git_SHA_CTX c;
199 git_zstream stream;
200 int zret;
201 int rename;
202 struct active_request_slot *slot;
205 extern struct http_object_request *new_http_object_request(
206 const char *base_url, unsigned char *sha1);
207 extern void process_http_object_request(struct http_object_request *freq);
208 extern int finish_http_object_request(struct http_object_request *freq);
209 extern void abort_http_object_request(struct http_object_request *freq);
210 extern void release_http_object_request(struct http_object_request *freq);
212 #endif /* HTTP_H */