[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

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);

/* 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
c8568e13 NH	40	struct slot_results
	41	{
	42	CURLcode curl_result;
	43	long http_code;
	44	};
	45
29508e1e NH	46	struct active_request_slot
	47	{
	48	CURL *curl;
	49	FILE *local;
	50	int in_use;
	51	CURLcode curl_result;
	52	long http_code;
baa7b67d	53	int *finished;
c8568e13	54	struct slot_results *results;
29508e1e NH	55	void *callback_data;
	56	void (callback_func)(void data);
	57	struct active_request_slot *next;
	58	};
	59
	60	struct buffer
	61	{
028c2976 MH	62	struct strbuf buf;
028c2976 MH	63	size_t posn;
29508e1e NH	64	};
	65
	66	/* Curl request read/write callbacks */
f444e528 JH	67	extern size_t fread_buffer(void ptr, size_t eltsize, size_t nmemb, void strbuf);
	68	extern size_t fwrite_buffer(const void ptr, size_t eltsize, size_t nmemb, void strbuf);
	69	extern size_t fwrite_null(const void ptr, size_t eltsize, size_t nmemb, void strbuf);
29508e1e NH	70
	71	/* Slot lifecycle functions */
	72	extern struct active_request_slot *get_active_slot(void);
	73	extern int start_active_slot(struct active_request_slot *slot);
	74	extern void run_active_slot(struct active_request_slot *slot);
	75	extern void finish_all_active_slots(void);
53f31389	76	extern void release_active_slot(struct active_request_slot *slot);
29508e1e NH	77
	78	#ifdef USE_CURL_MULTI
	79	extern void fill_active_slots(void);
fc57b6aa	80	extern void add_fill_function(void data, int (fill)(void *));
29508e1e NH	81	extern void step_active_slots(void);
	82	#endif
	83
9fc6440d	84	extern void http_init(struct remote *remote);
29508e1e NH	85	extern void http_cleanup(void);
	86
	87	extern int data_received;
	88	extern int active_requests;
	89
29508e1e NH	90	extern char curl_errorstr[CURL_ERROR_SIZE];
29508e1e NH	91
e8dc37e0 MH	92	static inline int missing__target(int code, int result)
	93	{
	94	return /* file:// URL -- do we ever use one??? */
	95	(result == CURLE_FILE_COULDNT_READ_FILE) \|\|
	96	/* http:// and https:// URL */
	97	(code == 404 && result == CURLE_HTTP_RETURNED_ERROR) \|\|
	98	/* ftp:// URL */
	99	(code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
	100	;
	101	}
	102
	103	#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
	104
c13b2633	105	extern int http_fetch_ref(const char base, struct ref ref);
d7e92806	106
29508e1e	107	#endif /* HTTP_H */