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"
28 #include "os_support.h"
31 #include "libavutil/opt.h"
33 /* XXX: POST protocol is not completely implemented because avconv uses
34 only a subset of it. */
36 /* used for protocol handling */
37 #define BUFFER_SIZE 1024
38 #define MAX_REDIRECTS 8
43 unsigned char buffer[BUFFER_SIZE], *buf_ptr, *buf_end;
46 int64_t chunksize; /**< Used if "Transfer-Encoding: chunked" otherwise -1. */
47 int64_t off, filesize;
48 char location[MAX_URL_SIZE];
49 HTTPAuthState auth_state;
50 HTTPAuthState proxy_auth_state;
52 int willclose; /**< Set if the server correctly handles Connection: close and will close the connection after feeding us the content. */
56 #define OFFSET(x) offsetof(HTTPContext, x)
57 #define D AV_OPT_FLAG_DECODING_PARAM
58 #define E AV_OPT_FLAG_ENCODING_PARAM
59 static const AVOption options[] = {
60 {"chunked_post", "use chunked transfer-encoding for posts", OFFSET(chunked_post), AV_OPT_TYPE_INT, {.dbl = 1}, 0, 1, E },
61 {"headers", "custom HTTP headers, can override built in default headers", OFFSET(headers), AV_OPT_TYPE_STRING, { 0 }, 0, 0, D|E },
64 #define HTTP_CLASS(flavor)\
65 static const AVClass flavor ## _context_class = {\
66 .class_name = #flavor,\
67 .item_name = av_default_item_name,\
69 .version = LIBAVUTIL_VERSION_INT,\
75 static int http_connect(URLContext *h, const char *path, const char *local_path,
76 const char *hoststr, const char *auth,
77 const char *proxyauth, int *new_location);
79 void ff_http_init_auth_state(URLContext *dest, const URLContext *src)
81 memcpy(&((HTTPContext*)dest->priv_data)->auth_state,
82 &((HTTPContext*)src->priv_data)->auth_state, sizeof(HTTPAuthState));
83 memcpy(&((HTTPContext*)dest->priv_data)->proxy_auth_state,
84 &((HTTPContext*)src->priv_data)->proxy_auth_state,
85 sizeof(HTTPAuthState));
88 /* return non zero if error */
89 static int http_open_cnx(URLContext *h)
91 const char *path, *proxy_path, *lower_proto = "tcp", *local_path;
92 char hostname[1024], hoststr[1024], proto[10];
93 char auth[1024], proxyauth[1024] = "";
95 char buf[1024], urlbuf[1024];
96 int port, use_proxy, err, location_changed = 0, redirects = 0, attempts = 0;
97 HTTPAuthType cur_auth_type, cur_proxy_auth_type;
98 HTTPContext *s = h->priv_data;
99 URLContext *hd = NULL;
101 proxy_path = getenv("http_proxy");
102 use_proxy = (proxy_path != NULL) && !getenv("no_proxy") &&
103 av_strstart(proxy_path, "http://", NULL);
105 /* fill the dest addr */
107 /* needed in any case to build the host string */
108 av_url_split(proto, sizeof(proto), auth, sizeof(auth),
109 hostname, sizeof(hostname), &port,
110 path1, sizeof(path1), s->location);
111 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
113 if (!strcmp(proto, "https")) {
122 if (path1[0] == '\0')
128 /* Reassemble the request URL without auth string - we don't
129 * want to leak the auth to the proxy. */
130 ff_url_join(urlbuf, sizeof(urlbuf), proto, NULL, hostname, port, "%s",
133 av_url_split(NULL, 0, proxyauth, sizeof(proxyauth),
134 hostname, sizeof(hostname), &port, NULL, 0, proxy_path);
137 ff_url_join(buf, sizeof(buf), lower_proto, NULL, hostname, port, NULL);
138 err = ffurl_open(&hd, buf, AVIO_FLAG_READ_WRITE,
139 &h->interrupt_callback, NULL);
144 cur_auth_type = s->auth_state.auth_type;
145 cur_proxy_auth_type = s->auth_state.auth_type;
146 if (http_connect(h, path, local_path, hoststr, auth, proxyauth, &location_changed) < 0)
149 if (s->http_code == 401) {
150 if ((cur_auth_type == HTTP_AUTH_NONE || s->auth_state.stale) &&
151 s->auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
157 if (s->http_code == 407) {
158 if ((cur_proxy_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
159 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
165 if ((s->http_code == 301 || s->http_code == 302 || s->http_code == 303 || s->http_code == 307)
166 && location_changed == 1) {
167 /* url moved, get next */
169 if (redirects++ >= MAX_REDIRECTS)
171 /* Restart the authentication process with the new target, which
172 * might use a different auth mechanism. */
173 memset(&s->auth_state, 0, sizeof(s->auth_state));
175 location_changed = 0;
186 static int http_open(URLContext *h, const char *uri, int flags)
188 HTTPContext *s = h->priv_data;
193 av_strlcpy(s->location, uri, sizeof(s->location));
196 int len = strlen(s->headers);
197 if (len < 2 || strcmp("\r\n", s->headers + len - 2))
198 av_log(h, AV_LOG_WARNING, "No trailing CRLF found in HTTP header.\n");
201 return http_open_cnx(h);
203 static int http_getc(HTTPContext *s)
206 if (s->buf_ptr >= s->buf_end) {
207 len = ffurl_read(s->hd, s->buffer, BUFFER_SIZE);
210 } else if (len == 0) {
213 s->buf_ptr = s->buffer;
214 s->buf_end = s->buffer + len;
217 return *s->buf_ptr++;
220 static int http_get_line(HTTPContext *s, char *line, int line_size)
232 if (q > line && q[-1] == '\r')
238 if ((q - line) < line_size - 1)
244 static int process_line(URLContext *h, char *line, int line_count,
247 HTTPContext *s = h->priv_data;
255 if (line_count == 0) {
256 while (!isspace(*p) && *p != '\0')
260 s->http_code = strtol(p, &end, 10);
262 av_dlog(NULL, "http_code=%d\n", s->http_code);
264 /* error codes are 4xx and 5xx, but regard 401 as a success, so we
265 * don't abort until all headers have been parsed. */
266 if (s->http_code >= 400 && s->http_code < 600 && (s->http_code != 401
267 || s->auth_state.auth_type != HTTP_AUTH_NONE) &&
268 (s->http_code != 407 || s->proxy_auth_state.auth_type != HTTP_AUTH_NONE)) {
269 end += strspn(end, SPACE_CHARS);
270 av_log(h, AV_LOG_WARNING, "HTTP error %d %s\n",
275 while (*p != '\0' && *p != ':')
285 if (!av_strcasecmp(tag, "Location")) {
286 strcpy(s->location, p);
288 } else if (!av_strcasecmp (tag, "Content-Length") && s->filesize == -1) {
289 s->filesize = atoll(p);
290 } else if (!av_strcasecmp (tag, "Content-Range")) {
291 /* "bytes $from-$to/$document_size" */
293 if (!strncmp (p, "bytes ", 6)) {
296 if ((slash = strchr(p, '/')) && strlen(slash) > 0)
297 s->filesize = atoll(slash+1);
299 h->is_streamed = 0; /* we _can_ in fact seek */
300 } else if (!av_strcasecmp(tag, "Accept-Ranges") && !strncmp(p, "bytes", 5)) {
302 } else if (!av_strcasecmp (tag, "Transfer-Encoding") && !av_strncasecmp(p, "chunked", 7)) {
305 } else if (!av_strcasecmp (tag, "WWW-Authenticate")) {
306 ff_http_auth_handle_header(&s->auth_state, tag, p);
307 } else if (!av_strcasecmp (tag, "Authentication-Info")) {
308 ff_http_auth_handle_header(&s->auth_state, tag, p);
309 } else if (!av_strcasecmp (tag, "Proxy-Authenticate")) {
310 ff_http_auth_handle_header(&s->proxy_auth_state, tag, p);
311 } else if (!av_strcasecmp (tag, "Connection")) {
312 if (!strcmp(p, "close"))
319 static inline int has_header(const char *str, const char *header)
321 /* header + 2 to skip over CRLF prefix. (make sure you have one!) */
324 return av_stristart(str, header + 2, NULL) || av_stristr(str, header);
327 static int http_connect(URLContext *h, const char *path, const char *local_path,
328 const char *hoststr, const char *auth,
329 const char *proxyauth, int *new_location)
331 HTTPContext *s = h->priv_data;
334 char headers[1024] = "";
335 char *authstr = NULL, *proxyauthstr = NULL;
336 int64_t off = s->off;
341 /* send http header */
342 post = h->flags & AVIO_FLAG_WRITE;
343 method = post ? "POST" : "GET";
344 authstr = ff_http_auth_create_response(&s->auth_state, auth, local_path,
346 proxyauthstr = ff_http_auth_create_response(&s->proxy_auth_state, proxyauth,
349 /* set default headers if needed */
350 if (!has_header(s->headers, "\r\nUser-Agent: "))
351 len += av_strlcatf(headers + len, sizeof(headers) - len,
352 "User-Agent: %s\r\n", LIBAVFORMAT_IDENT);
353 if (!has_header(s->headers, "\r\nAccept: "))
354 len += av_strlcpy(headers + len, "Accept: */*\r\n",
355 sizeof(headers) - len);
356 if (!has_header(s->headers, "\r\nRange: ") && !post)
357 len += av_strlcatf(headers + len, sizeof(headers) - len,
358 "Range: bytes=%"PRId64"-\r\n", s->off);
359 if (!has_header(s->headers, "\r\nConnection: "))
360 len += av_strlcpy(headers + len, "Connection: close\r\n",
361 sizeof(headers)-len);
362 if (!has_header(s->headers, "\r\nHost: "))
363 len += av_strlcatf(headers + len, sizeof(headers) - len,
364 "Host: %s\r\n", hoststr);
366 /* now add in custom headers */
368 av_strlcpy(headers + len, s->headers, sizeof(headers) - len);
370 snprintf(s->buffer, sizeof(s->buffer),
379 post && s->chunked_post ? "Transfer-Encoding: chunked\r\n" : "",
381 authstr ? authstr : "",
382 proxyauthstr ? "Proxy-" : "", proxyauthstr ? proxyauthstr : "");
385 av_freep(&proxyauthstr);
386 if (ffurl_write(s->hd, s->buffer, strlen(s->buffer)) < 0)
389 /* init input buffer */
390 s->buf_ptr = s->buffer;
391 s->buf_end = s->buffer;
397 /* Pretend that it did work. We didn't read any header yet, since
398 * we've still to send the POST data, but the code calling this
399 * function will check http_code after we return. */
405 /* wait for header */
407 if (http_get_line(s, line, sizeof(line)) < 0)
410 av_dlog(NULL, "header='%s'\n", line);
412 err = process_line(h, line, s->line_count, new_location);
420 return (off == s->off) ? 0 : -1;
424 static int http_buf_read(URLContext *h, uint8_t *buf, int size)
426 HTTPContext *s = h->priv_data;
428 /* read bytes from input buffer first */
429 len = s->buf_end - s->buf_ptr;
433 memcpy(buf, s->buf_ptr, len);
436 if (!s->willclose && s->filesize >= 0 && s->off >= s->filesize)
438 len = ffurl_read(s->hd, buf, size);
442 if (s->chunksize > 0)
448 static int http_read(URLContext *h, uint8_t *buf, int size)
450 HTTPContext *s = h->priv_data;
452 if (s->chunksize >= 0) {
458 if (http_get_line(s, line, sizeof(line)) < 0)
460 } while (!*line); /* skip CR LF from last chunk */
462 s->chunksize = strtoll(line, NULL, 16);
464 av_dlog(NULL, "Chunked encoding data size: %"PRId64"'\n", s->chunksize);
471 size = FFMIN(size, s->chunksize);
473 return http_buf_read(h, buf, size);
476 /* used only when posting data */
477 static int http_write(URLContext *h, const uint8_t *buf, int size)
479 char temp[11] = ""; /* 32-bit hex + CRLF + nul */
481 char crlf[] = "\r\n";
482 HTTPContext *s = h->priv_data;
484 if (!s->chunked_post) {
485 /* non-chunked data is sent without any special encoding */
486 return ffurl_write(s->hd, buf, size);
489 /* silently ignore zero-size data since chunk encoding that would
492 /* upload data using chunked encoding */
493 snprintf(temp, sizeof(temp), "%x\r\n", size);
495 if ((ret = ffurl_write(s->hd, temp, strlen(temp))) < 0 ||
496 (ret = ffurl_write(s->hd, buf, size)) < 0 ||
497 (ret = ffurl_write(s->hd, crlf, sizeof(crlf) - 1)) < 0)
503 static int http_close(URLContext *h)
506 char footer[] = "0\r\n\r\n";
507 HTTPContext *s = h->priv_data;
509 /* signal end of chunked encoding if used */
510 if ((h->flags & AVIO_FLAG_WRITE) && s->chunked_post) {
511 ret = ffurl_write(s->hd, footer, sizeof(footer) - 1);
512 ret = ret > 0 ? 0 : ret;
520 static int64_t http_seek(URLContext *h, int64_t off, int whence)
522 HTTPContext *s = h->priv_data;
523 URLContext *old_hd = s->hd;
524 int64_t old_off = s->off;
525 uint8_t old_buf[BUFFER_SIZE];
528 if (whence == AVSEEK_SIZE)
530 else if ((s->filesize == -1 && whence == SEEK_END) || h->is_streamed)
533 /* we save the old context in case the seek fails */
534 old_buf_size = s->buf_end - s->buf_ptr;
535 memcpy(old_buf, s->buf_ptr, old_buf_size);
537 if (whence == SEEK_CUR)
539 else if (whence == SEEK_END)
543 /* if it fails, continue on old connection */
544 if (http_open_cnx(h) < 0) {
545 memcpy(s->buffer, old_buf, old_buf_size);
546 s->buf_ptr = s->buffer;
547 s->buf_end = s->buffer + old_buf_size;
557 http_get_file_handle(URLContext *h)
559 HTTPContext *s = h->priv_data;
560 return ffurl_get_file_handle(s->hd);
563 #if CONFIG_HTTP_PROTOCOL
564 URLProtocol ff_http_protocol = {
566 .url_open = http_open,
567 .url_read = http_read,
568 .url_write = http_write,
569 .url_seek = http_seek,
570 .url_close = http_close,
571 .url_get_file_handle = http_get_file_handle,
572 .priv_data_size = sizeof(HTTPContext),
573 .priv_data_class = &http_context_class,
574 .flags = URL_PROTOCOL_FLAG_NETWORK,
577 #if CONFIG_HTTPS_PROTOCOL
578 URLProtocol ff_https_protocol = {
580 .url_open = http_open,
581 .url_read = http_read,
582 .url_write = http_write,
583 .url_seek = http_seek,
584 .url_close = http_close,
585 .url_get_file_handle = http_get_file_handle,
586 .priv_data_size = sizeof(HTTPContext),
587 .priv_data_class = &https_context_class,
588 .flags = URL_PROTOCOL_FLAG_NETWORK,
592 #if CONFIG_HTTPPROXY_PROTOCOL
593 static int http_proxy_close(URLContext *h)
595 HTTPContext *s = h->priv_data;
601 static int http_proxy_open(URLContext *h, const char *uri, int flags)
603 HTTPContext *s = h->priv_data;
604 char hostname[1024], hoststr[1024];
605 char auth[1024], pathbuf[1024], *path;
606 char line[1024], lower_url[100];
607 int port, ret = 0, attempts = 0;
608 HTTPAuthType cur_auth_type;
613 av_url_split(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
614 pathbuf, sizeof(pathbuf), uri);
615 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
620 ff_url_join(lower_url, sizeof(lower_url), "tcp", NULL, hostname, port,
623 ret = ffurl_open(&s->hd, lower_url, AVIO_FLAG_READ_WRITE,
624 &h->interrupt_callback, NULL);
628 authstr = ff_http_auth_create_response(&s->proxy_auth_state, auth,
630 snprintf(s->buffer, sizeof(s->buffer),
631 "CONNECT %s HTTP/1.1\r\n"
633 "Connection: close\r\n"
638 authstr ? "Proxy-" : "", authstr ? authstr : "");
641 if ((ret = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
644 s->buf_ptr = s->buffer;
645 s->buf_end = s->buffer;
648 cur_auth_type = s->proxy_auth_state.auth_type;
652 // Note: This uses buffering, potentially reading more than the
653 // HTTP header. If tunneling a protocol where the server starts
654 // the conversation, we might buffer part of that here, too.
655 // Reading that requires using the proper ffurl_read() function
656 // on this URLContext, not using the fd directly (as the tls
657 // protocol does). This shouldn't be an issue for tls though,
658 // since the client starts the conversation there, so there
659 // is no extra data that we might buffer up here.
660 if (http_get_line(s, line, sizeof(line)) < 0) {
665 av_dlog(h, "header='%s'\n", line);
667 ret = process_line(h, line, s->line_count, &new_loc);
675 if (s->http_code == 407 &&
676 (cur_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
677 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 2) {
683 if (s->http_code < 400)
692 static int http_proxy_write(URLContext *h, const uint8_t *buf, int size)
694 HTTPContext *s = h->priv_data;
695 return ffurl_write(s->hd, buf, size);
698 URLProtocol ff_httpproxy_protocol = {
700 .url_open = http_proxy_open,
701 .url_read = http_buf_read,
702 .url_write = http_proxy_write,
703 .url_close = http_proxy_close,
704 .url_get_file_handle = http_get_file_handle,
705 .priv_data_size = sizeof(HTTPContext),
706 .flags = URL_PROTOCOL_FLAG_NETWORK,