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"
29 #include "os_support.h"
31 #include "libavcodec/opt.h"
33 /* XXX: POST protocol is not completely implemented because ffmpeg uses
34 only a subset of it. */
36 /* used for protocol handling */
37 #define BUFFER_SIZE 1024
39 #define MAX_REDIRECTS 8
44 unsigned char buffer[BUFFER_SIZE], *buf_ptr, *buf_end;
47 int64_t chunksize; /**< Used if "Transfer-Encoding: chunked" otherwise -1. */
48 int64_t off, filesize;
49 char location[URL_SIZE];
50 HTTPAuthState auth_state;
51 unsigned char headers[BUFFER_SIZE];
54 #define OFFSET(x) offsetof(HTTPContext, x)
55 static const AVOption options[] = {
56 {"chunksize", "use chunked transfer-encoding for posts, -1 disables it, 0 enables it", OFFSET(chunksize), FF_OPT_TYPE_INT64, 0, -1, 0 }, /* Default to 0, for chunked POSTs */
59 static const AVClass httpcontext_class = {
60 "HTTP", av_default_item_name, options, LIBAVUTIL_VERSION_INT
63 static int http_connect(URLContext *h, const char *path, const char *hoststr,
64 const char *auth, int *new_location);
66 void ff_http_set_headers(URLContext *h, const char *headers)
68 HTTPContext *s = h->priv_data;
69 int len = strlen(headers);
71 if (len && strcmp("\r\n", headers + len - 2))
72 av_log(NULL, AV_LOG_ERROR, "No trailing CRLF found in HTTP header.\n");
74 av_strlcpy(s->headers, headers, sizeof(s->headers));
77 void ff_http_set_chunked_transfer_encoding(URLContext *h, int is_chunked)
79 ((HTTPContext*)h->priv_data)->chunksize = is_chunked ? 0 : -1;
82 void ff_http_init_auth_state(URLContext *dest, const URLContext *src)
84 memcpy(&((HTTPContext*)dest->priv_data)->auth_state,
85 &((HTTPContext*)src->priv_data)->auth_state, sizeof(HTTPAuthState));
88 /* return non zero if error */
89 static int http_open_cnx(URLContext *h)
91 const char *path, *proxy_path;
92 char hostname[1024], hoststr[1024];
96 int port, use_proxy, err, location_changed = 0, redirects = 0;
97 HTTPAuthType cur_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(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
109 path1, sizeof(path1), s->location);
110 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
113 av_url_split(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
114 NULL, 0, proxy_path);
117 if (path1[0] == '\0')
125 ff_url_join(buf, sizeof(buf), "tcp", NULL, hostname, port, NULL);
126 err = url_open(&hd, buf, URL_RDWR);
131 cur_auth_type = s->auth_state.auth_type;
132 if (http_connect(h, path, hoststr, auth, &location_changed) < 0)
134 if (s->http_code == 401) {
135 if (cur_auth_type == HTTP_AUTH_NONE && s->auth_state.auth_type != HTTP_AUTH_NONE) {
141 if ((s->http_code == 302 || s->http_code == 303) && location_changed == 1) {
142 /* url moved, get next */
144 if (redirects++ >= MAX_REDIRECTS)
146 location_changed = 0;
157 static int http_open(URLContext *h, const char *uri, int flags)
159 HTTPContext *s = h->priv_data;
164 av_strlcpy(s->location, uri, URL_SIZE);
166 return http_open_cnx(h);
168 static int http_getc(HTTPContext *s)
171 if (s->buf_ptr >= s->buf_end) {
172 len = url_read(s->hd, s->buffer, BUFFER_SIZE);
175 } else if (len == 0) {
178 s->buf_ptr = s->buffer;
179 s->buf_end = s->buffer + len;
182 return *s->buf_ptr++;
185 static int http_get_line(HTTPContext *s, char *line, int line_size)
197 if (q > line && q[-1] == '\r')
203 if ((q - line) < line_size - 1)
209 static int process_line(URLContext *h, char *line, int line_count,
212 HTTPContext *s = h->priv_data;
220 if (line_count == 0) {
221 while (!isspace(*p) && *p != '\0')
225 s->http_code = strtol(p, NULL, 10);
227 dprintf(NULL, "http_code=%d\n", s->http_code);
229 /* error codes are 4xx and 5xx, but regard 401 as a success, so we
230 * don't abort until all headers have been parsed. */
231 if (s->http_code >= 400 && s->http_code < 600 && s->http_code != 401)
234 while (*p != '\0' && *p != ':')
244 if (!strcmp(tag, "Location")) {
245 strcpy(s->location, p);
247 } else if (!strcmp (tag, "Content-Length") && s->filesize == -1) {
248 s->filesize = atoll(p);
249 } else if (!strcmp (tag, "Content-Range")) {
250 /* "bytes $from-$to/$document_size" */
252 if (!strncmp (p, "bytes ", 6)) {
255 if ((slash = strchr(p, '/')) && strlen(slash) > 0)
256 s->filesize = atoll(slash+1);
258 h->is_streamed = 0; /* we _can_ in fact seek */
259 } else if (!strcmp (tag, "Transfer-Encoding") && !strncasecmp(p, "chunked", 7)) {
262 } else if (!strcmp (tag, "WWW-Authenticate")) {
263 ff_http_auth_handle_header(&s->auth_state, tag, p);
264 } else if (!strcmp (tag, "Authentication-Info")) {
265 ff_http_auth_handle_header(&s->auth_state, tag, p);
271 static inline int has_header(const char *str, const char *header)
273 /* header + 2 to skip over CRLF prefix. (make sure you have one!) */
274 return av_stristart(str, header + 2, NULL) || av_stristr(str, header);
277 static int http_connect(URLContext *h, const char *path, const char *hoststr,
278 const char *auth, int *new_location)
280 HTTPContext *s = h->priv_data;
283 char headers[1024] = "";
284 char *authstr = NULL;
285 int64_t off = s->off;
289 /* send http header */
290 post = h->flags & URL_WRONLY;
291 authstr = ff_http_auth_create_response(&s->auth_state, auth, path,
292 post ? "POST" : "GET");
294 /* set default headers if needed */
295 if (!has_header(s->headers, "\r\nUser-Agent: "))
296 len += av_strlcatf(headers + len, sizeof(headers) - len,
297 "User-Agent: %s\r\n", LIBAVFORMAT_IDENT);
298 if (!has_header(s->headers, "\r\nAccept: "))
299 len += av_strlcpy(headers + len, "Accept: */*\r\n",
300 sizeof(headers) - len);
301 if (!has_header(s->headers, "\r\nRange: "))
302 len += av_strlcatf(headers + len, sizeof(headers) - len,
303 "Range: bytes=%"PRId64"-\r\n", s->off);
304 if (!has_header(s->headers, "\r\nConnection: "))
305 len += av_strlcpy(headers + len, "Connection: close\r\n",
306 sizeof(headers)-len);
307 if (!has_header(s->headers, "\r\nHost: "))
308 len += av_strlcatf(headers + len, sizeof(headers) - len,
309 "Host: %s\r\n", hoststr);
311 /* now add in custom headers */
312 av_strlcpy(headers+len, s->headers, sizeof(headers)-len);
314 snprintf(s->buffer, sizeof(s->buffer),
320 post ? "POST" : "GET",
322 post && s->chunksize >= 0 ? "Transfer-Encoding: chunked\r\n" : "",
324 authstr ? authstr : "");
327 if (url_write(s->hd, s->buffer, strlen(s->buffer)) < 0)
330 /* init input buffer */
331 s->buf_ptr = s->buffer;
332 s->buf_end = s->buffer;
337 /* Pretend that it did work. We didn't read any header yet, since
338 * we've still to send the POST data, but the code calling this
339 * function will check http_code after we return. */
345 /* wait for header */
347 if (http_get_line(s, line, sizeof(line)) < 0)
350 dprintf(NULL, "header='%s'\n", line);
352 err = process_line(h, line, s->line_count, new_location);
360 return (off == s->off) ? 0 : -1;
364 static int http_read(URLContext *h, uint8_t *buf, int size)
366 HTTPContext *s = h->priv_data;
369 if (s->chunksize >= 0) {
375 if (http_get_line(s, line, sizeof(line)) < 0)
377 } while (!*line); /* skip CR LF from last chunk */
379 s->chunksize = strtoll(line, NULL, 16);
381 dprintf(NULL, "Chunked encoding data size: %"PRId64"'\n", s->chunksize);
388 size = FFMIN(size, s->chunksize);
390 /* read bytes from input buffer first */
391 len = s->buf_end - s->buf_ptr;
395 memcpy(buf, s->buf_ptr, len);
398 len = url_read(s->hd, buf, size);
402 if (s->chunksize > 0)
408 /* used only when posting data */
409 static int http_write(URLContext *h, const uint8_t *buf, int size)
411 char temp[11] = ""; /* 32-bit hex + CRLF + nul */
413 char crlf[] = "\r\n";
414 HTTPContext *s = h->priv_data;
416 if (s->chunksize == -1) {
417 /* non-chunked data is sent without any special encoding */
418 return url_write(s->hd, buf, size);
421 /* silently ignore zero-size data since chunk encoding that would
424 /* upload data using chunked encoding */
425 snprintf(temp, sizeof(temp), "%x\r\n", size);
427 if ((ret = url_write(s->hd, temp, strlen(temp))) < 0 ||
428 (ret = url_write(s->hd, buf, size)) < 0 ||
429 (ret = url_write(s->hd, crlf, sizeof(crlf) - 1)) < 0)
435 static int http_close(URLContext *h)
438 char footer[] = "0\r\n\r\n";
439 HTTPContext *s = h->priv_data;
441 /* signal end of chunked encoding if used */
442 if ((h->flags & URL_WRONLY) && s->chunksize != -1) {
443 ret = url_write(s->hd, footer, sizeof(footer) - 1);
444 ret = ret > 0 ? 0 : ret;
452 static int64_t http_seek(URLContext *h, int64_t off, int whence)
454 HTTPContext *s = h->priv_data;
455 URLContext *old_hd = s->hd;
456 int64_t old_off = s->off;
457 uint8_t old_buf[BUFFER_SIZE];
460 if (whence == AVSEEK_SIZE)
462 else if ((s->filesize == -1 && whence == SEEK_END) || h->is_streamed)
465 /* we save the old context in case the seek fails */
466 old_buf_size = s->buf_end - s->buf_ptr;
467 memcpy(old_buf, s->buf_ptr, old_buf_size);
469 if (whence == SEEK_CUR)
471 else if (whence == SEEK_END)
475 /* if it fails, continue on old connection */
476 if (http_open_cnx(h) < 0) {
477 memcpy(s->buffer, old_buf, old_buf_size);
478 s->buf_ptr = s->buffer;
479 s->buf_end = s->buffer + old_buf_size;
489 http_get_file_handle(URLContext *h)
491 HTTPContext *s = h->priv_data;
492 return url_get_file_handle(s->hd);
495 URLProtocol http_protocol = {
502 .url_get_file_handle = http_get_file_handle,
503 .priv_data_size = sizeof(HTTPContext),
504 .priv_data_class = &httpcontext_class,