2 * HTTP protocol for ffmpeg client
3 * Copyright (c) 2000, 2001 Fabrice Bellard
5 * This file is part of FFmpeg.
7 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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"
32 /* XXX: POST protocol is not completely implemented because ffmpeg uses
33 only a subset of it. */
35 /* The IO buffer size is unrelated to the max URL size in itself, but needs
36 * to be large enough to fit the full request headers (including long
39 #define BUFFER_SIZE MAX_URL_SIZE
40 #define MAX_REDIRECTS 8
45 unsigned char buffer[BUFFER_SIZE], *buf_ptr, *buf_end;
48 int64_t chunksize; /**< Used if "Transfer-Encoding: chunked" otherwise -1. */
50 int64_t off, filesize;
51 char location[MAX_URL_SIZE];
52 HTTPAuthState auth_state;
53 HTTPAuthState proxy_auth_state;
55 int willclose; /**< Set if the server correctly handles Connection: close and will close the connection after feeding us the content. */
56 int seekable; /**< Control seekability, 0 = disable, 1 = enable, -1 = probe. */
58 int end_chunked_post; /**< A flag which indicates if the end of chunked encoding has been sent. */
59 int end_header; /**< A flag which indicates we have finished to read POST reply. */
60 int multiple_requests; /**< A flag which indicates if we use persistent connections. */
66 #define OFFSET(x) offsetof(HTTPContext, x)
67 #define D AV_OPT_FLAG_DECODING_PARAM
68 #define E AV_OPT_FLAG_ENCODING_PARAM
69 #define DEC AV_OPT_FLAG_DECODING_PARAM
70 static const AVOption options[] = {
71 {"seekable", "Control seekability of connection", OFFSET(seekable), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 1, D },
72 {"chunked_post", "use chunked transfer-encoding for posts", OFFSET(chunked_post), AV_OPT_TYPE_INT, {.i64 = 1}, 0, 1, E },
73 {"headers", "custom HTTP headers, can override built in default headers", OFFSET(headers), AV_OPT_TYPE_STRING, { 0 }, 0, 0, D|E },
74 {"user-agent", "override User-Agent header", OFFSET(user_agent), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, DEC},
75 {"multiple_requests", "use persistent connections", OFFSET(multiple_requests), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D|E },
76 {"post_data", "custom HTTP post data", OFFSET(post_data), AV_OPT_TYPE_BINARY, .flags = D|E },
79 #define HTTP_CLASS(flavor)\
80 static const AVClass flavor ## _context_class = {\
81 .class_name = #flavor,\
82 .item_name = av_default_item_name,\
84 .version = LIBAVUTIL_VERSION_INT,\
90 static int http_connect(URLContext *h, const char *path, const char *local_path,
91 const char *hoststr, const char *auth,
92 const char *proxyauth, int *new_location);
94 void ff_http_init_auth_state(URLContext *dest, const URLContext *src)
96 memcpy(&((HTTPContext*)dest->priv_data)->auth_state,
97 &((HTTPContext*)src->priv_data)->auth_state, sizeof(HTTPAuthState));
98 memcpy(&((HTTPContext*)dest->priv_data)->proxy_auth_state,
99 &((HTTPContext*)src->priv_data)->proxy_auth_state,
100 sizeof(HTTPAuthState));
103 /* return non zero if error */
104 static int http_open_cnx(URLContext *h)
106 const char *path, *proxy_path, *lower_proto = "tcp", *local_path;
107 char hostname[1024], hoststr[1024], proto[10];
108 char auth[1024], proxyauth[1024] = "";
109 char path1[MAX_URL_SIZE];
110 char buf[1024], urlbuf[MAX_URL_SIZE];
111 int port, use_proxy, err, location_changed = 0, redirects = 0, attempts = 0;
112 HTTPAuthType cur_auth_type, cur_proxy_auth_type;
113 HTTPContext *s = h->priv_data;
115 proxy_path = getenv("http_proxy");
116 use_proxy = (proxy_path != NULL) && !getenv("no_proxy") &&
117 av_strstart(proxy_path, "http://", NULL);
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 if (!strcmp(proto, "https")) {
136 if (path1[0] == '\0')
142 /* Reassemble the request URL without auth string - we don't
143 * want to leak the auth to the proxy. */
144 ff_url_join(urlbuf, sizeof(urlbuf), proto, NULL, hostname, port, "%s",
147 av_url_split(NULL, 0, proxyauth, sizeof(proxyauth),
148 hostname, sizeof(hostname), &port, NULL, 0, proxy_path);
151 ff_url_join(buf, sizeof(buf), lower_proto, NULL, hostname, port, NULL);
154 err = ffurl_open(&s->hd, buf, AVIO_FLAG_READ_WRITE,
155 &h->interrupt_callback, NULL);
160 cur_auth_type = s->auth_state.auth_type;
161 cur_proxy_auth_type = s->auth_state.auth_type;
162 if (http_connect(h, path, local_path, hoststr, auth, proxyauth, &location_changed) < 0)
165 if (s->http_code == 401) {
166 if ((cur_auth_type == HTTP_AUTH_NONE || s->auth_state.stale) &&
167 s->auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
168 ffurl_closep(&s->hd);
173 if (s->http_code == 407) {
174 if ((cur_proxy_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
175 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
176 ffurl_closep(&s->hd);
181 if ((s->http_code == 301 || s->http_code == 302 || s->http_code == 303 || s->http_code == 307)
182 && location_changed == 1) {
183 /* url moved, get next */
184 ffurl_closep(&s->hd);
185 if (redirects++ >= MAX_REDIRECTS)
187 /* Restart the authentication process with the new target, which
188 * might use a different auth mechanism. */
189 memset(&s->auth_state, 0, sizeof(s->auth_state));
191 location_changed = 0;
197 ffurl_closep(&s->hd);
201 int ff_http_do_new_request(URLContext *h, const char *uri)
203 HTTPContext *s = h->priv_data;
206 av_strlcpy(s->location, uri, sizeof(s->location));
208 return http_open_cnx(h);
211 static int http_open(URLContext *h, const char *uri, int flags)
213 HTTPContext *s = h->priv_data;
215 if( s->seekable == 1 )
221 av_strlcpy(s->location, uri, sizeof(s->location));
224 int len = strlen(s->headers);
225 if (len < 2 || strcmp("\r\n", s->headers + len - 2))
226 av_log(h, AV_LOG_WARNING, "No trailing CRLF found in HTTP header.\n");
229 return http_open_cnx(h);
231 static int http_getc(HTTPContext *s)
234 if (s->buf_ptr >= s->buf_end) {
235 len = ffurl_read(s->hd, s->buffer, BUFFER_SIZE);
238 } else if (len == 0) {
241 s->buf_ptr = s->buffer;
242 s->buf_end = s->buffer + len;
245 return *s->buf_ptr++;
248 static int http_get_line(HTTPContext *s, char *line, int line_size)
260 if (q > line && q[-1] == '\r')
266 if ((q - line) < line_size - 1)
272 static int process_line(URLContext *h, char *line, int line_count,
275 HTTPContext *s = h->priv_data;
279 if (line[0] == '\0') {
285 if (line_count == 0) {
286 while (!isspace(*p) && *p != '\0')
290 s->http_code = strtol(p, &end, 10);
292 av_dlog(NULL, "http_code=%d\n", s->http_code);
294 /* error codes are 4xx and 5xx, but regard 401 as a success, so we
295 * don't abort until all headers have been parsed. */
296 if (s->http_code >= 400 && s->http_code < 600 && (s->http_code != 401
297 || s->auth_state.auth_type != HTTP_AUTH_NONE) &&
298 (s->http_code != 407 || s->proxy_auth_state.auth_type != HTTP_AUTH_NONE)) {
299 end += strspn(end, SPACE_CHARS);
300 av_log(h, AV_LOG_WARNING, "HTTP error %d %s\n",
305 while (*p != '\0' && *p != ':')
315 if (!av_strcasecmp(tag, "Location")) {
316 strcpy(s->location, p);
318 } else if (!av_strcasecmp (tag, "Content-Length") && s->filesize == -1) {
319 s->filesize = strtoll(p, NULL, 10);
320 } else if (!av_strcasecmp (tag, "Content-Range")) {
321 /* "bytes $from-$to/$document_size" */
323 if (!strncmp (p, "bytes ", 6)) {
325 s->off = strtoll(p, NULL, 10);
326 if ((slash = strchr(p, '/')) && strlen(slash) > 0)
327 s->filesize = strtoll(slash+1, NULL, 10);
329 if (s->seekable == -1 && (!s->is_akamai || s->filesize != 2147483647))
330 h->is_streamed = 0; /* we _can_ in fact seek */
331 } else if (!av_strcasecmp(tag, "Accept-Ranges") && !strncmp(p, "bytes", 5) && s->seekable == -1) {
333 } else if (!av_strcasecmp (tag, "Transfer-Encoding") && !av_strncasecmp(p, "chunked", 7)) {
336 } else if (!av_strcasecmp (tag, "WWW-Authenticate")) {
337 ff_http_auth_handle_header(&s->auth_state, tag, p);
338 } else if (!av_strcasecmp (tag, "Authentication-Info")) {
339 ff_http_auth_handle_header(&s->auth_state, tag, p);
340 } else if (!av_strcasecmp (tag, "Proxy-Authenticate")) {
341 ff_http_auth_handle_header(&s->proxy_auth_state, tag, p);
342 } else if (!av_strcasecmp (tag, "Connection")) {
343 if (!strcmp(p, "close"))
345 } else if (!av_strcasecmp (tag, "Server") && !av_strcasecmp (p, "AkamaiGHost")) {
352 static inline int has_header(const char *str, const char *header)
354 /* header + 2 to skip over CRLF prefix. (make sure you have one!) */
357 return av_stristart(str, header + 2, NULL) || av_stristr(str, header);
360 static int http_read_header(URLContext *h, int *new_location)
362 HTTPContext *s = h->priv_data;
363 char line[MAX_URL_SIZE];
369 if ((err = http_get_line(s, line, sizeof(line))) < 0)
372 av_dlog(NULL, "header='%s'\n", line);
374 err = process_line(h, line, s->line_count, new_location);
385 static int http_connect(URLContext *h, const char *path, const char *local_path,
386 const char *hoststr, const char *auth,
387 const char *proxyauth, int *new_location)
389 HTTPContext *s = h->priv_data;
391 char headers[4096] = "";
392 char *authstr = NULL, *proxyauthstr = NULL;
393 int64_t off = s->off;
398 /* send http header */
399 post = h->flags & AVIO_FLAG_WRITE;
402 /* force POST method and disable chunked encoding when
403 * custom HTTP post data is set */
408 method = post ? "POST" : "GET";
409 authstr = ff_http_auth_create_response(&s->auth_state, auth, local_path,
411 proxyauthstr = ff_http_auth_create_response(&s->proxy_auth_state, proxyauth,
414 /* set default headers if needed */
415 if (!has_header(s->headers, "\r\nUser-Agent: "))
416 len += av_strlcatf(headers + len, sizeof(headers) - len,
417 "User-Agent: %s\r\n",
418 s->user_agent ? s->user_agent : LIBAVFORMAT_IDENT);
419 if (!has_header(s->headers, "\r\nAccept: "))
420 len += av_strlcpy(headers + len, "Accept: */*\r\n",
421 sizeof(headers) - len);
422 // Note: we send this on purpose even when s->off is 0 when we're probing,
423 // since it allows us to detect more reliably if a (non-conforming)
424 // server supports seeking by analysing the reply headers.
425 if (!has_header(s->headers, "\r\nRange: ") && !post && (s->off > 0 || s->seekable == -1))
426 len += av_strlcatf(headers + len, sizeof(headers) - len,
427 "Range: bytes=%"PRId64"-\r\n", s->off);
429 if (!has_header(s->headers, "\r\nConnection: ")) {
430 if (s->multiple_requests) {
431 len += av_strlcpy(headers + len, "Connection: keep-alive\r\n",
432 sizeof(headers) - len);
434 len += av_strlcpy(headers + len, "Connection: close\r\n",
435 sizeof(headers) - len);
439 if (!has_header(s->headers, "\r\nHost: "))
440 len += av_strlcatf(headers + len, sizeof(headers) - len,
441 "Host: %s\r\n", hoststr);
442 if (!has_header(s->headers, "\r\nContent-Length: ") && s->post_data)
443 len += av_strlcatf(headers + len, sizeof(headers) - len,
444 "Content-Length: %d\r\n", s->post_datalen);
446 /* now add in custom headers */
448 av_strlcpy(headers + len, s->headers, sizeof(headers) - len);
450 snprintf(s->buffer, sizeof(s->buffer),
459 post && s->chunked_post ? "Transfer-Encoding: chunked\r\n" : "",
461 authstr ? authstr : "",
462 proxyauthstr ? "Proxy-" : "", proxyauthstr ? proxyauthstr : "");
465 av_freep(&proxyauthstr);
466 if ((err = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
470 if ((err = ffurl_write(s->hd, s->post_data, s->post_datalen)) < 0)
473 /* init input buffer */
474 s->buf_ptr = s->buffer;
475 s->buf_end = s->buffer;
480 s->end_chunked_post = 0;
482 if (post && !s->post_data) {
483 /* Pretend that it did work. We didn't read any header yet, since
484 * we've still to send the POST data, but the code calling this
485 * function will check http_code after we return. */
490 /* wait for header */
491 err = http_read_header(h, new_location);
495 return (off == s->off) ? 0 : -1;
499 static int http_buf_read(URLContext *h, uint8_t *buf, int size)
501 HTTPContext *s = h->priv_data;
503 /* read bytes from input buffer first */
504 len = s->buf_end - s->buf_ptr;
508 memcpy(buf, s->buf_ptr, len);
511 if (!s->willclose && s->filesize >= 0 && s->off >= s->filesize)
513 len = ffurl_read(s->hd, buf, size);
517 if (s->chunksize > 0)
523 static int http_read(URLContext *h, uint8_t *buf, int size)
525 HTTPContext *s = h->priv_data;
526 int err, new_location;
531 if (s->end_chunked_post && !s->end_header) {
532 err = http_read_header(h, &new_location);
537 if (s->chunksize >= 0) {
543 if ((err = http_get_line(s, line, sizeof(line))) < 0)
545 } while (!*line); /* skip CR LF from last chunk */
547 s->chunksize = strtoll(line, NULL, 16);
549 av_dlog(NULL, "Chunked encoding data size: %"PRId64"'\n", s->chunksize);
556 size = FFMIN(size, s->chunksize);
558 return http_buf_read(h, buf, size);
561 /* used only when posting data */
562 static int http_write(URLContext *h, const uint8_t *buf, int size)
564 char temp[11] = ""; /* 32-bit hex + CRLF + nul */
566 char crlf[] = "\r\n";
567 HTTPContext *s = h->priv_data;
569 if (!s->chunked_post) {
570 /* non-chunked data is sent without any special encoding */
571 return ffurl_write(s->hd, buf, size);
574 /* silently ignore zero-size data since chunk encoding that would
577 /* upload data using chunked encoding */
578 snprintf(temp, sizeof(temp), "%x\r\n", size);
580 if ((ret = ffurl_write(s->hd, temp, strlen(temp))) < 0 ||
581 (ret = ffurl_write(s->hd, buf, size)) < 0 ||
582 (ret = ffurl_write(s->hd, crlf, sizeof(crlf) - 1)) < 0)
588 static int http_shutdown(URLContext *h, int flags)
591 char footer[] = "0\r\n\r\n";
592 HTTPContext *s = h->priv_data;
594 /* signal end of chunked encoding if used */
595 if ((flags & AVIO_FLAG_WRITE) && s->chunked_post) {
596 ret = ffurl_write(s->hd, footer, sizeof(footer) - 1);
597 ret = ret > 0 ? 0 : ret;
598 s->end_chunked_post = 1;
604 static int http_close(URLContext *h)
607 HTTPContext *s = h->priv_data;
609 if (!s->end_chunked_post) {
610 /* Close the write direction by sending the end of chunked encoding. */
611 ret = http_shutdown(h, h->flags);
615 ffurl_closep(&s->hd);
619 static int64_t http_seek(URLContext *h, int64_t off, int whence)
621 HTTPContext *s = h->priv_data;
622 URLContext *old_hd = s->hd;
623 int64_t old_off = s->off;
624 uint8_t old_buf[BUFFER_SIZE];
627 if (whence == AVSEEK_SIZE)
629 else if ((s->filesize == -1 && whence == SEEK_END) || h->is_streamed)
632 /* we save the old context in case the seek fails */
633 old_buf_size = s->buf_end - s->buf_ptr;
634 memcpy(old_buf, s->buf_ptr, old_buf_size);
636 if (whence == SEEK_CUR)
638 else if (whence == SEEK_END)
642 /* if it fails, continue on old connection */
643 if (http_open_cnx(h) < 0) {
644 memcpy(s->buffer, old_buf, old_buf_size);
645 s->buf_ptr = s->buffer;
646 s->buf_end = s->buffer + old_buf_size;
656 http_get_file_handle(URLContext *h)
658 HTTPContext *s = h->priv_data;
659 return ffurl_get_file_handle(s->hd);
662 #if CONFIG_HTTP_PROTOCOL
663 URLProtocol ff_http_protocol = {
665 .url_open = http_open,
666 .url_read = http_read,
667 .url_write = http_write,
668 .url_seek = http_seek,
669 .url_close = http_close,
670 .url_get_file_handle = http_get_file_handle,
671 .url_shutdown = http_shutdown,
672 .priv_data_size = sizeof(HTTPContext),
673 .priv_data_class = &http_context_class,
674 .flags = URL_PROTOCOL_FLAG_NETWORK,
677 #if CONFIG_HTTPS_PROTOCOL
678 URLProtocol ff_https_protocol = {
680 .url_open = http_open,
681 .url_read = http_read,
682 .url_write = http_write,
683 .url_seek = http_seek,
684 .url_close = http_close,
685 .url_get_file_handle = http_get_file_handle,
686 .url_shutdown = http_shutdown,
687 .priv_data_size = sizeof(HTTPContext),
688 .priv_data_class = &https_context_class,
689 .flags = URL_PROTOCOL_FLAG_NETWORK,
693 #if CONFIG_HTTPPROXY_PROTOCOL
694 static int http_proxy_close(URLContext *h)
696 HTTPContext *s = h->priv_data;
698 ffurl_closep(&s->hd);
702 static int http_proxy_open(URLContext *h, const char *uri, int flags)
704 HTTPContext *s = h->priv_data;
705 char hostname[1024], hoststr[1024];
706 char auth[1024], pathbuf[1024], *path;
708 int port, ret = 0, attempts = 0;
709 HTTPAuthType cur_auth_type;
713 if( s->seekable == 1 )
718 av_url_split(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
719 pathbuf, sizeof(pathbuf), uri);
720 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
725 ff_url_join(lower_url, sizeof(lower_url), "tcp", NULL, hostname, port,
728 ret = ffurl_open(&s->hd, lower_url, AVIO_FLAG_READ_WRITE,
729 &h->interrupt_callback, NULL);
733 authstr = ff_http_auth_create_response(&s->proxy_auth_state, auth,
735 snprintf(s->buffer, sizeof(s->buffer),
736 "CONNECT %s HTTP/1.1\r\n"
738 "Connection: close\r\n"
743 authstr ? "Proxy-" : "", authstr ? authstr : "");
746 if ((ret = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
749 s->buf_ptr = s->buffer;
750 s->buf_end = s->buffer;
753 cur_auth_type = s->proxy_auth_state.auth_type;
755 /* Note: This uses buffering, potentially reading more than the
756 * HTTP header. If tunneling a protocol where the server starts
757 * the conversation, we might buffer part of that here, too.
758 * Reading that requires using the proper ffurl_read() function
759 * on this URLContext, not using the fd directly (as the tls
760 * protocol does). This shouldn't be an issue for tls though,
761 * since the client starts the conversation there, so there
762 * is no extra data that we might buffer up here.
764 ret = http_read_header(h, &new_loc);
769 if (s->http_code == 407 &&
770 (cur_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
771 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 2) {
772 ffurl_closep(&s->hd);
776 if (s->http_code < 400)
785 static int http_proxy_write(URLContext *h, const uint8_t *buf, int size)
787 HTTPContext *s = h->priv_data;
788 return ffurl_write(s->hd, buf, size);
791 URLProtocol ff_httpproxy_protocol = {
793 .url_open = http_proxy_open,
794 .url_read = http_buf_read,
795 .url_write = http_proxy_write,
796 .url_close = http_proxy_close,
797 .url_get_file_handle = http_get_file_handle,
798 .priv_data_size = sizeof(HTTPContext),
799 .flags = URL_PROTOCOL_FLAG_NETWORK,