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