2 * HTTP protocol for avconv client
3 * Copyright (c) 2000, 2001 Fabrice Bellard
5 * This file is part of Libav.
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.
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.
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
22 #include "libavutil/avstring.h"
27 #include "os_support.h"
30 #include "libavutil/opt.h"
36 /* XXX: POST protocol is not completely implemented because avconv uses
37 only a subset of it. */
39 /* The IO buffer size is unrelated to the max URL size in itself, but needs
40 * to be large enough to fit the full request headers (including long
43 #define BUFFER_SIZE MAX_URL_SIZE
44 #define MAX_REDIRECTS 8
49 unsigned char buffer[BUFFER_SIZE], *buf_ptr, *buf_end;
52 int64_t chunksize; /**< Used if "Transfer-Encoding: chunked" otherwise -1. */
53 int64_t off, filesize;
54 char location[MAX_URL_SIZE];
55 HTTPAuthState auth_state;
56 HTTPAuthState proxy_auth_state;
58 int willclose; /**< Set if the server correctly handles Connection: close and will close the connection after feeding us the content. */
60 int end_chunked_post; /**< A flag which indicates if the end of chunked encoding has been sent. */
61 int end_header; /**< A flag which indicates we have finished to read POST reply. */
62 int multiple_requests; /**< A flag which indicates if we use persistent connections. */
67 z_stream inflate_stream;
68 uint8_t *inflate_buffer;
70 AVDictionary *chained_options;
73 #define OFFSET(x) offsetof(HTTPContext, x)
74 #define D AV_OPT_FLAG_DECODING_PARAM
75 #define E AV_OPT_FLAG_ENCODING_PARAM
76 static const AVOption options[] = {
77 {"chunked_post", "use chunked transfer-encoding for posts", OFFSET(chunked_post), AV_OPT_TYPE_INT, {.i64 = 1}, 0, 1, E },
78 {"headers", "custom HTTP headers, can override built in default headers", OFFSET(headers), AV_OPT_TYPE_STRING, { 0 }, 0, 0, D|E },
79 {"multiple_requests", "use persistent connections", OFFSET(multiple_requests), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D|E },
80 {"post_data", "custom HTTP post data", OFFSET(post_data), AV_OPT_TYPE_BINARY, .flags = D|E },
83 #define HTTP_CLASS(flavor)\
84 static const AVClass flavor ## _context_class = {\
85 .class_name = #flavor,\
86 .item_name = av_default_item_name,\
88 .version = LIBAVUTIL_VERSION_INT,\
94 static int http_connect(URLContext *h, const char *path, const char *local_path,
95 const char *hoststr, const char *auth,
96 const char *proxyauth, int *new_location);
98 void ff_http_init_auth_state(URLContext *dest, const URLContext *src)
100 memcpy(&((HTTPContext*)dest->priv_data)->auth_state,
101 &((HTTPContext*)src->priv_data)->auth_state, sizeof(HTTPAuthState));
102 memcpy(&((HTTPContext*)dest->priv_data)->proxy_auth_state,
103 &((HTTPContext*)src->priv_data)->proxy_auth_state,
104 sizeof(HTTPAuthState));
107 /* return non zero if error */
108 static int http_open_cnx(URLContext *h, AVDictionary **options)
110 const char *path, *proxy_path, *lower_proto = "tcp", *local_path;
111 char hostname[1024], hoststr[1024], proto[10];
112 char auth[1024], proxyauth[1024] = "";
113 char path1[MAX_URL_SIZE];
114 char buf[1024], urlbuf[MAX_URL_SIZE];
115 int port, use_proxy, err, location_changed = 0, redirects = 0, attempts = 0;
116 HTTPAuthType cur_auth_type, cur_proxy_auth_type;
117 HTTPContext *s = h->priv_data;
119 /* fill the dest addr */
121 /* needed in any case to build the host string */
122 av_url_split(proto, sizeof(proto), auth, sizeof(auth),
123 hostname, sizeof(hostname), &port,
124 path1, sizeof(path1), s->location);
125 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
127 proxy_path = getenv("http_proxy");
128 use_proxy = !ff_http_match_no_proxy(getenv("no_proxy"), hostname) &&
129 proxy_path != NULL && av_strstart(proxy_path, "http://", NULL);
131 if (!strcmp(proto, "https")) {
140 if (path1[0] == '\0')
146 /* Reassemble the request URL without auth string - we don't
147 * want to leak the auth to the proxy. */
148 ff_url_join(urlbuf, sizeof(urlbuf), proto, NULL, hostname, port, "%s",
151 av_url_split(NULL, 0, proxyauth, sizeof(proxyauth),
152 hostname, sizeof(hostname), &port, NULL, 0, proxy_path);
155 ff_url_join(buf, sizeof(buf), lower_proto, NULL, hostname, port, NULL);
158 err = ffurl_open(&s->hd, buf, AVIO_FLAG_READ_WRITE,
159 &h->interrupt_callback, options);
164 cur_auth_type = s->auth_state.auth_type;
165 cur_proxy_auth_type = s->auth_state.auth_type;
166 if (http_connect(h, path, local_path, hoststr, auth, proxyauth, &location_changed) < 0)
169 if (s->http_code == 401) {
170 if ((cur_auth_type == HTTP_AUTH_NONE || s->auth_state.stale) &&
171 s->auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
178 if (s->http_code == 407) {
179 if ((cur_proxy_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
180 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
187 if ((s->http_code == 301 || s->http_code == 302 || s->http_code == 303 || s->http_code == 307)
188 && location_changed == 1) {
189 /* url moved, get next */
192 if (redirects++ >= MAX_REDIRECTS)
194 /* Restart the authentication process with the new target, which
195 * might use a different auth mechanism. */
196 memset(&s->auth_state, 0, sizeof(s->auth_state));
198 location_changed = 0;
209 int ff_http_do_new_request(URLContext *h, const char *uri)
211 HTTPContext *s = h->priv_data;
212 AVDictionary *options = NULL;
216 av_strlcpy(s->location, uri, sizeof(s->location));
218 av_dict_copy(&options, s->chained_options, 0);
219 ret = http_open_cnx(h, &options);
220 av_dict_free(&options);
224 static int http_open(URLContext *h, const char *uri, int flags,
225 AVDictionary **options)
227 HTTPContext *s = h->priv_data;
233 av_strlcpy(s->location, uri, sizeof(s->location));
235 av_dict_copy(&s->chained_options, *options, 0);
238 int len = strlen(s->headers);
239 if (len < 2 || strcmp("\r\n", s->headers + len - 2))
240 av_log(h, AV_LOG_WARNING, "No trailing CRLF found in HTTP header.\n");
243 ret = http_open_cnx(h, options);
245 av_dict_free(&s->chained_options);
248 static int http_getc(HTTPContext *s)
251 if (s->buf_ptr >= s->buf_end) {
252 len = ffurl_read(s->hd, s->buffer, BUFFER_SIZE);
255 } else if (len == 0) {
258 s->buf_ptr = s->buffer;
259 s->buf_end = s->buffer + len;
262 return *s->buf_ptr++;
265 static int http_get_line(HTTPContext *s, char *line, int line_size)
277 if (q > line && q[-1] == '\r')
283 if ((q - line) < line_size - 1)
289 static int process_line(URLContext *h, char *line, int line_count,
292 HTTPContext *s = h->priv_data;
296 if (line[0] == '\0') {
302 if (line_count == 0) {
303 while (!av_isspace(*p) && *p != '\0')
305 while (av_isspace(*p))
307 s->http_code = strtol(p, &end, 10);
309 av_dlog(NULL, "http_code=%d\n", s->http_code);
311 /* error codes are 4xx and 5xx, but regard 401 as a success, so we
312 * don't abort until all headers have been parsed. */
313 if (s->http_code >= 400 && s->http_code < 600 && (s->http_code != 401
314 || s->auth_state.auth_type != HTTP_AUTH_NONE) &&
315 (s->http_code != 407 || s->proxy_auth_state.auth_type != HTTP_AUTH_NONE)) {
316 end += strspn(end, SPACE_CHARS);
317 av_log(h, AV_LOG_WARNING, "HTTP error %d %s\n",
322 while (*p != '\0' && *p != ':')
330 while (av_isspace(*p))
332 if (!av_strcasecmp(tag, "Location")) {
333 av_strlcpy(s->location, p, sizeof(s->location));
335 } else if (!av_strcasecmp (tag, "Content-Length") && s->filesize == -1) {
336 s->filesize = strtoll(p, NULL, 10);
337 } else if (!av_strcasecmp (tag, "Content-Range")) {
338 /* "bytes $from-$to/$document_size" */
340 if (!strncmp (p, "bytes ", 6)) {
342 s->off = strtoll(p, NULL, 10);
343 if ((slash = strchr(p, '/')) && strlen(slash) > 0)
344 s->filesize = strtoll(slash+1, NULL, 10);
346 h->is_streamed = 0; /* we _can_ in fact seek */
347 } else if (!av_strcasecmp(tag, "Accept-Ranges") && !strncmp(p, "bytes", 5)) {
349 } else if (!av_strcasecmp (tag, "Transfer-Encoding") && !av_strncasecmp(p, "chunked", 7)) {
352 } else if (!av_strcasecmp (tag, "WWW-Authenticate")) {
353 ff_http_auth_handle_header(&s->auth_state, tag, p);
354 } else if (!av_strcasecmp (tag, "Authentication-Info")) {
355 ff_http_auth_handle_header(&s->auth_state, tag, p);
356 } else if (!av_strcasecmp (tag, "Proxy-Authenticate")) {
357 ff_http_auth_handle_header(&s->proxy_auth_state, tag, p);
358 } else if (!av_strcasecmp (tag, "Connection")) {
359 if (!strcmp(p, "close"))
361 } else if (!av_strcasecmp (tag, "Content-Encoding")) {
362 if (!av_strncasecmp(p, "gzip", 4) || !av_strncasecmp(p, "deflate", 7)) {
365 inflateEnd(&s->inflate_stream);
366 if (inflateInit2(&s->inflate_stream, 32 + 15) != Z_OK) {
367 av_log(h, AV_LOG_WARNING, "Error during zlib initialisation: %s\n",
368 s->inflate_stream.msg);
369 return AVERROR(ENOSYS);
371 if (zlibCompileFlags() & (1 << 17)) {
372 av_log(h, AV_LOG_WARNING, "Your zlib was compiled without gzip support.\n");
373 return AVERROR(ENOSYS);
376 av_log(h, AV_LOG_WARNING, "Compressed (%s) content, need zlib with gzip support\n", p);
377 return AVERROR(ENOSYS);
379 } else if (!av_strncasecmp(p, "identity", 8)) {
380 // The normal, no-encoding case (although servers shouldn't include
381 // the header at all if this is the case).
383 av_log(h, AV_LOG_WARNING, "Unknown content coding: %s\n", p);
384 return AVERROR(ENOSYS);
391 static inline int has_header(const char *str, const char *header)
393 /* header + 2 to skip over CRLF prefix. (make sure you have one!) */
396 return av_stristart(str, header + 2, NULL) || av_stristr(str, header);
399 static int http_read_header(URLContext *h, int *new_location)
401 HTTPContext *s = h->priv_data;
402 char line[MAX_URL_SIZE];
408 if ((err = http_get_line(s, line, sizeof(line))) < 0)
411 av_dlog(NULL, "header='%s'\n", line);
413 err = process_line(h, line, s->line_count, new_location);
424 static int http_connect(URLContext *h, const char *path, const char *local_path,
425 const char *hoststr, const char *auth,
426 const char *proxyauth, int *new_location)
428 HTTPContext *s = h->priv_data;
430 char headers[1024] = "";
431 char *authstr = NULL, *proxyauthstr = NULL;
432 int64_t off = s->off;
437 /* send http header */
438 post = h->flags & AVIO_FLAG_WRITE;
441 /* force POST method and disable chunked encoding when
442 * custom HTTP post data is set */
447 method = post ? "POST" : "GET";
448 authstr = ff_http_auth_create_response(&s->auth_state, auth, local_path,
450 proxyauthstr = ff_http_auth_create_response(&s->proxy_auth_state, proxyauth,
453 /* set default headers if needed */
454 if (!has_header(s->headers, "\r\nUser-Agent: "))
455 len += av_strlcatf(headers + len, sizeof(headers) - len,
456 "User-Agent: %s\r\n", LIBAVFORMAT_IDENT);
457 if (!has_header(s->headers, "\r\nAccept: "))
458 len += av_strlcpy(headers + len, "Accept: */*\r\n",
459 sizeof(headers) - len);
460 if (!has_header(s->headers, "\r\nRange: ") && !post)
461 len += av_strlcatf(headers + len, sizeof(headers) - len,
462 "Range: bytes=%"PRId64"-\r\n", s->off);
464 if (!has_header(s->headers, "\r\nConnection: ")) {
465 if (s->multiple_requests) {
466 len += av_strlcpy(headers + len, "Connection: keep-alive\r\n",
467 sizeof(headers) - len);
469 len += av_strlcpy(headers + len, "Connection: close\r\n",
470 sizeof(headers) - len);
474 if (!has_header(s->headers, "\r\nHost: "))
475 len += av_strlcatf(headers + len, sizeof(headers) - len,
476 "Host: %s\r\n", hoststr);
477 if (!has_header(s->headers, "\r\nContent-Length: ") && s->post_data)
478 len += av_strlcatf(headers + len, sizeof(headers) - len,
479 "Content-Length: %d\r\n", s->post_datalen);
481 /* now add in custom headers */
483 av_strlcpy(headers + len, s->headers, sizeof(headers) - len);
485 snprintf(s->buffer, sizeof(s->buffer),
494 post && s->chunked_post ? "Transfer-Encoding: chunked\r\n" : "",
496 authstr ? authstr : "",
497 proxyauthstr ? "Proxy-" : "", proxyauthstr ? proxyauthstr : "");
500 av_freep(&proxyauthstr);
501 if ((err = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
505 if ((err = ffurl_write(s->hd, s->post_data, s->post_datalen)) < 0)
508 /* init input buffer */
509 s->buf_ptr = s->buffer;
510 s->buf_end = s->buffer;
515 s->end_chunked_post = 0;
517 if (post && !s->post_data) {
518 /* Pretend that it did work. We didn't read any header yet, since
519 * we've still to send the POST data, but the code calling this
520 * function will check http_code after we return. */
525 /* wait for header */
526 err = http_read_header(h, new_location);
530 return (off == s->off) ? 0 : -1;
534 static int http_buf_read(URLContext *h, uint8_t *buf, int size)
536 HTTPContext *s = h->priv_data;
538 /* read bytes from input buffer first */
539 len = s->buf_end - s->buf_ptr;
543 memcpy(buf, s->buf_ptr, len);
546 if (!s->willclose && s->filesize >= 0 && s->off >= s->filesize)
548 len = ffurl_read(s->hd, buf, size);
552 if (s->chunksize > 0)
559 #define DECOMPRESS_BUF_SIZE (256 * 1024)
560 static int http_buf_read_compressed(URLContext *h, uint8_t *buf, int size)
562 HTTPContext *s = h->priv_data;
565 if (!s->inflate_buffer) {
566 s->inflate_buffer = av_malloc(DECOMPRESS_BUF_SIZE);
567 if (!s->inflate_buffer)
568 return AVERROR(ENOMEM);
571 if (s->inflate_stream.avail_in == 0) {
572 int read = http_buf_read(h, s->inflate_buffer, DECOMPRESS_BUF_SIZE);
575 s->inflate_stream.next_in = s->inflate_buffer;
576 s->inflate_stream.avail_in = read;
579 s->inflate_stream.avail_out = size;
580 s->inflate_stream.next_out = buf;
582 ret = inflate(&s->inflate_stream, Z_SYNC_FLUSH);
583 if (ret != Z_OK && ret != Z_STREAM_END)
584 av_log(h, AV_LOG_WARNING, "inflate return value: %d, %s\n", ret, s->inflate_stream.msg);
586 return size - s->inflate_stream.avail_out;
590 static int http_read(URLContext *h, uint8_t *buf, int size)
592 HTTPContext *s = h->priv_data;
593 int err, new_location;
598 if (s->end_chunked_post && !s->end_header) {
599 err = http_read_header(h, &new_location);
604 if (s->chunksize >= 0) {
610 if ((err = http_get_line(s, line, sizeof(line))) < 0)
612 } while (!*line); /* skip CR LF from last chunk */
614 s->chunksize = strtoll(line, NULL, 16);
616 av_dlog(NULL, "Chunked encoding data size: %"PRId64"'\n", s->chunksize);
623 size = FFMIN(size, s->chunksize);
627 return http_buf_read_compressed(h, buf, size);
629 return http_buf_read(h, buf, size);
632 /* used only when posting data */
633 static int http_write(URLContext *h, const uint8_t *buf, int size)
635 char temp[11] = ""; /* 32-bit hex + CRLF + nul */
637 char crlf[] = "\r\n";
638 HTTPContext *s = h->priv_data;
640 if (!s->chunked_post) {
641 /* non-chunked data is sent without any special encoding */
642 return ffurl_write(s->hd, buf, size);
645 /* silently ignore zero-size data since chunk encoding that would
648 /* upload data using chunked encoding */
649 snprintf(temp, sizeof(temp), "%x\r\n", size);
651 if ((ret = ffurl_write(s->hd, temp, strlen(temp))) < 0 ||
652 (ret = ffurl_write(s->hd, buf, size)) < 0 ||
653 (ret = ffurl_write(s->hd, crlf, sizeof(crlf) - 1)) < 0)
659 static int http_shutdown(URLContext *h, int flags)
662 char footer[] = "0\r\n\r\n";
663 HTTPContext *s = h->priv_data;
665 /* signal end of chunked encoding if used */
666 if ((flags & AVIO_FLAG_WRITE) && s->chunked_post) {
667 ret = ffurl_write(s->hd, footer, sizeof(footer) - 1);
668 ret = ret > 0 ? 0 : ret;
669 s->end_chunked_post = 1;
675 static int http_close(URLContext *h)
678 HTTPContext *s = h->priv_data;
681 inflateEnd(&s->inflate_stream);
682 av_freep(&s->inflate_buffer);
685 if (!s->end_chunked_post) {
686 /* Close the write direction by sending the end of chunked encoding. */
687 ret = http_shutdown(h, h->flags);
692 av_dict_free(&s->chained_options);
696 static int64_t http_seek(URLContext *h, int64_t off, int whence)
698 HTTPContext *s = h->priv_data;
699 URLContext *old_hd = s->hd;
700 int64_t old_off = s->off;
701 uint8_t old_buf[BUFFER_SIZE];
703 AVDictionary *options = NULL;
705 if (whence == AVSEEK_SIZE)
707 else if ((s->filesize == -1 && whence == SEEK_END) || h->is_streamed)
710 /* we save the old context in case the seek fails */
711 old_buf_size = s->buf_end - s->buf_ptr;
712 memcpy(old_buf, s->buf_ptr, old_buf_size);
714 if (whence == SEEK_CUR)
716 else if (whence == SEEK_END)
720 /* if it fails, continue on old connection */
721 av_dict_copy(&options, s->chained_options, 0);
722 if (http_open_cnx(h, &options) < 0) {
723 av_dict_free(&options);
724 memcpy(s->buffer, old_buf, old_buf_size);
725 s->buf_ptr = s->buffer;
726 s->buf_end = s->buffer + old_buf_size;
731 av_dict_free(&options);
737 http_get_file_handle(URLContext *h)
739 HTTPContext *s = h->priv_data;
740 return ffurl_get_file_handle(s->hd);
743 #if CONFIG_HTTP_PROTOCOL
744 URLProtocol ff_http_protocol = {
746 .url_open2 = http_open,
747 .url_read = http_read,
748 .url_write = http_write,
749 .url_seek = http_seek,
750 .url_close = http_close,
751 .url_get_file_handle = http_get_file_handle,
752 .url_shutdown = http_shutdown,
753 .priv_data_size = sizeof(HTTPContext),
754 .priv_data_class = &http_context_class,
755 .flags = URL_PROTOCOL_FLAG_NETWORK,
758 #if CONFIG_HTTPS_PROTOCOL
759 URLProtocol ff_https_protocol = {
761 .url_open2 = http_open,
762 .url_read = http_read,
763 .url_write = http_write,
764 .url_seek = http_seek,
765 .url_close = http_close,
766 .url_get_file_handle = http_get_file_handle,
767 .url_shutdown = http_shutdown,
768 .priv_data_size = sizeof(HTTPContext),
769 .priv_data_class = &https_context_class,
770 .flags = URL_PROTOCOL_FLAG_NETWORK,
774 #if CONFIG_HTTPPROXY_PROTOCOL
775 static int http_proxy_close(URLContext *h)
777 HTTPContext *s = h->priv_data;
783 static int http_proxy_open(URLContext *h, const char *uri, int flags)
785 HTTPContext *s = h->priv_data;
786 char hostname[1024], hoststr[1024];
787 char auth[1024], pathbuf[1024], *path;
789 int port, ret = 0, attempts = 0;
790 HTTPAuthType cur_auth_type;
796 av_url_split(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
797 pathbuf, sizeof(pathbuf), uri);
798 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
803 ff_url_join(lower_url, sizeof(lower_url), "tcp", NULL, hostname, port,
806 ret = ffurl_open(&s->hd, lower_url, AVIO_FLAG_READ_WRITE,
807 &h->interrupt_callback, NULL);
811 authstr = ff_http_auth_create_response(&s->proxy_auth_state, auth,
813 snprintf(s->buffer, sizeof(s->buffer),
814 "CONNECT %s HTTP/1.1\r\n"
816 "Connection: close\r\n"
821 authstr ? "Proxy-" : "", authstr ? authstr : "");
824 if ((ret = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
827 s->buf_ptr = s->buffer;
828 s->buf_end = s->buffer;
831 cur_auth_type = s->proxy_auth_state.auth_type;
833 /* Note: This uses buffering, potentially reading more than the
834 * HTTP header. If tunneling a protocol where the server starts
835 * the conversation, we might buffer part of that here, too.
836 * Reading that requires using the proper ffurl_read() function
837 * on this URLContext, not using the fd directly (as the tls
838 * protocol does). This shouldn't be an issue for tls though,
839 * since the client starts the conversation there, so there
840 * is no extra data that we might buffer up here.
842 ret = http_read_header(h, &new_loc);
847 if (s->http_code == 407 &&
848 (cur_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
849 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 2) {
855 if (s->http_code < 400)
864 static int http_proxy_write(URLContext *h, const uint8_t *buf, int size)
866 HTTPContext *s = h->priv_data;
867 return ffurl_write(s->hd, buf, size);
870 URLProtocol ff_httpproxy_protocol = {
872 .url_open = http_proxy_open,
873 .url_read = http_buf_read,
874 .url_write = http_proxy_write,
875 .url_close = http_proxy_close,
876 .url_get_file_handle = http_get_file_handle,
877 .priv_data_size = sizeof(HTTPContext),
878 .flags = URL_PROTOCOL_FLAG_NETWORK,