souphttpsrc: Free extra headers when finalizing the element
[platform/upstream/gst-plugins-good.git] / ext / soup / gstsouphttpsrc.c
1 /* GStreamer
2  * Copyright (C) 2007-2008 Wouter Cloetens <wouter@mind.be>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more
13  */
14
15 /**
16  * SECTION:element-souphttpsrc
17  *
18  * This plugin reads data from a remote location specified by a URI.
19  * Supported protocols are 'http', 'https'.
20  * 
21  * An HTTP proxy must be specified by its URL.
22  * If the "http_proxy" environment variable is set, its value is used.
23  * If built with libsoup's GNOME integration features, the GNOME proxy
24  * configuration will be used, or failing that, proxy autodetection.
25  * The #GstSoupHTTPSrc:proxy property can be used to override the default.
26  *
27  * In case the #GstSoupHTTPSrc:iradio-mode property is set and the location is
28  * an HTTP resource, souphttpsrc will send special Icecast HTTP headers to the
29  * server to request additional Icecast meta-information.
30  * If the server is not an Icecast server, it will behave as if the
31  * #GstSoupHTTPSrc:iradio-mode property were not set. If it is, souphttpsrc will
32  * output data with a media type of application/x-icy, in which case you will
33  * need to use the #ICYDemux element as follow-up element to extract the Icecast
34  * metadata and to determine the underlying media type.
35  *
36  * <refsect2>
37  * <title>Example launch line</title>
38  * |[
39  * gst-launch-1.0 -v souphttpsrc location=https://some.server.org/index.html
40  *     ! filesink location=/home/joe/server.html
41  * ]| The above pipeline reads a web page from a server using the HTTPS protocol
42  * and writes it to a local file.
43  * |[
44  * gst-launch-1.0 -v souphttpsrc user-agent="FooPlayer 0.99 beta"
45  *     automatic-redirect=false proxy=http://proxy.intranet.local:8080
46  *     location=http://music.foobar.com/demo.mp3 ! mad ! audioconvert
47  *     ! audioresample ! alsasink
48  * ]| The above pipeline will read and decode and play an mp3 file from a
49  * web server using the HTTP protocol. If the server sends redirects,
50  * the request fails instead of following the redirect. The specified
51  * HTTP proxy server is used. The User-Agent HTTP request header
52  * is set to a custom string instead of "GStreamer souphttpsrc."
53  * |[
54  * gst-launch-1.0 -v souphttpsrc location=http://10.11.12.13/mjpeg
55  *     do-timestamp=true ! multipartdemux
56  *     ! image/jpeg,width=640,height=480 ! matroskamux
57  *     ! filesink location=mjpeg.mkv
58  * ]| The above pipeline reads a motion JPEG stream from an IP camera
59  * using the HTTP protocol, encoded as mime/multipart image/jpeg
60  * parts, and writes a Matroska motion JPEG file. The width and
61  * height properties are set in the caps to provide the Matroska
62  * multiplexer with the information to set this in the header.
63  * Timestamps are set on the buffers as they arrive from the camera.
64  * These are used by the mime/multipart demultiplexer to emit timestamps
65  * on the JPEG-encoded video frame buffers. This allows the Matroska
66  * multiplexer to timestamp the frames in the resulting file.
67  * </refsect2>
68  */
69
70 #ifdef HAVE_CONFIG_H
71 #include "config.h"
72 #endif
73
74 #include <string.h>
75 #ifdef HAVE_STDLIB_H
76 #include <stdlib.h>             /* atoi() */
77 #endif
78 #include <gst/gstelement.h>
79 #include <gst/gst-i18n-plugin.h>
80 #include <libsoup/soup.h>
81 #include "gstsouphttpsrc.h"
82 #include "gstsouputils.h"
83
84 #include <gst/tag/tag.h>
85
86 GST_DEBUG_CATEGORY_STATIC (souphttpsrc_debug);
87 #define GST_CAT_DEFAULT souphttpsrc_debug
88
89 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
90     GST_PAD_SRC,
91     GST_PAD_ALWAYS,
92     GST_STATIC_CAPS_ANY);
93
94 enum
95 {
96   PROP_0,
97   PROP_LOCATION,
98   PROP_IS_LIVE,
99   PROP_USER_AGENT,
100   PROP_AUTOMATIC_REDIRECT,
101   PROP_PROXY,
102   PROP_USER_ID,
103   PROP_USER_PW,
104   PROP_PROXY_ID,
105   PROP_PROXY_PW,
106   PROP_COOKIES,
107   PROP_IRADIO_MODE,
108   PROP_TIMEOUT,
109   PROP_EXTRA_HEADERS,
110   PROP_SOUP_LOG_LEVEL,
111   PROP_COMPRESS,
112   PROP_KEEP_ALIVE
113 };
114
115 #define DEFAULT_USER_AGENT           "GStreamer souphttpsrc "
116 #define DEFAULT_IRADIO_MODE          TRUE
117 #define DEFAULT_SOUP_LOG_LEVEL       SOUP_LOGGER_LOG_NONE
118 #define DEFAULT_COMPRESS             FALSE
119 #define DEFAULT_KEEP_ALIVE           FALSE
120
121 static void gst_soup_http_src_uri_handler_init (gpointer g_iface,
122     gpointer iface_data);
123 static void gst_soup_http_src_finalize (GObject * gobject);
124 static void gst_soup_http_src_dispose (GObject * gobject);
125
126 static void gst_soup_http_src_set_property (GObject * object, guint prop_id,
127     const GValue * value, GParamSpec * pspec);
128 static void gst_soup_http_src_get_property (GObject * object, guint prop_id,
129     GValue * value, GParamSpec * pspec);
130
131 static GstStateChangeReturn gst_soup_http_src_change_state (GstElement *
132     element, GstStateChange transition);
133 static GstFlowReturn gst_soup_http_src_create (GstPushSrc * psrc,
134     GstBuffer ** outbuf);
135 static gboolean gst_soup_http_src_start (GstBaseSrc * bsrc);
136 static gboolean gst_soup_http_src_stop (GstBaseSrc * bsrc);
137 static gboolean gst_soup_http_src_get_size (GstBaseSrc * bsrc, guint64 * size);
138 static gboolean gst_soup_http_src_is_seekable (GstBaseSrc * bsrc);
139 static gboolean gst_soup_http_src_do_seek (GstBaseSrc * bsrc,
140     GstSegment * segment);
141 static gboolean gst_soup_http_src_query (GstBaseSrc * bsrc, GstQuery * query);
142 static gboolean gst_soup_http_src_unlock (GstBaseSrc * bsrc);
143 static gboolean gst_soup_http_src_unlock_stop (GstBaseSrc * bsrc);
144 static gboolean gst_soup_http_src_set_location (GstSoupHTTPSrc * src,
145     const gchar * uri, GError ** error);
146 static gboolean gst_soup_http_src_set_proxy (GstSoupHTTPSrc * src,
147     const gchar * uri);
148 static char *gst_soup_http_src_unicodify (const char *str);
149 static gboolean gst_soup_http_src_build_message (GstSoupHTTPSrc * src,
150     const gchar * method);
151 static void gst_soup_http_src_cancel_message (GstSoupHTTPSrc * src);
152 static void gst_soup_http_src_queue_message (GstSoupHTTPSrc * src);
153 static gboolean gst_soup_http_src_add_range_header (GstSoupHTTPSrc * src,
154     guint64 offset, guint64 stop_offset);
155 static void gst_soup_http_src_session_unpause_message (GstSoupHTTPSrc * src);
156 static void gst_soup_http_src_session_pause_message (GstSoupHTTPSrc * src);
157 static gboolean gst_soup_http_src_session_open (GstSoupHTTPSrc * src);
158 static void gst_soup_http_src_session_close (GstSoupHTTPSrc * src);
159 static void gst_soup_http_src_parse_status (SoupMessage * msg,
160     GstSoupHTTPSrc * src);
161 static void gst_soup_http_src_chunk_free (gpointer gstbuf);
162 static SoupBuffer *gst_soup_http_src_chunk_allocator (SoupMessage * msg,
163     gsize max_len, gpointer user_data);
164 static void gst_soup_http_src_got_chunk_cb (SoupMessage * msg,
165     SoupBuffer * chunk, GstSoupHTTPSrc * src);
166 static void gst_soup_http_src_response_cb (SoupSession * session,
167     SoupMessage * msg, GstSoupHTTPSrc * src);
168 static void gst_soup_http_src_got_headers_cb (SoupMessage * msg,
169     GstSoupHTTPSrc * src);
170 static void gst_soup_http_src_got_body_cb (SoupMessage * msg,
171     GstSoupHTTPSrc * src);
172 static void gst_soup_http_src_finished_cb (SoupMessage * msg,
173     GstSoupHTTPSrc * src);
174 static void gst_soup_http_src_authenticate_cb (SoupSession * session,
175     SoupMessage * msg, SoupAuth * auth, gboolean retrying,
176     GstSoupHTTPSrc * src);
177
178 #define gst_soup_http_src_parent_class parent_class
179 G_DEFINE_TYPE_WITH_CODE (GstSoupHTTPSrc, gst_soup_http_src, GST_TYPE_PUSH_SRC,
180     G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER,
181         gst_soup_http_src_uri_handler_init));
182
183 static void
184 gst_soup_http_src_class_init (GstSoupHTTPSrcClass * klass)
185 {
186   GObjectClass *gobject_class;
187   GstElementClass *gstelement_class;
188   GstBaseSrcClass *gstbasesrc_class;
189   GstPushSrcClass *gstpushsrc_class;
190
191   gobject_class = (GObjectClass *) klass;
192   gstelement_class = (GstElementClass *) klass;
193   gstbasesrc_class = (GstBaseSrcClass *) klass;
194   gstpushsrc_class = (GstPushSrcClass *) klass;
195
196   gobject_class->set_property = gst_soup_http_src_set_property;
197   gobject_class->get_property = gst_soup_http_src_get_property;
198   gobject_class->finalize = gst_soup_http_src_finalize;
199   gobject_class->dispose = gst_soup_http_src_dispose;
200
201   g_object_class_install_property (gobject_class,
202       PROP_LOCATION,
203       g_param_spec_string ("location", "Location",
204           "Location to read from", "",
205           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
206   g_object_class_install_property (gobject_class,
207       PROP_USER_AGENT,
208       g_param_spec_string ("user-agent", "User-Agent",
209           "Value of the User-Agent HTTP request header field",
210           DEFAULT_USER_AGENT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
211   g_object_class_install_property (gobject_class,
212       PROP_AUTOMATIC_REDIRECT,
213       g_param_spec_boolean ("automatic-redirect", "automatic-redirect",
214           "Automatically follow HTTP redirects (HTTP Status Code 3xx)",
215           TRUE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
216   g_object_class_install_property (gobject_class,
217       PROP_PROXY,
218       g_param_spec_string ("proxy", "Proxy",
219           "HTTP proxy server URI", "",
220           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
221   g_object_class_install_property (gobject_class,
222       PROP_USER_ID,
223       g_param_spec_string ("user-id", "user-id",
224           "HTTP location URI user id for authentication", "",
225           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
226   g_object_class_install_property (gobject_class, PROP_USER_PW,
227       g_param_spec_string ("user-pw", "user-pw",
228           "HTTP location URI user password for authentication", "",
229           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
230   g_object_class_install_property (gobject_class, PROP_PROXY_ID,
231       g_param_spec_string ("proxy-id", "proxy-id",
232           "HTTP proxy URI user id for authentication", "",
233           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
234   g_object_class_install_property (gobject_class, PROP_PROXY_PW,
235       g_param_spec_string ("proxy-pw", "proxy-pw",
236           "HTTP proxy URI user password for authentication", "",
237           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
238   g_object_class_install_property (gobject_class, PROP_COOKIES,
239       g_param_spec_boxed ("cookies", "Cookies", "HTTP request cookies",
240           G_TYPE_STRV, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
241   g_object_class_install_property (gobject_class, PROP_IS_LIVE,
242       g_param_spec_boolean ("is-live", "is-live", "Act like a live source",
243           FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
244   g_object_class_install_property (gobject_class, PROP_TIMEOUT,
245       g_param_spec_uint ("timeout", "timeout",
246           "Value in seconds to timeout a blocking I/O (0 = No timeout).", 0,
247           3600, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
248   g_object_class_install_property (gobject_class, PROP_EXTRA_HEADERS,
249       g_param_spec_boxed ("extra-headers", "Extra Headers",
250           "Extra headers to append to the HTTP request",
251           GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
252   g_object_class_install_property (gobject_class, PROP_IRADIO_MODE,
253       g_param_spec_boolean ("iradio-mode", "iradio-mode",
254           "Enable internet radio mode (ask server to send shoutcast/icecast "
255           "metadata interleaved with the actual stream data)",
256           DEFAULT_IRADIO_MODE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
257
258  /**
259    * GstSoupHTTPSrc::http-log-level:
260    *
261    * If set and > 0, captures and dumps HTTP session data as
262    * log messages if log level >= GST_LEVEL_TRACE
263    *
264    * Since: 1.4
265    */
266   g_object_class_install_property (gobject_class, PROP_SOUP_LOG_LEVEL,
267       g_param_spec_enum ("http-log-level", "HTTP log level",
268           "Set log level for soup's HTTP session log",
269           SOUP_TYPE_LOGGER_LOG_LEVEL, DEFAULT_SOUP_LOG_LEVEL,
270           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
271
272  /**
273    * GstSoupHTTPSrc::compress:
274    *
275    * If set to %TRUE, souphttpsrc will automatically handle gzip
276    * and deflate Content-Encodings. This does not make much difference
277    * and causes more load for normal media files, but makes a real
278    * difference in size for plaintext files.
279    *
280    * Since: 1.4
281    */
282   g_object_class_install_property (gobject_class, PROP_COMPRESS,
283       g_param_spec_boolean ("compress", "Compress",
284           "Allow compressed content encodings",
285           DEFAULT_COMPRESS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
286
287  /**
288    * GstSoupHTTPSrc::keep-alive:
289    *
290    * If set to %TRUE, souphttpsrc will keep alive connections when being
291    * set to READY state and only will close connections when connecting
292    * to a different server or when going to NULL state..
293    *
294    * Since: 1.4
295    */
296   g_object_class_install_property (gobject_class, PROP_KEEP_ALIVE,
297       g_param_spec_boolean ("keep-alive", "keep-alive",
298           "Use HTTP persistent connections", DEFAULT_KEEP_ALIVE,
299           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
300
301   gst_element_class_add_pad_template (gstelement_class,
302       gst_static_pad_template_get (&srctemplate));
303
304   gst_element_class_set_static_metadata (gstelement_class, "HTTP client source",
305       "Source/Network",
306       "Receive data as a client over the network via HTTP using SOUP",
307       "Wouter Cloetens <wouter@mind.be>");
308   gstelement_class->change_state =
309       GST_DEBUG_FUNCPTR (gst_soup_http_src_change_state);
310
311   gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_soup_http_src_start);
312   gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_soup_http_src_stop);
313   gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_soup_http_src_unlock);
314   gstbasesrc_class->unlock_stop =
315       GST_DEBUG_FUNCPTR (gst_soup_http_src_unlock_stop);
316   gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_soup_http_src_get_size);
317   gstbasesrc_class->is_seekable =
318       GST_DEBUG_FUNCPTR (gst_soup_http_src_is_seekable);
319   gstbasesrc_class->do_seek = GST_DEBUG_FUNCPTR (gst_soup_http_src_do_seek);
320   gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_soup_http_src_query);
321
322   gstpushsrc_class->create = GST_DEBUG_FUNCPTR (gst_soup_http_src_create);
323
324   GST_DEBUG_CATEGORY_INIT (souphttpsrc_debug, "souphttpsrc", 0,
325       "SOUP HTTP src");
326 }
327
328 static void
329 gst_soup_http_src_reset (GstSoupHTTPSrc * src)
330 {
331   src->interrupted = FALSE;
332   src->retry = FALSE;
333   src->have_size = FALSE;
334   src->got_headers = FALSE;
335   src->seekable = FALSE;
336   src->read_position = 0;
337   src->request_position = 0;
338   src->stop_position = -1;
339   src->content_size = 0;
340   src->have_body = FALSE;
341
342   gst_caps_replace (&src->src_caps, NULL);
343   g_free (src->iradio_name);
344   src->iradio_name = NULL;
345   g_free (src->iradio_genre);
346   src->iradio_genre = NULL;
347   g_free (src->iradio_url);
348   src->iradio_url = NULL;
349 }
350
351 static void
352 gst_soup_http_src_init (GstSoupHTTPSrc * src)
353 {
354   const gchar *proxy;
355
356   g_mutex_init (&src->mutex);
357   g_cond_init (&src->request_finished_cond);
358   src->location = NULL;
359   src->redirection_uri = NULL;
360   src->automatic_redirect = TRUE;
361   src->user_agent = g_strdup (DEFAULT_USER_AGENT);
362   src->user_id = NULL;
363   src->user_pw = NULL;
364   src->proxy_id = NULL;
365   src->proxy_pw = NULL;
366   src->cookies = NULL;
367   src->iradio_mode = DEFAULT_IRADIO_MODE;
368   src->loop = NULL;
369   src->context = NULL;
370   src->session = NULL;
371   src->msg = NULL;
372   src->log_level = DEFAULT_SOUP_LOG_LEVEL;
373   proxy = g_getenv ("http_proxy");
374   if (proxy && !gst_soup_http_src_set_proxy (src, proxy)) {
375     GST_WARNING_OBJECT (src,
376         "The proxy in the http_proxy env var (\"%s\") cannot be parsed.",
377         proxy);
378   }
379
380   gst_soup_http_src_reset (src);
381 }
382
383 static void
384 gst_soup_http_src_dispose (GObject * gobject)
385 {
386   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (gobject);
387
388   GST_DEBUG_OBJECT (src, "dispose");
389
390   gst_soup_http_src_session_close (src);
391
392   G_OBJECT_CLASS (parent_class)->dispose (gobject);
393 }
394
395 static void
396 gst_soup_http_src_finalize (GObject * gobject)
397 {
398   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (gobject);
399
400   GST_DEBUG_OBJECT (src, "finalize");
401
402   g_mutex_clear (&src->mutex);
403   g_cond_clear (&src->request_finished_cond);
404   g_free (src->location);
405   if (src->redirection_uri) {
406     g_free (src->redirection_uri);
407   }
408   g_free (src->user_agent);
409   if (src->proxy != NULL) {
410     soup_uri_free (src->proxy);
411   }
412   g_free (src->user_id);
413   g_free (src->user_pw);
414   g_free (src->proxy_id);
415   g_free (src->proxy_pw);
416   g_strfreev (src->cookies);
417
418   if (src->extra_headers) {
419     gst_structure_free (src->extra_headers);
420     src->extra_headers = NULL;
421   }
422
423   G_OBJECT_CLASS (parent_class)->finalize (gobject);
424 }
425
426 static void
427 gst_soup_http_src_set_property (GObject * object, guint prop_id,
428     const GValue * value, GParamSpec * pspec)
429 {
430   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (object);
431
432   switch (prop_id) {
433     case PROP_LOCATION:
434     {
435       const gchar *location;
436
437       location = g_value_get_string (value);
438
439       if (location == NULL) {
440         GST_WARNING ("location property cannot be NULL");
441         goto done;
442       }
443       if (!gst_soup_http_src_set_location (src, location, NULL)) {
444         GST_WARNING ("badly formatted location");
445         goto done;
446       }
447       break;
448     }
449     case PROP_USER_AGENT:
450       if (src->user_agent)
451         g_free (src->user_agent);
452       src->user_agent = g_value_dup_string (value);
453       break;
454     case PROP_IRADIO_MODE:
455       src->iradio_mode = g_value_get_boolean (value);
456       break;
457     case PROP_AUTOMATIC_REDIRECT:
458       src->automatic_redirect = g_value_get_boolean (value);
459       break;
460     case PROP_PROXY:
461     {
462       const gchar *proxy;
463
464       proxy = g_value_get_string (value);
465
466       if (proxy == NULL) {
467         GST_WARNING ("proxy property cannot be NULL");
468         goto done;
469       }
470       if (!gst_soup_http_src_set_proxy (src, proxy)) {
471         GST_WARNING ("badly formatted proxy URI");
472         goto done;
473       }
474       break;
475     }
476     case PROP_COOKIES:
477       g_strfreev (src->cookies);
478       src->cookies = g_strdupv (g_value_get_boxed (value));
479       break;
480     case PROP_IS_LIVE:
481       gst_base_src_set_live (GST_BASE_SRC (src), g_value_get_boolean (value));
482       break;
483     case PROP_USER_ID:
484       if (src->user_id)
485         g_free (src->user_id);
486       src->user_id = g_value_dup_string (value);
487       break;
488     case PROP_USER_PW:
489       if (src->user_pw)
490         g_free (src->user_pw);
491       src->user_pw = g_value_dup_string (value);
492       break;
493     case PROP_PROXY_ID:
494       if (src->proxy_id)
495         g_free (src->proxy_id);
496       src->proxy_id = g_value_dup_string (value);
497       break;
498     case PROP_PROXY_PW:
499       if (src->proxy_pw)
500         g_free (src->proxy_pw);
501       src->proxy_pw = g_value_dup_string (value);
502       break;
503     case PROP_TIMEOUT:
504       src->timeout = g_value_get_uint (value);
505       break;
506     case PROP_EXTRA_HEADERS:{
507       const GstStructure *s = gst_value_get_structure (value);
508
509       if (src->extra_headers)
510         gst_structure_free (src->extra_headers);
511
512       src->extra_headers = s ? gst_structure_copy (s) : NULL;
513       break;
514     }
515     case PROP_SOUP_LOG_LEVEL:
516       src->log_level = g_value_get_enum (value);
517       break;
518     case PROP_COMPRESS:
519       src->compress = g_value_get_boolean (value);
520       break;
521     case PROP_KEEP_ALIVE:
522       src->keep_alive = g_value_get_boolean (value);
523       break;
524     default:
525       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
526       break;
527   }
528 done:
529   return;
530 }
531
532 static void
533 gst_soup_http_src_get_property (GObject * object, guint prop_id,
534     GValue * value, GParamSpec * pspec)
535 {
536   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (object);
537
538   switch (prop_id) {
539     case PROP_LOCATION:
540       g_value_set_string (value, src->location);
541       break;
542     case PROP_USER_AGENT:
543       g_value_set_string (value, src->user_agent);
544       break;
545     case PROP_AUTOMATIC_REDIRECT:
546       g_value_set_boolean (value, src->automatic_redirect);
547       break;
548     case PROP_PROXY:
549       if (src->proxy == NULL)
550         g_value_set_static_string (value, "");
551       else {
552         char *proxy = soup_uri_to_string (src->proxy, FALSE);
553
554         g_value_set_string (value, proxy);
555         g_free (proxy);
556       }
557       break;
558     case PROP_COOKIES:
559       g_value_set_boxed (value, g_strdupv (src->cookies));
560       break;
561     case PROP_IS_LIVE:
562       g_value_set_boolean (value, gst_base_src_is_live (GST_BASE_SRC (src)));
563       break;
564     case PROP_IRADIO_MODE:
565       g_value_set_boolean (value, src->iradio_mode);
566       break;
567     case PROP_USER_ID:
568       g_value_set_string (value, src->user_id);
569       break;
570     case PROP_USER_PW:
571       g_value_set_string (value, src->user_pw);
572       break;
573     case PROP_PROXY_ID:
574       g_value_set_string (value, src->proxy_id);
575       break;
576     case PROP_PROXY_PW:
577       g_value_set_string (value, src->proxy_pw);
578       break;
579     case PROP_TIMEOUT:
580       g_value_set_uint (value, src->timeout);
581       break;
582     case PROP_EXTRA_HEADERS:
583       gst_value_set_structure (value, src->extra_headers);
584       break;
585     case PROP_SOUP_LOG_LEVEL:
586       g_value_set_enum (value, src->log_level);
587       break;
588     case PROP_COMPRESS:
589       g_value_set_boolean (value, src->compress);
590       break;
591     case PROP_KEEP_ALIVE:
592       g_value_set_boolean (value, src->keep_alive);
593       break;
594     default:
595       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
596       break;
597   }
598 }
599
600 static gchar *
601 gst_soup_http_src_unicodify (const gchar * str)
602 {
603   const gchar *env_vars[] = { "GST_ICY_TAG_ENCODING",
604     "GST_TAG_ENCODING", NULL
605   };
606
607   return gst_tag_freeform_string_to_utf8 (str, -1, env_vars);
608 }
609
610 static void
611 gst_soup_http_src_cancel_message (GstSoupHTTPSrc * src)
612 {
613   if (src->msg != NULL) {
614     src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_CANCELLED;
615     soup_session_cancel_message (src->session, src->msg, SOUP_STATUS_CANCELLED);
616   }
617   src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE;
618   src->msg = NULL;
619 }
620
621 static void
622 gst_soup_http_src_queue_message (GstSoupHTTPSrc * src)
623 {
624   soup_session_queue_message (src->session, src->msg,
625       (SoupSessionCallback) gst_soup_http_src_response_cb, src);
626   src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_QUEUED;
627 }
628
629 static gboolean
630 gst_soup_http_src_add_range_header (GstSoupHTTPSrc * src, guint64 offset,
631     guint64 stop_offset)
632 {
633   gchar buf[64];
634
635   gint rc;
636
637   soup_message_headers_remove (src->msg->request_headers, "Range");
638   if (offset || stop_offset != -1) {
639     if (stop_offset != -1) {
640       rc = g_snprintf (buf, sizeof (buf), "bytes=%" G_GUINT64_FORMAT "-%"
641           G_GUINT64_FORMAT, offset, stop_offset);
642     } else {
643       rc = g_snprintf (buf, sizeof (buf), "bytes=%" G_GUINT64_FORMAT "-",
644           offset);
645     }
646     if (rc > sizeof (buf) || rc < 0)
647       return FALSE;
648     soup_message_headers_append (src->msg->request_headers, "Range", buf);
649   }
650   src->read_position = offset;
651   return TRUE;
652 }
653
654 static gboolean
655 _append_extra_header (GQuark field_id, const GValue * value, gpointer user_data)
656 {
657   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (user_data);
658   const gchar *field_name = g_quark_to_string (field_id);
659   gchar *field_content = NULL;
660
661   if (G_VALUE_TYPE (value) == G_TYPE_STRING) {
662     field_content = g_value_dup_string (value);
663   } else {
664     GValue dest = { 0, };
665
666     g_value_init (&dest, G_TYPE_STRING);
667     if (g_value_transform (value, &dest)) {
668       field_content = g_value_dup_string (&dest);
669     }
670   }
671
672   if (field_content == NULL) {
673     GST_ERROR_OBJECT (src, "extra-headers field '%s' contains no value "
674         "or can't be converted to a string", field_name);
675     return FALSE;
676   }
677
678   GST_DEBUG_OBJECT (src, "Appending extra header: \"%s: %s\"", field_name,
679       field_content);
680   soup_message_headers_append (src->msg->request_headers, field_name,
681       field_content);
682
683   g_free (field_content);
684
685   return TRUE;
686 }
687
688 static gboolean
689 _append_extra_headers (GQuark field_id, const GValue * value,
690     gpointer user_data)
691 {
692   if (G_VALUE_TYPE (value) == GST_TYPE_ARRAY) {
693     guint n = gst_value_array_get_size (value);
694     guint i;
695
696     for (i = 0; i < n; i++) {
697       const GValue *v = gst_value_array_get_value (value, i);
698
699       if (!_append_extra_header (field_id, v, user_data))
700         return FALSE;
701     }
702   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
703     guint n = gst_value_list_get_size (value);
704     guint i;
705
706     for (i = 0; i < n; i++) {
707       const GValue *v = gst_value_list_get_value (value, i);
708
709       if (!_append_extra_header (field_id, v, user_data))
710         return FALSE;
711     }
712   } else {
713     return _append_extra_header (field_id, value, user_data);
714   }
715
716   return TRUE;
717 }
718
719
720 static gboolean
721 gst_soup_http_src_add_extra_headers (GstSoupHTTPSrc * src)
722 {
723   if (!src->extra_headers)
724     return TRUE;
725
726   return gst_structure_foreach (src->extra_headers, _append_extra_headers, src);
727 }
728
729
730 static void
731 gst_soup_http_src_session_unpause_message (GstSoupHTTPSrc * src)
732 {
733   soup_session_unpause_message (src->session, src->msg);
734 }
735
736 static void
737 gst_soup_http_src_session_pause_message (GstSoupHTTPSrc * src)
738 {
739   soup_session_pause_message (src->session, src->msg);
740 }
741
742 static gboolean
743 gst_soup_http_src_session_open (GstSoupHTTPSrc * src)
744 {
745   if (src->session) {
746     GST_DEBUG_OBJECT (src, "Session is already open");
747     return TRUE;
748   }
749
750   if (!src->location) {
751     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (_("No URL set.")),
752         ("Missing location property"));
753     return FALSE;
754   }
755
756   if (!src->context)
757     src->context = g_main_context_new ();
758
759   if (!src->loop)
760     src->loop = g_main_loop_new (src->context, TRUE);
761   if (!src->loop) {
762     GST_ELEMENT_ERROR (src, LIBRARY, INIT,
763         (NULL), ("Failed to start GMainLoop"));
764     g_main_context_unref (src->context);
765     return FALSE;
766   }
767
768   if (!src->session) {
769     GST_DEBUG_OBJECT (src, "Creating session");
770     if (src->proxy == NULL) {
771       src->session =
772           soup_session_async_new_with_options (SOUP_SESSION_ASYNC_CONTEXT,
773           src->context, SOUP_SESSION_USER_AGENT, src->user_agent,
774           SOUP_SESSION_TIMEOUT, src->timeout,
775           SOUP_SESSION_ADD_FEATURE_BY_TYPE, SOUP_TYPE_PROXY_RESOLVER_DEFAULT,
776           NULL);
777     } else {
778       src->session =
779           soup_session_async_new_with_options (SOUP_SESSION_ASYNC_CONTEXT,
780           src->context, SOUP_SESSION_PROXY_URI, src->proxy,
781           SOUP_SESSION_TIMEOUT, src->timeout,
782           SOUP_SESSION_USER_AGENT, src->user_agent, NULL);
783     }
784
785     if (!src->session) {
786       GST_ELEMENT_ERROR (src, LIBRARY, INIT,
787           (NULL), ("Failed to create async session"));
788       return FALSE;
789     }
790
791     g_signal_connect (src->session, "authenticate",
792         G_CALLBACK (gst_soup_http_src_authenticate_cb), src);
793
794     /* Set up logging */
795     gst_soup_util_log_setup (src->session, src->log_level, GST_ELEMENT (src));
796   } else {
797     GST_DEBUG_OBJECT (src, "Re-using session");
798   }
799
800   if (src->compress)
801     soup_session_add_feature_by_type (src->session, SOUP_TYPE_CONTENT_DECODER);
802   else
803     soup_session_remove_feature_by_type (src->session,
804         SOUP_TYPE_CONTENT_DECODER);
805
806   return TRUE;
807 }
808
809 static void
810 gst_soup_http_src_session_close (GstSoupHTTPSrc * src)
811 {
812   if (src->session) {
813     soup_session_abort (src->session);  /* This unrefs the message. */
814     g_object_unref (src->session);
815     src->session = NULL;
816     src->msg = NULL;
817   }
818   if (src->loop) {
819     g_main_loop_unref (src->loop);
820     g_main_context_unref (src->context);
821     src->loop = NULL;
822     src->context = NULL;
823   }
824 }
825
826 static void
827 gst_soup_http_src_authenticate_cb (SoupSession * session, SoupMessage * msg,
828     SoupAuth * auth, gboolean retrying, GstSoupHTTPSrc * src)
829 {
830   if (!retrying) {
831     /* First time authentication only, if we fail and are called again with retry true fall through */
832     if (msg->status_code == SOUP_STATUS_UNAUTHORIZED) {
833       if (src->user_id && src->user_pw)
834         soup_auth_authenticate (auth, src->user_id, src->user_pw);
835     } else if (msg->status_code == SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED) {
836       if (src->proxy_id && src->proxy_pw)
837         soup_auth_authenticate (auth, src->proxy_id, src->proxy_pw);
838     }
839   }
840 }
841
842 static void
843 gst_soup_http_src_got_headers_cb (SoupMessage * msg, GstSoupHTTPSrc * src)
844 {
845   const char *value;
846   GstTagList *tag_list;
847   GstBaseSrc *basesrc;
848   guint64 newsize;
849   GHashTable *params = NULL;
850
851   GST_INFO_OBJECT (src, "got headers");
852
853   if (msg->status_code == SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED &&
854       src->proxy_id && src->proxy_pw)
855     return;
856
857   if (src->automatic_redirect && SOUP_STATUS_IS_REDIRECTION (msg->status_code)) {
858     src->redirection_uri = g_strdup (soup_message_headers_get_one
859         (msg->response_headers, "Location"));
860     GST_DEBUG_OBJECT (src, "%u redirect to \"%s\"", msg->status_code,
861         src->redirection_uri);
862     return;
863   }
864
865   if (msg->status_code == SOUP_STATUS_UNAUTHORIZED)
866     return;
867
868   src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING;
869   src->got_headers = TRUE;
870
871   /* Parse Content-Length. */
872   if (soup_message_headers_get_encoding (msg->response_headers) ==
873       SOUP_ENCODING_CONTENT_LENGTH) {
874     newsize = src->request_position +
875         soup_message_headers_get_content_length (msg->response_headers);
876     if (!src->have_size || (src->content_size != newsize)) {
877       src->content_size = newsize;
878       src->have_size = TRUE;
879       src->seekable = TRUE;
880       GST_DEBUG_OBJECT (src, "size = %" G_GUINT64_FORMAT, src->content_size);
881
882       basesrc = GST_BASE_SRC_CAST (src);
883       basesrc->segment.duration = src->content_size;
884       gst_element_post_message (GST_ELEMENT (src),
885           gst_message_new_duration_changed (GST_OBJECT (src)));
886     }
887   }
888
889   /* Icecast stuff */
890   tag_list = gst_tag_list_new_empty ();
891
892   if ((value =
893           soup_message_headers_get_one (msg->response_headers,
894               "icy-metaint")) != NULL) {
895     gint icy_metaint = atoi (value);
896
897     GST_DEBUG_OBJECT (src, "icy-metaint: %s (parsed: %d)", value, icy_metaint);
898     if (icy_metaint > 0) {
899       if (src->src_caps)
900         gst_caps_unref (src->src_caps);
901
902       src->src_caps = gst_caps_new_simple ("application/x-icy",
903           "metadata-interval", G_TYPE_INT, icy_metaint, NULL);
904
905       gst_base_src_set_caps (GST_BASE_SRC (src), src->src_caps);
906     }
907   }
908   if ((value =
909           soup_message_headers_get_content_type (msg->response_headers,
910               &params)) != NULL) {
911     GST_DEBUG_OBJECT (src, "Content-Type: %s", value);
912     if (g_ascii_strcasecmp (value, "audio/L16") == 0) {
913       gint channels = 2;
914       gint rate = 44100;
915       char *param;
916
917       if (src->src_caps)
918         gst_caps_unref (src->src_caps);
919
920       param = g_hash_table_lookup (params, "channels");
921       if (param != NULL)
922         channels = atol (param);
923
924       param = g_hash_table_lookup (params, "rate");
925       if (param != NULL)
926         rate = atol (param);
927
928       src->src_caps = gst_caps_new_simple ("audio/x-raw",
929           "format", G_TYPE_STRING, "S16BE",
930           "layout", G_TYPE_STRING, "interleaved",
931           "channels", G_TYPE_INT, channels, "rate", G_TYPE_INT, rate, NULL);
932
933       gst_base_src_set_caps (GST_BASE_SRC (src), src->src_caps);
934     } else {
935       /* Set the Content-Type field on the caps */
936       if (src->src_caps) {
937         src->src_caps = gst_caps_make_writable (src->src_caps);
938         gst_caps_set_simple (src->src_caps, "content-type", G_TYPE_STRING,
939             value, NULL);
940         gst_base_src_set_caps (GST_BASE_SRC (src), src->src_caps);
941       }
942     }
943   }
944
945   if (params != NULL)
946     g_hash_table_destroy (params);
947
948   if ((value =
949           soup_message_headers_get_one (msg->response_headers,
950               "icy-name")) != NULL) {
951     g_free (src->iradio_name);
952     src->iradio_name = gst_soup_http_src_unicodify (value);
953     if (src->iradio_name) {
954       gst_tag_list_add (tag_list, GST_TAG_MERGE_REPLACE, GST_TAG_ORGANIZATION,
955           src->iradio_name, NULL);
956     }
957   }
958   if ((value =
959           soup_message_headers_get_one (msg->response_headers,
960               "icy-genre")) != NULL) {
961     g_free (src->iradio_genre);
962     src->iradio_genre = gst_soup_http_src_unicodify (value);
963     if (src->iradio_genre) {
964       gst_tag_list_add (tag_list, GST_TAG_MERGE_REPLACE, GST_TAG_GENRE,
965           src->iradio_genre, NULL);
966     }
967   }
968   if ((value = soup_message_headers_get_one (msg->response_headers, "icy-url"))
969       != NULL) {
970     g_free (src->iradio_url);
971     src->iradio_url = gst_soup_http_src_unicodify (value);
972     if (src->iradio_url) {
973       gst_tag_list_add (tag_list, GST_TAG_MERGE_REPLACE, GST_TAG_LOCATION,
974           src->iradio_url, NULL);
975     }
976   }
977   if (!gst_tag_list_is_empty (tag_list)) {
978     GST_DEBUG_OBJECT (src,
979         "calling gst_element_found_tags with %" GST_PTR_FORMAT, tag_list);
980     gst_pad_push_event (GST_BASE_SRC_PAD (src), gst_event_new_tag (tag_list));
981   } else {
982     gst_tag_list_unref (tag_list);
983   }
984
985   /* Handle HTTP errors. */
986   gst_soup_http_src_parse_status (msg, src);
987
988   /* Check if Range header was respected. */
989   if (src->ret == GST_FLOW_CUSTOM_ERROR &&
990       src->read_position && msg->status_code != SOUP_STATUS_PARTIAL_CONTENT) {
991     src->seekable = FALSE;
992     GST_ELEMENT_ERROR (src, RESOURCE, SEEK,
993         (_("Server does not support seeking.")),
994         ("Server does not accept Range HTTP header, URL: %s", src->location));
995     src->ret = GST_FLOW_ERROR;
996   }
997
998   /* If we are going to error out, stop all processing right here, so we
999    * don't output any data (such as an error html page), and return
1000    * GST_FLOW_ERROR from the create function instead of having
1001    * got_chunk_cb overwrite src->ret with FLOW_OK again. */
1002   if (src->ret == GST_FLOW_ERROR || src->ret == GST_FLOW_EOS) {
1003     gst_soup_http_src_session_pause_message (src);
1004
1005     if (src->loop)
1006       g_main_loop_quit (src->loop);
1007   }
1008   g_cond_signal (&src->request_finished_cond);
1009 }
1010
1011 /* Have body. Signal EOS. */
1012 static void
1013 gst_soup_http_src_got_body_cb (SoupMessage * msg, GstSoupHTTPSrc * src)
1014 {
1015   if (G_UNLIKELY (msg != src->msg)) {
1016     GST_DEBUG_OBJECT (src, "got body, but not for current message");
1017     return;
1018   }
1019   if (G_UNLIKELY (src->session_io_status !=
1020           GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING)) {
1021     /* Probably a redirect. */
1022     return;
1023   }
1024   GST_DEBUG_OBJECT (src, "got body");
1025   src->ret = GST_FLOW_EOS;
1026   src->have_body = TRUE;
1027
1028   /* no need to interrupt the message here, we do it on the
1029    * finished_cb anyway if needed. And getting the body might mean
1030    * that the connection was hang up before finished. This happens when
1031    * the pipeline is stalled for too long (long pauses during playback).
1032    * Best to let it continue from here and pause because it reached the
1033    * final bytes based on content_size or received an out of range error */
1034 }
1035
1036 /* Finished. Signal EOS. */
1037 static void
1038 gst_soup_http_src_finished_cb (SoupMessage * msg, GstSoupHTTPSrc * src)
1039 {
1040   if (G_UNLIKELY (msg != src->msg)) {
1041     GST_DEBUG_OBJECT (src, "finished, but not for current message");
1042     return;
1043   }
1044   GST_DEBUG_OBJECT (src, "finished");
1045   src->ret = GST_FLOW_EOS;
1046   if (src->session_io_status == GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_CANCELLED) {
1047     /* gst_soup_http_src_cancel_message() triggered this; probably a seek
1048      * that occurred in the QUEUEING state; i.e. before the connection setup
1049      * was complete. Do nothing */
1050   } else if (src->session_io_status ==
1051       GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING && src->read_position > 0 &&
1052       (src->have_size && src->read_position < src->content_size)) {
1053     /* The server disconnected while streaming. Reconnect and seeking to the
1054      * last location. */
1055     src->retry = TRUE;
1056     src->ret = GST_FLOW_CUSTOM_ERROR;
1057   } else if (G_UNLIKELY (src->session_io_status !=
1058           GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING)) {
1059     if (msg->method == SOUP_METHOD_HEAD) {
1060       GST_DEBUG_OBJECT (src, "Ignoring error %d:%s during HEAD request",
1061           msg->status_code, msg->reason_phrase);
1062     } else {
1063       gst_soup_http_src_parse_status (msg, src);
1064     }
1065   }
1066   if (src->loop)
1067     g_main_loop_quit (src->loop);
1068   g_cond_signal (&src->request_finished_cond);
1069 }
1070
1071 /* Buffer lifecycle management.
1072  *
1073  * gst_soup_http_src_create() runs the GMainLoop for this element, to let
1074  * Soup take control.
1075  * A GstBuffer is allocated in gst_soup_http_src_chunk_allocator() and
1076  * associated with a SoupBuffer.
1077  * Soup reads HTTP data in the GstBuffer's data buffer.
1078  * The gst_soup_http_src_got_chunk_cb() is then called with the SoupBuffer.
1079  * That sets gst_soup_http_src_create()'s return argument to the GstBuffer,
1080  * increments its refcount (to 2), pauses the flow of data from the HTTP
1081  * source to prevent gst_soup_http_src_got_chunk_cb() from being called
1082  * again and breaks out of the GMainLoop.
1083  * Because the SOUP_MESSAGE_OVERWRITE_CHUNKS flag is set, Soup frees the
1084  * SoupBuffer and calls gst_soup_http_src_chunk_free(), which decrements the
1085  * refcount (to 1).
1086  * gst_soup_http_src_create() returns the GstBuffer. It will be freed by a
1087  * downstream element.
1088  * If Soup fails to read HTTP data, it does not call
1089  * gst_soup_http_src_got_chunk_cb(), but still frees the SoupBuffer and
1090  * calls gst_soup_http_src_chunk_free(), which decrements the GstBuffer's
1091  * refcount to 0, freeing it.
1092  */
1093
1094 typedef struct
1095 {
1096   GstBuffer *buffer;
1097   GstMapInfo map;
1098 } SoupGstChunk;
1099
1100 static void
1101 gst_soup_http_src_chunk_free (gpointer user_data)
1102 {
1103   SoupGstChunk *chunk = (SoupGstChunk *) user_data;
1104
1105   gst_buffer_unmap (chunk->buffer, &chunk->map);
1106   gst_buffer_unref (chunk->buffer);
1107   g_slice_free (SoupGstChunk, chunk);
1108 }
1109
1110 static SoupBuffer *
1111 gst_soup_http_src_chunk_allocator (SoupMessage * msg, gsize max_len,
1112     gpointer user_data)
1113 {
1114   GstSoupHTTPSrc *src = (GstSoupHTTPSrc *) user_data;
1115   GstBaseSrc *basesrc = GST_BASE_SRC_CAST (src);
1116   GstBuffer *gstbuf;
1117   SoupBuffer *soupbuf;
1118   gsize length;
1119   GstFlowReturn rc;
1120   SoupGstChunk *chunk;
1121
1122   if (max_len)
1123     length = MIN (basesrc->blocksize, max_len);
1124   else
1125     length = basesrc->blocksize;
1126   GST_DEBUG_OBJECT (src, "alloc %" G_GSIZE_FORMAT " bytes <= %" G_GSIZE_FORMAT,
1127       length, max_len);
1128
1129   rc = GST_BASE_SRC_CLASS (parent_class)->alloc (basesrc, -1, length, &gstbuf);
1130   if (G_UNLIKELY (rc != GST_FLOW_OK)) {
1131     /* Failed to allocate buffer. Stall SoupSession and return error code
1132      * to create(). */
1133     src->ret = rc;
1134     g_main_loop_quit (src->loop);
1135     return NULL;
1136   }
1137
1138   chunk = g_slice_new0 (SoupGstChunk);
1139   chunk->buffer = gstbuf;
1140   gst_buffer_map (gstbuf, &chunk->map, GST_MAP_READWRITE);
1141
1142   soupbuf = soup_buffer_new_with_owner (chunk->map.data, chunk->map.size,
1143       chunk, gst_soup_http_src_chunk_free);
1144
1145   return soupbuf;
1146 }
1147
1148 static void
1149 gst_soup_http_src_got_chunk_cb (SoupMessage * msg, SoupBuffer * chunk,
1150     GstSoupHTTPSrc * src)
1151 {
1152   GstBaseSrc *basesrc;
1153   guint64 new_position;
1154   SoupGstChunk *gchunk;
1155
1156   if (G_UNLIKELY (msg != src->msg)) {
1157     GST_DEBUG_OBJECT (src, "got chunk, but not for current message");
1158     return;
1159   }
1160   src->have_body = FALSE;
1161   if (G_UNLIKELY (src->session_io_status !=
1162           GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING)) {
1163     /* Probably a redirect. */
1164     return;
1165   }
1166   basesrc = GST_BASE_SRC_CAST (src);
1167   GST_DEBUG_OBJECT (src, "got chunk of %" G_GSIZE_FORMAT " bytes",
1168       chunk->length);
1169
1170   /* Extract the GstBuffer from the SoupBuffer and set its fields. */
1171   gchunk = (SoupGstChunk *) soup_buffer_get_owner (chunk);
1172   *src->outbuf = gchunk->buffer;
1173
1174   gst_buffer_resize (*src->outbuf, 0, chunk->length);
1175   GST_BUFFER_OFFSET (*src->outbuf) = basesrc->segment.position;
1176
1177   gst_buffer_ref (*src->outbuf);
1178
1179   new_position = src->read_position + chunk->length;
1180   if (G_LIKELY (src->request_position == src->read_position))
1181     src->request_position = new_position;
1182   src->read_position = new_position;
1183
1184   if (src->content_size != 0 && new_position > src->content_size) {
1185     GST_DEBUG_OBJECT (src, "Got position previous estimated content size "
1186         "(%" G_GINT64_FORMAT " > %" G_GINT64_FORMAT ")", new_position,
1187         src->content_size);
1188     src->content_size = new_position;
1189     basesrc->segment.duration = src->content_size;
1190     gst_element_post_message (GST_ELEMENT (src),
1191         gst_message_new_duration_changed (GST_OBJECT (src)));
1192   }
1193
1194   src->ret = GST_FLOW_OK;
1195   g_main_loop_quit (src->loop);
1196   gst_soup_http_src_session_pause_message (src);
1197 }
1198
1199 static void
1200 gst_soup_http_src_response_cb (SoupSession * session, SoupMessage * msg,
1201     GstSoupHTTPSrc * src)
1202 {
1203   if (G_UNLIKELY (msg != src->msg)) {
1204     GST_DEBUG_OBJECT (src, "got response %d: %s, but not for current message",
1205         msg->status_code, msg->reason_phrase);
1206     return;
1207   }
1208   if (G_UNLIKELY (src->session_io_status !=
1209           GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING)
1210       && SOUP_STATUS_IS_REDIRECTION (msg->status_code)) {
1211     /* Ignore redirections. */
1212     return;
1213   }
1214   GST_DEBUG_OBJECT (src, "got response %d: %s", msg->status_code,
1215       msg->reason_phrase);
1216   if (src->session_io_status == GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING &&
1217       src->read_position > 0 && (src->have_size
1218           && src->read_position < src->content_size)) {
1219     /* The server disconnected while streaming. Reconnect and seeking to the
1220      * last location. */
1221     src->retry = TRUE;
1222   } else
1223     gst_soup_http_src_parse_status (msg, src);
1224   /* The session's SoupMessage object expires after this callback returns. */
1225   src->msg = NULL;
1226   g_main_loop_quit (src->loop);
1227 }
1228
1229 #define SOUP_HTTP_SRC_ERROR(src,soup_msg,cat,code,error_message)     \
1230   GST_ELEMENT_ERROR ((src), cat, code, ("%s", error_message),        \
1231       ("%s (%d), URL: %s", (soup_msg)->reason_phrase,                \
1232           (soup_msg)->status_code, (src)->location));
1233
1234 static void
1235 gst_soup_http_src_parse_status (SoupMessage * msg, GstSoupHTTPSrc * src)
1236 {
1237   if (msg->method == SOUP_METHOD_HEAD) {
1238     if (!SOUP_STATUS_IS_SUCCESSFUL (msg->status_code))
1239       GST_DEBUG_OBJECT (src, "Ignoring error %d during HEAD request",
1240           msg->status_code);
1241   } else if (SOUP_STATUS_IS_TRANSPORT_ERROR (msg->status_code)) {
1242     switch (msg->status_code) {
1243       case SOUP_STATUS_CANT_RESOLVE:
1244       case SOUP_STATUS_CANT_RESOLVE_PROXY:
1245         SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, NOT_FOUND,
1246             _("Could not resolve server name."));
1247         src->ret = GST_FLOW_ERROR;
1248         break;
1249       case SOUP_STATUS_CANT_CONNECT:
1250       case SOUP_STATUS_CANT_CONNECT_PROXY:
1251         SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, OPEN_READ,
1252             _("Could not establish connection to server."));
1253         src->ret = GST_FLOW_ERROR;
1254         break;
1255       case SOUP_STATUS_SSL_FAILED:
1256         SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, OPEN_READ,
1257             _("Secure connection setup failed."));
1258         src->ret = GST_FLOW_ERROR;
1259         break;
1260       case SOUP_STATUS_IO_ERROR:
1261         SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, READ,
1262             _("A network error occured, or the server closed the connection "
1263                 "unexpectedly."));
1264         src->ret = GST_FLOW_ERROR;
1265         break;
1266       case SOUP_STATUS_MALFORMED:
1267         SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, READ,
1268             _("Server sent bad data."));
1269         src->ret = GST_FLOW_ERROR;
1270         break;
1271       case SOUP_STATUS_CANCELLED:
1272         /* No error message when interrupted by program. */
1273         break;
1274     }
1275   } else if (SOUP_STATUS_IS_CLIENT_ERROR (msg->status_code) ||
1276       SOUP_STATUS_IS_REDIRECTION (msg->status_code) ||
1277       SOUP_STATUS_IS_SERVER_ERROR (msg->status_code)) {
1278     /* Report HTTP error. */
1279
1280     /* when content_size is unknown and we have just finished receiving
1281      * a body message, requests that go beyond the content limits will result
1282      * in an error. Here we convert those to EOS */
1283     if (msg->status_code == SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE &&
1284         src->have_body && src->have_size) {
1285       GST_DEBUG_OBJECT (src, "Requested range out of limits and received full "
1286           "body, returning EOS");
1287       src->ret = GST_FLOW_EOS;
1288       return;
1289     }
1290
1291     /* FIXME: reason_phrase is not translated and not suitable for user
1292      * error dialog according to libsoup documentation.
1293      */
1294     if (msg->status_code == SOUP_STATUS_NOT_FOUND) {
1295       GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
1296           ("%s", msg->reason_phrase),
1297           ("%s (%d), URL: %s", msg->reason_phrase, msg->status_code,
1298               src->location));
1299     } else if (msg->status_code == SOUP_STATUS_UNAUTHORIZED ||
1300         msg->status_code == SOUP_STATUS_PAYMENT_REQUIRED ||
1301         msg->status_code == SOUP_STATUS_FORBIDDEN ||
1302         msg->status_code == SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED) {
1303       GST_ELEMENT_ERROR (src, RESOURCE, NOT_AUTHORIZED,
1304           ("%s", msg->reason_phrase),
1305           ("%s (%d), URL: %s", msg->reason_phrase, msg->status_code,
1306               src->location));
1307     } else {
1308       GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
1309           ("%s", msg->reason_phrase),
1310           ("%s (%d), URL: %s", msg->reason_phrase, msg->status_code,
1311               src->location));
1312     }
1313     src->ret = GST_FLOW_ERROR;
1314   }
1315 }
1316
1317 static gboolean
1318 gst_soup_http_src_build_message (GstSoupHTTPSrc * src, const gchar * method)
1319 {
1320   src->msg = soup_message_new (method, src->location);
1321   if (!src->msg) {
1322     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
1323         ("Error parsing URL."), ("URL: %s", src->location));
1324     return FALSE;
1325   }
1326   src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE;
1327   if (!src->keep_alive) {
1328     soup_message_headers_append (src->msg->request_headers, "Connection",
1329         "close");
1330   }
1331   if (src->iradio_mode) {
1332     soup_message_headers_append (src->msg->request_headers, "icy-metadata",
1333         "1");
1334   }
1335   if (src->cookies) {
1336     gchar **cookie;
1337
1338     for (cookie = src->cookies; *cookie != NULL; cookie++) {
1339       soup_message_headers_append (src->msg->request_headers, "Cookie",
1340           *cookie);
1341     }
1342   }
1343   src->retry = FALSE;
1344
1345   g_signal_connect (src->msg, "got_headers",
1346       G_CALLBACK (gst_soup_http_src_got_headers_cb), src);
1347   g_signal_connect (src->msg, "got_body",
1348       G_CALLBACK (gst_soup_http_src_got_body_cb), src);
1349   g_signal_connect (src->msg, "finished",
1350       G_CALLBACK (gst_soup_http_src_finished_cb), src);
1351   g_signal_connect (src->msg, "got_chunk",
1352       G_CALLBACK (gst_soup_http_src_got_chunk_cb), src);
1353   soup_message_set_flags (src->msg, SOUP_MESSAGE_OVERWRITE_CHUNKS |
1354       (src->automatic_redirect ? 0 : SOUP_MESSAGE_NO_REDIRECT));
1355   soup_message_set_chunk_allocator (src->msg,
1356       gst_soup_http_src_chunk_allocator, src, NULL);
1357   gst_soup_http_src_add_range_header (src, src->request_position,
1358       src->stop_position);
1359
1360   gst_soup_http_src_add_extra_headers (src);
1361
1362   return TRUE;
1363 }
1364
1365 static GstFlowReturn
1366 gst_soup_http_src_do_request (GstSoupHTTPSrc * src, const gchar * method,
1367     GstBuffer ** outbuf)
1368 {
1369   GST_LOG_OBJECT (src, "Running request for method: %s", method);
1370   if (src->msg && (src->request_position != src->read_position)) {
1371     if (src->session_io_status == GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE) {
1372       gst_soup_http_src_add_range_header (src, src->request_position,
1373           src->stop_position);
1374     } else {
1375       GST_DEBUG_OBJECT (src, "Seek from position %" G_GUINT64_FORMAT
1376           " to %" G_GUINT64_FORMAT ": requeueing connection request",
1377           src->read_position, src->request_position);
1378       gst_soup_http_src_cancel_message (src);
1379     }
1380   }
1381   if (!src->msg)
1382     if (!gst_soup_http_src_build_message (src, method)) {
1383       return GST_FLOW_ERROR;
1384     }
1385
1386   src->ret = GST_FLOW_CUSTOM_ERROR;
1387   src->outbuf = outbuf;
1388   do {
1389     if (src->interrupted) {
1390       GST_DEBUG_OBJECT (src, "interrupted");
1391       break;
1392     }
1393     if (src->retry) {
1394       GST_DEBUG_OBJECT (src, "Reconnecting");
1395       if (!gst_soup_http_src_build_message (src, method)) {
1396         return GST_FLOW_ERROR;
1397       }
1398       src->retry = FALSE;
1399       continue;
1400     }
1401     if (!src->msg) {
1402       GST_DEBUG_OBJECT (src, "EOS reached");
1403       break;
1404     }
1405
1406     switch (src->session_io_status) {
1407       case GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE:
1408         GST_DEBUG_OBJECT (src, "Queueing connection request");
1409         gst_soup_http_src_queue_message (src);
1410         break;
1411       case GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_QUEUED:
1412         break;
1413       case GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING:
1414         gst_soup_http_src_session_unpause_message (src);
1415         break;
1416       case GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_CANCELLED:
1417         /* Impossible. */
1418         break;
1419     }
1420
1421     if (src->ret == GST_FLOW_CUSTOM_ERROR)
1422       g_main_loop_run (src->loop);
1423   } while (src->ret == GST_FLOW_CUSTOM_ERROR);
1424
1425   if (src->ret == GST_FLOW_CUSTOM_ERROR)
1426     src->ret = GST_FLOW_EOS;
1427   g_cond_signal (&src->request_finished_cond);
1428   return src->ret;
1429 }
1430
1431 static GstFlowReturn
1432 gst_soup_http_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
1433 {
1434   GstSoupHTTPSrc *src;
1435   GstFlowReturn ret;
1436
1437   src = GST_SOUP_HTTP_SRC (psrc);
1438
1439   g_mutex_lock (&src->mutex);
1440   ret = gst_soup_http_src_do_request (src, SOUP_METHOD_GET, outbuf);
1441   g_mutex_unlock (&src->mutex);
1442   return ret;
1443 }
1444
1445 static gboolean
1446 gst_soup_http_src_start (GstBaseSrc * bsrc)
1447 {
1448   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1449
1450   GST_DEBUG_OBJECT (src, "start(\"%s\")", src->location);
1451
1452   return gst_soup_http_src_session_open (src);
1453 }
1454
1455 static gboolean
1456 gst_soup_http_src_stop (GstBaseSrc * bsrc)
1457 {
1458   GstSoupHTTPSrc *src;
1459
1460   src = GST_SOUP_HTTP_SRC (bsrc);
1461   GST_DEBUG_OBJECT (src, "stop()");
1462   if (src->keep_alive)
1463     gst_soup_http_src_cancel_message (src);
1464   else
1465     gst_soup_http_src_session_close (src);
1466
1467   gst_soup_http_src_reset (src);
1468   return TRUE;
1469 }
1470
1471 static GstStateChangeReturn
1472 gst_soup_http_src_change_state (GstElement * element, GstStateChange transition)
1473 {
1474   GstStateChangeReturn ret;
1475   GstSoupHTTPSrc *src;
1476
1477   src = GST_SOUP_HTTP_SRC (element);
1478
1479   switch (transition) {
1480     case GST_STATE_CHANGE_READY_TO_NULL:
1481       gst_soup_http_src_session_close (src);
1482       break;
1483     default:
1484       break;
1485   }
1486
1487   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1488
1489   return ret;
1490 }
1491
1492 /* Interrupt a blocking request. */
1493 static gboolean
1494 gst_soup_http_src_unlock (GstBaseSrc * bsrc)
1495 {
1496   GstSoupHTTPSrc *src;
1497
1498   src = GST_SOUP_HTTP_SRC (bsrc);
1499   GST_DEBUG_OBJECT (src, "unlock()");
1500
1501   src->interrupted = TRUE;
1502   if (src->loop)
1503     g_main_loop_quit (src->loop);
1504   g_cond_signal (&src->request_finished_cond);
1505   return TRUE;
1506 }
1507
1508 /* Interrupt interrupt. */
1509 static gboolean
1510 gst_soup_http_src_unlock_stop (GstBaseSrc * bsrc)
1511 {
1512   GstSoupHTTPSrc *src;
1513
1514   src = GST_SOUP_HTTP_SRC (bsrc);
1515   GST_DEBUG_OBJECT (src, "unlock_stop()");
1516
1517   src->interrupted = FALSE;
1518   return TRUE;
1519 }
1520
1521 static gboolean
1522 gst_soup_http_src_get_size (GstBaseSrc * bsrc, guint64 * size)
1523 {
1524   GstSoupHTTPSrc *src;
1525
1526   src = GST_SOUP_HTTP_SRC (bsrc);
1527
1528   if (src->have_size) {
1529     GST_DEBUG_OBJECT (src, "get_size() = %" G_GUINT64_FORMAT,
1530         src->content_size);
1531     *size = src->content_size;
1532     return TRUE;
1533   }
1534   GST_DEBUG_OBJECT (src, "get_size() = FALSE");
1535   return FALSE;
1536 }
1537
1538 static void
1539 gst_soup_http_src_check_seekable (GstSoupHTTPSrc * src)
1540 {
1541   GstFlowReturn ret = GST_FLOW_OK;
1542
1543   /* Special case to check if the server allows range requests
1544    * before really starting to get data in the buffer creation
1545    * loops.
1546    */
1547   if (!src->got_headers && GST_STATE (src) >= GST_STATE_PAUSED) {
1548     g_mutex_lock (&src->mutex);
1549     while (!src->got_headers && !src->interrupted && ret == GST_FLOW_OK) {
1550       if ((src->msg && src->msg->method != SOUP_METHOD_HEAD) &&
1551           src->session_io_status != GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE) {
1552         /* wait for the current request to finish */
1553         g_cond_wait (&src->request_finished_cond, &src->mutex);
1554       } else {
1555         if (gst_soup_http_src_session_open (src)) {
1556           ret = gst_soup_http_src_do_request (src, SOUP_METHOD_HEAD, NULL);
1557         }
1558       }
1559     }
1560     if (src->ret == GST_FLOW_EOS) {
1561       /* A HEAD request shouldn't lead to EOS */
1562       src->ret = GST_FLOW_OK;
1563     }
1564     /* resets status to idle */
1565     gst_soup_http_src_cancel_message (src);
1566     g_mutex_unlock (&src->mutex);
1567   }
1568
1569 }
1570
1571 static gboolean
1572 gst_soup_http_src_is_seekable (GstBaseSrc * bsrc)
1573 {
1574   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1575
1576   gst_soup_http_src_check_seekable (src);
1577
1578   return src->seekable;
1579 }
1580
1581 static gboolean
1582 gst_soup_http_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
1583 {
1584   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1585
1586   GST_DEBUG_OBJECT (src, "do_seek(%" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT
1587       ")", segment->start, segment->stop);
1588   if (src->read_position == segment->start &&
1589       src->request_position == src->read_position &&
1590       src->stop_position == segment->stop) {
1591     GST_DEBUG_OBJECT (src,
1592         "Seek to current read/end position and no seek pending");
1593     return TRUE;
1594   }
1595
1596   gst_soup_http_src_check_seekable (src);
1597
1598   /* If we have no headers we don't know yet if it is seekable or not.
1599    * Store the start position and error out later if it isn't */
1600   if (src->got_headers && !src->seekable) {
1601     GST_WARNING_OBJECT (src, "Not seekable");
1602     return FALSE;
1603   }
1604
1605   if (segment->rate < 0.0 || segment->format != GST_FORMAT_BYTES) {
1606     GST_WARNING_OBJECT (src, "Invalid seek segment");
1607     return FALSE;
1608   }
1609
1610   if (src->content_size != 0 && segment->start >= src->content_size) {
1611     GST_WARNING_OBJECT (src,
1612         "Potentially seeking behind end of file, might EOS immediately");
1613   }
1614
1615   /* Wait for create() to handle the jump in offset. */
1616   src->request_position = segment->start;
1617   src->stop_position = segment->stop;
1618   return TRUE;
1619 }
1620
1621 static gboolean
1622 gst_soup_http_src_query (GstBaseSrc * bsrc, GstQuery * query)
1623 {
1624   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1625   gboolean ret;
1626   GstSchedulingFlags flags;
1627   gint minsize, maxsize, align;
1628
1629   switch (GST_QUERY_TYPE (query)) {
1630     case GST_QUERY_URI:
1631       gst_query_set_uri (query, src->location);
1632       if (src->redirection_uri != NULL)
1633         gst_query_set_uri_redirection (query, src->redirection_uri);
1634       ret = TRUE;
1635       break;
1636     default:
1637       ret = FALSE;
1638       break;
1639   }
1640
1641   if (!ret)
1642     ret = GST_BASE_SRC_CLASS (parent_class)->query (bsrc, query);
1643
1644   switch (GST_QUERY_TYPE (query)) {
1645     case GST_QUERY_SCHEDULING:
1646       gst_query_parse_scheduling (query, &flags, &minsize, &maxsize, &align);
1647       flags |= GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED;
1648       gst_query_set_scheduling (query, flags, minsize, maxsize, align);
1649       break;
1650     default:
1651       break;
1652   }
1653
1654   return ret;
1655 }
1656
1657 static gboolean
1658 gst_soup_http_src_set_location (GstSoupHTTPSrc * src, const gchar * uri,
1659     GError ** error)
1660 {
1661   const char *alt_schemes[] = { "icy://", "icyx://" };
1662   guint i;
1663
1664   if (src->location) {
1665     g_free (src->location);
1666     src->location = NULL;
1667   }
1668
1669   if (uri == NULL)
1670     return FALSE;
1671
1672   for (i = 0; i < G_N_ELEMENTS (alt_schemes); i++) {
1673     if (g_str_has_prefix (uri, alt_schemes[i])) {
1674       src->location =
1675           g_strdup_printf ("http://%s", uri + strlen (alt_schemes[i]));
1676       return TRUE;
1677     }
1678   }
1679
1680   if (src->redirection_uri) {
1681     g_free (src->redirection_uri);
1682     src->redirection_uri = NULL;
1683   }
1684
1685   src->location = g_strdup (uri);
1686
1687   return TRUE;
1688 }
1689
1690 static gboolean
1691 gst_soup_http_src_set_proxy (GstSoupHTTPSrc * src, const gchar * uri)
1692 {
1693   if (src->proxy) {
1694     soup_uri_free (src->proxy);
1695     src->proxy = NULL;
1696   }
1697   if (g_str_has_prefix (uri, "http://")) {
1698     src->proxy = soup_uri_new (uri);
1699   } else {
1700     gchar *new_uri = g_strconcat ("http://", uri, NULL);
1701
1702     src->proxy = soup_uri_new (new_uri);
1703     g_free (new_uri);
1704   }
1705
1706   return TRUE;
1707 }
1708
1709 static guint
1710 gst_soup_http_src_uri_get_type (GType type)
1711 {
1712   return GST_URI_SRC;
1713 }
1714
1715 static const gchar *const *
1716 gst_soup_http_src_uri_get_protocols (GType type)
1717 {
1718   static const gchar *protocols[] = { "http", "https", "icy", "icyx", NULL };
1719
1720   return protocols;
1721 }
1722
1723 static gchar *
1724 gst_soup_http_src_uri_get_uri (GstURIHandler * handler)
1725 {
1726   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (handler);
1727
1728   /* FIXME: make thread-safe */
1729   return g_strdup (src->location);
1730 }
1731
1732 static gboolean
1733 gst_soup_http_src_uri_set_uri (GstURIHandler * handler, const gchar * uri,
1734     GError ** error)
1735 {
1736   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (handler);
1737
1738   return gst_soup_http_src_set_location (src, uri, error);
1739 }
1740
1741 static void
1742 gst_soup_http_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
1743 {
1744   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
1745
1746   iface->get_type = gst_soup_http_src_uri_get_type;
1747   iface->get_protocols = gst_soup_http_src_uri_get_protocols;
1748   iface->get_uri = gst_soup_http_src_uri_get_uri;
1749   iface->set_uri = gst_soup_http_src_uri_set_uri;
1750 }