Andrew's git / gitweb.git / http.h
?
http.hon commit Git 1.6.6.3 (abf411e)
   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_active_slot(struct active_request_slot *slot);
  83extern void finish_all_active_slots(void);
  84extern void release_active_slot(struct active_request_slot *slot);
  85
  86#ifdef USE_CURL_MULTI
  87extern void fill_active_slots(void);
  88extern void add_fill_function(void *data, int (*fill)(void *));
  89extern void step_active_slots(void);
  90#endif
  91
  92extern void http_init(struct remote *remote);
  93extern void http_cleanup(void);
  94
  95extern int data_received;
  96extern int active_requests;
  97extern int http_is_verbose;
  98extern size_t http_post_buffer;
  99
 100extern char curl_errorstr[CURL_ERROR_SIZE];
 101
 102static inline int missing__target(int code, int result)
 103{
 104        return  /* file:// URL -- do we ever use one??? */
 105                (result == CURLE_FILE_COULDNT_READ_FILE) ||
 106                /* http:// and https:// URL */
 107                (code == 404 && result == CURLE_HTTP_RETURNED_ERROR) ||
 108                /* ftp:// URL */
 109                (code == 550 && result == CURLE_FTP_COULDNT_RETR_FILE)
 110                ;
 111}
 112
 113#define missing_target(a) missing__target((a)->http_code, (a)->curl_result)
 114
 115/* Helpers for modifying and creating URLs */
 116extern void append_remote_object_url(struct strbuf *buf, const char *url,
 117                                     const char *hex,
 118                                     int only_two_digit_prefix);
 119extern char *get_remote_object_url(const char *url, const char *hex,
 120                                   int only_two_digit_prefix);
 121
 122/* Options for http_request_*() */
 123#define HTTP_NO_CACHE           1
 124
 125/* Return values for http_request_*() */
 126#define HTTP_OK                 0
 127#define HTTP_MISSING_TARGET     1
 128#define HTTP_ERROR              2
 129#define HTTP_START_FAILED       3
 130
 131/*
 132 * Requests an url and stores the result in a strbuf.
 133 *
 134 * If the result pointer is NULL, a HTTP HEAD request is made instead of GET.
 135 */
 136int http_get_strbuf(const char *url, struct strbuf *result, int options);
 137
 138/*
 139 * Downloads an url and stores the result in the given file.
 140 *
 141 * If a previous interrupted download is detected (i.e. a previous temporary
 142 * file is still around) the download is resumed.
 143 */
 144int http_get_file(const char *url, const char *filename, int options);
 145
 146/*
 147 * Prints an error message using error() containing url and curl_errorstr,
 148 * and returns ret.
 149 */
 150int http_error(const char *url, int ret);
 151
 152extern int http_fetch_ref(const char *base, struct ref *ref);
 153
 154/* Helpers for fetching packs */
 155extern int http_get_info_packs(const char *base_url,
 156        struct packed_git **packs_head);
 157
 158struct http_pack_request
 159{
 160        char *url;
 161        struct packed_git *target;
 162        struct packed_git **lst;
 163        FILE *packfile;
 164        char filename[PATH_MAX];
 165        char tmpfile[PATH_MAX];
 166        struct curl_slist *range_header;
 167        struct active_request_slot *slot;
 168};
 169
 170extern struct http_pack_request *new_http_pack_request(
 171        struct packed_git *target, const char *base_url);
 172extern int finish_http_pack_request(struct http_pack_request *preq);
 173extern void release_http_pack_request(struct http_pack_request *preq);
 174
 175/* Helpers for fetching object */
 176struct http_object_request
 177{
 178        char *url;
 179        char filename[PATH_MAX];
 180        char tmpfile[PATH_MAX];
 181        int localfile;
 182        CURLcode curl_result;
 183        char errorstr[CURL_ERROR_SIZE];
 184        long http_code;
 185        unsigned char sha1[20];
 186        unsigned char real_sha1[20];
 187        git_SHA_CTX c;
 188        z_stream stream;
 189        int zret;
 190        int rename;
 191        struct active_request_slot *slot;
 192};
 193
 194extern struct http_object_request *new_http_object_request(
 195        const char *base_url, unsigned char *sha1);
 196extern void process_http_object_request(struct http_object_request *freq);
 197extern int finish_http_object_request(struct http_object_request *freq);
 198extern void abort_http_object_request(struct http_object_request *freq);
 199extern void release_http_object_request(struct http_object_request *freq);
 200
 201#endif /* HTTP_H */