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