1 #include "git-compat-util.h"
5 #include "run-command.h"
8 #include "credential.h"
15 size_t http_post_buffer = 16 * LARGE_PACKET_MAX;
17 #if LIBCURL_VERSION_NUM >= 0x070a06
18 #define LIBCURL_CAN_HANDLE_AUTH_ANY
21 static int min_curl_sessions = 1;
22 static int curl_session_count;
24 static int max_requests = -1;
27 #ifndef NO_CURL_EASY_DUPHANDLE
28 static CURL *curl_default;
31 #define PREV_BUF_SIZE 4096
32 #define RANGE_HEADER_SIZE 30
34 char curl_errorstr[CURL_ERROR_SIZE];
36 static int curl_ssl_verify = -1;
37 static int curl_ssl_try;
38 static const char *ssl_cert;
39 #if LIBCURL_VERSION_NUM >= 0x070903
40 static const char *ssl_key;
42 #if LIBCURL_VERSION_NUM >= 0x070908
43 static const char *ssl_capath;
45 static const char *ssl_cainfo;
46 static long curl_low_speed_limit = -1;
47 static long curl_low_speed_time = -1;
48 static int curl_ftp_no_epsv;
49 static const char *curl_http_proxy;
50 static const char *curl_cookie_file;
51 static int curl_save_cookies;
52 struct credential http_auth = CREDENTIAL_INIT;
53 static int http_proactive_auth;
54 static const char *user_agent;
56 #if LIBCURL_VERSION_NUM >= 0x071700
57 /* Use CURLOPT_KEYPASSWD as is */
58 #elif LIBCURL_VERSION_NUM >= 0x070903
59 #define CURLOPT_KEYPASSWD CURLOPT_SSLKEYPASSWD
61 #define CURLOPT_KEYPASSWD CURLOPT_SSLCERTPASSWD
64 static struct credential cert_auth = CREDENTIAL_INIT;
65 static int ssl_cert_password_required;
67 static struct curl_slist *pragma_header;
68 static struct curl_slist *no_pragma_header;
70 static struct active_request_slot *active_queue_head;
72 static char *cached_accept_language;
74 size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *buffer_)
76 size_t size = eltsize * nmemb;
77 struct buffer *buffer = buffer_;
79 if (size > buffer->buf.len - buffer->posn)
80 size = buffer->buf.len - buffer->posn;
81 memcpy(ptr, buffer->buf.buf + buffer->posn, size);
88 curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp)
90 struct buffer *buffer = clientp;
96 case CURLIOCMD_RESTARTREAD:
101 return CURLIOE_UNKNOWNCMD;
106 size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *buffer_)
108 size_t size = eltsize * nmemb;
109 struct strbuf *buffer = buffer_;
111 strbuf_add(buffer, ptr, size);
115 size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf)
117 return eltsize * nmemb;
120 #ifdef USE_CURL_MULTI
121 static void process_curl_messages(void)
124 struct active_request_slot *slot;
125 CURLMsg *curl_message = curl_multi_info_read(curlm, &num_messages);
127 while (curl_message != NULL) {
128 if (curl_message->msg == CURLMSG_DONE) {
129 int curl_result = curl_message->data.result;
130 slot = active_queue_head;
131 while (slot != NULL &&
132 slot->curl != curl_message->easy_handle)
135 curl_multi_remove_handle(curlm, slot->curl);
136 slot->curl_result = curl_result;
137 finish_active_slot(slot);
139 fprintf(stderr, "Received DONE message for unknown request!\n");
142 fprintf(stderr, "Unknown CURL message received: %d\n",
143 (int)curl_message->msg);
145 curl_message = curl_multi_info_read(curlm, &num_messages);
150 static int http_options(const char *var, const char *value, void *cb)
152 if (!strcmp("http.sslverify", var)) {
153 curl_ssl_verify = git_config_bool(var, value);
156 if (!strcmp("http.sslcert", var))
157 return git_config_string(&ssl_cert, var, value);
158 #if LIBCURL_VERSION_NUM >= 0x070903
159 if (!strcmp("http.sslkey", var))
160 return git_config_string(&ssl_key, var, value);
162 #if LIBCURL_VERSION_NUM >= 0x070908
163 if (!strcmp("http.sslcapath", var))
164 return git_config_string(&ssl_capath, var, value);
166 if (!strcmp("http.sslcainfo", var))
167 return git_config_string(&ssl_cainfo, var, value);
168 if (!strcmp("http.sslcertpasswordprotected", var)) {
169 ssl_cert_password_required = git_config_bool(var, value);
172 if (!strcmp("http.ssltry", var)) {
173 curl_ssl_try = git_config_bool(var, value);
176 if (!strcmp("http.minsessions", var)) {
177 min_curl_sessions = git_config_int(var, value);
178 #ifndef USE_CURL_MULTI
179 if (min_curl_sessions > 1)
180 min_curl_sessions = 1;
184 #ifdef USE_CURL_MULTI
185 if (!strcmp("http.maxrequests", var)) {
186 max_requests = git_config_int(var, value);
190 if (!strcmp("http.lowspeedlimit", var)) {
191 curl_low_speed_limit = (long)git_config_int(var, value);
194 if (!strcmp("http.lowspeedtime", var)) {
195 curl_low_speed_time = (long)git_config_int(var, value);
199 if (!strcmp("http.noepsv", var)) {
200 curl_ftp_no_epsv = git_config_bool(var, value);
203 if (!strcmp("http.proxy", var))
204 return git_config_string(&curl_http_proxy, var, value);
206 if (!strcmp("http.cookiefile", var))
207 return git_config_string(&curl_cookie_file, var, value);
208 if (!strcmp("http.savecookies", var)) {
209 curl_save_cookies = git_config_bool(var, value);
213 if (!strcmp("http.postbuffer", var)) {
214 http_post_buffer = git_config_int(var, value);
215 if (http_post_buffer < LARGE_PACKET_MAX)
216 http_post_buffer = LARGE_PACKET_MAX;
220 if (!strcmp("http.useragent", var))
221 return git_config_string(&user_agent, var, value);
223 /* Fall back on the default ones */
224 return git_default_config(var, value, cb);
227 static void init_curl_http_auth(CURL *result)
229 if (!http_auth.username)
232 credential_fill(&http_auth);
234 #if LIBCURL_VERSION_NUM >= 0x071301
235 curl_easy_setopt(result, CURLOPT_USERNAME, http_auth.username);
236 curl_easy_setopt(result, CURLOPT_PASSWORD, http_auth.password);
239 static struct strbuf up = STRBUF_INIT;
241 * Note that we assume we only ever have a single set of
242 * credentials in a given program run, so we do not have
243 * to worry about updating this buffer, only setting its
247 strbuf_addf(&up, "%s:%s",
248 http_auth.username, http_auth.password);
249 curl_easy_setopt(result, CURLOPT_USERPWD, up.buf);
254 static int has_cert_password(void)
256 if (ssl_cert == NULL || ssl_cert_password_required != 1)
258 if (!cert_auth.password) {
259 cert_auth.protocol = xstrdup("cert");
260 cert_auth.username = xstrdup("");
261 cert_auth.path = xstrdup(ssl_cert);
262 credential_fill(&cert_auth);
267 #if LIBCURL_VERSION_NUM >= 0x071900
268 static void set_curl_keepalive(CURL *c)
270 curl_easy_setopt(c, CURLOPT_TCP_KEEPALIVE, 1);
273 #elif LIBCURL_VERSION_NUM >= 0x071000
274 static int sockopt_callback(void *client, curl_socket_t fd, curlsocktype type)
278 socklen_t len = (socklen_t)sizeof(ka);
280 if (type != CURLSOCKTYPE_IPCXN)
283 rc = setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, (void *)&ka, len);
285 warning("unable to set SO_KEEPALIVE on socket %s",
288 return 0; /* CURL_SOCKOPT_OK only exists since curl 7.21.5 */
291 static void set_curl_keepalive(CURL *c)
293 curl_easy_setopt(c, CURLOPT_SOCKOPTFUNCTION, sockopt_callback);
297 static void set_curl_keepalive(CURL *c)
299 /* not supported on older curl versions */
303 static CURL *get_curl_handle(void)
305 CURL *result = curl_easy_init();
308 die("curl_easy_init failed");
310 if (!curl_ssl_verify) {
311 curl_easy_setopt(result, CURLOPT_SSL_VERIFYPEER, 0);
312 curl_easy_setopt(result, CURLOPT_SSL_VERIFYHOST, 0);
314 /* Verify authenticity of the peer's certificate */
315 curl_easy_setopt(result, CURLOPT_SSL_VERIFYPEER, 1);
316 /* The name in the cert must match whom we tried to connect */
317 curl_easy_setopt(result, CURLOPT_SSL_VERIFYHOST, 2);
320 #if LIBCURL_VERSION_NUM >= 0x070907
321 curl_easy_setopt(result, CURLOPT_NETRC, CURL_NETRC_OPTIONAL);
323 #ifdef LIBCURL_CAN_HANDLE_AUTH_ANY
324 curl_easy_setopt(result, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
327 if (http_proactive_auth)
328 init_curl_http_auth(result);
330 if (ssl_cert != NULL)
331 curl_easy_setopt(result, CURLOPT_SSLCERT, ssl_cert);
332 if (has_cert_password())
333 curl_easy_setopt(result, CURLOPT_KEYPASSWD, cert_auth.password);
334 #if LIBCURL_VERSION_NUM >= 0x070903
336 curl_easy_setopt(result, CURLOPT_SSLKEY, ssl_key);
338 #if LIBCURL_VERSION_NUM >= 0x070908
339 if (ssl_capath != NULL)
340 curl_easy_setopt(result, CURLOPT_CAPATH, ssl_capath);
342 if (ssl_cainfo != NULL)
343 curl_easy_setopt(result, CURLOPT_CAINFO, ssl_cainfo);
345 if (curl_low_speed_limit > 0 && curl_low_speed_time > 0) {
346 curl_easy_setopt(result, CURLOPT_LOW_SPEED_LIMIT,
347 curl_low_speed_limit);
348 curl_easy_setopt(result, CURLOPT_LOW_SPEED_TIME,
349 curl_low_speed_time);
352 curl_easy_setopt(result, CURLOPT_FOLLOWLOCATION, 1);
353 #if LIBCURL_VERSION_NUM >= 0x071301
354 curl_easy_setopt(result, CURLOPT_POSTREDIR, CURL_REDIR_POST_ALL);
355 #elif LIBCURL_VERSION_NUM >= 0x071101
356 curl_easy_setopt(result, CURLOPT_POST301, 1);
359 if (getenv("GIT_CURL_VERBOSE"))
360 curl_easy_setopt(result, CURLOPT_VERBOSE, 1);
362 curl_easy_setopt(result, CURLOPT_USERAGENT,
363 user_agent ? user_agent : git_user_agent());
365 if (curl_ftp_no_epsv)
366 curl_easy_setopt(result, CURLOPT_FTP_USE_EPSV, 0);
368 #ifdef CURLOPT_USE_SSL
370 curl_easy_setopt(result, CURLOPT_USE_SSL, CURLUSESSL_TRY);
373 if (curl_http_proxy) {
374 curl_easy_setopt(result, CURLOPT_PROXY, curl_http_proxy);
375 curl_easy_setopt(result, CURLOPT_PROXYAUTH, CURLAUTH_ANY);
378 set_curl_keepalive(result);
383 static void set_from_env(const char **var, const char *envname)
385 const char *val = getenv(envname);
390 void http_init(struct remote *remote, const char *url, int proactive_auth)
392 char *low_speed_limit;
393 char *low_speed_time;
394 char *normalized_url;
395 struct urlmatch_config config = { STRING_LIST_INIT_DUP };
397 config.section = "http";
399 config.collect_fn = http_options;
400 config.cascade_fn = git_default_config;
404 normalized_url = url_normalize(url, &config.url);
406 git_config(urlmatch_config_entry, &config);
407 free(normalized_url);
409 if (curl_global_init(CURL_GLOBAL_ALL) != CURLE_OK)
410 die("curl_global_init failed");
412 http_proactive_auth = proactive_auth;
414 if (remote && remote->http_proxy)
415 curl_http_proxy = xstrdup(remote->http_proxy);
417 pragma_header = curl_slist_append(pragma_header, "Pragma: no-cache");
418 no_pragma_header = curl_slist_append(no_pragma_header, "Pragma:");
420 #ifdef USE_CURL_MULTI
422 char *http_max_requests = getenv("GIT_HTTP_MAX_REQUESTS");
423 if (http_max_requests != NULL)
424 max_requests = atoi(http_max_requests);
427 curlm = curl_multi_init();
429 die("curl_multi_init failed");
432 if (getenv("GIT_SSL_NO_VERIFY"))
435 set_from_env(&ssl_cert, "GIT_SSL_CERT");
436 #if LIBCURL_VERSION_NUM >= 0x070903
437 set_from_env(&ssl_key, "GIT_SSL_KEY");
439 #if LIBCURL_VERSION_NUM >= 0x070908
440 set_from_env(&ssl_capath, "GIT_SSL_CAPATH");
442 set_from_env(&ssl_cainfo, "GIT_SSL_CAINFO");
444 set_from_env(&user_agent, "GIT_HTTP_USER_AGENT");
446 low_speed_limit = getenv("GIT_HTTP_LOW_SPEED_LIMIT");
447 if (low_speed_limit != NULL)
448 curl_low_speed_limit = strtol(low_speed_limit, NULL, 10);
449 low_speed_time = getenv("GIT_HTTP_LOW_SPEED_TIME");
450 if (low_speed_time != NULL)
451 curl_low_speed_time = strtol(low_speed_time, NULL, 10);
453 if (curl_ssl_verify == -1)
456 curl_session_count = 0;
457 #ifdef USE_CURL_MULTI
458 if (max_requests < 1)
459 max_requests = DEFAULT_MAX_REQUESTS;
462 if (getenv("GIT_CURL_FTP_NO_EPSV"))
463 curl_ftp_no_epsv = 1;
466 credential_from_url(&http_auth, url);
467 if (!ssl_cert_password_required &&
468 getenv("GIT_SSL_CERT_PASSWORD_PROTECTED") &&
469 starts_with(url, "https://"))
470 ssl_cert_password_required = 1;
473 #ifndef NO_CURL_EASY_DUPHANDLE
474 curl_default = get_curl_handle();
478 void http_cleanup(void)
480 struct active_request_slot *slot = active_queue_head;
482 while (slot != NULL) {
483 struct active_request_slot *next = slot->next;
484 if (slot->curl != NULL) {
485 #ifdef USE_CURL_MULTI
486 curl_multi_remove_handle(curlm, slot->curl);
488 curl_easy_cleanup(slot->curl);
493 active_queue_head = NULL;
495 #ifndef NO_CURL_EASY_DUPHANDLE
496 curl_easy_cleanup(curl_default);
499 #ifdef USE_CURL_MULTI
500 curl_multi_cleanup(curlm);
502 curl_global_cleanup();
504 curl_slist_free_all(pragma_header);
505 pragma_header = NULL;
507 curl_slist_free_all(no_pragma_header);
508 no_pragma_header = NULL;
510 if (curl_http_proxy) {
511 free((void *)curl_http_proxy);
512 curl_http_proxy = NULL;
515 if (cert_auth.password != NULL) {
516 memset(cert_auth.password, 0, strlen(cert_auth.password));
517 free(cert_auth.password);
518 cert_auth.password = NULL;
520 ssl_cert_password_required = 0;
522 free(cached_accept_language);
523 cached_accept_language = NULL;
526 struct active_request_slot *get_active_slot(void)
528 struct active_request_slot *slot = active_queue_head;
529 struct active_request_slot *newslot;
531 #ifdef USE_CURL_MULTI
534 /* Wait for a slot to open up if the queue is full */
535 while (active_requests >= max_requests) {
536 curl_multi_perform(curlm, &num_transfers);
537 if (num_transfers < active_requests)
538 process_curl_messages();
542 while (slot != NULL && slot->in_use)
546 newslot = xmalloc(sizeof(*newslot));
547 newslot->curl = NULL;
549 newslot->next = NULL;
551 slot = active_queue_head;
553 active_queue_head = newslot;
555 while (slot->next != NULL)
557 slot->next = newslot;
562 if (slot->curl == NULL) {
563 #ifdef NO_CURL_EASY_DUPHANDLE
564 slot->curl = get_curl_handle();
566 slot->curl = curl_easy_duphandle(curl_default);
568 curl_session_count++;
573 slot->results = NULL;
574 slot->finished = NULL;
575 slot->callback_data = NULL;
576 slot->callback_func = NULL;
577 curl_easy_setopt(slot->curl, CURLOPT_COOKIEFILE, curl_cookie_file);
578 if (curl_save_cookies)
579 curl_easy_setopt(slot->curl, CURLOPT_COOKIEJAR, curl_cookie_file);
580 curl_easy_setopt(slot->curl, CURLOPT_HTTPHEADER, pragma_header);
581 curl_easy_setopt(slot->curl, CURLOPT_ERRORBUFFER, curl_errorstr);
582 curl_easy_setopt(slot->curl, CURLOPT_CUSTOMREQUEST, NULL);
583 curl_easy_setopt(slot->curl, CURLOPT_READFUNCTION, NULL);
584 curl_easy_setopt(slot->curl, CURLOPT_WRITEFUNCTION, NULL);
585 curl_easy_setopt(slot->curl, CURLOPT_POSTFIELDS, NULL);
586 curl_easy_setopt(slot->curl, CURLOPT_UPLOAD, 0);
587 curl_easy_setopt(slot->curl, CURLOPT_HTTPGET, 1);
588 curl_easy_setopt(slot->curl, CURLOPT_FAILONERROR, 1);
589 if (http_auth.password)
590 init_curl_http_auth(slot->curl);
595 int start_active_slot(struct active_request_slot *slot)
597 #ifdef USE_CURL_MULTI
598 CURLMcode curlm_result = curl_multi_add_handle(curlm, slot->curl);
601 if (curlm_result != CURLM_OK &&
602 curlm_result != CURLM_CALL_MULTI_PERFORM) {
609 * We know there must be something to do, since we just added
612 curl_multi_perform(curlm, &num_transfers);
617 #ifdef USE_CURL_MULTI
621 struct fill_chain *next;
624 static struct fill_chain *fill_cfg;
626 void add_fill_function(void *data, int (*fill)(void *))
628 struct fill_chain *new = xmalloc(sizeof(*new));
629 struct fill_chain **linkp = &fill_cfg;
634 linkp = &(*linkp)->next;
638 void fill_active_slots(void)
640 struct active_request_slot *slot = active_queue_head;
642 while (active_requests < max_requests) {
643 struct fill_chain *fill;
644 for (fill = fill_cfg; fill; fill = fill->next)
645 if (fill->fill(fill->data))
652 while (slot != NULL) {
653 if (!slot->in_use && slot->curl != NULL
654 && curl_session_count > min_curl_sessions) {
655 curl_easy_cleanup(slot->curl);
657 curl_session_count--;
663 void step_active_slots(void)
666 CURLMcode curlm_result;
669 curlm_result = curl_multi_perform(curlm, &num_transfers);
670 } while (curlm_result == CURLM_CALL_MULTI_PERFORM);
671 if (num_transfers < active_requests) {
672 process_curl_messages();
678 void run_active_slot(struct active_request_slot *slot)
680 #ifdef USE_CURL_MULTI
685 struct timeval select_timeout;
688 slot->finished = &finished;
693 #if LIBCURL_VERSION_NUM >= 0x070f04
695 curl_multi_timeout(curlm, &curl_timeout);
696 if (curl_timeout == 0) {
698 } else if (curl_timeout == -1) {
699 select_timeout.tv_sec = 0;
700 select_timeout.tv_usec = 50000;
702 select_timeout.tv_sec = curl_timeout / 1000;
703 select_timeout.tv_usec = (curl_timeout % 1000) * 1000;
706 select_timeout.tv_sec = 0;
707 select_timeout.tv_usec = 50000;
714 curl_multi_fdset(curlm, &readfds, &writefds, &excfds, &max_fd);
717 * It can happen that curl_multi_timeout returns a pathologically
718 * long timeout when curl_multi_fdset returns no file descriptors
719 * to read. See commit message for more details.
722 (select_timeout.tv_sec > 0 ||
723 select_timeout.tv_usec > 50000)) {
724 select_timeout.tv_sec = 0;
725 select_timeout.tv_usec = 50000;
728 select(max_fd+1, &readfds, &writefds, &excfds, &select_timeout);
732 while (slot->in_use) {
733 slot->curl_result = curl_easy_perform(slot->curl);
734 finish_active_slot(slot);
739 static void closedown_active_slot(struct active_request_slot *slot)
745 static void release_active_slot(struct active_request_slot *slot)
747 closedown_active_slot(slot);
748 if (slot->curl && curl_session_count > min_curl_sessions) {
749 #ifdef USE_CURL_MULTI
750 curl_multi_remove_handle(curlm, slot->curl);
752 curl_easy_cleanup(slot->curl);
754 curl_session_count--;
756 #ifdef USE_CURL_MULTI
761 void finish_active_slot(struct active_request_slot *slot)
763 closedown_active_slot(slot);
764 curl_easy_getinfo(slot->curl, CURLINFO_HTTP_CODE, &slot->http_code);
766 if (slot->finished != NULL)
767 (*slot->finished) = 1;
769 /* Store slot results so they can be read after the slot is reused */
770 if (slot->results != NULL) {
771 slot->results->curl_result = slot->curl_result;
772 slot->results->http_code = slot->http_code;
773 #if LIBCURL_VERSION_NUM >= 0x070a08
774 curl_easy_getinfo(slot->curl, CURLINFO_HTTPAUTH_AVAIL,
775 &slot->results->auth_avail);
777 slot->results->auth_avail = 0;
781 /* Run callback if appropriate */
782 if (slot->callback_func != NULL)
783 slot->callback_func(slot->callback_data);
786 void finish_all_active_slots(void)
788 struct active_request_slot *slot = active_queue_head;
792 run_active_slot(slot);
793 slot = active_queue_head;
799 /* Helpers for modifying and creating URLs */
800 static inline int needs_quote(int ch)
802 if (((ch >= 'A') && (ch <= 'Z'))
803 || ((ch >= 'a') && (ch <= 'z'))
804 || ((ch >= '0') && (ch <= '9'))
812 static char *quote_ref_url(const char *base, const char *ref)
814 struct strbuf buf = STRBUF_INIT;
818 end_url_with_slash(&buf, base);
820 for (cp = ref; (ch = *cp) != 0; cp++)
822 strbuf_addf(&buf, "%%%02x", ch);
824 strbuf_addch(&buf, *cp);
826 return strbuf_detach(&buf, NULL);
829 void append_remote_object_url(struct strbuf *buf, const char *url,
831 int only_two_digit_prefix)
833 end_url_with_slash(buf, url);
835 strbuf_addf(buf, "objects/%.*s/", 2, hex);
836 if (!only_two_digit_prefix)
837 strbuf_addf(buf, "%s", hex+2);
840 char *get_remote_object_url(const char *url, const char *hex,
841 int only_two_digit_prefix)
843 struct strbuf buf = STRBUF_INIT;
844 append_remote_object_url(&buf, url, hex, only_two_digit_prefix);
845 return strbuf_detach(&buf, NULL);
848 int handle_curl_result(struct slot_results *results)
851 * If we see a failing http code with CURLE_OK, we have turned off
852 * FAILONERROR (to keep the server's custom error response), and should
853 * translate the code into failure here.
855 if (results->curl_result == CURLE_OK &&
856 results->http_code >= 400) {
857 results->curl_result = CURLE_HTTP_RETURNED_ERROR;
859 * Normally curl will already have put the "reason phrase"
860 * from the server into curl_errorstr; unfortunately without
861 * FAILONERROR it is lost, so we can give only the numeric
864 snprintf(curl_errorstr, sizeof(curl_errorstr),
865 "The requested URL returned error: %ld",
869 if (results->curl_result == CURLE_OK) {
870 credential_approve(&http_auth);
872 } else if (missing_target(results))
873 return HTTP_MISSING_TARGET;
874 else if (results->http_code == 401) {
875 if (http_auth.username && http_auth.password) {
876 credential_reject(&http_auth);
882 #if LIBCURL_VERSION_NUM >= 0x070c00
883 if (!curl_errorstr[0])
884 strlcpy(curl_errorstr,
885 curl_easy_strerror(results->curl_result),
886 sizeof(curl_errorstr));
892 int run_one_slot(struct active_request_slot *slot,
893 struct slot_results *results)
895 slot->results = results;
896 if (!start_active_slot(slot)) {
897 snprintf(curl_errorstr, sizeof(curl_errorstr),
898 "failed to start HTTP request");
899 return HTTP_START_FAILED;
902 run_active_slot(slot);
903 return handle_curl_result(results);
906 static CURLcode curlinfo_strbuf(CURL *curl, CURLINFO info, struct strbuf *buf)
912 ret = curl_easy_getinfo(curl, info, &ptr);
914 strbuf_addstr(buf, ptr);
919 * Check for and extract a content-type parameter. "raw"
920 * should be positioned at the start of the potential
921 * parameter, with any whitespace already removed.
923 * "name" is the name of the parameter. The value is appended
926 static int extract_param(const char *raw, const char *name,
929 size_t len = strlen(name);
931 if (strncasecmp(raw, name, len))
939 while (*raw && !isspace(*raw) && *raw != ';')
940 strbuf_addch(out, *raw++);
945 * Extract a normalized version of the content type, with any
946 * spaces suppressed, all letters lowercased, and no trailing ";"
949 * Note that we will silently remove even invalid whitespace. For
950 * example, "text / plain" is specifically forbidden by RFC 2616,
951 * but "text/plain" is the only reasonable output, and this keeps
954 * If the "charset" argument is not NULL, store the value of any
955 * charset parameter there.
958 * "TEXT/PLAIN; charset=utf-8" -> "text/plain", "utf-8"
959 * "text / plain" -> "text/plain"
961 static void extract_content_type(struct strbuf *raw, struct strbuf *type,
962 struct strbuf *charset)
967 strbuf_grow(type, raw->len);
968 for (p = raw->buf; *p; p++) {
975 strbuf_addch(type, tolower(*p));
981 strbuf_reset(charset);
983 while (isspace(*p) || *p == ';')
985 if (!extract_param(p, "charset", charset))
987 while (*p && !isspace(*p))
991 if (!charset->len && starts_with(type->buf, "text/"))
992 strbuf_addstr(charset, "ISO-8859-1");
995 static void write_accept_language(struct strbuf *buf)
998 * MAX_DECIMAL_PLACES must not be larger than 3. If it is larger than
999 * that, q-value will be smaller than 0.001, the minimum q-value the
1000 * HTTP specification allows. See
1001 * http://tools.ietf.org/html/rfc7231#section-5.3.1 for q-value.
1003 const int MAX_DECIMAL_PLACES = 3;
1004 const int MAX_LANGUAGE_TAGS = 1000;
1005 const int MAX_ACCEPT_LANGUAGE_HEADER_SIZE = 4000;
1006 char **language_tags = NULL;
1008 const char *s = get_preferred_languages();
1010 struct strbuf tag = STRBUF_INIT;
1012 /* Don't add Accept-Language header if no language is preferred. */
1017 * Split the colon-separated string of preferred languages into
1018 * language_tags array.
1021 /* collect language tag */
1022 for (; *s && (isalnum(*s) || *s == '_'); s++)
1023 strbuf_addch(&tag, *s == '_' ? '-' : *s);
1025 /* skip .codeset, @modifier and any other unnecessary parts */
1026 while (*s && *s != ':')
1031 REALLOC_ARRAY(language_tags, num_langs);
1032 language_tags[num_langs - 1] = strbuf_detach(&tag, NULL);
1033 if (num_langs >= MAX_LANGUAGE_TAGS - 1) /* -1 for '*' */
1038 /* write Accept-Language header into buf */
1040 int last_buf_len = 0;
1046 REALLOC_ARRAY(language_tags, num_langs + 1);
1047 language_tags[num_langs++] = "*"; /* it's OK; this won't be freed */
1049 /* compute decimal_places */
1050 for (max_q = 1, decimal_places = 0;
1051 max_q < num_langs && decimal_places <= MAX_DECIMAL_PLACES;
1052 decimal_places++, max_q *= 10)
1055 sprintf(q_format, ";q=0.%%0%dd", decimal_places);
1057 strbuf_addstr(buf, "Accept-Language: ");
1059 for (i = 0; i < num_langs; i++) {
1061 strbuf_addstr(buf, ", ");
1063 strbuf_addstr(buf, language_tags[i]);
1066 strbuf_addf(buf, q_format, max_q - i);
1068 if (buf->len > MAX_ACCEPT_LANGUAGE_HEADER_SIZE) {
1069 strbuf_remove(buf, last_buf_len, buf->len - last_buf_len);
1073 last_buf_len = buf->len;
1077 /* free language tags -- last one is a static '*' */
1078 for (i = 0; i < num_langs - 1; i++)
1079 free(language_tags[i]);
1080 free(language_tags);
1084 * Get an Accept-Language header which indicates user's preferred languages.
1088 * LANGUAGE=ko:en -> "Accept-Language: ko, en; q=0.9, *; q=0.1"
1089 * LANGUAGE=ko_KR.UTF-8:sr@latin -> "Accept-Language: ko-KR, sr; q=0.9, *; q=0.1"
1090 * LANGUAGE=ko LANG=en_US.UTF-8 -> "Accept-Language: ko, *; q=0.1"
1091 * LANGUAGE= LANG=en_US.UTF-8 -> "Accept-Language: en-US, *; q=0.1"
1092 * LANGUAGE= LANG=C -> ""
1094 static const char *get_accept_language(void)
1096 if (!cached_accept_language) {
1097 struct strbuf buf = STRBUF_INIT;
1098 write_accept_language(&buf);
1100 cached_accept_language = strbuf_detach(&buf, NULL);
1103 return cached_accept_language;
1106 /* http_request() targets */
1107 #define HTTP_REQUEST_STRBUF 0
1108 #define HTTP_REQUEST_FILE 1
1110 static int http_request(const char *url,
1111 void *result, int target,
1112 const struct http_get_options *options)
1114 struct active_request_slot *slot;
1115 struct slot_results results;
1116 struct curl_slist *headers = NULL;
1117 struct strbuf buf = STRBUF_INIT;
1118 const char *accept_language;
1121 slot = get_active_slot();
1122 curl_easy_setopt(slot->curl, CURLOPT_HTTPGET, 1);
1124 if (result == NULL) {
1125 curl_easy_setopt(slot->curl, CURLOPT_NOBODY, 1);
1127 curl_easy_setopt(slot->curl, CURLOPT_NOBODY, 0);
1128 curl_easy_setopt(slot->curl, CURLOPT_FILE, result);
1130 if (target == HTTP_REQUEST_FILE) {
1131 long posn = ftell(result);
1132 curl_easy_setopt(slot->curl, CURLOPT_WRITEFUNCTION,
1135 strbuf_addf(&buf, "Range: bytes=%ld-", posn);
1136 headers = curl_slist_append(headers, buf.buf);
1140 curl_easy_setopt(slot->curl, CURLOPT_WRITEFUNCTION,
1144 accept_language = get_accept_language();
1146 if (accept_language)
1147 headers = curl_slist_append(headers, accept_language);
1149 strbuf_addstr(&buf, "Pragma:");
1150 if (options && options->no_cache)
1151 strbuf_addstr(&buf, " no-cache");
1152 if (options && options->keep_error)
1153 curl_easy_setopt(slot->curl, CURLOPT_FAILONERROR, 0);
1155 headers = curl_slist_append(headers, buf.buf);
1157 curl_easy_setopt(slot->curl, CURLOPT_URL, url);
1158 curl_easy_setopt(slot->curl, CURLOPT_HTTPHEADER, headers);
1159 curl_easy_setopt(slot->curl, CURLOPT_ENCODING, "gzip");
1161 ret = run_one_slot(slot, &results);
1163 if (options && options->content_type) {
1164 struct strbuf raw = STRBUF_INIT;
1165 curlinfo_strbuf(slot->curl, CURLINFO_CONTENT_TYPE, &raw);
1166 extract_content_type(&raw, options->content_type,
1168 strbuf_release(&raw);
1171 if (options && options->effective_url)
1172 curlinfo_strbuf(slot->curl, CURLINFO_EFFECTIVE_URL,
1173 options->effective_url);
1175 curl_slist_free_all(headers);
1176 strbuf_release(&buf);
1182 * Update the "base" url to a more appropriate value, as deduced by
1183 * redirects seen when requesting a URL starting with "url".
1185 * The "asked" parameter is a URL that we asked curl to access, and must begin
1188 * The "got" parameter is the URL that curl reported to us as where we ended
1191 * Returns 1 if we updated the base url, 0 otherwise.
1193 * Our basic strategy is to compare "base" and "asked" to find the bits
1194 * specific to our request. We then strip those bits off of "got" to yield the
1195 * new base. So for example, if our base is "http://example.com/foo.git",
1196 * and we ask for "http://example.com/foo.git/info/refs", we might end up
1197 * with "https://other.example.com/foo.git/info/refs". We would want the
1198 * new URL to become "https://other.example.com/foo.git".
1200 * Note that this assumes a sane redirect scheme. It's entirely possible
1201 * in the example above to end up at a URL that does not even end in
1202 * "info/refs". In such a case we simply punt, as there is not much we can
1203 * do (and such a scheme is unlikely to represent a real git repository,
1204 * which means we are likely about to abort anyway).
1206 static int update_url_from_redirect(struct strbuf *base,
1208 const struct strbuf *got)
1213 if (!strcmp(asked, got->buf))
1216 if (!skip_prefix(asked, base->buf, &tail))
1217 die("BUG: update_url_from_redirect: %s is not a superset of %s",
1220 tail_len = strlen(tail);
1222 if (got->len < tail_len ||
1223 strcmp(tail, got->buf + got->len - tail_len))
1224 return 0; /* insane redirect scheme */
1227 strbuf_add(base, got->buf, got->len - tail_len);
1231 static int http_request_reauth(const char *url,
1232 void *result, int target,
1233 struct http_get_options *options)
1235 int ret = http_request(url, result, target, options);
1237 if (options && options->effective_url && options->base_url) {
1238 if (update_url_from_redirect(options->base_url,
1239 url, options->effective_url)) {
1240 credential_from_url(&http_auth, options->base_url->buf);
1241 url = options->effective_url->buf;
1245 if (ret != HTTP_REAUTH)
1249 * If we are using KEEP_ERROR, the previous request may have
1250 * put cruft into our output stream; we should clear it out before
1251 * making our next request. We only know how to do this for
1252 * the strbuf case, but that is enough to satisfy current callers.
1254 if (options && options->keep_error) {
1256 case HTTP_REQUEST_STRBUF:
1257 strbuf_reset(result);
1260 die("BUG: HTTP_KEEP_ERROR is only supported with strbufs");
1264 credential_fill(&http_auth);
1266 return http_request(url, result, target, options);
1269 int http_get_strbuf(const char *url,
1270 struct strbuf *result,
1271 struct http_get_options *options)
1273 return http_request_reauth(url, result, HTTP_REQUEST_STRBUF, options);
1277 * Downloads a URL and stores the result in the given file.
1279 * If a previous interrupted download is detected (i.e. a previous temporary
1280 * file is still around) the download is resumed.
1282 static int http_get_file(const char *url, const char *filename,
1283 struct http_get_options *options)
1286 struct strbuf tmpfile = STRBUF_INIT;
1289 strbuf_addf(&tmpfile, "%s.temp", filename);
1290 result = fopen(tmpfile.buf, "a");
1292 error("Unable to open local file %s", tmpfile.buf);
1297 ret = http_request_reauth(url, result, HTTP_REQUEST_FILE, options);
1300 if (ret == HTTP_OK && move_temp_to_file(tmpfile.buf, filename))
1303 strbuf_release(&tmpfile);
1307 int http_fetch_ref(const char *base, struct ref *ref)
1309 struct http_get_options options = {0};
1311 struct strbuf buffer = STRBUF_INIT;
1314 options.no_cache = 1;
1316 url = quote_ref_url(base, ref->name);
1317 if (http_get_strbuf(url, &buffer, &options) == HTTP_OK) {
1318 strbuf_rtrim(&buffer);
1319 if (buffer.len == 40)
1320 ret = get_sha1_hex(buffer.buf, ref->old_sha1);
1321 else if (starts_with(buffer.buf, "ref: ")) {
1322 ref->symref = xstrdup(buffer.buf + 5);
1327 strbuf_release(&buffer);
1332 /* Helpers for fetching packs */
1333 static char *fetch_pack_index(unsigned char *sha1, const char *base_url)
1336 struct strbuf buf = STRBUF_INIT;
1338 if (http_is_verbose)
1339 fprintf(stderr, "Getting index for pack %s\n", sha1_to_hex(sha1));
1341 end_url_with_slash(&buf, base_url);
1342 strbuf_addf(&buf, "objects/pack/pack-%s.idx", sha1_to_hex(sha1));
1343 url = strbuf_detach(&buf, NULL);
1345 strbuf_addf(&buf, "%s.temp", sha1_pack_index_name(sha1));
1346 tmp = strbuf_detach(&buf, NULL);
1348 if (http_get_file(url, tmp, NULL) != HTTP_OK) {
1349 error("Unable to get pack index %s", url);
1358 static int fetch_and_setup_pack_index(struct packed_git **packs_head,
1359 unsigned char *sha1, const char *base_url)
1361 struct packed_git *new_pack;
1362 char *tmp_idx = NULL;
1365 if (has_pack_index(sha1)) {
1366 new_pack = parse_pack_index(sha1, NULL);
1368 return -1; /* parse_pack_index() already issued error message */
1372 tmp_idx = fetch_pack_index(sha1, base_url);
1376 new_pack = parse_pack_index(sha1, tmp_idx);
1381 return -1; /* parse_pack_index() already issued error message */
1384 ret = verify_pack_index(new_pack);
1386 close_pack_index(new_pack);
1387 ret = move_temp_to_file(tmp_idx, sha1_pack_index_name(sha1));
1394 new_pack->next = *packs_head;
1395 *packs_head = new_pack;
1399 int http_get_info_packs(const char *base_url, struct packed_git **packs_head)
1401 struct http_get_options options = {0};
1404 struct strbuf buf = STRBUF_INIT;
1405 unsigned char sha1[20];
1407 end_url_with_slash(&buf, base_url);
1408 strbuf_addstr(&buf, "objects/info/packs");
1409 url = strbuf_detach(&buf, NULL);
1411 options.no_cache = 1;
1412 ret = http_get_strbuf(url, &buf, &options);
1417 while (i < buf.len) {
1421 if (i + 52 <= buf.len &&
1422 starts_with(data + i, " pack-") &&
1423 starts_with(data + i + 46, ".pack\n")) {
1424 get_sha1_hex(data + i + 6, sha1);
1425 fetch_and_setup_pack_index(packs_head, sha1,
1431 while (i < buf.len && data[i] != '\n')
1442 void release_http_pack_request(struct http_pack_request *preq)
1444 if (preq->packfile != NULL) {
1445 fclose(preq->packfile);
1446 preq->packfile = NULL;
1448 if (preq->range_header != NULL) {
1449 curl_slist_free_all(preq->range_header);
1450 preq->range_header = NULL;
1456 int finish_http_pack_request(struct http_pack_request *preq)
1458 struct packed_git **lst;
1459 struct packed_git *p = preq->target;
1461 struct child_process ip = CHILD_PROCESS_INIT;
1462 const char *ip_argv[8];
1464 close_pack_index(p);
1466 fclose(preq->packfile);
1467 preq->packfile = NULL;
1471 lst = &((*lst)->next);
1472 *lst = (*lst)->next;
1474 tmp_idx = xstrdup(preq->tmpfile);
1475 strcpy(tmp_idx + strlen(tmp_idx) - strlen(".pack.temp"),
1478 ip_argv[0] = "index-pack";
1480 ip_argv[2] = tmp_idx;
1481 ip_argv[3] = preq->tmpfile;
1489 if (run_command(&ip)) {
1490 unlink(preq->tmpfile);
1496 unlink(sha1_pack_index_name(p->sha1));
1498 if (move_temp_to_file(preq->tmpfile, sha1_pack_name(p->sha1))
1499 || move_temp_to_file(tmp_idx, sha1_pack_index_name(p->sha1))) {
1504 install_packed_git(p);
1509 struct http_pack_request *new_http_pack_request(
1510 struct packed_git *target, const char *base_url)
1513 char range[RANGE_HEADER_SIZE];
1514 struct strbuf buf = STRBUF_INIT;
1515 struct http_pack_request *preq;
1517 preq = xcalloc(1, sizeof(*preq));
1518 preq->target = target;
1520 end_url_with_slash(&buf, base_url);
1521 strbuf_addf(&buf, "objects/pack/pack-%s.pack",
1522 sha1_to_hex(target->sha1));
1523 preq->url = strbuf_detach(&buf, NULL);
1525 snprintf(preq->tmpfile, sizeof(preq->tmpfile), "%s.temp",
1526 sha1_pack_name(target->sha1));
1527 preq->packfile = fopen(preq->tmpfile, "a");
1528 if (!preq->packfile) {
1529 error("Unable to open local file %s for pack",
1534 preq->slot = get_active_slot();
1535 curl_easy_setopt(preq->slot->curl, CURLOPT_FILE, preq->packfile);
1536 curl_easy_setopt(preq->slot->curl, CURLOPT_WRITEFUNCTION, fwrite);
1537 curl_easy_setopt(preq->slot->curl, CURLOPT_URL, preq->url);
1538 curl_easy_setopt(preq->slot->curl, CURLOPT_HTTPHEADER,
1542 * If there is data present from a previous transfer attempt,
1543 * resume where it left off
1545 prev_posn = ftell(preq->packfile);
1547 if (http_is_verbose)
1549 "Resuming fetch of pack %s at byte %ld\n",
1550 sha1_to_hex(target->sha1), prev_posn);
1551 sprintf(range, "Range: bytes=%ld-", prev_posn);
1552 preq->range_header = curl_slist_append(NULL, range);
1553 curl_easy_setopt(preq->slot->curl, CURLOPT_HTTPHEADER,
1554 preq->range_header);
1565 /* Helpers for fetching objects (loose) */
1566 static size_t fwrite_sha1_file(char *ptr, size_t eltsize, size_t nmemb,
1569 unsigned char expn[4096];
1570 size_t size = eltsize * nmemb;
1572 struct http_object_request *freq =
1573 (struct http_object_request *)data;
1575 ssize_t retval = xwrite(freq->localfile,
1576 (char *) ptr + posn, size - posn);
1580 } while (posn < size);
1582 freq->stream.avail_in = size;
1583 freq->stream.next_in = (void *)ptr;
1585 freq->stream.next_out = expn;
1586 freq->stream.avail_out = sizeof(expn);
1587 freq->zret = git_inflate(&freq->stream, Z_SYNC_FLUSH);
1588 git_SHA1_Update(&freq->c, expn,
1589 sizeof(expn) - freq->stream.avail_out);
1590 } while (freq->stream.avail_in && freq->zret == Z_OK);
1594 struct http_object_request *new_http_object_request(const char *base_url,
1595 unsigned char *sha1)
1597 char *hex = sha1_to_hex(sha1);
1598 const char *filename;
1599 char prevfile[PATH_MAX];
1601 char prev_buf[PREV_BUF_SIZE];
1602 ssize_t prev_read = 0;
1604 char range[RANGE_HEADER_SIZE];
1605 struct curl_slist *range_header = NULL;
1606 struct http_object_request *freq;
1608 freq = xcalloc(1, sizeof(*freq));
1609 hashcpy(freq->sha1, sha1);
1610 freq->localfile = -1;
1612 filename = sha1_file_name(sha1);
1613 snprintf(freq->tmpfile, sizeof(freq->tmpfile),
1614 "%s.temp", filename);
1616 snprintf(prevfile, sizeof(prevfile), "%s.prev", filename);
1617 unlink_or_warn(prevfile);
1618 rename(freq->tmpfile, prevfile);
1619 unlink_or_warn(freq->tmpfile);
1621 if (freq->localfile != -1)
1622 error("fd leakage in start: %d", freq->localfile);
1623 freq->localfile = open(freq->tmpfile,
1624 O_WRONLY | O_CREAT | O_EXCL, 0666);
1626 * This could have failed due to the "lazy directory creation";
1627 * try to mkdir the last path component.
1629 if (freq->localfile < 0 && errno == ENOENT) {
1630 char *dir = strrchr(freq->tmpfile, '/');
1633 mkdir(freq->tmpfile, 0777);
1636 freq->localfile = open(freq->tmpfile,
1637 O_WRONLY | O_CREAT | O_EXCL, 0666);
1640 if (freq->localfile < 0) {
1641 error("Couldn't create temporary file %s: %s",
1642 freq->tmpfile, strerror(errno));
1646 git_inflate_init(&freq->stream);
1648 git_SHA1_Init(&freq->c);
1650 freq->url = get_remote_object_url(base_url, hex, 0);
1653 * If a previous temp file is present, process what was already
1656 prevlocal = open(prevfile, O_RDONLY);
1657 if (prevlocal != -1) {
1659 prev_read = xread(prevlocal, prev_buf, PREV_BUF_SIZE);
1661 if (fwrite_sha1_file(prev_buf,
1664 freq) == prev_read) {
1665 prev_posn += prev_read;
1670 } while (prev_read > 0);
1673 unlink_or_warn(prevfile);
1676 * Reset inflate/SHA1 if there was an error reading the previous temp
1677 * file; also rewind to the beginning of the local file.
1679 if (prev_read == -1) {
1680 memset(&freq->stream, 0, sizeof(freq->stream));
1681 git_inflate_init(&freq->stream);
1682 git_SHA1_Init(&freq->c);
1685 lseek(freq->localfile, 0, SEEK_SET);
1686 if (ftruncate(freq->localfile, 0) < 0) {
1687 error("Couldn't truncate temporary file %s: %s",
1688 freq->tmpfile, strerror(errno));
1694 freq->slot = get_active_slot();
1696 curl_easy_setopt(freq->slot->curl, CURLOPT_FILE, freq);
1697 curl_easy_setopt(freq->slot->curl, CURLOPT_WRITEFUNCTION, fwrite_sha1_file);
1698 curl_easy_setopt(freq->slot->curl, CURLOPT_ERRORBUFFER, freq->errorstr);
1699 curl_easy_setopt(freq->slot->curl, CURLOPT_URL, freq->url);
1700 curl_easy_setopt(freq->slot->curl, CURLOPT_HTTPHEADER, no_pragma_header);
1703 * If we have successfully processed data from a previous fetch
1704 * attempt, only fetch the data we don't already have.
1707 if (http_is_verbose)
1709 "Resuming fetch of object %s at byte %ld\n",
1711 sprintf(range, "Range: bytes=%ld-", prev_posn);
1712 range_header = curl_slist_append(range_header, range);
1713 curl_easy_setopt(freq->slot->curl,
1714 CURLOPT_HTTPHEADER, range_header);
1725 void process_http_object_request(struct http_object_request *freq)
1727 if (freq->slot == NULL)
1729 freq->curl_result = freq->slot->curl_result;
1730 freq->http_code = freq->slot->http_code;
1734 int finish_http_object_request(struct http_object_request *freq)
1738 close(freq->localfile);
1739 freq->localfile = -1;
1741 process_http_object_request(freq);
1743 if (freq->http_code == 416) {
1744 warning("requested range invalid; we may already have all the data.");
1745 } else if (freq->curl_result != CURLE_OK) {
1746 if (stat(freq->tmpfile, &st) == 0)
1747 if (st.st_size == 0)
1748 unlink_or_warn(freq->tmpfile);
1752 git_inflate_end(&freq->stream);
1753 git_SHA1_Final(freq->real_sha1, &freq->c);
1754 if (freq->zret != Z_STREAM_END) {
1755 unlink_or_warn(freq->tmpfile);
1758 if (hashcmp(freq->sha1, freq->real_sha1)) {
1759 unlink_or_warn(freq->tmpfile);
1763 move_temp_to_file(freq->tmpfile, sha1_file_name(freq->sha1));
1765 return freq->rename;
1768 void abort_http_object_request(struct http_object_request *freq)
1770 unlink_or_warn(freq->tmpfile);
1772 release_http_object_request(freq);
1775 void release_http_object_request(struct http_object_request *freq)
1777 if (freq->localfile != -1) {
1778 close(freq->localfile);
1779 freq->localfile = -1;
1781 if (freq->url != NULL) {
1785 if (freq->slot != NULL) {
1786 freq->slot->callback_func = NULL;
1787 freq->slot->callback_data = NULL;
1788 release_active_slot(freq->slot);