docs/plugins/: Add souphttpsrc to the docs.

Original commit message from CVS:
Patch by: Wouter Cloetens <wouter at mind dot be>
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
Add souphttpsrc to the docs.
* configure.ac:
* ext/soup/gstsouphttpsrc.c: (gst_souphttp_src_class_init),
(gst_souphttp_src_init), (gst_souphttp_src_dispose),
(gst_souphttp_src_set_property), (gst_souphttp_src_get_property),
(gst_souphttp_src_cancel_message),
(gst_souphttp_src_queue_message),
(gst_souphttp_src_add_range_header),
(gst_souphttp_src_session_unpause_message),
(gst_souphttp_src_session_pause_message),
(gst_souphttp_src_session_close),
(gst_souphttp_src_got_headers_cb), (gst_souphttp_src_got_body_cb),
(gst_souphttp_src_finished_cb), (gst_souphttp_src_got_chunk_cb),
(gst_souphttp_src_response_cb), (gst_souphttp_src_parse_status),
(gst_souphttp_src_create), (gst_souphttp_src_start),
(gst_souphttp_src_stop), (gst_souphttp_src_unlock),
(gst_souphttp_src_unlock_stop), (gst_souphttp_src_get_size),
(gst_souphttp_src_is_seekable), (gst_souphttp_src_do_seek),
(gst_souphttp_src_set_location), (gst_souphttp_src_set_proxy),
(plugin_init):
* ext/soup/gstsouphttpsrc.h:
Add support for libsoup2.4 and require it. Also implement redirection
and manual proxy specification. Fixes bug #510708.
* tests/check/Makefile.am:
* tests/check/elements/.cvsignore:
* tests/check/elements/souphttpsrc.c:
Add unit test for souphttpsrc.

1 files changed, 408 insertions, 0 deletions

diff --git a/tests/check/elements/souphttpsrc.c b/tests/check/elements/souphttpsrc.c
new file mode 100644
index 00000000..8f85c1df
--- /dev/null
+++ b/tests/check/elements/souphttpsrc.c
@@ -0,0 +1,408 @@
+/* GStreamer unit tests for the souphttpsrc element
+ * Copyright (C) 2006-2007 Tim-Philipp Müller <tim centricular net>
+ * Copyright (C) 2008 Wouter Cloetens <wouter@mind.be>
+ * Copyright (C) 2001-2003, Ximian, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <glib.h>
+#include <libsoup/soup-address.h>
+#include <libsoup/soup-message.h>
+#include <libsoup/soup-server.h>
+#include <gst/check/gstcheck.h>
+
+static int http_port = 0, https_port = 0;
+gboolean redirect = TRUE;
+
+static int run_server (int *http_port, int *https_port);
+
+
+static void
+handoff_cb (GstElement * fakesink, GstBuffer * buf, GstPad * pad,
+    GstBuffer ** p_outbuf)
+{
+  GST_LOG ("handoff, buf = %p", buf);
+  if (*p_outbuf == NULL)
+    *p_outbuf = gst_buffer_ref (buf);
+}
+
+int
+run_test (const char *format, ...)
+{
+  GstStateChangeReturn ret;
+  GstElement *pipe, *src, *sink;
+  GstBuffer *buf = NULL;
+  GstMessage *msg;
+  gchar *url;
+  va_list args;
+  int rc = -1;
+
+  pipe = gst_pipeline_new (NULL);
+
+  src = gst_element_factory_make ("souphttpsrc", NULL);
+  fail_unless (src != NULL);
+
+  sink = gst_element_factory_make ("fakesink", NULL);
+  fail_unless (sink != NULL);
+
+  gst_bin_add (GST_BIN (pipe), src);
+  gst_bin_add (GST_BIN (pipe), sink);
+  fail_unless (gst_element_link (src, sink));
+
+  if (http_port == 0) {
+    GST_DEBUG ("failed to start soup http server");
+  }
+  fail_unless (http_port != 0);
+  va_start (args, format);
+  g_vasprintf (&url, format, args);
+  va_end (args);
+  fail_unless (url != NULL);
+  g_object_set (src, "location", url, NULL);
+  g_free (url);
+
+  g_object_set (src, "automatic-redirect", redirect, NULL);
+  g_object_set (sink, "signal-handoffs", TRUE, NULL);
+  g_signal_connect (sink, "preroll-handoff", G_CALLBACK (handoff_cb), &buf);
+
+  ret = gst_element_set_state (pipe, GST_STATE_PAUSED);
+  if (ret != GST_STATE_CHANGE_ASYNC) {
+    GST_DEBUG ("failed to start up soup http src, ret = %d", ret);
+    goto done;
+  }
+
+  gst_element_set_state (pipe, GST_STATE_PLAYING);
+  msg = gst_bus_poll (GST_ELEMENT_BUS (pipe),
+      GST_MESSAGE_EOS | GST_MESSAGE_ERROR, -1);
+  if (GST_MESSAGE_TYPE (msg) == GST_MESSAGE_ERROR) {
+    gchar *debug = NULL;
+    GError *err = NULL;
+
+    gst_message_parse_error (msg, &err, &debug);
+    GST_INFO ("error: %s", err->message);
+    if (g_str_has_suffix (err->message, "Not Found"))
+      rc = 404;
+    else if (g_str_has_suffix (err->message, "Forbidden"))
+      rc = 403;
+    else if (g_str_has_suffix (err->message, "Found"))
+      rc = 302;
+    GST_INFO ("debug: %s", debug);
+    g_error_free (err);
+    g_free (debug);
+    gst_message_unref (msg);
+    goto done;
+  }
+  gst_message_unref (msg);
+
+  /* don't wait for more than 10 seconds */
+  ret = gst_element_get_state (pipe, NULL, NULL, 10 * GST_SECOND);
+  GST_LOG ("ret = %u", ret);
+
+  if (buf == NULL) {
+    /* we want to test the buffer offset, nothing else; if there's a failure
+     * it might be for lots of reasons (no network connection, whatever), we're
+     * not interested in those */
+    GST_DEBUG ("didn't manage to get data within 10 seconds, skipping test");
+    goto done;
+  }
+
+  GST_DEBUG ("buffer offset = %" G_GUINT64_FORMAT, GST_BUFFER_OFFSET (buf));
+
+  /* first buffer should have a 0 offset */
+  fail_unless (GST_BUFFER_OFFSET (buf) == 0);
+  gst_buffer_unref (buf);
+  rc = 0;
+
+done:
+
+  gst_element_set_state (pipe, GST_STATE_NULL);
+  gst_object_unref (pipe);
+  return rc;
+}
+
+GST_START_TEST (test_first_buffer_has_offset)
+{
+  fail_unless (run_test ("http://127.0.0.1:%d/", http_port) == 0);
+}
+
+GST_END_TEST;
+
+GST_START_TEST (test_not_found)
+{
+  fail_unless (run_test ("http://127.0.0.1:%d/404", http_port) == 404);
+}
+
+GST_END_TEST;
+
+GST_START_TEST (test_forbidden)
+{
+  fail_unless (run_test ("http://127.0.0.1:%d/403", http_port) == 403);
+}
+
+GST_END_TEST;
+
+GST_START_TEST (test_redirect_no)
+{
+  redirect = FALSE;
+  fail_unless (run_test ("http://127.0.0.1:%d/302", http_port) == 302);
+}
+
+GST_END_TEST;
+
+GST_START_TEST (test_redirect_yes)
+{
+  redirect = TRUE;
+  fail_unless (run_test ("http://127.0.0.1:%d/302", http_port) == 0);
+}
+
+GST_END_TEST;
+
+GST_START_TEST (test_https)
+{
+  if (!https_port)
+    GST_INFO ("Failed to start an HTTPS server; let's just skip this test.");
+  else
+    fail_unless (run_test ("https://127.0.0.1:%d/", https_port) == 0);
+}
+
+GST_END_TEST;
+
+GST_START_TEST (test_icy_stream)
+{
+  GstElement *pipe, *src, *sink;
+  GstMessage *msg;
+
+  pipe = gst_pipeline_new (NULL);
+
+  src = gst_element_factory_make ("souphttpsrc", NULL);
+  fail_unless (src != NULL);
+
+  sink = gst_element_factory_make ("fakesink", NULL);
+  fail_unless (sink != NULL);
+
+  gst_bin_add (GST_BIN (pipe), src);
+  gst_bin_add (GST_BIN (pipe), sink);
+  fail_unless (gst_element_link (src, sink));
+
+  /* First try Virgin Radio Ogg stream, to see if there's connectivity and all
+   * (which is an attempt to work around the completely horrid error reporting
+   * and that we can't distinguish different types of failures here). */
+
+  g_object_set (src, "location", "http://ogg2.smgradio.com/vr32.ogg", NULL);
+  g_object_set (src, "num-buffers", 1, NULL);
+  gst_element_set_state (pipe, GST_STATE_PLAYING);
+
+  msg = gst_bus_poll (GST_ELEMENT_BUS (pipe),
+      GST_MESSAGE_EOS | GST_MESSAGE_ERROR, -1);
+  if (GST_MESSAGE_TYPE (msg) == GST_MESSAGE_ERROR) {
+    GST_INFO ("looks like there's no net connectivity or sgmradio.com is "
+        "down. In any case, let's just skip this test");
+    gst_message_unref (msg);
+    goto done;
+  }
+  gst_message_unref (msg);
+  msg = NULL;
+  gst_element_set_state (pipe, GST_STATE_NULL);
+
+  /* Now, if the ogg stream works, the mp3 shoutcast stream should work as
+   * well (time will tell if that's true) */
+
+  /* Virgin Radio 32kbps mp3 shoutcast stream */
+  g_object_set (src, "location", "http://mp3-vr-32.smgradio.com:80/", NULL);
+
+
+  /* EOS after the first buffer */
+  g_object_set (src, "num-buffers", 1, NULL);
+
+  gst_element_set_state (pipe, GST_STATE_PLAYING);
+  msg = gst_bus_poll (GST_ELEMENT_BUS (pipe),
+      GST_MESSAGE_EOS | GST_MESSAGE_ERROR, -1);
+
+  if (GST_MESSAGE_TYPE (msg) == GST_MESSAGE_EOS) {
+    GST_DEBUG ("success, we're done here");
+    gst_message_unref (msg);
+    goto done;
+  }
+
+  {
+    GError *err = NULL;
+
+    gst_message_parse_error (msg, &err, NULL);
+    gst_message_unref (msg);
+    g_error ("Error with ICY mp3 shoutcast stream: %s", err->message);
+    g_error_free (err);
+  }
+
+done:
+
+  gst_element_set_state (pipe, GST_STATE_NULL);
+  gst_object_unref (pipe);
+}
+
+GST_END_TEST;
+
+static Suite *
+souphttpsrc_suite (void)
+{
+  g_type_init ();
+  g_thread_init (NULL);
+
+  Suite *s = suite_create ("souphttpsrc");
+  TCase *tc_chain = tcase_create ("general");
+
+  suite_add_tcase (s, tc_chain);
+  run_server (&http_port, &https_port);
+  tcase_add_test (tc_chain, test_first_buffer_has_offset);
+  tcase_add_test (tc_chain, test_https);
+  tcase_add_test (tc_chain, test_redirect_yes);
+  tcase_add_test (tc_chain, test_redirect_no);
+  tcase_add_test (tc_chain, test_not_found);
+  tcase_add_test (tc_chain, test_forbidden);
+  tcase_add_test (tc_chain, test_icy_stream);
+
+  return s;
+}
+
+GST_CHECK_MAIN (souphttpsrc);
+
+static void
+do_get (SoupMessage * msg, const char *path)
+{
+  char *uri;
+  int buflen = 4096;
+  SoupKnownStatusCode status = SOUP_STATUS_OK;
+
+  uri = soup_uri_to_string (soup_message_get_uri (msg), FALSE);
+  GST_DEBUG ("request: \"%s\"", uri);
+
+  if (!strcmp (path, "/301"))
+    status = SOUP_STATUS_MOVED_PERMANENTLY;
+  else if (!strcmp (path, "/302"))
+    status = SOUP_STATUS_MOVED_TEMPORARILY;
+  else if (!strcmp (path, "/307"))
+    status = SOUP_STATUS_TEMPORARY_REDIRECT;
+  else if (!strcmp (path, "/403"))
+    status = SOUP_STATUS_FORBIDDEN;
+  else if (!strcmp (path, "/404"))
+    status = SOUP_STATUS_NOT_FOUND;
+
+  if (SOUP_STATUS_IS_REDIRECTION (status)) {
+    char *redir_uri;
+
+    redir_uri = g_strdup_printf ("%s-redirected", uri);
+    soup_message_headers_append (msg->response_headers, "Location", redir_uri);
+    g_free (redir_uri);
+  }
+  if (status != SOUP_STATUS_OK)
+    goto leave;
+
+  if (msg->method == SOUP_METHOD_GET) {
+    char *buf;
+
+    buf = g_malloc (buflen);
+    memset (buf, 0, buflen);
+    soup_message_body_append (msg->response_body, SOUP_MEMORY_TAKE,
+        buf, buflen);
+  } else {                      /* msg->method == SOUP_METHOD_HEAD */
+
+    char *length;
+
+    /* We could just use the same code for both GET and
+     * HEAD. But we'll optimize and avoid the extra
+     * malloc.
+     */
+    length = g_strdup_printf ("%lu", (gulong) buflen);
+    soup_message_headers_append (msg->response_headers,
+        "Content-Length", length);
+    g_free (length);
+  }
+
+leave:
+  soup_message_set_status (msg, status);
+  g_free (uri);
+}
+
+static void
+print_header (const char *name, const char *value, gpointer data)
+{
+  GST_DEBUG ("header: %s: %s", name, value);
+}
+
+static void
+server_callback (SoupServer * server, SoupMessage * msg,
+    const char *path, GHashTable * query,
+    SoupClientContext * context, gpointer data)
+{
+  GST_DEBUG ("%s %s HTTP/1.%d", msg->method, path,
+      soup_message_get_http_version (msg));
+  soup_message_headers_foreach (msg->request_headers, print_header, NULL);
+  if (msg->request_body->length)
+    GST_DEBUG ("%s", msg->request_body->data);
+
+  if (msg->method == SOUP_METHOD_GET || msg->method == SOUP_METHOD_HEAD)
+    do_get (msg, path);
+  else
+    soup_message_set_status (msg, SOUP_STATUS_NOT_IMPLEMENTED);
+
+  GST_DEBUG ("  -> %d %s", msg->status_code, msg->reason_phrase);
+}
+
+int
+run_server (int *http_port, int *https_port)
+{
+  SoupServer *server, *ssl_server;
+  int port = SOUP_ADDRESS_ANY_PORT;
+  int ssl_port = SOUP_ADDRESS_ANY_PORT;
+  const char *ssl_cert_file = "test-cert.pem", *ssl_key_file = "test-key.pem";
+  static int server_running = 0;
+
+  if (server_running)
+    return 0;
+  server_running = 1;
+
+  *http_port = *https_port = 0;
+
+  server = soup_server_new (SOUP_SERVER_PORT, port, NULL);
+  if (!server) {
+    GST_DEBUG ("Unable to bind to server port %d", port);
+    return 1;
+  }
+  *http_port = soup_server_get_port (server);
+  GST_INFO ("HTTP server listening on port %d", *http_port);
+  soup_server_add_handler (server, NULL, server_callback, NULL, NULL);
+  soup_server_run_async (server);
+
+  if (ssl_cert_file && ssl_key_file) {
+    ssl_server = soup_server_new (SOUP_SERVER_PORT, ssl_port,
+        SOUP_SERVER_SSL_CERT_FILE, ssl_cert_file,
+        SOUP_SERVER_SSL_KEY_FILE, ssl_key_file, NULL);
+
+    if (!ssl_server) {
+      GST_DEBUG ("Unable to bind to SSL server port %d", ssl_port);
+      return 1;
+    }
+    *https_port = soup_server_get_port (ssl_server);
+    GST_INFO ("HTTPS server listening on port %d", *https_port);
+    soup_server_add_handler (ssl_server, NULL, server_callback, NULL, NULL);
+    soup_server_run_async (ssl_server);
+  }
+
+  return 0;
+}