Andrew's git - gitweb.git/blob

   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
  53struct slot_results {
  54        CURLcode curl_result;
  55        long http_code;
  56        long auth_avail;
  57        long http_connectcode;
  58};
  59
  60struct 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
  72struct buffer {
  73        struct strbuf buf;
  74        size_t posn;
  75};
  76
  77/* Curl request read/write callbacks */
  78size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  79size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  80size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  81#ifndef NO_CURL_IOCTL
  82curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
  83#endif
  84
  85/* Slot lifecycle functions */
  86struct active_request_slot *get_active_slot(void);
  87int start_active_slot(struct active_request_slot *slot);
  88void run_active_slot(struct active_request_slot *slot);
  89void 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 */
  97int run_one_slot(struct active_request_slot *slot,
  98                 struct slot_results *results);
  99
 100#ifdef USE_CURL_MULTI
 101void fill_active_slots(void);
 102void add_fill_function(void *data, int (*fill)(void *));
 103void step_active_slots(void);
 104#endif
 105
 106void http_init(struct remote *remote, const char *url,
 107               int proactive_auth);
 108void http_cleanup(void);
 109struct curl_slist *http_copy_default_headers(void);
 110
 111extern long int git_curl_ipresolve;
 112extern int active_requests;
 113extern int http_is_verbose;
 114extern ssize_t http_post_buffer;
 115extern struct credential http_auth;
 116
 117extern char curl_errorstr[CURL_ERROR_SIZE];
 118
 119enum http_follow_config {
 120        HTTP_FOLLOW_NONE,
 121        HTTP_FOLLOW_ALWAYS,
 122        HTTP_FOLLOW_INITIAL
 123};
 124extern enum http_follow_config http_follow_config;
 125
 126static 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/*
 140 * Normalize curl results to handle CURL_FAILONERROR (or lack thereof). Failing
 141 * http codes have their "result" converted to CURLE_HTTP_RETURNED_ERROR, and
 142 * an appropriate string placed in the errorstr buffer (pass curl_errorstr if
 143 * you don't have a custom buffer).
 144 */
 145void normalize_curl_result(CURLcode *result, long http_code, char *errorstr,
 146                           size_t errorlen);
 147
 148/* Helpers for modifying and creating URLs */
 149void append_remote_object_url(struct strbuf *buf, const char *url,
 150                              const char *hex,
 151                              int only_two_digit_prefix);
 152char *get_remote_object_url(const char *url, const char *hex,
 153                            int only_two_digit_prefix);
 154
 155/* Options for http_get_*() */
 156struct http_get_options {
 157        unsigned no_cache:1,
 158                 initial_request:1;
 159
 160        /* If non-NULL, returns the content-type of the response. */
 161        struct strbuf *content_type;
 162
 163        /*
 164         * If non-NULL, and content_type above is non-NULL, returns
 165         * the charset parameter from the content-type. If none is
 166         * present, returns an empty string.
 167         */
 168        struct strbuf *charset;
 169
 170        /*
 171         * If non-NULL, returns the URL we ended up at, including any
 172         * redirects we followed.
 173         */
 174        struct strbuf *effective_url;
 175
 176        /*
 177         * If both base_url and effective_url are non-NULL, the base URL will
 178         * be munged to reflect any redirections going from the requested url
 179         * to effective_url. See the definition of update_url_from_redirect
 180         * for details.
 181         */
 182        struct strbuf *base_url;
 183
 184        /*
 185         * If not NULL, contains additional HTTP headers to be sent with the
 186         * request. The strings in the list must not be freed until after the
 187         * request has completed.
 188         */
 189        struct string_list *extra_headers;
 190};
 191
 192/* Return values for http_get_*() */
 193#define HTTP_OK                 0
 194#define HTTP_MISSING_TARGET     1
 195#define HTTP_ERROR              2
 196#define HTTP_START_FAILED       3
 197#define HTTP_REAUTH     4
 198#define HTTP_NOAUTH     5
 199
 200/*
 201 * Requests a URL and stores the result in a strbuf.
 202 *
 203 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
 204 */
 205int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
 206
 207int http_fetch_ref(const char *base, struct ref *ref);
 208
 209/* Helpers for fetching packs */
 210int http_get_info_packs(const char *base_url,
 211                        struct packed_git **packs_head);
 212
 213struct http_pack_request {
 214        char *url;
 215        struct packed_git *target;
 216        struct packed_git **lst;
 217        FILE *packfile;
 218        struct strbuf tmpfile;
 219        struct active_request_slot *slot;
 220};
 221
 222struct http_pack_request *new_http_pack_request(
 223        struct packed_git *target, const char *base_url);
 224int finish_http_pack_request(struct http_pack_request *preq);
 225void release_http_pack_request(struct http_pack_request *preq);
 226
 227/* Helpers for fetching object */
 228struct http_object_request {
 229        char *url;
 230        struct strbuf tmpfile;
 231        int localfile;
 232        CURLcode curl_result;
 233        char errorstr[CURL_ERROR_SIZE];
 234        long http_code;
 235        struct object_id oid;
 236        struct object_id real_oid;
 237        git_hash_ctx c;
 238        git_zstream stream;
 239        int zret;
 240        int rename;
 241        struct active_request_slot *slot;
 242};
 243
 244struct http_object_request *new_http_object_request(
 245        const char *base_url, const struct object_id *oid);
 246void process_http_object_request(struct http_object_request *freq);
 247int finish_http_object_request(struct http_object_request *freq);
 248void abort_http_object_request(struct http_object_request *freq);
 249void release_http_object_request(struct http_object_request *freq);
 250
 251/* setup routine for curl_easy_setopt CURLOPT_DEBUGFUNCTION */
 252void setup_curl_trace(CURL *handle);
 253#endif /* HTTP_H */