Merge branch 'ye/http-accept-language'
authorJunio C Hamano <gitster@pobox.com>
Wed, 18 Feb 2015 19:44:57 +0000 (11:44 -0800)
committerJunio C Hamano <gitster@pobox.com>
Wed, 18 Feb 2015 19:44:57 +0000 (11:44 -0800)
Using environment variable LANGUAGE and friends on the client side,
HTTP-based transports now send Accept-Language when making requests.

* ye/http-accept-language:
http: add Accept-Language header if possible

1  2 
http.c
remote-curl.c
t/t5550-http-fetch-dumb.sh
diff --combined http.c
index 2cdf67d8307f3067673324647e681b0874565d55,8b659b66963c38c84c498a0850105e68668b1e16..efdab0979692153f016bdf1fdb1a2e782738f1bc
--- 1/http.c
--- 2/http.c
+++ b/http.c
@@@ -62,15 -62,14 +62,17 @@@ static const char *user_agent
  
  static struct credential cert_auth = CREDENTIAL_INIT;
  static int ssl_cert_password_required;
 +#ifdef LIBCURL_CAN_HANDLE_AUTH_ANY
 +static unsigned long http_auth_methods = CURLAUTH_ANY;
 +#endif
  
  static struct curl_slist *pragma_header;
  static struct curl_slist *no_pragma_header;
  
  static struct active_request_slot *active_queue_head;
  
+ static char *cached_accept_language;
  size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *buffer_)
  {
        size_t size = eltsize * nmemb;
@@@ -117,37 -116,6 +119,37 @@@ size_t fwrite_null(char *ptr, size_t el
        return eltsize * nmemb;
  }
  
 +static void closedown_active_slot(struct active_request_slot *slot)
 +{
 +      active_requests--;
 +      slot->in_use = 0;
 +}
 +
 +static void finish_active_slot(struct active_request_slot *slot)
 +{
 +      closedown_active_slot(slot);
 +      curl_easy_getinfo(slot->curl, CURLINFO_HTTP_CODE, &slot->http_code);
 +
 +      if (slot->finished != NULL)
 +              (*slot->finished) = 1;
 +
 +      /* Store slot results so they can be read after the slot is reused */
 +      if (slot->results != NULL) {
 +              slot->results->curl_result = slot->curl_result;
 +              slot->results->http_code = slot->http_code;
 +#if LIBCURL_VERSION_NUM >= 0x070a08
 +              curl_easy_getinfo(slot->curl, CURLINFO_HTTPAUTH_AVAIL,
 +                                &slot->results->auth_avail);
 +#else
 +              slot->results->auth_avail = 0;
 +#endif
 +      }
 +
 +      /* Run callback if appropriate */
 +      if (slot->callback_func != NULL)
 +              slot->callback_func(slot->callback_data);
 +}
 +
  #ifdef USE_CURL_MULTI
  static void process_curl_messages(void)
  {
@@@ -549,6 -517,9 +551,9 @@@ void http_cleanup(void
                cert_auth.password = NULL;
        }
        ssl_cert_password_required = 0;
+       free(cached_accept_language);
+       cached_accept_language = NULL;
  }
  
  struct active_request_slot *get_active_slot(void)
        curl_easy_setopt(slot->curl, CURLOPT_UPLOAD, 0);
        curl_easy_setopt(slot->curl, CURLOPT_HTTPGET, 1);
        curl_easy_setopt(slot->curl, CURLOPT_FAILONERROR, 1);
 +#ifdef LIBCURL_CAN_HANDLE_AUTH_ANY
 +      curl_easy_setopt(slot->curl, CURLOPT_HTTPAUTH, http_auth_methods);
 +#endif
        if (http_auth.password)
                init_curl_http_auth(slot->curl);
  
@@@ -767,6 -735,12 +772,6 @@@ void run_active_slot(struct active_requ
  #endif
  }
  
 -static void closedown_active_slot(struct active_request_slot *slot)
 -{
 -      active_requests--;
 -      slot->in_use = 0;
 -}
 -
  static void release_active_slot(struct active_request_slot *slot)
  {
        closedown_active_slot(slot);
  #endif
  }
  
 -void finish_active_slot(struct active_request_slot *slot)
 -{
 -      closedown_active_slot(slot);
 -      curl_easy_getinfo(slot->curl, CURLINFO_HTTP_CODE, &slot->http_code);
 -
 -      if (slot->finished != NULL)
 -              (*slot->finished) = 1;
 -
 -      /* Store slot results so they can be read after the slot is reused */
 -      if (slot->results != NULL) {
 -              slot->results->curl_result = slot->curl_result;
 -              slot->results->http_code = slot->http_code;
 -#if LIBCURL_VERSION_NUM >= 0x070a08
 -              curl_easy_getinfo(slot->curl, CURLINFO_HTTPAUTH_AVAIL,
 -                                &slot->results->auth_avail);
 -#else
 -              slot->results->auth_avail = 0;
 -#endif
 -      }
 -
 -      /* Run callback if appropriate */
 -      if (slot->callback_func != NULL)
 -              slot->callback_func(slot->callback_data);
 -}
 -
  void finish_all_active_slots(void)
  {
        struct active_request_slot *slot = active_queue_head;
@@@ -845,7 -844,7 +850,7 @@@ char *get_remote_object_url(const char 
        return strbuf_detach(&buf, NULL);
  }
  
 -int handle_curl_result(struct slot_results *results)
 +static int handle_curl_result(struct slot_results *results)
  {
        /*
         * If we see a failing http code with CURLE_OK, we have turned off
                        credential_reject(&http_auth);
                        return HTTP_NOAUTH;
                } else {
 +#ifdef LIBCURL_CAN_HANDLE_AUTH_ANY
 +                      http_auth_methods &= ~CURLAUTH_GSSNEGOTIATE;
 +#endif
                        return HTTP_REAUTH;
                }
        } else {
@@@ -995,7 -991,142 +1000,143 @@@ static void extract_content_type(struc
                strbuf_addstr(charset, "ISO-8859-1");
  }
  
 +
+ /*
+  * Guess the user's preferred languages from the value in LANGUAGE environment
+  * variable and LC_MESSAGES locale category if NO_GETTEXT is not defined.
+  *
+  * The result can be a colon-separated list like "ko:ja:en".
+  */
+ static const char *get_preferred_languages(void)
+ {
+       const char *retval;
+       retval = getenv("LANGUAGE");
+       if (retval && *retval)
+               return retval;
+ #ifndef NO_GETTEXT
+       retval = setlocale(LC_MESSAGES, NULL);
+       if (retval && *retval &&
+               strcmp(retval, "C") &&
+               strcmp(retval, "POSIX"))
+               return retval;
+ #endif
+       return NULL;
+ }
+ static void write_accept_language(struct strbuf *buf)
+ {
+       /*
+        * MAX_DECIMAL_PLACES must not be larger than 3. If it is larger than
+        * that, q-value will be smaller than 0.001, the minimum q-value the
+        * HTTP specification allows. See
+        * http://tools.ietf.org/html/rfc7231#section-5.3.1 for q-value.
+        */
+       const int MAX_DECIMAL_PLACES = 3;
+       const int MAX_LANGUAGE_TAGS = 1000;
+       const int MAX_ACCEPT_LANGUAGE_HEADER_SIZE = 4000;
+       char **language_tags = NULL;
+       int num_langs = 0;
+       const char *s = get_preferred_languages();
+       int i;
+       struct strbuf tag = STRBUF_INIT;
+       /* Don't add Accept-Language header if no language is preferred. */
+       if (!s)
+               return;
+       /*
+        * Split the colon-separated string of preferred languages into
+        * language_tags array.
+        */
+       do {
+               /* collect language tag */
+               for (; *s && (isalnum(*s) || *s == '_'); s++)
+                       strbuf_addch(&tag, *s == '_' ? '-' : *s);
+               /* skip .codeset, @modifier and any other unnecessary parts */
+               while (*s && *s != ':')
+                       s++;
+               if (tag.len) {
+                       num_langs++;
+                       REALLOC_ARRAY(language_tags, num_langs);
+                       language_tags[num_langs - 1] = strbuf_detach(&tag, NULL);
+                       if (num_langs >= MAX_LANGUAGE_TAGS - 1) /* -1 for '*' */
+                               break;
+               }
+       } while (*s++);
+       /* write Accept-Language header into buf */
+       if (num_langs) {
+               int last_buf_len = 0;
+               int max_q;
+               int decimal_places;
+               char q_format[32];
+               /* add '*' */
+               REALLOC_ARRAY(language_tags, num_langs + 1);
+               language_tags[num_langs++] = "*"; /* it's OK; this won't be freed */
+               /* compute decimal_places */
+               for (max_q = 1, decimal_places = 0;
+                    max_q < num_langs && decimal_places <= MAX_DECIMAL_PLACES;
+                    decimal_places++, max_q *= 10)
+                       ;
+               sprintf(q_format, ";q=0.%%0%dd", decimal_places);
+               strbuf_addstr(buf, "Accept-Language: ");
+               for (i = 0; i < num_langs; i++) {
+                       if (i > 0)
+                               strbuf_addstr(buf, ", ");
+                       strbuf_addstr(buf, language_tags[i]);
+                       if (i > 0)
+                               strbuf_addf(buf, q_format, max_q - i);
+                       if (buf->len > MAX_ACCEPT_LANGUAGE_HEADER_SIZE) {
+                               strbuf_remove(buf, last_buf_len, buf->len - last_buf_len);
+                               break;
+                       }
+                       last_buf_len = buf->len;
+               }
+       }
+       /* free language tags -- last one is a static '*' */
+       for (i = 0; i < num_langs - 1; i++)
+               free(language_tags[i]);
+       free(language_tags);
+ }
+ /*
+  * Get an Accept-Language header which indicates user's preferred languages.
+  *
+  * Examples:
+  *   LANGUAGE= -> ""
+  *   LANGUAGE=ko:en -> "Accept-Language: ko, en; q=0.9, *; q=0.1"
+  *   LANGUAGE=ko_KR.UTF-8:sr@latin -> "Accept-Language: ko-KR, sr; q=0.9, *; q=0.1"
+  *   LANGUAGE=ko LANG=en_US.UTF-8 -> "Accept-Language: ko, *; q=0.1"
+  *   LANGUAGE= LANG=en_US.UTF-8 -> "Accept-Language: en-US, *; q=0.1"
+  *   LANGUAGE= LANG=C -> ""
+  */
+ static const char *get_accept_language(void)
+ {
+       if (!cached_accept_language) {
+               struct strbuf buf = STRBUF_INIT;
+               write_accept_language(&buf);
+               if (buf.len > 0)
+                       cached_accept_language = strbuf_detach(&buf, NULL);
+       }
+       return cached_accept_language;
+ }
  /* http_request() targets */
  #define HTTP_REQUEST_STRBUF   0
  #define HTTP_REQUEST_FILE     1
@@@ -1008,6 -1139,7 +1149,7 @@@ static int http_request(const char *url
        struct slot_results results;
        struct curl_slist *headers = NULL;
        struct strbuf buf = STRBUF_INIT;
+       const char *accept_language;
        int ret;
  
        slot = get_active_slot();
                                         fwrite_buffer);
        }
  
+       accept_language = get_accept_language();
+       if (accept_language)
+               headers = curl_slist_append(headers, accept_language);
        strbuf_addstr(&buf, "Pragma:");
        if (options && options->no_cache)
                strbuf_addstr(&buf, " no-cache");
@@@ -1250,7 -1387,7 +1397,7 @@@ static int fetch_and_setup_pack_index(s
        int ret;
  
        if (has_pack_index(sha1)) {
 -              new_pack = parse_pack_index(sha1, NULL);
 +              new_pack = parse_pack_index(sha1, sha1_pack_index_name(sha1));
                if (!new_pack)
                        return -1; /* parse_pack_index() already issued error message */
                goto add_pack;
diff --combined remote-curl.c
index 515ac9b411a211936a575628706a30ea4a2ccc3f,04989e5d7ef56b5d320465a584c76355b871560a..deb4bfe684512ea48fbc0d2663270e44722db26b
@@@ -760,7 -760,7 +760,7 @@@ static int fetch_git(struct discovery *
  
        for (i = 0; i < nr_heads; i++) {
                struct ref *ref = to_fetch[i];
 -              if (!ref->name || !*ref->name)
 +              if (!*ref->name)
                        die("cannot fetch by sha1 over smart http");
                packet_buf_write(&preamble, "%s %s\n",
                                 sha1_to_hex(ref->old_sha1), ref->name);
@@@ -962,6 -962,8 +962,8 @@@ int main(int argc, const char **argv
        struct strbuf buf = STRBUF_INIT;
        int nongit;
  
+       git_setup_gettext();
        git_extract_argv0_path(argv[0]);
        setup_git_directory_gently(&nongit);
        if (argc < 2) {
index 6da942243101c4f5358b4aaf3c62cf6390c258b4,e1e29381feb7209487e77a374bd32e8b15d36482..2731ad4cea951744ea82b94a038a71ef01a228a2
@@@ -165,24 -165,6 +165,24 @@@ test_expect_success 'fetch notices corr
        )
  '
  
 +test_expect_success 'fetch can handle previously-fetched .idx files' '
 +      git checkout --orphan branch1 &&
 +      echo base >file &&
 +      git add file &&
 +      git commit -m base &&
 +      git --bare init "$HTTPD_DOCUMENT_ROOT_PATH"/repo_packed_branches.git &&
 +      git push "$HTTPD_DOCUMENT_ROOT_PATH"/repo_packed_branches.git branch1 &&
 +      git --git-dir="$HTTPD_DOCUMENT_ROOT_PATH"/repo_packed_branches.git repack -d &&
 +      git checkout -b branch2 branch1 &&
 +      echo b2 >>file &&
 +      git commit -a -m b2 &&
 +      git push "$HTTPD_DOCUMENT_ROOT_PATH"/repo_packed_branches.git branch2 &&
 +      git --git-dir="$HTTPD_DOCUMENT_ROOT_PATH"/repo_packed_branches.git repack -d &&
 +      git --bare init clone_packed_branches.git &&
 +      git --git-dir=clone_packed_branches.git fetch "$HTTPD_URL"/dumb/repo_packed_branches.git branch1:branch1 &&
 +      git --git-dir=clone_packed_branches.git fetch "$HTTPD_URL"/dumb/repo_packed_branches.git branch2:branch2
 +'
 +
  test_expect_success 'did not use upload-pack service' '
        grep '/git-upload-pack' <"$HTTPD_ROOT_PATH"/access.log >act
        : >exp
@@@ -214,5 -196,47 +214,47 @@@ test_expect_success 'reencoding is robu
        grep "this is the error message" stderr
  '
  
+ check_language () {
+       case "$2" in
+       '')
+               >expect
+               ;;
+       ?*)
+               echo "Accept-Language: $1" >expect
+               ;;
+       esac &&
+       GIT_CURL_VERBOSE=1 \
+       LANGUAGE=$2 \
+       git ls-remote "$HTTPD_URL/dumb/repo.git" >output 2>&1 &&
+       tr -d '\015' <output |
+       sort -u |
+       sed -ne '/^Accept-Language:/ p' >actual &&
+       test_cmp expect actual
+ }
+ test_expect_success 'git client sends Accept-Language based on LANGUAGE' '
+       check_language "ko-KR, *;q=0.9" ko_KR.UTF-8'
+ test_expect_success 'git client sends Accept-Language correctly with unordinary LANGUAGE' '
+       check_language "ko-KR, *;q=0.9" "ko_KR:" &&
+       check_language "ko-KR, en-US;q=0.9, *;q=0.8" "ko_KR::en_US" &&
+       check_language "ko-KR, *;q=0.9" ":::ko_KR" &&
+       check_language "ko-KR, en-US;q=0.9, *;q=0.8" "ko_KR!!:en_US" &&
+       check_language "ko-KR, ja-JP;q=0.9, *;q=0.8" "ko_KR en_US:ja_JP"'
+ test_expect_success 'git client sends Accept-Language with many preferred languages' '
+       check_language "ko-KR, en-US;q=0.9, fr-CA;q=0.8, de;q=0.7, sr;q=0.6, \
+ ja;q=0.5, zh;q=0.4, sv;q=0.3, pt;q=0.2, *;q=0.1" \
+               ko_KR.EUC-KR:en_US.UTF-8:fr_CA:de.UTF-8@euro:sr@latin:ja:zh:sv:pt &&
+       check_language "ko-KR, en-US;q=0.99, fr-CA;q=0.98, de;q=0.97, sr;q=0.96, \
+ ja;q=0.95, zh;q=0.94, sv;q=0.93, pt;q=0.92, nb;q=0.91, *;q=0.90" \
+               ko_KR.EUC-KR:en_US.UTF-8:fr_CA:de.UTF-8@euro:sr@latin:ja:zh:sv:pt:nb
+ '
+ test_expect_success 'git client does not send an empty Accept-Language' '
+       GIT_CURL_VERBOSE=1 LANGUAGE= git ls-remote "$HTTPD_URL/dumb/repo.git" 2>stderr &&
+       ! grep "^Accept-Language:" stderr
+ '
  stop_httpd
  test_done