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 is not something Makefile should set nor users should pass
  17 * via CFLAGS.
  18 */
  19#undef USE_CURL_MULTI
  20
  21#if LIBCURL_VERSION_NUM >= 0x071000
  22#define USE_CURL_MULTI
  23#define DEFAULT_MAX_REQUESTS 5
  24#endif
  25
  26#if LIBCURL_VERSION_NUM < 0x070704
  27#define curl_global_cleanup() do { /* nothing */ } while (0)
  28#endif
  29#if LIBCURL_VERSION_NUM < 0x070800
  30#define curl_global_init(a) do { /* nothing */ } while (0)
  31#endif
  32
  33#if (LIBCURL_VERSION_NUM < 0x070c04) || (LIBCURL_VERSION_NUM == 0x071000)
  34#define NO_CURL_EASY_DUPHANDLE
  35#endif
  36
  37#if LIBCURL_VERSION_NUM < 0x070a03
  38#define CURLE_HTTP_RETURNED_ERROR CURLE_HTTP_NOT_FOUND
  39#endif
  40
  41#if LIBCURL_VERSION_NUM < 0x070c03
  42#define NO_CURL_IOCTL
  43#endif
  44
  45/*
  46 * CURLOPT_USE_SSL was known as CURLOPT_FTP_SSL up to 7.16.4,
  47 * and the constants were known as CURLFTPSSL_*
  48*/
  49#if !defined(CURLOPT_USE_SSL) && defined(CURLOPT_FTP_SSL)
  50#define CURLOPT_USE_SSL CURLOPT_FTP_SSL
  51#define CURLUSESSL_TRY CURLFTPSSL_TRY
  52#endif
  53
  54struct slot_results {
  55        CURLcode curl_result;
  56        long http_code;
  57        long auth_avail;
  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 */
  78extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  79extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  80extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  81#ifndef NO_CURL_IOCTL
  82extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
  83#endif
  84
  85/* Slot lifecycle functions */
  86extern struct active_request_slot *get_active_slot(void);
  87extern int start_active_slot(struct active_request_slot *slot);
  88extern void run_active_slot(struct active_request_slot *slot);
  89extern void finish_active_slot(struct active_request_slot *slot);
  90extern void finish_all_active_slots(void);
  91extern int handle_curl_result(struct slot_results *results);
  92
  93/*
  94 * This will run one slot to completion in a blocking manner, similar to how
  95 * curl_easy_perform would work (but we don't want to use that, because
  96 * we do not want to intermingle calls to curl_multi and curl_easy).
  97 *
  98 */
  99int run_one_slot(struct active_request_slot *slot,
 100                 struct slot_results *results);
 101
 102#ifdef USE_CURL_MULTI
 103extern void fill_active_slots(void);
 104extern void add_fill_function(void *data, int (*fill)(void *));
 105extern void step_active_slots(void);
 106#endif
 107
 108extern void http_init(struct remote *remote, const char *url,
 109                      int proactive_auth);
 110extern void http_cleanup(void);
 111
 112extern int active_requests;
 113extern int http_is_verbose;
 114extern size_t http_post_buffer;
 115extern struct credential http_auth;
 116
 117extern char curl_errorstr[CURL_ERROR_SIZE];
 118
 119static inline int missing__target(int code, int result)
 120{
 121        return  /* file:// URL -- do we ever use one??? */
 122                (result == CURLE_FILE_COULDNT_READ_FILE) ||
 123                /* http:// and https:// URL */
 124                (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
 125                /* ftp:// URL */
 126                (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
 127                ;
 128}
 129
 130#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
 131
 132/* Helpers for modifying and creating URLs */
 133extern void append_remote_object_url(struct strbuf *buf, const char *url,
 134                                     const char *hex,
 135                                     int only_two_digit_prefix);
 136extern char *get_remote_object_url(const char *url, const char *hex,
 137                                   int only_two_digit_prefix);
 138
 139/* Options for http_get_*() */
 140struct http_get_options {
 141        unsigned no_cache:1,
 142                 keep_error:1;
 143
 144        /* If non-NULL, returns the content-type of the response. */
 145        struct strbuf *content_type;
 146
 147        /*
 148         * If non-NULL, returns the URL we ended up at, including any
 149         * redirects we followed.
 150         */
 151        struct strbuf *effective_url;
 152
 153        /*
 154         * If both base_url and effective_url are non-NULL, the base URL will
 155         * be munged to reflect any redirections going from the requested url
 156         * to effective_url. See the definition of update_url_from_redirect
 157         * for details.
 158         */
 159        struct strbuf *base_url;
 160};
 161
 162/* Return values for http_get_*() */
 163#define HTTP_OK                 0
 164#define HTTP_MISSING_TARGET     1
 165#define HTTP_ERROR              2
 166#define HTTP_START_FAILED       3
 167#define HTTP_REAUTH     4
 168#define HTTP_NOAUTH     5
 169
 170/*
 171 * Requests a URL and stores the result in a strbuf.
 172 *
 173 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
 174 */
 175int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
 176
 177extern int http_fetch_ref(const char *base, struct ref *ref);
 178
 179/* Helpers for fetching packs */
 180extern int http_get_info_packs(const char *base_url,
 181        struct packed_git **packs_head);
 182
 183struct http_pack_request {
 184        char *url;
 185        struct packed_git *target;
 186        struct packed_git **lst;
 187        FILE *packfile;
 188        char tmpfile[PATH_MAX];
 189        struct curl_slist *range_header;
 190        struct active_request_slot *slot;
 191};
 192
 193extern struct http_pack_request *new_http_pack_request(
 194        struct packed_git *target, const char *base_url);
 195extern int finish_http_pack_request(struct http_pack_request *preq);
 196extern void release_http_pack_request(struct http_pack_request *preq);
 197
 198/* Helpers for fetching object */
 199struct http_object_request {
 200        char *url;
 201        char tmpfile[PATH_MAX];
 202        int localfile;
 203        CURLcode curl_result;
 204        char errorstr[CURL_ERROR_SIZE];
 205        long http_code;
 206        unsigned char sha1[20];
 207        unsigned char real_sha1[20];
 208        git_SHA_CTX c;
 209        git_zstream stream;
 210        int zret;
 211        int rename;
 212        struct active_request_slot *slot;
 213};
 214
 215extern struct http_object_request *new_http_object_request(
 216        const char *base_url, unsigned char *sha1);
 217extern void process_http_object_request(struct http_object_request *freq);
 218extern int finish_http_object_request(struct http_object_request *freq);
 219extern void abort_http_object_request(struct http_object_request *freq);
 220extern void release_http_object_request(struct http_object_request *freq);
 221
 222#endif /* HTTP_H */