blob: 5c9441c10ce708be426afe7424d63dcbb68a49e2 [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"
Mike Hommey028c2972007-12-09 20:30:59 +010011
Junio C Hamano4f5f9982008-01-21 17:34:43 -080012/*
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
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
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
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
Nick Hengeveldc8568e12006-01-31 11:06:55 -080044struct slot_results
45{
46 CURLcode curl_result;
47 long http_code;
48};
49
Nick Hengeveld29508e12005-11-18 11:02:58 -080050struct active_request_slot
51{
52 CURL *curl;
53 FILE *local;
54 int in_use;
55 CURLcode curl_result;
56 long http_code;
Nick Hengeveldbaa7b672006-03-10 20:18:01 -080057 int *finished;
Nick Hengeveldc8568e12006-01-31 11:06:55 -080058 struct slot_results *results;
Nick Hengeveld29508e12005-11-18 11:02:58 -080059 void *callback_data;
60 void (*callback_func)(void *data);
61 struct active_request_slot *next;
62};
63
64struct buffer
65{
Mike Hommey028c2972007-12-09 20:30:59 +010066 struct strbuf buf;
67 size_t posn;
Nick Hengeveld29508e12005-11-18 11:02:58 -080068};
69
70/* Curl request read/write callbacks */
Junio C Hamanof444e522008-07-04 00:37:40 -070071extern size_t fread_buffer(void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
72extern size_t fwrite_buffer(const void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
73extern size_t fwrite_null(const void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
Martin Storsjö3944ba02009-04-01 19:48:24 +030074#ifndef NO_CURL_IOCTL
75extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
76#endif
Nick Hengeveld29508e12005-11-18 11:02:58 -080077
78/* Slot lifecycle functions */
79extern struct active_request_slot *get_active_slot(void);
80extern int start_active_slot(struct active_request_slot *slot);
81extern void run_active_slot(struct active_request_slot *slot);
Shawn O. Pearcede1a2fd2009-10-30 17:47:41 -070082extern void finish_active_slot(struct active_request_slot *slot);
Nick Hengeveld29508e12005-11-18 11:02:58 -080083extern void finish_all_active_slots(void);
Nick Hengeveld29508e12005-11-18 11:02:58 -080084
85#ifdef USE_CURL_MULTI
86extern void fill_active_slots(void);
Daniel Barkalowfc57b6a2007-09-10 23:02:34 -040087extern void add_fill_function(void *data, int (*fill)(void *));
Nick Hengeveld29508e12005-11-18 11:02:58 -080088extern void step_active_slots(void);
89#endif
90
Mike Hommey9fc64402008-02-27 21:35:50 +010091extern void http_init(struct remote *remote);
Nick Hengeveld29508e12005-11-18 11:02:58 -080092extern void http_cleanup(void);
93
94extern int data_received;
95extern int active_requests;
Tay Ray Chuane9176742009-06-06 16:43:41 +080096extern int http_is_verbose;
Shawn O. Pearcede1a2fd2009-10-30 17:47:41 -070097extern size_t http_post_buffer;
Nick Hengeveld29508e12005-11-18 11:02:58 -080098
Nick Hengeveld29508e12005-11-18 11:02:58 -080099extern char curl_errorstr[CURL_ERROR_SIZE];
100
Mike Hommeye8dc37e2007-12-10 22:36:09 +0100101static inline int missing__target(int code, int result)
102{
103 return /* file:// URL -- do we ever use one??? */
104 (result == CURLE_FILE_COULDNT_READ_FILE) ||
105 /* http:// and https:// URL */
106 (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
107 /* ftp:// URL */
108 (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
109 ;
110}
111
112#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
113
Tay Ray Chuan5424bc52009-06-06 16:44:02 +0800114/* Helpers for modifying and creating URLs */
115extern void append_remote_object_url(struct strbuf *buf, const char *url,
116 const char *hex,
117 int only_two_digit_prefix);
118extern char *get_remote_object_url(const char *url, const char *hex,
119 int only_two_digit_prefix);
120
Mike Hommeye929cd22009-06-06 16:43:53 +0800121/* Options for http_request_*() */
122#define HTTP_NO_CACHE 1
123
124/* Return values for http_request_*() */
125#define HTTP_OK 0
126#define HTTP_MISSING_TARGET 1
127#define HTTP_ERROR 2
128#define HTTP_START_FAILED 3
129
130/*
131 * Requests an url and stores the result in a strbuf.
132 *
133 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
134 */
135int http_get_strbuf(const char *url, struct strbuf *result, int options);
136
137/*
Mike Hommeye929cd22009-06-06 16:43:53 +0800138 * Prints an error message using error() containing url and curl_errorstr,
139 * and returns ret.
140 */
141int http_error(const char *url, int ret);
142
Daniel Barkalowc13b2632008-04-26 15:53:09 -0400143extern int http_fetch_ref(const char *base, struct ref *ref);
Mike Hommeyd7e92802007-12-11 00:08:25 +0100144
Tay Ray Chuanb8caac22009-06-06 16:43:59 +0800145/* Helpers for fetching packs */
146extern int http_get_info_packs(const char *base_url,
147 struct packed_git **packs_head);
148
Tay Ray Chuan2264dfa2009-06-06 16:44:01 +0800149struct http_pack_request
150{
151 char *url;
152 struct packed_git *target;
153 struct packed_git **lst;
154 FILE *packfile;
155 char filename[PATH_MAX];
156 char tmpfile[PATH_MAX];
157 struct curl_slist *range_header;
158 struct active_request_slot *slot;
159};
160
161extern struct http_pack_request *new_http_pack_request(
162 struct packed_git *target, const char *base_url);
163extern int finish_http_pack_request(struct http_pack_request *preq);
164extern void release_http_pack_request(struct http_pack_request *preq);
165
Tay Ray Chuan5424bc52009-06-06 16:44:02 +0800166/* Helpers for fetching object */
167struct http_object_request
168{
169 char *url;
170 char filename[PATH_MAX];
171 char tmpfile[PATH_MAX];
172 int localfile;
173 CURLcode curl_result;
174 char errorstr[CURL_ERROR_SIZE];
175 long http_code;
176 unsigned char sha1[20];
177 unsigned char real_sha1[20];
178 git_SHA_CTX c;
179 z_stream stream;
180 int zret;
181 int rename;
182 struct active_request_slot *slot;
183};
184
185extern struct http_object_request *new_http_object_request(
186 const char *base_url, unsigned char *sha1);
187extern void process_http_object_request(struct http_object_request *freq);
188extern int finish_http_object_request(struct http_object_request *freq);
189extern void abort_http_object_request(struct http_object_request *freq);
190extern void release_http_object_request(struct http_object_request *freq);
191
Nick Hengeveld29508e12005-11-18 11:02:58 -0800192#endif /* HTTP_H */