Fix the building of gitman.info document
[git/jnareb-git.git] / http.c
blobee58799ca8cd433218ca7d40946580732a9010e7
1 #include "http.h"
3 int data_received;
4 int active_requests = 0;
6 #ifdef USE_CURL_MULTI
7 static int max_requests = -1;
8 static CURLM *curlm;
9 #endif
10 #ifndef NO_CURL_EASY_DUPHANDLE
11 static CURL *curl_default;
12 #endif
13 char curl_errorstr[CURL_ERROR_SIZE];
15 static int curl_ssl_verify = -1;
16 static const char *ssl_cert = NULL;
17 #if LIBCURL_VERSION_NUM >= 0x070902
18 static const char *ssl_key = NULL;
19 #endif
20 #if LIBCURL_VERSION_NUM >= 0x070908
21 static const char *ssl_capath = NULL;
22 #endif
23 static const char *ssl_cainfo = NULL;
24 static long curl_low_speed_limit = -1;
25 static long curl_low_speed_time = -1;
26 static int curl_ftp_no_epsv = 0;
27 static const char *curl_http_proxy = NULL;
29 static struct curl_slist *pragma_header;
31 static struct active_request_slot *active_queue_head = NULL;
33 size_t fread_buffer(void *ptr, size_t eltsize, size_t nmemb, void *buffer_)
35 size_t size = eltsize * nmemb;
36 struct buffer *buffer = buffer_;
38 if (size > buffer->buf.len - buffer->posn)
39 size = buffer->buf.len - buffer->posn;
40 memcpy(ptr, buffer->buf.buf + buffer->posn, size);
41 buffer->posn += size;
43 return size;
46 size_t fwrite_buffer(const void *ptr, size_t eltsize, size_t nmemb, void *buffer_)
48 size_t size = eltsize * nmemb;
49 struct strbuf *buffer = buffer_;
51 strbuf_add(buffer, ptr, size);
52 data_received++;
53 return size;
56 size_t fwrite_null(const void *ptr, size_t eltsize, size_t nmemb, void *strbuf)
58 data_received++;
59 return eltsize * nmemb;
62 static void finish_active_slot(struct active_request_slot *slot);
64 #ifdef USE_CURL_MULTI
65 static void process_curl_messages(void)
67 int num_messages;
68 struct active_request_slot *slot;
69 CURLMsg *curl_message = curl_multi_info_read(curlm, &num_messages);
71 while (curl_message != NULL) {
72 if (curl_message->msg == CURLMSG_DONE) {
73 int curl_result = curl_message->data.result;
74 slot = active_queue_head;
75 while (slot != NULL &&
76 slot->curl != curl_message->easy_handle)
77 slot = slot->next;
78 if (slot != NULL) {
79 curl_multi_remove_handle(curlm, slot->curl);
80 slot->curl_result = curl_result;
81 finish_active_slot(slot);
82 } else {
83 fprintf(stderr, "Received DONE message for unknown request!\n");
85 } else {
86 fprintf(stderr, "Unknown CURL message received: %d\n",
87 (int)curl_message->msg);
89 curl_message = curl_multi_info_read(curlm, &num_messages);
92 #endif
94 static int http_options(const char *var, const char *value, void *cb)
96 if (!strcmp("http.sslverify", var)) {
97 if (curl_ssl_verify == -1) {
98 curl_ssl_verify = git_config_bool(var, value);
100 return 0;
103 if (!strcmp("http.sslcert", var)) {
104 if (ssl_cert == NULL)
105 return git_config_string(&ssl_cert, var, value);
106 return 0;
108 #if LIBCURL_VERSION_NUM >= 0x070902
109 if (!strcmp("http.sslkey", var)) {
110 if (ssl_key == NULL)
111 return git_config_string(&ssl_key, var, value);
112 return 0;
114 #endif
115 #if LIBCURL_VERSION_NUM >= 0x070908
116 if (!strcmp("http.sslcapath", var)) {
117 if (ssl_capath == NULL)
118 return git_config_string(&ssl_capath, var, value);
119 return 0;
121 #endif
122 if (!strcmp("http.sslcainfo", var)) {
123 if (ssl_cainfo == NULL)
124 return git_config_string(&ssl_cainfo, var, value);
125 return 0;
128 #ifdef USE_CURL_MULTI
129 if (!strcmp("http.maxrequests", var)) {
130 if (max_requests == -1)
131 max_requests = git_config_int(var, value);
132 return 0;
134 #endif
136 if (!strcmp("http.lowspeedlimit", var)) {
137 if (curl_low_speed_limit == -1)
138 curl_low_speed_limit = (long)git_config_int(var, value);
139 return 0;
141 if (!strcmp("http.lowspeedtime", var)) {
142 if (curl_low_speed_time == -1)
143 curl_low_speed_time = (long)git_config_int(var, value);
144 return 0;
147 if (!strcmp("http.noepsv", var)) {
148 curl_ftp_no_epsv = git_config_bool(var, value);
149 return 0;
151 if (!strcmp("http.proxy", var)) {
152 if (curl_http_proxy == NULL)
153 return git_config_string(&curl_http_proxy, var, value);
154 return 0;
157 /* Fall back on the default ones */
158 return git_default_config(var, value, cb);
161 static CURL* get_curl_handle(void)
163 CURL* result = curl_easy_init();
165 if (!curl_ssl_verify) {
166 curl_easy_setopt(result, CURLOPT_SSL_VERIFYPEER, 0);
167 curl_easy_setopt(result, CURLOPT_SSL_VERIFYHOST, 0);
168 } else {
169 /* Verify authenticity of the peer's certificate */
170 curl_easy_setopt(result, CURLOPT_SSL_VERIFYPEER, 1);
171 /* The name in the cert must match whom we tried to connect */
172 curl_easy_setopt(result, CURLOPT_SSL_VERIFYHOST, 2);
175 #if LIBCURL_VERSION_NUM >= 0x070907
176 curl_easy_setopt(result, CURLOPT_NETRC, CURL_NETRC_OPTIONAL);
177 #endif
179 if (ssl_cert != NULL)
180 curl_easy_setopt(result, CURLOPT_SSLCERT, ssl_cert);
181 #if LIBCURL_VERSION_NUM >= 0x070902
182 if (ssl_key != NULL)
183 curl_easy_setopt(result, CURLOPT_SSLKEY, ssl_key);
184 #endif
185 #if LIBCURL_VERSION_NUM >= 0x070908
186 if (ssl_capath != NULL)
187 curl_easy_setopt(result, CURLOPT_CAPATH, ssl_capath);
188 #endif
189 if (ssl_cainfo != NULL)
190 curl_easy_setopt(result, CURLOPT_CAINFO, ssl_cainfo);
191 curl_easy_setopt(result, CURLOPT_FAILONERROR, 1);
193 if (curl_low_speed_limit > 0 && curl_low_speed_time > 0) {
194 curl_easy_setopt(result, CURLOPT_LOW_SPEED_LIMIT,
195 curl_low_speed_limit);
196 curl_easy_setopt(result, CURLOPT_LOW_SPEED_TIME,
197 curl_low_speed_time);
200 curl_easy_setopt(result, CURLOPT_FOLLOWLOCATION, 1);
202 if (getenv("GIT_CURL_VERBOSE"))
203 curl_easy_setopt(result, CURLOPT_VERBOSE, 1);
205 curl_easy_setopt(result, CURLOPT_USERAGENT, GIT_USER_AGENT);
207 if (curl_ftp_no_epsv)
208 curl_easy_setopt(result, CURLOPT_FTP_USE_EPSV, 0);
210 if (curl_http_proxy)
211 curl_easy_setopt(result, CURLOPT_PROXY, curl_http_proxy);
213 return result;
216 void http_init(struct remote *remote)
218 char *low_speed_limit;
219 char *low_speed_time;
221 curl_global_init(CURL_GLOBAL_ALL);
223 if (remote && remote->http_proxy)
224 curl_http_proxy = xstrdup(remote->http_proxy);
226 pragma_header = curl_slist_append(pragma_header, "Pragma: no-cache");
228 #ifdef USE_CURL_MULTI
230 char *http_max_requests = getenv("GIT_HTTP_MAX_REQUESTS");
231 if (http_max_requests != NULL)
232 max_requests = atoi(http_max_requests);
235 curlm = curl_multi_init();
236 if (curlm == NULL) {
237 fprintf(stderr, "Error creating curl multi handle.\n");
238 exit(1);
240 #endif
242 if (getenv("GIT_SSL_NO_VERIFY"))
243 curl_ssl_verify = 0;
245 ssl_cert = getenv("GIT_SSL_CERT");
246 #if LIBCURL_VERSION_NUM >= 0x070902
247 ssl_key = getenv("GIT_SSL_KEY");
248 #endif
249 #if LIBCURL_VERSION_NUM >= 0x070908
250 ssl_capath = getenv("GIT_SSL_CAPATH");
251 #endif
252 ssl_cainfo = getenv("GIT_SSL_CAINFO");
254 low_speed_limit = getenv("GIT_HTTP_LOW_SPEED_LIMIT");
255 if (low_speed_limit != NULL)
256 curl_low_speed_limit = strtol(low_speed_limit, NULL, 10);
257 low_speed_time = getenv("GIT_HTTP_LOW_SPEED_TIME");
258 if (low_speed_time != NULL)
259 curl_low_speed_time = strtol(low_speed_time, NULL, 10);
261 git_config(http_options, NULL);
263 if (curl_ssl_verify == -1)
264 curl_ssl_verify = 1;
266 #ifdef USE_CURL_MULTI
267 if (max_requests < 1)
268 max_requests = DEFAULT_MAX_REQUESTS;
269 #endif
271 if (getenv("GIT_CURL_FTP_NO_EPSV"))
272 curl_ftp_no_epsv = 1;
274 #ifndef NO_CURL_EASY_DUPHANDLE
275 curl_default = get_curl_handle();
276 #endif
279 void http_cleanup(void)
281 struct active_request_slot *slot = active_queue_head;
283 while (slot != NULL) {
284 struct active_request_slot *next = slot->next;
285 if (slot->curl != NULL) {
286 #ifdef USE_CURL_MULTI
287 curl_multi_remove_handle(curlm, slot->curl);
288 #endif
289 curl_easy_cleanup(slot->curl);
291 free(slot);
292 slot = next;
294 active_queue_head = NULL;
296 #ifndef NO_CURL_EASY_DUPHANDLE
297 curl_easy_cleanup(curl_default);
298 #endif
300 #ifdef USE_CURL_MULTI
301 curl_multi_cleanup(curlm);
302 #endif
303 curl_global_cleanup();
305 curl_slist_free_all(pragma_header);
306 pragma_header = NULL;
308 if (curl_http_proxy) {
309 free((void *)curl_http_proxy);
310 curl_http_proxy = NULL;
314 struct active_request_slot *get_active_slot(void)
316 struct active_request_slot *slot = active_queue_head;
317 struct active_request_slot *newslot;
319 #ifdef USE_CURL_MULTI
320 int num_transfers;
322 /* Wait for a slot to open up if the queue is full */
323 while (active_requests >= max_requests) {
324 curl_multi_perform(curlm, &num_transfers);
325 if (num_transfers < active_requests) {
326 process_curl_messages();
329 #endif
331 while (slot != NULL && slot->in_use) {
332 slot = slot->next;
334 if (slot == NULL) {
335 newslot = xmalloc(sizeof(*newslot));
336 newslot->curl = NULL;
337 newslot->in_use = 0;
338 newslot->next = NULL;
340 slot = active_queue_head;
341 if (slot == NULL) {
342 active_queue_head = newslot;
343 } else {
344 while (slot->next != NULL) {
345 slot = slot->next;
347 slot->next = newslot;
349 slot = newslot;
352 if (slot->curl == NULL) {
353 #ifdef NO_CURL_EASY_DUPHANDLE
354 slot->curl = get_curl_handle();
355 #else
356 slot->curl = curl_easy_duphandle(curl_default);
357 #endif
360 active_requests++;
361 slot->in_use = 1;
362 slot->local = NULL;
363 slot->results = NULL;
364 slot->finished = NULL;
365 slot->callback_data = NULL;
366 slot->callback_func = NULL;
367 curl_easy_setopt(slot->curl, CURLOPT_HTTPHEADER, pragma_header);
368 curl_easy_setopt(slot->curl, CURLOPT_ERRORBUFFER, curl_errorstr);
369 curl_easy_setopt(slot->curl, CURLOPT_CUSTOMREQUEST, NULL);
370 curl_easy_setopt(slot->curl, CURLOPT_READFUNCTION, NULL);
371 curl_easy_setopt(slot->curl, CURLOPT_WRITEFUNCTION, NULL);
372 curl_easy_setopt(slot->curl, CURLOPT_UPLOAD, 0);
373 curl_easy_setopt(slot->curl, CURLOPT_HTTPGET, 1);
375 return slot;
378 int start_active_slot(struct active_request_slot *slot)
380 #ifdef USE_CURL_MULTI
381 CURLMcode curlm_result = curl_multi_add_handle(curlm, slot->curl);
382 int num_transfers;
384 if (curlm_result != CURLM_OK &&
385 curlm_result != CURLM_CALL_MULTI_PERFORM) {
386 active_requests--;
387 slot->in_use = 0;
388 return 0;
392 * We know there must be something to do, since we just added
393 * something.
395 curl_multi_perform(curlm, &num_transfers);
396 #endif
397 return 1;
400 #ifdef USE_CURL_MULTI
401 struct fill_chain {
402 void *data;
403 int (*fill)(void *);
404 struct fill_chain *next;
407 static struct fill_chain *fill_cfg = NULL;
409 void add_fill_function(void *data, int (*fill)(void *))
411 struct fill_chain *new = xmalloc(sizeof(*new));
412 struct fill_chain **linkp = &fill_cfg;
413 new->data = data;
414 new->fill = fill;
415 new->next = NULL;
416 while (*linkp)
417 linkp = &(*linkp)->next;
418 *linkp = new;
421 void fill_active_slots(void)
423 struct active_request_slot *slot = active_queue_head;
425 while (active_requests < max_requests) {
426 struct fill_chain *fill;
427 for (fill = fill_cfg; fill; fill = fill->next)
428 if (fill->fill(fill->data))
429 break;
431 if (!fill)
432 break;
435 while (slot != NULL) {
436 if (!slot->in_use && slot->curl != NULL) {
437 curl_easy_cleanup(slot->curl);
438 slot->curl = NULL;
440 slot = slot->next;
444 void step_active_slots(void)
446 int num_transfers;
447 CURLMcode curlm_result;
449 do {
450 curlm_result = curl_multi_perform(curlm, &num_transfers);
451 } while (curlm_result == CURLM_CALL_MULTI_PERFORM);
452 if (num_transfers < active_requests) {
453 process_curl_messages();
454 fill_active_slots();
457 #endif
459 void run_active_slot(struct active_request_slot *slot)
461 #ifdef USE_CURL_MULTI
462 long last_pos = 0;
463 long current_pos;
464 fd_set readfds;
465 fd_set writefds;
466 fd_set excfds;
467 int max_fd;
468 struct timeval select_timeout;
469 int finished = 0;
471 slot->finished = &finished;
472 while (!finished) {
473 data_received = 0;
474 step_active_slots();
476 if (!data_received && slot->local != NULL) {
477 current_pos = ftell(slot->local);
478 if (current_pos > last_pos)
479 data_received++;
480 last_pos = current_pos;
483 if (slot->in_use && !data_received) {
484 max_fd = 0;
485 FD_ZERO(&readfds);
486 FD_ZERO(&writefds);
487 FD_ZERO(&excfds);
488 select_timeout.tv_sec = 0;
489 select_timeout.tv_usec = 50000;
490 select(max_fd, &readfds, &writefds,
491 &excfds, &select_timeout);
494 #else
495 while (slot->in_use) {
496 slot->curl_result = curl_easy_perform(slot->curl);
497 finish_active_slot(slot);
499 #endif
502 static void closedown_active_slot(struct active_request_slot *slot)
504 active_requests--;
505 slot->in_use = 0;
508 void release_active_slot(struct active_request_slot *slot)
510 closedown_active_slot(slot);
511 if (slot->curl) {
512 #ifdef USE_CURL_MULTI
513 curl_multi_remove_handle(curlm, slot->curl);
514 #endif
515 curl_easy_cleanup(slot->curl);
516 slot->curl = NULL;
518 #ifdef USE_CURL_MULTI
519 fill_active_slots();
520 #endif
523 static void finish_active_slot(struct active_request_slot *slot)
525 closedown_active_slot(slot);
526 curl_easy_getinfo(slot->curl, CURLINFO_HTTP_CODE, &slot->http_code);
528 if (slot->finished != NULL)
529 (*slot->finished) = 1;
531 /* Store slot results so they can be read after the slot is reused */
532 if (slot->results != NULL) {
533 slot->results->curl_result = slot->curl_result;
534 slot->results->http_code = slot->http_code;
537 /* Run callback if appropriate */
538 if (slot->callback_func != NULL) {
539 slot->callback_func(slot->callback_data);
543 void finish_all_active_slots(void)
545 struct active_request_slot *slot = active_queue_head;
547 while (slot != NULL)
548 if (slot->in_use) {
549 run_active_slot(slot);
550 slot = active_queue_head;
551 } else {
552 slot = slot->next;
556 static inline int needs_quote(int ch)
558 if (((ch >= 'A') && (ch <= 'Z'))
559 || ((ch >= 'a') && (ch <= 'z'))
560 || ((ch >= '0') && (ch <= '9'))
561 || (ch == '/')
562 || (ch == '-')
563 || (ch == '.'))
564 return 0;
565 return 1;
568 static inline int hex(int v)
570 if (v < 10) return '0' + v;
571 else return 'A' + v - 10;
574 static char *quote_ref_url(const char *base, const char *ref)
576 const char *cp;
577 char *dp, *qref;
578 int len, baselen, ch;
580 baselen = strlen(base);
581 len = baselen + 2; /* '/' after base and terminating NUL */
582 for (cp = ref; (ch = *cp) != 0; cp++, len++)
583 if (needs_quote(ch))
584 len += 2; /* extra two hex plus replacement % */
585 qref = xmalloc(len);
586 memcpy(qref, base, baselen);
587 dp = qref + baselen;
588 *(dp++) = '/';
589 for (cp = ref; (ch = *cp) != 0; cp++) {
590 if (needs_quote(ch)) {
591 *dp++ = '%';
592 *dp++ = hex((ch >> 4) & 0xF);
593 *dp++ = hex(ch & 0xF);
595 else
596 *dp++ = ch;
598 *dp = 0;
600 return qref;
603 int http_fetch_ref(const char *base, struct ref *ref)
605 char *url;
606 struct strbuf buffer = STRBUF_INIT;
607 struct active_request_slot *slot;
608 struct slot_results results;
609 int ret;
611 url = quote_ref_url(base, ref->name);
612 slot = get_active_slot();
613 slot->results = &results;
614 curl_easy_setopt(slot->curl, CURLOPT_FILE, &buffer);
615 curl_easy_setopt(slot->curl, CURLOPT_WRITEFUNCTION, fwrite_buffer);
616 curl_easy_setopt(slot->curl, CURLOPT_HTTPHEADER, NULL);
617 curl_easy_setopt(slot->curl, CURLOPT_URL, url);
618 if (start_active_slot(slot)) {
619 run_active_slot(slot);
620 if (results.curl_result == CURLE_OK) {
621 strbuf_rtrim(&buffer);
622 if (buffer.len == 40)
623 ret = get_sha1_hex(buffer.buf, ref->old_sha1);
624 else if (!prefixcmp(buffer.buf, "ref: ")) {
625 ref->symref = xstrdup(buffer.buf + 5);
626 ret = 0;
627 } else
628 ret = 1;
629 } else {
630 ret = error("Couldn't get %s for %s\n%s",
631 url, ref->name, curl_errorstr);
633 } else {
634 ret = error("Unable to start request");
637 strbuf_release(&buffer);
638 free(url);
639 return ret;