[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"

/*
 * 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;
	FILE *local;
	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(void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
extern size_t fwrite_buffer(const void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
extern size_t fwrite_null(const void *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_all_active_slots(void);
extern void release_active_slot(struct active_request_slot *slot);

#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);
extern void http_cleanup(void);

extern int data_received;
extern int active_requests;

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)

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

#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"
028c2976	11
4f5f998f JH	12	/*
	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.
	17	*/
	18	#undef USE_CURL_MULTI
	19
9cf04301	20	#if LIBCURL_VERSION_NUM >= 0x071000
29508e1e NH	21	#define USE_CURL_MULTI
	22	#define DEFAULT_MAX_REQUESTS 5
	23	#endif
	24
	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
	31
500ebb01	32	#if (LIBCURL_VERSION_NUM < 0x070c04) \|\| (LIBCURL_VERSION_NUM == 0x071000)
29508e1e NH	33	#define NO_CURL_EASY_DUPHANDLE
	34	#endif
	35
c774b2dc AH	36	#if LIBCURL_VERSION_NUM < 0x070a03
	37	#define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
	38	#endif
	39
3944ba0c MS	40	#if LIBCURL_VERSION_NUM < 0x070c03
	41	#define NO_CURL_IOCTL
	42	#endif
	43
c8568e13 NH	44	struct slot_results
	45	{
	46	CURLcode curl_result;
	47	long http_code;
	48	};
	49
29508e1e NH	50	struct active_request_slot
	51	{
	52	CURL *curl;
	53	FILE *local;
	54	int in_use;
	55	CURLcode curl_result;
	56	long http_code;
baa7b67d	57	int *finished;
c8568e13	58	struct slot_results *results;
29508e1e NH	59	void *callback_data;
	60	void (callback_func)(void data);
	61	struct active_request_slot *next;
	62	};
	63
	64	struct buffer
	65	{
028c2976 MH	66	struct strbuf buf;
028c2976 MH	67	size_t posn;
29508e1e NH	68	};
	69
	70	/* Curl request read/write callbacks */
f444e528 JH	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);
3944ba0c MS	74	#ifndef NO_CURL_IOCTL
	75	extern curlioerr ioctl_buffer(CURL handle, int cmd, void clientp);
	76	#endif
29508e1e NH	77
	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_all_active_slots(void);
53f31389	83	extern void release_active_slot(struct active_request_slot *slot);
29508e1e NH	84
	85	#ifdef USE_CURL_MULTI
	86	extern void fill_active_slots(void);
fc57b6aa	87	extern void add_fill_function(void data, int (fill)(void *));
29508e1e NH	88	extern void step_active_slots(void);
	89	#endif
	90
9fc6440d	91	extern void http_init(struct remote *remote);
29508e1e NH	92	extern void http_cleanup(void);
	93
	94	extern int data_received;
	95	extern int active_requests;
	96
29508e1e NH	97	extern char curl_errorstr[CURL_ERROR_SIZE];
29508e1e NH	98
e8dc37e0 MH	99	static inline int missing__target(int code, int result)
	100	{
	101	return /* file:// URL -- do we ever use one??? */
	102	(result == CURLE_FILE_COULDNT_READ_FILE) \|\|
	103	/* http:// and https:// URL */
	104	(code == 404 && result == CURLE_HTTP_RETURNED_ERROR) \|\|
	105	/* ftp:// URL */
	106	(code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
	107	;
	108	}
	109
	110	#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
	111
c13b2633	112	extern int http_fetch_ref(const char base, struct ref ref);
d7e92806	113
29508e1e	114	#endif /* HTTP_H */