Andrew's git / gitweb.git / http.h
?
http.hon commit First batch for 2.5 cycle (8440f74)
   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_all_active_slots(void);
  89
  90/*
  91 * This will run one slot to completion in a blocking manner, similar to how
  92 * curl_easy_perform would work (but we don't want to use that, because
  93 * we do not want to intermingle calls to curl_multi and curl_easy).
  94 *
  95 */
  96int run_one_slot(struct active_request_slot *slot,
  97                 struct slot_results *results);
  98
  99#ifdef USE_CURL_MULTI
 100extern void fill_active_slots(void);
 101extern void add_fill_function(void *data, int (*fill)(void *));
 102extern void step_active_slots(void);
 103#endif
 104
 105extern void http_init(struct remote *remote, const char *url,
 106                      int proactive_auth);
 107extern void http_cleanup(void);
 108
 109extern int active_requests;
 110extern int http_is_verbose;
 111extern size_t http_post_buffer;
 112extern struct credential http_auth;
 113
 114extern char curl_errorstr[CURL_ERROR_SIZE];
 115
 116static inline int missing__target(int code, int result)
 117{
 118        return  /* file:// URL -- do we ever use one??? */
 119                (result == CURLE_FILE_COULDNT_READ_FILE) ||
 120                /* http:// and https:// URL */
 121                (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
 122                /* ftp:// URL */
 123                (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
 124                ;
 125}
 126
 127#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
 128
 129/* Helpers for modifying and creating URLs */
 130extern void append_remote_object_url(struct strbuf *buf, const char *url,
 131                                     const char *hex,
 132                                     int only_two_digit_prefix);
 133extern char *get_remote_object_url(const char *url, const char *hex,
 134                                   int only_two_digit_prefix);
 135
 136/* Options for http_get_*() */
 137struct http_get_options {
 138        unsigned no_cache:1,
 139                 keep_error:1;
 140
 141        /* If non-NULL, returns the content-type of the response. */
 142        struct strbuf *content_type;
 143
 144        /*
 145         * If non-NULL, and content_type above is non-NULL, returns
 146         * the charset parameter from the content-type. If none is
 147         * present, returns an empty string.
 148         */
 149        struct strbuf *charset;
 150
 151        /*
 152         * If non-NULL, returns the URL we ended up at, including any
 153         * redirects we followed.
 154         */
 155        struct strbuf *effective_url;
 156
 157        /*
 158         * If both base_url and effective_url are non-NULL, the base URL will
 159         * be munged to reflect any redirections going from the requested url
 160         * to effective_url. See the definition of update_url_from_redirect
 161         * for details.
 162         */
 163        struct strbuf *base_url;
 164};
 165
 166/* Return values for http_get_*() */
 167#define HTTP_OK                 0
 168#define HTTP_MISSING_TARGET     1
 169#define HTTP_ERROR              2
 170#define HTTP_START_FAILED       3
 171#define HTTP_REAUTH     4
 172#define HTTP_NOAUTH     5
 173
 174/*
 175 * Requests a URL and stores the result in a strbuf.
 176 *
 177 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
 178 */
 179int http_get_strbuf(const char *url, struct strbuf *result, struct http_get_options *options);
 180
 181extern int http_fetch_ref(const char *base, struct ref *ref);
 182
 183/* Helpers for fetching packs */
 184extern int http_get_info_packs(const char *base_url,
 185        struct packed_git **packs_head);
 186
 187struct http_pack_request {
 188        char *url;
 189        struct packed_git *target;
 190        struct packed_git **lst;
 191        FILE *packfile;
 192        char tmpfile[PATH_MAX];
 193        struct curl_slist *range_header;
 194        struct active_request_slot *slot;
 195};
 196
 197extern struct http_pack_request *new_http_pack_request(
 198        struct packed_git *target, const char *base_url);
 199extern int finish_http_pack_request(struct http_pack_request *preq);
 200extern void release_http_pack_request(struct http_pack_request *preq);
 201
 202/* Helpers for fetching object */
 203struct http_object_request {
 204        char *url;
 205        char tmpfile[PATH_MAX];
 206        int localfile;
 207        CURLcode curl_result;
 208        char errorstr[CURL_ERROR_SIZE];
 209        long http_code;
 210        unsigned char sha1[20];
 211        unsigned char real_sha1[20];
 212        git_SHA_CTX c;
 213        git_zstream stream;
 214        int zret;
 215        int rename;
 216        struct active_request_slot *slot;
 217};
 218
 219extern struct http_object_request *new_http_object_request(
 220        const char *base_url, unsigned char *sha1);
 221extern void process_http_object_request(struct http_object_request *freq);
 222extern int finish_http_object_request(struct http_object_request *freq);
 223extern void abort_http_object_request(struct http_object_request *freq);
 224extern void release_http_object_request(struct http_object_request *freq);
 225
 226#endif /* HTTP_H */