1#ifndef HTTP_H
2#define HTTP_H
3
4#include "cache.h"
5
6#include <curl/curl.h>
7#include <curl/easy.h>
8
9#include "strbuf.h"
10#include "remote.h"
11#include "url.h"
12
13/*
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.
18 */
19#undef USE_CURL_MULTI
20
21#if LIBCURL_VERSION_NUM >= 0x071000
22#define USE_CURL_MULTI
23#define DEFAULT_MAX_REQUESTS 5
24#endif
25
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
32
33#if (LIBCURL_VERSION_NUM < 0x070c04) || (LIBCURL_VERSION_NUM == 0x071000)
34#define NO_CURL_EASY_DUPHANDLE
35#endif
36
37#if LIBCURL_VERSION_NUM < 0x070a03
38#define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
39#endif
40
41#if LIBCURL_VERSION_NUM < 0x070c03
42#define NO_CURL_IOCTL
43#endif
44
45struct slot_results {
46 CURLcode curl_result;
47 long http_code;
48};
49
50struct active_request_slot {
51 CURL *curl;
52 int in_use;
53 CURLcode curl_result;
54 long http_code;
55 int *finished;
56 struct slot_results *results;
57 void *callback_data;
58 void (*callback_func)(void *data);
59 struct active_request_slot *next;
60};
61
62struct buffer {
63 struct strbuf buf;
64 size_t posn;
65};
66
67/* Curl request read/write callbacks */
68extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
69extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
70extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
71#ifndef NO_CURL_IOCTL
72extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
73#endif
74
75/* Slot lifecycle functions */
76extern struct active_request_slot *get_active_slot(void);
77extern int start_active_slot(struct active_request_slot *slot);
78extern void run_active_slot(struct active_request_slot *slot);
79extern void finish_active_slot(struct active_request_slot *slot);
80extern void finish_all_active_slots(void);
81
82#ifdef USE_CURL_MULTI
83extern void fill_active_slots(void);
84extern void add_fill_function(void *data, int (*fill)(void *));
85extern void step_active_slots(void);
86#endif
87
88extern void http_init(struct remote *remote, const char *url,
89 int proactive_auth);
90extern void http_cleanup(void);
91
92extern int active_requests;
93extern int http_is_verbose;
94extern size_t http_post_buffer;
95
96extern char curl_errorstr[CURL_ERROR_SIZE];
97
98static inline int missing__target(int code, int result)
99{
100 return /* file:// URL -- do we ever use one??? */
101 (result == CURLE_FILE_COULDNT_READ_FILE) ||
102 /* http:// and https:// URL */
103 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
104 /* ftp:// URL */
105 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
106 ;
107}
108
109#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
110
111/* Helpers for modifying and creating URLs */
112extern void append_remote_object_url(struct strbuf *buf, const char *url,
113 const char *hex,
114 int only_two_digit_prefix);
115extern char *get_remote_object_url(const char *url, const char *hex,
116 int only_two_digit_prefix);
117
118/* Options for http_request_*() */
119#define HTTP_NO_CACHE 1
120
121/* Return values for http_request_*() */
122#define HTTP_OK 0
123#define HTTP_MISSING_TARGET 1
124#define HTTP_ERROR 2
125#define HTTP_START_FAILED 3
126#define HTTP_REAUTH 4
127#define HTTP_NOAUTH 5
128
129/*
130 * Requests an url and stores the result in a strbuf.
131 *
132 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
133 */
134int http_get_strbuf(const char *url, struct strbuf *result, int options);
135
136/*
137 * Prints an error message using error() containing url and curl_errorstr,
138 * and returns ret.
139 */
140int http_error(const char *url, int ret);
141
142extern int http_fetch_ref(const char *base, struct ref *ref);
143
144/* Helpers for fetching packs */
145extern int http_get_info_packs(const char *base_url,
146 struct packed_git **packs_head);
147
148struct http_pack_request {
149 char *url;
150 struct packed_git *target;
151 struct packed_git **lst;
152 FILE *packfile;
153 char tmpfile[PATH_MAX];
154 struct curl_slist *range_header;
155 struct active_request_slot *slot;
156};
157
158extern struct http_pack_request *new_http_pack_request(
159 struct packed_git *target, const char *base_url);
160extern int finish_http_pack_request(struct http_pack_request *preq);
161extern void release_http_pack_request(struct http_pack_request *preq);
162
163/* Helpers for fetching object */
164struct http_object_request {
165 char *url;
166 char tmpfile[PATH_MAX];
167 int localfile;
168 CURLcode curl_result;
169 char errorstr[CURL_ERROR_SIZE];
170 long http_code;
171 unsigned char sha1[20];
172 unsigned char real_sha1[20];
173 git_SHA_CTX c;
174 git_zstream stream;
175 int zret;
176 int rename;
177 struct active_request_slot *slot;
178};
179
180extern struct http_object_request *new_http_object_request(
181 const char *base_url, unsigned char *sha1);
182extern void process_http_object_request(struct http_object_request *freq);
183extern int finish_http_object_request(struct http_object_request *freq);
184extern void abort_http_object_request(struct http_object_request *freq);
185extern void release_http_object_request(struct http_object_request *freq);
186
187#endif /* HTTP_H */