blob: 4ef4bbda7d86d8ca5238d45897b277709b30414a [file] [log] [blame]
Nick Hengeveld29508e12005-11-18 11:02:58 -08001#ifndef HTTP_H
2#define HTTP_H
3
4#include "cache.h"
5
6#include <curl/curl.h>
7#include <curl/easy.h>
8
Mike Hommey028c2972007-12-09 20:30:59 +01009#include "strbuf.h"
Mike Hommey9fc64402008-02-27 21:35:50 +010010#include "remote.h"
Tay Ray Chuan1966d9f2010-11-25 16:21:04 +080011#include "url.h"
Mike Hommey028c2972007-12-09 20:30:59 +010012
Junio C Hamano4f5f9982008-01-21 17:34:43 -080013/*
14 * We detect based on the cURL version if multi-transfer is
15 * usable in this implementation and define this symbol accordingly.
Justin Lebar01689902014-03-31 15:11:46 -070016 * This shouldn't be set by the Makefile or by the user (e.g. via CFLAGS).
Junio C Hamano4f5f9982008-01-21 17:34:43 -080017 */
18#undef USE_CURL_MULTI
19
Alexandre Julliard9cf04302007-05-02 14:53:23 +020020#if LIBCURL_VERSION_NUM >= 0x071000
Nick Hengeveld29508e12005-11-18 11:02:58 -080021#define USE_CURL_MULTI
22#define DEFAULT_MAX_REQUESTS 5
23#endif
24
25#if LIBCURL_VERSION_NUM < 0x070704
Jonathan Nieder98746062010-08-12 17:11:15 -050026#define curl_global_cleanup() do { /* nothing */ } while (0)
Nick Hengeveld29508e12005-11-18 11:02:58 -080027#endif
28#if LIBCURL_VERSION_NUM < 0x070800
Jonathan Nieder98746062010-08-12 17:11:15 -050029#define curl_global_init(a) do { /* nothing */ } while (0)
Nick Hengeveld29508e12005-11-18 11:02:58 -080030#endif
31
Junio C Hamano500ebb02006-12-27 13:59:26 -080032#if (LIBCURL_VERSION_NUM < 0x070c04) || (LIBCURL_VERSION_NUM == 0x071000)
Nick Hengeveld29508e12005-11-18 11:02:58 -080033#define NO_CURL_EASY_DUPHANDLE
34#endif
35
Art Haasc774b2d2006-09-19 07:20:19 -050036#if LIBCURL_VERSION_NUM < 0x070a03
37#define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
38#endif
39
Martin Storsjö3944ba02009-04-01 19:48:24 +030040#if LIBCURL_VERSION_NUM < 0x070c03
41#define NO_CURL_IOCTL
42#endif
43
Modestas Vainius4bc444e2013-04-07 22:10:39 +030044/*
45 * CURLOPT_USE_SSL was known as CURLOPT_FTP_SSL up to 7.16.4,
46 * and the constants were known as CURLFTPSSL_*
47*/
48#if !defined(CURLOPT_USE_SSL) && defined(CURLOPT_FTP_SSL)
49#define CURLOPT_USE_SSL CURLOPT_FTP_SSL
50#define CURLUSESSL_TRY CURLFTPSSL_TRY
51#endif
52
Jonathan Nieder9cba13c2011-03-16 02:08:34 -050053struct slot_results {
Nick Hengeveldc8568e12006-01-31 11:06:55 -080054 CURLcode curl_result;
55 long http_code;
Jeff King0972ccd2013-10-31 02:35:31 -040056 long auth_avail;
Knut Franke372370f2016-01-26 13:02:48 +000057 long http_connectcode;
Nick Hengeveldc8568e12006-01-31 11:06:55 -080058};
59
Jonathan Nieder9cba13c2011-03-16 02:08:34 -050060struct active_request_slot {
Nick Hengeveld29508e12005-11-18 11:02:58 -080061 CURL *curl;
Nick Hengeveld29508e12005-11-18 11:02:58 -080062 int in_use;
63 CURLcode curl_result;
64 long http_code;
Nick Hengeveldbaa7b672006-03-10 20:18:01 -080065 int *finished;
Nick Hengeveldc8568e12006-01-31 11:06:55 -080066 struct slot_results *results;
Nick Hengeveld29508e12005-11-18 11:02:58 -080067 void *callback_data;
68 void (*callback_func)(void *data);
69 struct active_request_slot *next;
70};
71
Jonathan Nieder9cba13c2011-03-16 02:08:34 -050072struct buffer {
Mike Hommey028c2972007-12-09 20:30:59 +010073 struct strbuf buf;
74 size_t posn;
Nick Hengeveld29508e12005-11-18 11:02:58 -080075};
76
77/* Curl request read/write callbacks */
Dan McGeea04ff3e2011-05-03 23:47:27 +080078extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
79extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
80extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
Martin Storsjö3944ba02009-04-01 19:48:24 +030081#ifndef NO_CURL_IOCTL
82extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
83#endif
Nick Hengeveld29508e12005-11-18 11:02:58 -080084
85/* Slot lifecycle functions */
86extern struct active_request_slot *get_active_slot(void);
87extern int start_active_slot(struct active_request_slot *slot);
88extern void run_active_slot(struct active_request_slot *slot);
89extern void finish_all_active_slots(void);
Nick Hengeveld29508e12005-11-18 11:02:58 -080090
Jeff Kingbeed3362014-02-18 05:34:20 -050091/*
92 * This will run one slot to completion in a blocking manner, similar to how
93 * curl_easy_perform would work (but we don't want to use that, because
94 * we do not want to intermingle calls to curl_multi and curl_easy).
95 *
96 */
97int run_one_slot(struct active_request_slot *slot,
98 struct slot_results *results);
99
Nick Hengeveld29508e12005-11-18 11:02:58 -0800100#ifdef USE_CURL_MULTI
101extern void fill_active_slots(void);
Daniel Barkalowfc57b6a2007-09-10 23:02:34 -0400102extern void add_fill_function(void *data, int (*fill)(void *));
Nick Hengeveld29508e12005-11-18 11:02:58 -0800103extern void step_active_slots(void);
104#endif
105
Jeff Kinga4ddbc32011-12-13 19:11:56 -0500106extern void http_init(struct remote *remote, const char *url,
107 int proactive_auth);
Nick Hengeveld29508e12005-11-18 11:02:58 -0800108extern void http_cleanup(void);
109
Eric Wongc915f112016-02-03 04:09:14 +0000110extern long int git_curl_ipresolve;
Nick Hengeveld29508e12005-11-18 11:02:58 -0800111extern int active_requests;
Tay Ray Chuane9176742009-06-06 16:43:41 +0800112extern int http_is_verbose;
Shawn O. Pearcede1a2fd2009-10-30 17:47:41 -0700113extern size_t http_post_buffer;
Jeff King2501aff2013-09-28 04:31:45 -0400114extern struct credential http_auth;
Nick Hengeveld29508e12005-11-18 11:02:58 -0800115
Nick Hengeveld29508e12005-11-18 11:02:58 -0800116extern char curl_errorstr[CURL_ERROR_SIZE];
117
Mike Hommeye8dc37e2007-12-10 22:36:09 +0100118static inline int missing__target(int code, int result)
119{
120 return /* file:// URL -- do we ever use one??? */
121 (result == CURLE_FILE_COULDNT_READ_FILE) ||
122 /* http:// and https:// URL */
123 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
124 /* ftp:// URL */
125 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
126 ;
127}
128
129#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
130
Tay Ray Chuan5424bc52009-06-06 16:44:02 +0800131/* Helpers for modifying and creating URLs */
132extern void append_remote_object_url(struct strbuf *buf, const char *url,
133 const char *hex,
134 int only_two_digit_prefix);
135extern char *get_remote_object_url(const char *url, const char *hex,
136 int only_two_digit_prefix);
137
Jeff King1bbcc222013-09-28 04:31:23 -0400138/* Options for http_get_*() */
139struct http_get_options {
140 unsigned no_cache:1,
141 keep_error:1;
Mike Hommeye929cd22009-06-06 16:43:53 +0800142
Jeff King1bbcc222013-09-28 04:31:23 -0400143 /* If non-NULL, returns the content-type of the response. */
144 struct strbuf *content_type;
Jeff King78868962013-09-28 04:32:02 -0400145
146 /*
Jeff Kinge3131622014-05-22 05:30:05 -0400147 * If non-NULL, and content_type above is non-NULL, returns
148 * the charset parameter from the content-type. If none is
149 * present, returns an empty string.
150 */
151 struct strbuf *charset;
152
153 /*
Jeff King78868962013-09-28 04:32:02 -0400154 * If non-NULL, returns the URL we ended up at, including any
155 * redirects we followed.
156 */
157 struct strbuf *effective_url;
Jeff Kingc93c92f2013-09-28 04:34:05 -0400158
159 /*
160 * If both base_url and effective_url are non-NULL, the base URL will
161 * be munged to reflect any redirections going from the requested url
162 * to effective_url. See the definition of update_url_from_redirect
163 * for details.
164 */
165 struct strbuf *base_url;
Jeff King1bbcc222013-09-28 04:31:23 -0400166};
167
168/* Return values for http_get_*() */
Mike Hommeye929cd22009-06-06 16:43:53 +0800169#define HTTP_OK 0
170#define HTTP_MISSING_TARGET 1
171#define HTTP_ERROR 2
172#define HTTP_START_FAILED 3
Scott Chacon42653c02010-04-01 15:14:35 -0700173#define HTTP_REAUTH 4
174#define HTTP_NOAUTH 5
Mike Hommeye929cd22009-06-06 16:43:53 +0800175
176/*
Jim Meyeringa7793a72012-03-28 10:41:54 +0200177 * Requests a URL and stores the result in a strbuf.
Mike Hommeye929cd22009-06-06 16:43:53 +0800178 *
179 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
180 */
Jeff King1bbcc222013-09-28 04:31:23 -0400181int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
Mike Hommeye929cd22009-06-06 16:43:53 +0800182
Daniel Barkalowc13b2632008-04-26 15:53:09 -0400183extern int http_fetch_ref(const char *base, struct ref *ref);
Mike Hommeyd7e92802007-12-11 00:08:25 +0100184
Tay Ray Chuanb8caac22009-06-06 16:43:59 +0800185/* Helpers for fetching packs */
186extern int http_get_info_packs(const char *base_url,
187 struct packed_git **packs_head);
188
Jonathan Nieder9cba13c2011-03-16 02:08:34 -0500189struct http_pack_request {
Tay Ray Chuan2264dfa2009-06-06 16:44:01 +0800190 char *url;
191 struct packed_git *target;
192 struct packed_git **lst;
193 FILE *packfile;
Tay Ray Chuan2264dfa2009-06-06 16:44:01 +0800194 char tmpfile[PATH_MAX];
Tay Ray Chuan2264dfa2009-06-06 16:44:01 +0800195 struct active_request_slot *slot;
196};
197
198extern struct http_pack_request *new_http_pack_request(
199 struct packed_git *target, const char *base_url);
200extern int finish_http_pack_request(struct http_pack_request *preq);
201extern void release_http_pack_request(struct http_pack_request *preq);
202
Tay Ray Chuan5424bc52009-06-06 16:44:02 +0800203/* Helpers for fetching object */
Jonathan Nieder9cba13c2011-03-16 02:08:34 -0500204struct http_object_request {
Tay Ray Chuan5424bc52009-06-06 16:44:02 +0800205 char *url;
Tay Ray Chuan5424bc52009-06-06 16:44:02 +0800206 char tmpfile[PATH_MAX];
207 int localfile;
208 CURLcode curl_result;
209 char errorstr[CURL_ERROR_SIZE];
210 long http_code;
211 unsigned char sha1[20];
212 unsigned char real_sha1[20];
213 git_SHA_CTX c;
Junio C Hamanoef49a7a2011-06-10 11:52:15 -0700214 git_zstream stream;
Tay Ray Chuan5424bc52009-06-06 16:44:02 +0800215 int zret;
216 int rename;
217 struct active_request_slot *slot;
218};
219
220extern struct http_object_request *new_http_object_request(
221 const char *base_url, unsigned char *sha1);
222extern void process_http_object_request(struct http_object_request *freq);
223extern int finish_http_object_request(struct http_object_request *freq);
224extern void abort_http_object_request(struct http_object_request *freq);
225extern void release_http_object_request(struct http_object_request *freq);
226
Nick Hengeveld29508e12005-11-18 11:02:58 -0800227#endif /* HTTP_H */