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
  12/*
  13 * We detect based on the cURL version if multi-transfer is
  14 * usable in this implementation and define this symbol accordingly.
  15 * This is not something Makefile should set nor users should pass
  16 * 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
  44struct slot_results
  45{
  46        CURLcode curl_result;
  47        long http_code;
  48};
  49
  50struct active_request_slot
  51{
  52        CURL *curl;
  53        FILE *local;
  54        int in_use;
  55        CURLcode curl_result;
  56        long http_code;
  57        int *finished;
  58        struct slot_results *results;
  59        void *callback_data;
  60        void (*callback_func)(void *data);
  61        struct active_request_slot *next;
  62};
  63
  64struct buffer
  65{
  66        struct strbuf buf;
  67        size_t posn;
  68};
  69
  70/* Curl request read/write callbacks */
  71extern size_t fread_buffer(void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  72extern size_t fwrite_buffer(const void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  73extern size_t fwrite_null(const void *ptr, size_t eltsize, size_t nmemb, void *strbuf);
  74#ifndef NO_CURL_IOCTL
  75extern curlioerr ioctl_buffer(CURL *handle, int cmd, void *clientp);
  76#endif
  77
  78/* Slot lifecycle functions */
  79extern struct active_request_slot *get_active_slot(void);
  80extern int start_active_slot(struct active_request_slot *slot);
  81extern void run_active_slot(struct active_request_slot *slot);
  82extern void finish_all_active_slots(void);
  83extern void release_active_slot(struct active_request_slot *slot);
  84
  85#ifdef USE_CURL_MULTI
  86extern void fill_active_slots(void);
  87extern void add_fill_function(void *data, int (*fill)(void *));
  88extern void step_active_slots(void);
  89#endif
  90
  91extern void http_init(struct remote *remote);
  92extern void http_cleanup(void);
  93
  94extern int data_received;
  95extern int active_requests;
  96extern int http_is_verbose;
  97
  98extern char curl_errorstr[CURL_ERROR_SIZE];
  99
 100static inline int missing__target(int code, int result)
 101{
 102        return  /* file:// URL -- do we ever use one??? */
 103                (result == CURLE_FILE_COULDNT_READ_FILE) ||
 104                /* http:// and https:// URL */
 105                (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
 106                /* ftp:// URL */
 107                (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
 108                ;
 109}
 110
 111#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
 112
 113/* Helpers for modifying and creating URLs */
 114extern void append_remote_object_url(struct strbuf *buf, const char *url,
 115                                     const char *hex,
 116                                     int only_two_digit_prefix);
 117extern char *get_remote_object_url(const char *url, const char *hex,
 118                                   int only_two_digit_prefix);
 119
 120/* Options for http_request_*() */
 121#define HTTP_NO_CACHE           1
 122
 123/* Return values for http_request_*() */
 124#define HTTP_OK                 0
 125#define HTTP_MISSING_TARGET     1
 126#define HTTP_ERROR              2
 127#define HTTP_START_FAILED       3
 128
 129/*
 130 * Requests an url and stores the result in a strbuf.
 131 *
 132 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
 133 */
 134int http_get_strbuf(const char *url, struct strbuf *result, int options);
 135
 136/*
 137 * Downloads an url and stores the result in the given file.
 138 *
 139 * If a previous interrupted download is detected (i.e. a previous temporary
 140 * file is still around) the download is resumed.
 141 */
 142int http_get_file(const char *url, const char *filename, int options);
 143
 144/*
 145 * Prints an error message using error() containing url and curl_errorstr,
 146 * and returns ret.
 147 */
 148int http_error(const char *url, int ret);
 149
 150extern int http_fetch_ref(const char *base, struct ref *ref);
 151
 152/* Helpers for fetching packs */
 153extern int http_get_info_packs(const char *base_url,
 154        struct packed_git **packs_head);
 155
 156struct http_pack_request
 157{
 158        char *url;
 159        struct packed_git *target;
 160        struct packed_git **lst;
 161        FILE *packfile;
 162        char filename[PATH_MAX];
 163        char tmpfile[PATH_MAX];
 164        struct curl_slist *range_header;
 165        struct active_request_slot *slot;
 166};
 167
 168extern struct http_pack_request *new_http_pack_request(
 169        struct packed_git *target, const char *base_url);
 170extern int finish_http_pack_request(struct http_pack_request *preq);
 171extern void release_http_pack_request(struct http_pack_request *preq);
 172
 173/* Helpers for fetching object */
 174struct http_object_request
 175{
 176        char *url;
 177        char filename[PATH_MAX];
 178        char tmpfile[PATH_MAX];
 179        int localfile;
 180        CURLcode curl_result;
 181        char errorstr[CURL_ERROR_SIZE];
 182        long http_code;
 183        unsigned char sha1[20];
 184        unsigned char real_sha1[20];
 185        git_SHA_CTX c;
 186        z_stream stream;
 187        int zret;
 188        int rename;
 189        struct active_request_slot *slot;
 190};
 191
 192extern struct http_object_request *new_http_object_request(
 193        const char *base_url, unsigned char *sha1);
 194extern void process_http_object_request(struct http_object_request *freq);
 195extern int finish_http_object_request(struct http_object_request *freq);
 196extern void abort_http_object_request(struct http_object_request *freq);
 197extern void release_http_object_request(struct http_object_request *freq);
 198
 199#endif /* HTTP_H */