[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 shouldn't be set by the Makefile or by the user (e.g. 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

/*
 * CURLOPT_USE_SSL was known as CURLOPT_FTP_SSL up to 7.16.4,
 * and the constants were known as CURLFTPSSL_*
*/
#if !defined(CURLOPT_USE_SSL) && defined(CURLOPT_FTP_SSL)
#define CURLOPT_USE_SSL CURLOPT_FTP_SSL
#define CURLUSESSL_TRY CURLFTPSSL_TRY
#endif

struct slot_results {
	CURLcode curl_result;
	long http_code;
	long auth_avail;
	long http_connectcode;
};

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_all_active_slots(void);

/*
 * This will run one slot to completion in a blocking manner, similar to how
 * curl_easy_perform would work (but we don't want to use that, because
 * we do not want to intermingle calls to curl_multi and curl_easy).
 *
 */
int run_one_slot(struct active_request_slot *slot,
		 struct slot_results *results);

#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 struct curl_slist *http_copy_default_headers(void);

extern long int git_curl_ipresolve;
extern int active_requests;
extern int http_is_verbose;
extern ssize_t http_post_buffer;
extern struct credential http_auth;

extern char curl_errorstr[CURL_ERROR_SIZE];

enum http_follow_config {
	HTTP_FOLLOW_NONE,
	HTTP_FOLLOW_ALWAYS,
	HTTP_FOLLOW_INITIAL
};
extern enum http_follow_config http_follow_config;

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_get_*() */
struct http_get_options {
	unsigned no_cache:1,
		 keep_error:1,
		 initial_request:1;

	/* If non-NULL, returns the content-type of the response. */
	struct strbuf *content_type;

	/*
	 * If non-NULL, and content_type above is non-NULL, returns
	 * the charset parameter from the content-type. If none is
	 * present, returns an empty string.
	 */
	struct strbuf *charset;

	/*
	 * If non-NULL, returns the URL we ended up at, including any
	 * redirects we followed.
	 */
	struct strbuf *effective_url;

	/*
	 * If both base_url and effective_url are non-NULL, the base URL will
	 * be munged to reflect any redirections going from the requested url
	 * to effective_url. See the definition of update_url_from_redirect
	 * for details.
	 */
	struct strbuf *base_url;

	/*
	 * If not NULL, contains additional HTTP headers to be sent with the
	 * request. The strings in the list must not be freed until after the
	 * request has completed.
	 */
	struct string_list *extra_headers;
};

/* Return values for http_get_*() */
#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, struct http_get_options *options);

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;
	struct strbuf tmpfile;
	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;
	struct strbuf tmpfile;
	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);

/* setup routine for curl_easy_setopt CURLOPT_DEBUGFUNCTION */
void setup_curl_trace(CURL *handle);
#endif /* HTTP_H */
Commit	Line	Data
	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 shouldn't be set by the Makefile or by the user (e.g. via CFLAGS).
	17	*/
	18	#undef USE_CURL_MULTI
	19
	20	#if LIBCURL_VERSION_NUM >= 0x071000
	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
	32	#if (LIBCURL_VERSION_NUM < 0x070c04) \|\| (LIBCURL_VERSION_NUM == 0x071000)
	33	#define NO_CURL_EASY_DUPHANDLE
	34	#endif
	35
	36	#if LIBCURL_VERSION_NUM < 0x070a03
	37	#define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
	38	#endif
	39
	40	#if LIBCURL_VERSION_NUM < 0x070c03
	41	#define NO_CURL_IOCTL
	42	#endif
	43
	44	/*
	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
	53	struct slot_results {
	54	CURLcode curl_result;
	55	long http_code;
	56	long auth_avail;
	57	long http_connectcode;
	58	};
	59
	60	struct active_request_slot {
	61	CURL *curl;
	62	int in_use;
	63	CURLcode curl_result;
	64	long http_code;
	65	int *finished;
	66	struct slot_results *results;
	67	void *callback_data;
	68	void (callback_func)(void data);
	69	struct active_request_slot *next;
	70	};
	71
	72	struct buffer {
	73	struct strbuf buf;
	74	size_t posn;
	75	};
	76
	77	/* Curl request read/write callbacks */
	78	extern size_t fread_buffer(char ptr, size_t eltsize, size_t nmemb, void strbuf);
	79	extern size_t fwrite_buffer(char ptr, size_t eltsize, size_t nmemb, void strbuf);
	80	extern size_t fwrite_null(char ptr, size_t eltsize, size_t nmemb, void strbuf);
	81	#ifndef NO_CURL_IOCTL
	82	extern curlioerr ioctl_buffer(CURL handle, int cmd, void clientp);
	83	#endif
	84
	85	/* Slot lifecycle functions */
	86	extern struct active_request_slot *get_active_slot(void);
	87	extern int start_active_slot(struct active_request_slot *slot);
	88	extern void run_active_slot(struct active_request_slot *slot);
	89	extern void finish_all_active_slots(void);
	90
	91	/*
	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	*/
	97	int run_one_slot(struct active_request_slot *slot,
	98	struct slot_results *results);
	99
	100	#ifdef USE_CURL_MULTI
	101	extern void fill_active_slots(void);
	102	extern void add_fill_function(void data, int (fill)(void *));
	103	extern void step_active_slots(void);
	104	#endif
	105
	106	extern void http_init(struct remote remote, const char url,
	107	int proactive_auth);
	108	extern void http_cleanup(void);
	109	extern struct curl_slist *http_copy_default_headers(void);
	110
	111	extern long int git_curl_ipresolve;
	112	extern int active_requests;
	113	extern int http_is_verbose;
	114	extern ssize_t http_post_buffer;
	115	extern struct credential http_auth;
	116
	117	extern char curl_errorstr[CURL_ERROR_SIZE];
	118
	119	enum http_follow_config {
	120	HTTP_FOLLOW_NONE,
	121	HTTP_FOLLOW_ALWAYS,
	122	HTTP_FOLLOW_INITIAL
	123	};
	124	extern enum http_follow_config http_follow_config;
	125
	126	static inline int missing__target(int code, int result)
	127	{
	128	return /* file:// URL -- do we ever use one??? */
	129	(result == CURLE_FILE_COULDNT_READ_FILE) \|\|
	130	/* http:// and https:// URL */
	131	(code == 404 && result == CURLE_HTTP_RETURNED_ERROR) \|\|
	132	/* ftp:// URL */
	133	(code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
	134	;
	135	}
	136
	137	#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
	138
	139	/* Helpers for modifying and creating URLs */
	140	extern void append_remote_object_url(struct strbuf buf, const char url,
	141	const char *hex,
	142	int only_two_digit_prefix);
	143	extern char get_remote_object_url(const char url, const char *hex,
	144	int only_two_digit_prefix);
	145
	146	/* Options for http_get_() /
	147	struct http_get_options {
	148	unsigned no_cache:1,
	149	keep_error:1,
	150	initial_request:1;
	151
	152	/* If non-NULL, returns the content-type of the response. */
	153	struct strbuf *content_type;
	154
	155	/*
	156	* If non-NULL, and content_type above is non-NULL, returns
	157	* the charset parameter from the content-type. If none is
	158	* present, returns an empty string.
	159	*/
	160	struct strbuf *charset;
	161
	162	/*
	163	* If non-NULL, returns the URL we ended up at, including any
	164	* redirects we followed.
	165	*/
	166	struct strbuf *effective_url;
	167
	168	/*
	169	* If both base_url and effective_url are non-NULL, the base URL will
	170	* be munged to reflect any redirections going from the requested url
	171	* to effective_url. See the definition of update_url_from_redirect
	172	* for details.
	173	*/
	174	struct strbuf *base_url;
	175
	176	/*
	177	* If not NULL, contains additional HTTP headers to be sent with the
	178	* request. The strings in the list must not be freed until after the
	179	* request has completed.
	180	*/
	181	struct string_list *extra_headers;
	182	};
	183
	184	/* Return values for http_get_() /
	185	#define HTTP_OK 0
	186	#define HTTP_MISSING_TARGET 1
	187	#define HTTP_ERROR 2
	188	#define HTTP_START_FAILED 3
	189	#define HTTP_REAUTH 4
	190	#define HTTP_NOAUTH 5
	191
	192	/*
	193	* Requests a URL and stores the result in a strbuf.
	194	*
	195	* If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
	196	*/
	197	int http_get_strbuf(const char url, struct strbuf result, struct http_get_options *options);
	198
	199	extern int http_fetch_ref(const char base, struct ref ref);
	200
	201	/* Helpers for fetching packs */
	202	extern int http_get_info_packs(const char *base_url,
	203	struct packed_git **packs_head);
	204
	205	struct http_pack_request {
	206	char *url;
	207	struct packed_git *target;
	208	struct packed_git **lst;
	209	FILE *packfile;
	210	struct strbuf tmpfile;
	211	struct active_request_slot *slot;
	212	};
	213
	214	extern struct http_pack_request *new_http_pack_request(
	215	struct packed_git target, const char base_url);
	216	extern int finish_http_pack_request(struct http_pack_request *preq);
	217	extern void release_http_pack_request(struct http_pack_request *preq);
	218
	219	/* Helpers for fetching object */
	220	struct http_object_request {
	221	char *url;
	222	struct strbuf tmpfile;
	223	int localfile;
	224	CURLcode curl_result;
	225	char errorstr[CURL_ERROR_SIZE];
	226	long http_code;
	227	unsigned char sha1[20];
	228	unsigned char real_sha1[20];
	229	git_SHA_CTX c;
	230	git_zstream stream;
	231	int zret;
	232	int rename;
	233	struct active_request_slot *slot;
	234	};
	235
	236	extern struct http_object_request *new_http_object_request(
	237	const char base_url, unsigned char sha1);
	238	extern void process_http_object_request(struct http_object_request *freq);
	239	extern int finish_http_object_request(struct http_object_request *freq);
	240	extern void abort_http_object_request(struct http_object_request *freq);
	241	extern void release_http_object_request(struct http_object_request *freq);
	242
	243	/* setup routine for curl_easy_setopt CURLOPT_DEBUGFUNCTION */
	244	void setup_curl_trace(CURL *handle);
	245	#endif /* HTTP_H */