Merge branch 'cb/maint-orphan-merge-noclobber'
[git/kirr.git] / http.h
blob173f74c8298c3fa3989f88b06e2085127fe96db8
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"
13 * We detect based on the cURL version if multi-transfer is
14 * usable in this implementation and define this symbol accordingly.
15 * This is not something Makefile should set nor users should pass
16 * 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
44 struct slot_results
46 CURLcode curl_result;
47 long http_code;
50 struct active_request_slot
52 CURL *curl;
53 FILE *local;
54 int in_use;
55 CURLcode curl_result;
56 long http_code;
57 int *finished;
58 struct slot_results *results;
59 void *callback_data;
60 void (*callback_func)(void *data);
61 struct active_request_slot *next;
64 struct buffer
66 struct strbuf buf;
67 size_t posn;
70 /* Curl request read/write callbacks */
71 extern size_t fread_buffer(void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
72 extern size_t fwrite_buffer(const void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
73 extern size_t fwrite_null(const void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
74 #ifndef NO_CURL_IOCTL
75 extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
76 #endif
78 /* Slot lifecycle functions */
79 extern struct active_request_slot *get_active_slot(void);
80 extern int start_active_slot(struct active_request_slot *slot);
81 extern void run_active_slot(struct active_request_slot *slot);
82 extern void finish_active_slot(struct active_request_slot *slot);
83 extern void finish_all_active_slots(void);
85 #ifdef USE_CURL_MULTI
86 extern void fill_active_slots(void);
87 extern void add_fill_function(void *data, int (*fill)(void *));
88 extern void step_active_slots(void);
89 #endif
91 extern void http_init(struct remote *remote);
92 extern void http_cleanup(void);
94 extern int data_received;
95 extern int active_requests;
96 extern int http_is_verbose;
97 extern size_t http_post_buffer;
99 extern char curl_errorstr[CURL_ERROR_SIZE];
101 static inline int missing__target(int code, int result)
103 return /* file:// URL -- do we ever use one??? */
104 (result == CURLE_FILE_COULDNT_READ_FILE) ||
105 /* http:// and https:// URL */
106 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
107 /* ftp:// URL */
108 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
112 #define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
114 /* Helpers for modifying and creating URLs */
115 extern void append_remote_object_url(struct strbuf *buf, const char *url,
116 const char *hex,
117 int only_two_digit_prefix);
118 extern char *get_remote_object_url(const char *url, const char *hex,
119 int only_two_digit_prefix);
120 extern void end_url_with_slash(struct strbuf *buf, const char *url);
122 /* Options for http_request_*() */
123 #define HTTP_NO_CACHE 1
125 /* Return values for http_request_*() */
126 #define HTTP_OK 0
127 #define HTTP_MISSING_TARGET 1
128 #define HTTP_ERROR 2
129 #define HTTP_START_FAILED 3
130 #define HTTP_REAUTH 4
131 #define HTTP_NOAUTH 5
134 * Requests an url and stores the result in a strbuf.
136 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
138 int http_get_strbuf(const char *url, struct strbuf *result, int options);
141 * Prints an error message using error() containing url and curl_errorstr,
142 * and returns ret.
144 int http_error(const char *url, int ret);
146 extern int http_fetch_ref(const char *base, struct ref *ref);
148 /* Helpers for fetching packs */
149 extern int http_get_info_packs(const char *base_url,
150 struct packed_git **packs_head);
152 struct http_pack_request
154 char *url;
155 struct packed_git *target;
156 struct packed_git **lst;
157 FILE *packfile;
158 char tmpfile[PATH_MAX];
159 struct curl_slist *range_header;
160 struct active_request_slot *slot;
163 extern struct http_pack_request *new_http_pack_request(
164 struct packed_git *target, const char *base_url);
165 extern int finish_http_pack_request(struct http_pack_request *preq);
166 extern void release_http_pack_request(struct http_pack_request *preq);
168 /* Helpers for fetching object */
169 struct http_object_request
171 char *url;
172 char tmpfile[PATH_MAX];
173 int localfile;
174 CURLcode curl_result;
175 char errorstr[CURL_ERROR_SIZE];
176 long http_code;
177 unsigned char sha1[20];
178 unsigned char real_sha1[20];
179 git_SHA_CTX c;
180 z_stream stream;
181 int zret;
182 int rename;
183 struct active_request_slot *slot;
186 extern struct http_object_request *new_http_object_request(
187 const char *base_url, unsigned char *sha1);
188 extern void process_http_object_request(struct http_object_request *freq);
189 extern int finish_http_object_request(struct http_object_request *freq);
190 extern void abort_http_object_request(struct http_object_request *freq);
191 extern void release_http_object_request(struct http_object_request *freq);
193 #endif /* HTTP_H */