Andrew's git / gitweb.git / http.h
?
http.hon commit Merge branch 'jl/nor-or-nand-and' (d59c12d)
   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};
  58
  59struct active_request_slot {
  60        CURL *curl;
  61        int in_use;
  62        CURLcode curl_result;
  63        long http_code;
  64        int *finished;
  65        struct slot_results *results;
  66        void *callback_data;
  67        void (*callback_func)(void *data);
  68        struct active_request_slot *next;
  69};
  70
  71struct buffer {
  72        struct strbuf buf;
  73        size_t posn;
  74};
  75
  76/* Curl request read/write callbacks */
  77extern size_t fread_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  78extern size_t fwrite_buffer(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  79extern size_t fwrite_null(char *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  80#ifndef NO_CURL_IOCTL
  81extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
  82#endif
  83
  84/* Slot lifecycle functions */
  85extern struct active_request_slot *get_active_slot(void);
  86extern int start_active_slot(struct active_request_slot *slot);
  87extern void run_active_slot(struct active_request_slot *slot);
  88extern void finish_active_slot(struct active_request_slot *slot);
  89extern void finish_all_active_slots(void);
  90extern int handle_curl_result(struct slot_results *results);
  91
  92/*
  93 * This will run one slot to completion in a blocking manner, similar to how
  94 * curl_easy_perform would work (but we don't want to use that, because
  95 * we do not want to intermingle calls to curl_multi and curl_easy).
  96 *
  97 */
  98int run_one_slot(struct active_request_slot *slot,
  99                 struct slot_results *results);
 100
 101#ifdef USE_CURL_MULTI
 102extern void fill_active_slots(void);
 103extern void add_fill_function(void *data, int (*fill)(void *));
 104extern void step_active_slots(void);
 105#endif
 106
 107extern void http_init(struct remote *remote, const char *url,
 108                      int proactive_auth);
 109extern void http_cleanup(void);
 110
 111extern int active_requests;
 112extern int http_is_verbose;
 113extern size_t http_post_buffer;
 114extern struct credential http_auth;
 115
 116extern char curl_errorstr[CURL_ERROR_SIZE];
 117
 118static inline int missing__target(int code, int result)
 119{
 120        return  /* file:// URL -- do we ever use one??? */
 121                (result == CURLE_FILE_COULDNT_READ_FILE) ||
 122                /* http:// and https:// URL */
 123                (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
 124                /* ftp:// URL */
 125                (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
 126                ;
 127}
 128
 129#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
 130
 131/* Helpers for modifying and creating URLs */
 132extern void append_remote_object_url(struct strbuf *buf, const char *url,
 133                                     const char *hex,
 134                                     int only_two_digit_prefix);
 135extern char *get_remote_object_url(const char *url, const char *hex,
 136                                   int only_two_digit_prefix);
 137
 138/* Options for http_get_*() */
 139struct http_get_options {
 140        unsigned no_cache:1,
 141                 keep_error:1;
 142
 143        /* If non-NULL, returns the content-type of the response. */
 144        struct strbuf *content_type;
 145
 146        /*
 147         * If non-NULL, returns the URL we ended up at, including any
 148         * redirects we followed.
 149         */
 150        struct strbuf *effective_url;
 151
 152        /*
 153         * If both base_url and effective_url are non-NULL, the base URL will
 154         * be munged to reflect any redirections going from the requested url
 155         * to effective_url. See the definition of update_url_from_redirect
 156         * for details.
 157         */
 158        struct strbuf *base_url;
 159};
 160
 161/* Return values for http_get_*() */
 162#define HTTP_OK                 0
 163#define HTTP_MISSING_TARGET     1
 164#define HTTP_ERROR              2
 165#define HTTP_START_FAILED       3
 166#define HTTP_REAUTH     4
 167#define HTTP_NOAUTH     5
 168
 169/*
 170 * Requests a URL and stores the result in a strbuf.
 171 *
 172 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
 173 */
 174int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
 175
 176extern int http_fetch_ref(const char *base, struct ref *ref);
 177
 178/* Helpers for fetching packs */
 179extern int http_get_info_packs(const char *base_url,
 180        struct packed_git **packs_head);
 181
 182struct http_pack_request {
 183        char *url;
 184        struct packed_git *target;
 185        struct packed_git **lst;
 186        FILE *packfile;
 187        char tmpfile[PATH_MAX];
 188        struct curl_slist *range_header;
 189        struct active_request_slot *slot;
 190};
 191
 192extern struct http_pack_request *new_http_pack_request(
 193        struct packed_git *target, const char *base_url);
 194extern int finish_http_pack_request(struct http_pack_request *preq);
 195extern void release_http_pack_request(struct http_pack_request *preq);
 196
 197/* Helpers for fetching object */
 198struct http_object_request {
 199        char *url;
 200        char tmpfile[PATH_MAX];
 201        int localfile;
 202        CURLcode curl_result;
 203        char errorstr[CURL_ERROR_SIZE];
 204        long http_code;
 205        unsigned char sha1[20];
 206        unsigned char real_sha1[20];
 207        git_SHA_CTX c;
 208        git_zstream stream;
 209        int zret;
 210        int rename;
 211        struct active_request_slot *slot;
 212};
 213
 214extern struct http_object_request *new_http_object_request(
 215        const char *base_url, unsigned char *sha1);
 216extern void process_http_object_request(struct http_object_request *freq);
 217extern int finish_http_object_request(struct http_object_request *freq);
 218extern void abort_http_object_request(struct http_object_request *freq);
 219extern void release_http_object_request(struct http_object_request *freq);
 220
 221#endif /* HTTP_H */