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