093bb822dce96fc5fc7276049d56dd6801047b54
[ffmpeg.git] / libavformat / http.c
1 /*
2  * HTTP protocol for avconv client
3  * Copyright (c) 2000, 2001 Fabrice Bellard
4  *
5  * This file is part of Libav.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #include "libavutil/avstring.h"
23 #include "avformat.h"
24 #include <unistd.h>
25 #include "internal.h"
26 #include "network.h"
27 #include "http.h"
28 #include "os_support.h"
29 #include "httpauth.h"
30 #include "url.h"
31 #include "libavutil/opt.h"
32
33 /* XXX: POST protocol is not completely implemented because avconv uses
34    only a subset of it. */
35
36 /* used for protocol handling */
37 #define BUFFER_SIZE 1024
38 #define MAX_REDIRECTS 8
39
40 typedef struct {
41     const AVClass *class;
42     URLContext *hd;
43     unsigned char buffer[BUFFER_SIZE], *buf_ptr, *buf_end;
44     int line_count;
45     int http_code;
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     char *headers;
51     int willclose;          /**< Set if the server correctly handles Connection: close and will close the connection after feeding us the content. */
52     int chunked_post;
53 } HTTPContext;
54
55 #define OFFSET(x) offsetof(HTTPContext, x)
56 #define D AV_OPT_FLAG_DECODING_PARAM
57 #define E AV_OPT_FLAG_ENCODING_PARAM
58 static const AVOption options[] = {
59 {"chunked_post", "use chunked transfer-encoding for posts", OFFSET(chunked_post), AV_OPT_TYPE_INT, {.dbl = 1}, 0, 1, E },
60 {"headers", "custom HTTP headers, can override built in default headers", OFFSET(headers), AV_OPT_TYPE_STRING, { 0 }, 0, 0, D|E },
61 {NULL}
62 };
63 #define HTTP_CLASS(flavor)\
64 static const AVClass flavor ## _context_class = {\
65     .class_name     = #flavor,\
66     .item_name      = av_default_item_name,\
67     .option         = options,\
68     .version        = LIBAVUTIL_VERSION_INT,\
69 };
70
71 HTTP_CLASS(http);
72 HTTP_CLASS(https);
73
74 static int http_connect(URLContext *h, const char *path, const char *hoststr,
75                         const char *auth, int *new_location);
76
77 void ff_http_init_auth_state(URLContext *dest, const URLContext *src)
78 {
79     memcpy(&((HTTPContext*)dest->priv_data)->auth_state,
80            &((HTTPContext*)src->priv_data)->auth_state, sizeof(HTTPAuthState));
81 }
82
83 /* return non zero if error */
84 static int http_open_cnx(URLContext *h)
85 {
86     const char *path, *proxy_path, *lower_proto = "tcp";
87     char hostname[1024], hoststr[1024], proto[10];
88     char auth[1024];
89     char path1[1024];
90     char buf[1024];
91     int port, use_proxy, err, location_changed = 0, redirects = 0;
92     HTTPAuthType cur_auth_type;
93     HTTPContext *s = h->priv_data;
94     URLContext *hd = NULL;
95
96     proxy_path = getenv("http_proxy");
97     use_proxy = (proxy_path != NULL) && !getenv("no_proxy") &&
98         av_strstart(proxy_path, "http://", NULL);
99
100     /* fill the dest addr */
101  redo:
102     /* needed in any case to build the host string */
103     av_url_split(proto, sizeof(proto), auth, sizeof(auth),
104                  hostname, sizeof(hostname), &port,
105                  path1, sizeof(path1), s->location);
106     ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
107
108     if (use_proxy) {
109         av_url_split(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
110                      NULL, 0, proxy_path);
111         path = s->location;
112     } else {
113         if (path1[0] == '\0')
114             path = "/";
115         else
116             path = path1;
117     }
118     if (!strcmp(proto, "https")) {
119         lower_proto = "tls";
120         if (port < 0)
121             port = 443;
122     }
123     if (port < 0)
124         port = 80;
125
126     ff_url_join(buf, sizeof(buf), lower_proto, NULL, hostname, port, NULL);
127     err = ffurl_open(&hd, buf, AVIO_FLAG_READ_WRITE);
128     if (err < 0)
129         goto fail;
130
131     s->hd = hd;
132     cur_auth_type = s->auth_state.auth_type;
133     if (http_connect(h, path, hoststr, auth, &location_changed) < 0)
134         goto fail;
135     if (s->http_code == 401) {
136         if (cur_auth_type == HTTP_AUTH_NONE && s->auth_state.auth_type != HTTP_AUTH_NONE) {
137             ffurl_close(hd);
138             goto redo;
139         } else
140             goto fail;
141     }
142     if ((s->http_code == 301 || s->http_code == 302 || s->http_code == 303 || s->http_code == 307)
143         && location_changed == 1) {
144         /* url moved, get next */
145         ffurl_close(hd);
146         if (redirects++ >= MAX_REDIRECTS)
147             return AVERROR(EIO);
148         location_changed = 0;
149         goto redo;
150     }
151     return 0;
152  fail:
153     if (hd)
154         ffurl_close(hd);
155     s->hd = NULL;
156     return AVERROR(EIO);
157 }
158
159 static int http_open(URLContext *h, const char *uri, int flags)
160 {
161     HTTPContext *s = h->priv_data;
162
163     h->is_streamed = 1;
164
165     s->filesize = -1;
166     av_strlcpy(s->location, uri, sizeof(s->location));
167
168     if (s->headers) {
169         int len = strlen(s->headers);
170         if (len < 2 || strcmp("\r\n", s->headers + len - 2))
171             av_log(h, AV_LOG_WARNING, "No trailing CRLF found in HTTP header.\n");
172     }
173
174     return http_open_cnx(h);
175 }
176 static int http_getc(HTTPContext *s)
177 {
178     int len;
179     if (s->buf_ptr >= s->buf_end) {
180         len = ffurl_read(s->hd, s->buffer, BUFFER_SIZE);
181         if (len < 0) {
182             return AVERROR(EIO);
183         } else if (len == 0) {
184             return -1;
185         } else {
186             s->buf_ptr = s->buffer;
187             s->buf_end = s->buffer + len;
188         }
189     }
190     return *s->buf_ptr++;
191 }
192
193 static int http_get_line(HTTPContext *s, char *line, int line_size)
194 {
195     int ch;
196     char *q;
197
198     q = line;
199     for(;;) {
200         ch = http_getc(s);
201         if (ch < 0)
202             return AVERROR(EIO);
203         if (ch == '\n') {
204             /* process line */
205             if (q > line && q[-1] == '\r')
206                 q--;
207             *q = '\0';
208
209             return 0;
210         } else {
211             if ((q - line) < line_size - 1)
212                 *q++ = ch;
213         }
214     }
215 }
216
217 static int process_line(URLContext *h, char *line, int line_count,
218                         int *new_location)
219 {
220     HTTPContext *s = h->priv_data;
221     char *tag, *p, *end;
222
223     /* end of header */
224     if (line[0] == '\0')
225         return 0;
226
227     p = line;
228     if (line_count == 0) {
229         while (!isspace(*p) && *p != '\0')
230             p++;
231         while (isspace(*p))
232             p++;
233         s->http_code = strtol(p, &end, 10);
234
235         av_dlog(NULL, "http_code=%d\n", s->http_code);
236
237         /* error codes are 4xx and 5xx, but regard 401 as a success, so we
238          * don't abort until all headers have been parsed. */
239         if (s->http_code >= 400 && s->http_code < 600 && (s->http_code != 401
240             || s->auth_state.auth_type != HTTP_AUTH_NONE)) {
241             end += strspn(end, SPACE_CHARS);
242             av_log(h, AV_LOG_WARNING, "HTTP error %d %s\n",
243                    s->http_code, end);
244             return -1;
245         }
246     } else {
247         while (*p != '\0' && *p != ':')
248             p++;
249         if (*p != ':')
250             return 1;
251
252         *p = '\0';
253         tag = line;
254         p++;
255         while (isspace(*p))
256             p++;
257         if (!av_strcasecmp(tag, "Location")) {
258             strcpy(s->location, p);
259             *new_location = 1;
260         } else if (!av_strcasecmp (tag, "Content-Length") && s->filesize == -1) {
261             s->filesize = atoll(p);
262         } else if (!av_strcasecmp (tag, "Content-Range")) {
263             /* "bytes $from-$to/$document_size" */
264             const char *slash;
265             if (!strncmp (p, "bytes ", 6)) {
266                 p += 6;
267                 s->off = atoll(p);
268                 if ((slash = strchr(p, '/')) && strlen(slash) > 0)
269                     s->filesize = atoll(slash+1);
270             }
271             h->is_streamed = 0; /* we _can_ in fact seek */
272         } else if (!av_strcasecmp(tag, "Accept-Ranges") && !strncmp(p, "bytes", 5)) {
273             h->is_streamed = 0;
274         } else if (!av_strcasecmp (tag, "Transfer-Encoding") && !av_strncasecmp(p, "chunked", 7)) {
275             s->filesize = -1;
276             s->chunksize = 0;
277         } else if (!av_strcasecmp (tag, "WWW-Authenticate")) {
278             ff_http_auth_handle_header(&s->auth_state, tag, p);
279         } else if (!av_strcasecmp (tag, "Authentication-Info")) {
280             ff_http_auth_handle_header(&s->auth_state, tag, p);
281         } else if (!av_strcasecmp (tag, "Connection")) {
282             if (!strcmp(p, "close"))
283                 s->willclose = 1;
284         }
285     }
286     return 1;
287 }
288
289 static inline int has_header(const char *str, const char *header)
290 {
291     /* header + 2 to skip over CRLF prefix. (make sure you have one!) */
292     if (!str)
293         return 0;
294     return av_stristart(str, header + 2, NULL) || av_stristr(str, header);
295 }
296
297 static int http_connect(URLContext *h, const char *path, const char *hoststr,
298                         const char *auth, int *new_location)
299 {
300     HTTPContext *s = h->priv_data;
301     int post, err;
302     char line[1024];
303     char headers[1024] = "";
304     char *authstr = NULL;
305     int64_t off = s->off;
306     int len = 0;
307
308
309     /* send http header */
310     post = h->flags & AVIO_FLAG_WRITE;
311     authstr = ff_http_auth_create_response(&s->auth_state, auth, path,
312                                         post ? "POST" : "GET");
313
314     /* set default headers if needed */
315     if (!has_header(s->headers, "\r\nUser-Agent: "))
316        len += av_strlcatf(headers + len, sizeof(headers) - len,
317                           "User-Agent: %s\r\n", LIBAVFORMAT_IDENT);
318     if (!has_header(s->headers, "\r\nAccept: "))
319         len += av_strlcpy(headers + len, "Accept: */*\r\n",
320                           sizeof(headers) - len);
321     if (!has_header(s->headers, "\r\nRange: ") && !post)
322         len += av_strlcatf(headers + len, sizeof(headers) - len,
323                            "Range: bytes=%"PRId64"-\r\n", s->off);
324     if (!has_header(s->headers, "\r\nConnection: "))
325         len += av_strlcpy(headers + len, "Connection: close\r\n",
326                           sizeof(headers)-len);
327     if (!has_header(s->headers, "\r\nHost: "))
328         len += av_strlcatf(headers + len, sizeof(headers) - len,
329                            "Host: %s\r\n", hoststr);
330
331     /* now add in custom headers */
332     if (s->headers)
333         av_strlcpy(headers + len, s->headers, sizeof(headers) - len);
334
335     snprintf(s->buffer, sizeof(s->buffer),
336              "%s %s HTTP/1.1\r\n"
337              "%s"
338              "%s"
339              "%s"
340              "\r\n",
341              post ? "POST" : "GET",
342              path,
343              post && s->chunked_post ? "Transfer-Encoding: chunked\r\n" : "",
344              headers,
345              authstr ? authstr : "");
346
347     av_freep(&authstr);
348     if (ffurl_write(s->hd, s->buffer, strlen(s->buffer)) < 0)
349         return AVERROR(EIO);
350
351     /* init input buffer */
352     s->buf_ptr = s->buffer;
353     s->buf_end = s->buffer;
354     s->line_count = 0;
355     s->off = 0;
356     s->filesize = -1;
357     s->willclose = 0;
358     if (post) {
359         /* Pretend that it did work. We didn't read any header yet, since
360          * we've still to send the POST data, but the code calling this
361          * function will check http_code after we return. */
362         s->http_code = 200;
363         return 0;
364     }
365     s->chunksize = -1;
366
367     /* wait for header */
368     for(;;) {
369         if (http_get_line(s, line, sizeof(line)) < 0)
370             return AVERROR(EIO);
371
372         av_dlog(NULL, "header='%s'\n", line);
373
374         err = process_line(h, line, s->line_count, new_location);
375         if (err < 0)
376             return err;
377         if (err == 0)
378             break;
379         s->line_count++;
380     }
381
382     return (off == s->off) ? 0 : -1;
383 }
384
385
386 static int http_read(URLContext *h, uint8_t *buf, int size)
387 {
388     HTTPContext *s = h->priv_data;
389     int len;
390
391     if (s->chunksize >= 0) {
392         if (!s->chunksize) {
393             char line[32];
394
395             for(;;) {
396                 do {
397                     if (http_get_line(s, line, sizeof(line)) < 0)
398                         return AVERROR(EIO);
399                 } while (!*line);    /* skip CR LF from last chunk */
400
401                 s->chunksize = strtoll(line, NULL, 16);
402
403                 av_dlog(NULL, "Chunked encoding data size: %"PRId64"'\n", s->chunksize);
404
405                 if (!s->chunksize)
406                     return 0;
407                 break;
408             }
409         }
410         size = FFMIN(size, s->chunksize);
411     }
412     /* read bytes from input buffer first */
413     len = s->buf_end - s->buf_ptr;
414     if (len > 0) {
415         if (len > size)
416             len = size;
417         memcpy(buf, s->buf_ptr, len);
418         s->buf_ptr += len;
419     } else {
420         if (!s->willclose && s->filesize >= 0 && s->off >= s->filesize)
421             return AVERROR_EOF;
422         len = ffurl_read(s->hd, buf, size);
423     }
424     if (len > 0) {
425         s->off += len;
426         if (s->chunksize > 0)
427             s->chunksize -= len;
428     }
429     return len;
430 }
431
432 /* used only when posting data */
433 static int http_write(URLContext *h, const uint8_t *buf, int size)
434 {
435     char temp[11] = "";  /* 32-bit hex + CRLF + nul */
436     int ret;
437     char crlf[] = "\r\n";
438     HTTPContext *s = h->priv_data;
439
440     if (!s->chunked_post) {
441         /* non-chunked data is sent without any special encoding */
442         return ffurl_write(s->hd, buf, size);
443     }
444
445     /* silently ignore zero-size data since chunk encoding that would
446      * signal EOF */
447     if (size > 0) {
448         /* upload data using chunked encoding */
449         snprintf(temp, sizeof(temp), "%x\r\n", size);
450
451         if ((ret = ffurl_write(s->hd, temp, strlen(temp))) < 0 ||
452             (ret = ffurl_write(s->hd, buf, size)) < 0 ||
453             (ret = ffurl_write(s->hd, crlf, sizeof(crlf) - 1)) < 0)
454             return ret;
455     }
456     return size;
457 }
458
459 static int http_close(URLContext *h)
460 {
461     int ret = 0;
462     char footer[] = "0\r\n\r\n";
463     HTTPContext *s = h->priv_data;
464
465     /* signal end of chunked encoding if used */
466     if ((h->flags & AVIO_FLAG_WRITE) && s->chunked_post) {
467         ret = ffurl_write(s->hd, footer, sizeof(footer) - 1);
468         ret = ret > 0 ? 0 : ret;
469     }
470
471     if (s->hd)
472         ffurl_close(s->hd);
473     return ret;
474 }
475
476 static int64_t http_seek(URLContext *h, int64_t off, int whence)
477 {
478     HTTPContext *s = h->priv_data;
479     URLContext *old_hd = s->hd;
480     int64_t old_off = s->off;
481     uint8_t old_buf[BUFFER_SIZE];
482     int old_buf_size;
483
484     if (whence == AVSEEK_SIZE)
485         return s->filesize;
486     else if ((s->filesize == -1 && whence == SEEK_END) || h->is_streamed)
487         return -1;
488
489     /* we save the old context in case the seek fails */
490     old_buf_size = s->buf_end - s->buf_ptr;
491     memcpy(old_buf, s->buf_ptr, old_buf_size);
492     s->hd = NULL;
493     if (whence == SEEK_CUR)
494         off += s->off;
495     else if (whence == SEEK_END)
496         off += s->filesize;
497     s->off = off;
498
499     /* if it fails, continue on old connection */
500     if (http_open_cnx(h) < 0) {
501         memcpy(s->buffer, old_buf, old_buf_size);
502         s->buf_ptr = s->buffer;
503         s->buf_end = s->buffer + old_buf_size;
504         s->hd = old_hd;
505         s->off = old_off;
506         return -1;
507     }
508     ffurl_close(old_hd);
509     return off;
510 }
511
512 static int
513 http_get_file_handle(URLContext *h)
514 {
515     HTTPContext *s = h->priv_data;
516     return ffurl_get_file_handle(s->hd);
517 }
518
519 #if CONFIG_HTTP_PROTOCOL
520 URLProtocol ff_http_protocol = {
521     .name                = "http",
522     .url_open            = http_open,
523     .url_read            = http_read,
524     .url_write           = http_write,
525     .url_seek            = http_seek,
526     .url_close           = http_close,
527     .url_get_file_handle = http_get_file_handle,
528     .priv_data_size      = sizeof(HTTPContext),
529     .priv_data_class     = &http_context_class,
530 };
531 #endif
532 #if CONFIG_HTTPS_PROTOCOL
533 URLProtocol ff_https_protocol = {
534     .name                = "https",
535     .url_open            = http_open,
536     .url_read            = http_read,
537     .url_write           = http_write,
538     .url_seek            = http_seek,
539     .url_close           = http_close,
540     .url_get_file_handle = http_get_file_handle,
541     .priv_data_size      = sizeof(HTTPContext),
542     .priv_data_class     = &https_context_class,
543 };
544 #endif