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. */
54 int end_chunked_post; /**< A flag which indicates if the end of chunked encoding has been sent. */
57 #define OFFSET(x) offsetof(HTTPContext, x)
58 #define D AV_OPT_FLAG_DECODING_PARAM
59 #define E AV_OPT_FLAG_ENCODING_PARAM
60 static const AVOption options[] = {
61 {"chunked_post", "use chunked transfer-encoding for posts", OFFSET(chunked_post), AV_OPT_TYPE_INT, {.dbl = 1}, 0, 1, E },
62 {"headers", "custom HTTP headers, can override built in default headers", OFFSET(headers), AV_OPT_TYPE_STRING, { 0 }, 0, 0, D|E },
65 #define HTTP_CLASS(flavor)\
66 static const AVClass flavor ## _context_class = {\
67 .class_name = #flavor,\
68 .item_name = av_default_item_name,\
70 .version = LIBAVUTIL_VERSION_INT,\
76 static int http_connect(URLContext *h, const char *path, const char *local_path,
77 const char *hoststr, const char *auth,
78 const char *proxyauth, int *new_location);
80 void ff_http_init_auth_state(URLContext *dest, const URLContext *src)
82 memcpy(&((HTTPContext*)dest->priv_data)->auth_state,
83 &((HTTPContext*)src->priv_data)->auth_state, sizeof(HTTPAuthState));
84 memcpy(&((HTTPContext*)dest->priv_data)->proxy_auth_state,
85 &((HTTPContext*)src->priv_data)->proxy_auth_state,
86 sizeof(HTTPAuthState));
89 /* return non zero if error */
90 static int http_open_cnx(URLContext *h)
92 const char *path, *proxy_path, *lower_proto = "tcp", *local_path;
93 char hostname[1024], hoststr[1024], proto[10];
94 char auth[1024], proxyauth[1024] = "";
96 char buf[1024], urlbuf[1024];
97 int port, use_proxy, err, location_changed = 0, redirects = 0, attempts = 0;
98 HTTPAuthType cur_auth_type, cur_proxy_auth_type;
99 HTTPContext *s = h->priv_data;
100 URLContext *hd = NULL;
102 proxy_path = getenv("http_proxy");
103 use_proxy = (proxy_path != NULL) && !getenv("no_proxy") &&
104 av_strstart(proxy_path, "http://", NULL);
106 /* fill the dest addr */
108 /* needed in any case to build the host string */
109 av_url_split(proto, sizeof(proto), auth, sizeof(auth),
110 hostname, sizeof(hostname), &port,
111 path1, sizeof(path1), s->location);
112 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
114 if (!strcmp(proto, "https")) {
123 if (path1[0] == '\0')
129 /* Reassemble the request URL without auth string - we don't
130 * want to leak the auth to the proxy. */
131 ff_url_join(urlbuf, sizeof(urlbuf), proto, NULL, hostname, port, "%s",
134 av_url_split(NULL, 0, proxyauth, sizeof(proxyauth),
135 hostname, sizeof(hostname), &port, NULL, 0, proxy_path);
138 ff_url_join(buf, sizeof(buf), lower_proto, NULL, hostname, port, NULL);
139 err = ffurl_open(&hd, buf, AVIO_FLAG_READ_WRITE,
140 &h->interrupt_callback, NULL);
145 cur_auth_type = s->auth_state.auth_type;
146 cur_proxy_auth_type = s->auth_state.auth_type;
147 if (http_connect(h, path, local_path, hoststr, auth, proxyauth, &location_changed) < 0)
150 if (s->http_code == 401) {
151 if ((cur_auth_type == HTTP_AUTH_NONE || s->auth_state.stale) &&
152 s->auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
158 if (s->http_code == 407) {
159 if ((cur_proxy_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
160 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
166 if ((s->http_code == 301 || s->http_code == 302 || s->http_code == 303 || s->http_code == 307)
167 && location_changed == 1) {
168 /* url moved, get next */
170 if (redirects++ >= MAX_REDIRECTS)
172 /* Restart the authentication process with the new target, which
173 * might use a different auth mechanism. */
174 memset(&s->auth_state, 0, sizeof(s->auth_state));
176 location_changed = 0;
187 static int http_open(URLContext *h, const char *uri, int flags)
189 HTTPContext *s = h->priv_data;
194 av_strlcpy(s->location, uri, sizeof(s->location));
197 int len = strlen(s->headers);
198 if (len < 2 || strcmp("\r\n", s->headers + len - 2))
199 av_log(h, AV_LOG_WARNING, "No trailing CRLF found in HTTP header.\n");
202 return http_open_cnx(h);
204 static int http_getc(HTTPContext *s)
207 if (s->buf_ptr >= s->buf_end) {
208 len = ffurl_read(s->hd, s->buffer, BUFFER_SIZE);
211 } else if (len == 0) {
214 s->buf_ptr = s->buffer;
215 s->buf_end = s->buffer + len;
218 return *s->buf_ptr++;
221 static int http_get_line(HTTPContext *s, char *line, int line_size)
233 if (q > line && q[-1] == '\r')
239 if ((q - line) < line_size - 1)
245 static int process_line(URLContext *h, char *line, int line_count,
248 HTTPContext *s = h->priv_data;
256 if (line_count == 0) {
257 while (!isspace(*p) && *p != '\0')
261 s->http_code = strtol(p, &end, 10);
263 av_dlog(NULL, "http_code=%d\n", s->http_code);
265 /* error codes are 4xx and 5xx, but regard 401 as a success, so we
266 * don't abort until all headers have been parsed. */
267 if (s->http_code >= 400 && s->http_code < 600 && (s->http_code != 401
268 || s->auth_state.auth_type != HTTP_AUTH_NONE) &&
269 (s->http_code != 407 || s->proxy_auth_state.auth_type != HTTP_AUTH_NONE)) {
270 end += strspn(end, SPACE_CHARS);
271 av_log(h, AV_LOG_WARNING, "HTTP error %d %s\n",
276 while (*p != '\0' && *p != ':')
286 if (!av_strcasecmp(tag, "Location")) {
287 strcpy(s->location, p);
289 } else if (!av_strcasecmp (tag, "Content-Length") && s->filesize == -1) {
290 s->filesize = atoll(p);
291 } else if (!av_strcasecmp (tag, "Content-Range")) {
292 /* "bytes $from-$to/$document_size" */
294 if (!strncmp (p, "bytes ", 6)) {
297 if ((slash = strchr(p, '/')) && strlen(slash) > 0)
298 s->filesize = atoll(slash+1);
300 h->is_streamed = 0; /* we _can_ in fact seek */
301 } else if (!av_strcasecmp(tag, "Accept-Ranges") && !strncmp(p, "bytes", 5)) {
303 } else if (!av_strcasecmp (tag, "Transfer-Encoding") && !av_strncasecmp(p, "chunked", 7)) {
306 } else if (!av_strcasecmp (tag, "WWW-Authenticate")) {
307 ff_http_auth_handle_header(&s->auth_state, tag, p);
308 } else if (!av_strcasecmp (tag, "Authentication-Info")) {
309 ff_http_auth_handle_header(&s->auth_state, tag, p);
310 } else if (!av_strcasecmp (tag, "Proxy-Authenticate")) {
311 ff_http_auth_handle_header(&s->proxy_auth_state, tag, p);
312 } else if (!av_strcasecmp (tag, "Connection")) {
313 if (!strcmp(p, "close"))
320 static inline int has_header(const char *str, const char *header)
322 /* header + 2 to skip over CRLF prefix. (make sure you have one!) */
325 return av_stristart(str, header + 2, NULL) || av_stristr(str, header);
328 static int http_read_header(URLContext *h, int *new_location)
330 HTTPContext *s = h->priv_data;
335 if (http_get_line(s, line, sizeof(line)) < 0)
338 av_dlog(NULL, "header='%s'\n", line);
340 err = process_line(h, line, s->line_count, new_location);
351 static int http_connect(URLContext *h, const char *path, const char *local_path,
352 const char *hoststr, const char *auth,
353 const char *proxyauth, int *new_location)
355 HTTPContext *s = h->priv_data;
357 char headers[1024] = "";
358 char *authstr = NULL, *proxyauthstr = NULL;
359 int64_t off = s->off;
364 /* send http header */
365 post = h->flags & AVIO_FLAG_WRITE;
366 method = post ? "POST" : "GET";
367 authstr = ff_http_auth_create_response(&s->auth_state, auth, local_path,
369 proxyauthstr = ff_http_auth_create_response(&s->proxy_auth_state, proxyauth,
372 /* set default headers if needed */
373 if (!has_header(s->headers, "\r\nUser-Agent: "))
374 len += av_strlcatf(headers + len, sizeof(headers) - len,
375 "User-Agent: %s\r\n", LIBAVFORMAT_IDENT);
376 if (!has_header(s->headers, "\r\nAccept: "))
377 len += av_strlcpy(headers + len, "Accept: */*\r\n",
378 sizeof(headers) - len);
379 if (!has_header(s->headers, "\r\nRange: ") && !post)
380 len += av_strlcatf(headers + len, sizeof(headers) - len,
381 "Range: bytes=%"PRId64"-\r\n", s->off);
382 if (!has_header(s->headers, "\r\nConnection: "))
383 len += av_strlcpy(headers + len, "Connection: close\r\n",
384 sizeof(headers)-len);
385 if (!has_header(s->headers, "\r\nHost: "))
386 len += av_strlcatf(headers + len, sizeof(headers) - len,
387 "Host: %s\r\n", hoststr);
389 /* now add in custom headers */
391 av_strlcpy(headers + len, s->headers, sizeof(headers) - len);
393 snprintf(s->buffer, sizeof(s->buffer),
402 post && s->chunked_post ? "Transfer-Encoding: chunked\r\n" : "",
404 authstr ? authstr : "",
405 proxyauthstr ? "Proxy-" : "", proxyauthstr ? proxyauthstr : "");
408 av_freep(&proxyauthstr);
409 if (ffurl_write(s->hd, s->buffer, strlen(s->buffer)) < 0)
412 /* init input buffer */
413 s->buf_ptr = s->buffer;
414 s->buf_end = s->buffer;
419 s->end_chunked_post = 0;
421 /* Pretend that it did work. We didn't read any header yet, since
422 * we've still to send the POST data, but the code calling this
423 * function will check http_code after we return. */
429 /* wait for header */
430 err = http_read_header(h, new_location);
434 return (off == s->off) ? 0 : -1;
438 static int http_buf_read(URLContext *h, uint8_t *buf, int size)
440 HTTPContext *s = h->priv_data;
442 /* read bytes from input buffer first */
443 len = s->buf_end - s->buf_ptr;
447 memcpy(buf, s->buf_ptr, len);
450 if (!s->willclose && s->filesize >= 0 && s->off >= s->filesize)
452 len = ffurl_read(s->hd, buf, size);
456 if (s->chunksize > 0)
462 static int http_read(URLContext *h, uint8_t *buf, int size)
464 HTTPContext *s = h->priv_data;
466 if (s->chunksize >= 0) {
472 if (http_get_line(s, line, sizeof(line)) < 0)
474 } while (!*line); /* skip CR LF from last chunk */
476 s->chunksize = strtoll(line, NULL, 16);
478 av_dlog(NULL, "Chunked encoding data size: %"PRId64"'\n", s->chunksize);
485 size = FFMIN(size, s->chunksize);
487 return http_buf_read(h, buf, size);
490 /* used only when posting data */
491 static int http_write(URLContext *h, const uint8_t *buf, int size)
493 char temp[11] = ""; /* 32-bit hex + CRLF + nul */
495 char crlf[] = "\r\n";
496 HTTPContext *s = h->priv_data;
498 if (!s->chunked_post) {
499 /* non-chunked data is sent without any special encoding */
500 return ffurl_write(s->hd, buf, size);
503 /* silently ignore zero-size data since chunk encoding that would
506 /* upload data using chunked encoding */
507 snprintf(temp, sizeof(temp), "%x\r\n", size);
509 if ((ret = ffurl_write(s->hd, temp, strlen(temp))) < 0 ||
510 (ret = ffurl_write(s->hd, buf, size)) < 0 ||
511 (ret = ffurl_write(s->hd, crlf, sizeof(crlf) - 1)) < 0)
517 static int http_shutdown(URLContext *h, int flags)
520 char footer[] = "0\r\n\r\n";
521 HTTPContext *s = h->priv_data;
523 /* signal end of chunked encoding if used */
524 if ((flags & AVIO_FLAG_WRITE) && s->chunked_post) {
525 ret = ffurl_write(s->hd, footer, sizeof(footer) - 1);
526 ret = ret > 0 ? 0 : ret;
527 s->end_chunked_post = 1;
533 static int http_close(URLContext *h)
536 HTTPContext *s = h->priv_data;
538 if (!s->end_chunked_post) {
539 /* Close the write direction by sending the end of chunked encoding. */
540 ret = http_shutdown(h, h->flags);
548 static int64_t http_seek(URLContext *h, int64_t off, int whence)
550 HTTPContext *s = h->priv_data;
551 URLContext *old_hd = s->hd;
552 int64_t old_off = s->off;
553 uint8_t old_buf[BUFFER_SIZE];
556 if (whence == AVSEEK_SIZE)
558 else if ((s->filesize == -1 && whence == SEEK_END) || h->is_streamed)
561 /* we save the old context in case the seek fails */
562 old_buf_size = s->buf_end - s->buf_ptr;
563 memcpy(old_buf, s->buf_ptr, old_buf_size);
565 if (whence == SEEK_CUR)
567 else if (whence == SEEK_END)
571 /* if it fails, continue on old connection */
572 if (http_open_cnx(h) < 0) {
573 memcpy(s->buffer, old_buf, old_buf_size);
574 s->buf_ptr = s->buffer;
575 s->buf_end = s->buffer + old_buf_size;
585 http_get_file_handle(URLContext *h)
587 HTTPContext *s = h->priv_data;
588 return ffurl_get_file_handle(s->hd);
591 #if CONFIG_HTTP_PROTOCOL
592 URLProtocol ff_http_protocol = {
594 .url_open = http_open,
595 .url_read = http_read,
596 .url_write = http_write,
597 .url_seek = http_seek,
598 .url_close = http_close,
599 .url_get_file_handle = http_get_file_handle,
600 .url_shutdown = http_shutdown,
601 .priv_data_size = sizeof(HTTPContext),
602 .priv_data_class = &http_context_class,
603 .flags = URL_PROTOCOL_FLAG_NETWORK,
606 #if CONFIG_HTTPS_PROTOCOL
607 URLProtocol ff_https_protocol = {
609 .url_open = http_open,
610 .url_read = http_read,
611 .url_write = http_write,
612 .url_seek = http_seek,
613 .url_close = http_close,
614 .url_get_file_handle = http_get_file_handle,
615 .priv_data_size = sizeof(HTTPContext),
616 .priv_data_class = &https_context_class,
617 .flags = URL_PROTOCOL_FLAG_NETWORK,
621 #if CONFIG_HTTPPROXY_PROTOCOL
622 static int http_proxy_close(URLContext *h)
624 HTTPContext *s = h->priv_data;
630 static int http_proxy_open(URLContext *h, const char *uri, int flags)
632 HTTPContext *s = h->priv_data;
633 char hostname[1024], hoststr[1024];
634 char auth[1024], pathbuf[1024], *path;
636 int port, ret = 0, attempts = 0;
637 HTTPAuthType cur_auth_type;
643 av_url_split(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
644 pathbuf, sizeof(pathbuf), uri);
645 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
650 ff_url_join(lower_url, sizeof(lower_url), "tcp", NULL, hostname, port,
653 ret = ffurl_open(&s->hd, lower_url, AVIO_FLAG_READ_WRITE,
654 &h->interrupt_callback, NULL);
658 authstr = ff_http_auth_create_response(&s->proxy_auth_state, auth,
660 snprintf(s->buffer, sizeof(s->buffer),
661 "CONNECT %s HTTP/1.1\r\n"
663 "Connection: close\r\n"
668 authstr ? "Proxy-" : "", authstr ? authstr : "");
671 if ((ret = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
674 s->buf_ptr = s->buffer;
675 s->buf_end = s->buffer;
678 cur_auth_type = s->proxy_auth_state.auth_type;
680 /* Note: This uses buffering, potentially reading more than the
681 * HTTP header. If tunneling a protocol where the server starts
682 * the conversation, we might buffer part of that here, too.
683 * Reading that requires using the proper ffurl_read() function
684 * on this URLContext, not using the fd directly (as the tls
685 * protocol does). This shouldn't be an issue for tls though,
686 * since the client starts the conversation there, so there
687 * is no extra data that we might buffer up here.
689 ret = http_read_header(h, &new_loc);
694 if (s->http_code == 407 &&
695 (cur_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
696 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 2) {
702 if (s->http_code < 400)
711 static int http_proxy_write(URLContext *h, const uint8_t *buf, int size)
713 HTTPContext *s = h->priv_data;
714 return ffurl_write(s->hd, buf, size);
717 URLProtocol ff_httpproxy_protocol = {
719 .url_open = http_proxy_open,
720 .url_read = http_buf_read,
721 .url_write = http_proxy_write,
722 .url_close = http_proxy_close,
723 .url_get_file_handle = http_get_file_handle,
724 .priv_data_size = sizeof(HTTPContext),
725 .flags = URL_PROTOCOL_FLAG_NETWORK,