[thirdparty/git.git] / http.h

#ifndef HTTP_H
#define HTTP_H

#include "cache.h"

#include <curl/curl.h>
#include <curl/easy.h>

#include "strbuf.h"
#include "remote.h"
#include "url.h"

/*
 * We detect based on the cURL version if multi-transfer is
 * usable in this implementation and define this symbol accordingly.
 * This is not something Makefile should set nor users should pass
 * via CFLAGS.
 */
#undef USE_CURL_MULTI

#if LIBCURL_VERSION_NUM >= 0x071000
#define USE_CURL_MULTI
#define DEFAULT_MAX_REQUESTS 5
#endif

#if LIBCURL_VERSION_NUM < 0x070704
#define curl_global_cleanup() do { /* nothing */ } while (0)
#endif
#if LIBCURL_VERSION_NUM < 0x070800
#define curl_global_init(a) do { /* nothing */ } while (0)
#endif

#if (LIBCURL_VERSION_NUM < 0x070c04) || (LIBCURL_VERSION_NUM == 0x071000)
#define NO_CURL_EASY_DUPHANDLE
#endif

#if LIBCURL_VERSION_NUM < 0x070a03
#define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
#endif

#if LIBCURL_VERSION_NUM < 0x070c03
#define NO_CURL_IOCTL
#endif

struct slot_results {
	CURLcode curl_result;
	long http_code;
};

struct active_request_slot {
	CURL *curl;
	int in_use;
	CURLcode curl_result;
	long http_code;
	int *finished;
	struct slot_results *results;
	void *callback_data;
	void (*callback_func)(void *data);
	struct active_request_slot *next;
};

struct buffer {
	struct strbuf buf;
	size_t posn;
};

/* Curl request read/write callbacks */
extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
#ifndef NO_CURL_IOCTL
extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
#endif

/* Slot lifecycle functions */
extern struct active_request_slot *get_active_slot(void);
extern int start_active_slot(struct active_request_slot *slot);
extern void run_active_slot(struct active_request_slot *slot);
extern void finish_active_slot(struct active_request_slot *slot);
extern void finish_all_active_slots(void);

#ifdef USE_CURL_MULTI
extern void fill_active_slots(void);
extern void add_fill_function(void *data, int (*fill)(void *));
extern void step_active_slots(void);
#endif

extern void http_init(struct remote *remote, const char *url,
		      int proactive_auth);
extern void http_cleanup(void);

extern int active_requests;
extern int http_is_verbose;
extern size_t http_post_buffer;

extern char curl_errorstr[CURL_ERROR_SIZE];

static inline int missing__target(int code, int result)
{
	return	/* file:// URL -- do we ever use one??? */
		(result == CURLE_FILE_COULDNT_READ_FILE) ||
		/* http:// and https:// URL */
		(code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
		/* ftp:// URL */
		(code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
		;
}

#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)

/* Helpers for modifying and creating URLs */
extern void append_remote_object_url(struct strbuf *buf, const char *url,
				     const char *hex,
				     int only_two_digit_prefix);
extern char *get_remote_object_url(const char *url, const char *hex,
				   int only_two_digit_prefix);

/* Options for http_request_*() */
#define HTTP_NO_CACHE		1

/* Return values for http_request_*() */
#define HTTP_OK			0
#define HTTP_MISSING_TARGET	1
#define HTTP_ERROR		2
#define HTTP_START_FAILED	3
#define HTTP_REAUTH	4
#define HTTP_NOAUTH	5

/*
 * Requests a URL and stores the result in a strbuf.
 *
 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
 */
int http_get_strbuf(const char *url, struct strbuf *result, int options);

/*
 * Prints an error message using error() containing url and curl_errorstr,
 * and returns ret.
 */
int http_error(const char *url, int ret);

extern int http_fetch_ref(const char *base, struct ref *ref);

/* Helpers for fetching packs */
extern int http_get_info_packs(const char *base_url,
	struct packed_git **packs_head);

struct http_pack_request {
	char *url;
	struct packed_git *target;
	struct packed_git **lst;
	FILE *packfile;
	char tmpfile[PATH_MAX];
	struct curl_slist *range_header;
	struct active_request_slot *slot;
};

extern struct http_pack_request *new_http_pack_request(
	struct packed_git *target, const char *base_url);
extern int finish_http_pack_request(struct http_pack_request *preq);
extern void release_http_pack_request(struct http_pack_request *preq);

/* Helpers for fetching object */
struct http_object_request {
	char *url;
	char tmpfile[PATH_MAX];
	int localfile;
	CURLcode curl_result;
	char errorstr[CURL_ERROR_SIZE];
	long http_code;
	unsigned char sha1[20];
	unsigned char real_sha1[20];
	git_SHA_CTX c;
	git_zstream stream;
	int zret;
	int rename;
	struct active_request_slot *slot;
};

extern struct http_object_request *new_http_object_request(
	const char *base_url, unsigned char *sha1);
extern void process_http_object_request(struct http_object_request *freq);
extern int finish_http_object_request(struct http_object_request *freq);
extern void abort_http_object_request(struct http_object_request *freq);
extern void release_http_object_request(struct http_object_request *freq);

#endif /* HTTP_H */
Commit	Line	Data
29508e1e NH	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
028c2976	9	#include "strbuf.h"
9fc6440d	10	#include "remote.h"
1966d9f3	11	#include "url.h"
028c2976	12
4f5f998f JH	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
9cf04301	21	#if LIBCURL_VERSION_NUM >= 0x071000
29508e1e NH	22	#define USE_CURL_MULTI
	23	#define DEFAULT_MAX_REQUESTS 5
	24	#endif
	25
	26	#if LIBCURL_VERSION_NUM < 0x070704
98746061	27	#define curl_global_cleanup() do { /* nothing */ } while (0)
29508e1e NH	28	#endif
29508e1e NH	29	#if LIBCURL_VERSION_NUM < 0x070800
98746061	30	#define curl_global_init(a) do { /* nothing */ } while (0)
29508e1e NH	31	#endif
29508e1e NH	32
500ebb01	33	#if (LIBCURL_VERSION_NUM < 0x070c04) \|\| (LIBCURL_VERSION_NUM == 0x071000)
29508e1e NH	34	#define NO_CURL_EASY_DUPHANDLE
	35	#endif
	36
c774b2dc AH	37	#if LIBCURL_VERSION_NUM < 0x070a03
	38	#define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
	39	#endif
	40
3944ba0c MS	41	#if LIBCURL_VERSION_NUM < 0x070c03
	42	#define NO_CURL_IOCTL
	43	#endif
	44
9cba13ca	45	struct slot_results {
c8568e13 NH	46	CURLcode curl_result;
	47	long http_code;
	48	};
	49
9cba13ca	50	struct active_request_slot {
29508e1e	51	CURL *curl;
29508e1e NH	52	int in_use;
	53	CURLcode curl_result;
	54	long http_code;
baa7b67d	55	int *finished;
c8568e13	56	struct slot_results *results;
29508e1e NH	57	void *callback_data;
	58	void (callback_func)(void data);
	59	struct active_request_slot *next;
	60	};
	61
9cba13ca	62	struct buffer {
028c2976 MH	63	struct strbuf buf;
028c2976 MH	64	size_t posn;
29508e1e NH	65	};
	66
	67	/* Curl request read/write callbacks */
a04ff3ec DM	68	extern size_t fread_buffer(char ptr, size_t eltsize, size_t nmemb, void strbuf);
	69	extern size_t fwrite_buffer(char ptr, size_t eltsize, size_t nmemb, void strbuf);
	70	extern size_t fwrite_null(char ptr, size_t eltsize, size_t nmemb, void strbuf);
3944ba0c MS	71	#ifndef NO_CURL_IOCTL
	72	extern curlioerr ioctl_buffer(CURL handle, int cmd, void clientp);
	73	#endif
29508e1e NH	74
	75	/* Slot lifecycle functions */
	76	extern struct active_request_slot *get_active_slot(void);
	77	extern int start_active_slot(struct active_request_slot *slot);
	78	extern void run_active_slot(struct active_request_slot *slot);
de1a2fdd	79	extern void finish_active_slot(struct active_request_slot *slot);
29508e1e NH	80	extern void finish_all_active_slots(void);
	81
	82	#ifdef USE_CURL_MULTI
	83	extern void fill_active_slots(void);
fc57b6aa	84	extern void add_fill_function(void data, int (fill)(void *));
29508e1e NH	85	extern void step_active_slots(void);
	86	#endif
	87
a4ddbc33 JK	88	extern void http_init(struct remote remote, const char url,
a4ddbc33 JK	89	int proactive_auth);
29508e1e NH	90	extern void http_cleanup(void);
29508e1e NH	91
29508e1e	92	extern int active_requests;
e9176745	93	extern int http_is_verbose;
de1a2fdd	94	extern size_t http_post_buffer;
29508e1e	95
29508e1e NH	96	extern char curl_errorstr[CURL_ERROR_SIZE];
29508e1e NH	97
e8dc37e0 MH	98	static 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
5424bc55 TRC	111	/* Helpers for modifying and creating URLs */
	112	extern void append_remote_object_url(struct strbuf buf, const char url,
	113	const char *hex,
	114	int only_two_digit_prefix);
	115	extern char get_remote_object_url(const char url, const char *hex,
	116	int only_two_digit_prefix);
	117
e929cd20 MH	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
42653c09 SC	126	#define HTTP_REAUTH 4
42653c09 SC	127	#define HTTP_NOAUTH 5
e929cd20 MH	128
e929cd20 MH	129	/*
a7793a74	130	* Requests a URL and stores the result in a strbuf.
e929cd20 MH	131	*
	132	* If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
	133	*/
	134	int http_get_strbuf(const char url, struct strbuf result, int options);
	135
e929cd20 MH	136	/*
	137	* Prints an error message using error() containing url and curl_errorstr,
	138	* and returns ret.
	139	*/
	140	int http_error(const char *url, int ret);
	141
c13b2633	142	extern int http_fetch_ref(const char base, struct ref ref);
d7e92806	143
b8caac2b TRC	144	/* Helpers for fetching packs */
	145	extern int http_get_info_packs(const char *base_url,
	146	struct packed_git **packs_head);
	147
9cba13ca	148	struct http_pack_request {
2264dfa5 TRC	149	char *url;
	150	struct packed_git *target;
	151	struct packed_git **lst;
	152	FILE *packfile;
2264dfa5 TRC	153	char tmpfile[PATH_MAX];
	154	struct curl_slist *range_header;
	155	struct active_request_slot *slot;
	156	};
	157
	158	extern struct http_pack_request *new_http_pack_request(
	159	struct packed_git target, const char base_url);
	160	extern int finish_http_pack_request(struct http_pack_request *preq);
	161	extern void release_http_pack_request(struct http_pack_request *preq);
	162
5424bc55	163	/* Helpers for fetching object */
9cba13ca	164	struct http_object_request {
5424bc55	165	char *url;
5424bc55 TRC	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;
ef49a7a0	174	git_zstream stream;
5424bc55 TRC	175	int zret;
	176	int rename;
	177	struct active_request_slot *slot;
	178	};
	179
	180	extern struct http_object_request *new_http_object_request(
	181	const char base_url, unsigned char sha1);
	182	extern void process_http_object_request(struct http_object_request *freq);
	183	extern int finish_http_object_request(struct http_object_request *freq);
	184	extern void abort_http_object_request(struct http_object_request *freq);
	185	extern void release_http_object_request(struct http_object_request *freq);
	186
29508e1e	187	#endif /* HTTP_H */