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;
72 #define OFFSET(x) offsetof(HTTPContext, x)
73 #define D AV_OPT_FLAG_DECODING_PARAM
74 #define E AV_OPT_FLAG_ENCODING_PARAM
75 static const AVOption options[] = {
76 {"chunked_post", "use chunked transfer-encoding for posts", OFFSET(chunked_post), AV_OPT_TYPE_INT, {.i64 = 1}, 0, 1, E },
77 {"headers", "custom HTTP headers, can override built in default headers", OFFSET(headers), AV_OPT_TYPE_STRING, { 0 }, 0, 0, D|E },
78 {"multiple_requests", "use persistent connections", OFFSET(multiple_requests), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D|E },
79 {"post_data", "custom HTTP post data", OFFSET(post_data), AV_OPT_TYPE_BINARY, .flags = D|E },
82 #define HTTP_CLASS(flavor)\
83 static const AVClass flavor ## _context_class = {\
84 .class_name = #flavor,\
85 .item_name = av_default_item_name,\
87 .version = LIBAVUTIL_VERSION_INT,\
93 static int http_connect(URLContext *h, const char *path, const char *local_path,
94 const char *hoststr, const char *auth,
95 const char *proxyauth, int *new_location);
97 void ff_http_init_auth_state(URLContext *dest, const URLContext *src)
99 memcpy(&((HTTPContext*)dest->priv_data)->auth_state,
100 &((HTTPContext*)src->priv_data)->auth_state, sizeof(HTTPAuthState));
101 memcpy(&((HTTPContext*)dest->priv_data)->proxy_auth_state,
102 &((HTTPContext*)src->priv_data)->proxy_auth_state,
103 sizeof(HTTPAuthState));
106 /* return non zero if error */
107 static int http_open_cnx(URLContext *h)
109 const char *path, *proxy_path, *lower_proto = "tcp", *local_path;
110 char hostname[1024], hoststr[1024], proto[10];
111 char auth[1024], proxyauth[1024] = "";
112 char path1[MAX_URL_SIZE];
113 char buf[1024], urlbuf[MAX_URL_SIZE];
114 int port, use_proxy, err, location_changed = 0, redirects = 0, attempts = 0;
115 HTTPAuthType cur_auth_type, cur_proxy_auth_type;
116 HTTPContext *s = h->priv_data;
118 /* fill the dest addr */
120 /* needed in any case to build the host string */
121 av_url_split(proto, sizeof(proto), auth, sizeof(auth),
122 hostname, sizeof(hostname), &port,
123 path1, sizeof(path1), s->location);
124 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
126 proxy_path = getenv("http_proxy");
127 use_proxy = !ff_http_match_no_proxy(getenv("no_proxy"), hostname) &&
128 proxy_path != NULL && av_strstart(proxy_path, "http://", NULL);
130 if (!strcmp(proto, "https")) {
139 if (path1[0] == '\0')
145 /* Reassemble the request URL without auth string - we don't
146 * want to leak the auth to the proxy. */
147 ff_url_join(urlbuf, sizeof(urlbuf), proto, NULL, hostname, port, "%s",
150 av_url_split(NULL, 0, proxyauth, sizeof(proxyauth),
151 hostname, sizeof(hostname), &port, NULL, 0, proxy_path);
154 ff_url_join(buf, sizeof(buf), lower_proto, NULL, hostname, port, NULL);
157 err = ffurl_open(&s->hd, buf, AVIO_FLAG_READ_WRITE,
158 &h->interrupt_callback, NULL);
163 cur_auth_type = s->auth_state.auth_type;
164 cur_proxy_auth_type = s->auth_state.auth_type;
165 if (http_connect(h, path, local_path, hoststr, auth, proxyauth, &location_changed) < 0)
168 if (s->http_code == 401) {
169 if ((cur_auth_type == HTTP_AUTH_NONE || s->auth_state.stale) &&
170 s->auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
177 if (s->http_code == 407) {
178 if ((cur_proxy_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
179 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
186 if ((s->http_code == 301 || s->http_code == 302 || s->http_code == 303 || s->http_code == 307)
187 && location_changed == 1) {
188 /* url moved, get next */
191 if (redirects++ >= MAX_REDIRECTS)
193 /* Restart the authentication process with the new target, which
194 * might use a different auth mechanism. */
195 memset(&s->auth_state, 0, sizeof(s->auth_state));
197 location_changed = 0;
208 int ff_http_do_new_request(URLContext *h, const char *uri)
210 HTTPContext *s = h->priv_data;
213 av_strlcpy(s->location, uri, sizeof(s->location));
215 return http_open_cnx(h);
218 static int http_open(URLContext *h, const char *uri, int flags)
220 HTTPContext *s = h->priv_data;
225 av_strlcpy(s->location, uri, sizeof(s->location));
228 int len = strlen(s->headers);
229 if (len < 2 || strcmp("\r\n", s->headers + len - 2))
230 av_log(h, AV_LOG_WARNING, "No trailing CRLF found in HTTP header.\n");
233 return http_open_cnx(h);
235 static int http_getc(HTTPContext *s)
238 if (s->buf_ptr >= s->buf_end) {
239 len = ffurl_read(s->hd, s->buffer, BUFFER_SIZE);
242 } else if (len == 0) {
245 s->buf_ptr = s->buffer;
246 s->buf_end = s->buffer + len;
249 return *s->buf_ptr++;
252 static int http_get_line(HTTPContext *s, char *line, int line_size)
264 if (q > line && q[-1] == '\r')
270 if ((q - line) < line_size - 1)
276 static int process_line(URLContext *h, char *line, int line_count,
279 HTTPContext *s = h->priv_data;
283 if (line[0] == '\0') {
289 if (line_count == 0) {
290 while (!av_isspace(*p) && *p != '\0')
292 while (av_isspace(*p))
294 s->http_code = strtol(p, &end, 10);
296 av_dlog(NULL, "http_code=%d\n", s->http_code);
298 /* error codes are 4xx and 5xx, but regard 401 as a success, so we
299 * don't abort until all headers have been parsed. */
300 if (s->http_code >= 400 && s->http_code < 600 && (s->http_code != 401
301 || s->auth_state.auth_type != HTTP_AUTH_NONE) &&
302 (s->http_code != 407 || s->proxy_auth_state.auth_type != HTTP_AUTH_NONE)) {
303 end += strspn(end, SPACE_CHARS);
304 av_log(h, AV_LOG_WARNING, "HTTP error %d %s\n",
309 while (*p != '\0' && *p != ':')
317 while (av_isspace(*p))
319 if (!av_strcasecmp(tag, "Location")) {
320 av_strlcpy(s->location, p, sizeof(s->location));
322 } else if (!av_strcasecmp (tag, "Content-Length") && s->filesize == -1) {
323 s->filesize = strtoll(p, NULL, 10);
324 } else if (!av_strcasecmp (tag, "Content-Range")) {
325 /* "bytes $from-$to/$document_size" */
327 if (!strncmp (p, "bytes ", 6)) {
329 s->off = strtoll(p, NULL, 10);
330 if ((slash = strchr(p, '/')) && strlen(slash) > 0)
331 s->filesize = strtoll(slash+1, NULL, 10);
333 h->is_streamed = 0; /* we _can_ in fact seek */
334 } else if (!av_strcasecmp(tag, "Accept-Ranges") && !strncmp(p, "bytes", 5)) {
336 } else if (!av_strcasecmp (tag, "Transfer-Encoding") && !av_strncasecmp(p, "chunked", 7)) {
339 } else if (!av_strcasecmp (tag, "WWW-Authenticate")) {
340 ff_http_auth_handle_header(&s->auth_state, tag, p);
341 } else if (!av_strcasecmp (tag, "Authentication-Info")) {
342 ff_http_auth_handle_header(&s->auth_state, tag, p);
343 } else if (!av_strcasecmp (tag, "Proxy-Authenticate")) {
344 ff_http_auth_handle_header(&s->proxy_auth_state, tag, p);
345 } else if (!av_strcasecmp (tag, "Connection")) {
346 if (!strcmp(p, "close"))
348 } else if (!av_strcasecmp (tag, "Content-Encoding")) {
349 if (!av_strncasecmp(p, "gzip", 4) || !av_strncasecmp(p, "deflate", 7)) {
352 inflateEnd(&s->inflate_stream);
353 if (inflateInit2(&s->inflate_stream, 32 + 15) != Z_OK) {
354 av_log(h, AV_LOG_WARNING, "Error during zlib initialisation: %s\n",
355 s->inflate_stream.msg);
356 return AVERROR(ENOSYS);
358 if (zlibCompileFlags() & (1 << 17)) {
359 av_log(h, AV_LOG_WARNING, "Your zlib was compiled without gzip support.\n");
360 return AVERROR(ENOSYS);
363 av_log(h, AV_LOG_WARNING, "Compressed (%s) content, need zlib with gzip support\n", p);
364 return AVERROR(ENOSYS);
366 } else if (!av_strncasecmp(p, "identity", 8)) {
367 // The normal, no-encoding case (although servers shouldn't include
368 // the header at all if this is the case).
370 av_log(h, AV_LOG_WARNING, "Unknown content coding: %s\n", p);
371 return AVERROR(ENOSYS);
378 static inline int has_header(const char *str, const char *header)
380 /* header + 2 to skip over CRLF prefix. (make sure you have one!) */
383 return av_stristart(str, header + 2, NULL) || av_stristr(str, header);
386 static int http_read_header(URLContext *h, int *new_location)
388 HTTPContext *s = h->priv_data;
389 char line[MAX_URL_SIZE];
395 if ((err = http_get_line(s, line, sizeof(line))) < 0)
398 av_dlog(NULL, "header='%s'\n", line);
400 err = process_line(h, line, s->line_count, new_location);
411 static int http_connect(URLContext *h, const char *path, const char *local_path,
412 const char *hoststr, const char *auth,
413 const char *proxyauth, int *new_location)
415 HTTPContext *s = h->priv_data;
417 char headers[1024] = "";
418 char *authstr = NULL, *proxyauthstr = NULL;
419 int64_t off = s->off;
424 /* send http header */
425 post = h->flags & AVIO_FLAG_WRITE;
428 /* force POST method and disable chunked encoding when
429 * custom HTTP post data is set */
434 method = post ? "POST" : "GET";
435 authstr = ff_http_auth_create_response(&s->auth_state, auth, local_path,
437 proxyauthstr = ff_http_auth_create_response(&s->proxy_auth_state, proxyauth,
440 /* set default headers if needed */
441 if (!has_header(s->headers, "\r\nUser-Agent: "))
442 len += av_strlcatf(headers + len, sizeof(headers) - len,
443 "User-Agent: %s\r\n", LIBAVFORMAT_IDENT);
444 if (!has_header(s->headers, "\r\nAccept: "))
445 len += av_strlcpy(headers + len, "Accept: */*\r\n",
446 sizeof(headers) - len);
447 if (!has_header(s->headers, "\r\nRange: ") && !post)
448 len += av_strlcatf(headers + len, sizeof(headers) - len,
449 "Range: bytes=%"PRId64"-\r\n", s->off);
451 if (!has_header(s->headers, "\r\nConnection: ")) {
452 if (s->multiple_requests) {
453 len += av_strlcpy(headers + len, "Connection: keep-alive\r\n",
454 sizeof(headers) - len);
456 len += av_strlcpy(headers + len, "Connection: close\r\n",
457 sizeof(headers) - len);
461 if (!has_header(s->headers, "\r\nHost: "))
462 len += av_strlcatf(headers + len, sizeof(headers) - len,
463 "Host: %s\r\n", hoststr);
464 if (!has_header(s->headers, "\r\nContent-Length: ") && s->post_data)
465 len += av_strlcatf(headers + len, sizeof(headers) - len,
466 "Content-Length: %d\r\n", s->post_datalen);
468 /* now add in custom headers */
470 av_strlcpy(headers + len, s->headers, sizeof(headers) - len);
472 snprintf(s->buffer, sizeof(s->buffer),
481 post && s->chunked_post ? "Transfer-Encoding: chunked\r\n" : "",
483 authstr ? authstr : "",
484 proxyauthstr ? "Proxy-" : "", proxyauthstr ? proxyauthstr : "");
487 av_freep(&proxyauthstr);
488 if ((err = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
492 if ((err = ffurl_write(s->hd, s->post_data, s->post_datalen)) < 0)
495 /* init input buffer */
496 s->buf_ptr = s->buffer;
497 s->buf_end = s->buffer;
502 s->end_chunked_post = 0;
504 if (post && !s->post_data) {
505 /* Pretend that it did work. We didn't read any header yet, since
506 * we've still to send the POST data, but the code calling this
507 * function will check http_code after we return. */
512 /* wait for header */
513 err = http_read_header(h, new_location);
517 return (off == s->off) ? 0 : -1;
521 static int http_buf_read(URLContext *h, uint8_t *buf, int size)
523 HTTPContext *s = h->priv_data;
525 /* read bytes from input buffer first */
526 len = s->buf_end - s->buf_ptr;
530 memcpy(buf, s->buf_ptr, len);
533 if (!s->willclose && s->filesize >= 0 && s->off >= s->filesize)
535 len = ffurl_read(s->hd, buf, size);
539 if (s->chunksize > 0)
546 #define DECOMPRESS_BUF_SIZE (256 * 1024)
547 static int http_buf_read_compressed(URLContext *h, uint8_t *buf, int size)
549 HTTPContext *s = h->priv_data;
552 if (!s->inflate_buffer) {
553 s->inflate_buffer = av_malloc(DECOMPRESS_BUF_SIZE);
554 if (!s->inflate_buffer)
555 return AVERROR(ENOMEM);
558 if (s->inflate_stream.avail_in == 0) {
559 int read = http_buf_read(h, s->inflate_buffer, DECOMPRESS_BUF_SIZE);
562 s->inflate_stream.next_in = s->inflate_buffer;
563 s->inflate_stream.avail_in = read;
566 s->inflate_stream.avail_out = size;
567 s->inflate_stream.next_out = buf;
569 ret = inflate(&s->inflate_stream, Z_SYNC_FLUSH);
570 if (ret != Z_OK && ret != Z_STREAM_END)
571 av_log(h, AV_LOG_WARNING, "inflate return value: %d, %s\n", ret, s->inflate_stream.msg);
573 return size - s->inflate_stream.avail_out;
577 static int http_read(URLContext *h, uint8_t *buf, int size)
579 HTTPContext *s = h->priv_data;
580 int err, new_location;
585 if (s->end_chunked_post && !s->end_header) {
586 err = http_read_header(h, &new_location);
591 if (s->chunksize >= 0) {
597 if ((err = http_get_line(s, line, sizeof(line))) < 0)
599 } while (!*line); /* skip CR LF from last chunk */
601 s->chunksize = strtoll(line, NULL, 16);
603 av_dlog(NULL, "Chunked encoding data size: %"PRId64"'\n", s->chunksize);
610 size = FFMIN(size, s->chunksize);
614 return http_buf_read_compressed(h, buf, size);
616 return http_buf_read(h, buf, size);
619 /* used only when posting data */
620 static int http_write(URLContext *h, const uint8_t *buf, int size)
622 char temp[11] = ""; /* 32-bit hex + CRLF + nul */
624 char crlf[] = "\r\n";
625 HTTPContext *s = h->priv_data;
627 if (!s->chunked_post) {
628 /* non-chunked data is sent without any special encoding */
629 return ffurl_write(s->hd, buf, size);
632 /* silently ignore zero-size data since chunk encoding that would
635 /* upload data using chunked encoding */
636 snprintf(temp, sizeof(temp), "%x\r\n", size);
638 if ((ret = ffurl_write(s->hd, temp, strlen(temp))) < 0 ||
639 (ret = ffurl_write(s->hd, buf, size)) < 0 ||
640 (ret = ffurl_write(s->hd, crlf, sizeof(crlf) - 1)) < 0)
646 static int http_shutdown(URLContext *h, int flags)
649 char footer[] = "0\r\n\r\n";
650 HTTPContext *s = h->priv_data;
652 /* signal end of chunked encoding if used */
653 if ((flags & AVIO_FLAG_WRITE) && s->chunked_post) {
654 ret = ffurl_write(s->hd, footer, sizeof(footer) - 1);
655 ret = ret > 0 ? 0 : ret;
656 s->end_chunked_post = 1;
662 static int http_close(URLContext *h)
665 HTTPContext *s = h->priv_data;
668 inflateEnd(&s->inflate_stream);
669 av_freep(&s->inflate_buffer);
672 if (!s->end_chunked_post) {
673 /* Close the write direction by sending the end of chunked encoding. */
674 ret = http_shutdown(h, h->flags);
682 static int64_t http_seek(URLContext *h, int64_t off, int whence)
684 HTTPContext *s = h->priv_data;
685 URLContext *old_hd = s->hd;
686 int64_t old_off = s->off;
687 uint8_t old_buf[BUFFER_SIZE];
690 if (whence == AVSEEK_SIZE)
692 else if ((s->filesize == -1 && whence == SEEK_END) || h->is_streamed)
695 /* we save the old context in case the seek fails */
696 old_buf_size = s->buf_end - s->buf_ptr;
697 memcpy(old_buf, s->buf_ptr, old_buf_size);
699 if (whence == SEEK_CUR)
701 else if (whence == SEEK_END)
705 /* if it fails, continue on old connection */
706 if (http_open_cnx(h) < 0) {
707 memcpy(s->buffer, old_buf, old_buf_size);
708 s->buf_ptr = s->buffer;
709 s->buf_end = s->buffer + old_buf_size;
719 http_get_file_handle(URLContext *h)
721 HTTPContext *s = h->priv_data;
722 return ffurl_get_file_handle(s->hd);
725 #if CONFIG_HTTP_PROTOCOL
726 URLProtocol ff_http_protocol = {
728 .url_open = http_open,
729 .url_read = http_read,
730 .url_write = http_write,
731 .url_seek = http_seek,
732 .url_close = http_close,
733 .url_get_file_handle = http_get_file_handle,
734 .url_shutdown = http_shutdown,
735 .priv_data_size = sizeof(HTTPContext),
736 .priv_data_class = &http_context_class,
737 .flags = URL_PROTOCOL_FLAG_NETWORK,
740 #if CONFIG_HTTPS_PROTOCOL
741 URLProtocol ff_https_protocol = {
743 .url_open = http_open,
744 .url_read = http_read,
745 .url_write = http_write,
746 .url_seek = http_seek,
747 .url_close = http_close,
748 .url_get_file_handle = http_get_file_handle,
749 .url_shutdown = http_shutdown,
750 .priv_data_size = sizeof(HTTPContext),
751 .priv_data_class = &https_context_class,
752 .flags = URL_PROTOCOL_FLAG_NETWORK,
756 #if CONFIG_HTTPPROXY_PROTOCOL
757 static int http_proxy_close(URLContext *h)
759 HTTPContext *s = h->priv_data;
765 static int http_proxy_open(URLContext *h, const char *uri, int flags)
767 HTTPContext *s = h->priv_data;
768 char hostname[1024], hoststr[1024];
769 char auth[1024], pathbuf[1024], *path;
771 int port, ret = 0, attempts = 0;
772 HTTPAuthType cur_auth_type;
778 av_url_split(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
779 pathbuf, sizeof(pathbuf), uri);
780 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
785 ff_url_join(lower_url, sizeof(lower_url), "tcp", NULL, hostname, port,
788 ret = ffurl_open(&s->hd, lower_url, AVIO_FLAG_READ_WRITE,
789 &h->interrupt_callback, NULL);
793 authstr = ff_http_auth_create_response(&s->proxy_auth_state, auth,
795 snprintf(s->buffer, sizeof(s->buffer),
796 "CONNECT %s HTTP/1.1\r\n"
798 "Connection: close\r\n"
803 authstr ? "Proxy-" : "", authstr ? authstr : "");
806 if ((ret = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
809 s->buf_ptr = s->buffer;
810 s->buf_end = s->buffer;
813 cur_auth_type = s->proxy_auth_state.auth_type;
815 /* Note: This uses buffering, potentially reading more than the
816 * HTTP header. If tunneling a protocol where the server starts
817 * the conversation, we might buffer part of that here, too.
818 * Reading that requires using the proper ffurl_read() function
819 * on this URLContext, not using the fd directly (as the tls
820 * protocol does). This shouldn't be an issue for tls though,
821 * since the client starts the conversation there, so there
822 * is no extra data that we might buffer up here.
824 ret = http_read_header(h, &new_loc);
829 if (s->http_code == 407 &&
830 (cur_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
831 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 2) {
837 if (s->http_code < 400)
846 static int http_proxy_write(URLContext *h, const uint8_t *buf, int size)
848 HTTPContext *s = h->priv_data;
849 return ffurl_write(s->hd, buf, size);
852 URLProtocol ff_httpproxy_protocol = {
854 .url_open = http_proxy_open,
855 .url_read = http_buf_read,
856 .url_write = http_proxy_write,
857 .url_close = http_proxy_close,
858 .url_get_file_handle = http_get_file_handle,
859 .priv_data_size = sizeof(HTTPContext),
860 .flags = URL_PROTOCOL_FLAG_NETWORK,