libavformat/http.c

   1 /*
   2  * HTTP protocol for ffmpeg client
   3  * Copyright (c) 2000, 2001 Fabrice Bellard
   4  *
   5  * This file is part of Libav.
   6  *
   7  * Libav is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * Libav is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with Libav; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #include "libavutil/avstring.h"
  23 #include "avformat.h"
  24 #include <unistd.h>
  25 #include <strings.h>
  26 #include "internal.h"
  27 #include "network.h"
  28 #include "http.h"
  29 #include "os_support.h"
  30 #include "httpauth.h"
  31 #include "url.h"
  32 #include "libavutil/opt.h"
  33
  34 /* XXX: POST protocol is not completely implemented because ffmpeg uses
  35    only a subset of it. */
  36
  37 /* used for protocol handling */
  38 #define BUFFER_SIZE 1024
  39 #define MAX_REDIRECTS 8
  40
  41 typedef struct {
  42     const AVClass *class;
  43     URLContext *hd;
  44     unsigned char buffer[BUFFER_SIZE], *buf_ptr, *buf_end;
  45     int line_count;
  46     int http_code;
  47     int64_t chunksize;      /**< Used if "Transfer-Encoding: chunked" otherwise -1. */
  48     int64_t off, filesize;
  49     char location[MAX_URL_SIZE];
  50     HTTPAuthState auth_state;
  51     unsigned char headers[BUFFER_SIZE];
  52     int willclose;          /**< Set if the server correctly handles Connection: close and will close the connection after feeding us the content. */
  53 } HTTPContext;
  54
  55 #define OFFSET(x) offsetof(HTTPContext, x)
  56 static const AVOption options[] = {
  57 {"chunksize", "use chunked transfer-encoding for posts, -1 disables it, 0 enables it", OFFSET(chunksize), FF_OPT_TYPE_INT64, {.dbl = 0}, -1, 0 }, /* Default to 0, for chunked POSTs */
  58 {NULL}
  59 };
  60 static const AVClass httpcontext_class = {
  61     .class_name     = "HTTP",
  62     .item_name      = av_default_item_name,
  63     .option         = options,
  64     .version        = LIBAVUTIL_VERSION_INT,
  65 };
  66
  67 static int http_connect(URLContext *h, const char *path, const char *hoststr,
  68                         const char *auth, int *new_location);
  69
  70 void ff_http_set_headers(URLContext *h, const char *headers)
  71 {
  72     HTTPContext *s = h->priv_data;
  73     int len = strlen(headers);
  74
  75     if (len && strcmp("\r\n", headers + len - 2))
  76         av_log(h, AV_LOG_ERROR, "No trailing CRLF found in HTTP header.\n");
  77
  78     av_strlcpy(s->headers, headers, sizeof(s->headers));
  79 }
  80
  81 void ff_http_set_chunked_transfer_encoding(URLContext *h, int is_chunked)
  82 {
  83     ((HTTPContext*)h->priv_data)->chunksize = is_chunked ? 0 : -1;
  84 }
  85
  86 void ff_http_init_auth_state(URLContext *dest, const URLContext *src)
  87 {
  88     memcpy(&((HTTPContext*)dest->priv_data)->auth_state,
  89            &((HTTPContext*)src->priv_data)->auth_state, sizeof(HTTPAuthState));
  90 }
  91
  92 /* return non zero if error */
  93 static int http_open_cnx(URLContext *h)
  94 {
  95     const char *path, *proxy_path;
  96     char hostname[1024], hoststr[1024];
  97     char auth[1024];
  98     char path1[1024];
  99     char buf[1024];
 100     int port, use_proxy, err, location_changed = 0, redirects = 0;
 101     HTTPAuthType cur_auth_type;
 102     HTTPContext *s = h->priv_data;
 103     URLContext *hd = NULL;
 104
 105     proxy_path = getenv("http_proxy");
 106     use_proxy = (proxy_path != NULL) && !getenv("no_proxy") &&
 107         av_strstart(proxy_path, "http://", NULL);
 108
 109     /* fill the dest addr */
 110  redo:
 111     /* needed in any case to build the host string */
 112     av_url_split(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
 113                  path1, sizeof(path1), s->location);
 114     ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
 115
 116     if (use_proxy) {
 117         av_url_split(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
 118                      NULL, 0, proxy_path);
 119         path = s->location;
 120     } else {
 121         if (path1[0] == '\0')
 122             path = "/";
 123         else
 124             path = path1;
 125     }
 126     if (port < 0)
 127         port = 80;
 128
 129     ff_url_join(buf, sizeof(buf), "tcp", NULL, hostname, port, NULL);
 130     err = ffurl_open(&hd, buf, AVIO_FLAG_READ_WRITE);
 131     if (err < 0)
 132         goto fail;
 133
 134     s->hd = hd;
 135     cur_auth_type = s->auth_state.auth_type;
 136     if (http_connect(h, path, hoststr, auth, &location_changed) < 0)
 137         goto fail;
 138     if (s->http_code == 401) {
 139         if (cur_auth_type == HTTP_AUTH_NONE && s->auth_state.auth_type != HTTP_AUTH_NONE) {
 140             ffurl_close(hd);
 141             goto redo;
 142         } else
 143             goto fail;
 144     }
 145     if ((s->http_code == 301 || s->http_code == 302 || s->http_code == 303 || s->http_code == 307)
 146         && location_changed == 1) {
 147         /* url moved, get next */
 148         ffurl_close(hd);
 149         if (redirects++ >= MAX_REDIRECTS)
 150             return AVERROR(EIO);
 151         location_changed = 0;
 152         goto redo;
 153     }
 154     return 0;
 155  fail:
 156     if (hd)
 157         ffurl_close(hd);
 158     s->hd = NULL;
 159     return AVERROR(EIO);
 160 }
 161
 162 static int http_open(URLContext *h, const char *uri, int flags)
 163 {
 164     HTTPContext *s = h->priv_data;
 165
 166     h->is_streamed = 1;
 167
 168     s->filesize = -1;
 169     av_strlcpy(s->location, uri, sizeof(s->location));
 170
 171     return http_open_cnx(h);
 172 }
 173 static int http_getc(HTTPContext *s)
 174 {
 175     int len;
 176     if (s->buf_ptr >= s->buf_end) {
 177         len = ffurl_read(s->hd, s->buffer, BUFFER_SIZE);
 178         if (len < 0) {
 179             return AVERROR(EIO);
 180         } else if (len == 0) {
 181             return -1;
 182         } else {
 183             s->buf_ptr = s->buffer;
 184             s->buf_end = s->buffer + len;
 185         }
 186     }
 187     return *s->buf_ptr++;
 188 }
 189
 190 static int http_get_line(HTTPContext *s, char *line, int line_size)
 191 {
 192     int ch;
 193     char *q;
 194
 195     q = line;
 196     for(;;) {
 197         ch = http_getc(s);
 198         if (ch < 0)
 199             return AVERROR(EIO);
 200         if (ch == '\n') {
 201             /* process line */
 202             if (q > line && q[-1] == '\r')
 203                 q--;
 204             *q = '\0';
 205
 206             return 0;
 207         } else {
 208             if ((q - line) < line_size - 1)
 209                 *q++ = ch;
 210         }
 211     }
 212 }
 213
 214 static int process_line(URLContext *h, char *line, int line_count,
 215                         int *new_location)
 216 {
 217     HTTPContext *s = h->priv_data;
 218     char *tag, *p, *end;
 219
 220     /* end of header */
 221     if (line[0] == '\0')
 222         return 0;
 223
 224     p = line;
 225     if (line_count == 0) {
 226         while (!isspace(*p) && *p != '\0')
 227             p++;
 228         while (isspace(*p))
 229             p++;
 230         s->http_code = strtol(p, &end, 10);
 231
 232         av_dlog(NULL, "http_code=%d\n", s->http_code);
 233
 234         /* error codes are 4xx and 5xx, but regard 401 as a success, so we
 235          * don't abort until all headers have been parsed. */
 236         if (s->http_code >= 400 && s->http_code < 600 && s->http_code != 401) {
 237             end += strspn(end, SPACE_CHARS);
 238             av_log(h, AV_LOG_WARNING, "HTTP error %d %s\n",
 239                    s->http_code, end);
 240             return -1;
 241         }
 242     } else {
 243         while (*p != '\0' && *p != ':')
 244             p++;
 245         if (*p != ':')
 246             return 1;
 247
 248         *p = '\0';
 249         tag = line;
 250         p++;
 251         while (isspace(*p))
 252             p++;
 253         if (!strcasecmp(tag, "Location")) {
 254             strcpy(s->location, p);
 255             *new_location = 1;
 256         } else if (!strcasecmp (tag, "Content-Length") && s->filesize == -1) {
 257             s->filesize = atoll(p);
 258         } else if (!strcasecmp (tag, "Content-Range")) {
 259             /* "bytes $from-$to/$document_size" */
 260             const char *slash;
 261             if (!strncmp (p, "bytes ", 6)) {
 262                 p += 6;
 263                 s->off = atoll(p);
 264                 if ((slash = strchr(p, '/')) && strlen(slash) > 0)
 265                     s->filesize = atoll(slash+1);
 266             }
 267             h->is_streamed = 0; /* we _can_ in fact seek */
 268         } else if (!strcasecmp(tag, "Accept-Ranges") && !strncmp(p, "bytes", 5)) {
 269             h->is_streamed = 0;
 270         } else if (!strcasecmp (tag, "Transfer-Encoding") && !strncasecmp(p, "chunked", 7)) {
 271             s->filesize = -1;
 272             s->chunksize = 0;
 273         } else if (!strcasecmp (tag, "WWW-Authenticate")) {
 274             ff_http_auth_handle_header(&s->auth_state, tag, p);
 275         } else if (!strcasecmp (tag, "Authentication-Info")) {
 276             ff_http_auth_handle_header(&s->auth_state, tag, p);
 277         } else if (!strcasecmp (tag, "Connection")) {
 278             if (!strcmp(p, "close"))
 279                 s->willclose = 1;
 280         }
 281     }
 282     return 1;
 283 }
 284
 285 static inline int has_header(const char *str, const char *header)
 286 {
 287     /* header + 2 to skip over CRLF prefix. (make sure you have one!) */
 288     return av_stristart(str, header + 2, NULL) || av_stristr(str, header);
 289 }
 290
 291 static int http_connect(URLContext *h, const char *path, const char *hoststr,
 292                         const char *auth, int *new_location)
 293 {
 294     HTTPContext *s = h->priv_data;
 295     int post, err;
 296     char line[1024];
 297     char headers[1024] = "";
 298     char *authstr = NULL;
 299     int64_t off = s->off;
 300     int len = 0;
 301
 302
 303     /* send http header */
 304     post = h->flags & AVIO_FLAG_WRITE;
 305     authstr = ff_http_auth_create_response(&s->auth_state, auth, path,
 306                                         post ? "POST" : "GET");
 307
 308     /* set default headers if needed */
 309     if (!has_header(s->headers, "\r\nUser-Agent: "))
 310        len += av_strlcatf(headers + len, sizeof(headers) - len,
 311                           "User-Agent: %s\r\n", LIBAVFORMAT_IDENT);
 312     if (!has_header(s->headers, "\r\nAccept: "))
 313         len += av_strlcpy(headers + len, "Accept: */*\r\n",
 314                           sizeof(headers) - len);
 315     if (!has_header(s->headers, "\r\nRange: "))
 316         len += av_strlcatf(headers + len, sizeof(headers) - len,
 317                            "Range: bytes=%"PRId64"-\r\n", s->off);
 318     if (!has_header(s->headers, "\r\nConnection: "))
 319         len += av_strlcpy(headers + len, "Connection: close\r\n",
 320                           sizeof(headers)-len);
 321     if (!has_header(s->headers, "\r\nHost: "))
 322         len += av_strlcatf(headers + len, sizeof(headers) - len,
 323                            "Host: %s\r\n", hoststr);
 324
 325     /* now add in custom headers */
 326     av_strlcpy(headers+len, s->headers, sizeof(headers)-len);
 327
 328     snprintf(s->buffer, sizeof(s->buffer),
 329              "%s %s HTTP/1.1\r\n"
 330              "%s"
 331              "%s"
 332              "%s"
 333              "\r\n",
 334              post ? "POST" : "GET",
 335              path,
 336              post && s->chunksize >= 0 ? "Transfer-Encoding: chunked\r\n" : "",
 337              headers,
 338              authstr ? authstr : "");
 339
 340     av_freep(&authstr);
 341     if (ffurl_write(s->hd, s->buffer, strlen(s->buffer)) < 0)
 342         return AVERROR(EIO);
 343
 344     /* init input buffer */
 345     s->buf_ptr = s->buffer;
 346     s->buf_end = s->buffer;
 347     s->line_count = 0;
 348     s->off = 0;
 349     s->filesize = -1;
 350     s->willclose = 0;
 351     if (post) {
 352         /* Pretend that it did work. We didn't read any header yet, since
 353          * we've still to send the POST data, but the code calling this
 354          * function will check http_code after we return. */
 355         s->http_code = 200;
 356         return 0;
 357     }
 358     s->chunksize = -1;
 359
 360     /* wait for header */
 361     for(;;) {
 362         if (http_get_line(s, line, sizeof(line)) < 0)
 363             return AVERROR(EIO);
 364
 365         av_dlog(NULL, "header='%s'\n", line);
 366
 367         err = process_line(h, line, s->line_count, new_location);
 368         if (err < 0)
 369             return err;
 370         if (err == 0)
 371             break;
 372         s->line_count++;
 373     }
 374
 375     return (off == s->off) ? 0 : -1;
 376 }
 377
 378
 379 static int http_read(URLContext *h, uint8_t *buf, int size)
 380 {
 381     HTTPContext *s = h->priv_data;
 382     int len;
 383
 384     if (s->chunksize >= 0) {
 385         if (!s->chunksize) {
 386             char line[32];
 387
 388             for(;;) {
 389                 do {
 390                     if (http_get_line(s, line, sizeof(line)) < 0)
 391                         return AVERROR(EIO);
 392                 } while (!*line);    /* skip CR LF from last chunk */
 393
 394                 s->chunksize = strtoll(line, NULL, 16);
 395
 396                 av_dlog(NULL, "Chunked encoding data size: %"PRId64"'\n", s->chunksize);
 397
 398                 if (!s->chunksize)
 399                     return 0;
 400                 break;
 401             }
 402         }
 403         size = FFMIN(size, s->chunksize);
 404     }
 405     /* read bytes from input buffer first */
 406     len = s->buf_end - s->buf_ptr;
 407     if (len > 0) {
 408         if (len > size)
 409             len = size;
 410         memcpy(buf, s->buf_ptr, len);
 411         s->buf_ptr += len;
 412     } else {
 413         if (!s->willclose && s->filesize >= 0 && s->off >= s->filesize)
 414             return AVERROR_EOF;
 415         len = ffurl_read(s->hd, buf, size);
 416     }
 417     if (len > 0) {
 418         s->off += len;
 419         if (s->chunksize > 0)
 420             s->chunksize -= len;
 421     }
 422     return len;
 423 }
 424
 425 /* used only when posting data */
 426 static int http_write(URLContext *h, const uint8_t *buf, int size)
 427 {
 428     char temp[11] = "";  /* 32-bit hex + CRLF + nul */
 429     int ret;
 430     char crlf[] = "\r\n";
 431     HTTPContext *s = h->priv_data;
 432
 433     if (s->chunksize == -1) {
 434         /* non-chunked data is sent without any special encoding */
 435         return ffurl_write(s->hd, buf, size);
 436     }
 437
 438     /* silently ignore zero-size data since chunk encoding that would
 439      * signal EOF */
 440     if (size > 0) {
 441         /* upload data using chunked encoding */
 442         snprintf(temp, sizeof(temp), "%x\r\n", size);
 443
 444         if ((ret = ffurl_write(s->hd, temp, strlen(temp))) < 0 ||
 445             (ret = ffurl_write(s->hd, buf, size)) < 0 ||
 446             (ret = ffurl_write(s->hd, crlf, sizeof(crlf) - 1)) < 0)
 447             return ret;
 448     }
 449     return size;
 450 }
 451
 452 static int http_close(URLContext *h)
 453 {
 454     int ret = 0;
 455     char footer[] = "0\r\n\r\n";
 456     HTTPContext *s = h->priv_data;
 457
 458     /* signal end of chunked encoding if used */
 459     if ((h->flags & AVIO_FLAG_WRITE) && s->chunksize != -1) {
 460         ret = ffurl_write(s->hd, footer, sizeof(footer) - 1);
 461         ret = ret > 0 ? 0 : ret;
 462     }
 463
 464     if (s->hd)
 465         ffurl_close(s->hd);
 466     return ret;
 467 }
 468
 469 static int64_t http_seek(URLContext *h, int64_t off, int whence)
 470 {
 471     HTTPContext *s = h->priv_data;
 472     URLContext *old_hd = s->hd;
 473     int64_t old_off = s->off;
 474     uint8_t old_buf[BUFFER_SIZE];
 475     int old_buf_size;
 476
 477     if (whence == AVSEEK_SIZE)
 478         return s->filesize;
 479     else if ((s->filesize == -1 && whence == SEEK_END) || h->is_streamed)
 480         return -1;
 481
 482     /* we save the old context in case the seek fails */
 483     old_buf_size = s->buf_end - s->buf_ptr;
 484     memcpy(old_buf, s->buf_ptr, old_buf_size);
 485     s->hd = NULL;
 486     if (whence == SEEK_CUR)
 487         off += s->off;
 488     else if (whence == SEEK_END)
 489         off += s->filesize;
 490     s->off = off;
 491
 492     /* if it fails, continue on old connection */
 493     if (http_open_cnx(h) < 0) {
 494         memcpy(s->buffer, old_buf, old_buf_size);
 495         s->buf_ptr = s->buffer;
 496         s->buf_end = s->buffer + old_buf_size;
 497         s->hd = old_hd;
 498         s->off = old_off;
 499         return -1;
 500     }
 501     ffurl_close(old_hd);
 502     return off;
 503 }
 504
 505 static int
 506 http_get_file_handle(URLContext *h)
 507 {
 508     HTTPContext *s = h->priv_data;
 509     return ffurl_get_file_handle(s->hd);
 510 }
 511
 512 URLProtocol ff_http_protocol = {
 513     .name                = "http",
 514     .url_open            = http_open,
 515     .url_read            = http_read,
 516     .url_write           = http_write,
 517     .url_seek            = http_seek,
 518     .url_close           = http_close,
 519     .url_get_file_handle = http_get_file_handle,
 520     .priv_data_size      = sizeof(HTTPContext),
 521     .priv_data_class     = &httpcontext_class,
 522 };