2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * Copyright (C) 2011 Tim-Philipp Müller <tim centricular net>
5 * Copyright (C) 2014 David Waring, British Broadcasting Corporation
6 * <david.waring@rd.bbc.co.uk>
8 * gsturi.c: register URI handlers and IETF RFC 3986 URI manipulations.
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Library General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Library General Public License for more details.
20 * You should have received a copy of the GNU Library General Public
21 * License along with this library; if not, write to the
22 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
23 * Boston, MA 02110-1301, USA.
27 * SECTION:gsturihandler
28 * @short_description: Interface to ease URI handling in plugins.
30 * The #GstURIHandler is an interface that is implemented by Source and Sink
31 * #GstElement to unify handling of URI.
33 * An application can use the following functions to quickly get an element
34 * that handles the given URI for reading or writing
35 * (gst_element_make_from_uri()).
37 * Source and Sink plugins should implement this interface when possible.
44 #include "gst_private.h"
48 #include "gstregistry.h"
50 #include "gst-i18n-lib.h"
54 #include <glib/gprintf.h>
56 GST_DEBUG_CATEGORY_STATIC (gst_uri_handler_debug);
57 #define GST_CAT_DEFAULT gst_uri_handler_debug
59 #ifndef HAVE_STRCASESTR
60 #define strcasestr _gst_ascii_strcasestr
62 /* From https://github.com/freebsd/freebsd/blob/master/contrib/file/src/strcasestr.c
63 * Updated to use GLib types and GLib string functions
65 * Copyright (c) 1990, 1993
66 * The Regents of the University of California. All rights reserved.
68 * This code is derived from software contributed to Berkeley by
71 * Redistribution and use in source and binary forms, with or without
72 * modification, are permitted provided that the following conditions
74 * 1. Redistributions of source code must retain the above copyright
75 * notice, this list of conditions and the following disclaimer.
76 * 2. Redistributions in binary form must reproduce the above copyright
77 * notice, this list of conditions and the following disclaimer in the
78 * documentation and/or other materials provided with the distribution.
79 * 3. Neither the name of the University nor the names of its contributors
80 * may be used to endorse or promote products derived from this software
81 * without specific prior written permission.
83 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
84 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
85 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
86 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
87 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
88 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
89 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
90 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
91 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
92 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
97 * Find the first occurrence of find in s, ignore case.
101 _gst_ascii_strcasestr (const gchar * s, const gchar * find)
106 if ((c = *find++) != 0) {
107 c = g_ascii_tolower (c);
111 if ((sc = *s++) == 0)
113 } while (g_ascii_tolower (sc) != c);
114 } while (g_ascii_strncasecmp (s, find, len) != 0);
117 return (gchar *) (gintptr) (s);
121 #if !GLIB_CHECK_VERSION (2, 33, 4)
122 #define g_list_copy_deep gst_g_list_copy_deep
124 gst_g_list_copy_deep (GList * list, GCopyFunc func, gpointer user_data)
126 list = g_list_copy (list);
131 for (l = list; l != NULL; l = l->next) {
132 l->data = func (l->data, user_data);
141 gst_uri_handler_get_type (void)
143 static volatile gsize urihandler_type = 0;
145 if (g_once_init_enter (&urihandler_type)) {
147 static const GTypeInfo urihandler_info = {
148 sizeof (GstURIHandlerInterface),
160 _type = g_type_register_static (G_TYPE_INTERFACE,
161 "GstURIHandler", &urihandler_info, 0);
163 GST_DEBUG_CATEGORY_INIT (gst_uri_handler_debug, "GST_URI", GST_DEBUG_BOLD,
165 g_once_init_leave (&urihandler_type, _type);
167 return urihandler_type;
171 gst_uri_error_quark (void)
173 return g_quark_from_static_string ("gst-uri-error-quark");
176 static const guchar acceptable[96] = { /* X0 X1 X2 X3 X4 X5 X6 X7 X8 X9 XA XB XC XD XE XF */
177 0x00, 0x3F, 0x20, 0x20, 0x20, 0x00, 0x2C, 0x3F, 0x3F, 0x3F, 0x3F, 0x22, 0x20, 0x3F, 0x3F, 0x1C, /* 2X !"#$%&'()*+,-./ */
178 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x38, 0x20, 0x20, 0x2C, 0x20, 0x2C, /* 3X 0123456789:;<=>? */
179 0x30, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, /* 4X @ABCDEFGHIJKLMNO */
180 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x20, 0x20, 0x20, 0x20, 0x3F, /* 5X PQRSTUVWXYZ[\]^_ */
181 0x20, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, /* 6X `abcdefghijklmno */
182 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x20, 0x20, 0x20, 0x3F, 0x20 /* 7X pqrstuvwxyz{|}~DEL */
187 UNSAFE_ALL = 0x1, /* Escape all unsafe characters */
188 UNSAFE_ALLOW_PLUS = 0x2, /* Allows '+' */
189 UNSAFE_PATH = 0x4, /* Allows '/' and '?' and '&' and '=' */
190 UNSAFE_DOS_PATH = 0x8, /* Allows '/' and '?' and '&' and '=' and ':' */
191 UNSAFE_HOST = 0x10, /* Allows '/' and ':' and '@' */
192 UNSAFE_SLASHES = 0x20 /* Allows all characters except for '/' and '%' */
193 } UnsafeCharacterSet;
195 #define HEX_ESCAPE '%'
197 /* Escape undesirable characters using %
198 * -------------------------------------
200 * This function takes a pointer to a string in which
201 * some characters may be unacceptable unescaped.
202 * It returns a string which has these characters
203 * represented by a '%' character followed by two hex digits.
205 * This routine returns a g_malloced string.
208 static const gchar hex[16] = "0123456789ABCDEF";
211 escape_string_internal (const gchar * string, UnsafeCharacterSet mask)
213 #define ACCEPTABLE_CHAR(a) ((a)>=32 && (a)<128 && (acceptable[(a)-32] & use_mask))
220 UnsafeCharacterSet use_mask;
222 g_return_val_if_fail (mask == UNSAFE_ALL
223 || mask == UNSAFE_ALLOW_PLUS
224 || mask == UNSAFE_PATH
225 || mask == UNSAFE_DOS_PATH
226 || mask == UNSAFE_HOST || mask == UNSAFE_SLASHES, NULL);
228 if (string == NULL) {
234 for (p = string; *p != '\0'; p++) {
236 if (!ACCEPTABLE_CHAR (c)) {
239 if ((use_mask == UNSAFE_HOST) && (unacceptable || (c == '/'))) {
240 /* when escaping a host, if we hit something that needs to be escaped, or we finally
241 * hit a path separator, revert to path mode (the host segment of the url is over).
243 use_mask = UNSAFE_PATH;
247 result = g_malloc (p - string + unacceptable * 2 + 1);
250 for (q = result, p = string; *p != '\0'; p++) {
253 if (!ACCEPTABLE_CHAR (c)) {
254 *q++ = HEX_ESCAPE; /* means hex coming */
260 if ((use_mask == UNSAFE_HOST) && (!ACCEPTABLE_CHAR (c) || (c == '/'))) {
261 use_mask = UNSAFE_PATH;
271 * @string: string to be escaped
273 * Escapes @string, replacing any and all special characters
274 * with equivalent escape sequences.
276 * Return value: a newly allocated string equivalent to @string
277 * but with all special characters escaped
280 escape_string (const gchar * string)
282 return escape_string_internal (string, UNSAFE_ALL);
288 return c >= '0' && c <= '9' ? c - '0'
289 : c >= 'A' && c <= 'F' ? c - 'A' + 10
290 : c >= 'a' && c <= 'f' ? c - 'a' + 10 : -1;
294 unescape_character (const char *scanner)
299 first_digit = hex_to_int (*scanner++);
300 if (first_digit < 0) {
304 second_digit = hex_to_int (*scanner);
305 if (second_digit < 0) {
309 return (first_digit << 4) | second_digit;
313 * @escaped_string: an escaped URI, path, or other string
314 * @illegal_characters: a string containing a sequence of characters
315 * considered "illegal", '\0' is automatically in this list.
317 * Decodes escaped characters (i.e. PERCENTxx sequences) in @escaped_string.
318 * Characters are encoded in PERCENTxy form, where xy is the ASCII hex code
319 * for character 16x+y.
321 * Return value: (nullable): a newly allocated string with the
322 * unescaped equivalents, or %NULL if @escaped_string contained one of
323 * the characters in @illegal_characters.
326 unescape_string (const gchar * escaped_string, const gchar * illegal_characters)
332 if (escaped_string == NULL) {
336 result = g_malloc (strlen (escaped_string) + 1);
339 for (in = escaped_string; *in != '\0'; in++) {
341 if (*in == HEX_ESCAPE) {
342 character = unescape_character (in + 1);
344 /* Check for an illegal character. We consider '\0' illegal here. */
346 || (illegal_characters != NULL
347 && strchr (illegal_characters, (char) character) != NULL)) {
353 *out++ = (char) character;
357 g_assert ((gsize) (out - result) <= strlen (escaped_string));
364 gst_uri_protocol_check_internal (const gchar * uri, gchar ** endptr)
366 gchar *check = (gchar *) uri;
368 g_assert (uri != NULL);
369 g_assert (endptr != NULL);
371 if (g_ascii_isalpha (*check)) {
373 while (g_ascii_isalnum (*check) || *check == '+'
374 || *check == '-' || *check == '.')
382 * gst_uri_protocol_is_valid:
383 * @protocol: A string
385 * Tests if the given string is a valid protocol identifier. Protocols
386 * must consist of alphanumeric characters, '+', '-' and '.' and must
387 * start with a alphabetic character. See RFC 3986 Section 3.1.
389 * Returns: %TRUE if the string is a valid protocol identifier, %FALSE otherwise.
392 gst_uri_protocol_is_valid (const gchar * protocol)
396 g_return_val_if_fail (protocol != NULL, FALSE);
398 gst_uri_protocol_check_internal (protocol, &endptr);
400 return *endptr == '\0' && ((gsize) (endptr - protocol)) >= 2;
407 * Tests if the given string is a valid URI identifier. URIs start with a valid
408 * scheme followed by ":" and maybe a string identifying the location.
410 * Returns: %TRUE if the string is a valid URI
413 gst_uri_is_valid (const gchar * uri)
417 g_return_val_if_fail (uri != NULL, FALSE);
419 gst_uri_protocol_check_internal (uri, &endptr);
421 return *endptr == ':' && ((gsize) (endptr - uri)) >= 2;
425 * gst_uri_get_protocol:
428 * Extracts the protocol out of a given valid URI. The returned string must be
429 * freed using g_free().
431 * Returns: The protocol for this URI.
434 gst_uri_get_protocol (const gchar * uri)
438 g_return_val_if_fail (uri != NULL, NULL);
439 g_return_val_if_fail (gst_uri_is_valid (uri), NULL);
441 colon = strstr (uri, ":");
443 return g_ascii_strdown (uri, colon - uri);
447 * gst_uri_has_protocol:
449 * @protocol: a protocol string (e.g. "http")
451 * Checks if the protocol of a given valid URI matches @protocol.
453 * Returns: %TRUE if the protocol matches.
456 gst_uri_has_protocol (const gchar * uri, const gchar * protocol)
460 g_return_val_if_fail (uri != NULL, FALSE);
461 g_return_val_if_fail (protocol != NULL, FALSE);
462 g_return_val_if_fail (gst_uri_is_valid (uri), FALSE);
464 colon = strstr (uri, ":");
469 return (g_ascii_strncasecmp (uri, protocol, (gsize) (colon - uri)) == 0);
473 * gst_uri_get_location:
476 * Extracts the location out of a given valid URI, ie. the protocol and "://"
477 * are stripped from the URI, which means that the location returned includes
478 * the hostname if one is specified. The returned string must be freed using
481 * Free-function: g_free
483 * Returns: (transfer full): the location for this URI. Returns %NULL if the
484 * URI isn't valid. If the URI does not contain a location, an empty
485 * string is returned.
488 gst_uri_get_location (const gchar * uri)
491 gchar *unescaped = NULL;
493 g_return_val_if_fail (uri != NULL, NULL);
494 g_return_val_if_fail (gst_uri_is_valid (uri), NULL);
496 colon = strstr (uri, "://");
500 unescaped = unescape_string (colon + 3, "/");
502 /* On Windows an URI might look like file:///c:/foo/bar.txt or
503 * file:///c|/foo/bar.txt (some Netscape versions) and we want to
504 * return c:/foo/bar.txt as location rather than /c:/foo/bar.txt.
505 * Can't use g_filename_from_uri() here because it will only handle the
506 * file:// protocol */
508 if (unescaped != NULL && unescaped[0] == '/' &&
509 g_ascii_isalpha (unescaped[1]) &&
510 (unescaped[2] == ':' || unescaped[2] == '|')) {
512 memmove (unescaped, unescaped + 1, strlen (unescaped + 1) + 1);
516 GST_LOG ("extracted location '%s' from URI '%s'", GST_STR_NULL (unescaped),
523 * @protocol: Protocol for URI
524 * @location: (transfer none): Location for URI
526 * Constructs a URI for a given valid protocol and location.
528 * Free-function: g_free
530 * Returns: (transfer full): a new string for this URI. Returns %NULL if the
531 * given URI protocol is not valid, or the given location is %NULL.
534 gst_uri_construct (const gchar * protocol, const gchar * location)
536 char *escaped, *proto_lowercase;
539 g_return_val_if_fail (gst_uri_protocol_is_valid (protocol), NULL);
540 g_return_val_if_fail (location != NULL, NULL);
542 proto_lowercase = g_ascii_strdown (protocol, -1);
543 escaped = escape_string (location);
544 retval = g_strdup_printf ("%s://%s", proto_lowercase, escaped);
546 g_free (proto_lowercase);
554 const gchar *protocol;
559 search_by_entry (GstPluginFeature * feature, gpointer search_entry)
561 const gchar *const *protocols;
562 GstElementFactory *factory;
563 SearchEntry *entry = (SearchEntry *) search_entry;
565 if (!GST_IS_ELEMENT_FACTORY (feature))
567 factory = GST_ELEMENT_FACTORY_CAST (feature);
569 if (factory->uri_type != entry->type)
572 protocols = gst_element_factory_get_uri_protocols (factory);
574 if (protocols == NULL) {
575 g_warning ("Factory '%s' implements GstUriHandler interface but returned "
576 "no supported protocols!", gst_plugin_feature_get_name (feature));
580 while (*protocols != NULL) {
581 if (g_ascii_strcasecmp (*protocols, entry->protocol) == 0)
589 sort_by_rank (GstPluginFeature * first, GstPluginFeature * second)
591 return gst_plugin_feature_get_rank (second) -
592 gst_plugin_feature_get_rank (first);
596 get_element_factories_from_uri_protocol (const GstURIType type,
597 const gchar * protocol)
599 GList *possibilities;
602 g_return_val_if_fail (protocol, NULL);
605 entry.protocol = protocol;
606 possibilities = gst_registry_feature_filter (gst_registry_get (),
607 search_by_entry, FALSE, &entry);
609 return possibilities;
613 * gst_uri_protocol_is_supported:
614 * @type: Whether to check for a source or a sink
615 * @protocol: Protocol that should be checked for (e.g. "http" or "smb")
617 * Checks if an element exists that supports the given URI protocol. Note
618 * that a positive return value does not imply that a subsequent call to
619 * gst_element_make_from_uri() is guaranteed to work.
624 gst_uri_protocol_is_supported (const GstURIType type, const gchar * protocol)
626 GList *possibilities;
628 g_return_val_if_fail (protocol, FALSE);
630 possibilities = get_element_factories_from_uri_protocol (type, protocol);
633 g_list_free (possibilities);
640 * gst_element_make_from_uri:
641 * @type: Whether to create a source or a sink
642 * @uri: URI to create an element for
643 * @elementname: (allow-none): Name of created element, can be %NULL.
644 * @error: (allow-none): address where to store error information, or %NULL.
646 * Creates an element for handling the given URI.
648 * Returns: (transfer floating): a new element or %NULL if none could be created
651 gst_element_make_from_uri (const GstURIType type, const gchar * uri,
652 const gchar * elementname, GError ** error)
654 GList *possibilities, *walk;
656 GstElement *ret = NULL;
658 g_return_val_if_fail (gst_is_initialized (), NULL);
659 g_return_val_if_fail (GST_URI_TYPE_IS_VALID (type), NULL);
660 g_return_val_if_fail (gst_uri_is_valid (uri), NULL);
661 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
663 GST_DEBUG ("type:%d, uri:%s, elementname:%s", type, uri, elementname);
665 protocol = gst_uri_get_protocol (uri);
666 possibilities = get_element_factories_from_uri_protocol (type, protocol);
668 if (!possibilities) {
669 GST_DEBUG ("No %s for URI '%s'", type == GST_URI_SINK ? "sink" : "source",
671 /* The error message isn't great, but we don't expect applications to
672 * show that error to users, but call the missing plugins functions */
673 g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_UNSUPPORTED_PROTOCOL,
674 _("No URI handler for the %s protocol found"), protocol);
680 possibilities = g_list_sort (possibilities, (GCompareFunc) sort_by_rank);
681 walk = possibilities;
683 GstElementFactory *factory = walk->data;
684 GError *uri_err = NULL;
686 ret = gst_element_factory_create (factory, elementname);
688 GstURIHandler *handler = GST_URI_HANDLER (ret);
690 if (gst_uri_handler_set_uri (handler, uri, &uri_err))
693 GST_WARNING ("%s didn't accept URI '%s': %s", GST_OBJECT_NAME (ret), uri,
696 if (error != NULL && *error == NULL)
697 g_propagate_error (error, uri_err);
699 g_error_free (uri_err);
701 gst_object_unref (ret);
706 gst_plugin_feature_list_free (possibilities);
708 GST_LOG_OBJECT (ret, "created %s for URL '%s'",
709 type == GST_URI_SINK ? "sink" : "source", uri);
711 /* if the first handler didn't work, but we found another one that works */
713 g_clear_error (error);
719 * gst_uri_handler_get_uri_type:
720 * @handler: A #GstURIHandler.
722 * Gets the type of the given URI handler
724 * Returns: the #GstURIType of the URI handler.
725 * Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly.
728 gst_uri_handler_get_uri_type (GstURIHandler * handler)
730 GstURIHandlerInterface *iface;
733 g_return_val_if_fail (GST_IS_URI_HANDLER (handler), GST_URI_UNKNOWN);
735 iface = GST_URI_HANDLER_GET_INTERFACE (handler);
736 g_return_val_if_fail (iface != NULL, GST_URI_UNKNOWN);
737 g_return_val_if_fail (iface->get_type != NULL, GST_URI_UNKNOWN);
739 ret = iface->get_type (G_OBJECT_TYPE (handler));
740 g_return_val_if_fail (GST_URI_TYPE_IS_VALID (ret), GST_URI_UNKNOWN);
746 * gst_uri_handler_get_protocols:
747 * @handler: A #GstURIHandler.
749 * Gets the list of protocols supported by @handler. This list may not be
752 * Returns: (transfer none) (element-type utf8) (nullable): the
753 * supported protocols. Returns %NULL if the @handler isn't
754 * implemented properly, or the @handler doesn't support any
758 gst_uri_handler_get_protocols (GstURIHandler * handler)
760 GstURIHandlerInterface *iface;
761 const gchar *const *ret;
763 g_return_val_if_fail (GST_IS_URI_HANDLER (handler), NULL);
765 iface = GST_URI_HANDLER_GET_INTERFACE (handler);
766 g_return_val_if_fail (iface != NULL, NULL);
767 g_return_val_if_fail (iface->get_protocols != NULL, NULL);
769 ret = iface->get_protocols (G_OBJECT_TYPE (handler));
770 g_return_val_if_fail (ret != NULL, NULL);
776 * gst_uri_handler_get_uri:
777 * @handler: A #GstURIHandler
779 * Gets the currently handled URI.
781 * Returns: (transfer full) (nullable): the URI currently handled by
782 * the @handler. Returns %NULL if there are no URI currently
783 * handled. The returned string must be freed with g_free() when no
787 gst_uri_handler_get_uri (GstURIHandler * handler)
789 GstURIHandlerInterface *iface;
792 g_return_val_if_fail (GST_IS_URI_HANDLER (handler), NULL);
794 iface = GST_URI_HANDLER_GET_INTERFACE (handler);
795 g_return_val_if_fail (iface != NULL, NULL);
796 g_return_val_if_fail (iface->get_uri != NULL, NULL);
797 ret = iface->get_uri (handler);
799 g_return_val_if_fail (gst_uri_is_valid (ret), NULL);
805 * gst_uri_handler_set_uri:
806 * @handler: A #GstURIHandler
808 * @error: (allow-none): address where to store a #GError in case of
811 * Tries to set the URI of the given handler.
813 * Returns: %TRUE if the URI was set successfully, else %FALSE.
816 gst_uri_handler_set_uri (GstURIHandler * handler, const gchar * uri,
819 GstURIHandlerInterface *iface;
823 g_return_val_if_fail (GST_IS_URI_HANDLER (handler), FALSE);
824 g_return_val_if_fail (gst_uri_is_valid (uri), FALSE);
825 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
827 iface = GST_URI_HANDLER_GET_INTERFACE (handler);
828 g_return_val_if_fail (iface != NULL, FALSE);
829 g_return_val_if_fail (iface->set_uri != NULL, FALSE);
831 protocol = gst_uri_get_protocol (uri);
833 if (iface->get_protocols) {
834 const gchar *const *protocols;
835 const gchar *const *p;
836 gboolean found_protocol = FALSE;
838 protocols = iface->get_protocols (G_OBJECT_TYPE (handler));
839 if (protocols != NULL) {
840 for (p = protocols; *p != NULL; ++p) {
841 if (g_ascii_strcasecmp (protocol, *p) == 0) {
842 found_protocol = TRUE;
847 if (!found_protocol) {
848 g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_UNSUPPORTED_PROTOCOL,
849 _("URI scheme '%s' not supported"), protocol);
856 ret = iface->set_uri (handler, uri, error);
864 gst_file_utils_canonicalise_path (const gchar * path)
866 gchar **parts, **p, *clean_path;
870 GST_WARNING ("FIXME: canonicalise win32 path");
871 return g_strdup (path);
875 parts = g_strsplit (path, "/", -1);
879 if (strcmp (*p, ".") == 0) {
880 /* just move all following parts on top of this, incl. NUL terminator */
882 memmove (p, p + 1, (g_strv_length (p + 1) + 1) * sizeof (gchar *));
883 /* re-check the new current part again in the next iteration */
885 } else if (strcmp (*p, "..") == 0 && p > parts) {
886 /* just move all following parts on top of the previous part, incl.
890 memmove (p - 1, p + 1, (g_strv_length (p + 1) + 1) * sizeof (gchar *));
891 /* re-check the new current part again in the next iteration */
900 num_parts = g_strv_length (parts) + 1; /* incl. terminator */
901 parts = g_renew (gchar *, parts, num_parts + 1);
902 memmove (parts + 1, parts, num_parts * sizeof (gchar *));
903 parts[0] = g_strdup ("/");
906 clean_path = g_build_filenamev (parts);
912 file_path_contains_relatives (const gchar * path)
914 return (strstr (path, "/./") != NULL || strstr (path, "/../") != NULL ||
915 strstr (path, G_DIR_SEPARATOR_S "." G_DIR_SEPARATOR_S) != NULL ||
916 strstr (path, G_DIR_SEPARATOR_S ".." G_DIR_SEPARATOR_S) != NULL);
920 * gst_filename_to_uri:
921 * @filename: absolute or relative file name path
922 * @error: pointer to error, or %NULL
924 * Similar to g_filename_to_uri(), but attempts to handle relative file paths
925 * as well. Before converting @filename into an URI, it will be prefixed by
926 * the current working directory if it is a relative path, and then the path
927 * will be canonicalised so that it doesn't contain any './' or '../' segments.
929 * On Windows #filename should be in UTF-8 encoding.
931 * Returns: newly-allocated URI string, or NULL on error. The caller must
932 * free the URI string with g_free() when no longer needed.
935 gst_filename_to_uri (const gchar * filename, GError ** error)
937 gchar *abs_location = NULL;
938 gchar *uri, *abs_clean;
940 g_return_val_if_fail (filename != NULL, NULL);
941 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
943 if (g_path_is_absolute (filename)) {
944 if (!file_path_contains_relatives (filename)) {
945 uri = g_filename_to_uri (filename, NULL, error);
949 abs_location = g_strdup (filename);
953 cwd = g_get_current_dir ();
954 abs_location = g_build_filename (cwd, filename, NULL);
957 if (!file_path_contains_relatives (abs_location)) {
958 uri = g_filename_to_uri (abs_location, NULL, error);
963 /* path is now absolute, but contains '.' or '..' */
964 abs_clean = gst_file_utils_canonicalise_path (abs_location);
965 GST_LOG ("'%s' -> '%s' -> '%s'", filename, abs_location, abs_clean);
966 uri = g_filename_to_uri (abs_clean, NULL, error);
971 g_free (abs_location);
972 GST_DEBUG ("'%s' -> '%s'", filename, uri);
976 /****************************************************************************
977 * GstUri - GstMiniObject to parse and merge URIs according to IETF RFC 3986
978 ****************************************************************************/
982 * @short_description: URI parsing and manipulation.
984 * A #GstUri object can be used to parse and split a URI string into its
985 * constituant parts. Two #GstUri objects can be joined to make a new #GstUri
986 * using the algorithm described in RFC3986.
989 /* Definition for GstUri object */
993 GstMiniObject mini_object;
1003 GST_DEFINE_MINI_OBJECT_TYPE (GstUri, gst_uri);
1005 static GstUri *_gst_uri_copy (const GstUri * uri);
1006 static void _gst_uri_free (GstUri * uri);
1007 static GstUri *_gst_uri_new (void);
1008 static GList *_remove_dot_segments (GList * path);
1010 /* private GstUri functions */
1016 uri = GST_URI_CAST (g_slice_new0 (GstUri));
1019 gst_mini_object_init (GST_MINI_OBJECT_CAST (uri), 0, gst_uri_get_type (),
1020 (GstMiniObjectCopyFunction) _gst_uri_copy, NULL,
1021 (GstMiniObjectFreeFunction) _gst_uri_free);
1027 _gst_uri_free (GstUri * uri)
1029 g_return_if_fail (GST_IS_URI (uri));
1031 g_free (uri->scheme);
1032 g_free (uri->userinfo);
1034 g_list_free_full (uri->path, g_free);
1036 g_hash_table_unref (uri->query);
1037 g_free (uri->fragment);
1039 g_slice_free1 (sizeof (*uri), uri);
1043 _gst_uri_copy_query_table (GHashTable * orig)
1045 GHashTable *new = NULL;
1048 GHashTableIter iter;
1049 gpointer key, value;
1050 new = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
1051 g_hash_table_iter_init (&iter, orig);
1052 while (g_hash_table_iter_next (&iter, &key, &value)) {
1053 g_hash_table_insert (new, g_strdup (key), g_strdup (value));
1061 _gst_uri_copy (const GstUri * orig_uri)
1065 g_return_val_if_fail (GST_IS_URI (orig_uri), NULL);
1067 new_uri = _gst_uri_new ();
1070 new_uri->scheme = g_strdup (orig_uri->scheme);
1071 new_uri->userinfo = g_strdup (orig_uri->userinfo);
1072 new_uri->host = g_strdup (orig_uri->host);
1073 new_uri->port = orig_uri->port;
1074 new_uri->path = g_list_copy_deep (orig_uri->path, (GCopyFunc) g_strdup,
1076 new_uri->query = _gst_uri_copy_query_table (orig_uri->query);
1077 new_uri->fragment = g_strdup (orig_uri->fragment);
1084 * _gst_uri_compare_lists:
1086 * Compare two lists for equality. This compares the two lists, item for item,
1087 * comparing items in the same position in the two lists. If @first is
1088 * considered less than @second the result will be negative. If @first is
1089 * considered to be more than @second then the result will be positive. If the
1090 * lists are considered to be equal then the result will be 0. If two lists
1091 * have the same items, but one list is shorter than the other, then the
1092 * shorter list is considered to be less than the longer list.
1095 _gst_uri_compare_lists (GList * first, GList * second, GCompareFunc cmp_fn)
1100 for (itr1 = first, itr2 = second;
1101 itr1 != NULL || itr2 != NULL; itr1 = itr1->next, itr2 = itr2->next) {
1106 result = cmp_fn (itr1->data, itr2->data);
1115 _GST_URI_NORMALIZE_LOWERCASE = 1,
1116 _GST_URI_NORMALIZE_UPPERCASE = 2
1117 } _GstUriNormalizations;
1120 * Find the first character that hasn't been normalized according to the @flags.
1123 _gst_uri_first_non_normalized_char (gchar * str, guint flags)
1130 for (pos = str; *pos; pos++) {
1131 if ((flags & _GST_URI_NORMALIZE_UPPERCASE) && g_ascii_islower (*pos))
1133 if ((flags & _GST_URI_NORMALIZE_LOWERCASE) && g_ascii_isupper (*pos))
1140 _gst_uri_normalize_lowercase (gchar * str)
1143 gboolean ret = FALSE;
1145 for (pos = _gst_uri_first_non_normalized_char (str,
1146 _GST_URI_NORMALIZE_LOWERCASE);
1148 pos = _gst_uri_first_non_normalized_char (pos + 1,
1149 _GST_URI_NORMALIZE_LOWERCASE)) {
1150 *pos = g_ascii_tolower (*pos);
1157 #define _gst_uri_normalize_scheme _gst_uri_normalize_lowercase
1158 #define _gst_uri_normalize_hostname _gst_uri_normalize_lowercase
1161 _gst_uri_normalize_path (GList ** path)
1165 new_path = _remove_dot_segments (*path);
1166 if (_gst_uri_compare_lists (new_path, *path, (GCompareFunc) g_strcmp0) != 0) {
1167 g_list_free_full (*path, g_free);
1171 g_list_free_full (new_path, g_free);
1177 _gst_uri_normalize_str_noop (gchar * str)
1183 _gst_uri_normalize_table_noop (GHashTable * table)
1188 #define _gst_uri_normalize_userinfo _gst_uri_normalize_str_noop
1189 #define _gst_uri_normalize_query _gst_uri_normalize_table_noop
1190 #define _gst_uri_normalize_fragment _gst_uri_normalize_str_noop
1192 /* RFC 3986 functions */
1195 _merge (GList * base, GList * path)
1197 GList *ret, *path_copy, *last;
1199 path_copy = g_list_copy_deep (path, (GCopyFunc) g_strdup, NULL);
1200 /* if base is NULL make path absolute */
1202 if (path_copy != NULL && path_copy->data != NULL) {
1203 path_copy = g_list_prepend (path_copy, NULL);
1208 ret = g_list_copy_deep (base, (GCopyFunc) g_strdup, NULL);
1209 last = g_list_last (ret);
1210 ret = g_list_remove_link (ret, last);
1211 g_list_free_full (last, g_free);
1212 ret = g_list_concat (ret, path_copy);
1218 _remove_dot_segments (GList * path)
1220 GList *out, *elem, *next;
1225 out = g_list_copy_deep (path, (GCopyFunc) g_strdup, NULL);
1227 for (elem = out; elem; elem = next) {
1229 if (elem->data == NULL && elem != out && next != NULL) {
1230 out = g_list_delete_link (out, elem);
1231 } else if (g_strcmp0 (elem->data, ".") == 0) {
1232 g_free (elem->data);
1233 out = g_list_delete_link (out, elem);
1234 } else if (g_strcmp0 (elem->data, "..") == 0) {
1235 GList *prev = g_list_previous (elem);
1236 if (prev && (prev != out || prev->data != NULL)) {
1237 g_free (prev->data);
1238 out = g_list_delete_link (out, prev);
1240 g_free (elem->data);
1242 out = g_list_delete_link (out, elem);
1244 /* path ends in '/..' We need to keep the last '/' */
1254 _gst_uri_escape_userinfo (const gchar * userinfo)
1256 return g_uri_escape_string (userinfo,
1257 G_URI_RESERVED_CHARS_ALLOWED_IN_USERINFO, FALSE);
1261 _gst_uri_escape_host (const gchar * host)
1263 return g_uri_escape_string (host,
1264 G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, FALSE);
1268 _gst_uri_escape_host_colon (const gchar * host)
1270 return g_uri_escape_string (host,
1271 G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS ":", FALSE);
1275 _gst_uri_escape_path_segment (const gchar * segment)
1277 return g_uri_escape_string (segment,
1278 G_URI_RESERVED_CHARS_ALLOWED_IN_PATH_ELEMENT, FALSE);
1282 _gst_uri_escape_http_query_element (const gchar * element)
1286 ret = g_uri_escape_string (element, "!$'()*,;:@/? ", FALSE);
1287 for (c = ret; *c; c++)
1294 _gst_uri_escape_fragment (const gchar * fragment)
1296 return g_uri_escape_string (fragment,
1297 G_URI_RESERVED_CHARS_ALLOWED_IN_PATH "?", FALSE);
1301 _gst_uri_string_to_list (const gchar * str, const gchar * sep, gboolean convert,
1304 GList *new_list = NULL;
1307 guint pct_sep_len = 0;
1308 gchar *pct_sep = NULL;
1311 if (convert && !unescape) {
1312 pct_sep = g_strdup_printf ("%%%2.2X", (guint) (*sep));
1316 split_str = g_strsplit (str, sep, -1);
1319 for (next_elem = split_str; *next_elem; next_elem += 1) {
1320 gchar *elem = *next_elem;
1321 if (*elem == '\0') {
1322 new_list = g_list_append (new_list, NULL);
1324 if (convert && !unescape) {
1326 for (next_sep = strcasestr (elem, pct_sep); next_sep;
1327 next_sep = strcasestr (next_sep + 1, pct_sep)) {
1329 memmove (next_sep + 1, next_sep + pct_sep_len,
1330 strlen (next_sep + pct_sep_len) + 1);
1334 *next_elem = g_uri_unescape_string (elem, NULL);
1338 new_list = g_list_append (new_list, g_strdup (elem));
1342 g_strfreev (split_str);
1343 if (convert && !unescape)
1351 _gst_uri_string_to_table (const gchar * str, const gchar * part_sep,
1352 const gchar * kv_sep, gboolean convert, gboolean unescape)
1354 GHashTable *new_table = NULL;
1357 gchar *pct_part_sep = NULL, *pct_kv_sep = NULL;
1358 gchar **split_parts;
1360 new_table = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
1362 if (convert && !unescape) {
1363 pct_part_sep = g_strdup_printf ("%%%2.2X", (guint) (*part_sep));
1364 pct_kv_sep = g_strdup_printf ("%%%2.2X", (guint) (*kv_sep));
1367 split_parts = g_strsplit (str, part_sep, -1);
1370 for (next_part = split_parts; *next_part; next_part += 1) {
1371 gchar *part = *next_part;
1374 /* if we are converting percent encoded versions of separators then
1375 * substitute the part separator now. */
1376 if (convert && !unescape) {
1378 for (next_sep = strcasestr (part, pct_part_sep); next_sep;
1379 next_sep = strcasestr (next_sep + 1, pct_part_sep)) {
1380 *next_sep = *part_sep;
1381 memmove (next_sep + 1, next_sep + 3, strlen (next_sep + 3) + 1);
1384 /* find the key/value separator within the part */
1385 kv_sep_pos = g_strstr_len (part, -1, kv_sep);
1386 if (kv_sep_pos == NULL) {
1388 key = g_uri_unescape_string (part, NULL);
1390 key = g_strdup (part);
1395 key = g_uri_unescape_segment (part, kv_sep_pos, NULL);
1396 value = g_uri_unescape_string (kv_sep_pos + 1, NULL);
1398 key = g_strndup (part, kv_sep_pos - part);
1399 value = g_strdup (kv_sep_pos + 1);
1402 /* if we are converting percent encoded versions of separators then
1403 * substitute the key/value separator in both key and value now. */
1404 if (convert && !unescape) {
1406 for (next_sep = strcasestr (key, pct_kv_sep); next_sep;
1407 next_sep = strcasestr (next_sep + 1, pct_kv_sep)) {
1408 *next_sep = *kv_sep;
1409 memmove (next_sep + 1, next_sep + 3, strlen (next_sep + 3) + 1);
1412 for (next_sep = strcasestr (value, pct_kv_sep); next_sep;
1413 next_sep = strcasestr (next_sep + 1, pct_kv_sep)) {
1414 *next_sep = *kv_sep;
1415 memmove (next_sep + 1, next_sep + 3, strlen (next_sep + 3) + 1);
1419 /* add value to the table */
1420 g_hash_table_insert (new_table, key, value);
1424 g_strfreev (split_parts);
1425 if (convert && !unescape) {
1426 g_free (pct_part_sep);
1427 g_free (pct_kv_sep);
1436 * Method definitions.
1441 * @scheme: (nullable): The scheme for the new URI.
1442 * @userinfo: (nullable): The user-info for the new URI.
1443 * @host: (nullable): The host name for the new URI.
1444 * @port: The port number for the new URI or %GST_URI_NO_PORT.
1445 * @path: (nullable): The path for the new URI with '/' separating path
1447 * @query: (nullable): The query string for the new URI with '&' separating
1448 * query elements. Elements containing '&' characters
1449 * should encode them as "%26".
1450 * @fragment: (nullable): The fragment name for the new URI.
1452 * Creates a new #GstUri object with the given URI parts. The path and query
1453 * strings will be broken down into their elements. All strings should not be
1454 * escaped except where indicated.
1456 * Returns: (transfer full): A new #GstUri object.
1461 gst_uri_new (const gchar * scheme, const gchar * userinfo, const gchar * host,
1462 guint port, const gchar * path, const gchar * query, const gchar * fragment)
1466 new_uri = _gst_uri_new ();
1468 new_uri->scheme = g_strdup (scheme);
1469 new_uri->userinfo = g_strdup (userinfo);
1470 new_uri->host = g_strdup (host);
1471 new_uri->port = port;
1472 new_uri->path = _gst_uri_string_to_list (path, "/", FALSE, FALSE);
1473 new_uri->query = _gst_uri_string_to_table (query, "&", "=", TRUE, FALSE);
1474 new_uri->fragment = g_strdup (fragment);
1481 * gst_uri_new_with_base:
1482 * @base: (transfer none)(nullable): The base URI to join the new URI to.
1483 * @scheme: (nullable): The scheme for the new URI.
1484 * @userinfo: (nullable): The user-info for the new URI.
1485 * @host: (nullable): The host name for the new URI.
1486 * @port: The port number for the new URI or %GST_URI_NO_PORT.
1487 * @path: (nullable): The path for the new URI with '/' separating path
1489 * @query: (nullable): The query string for the new URI with '&' separating
1490 * query elements. Elements containing '&' characters
1491 * should encode them as "%26".
1492 * @fragment: (nullable): The fragment name for the new URI.
1494 * Like gst_uri_new(), but joins the new URI onto a base URI.
1496 * Returns: (transfer full): The new URI joined onto @base.
1501 gst_uri_new_with_base (GstUri * base, const gchar * scheme,
1502 const gchar * userinfo, const gchar * host, guint port, const gchar * path,
1503 const gchar * query, const gchar * fragment)
1505 GstUri *new_rel_uri;
1508 g_return_val_if_fail (base == NULL || GST_IS_URI (base), NULL);
1510 new_rel_uri = gst_uri_new (scheme, userinfo, host, port, path, query,
1512 new_uri = gst_uri_join (base, new_rel_uri);
1513 gst_uri_unref (new_rel_uri);
1519 * gst_uri_from_string:
1520 * @uri: The URI string to parse.
1522 * Parses a URI string into a new #GstUri object. Will return NULL if the URI
1525 * Returns: (transfer full)(nullable): A new #GstUri object, or NULL.
1530 gst_uri_from_string (const gchar * uri)
1532 const gchar *orig_uri = uri;
1535 uri_obj = _gst_uri_new ();
1537 if (uri_obj && uri != NULL) {
1540 /* be helpful and skip initial white space */
1541 while (*uri == '\v' || g_ascii_isspace (*uri))
1544 if (g_ascii_isalpha (uri[i])) {
1545 /* find end of scheme name */
1547 while (g_ascii_isalnum (uri[i]) || uri[i] == '+' || uri[i] == '-' ||
1551 if (i > 0 && uri[i] == ':') {
1553 uri_obj->scheme = g_strndup (uri, i);
1556 if (uri[0] == '/' && uri[1] == '/') {
1557 const gchar *eoa, *eoui, *eoh, *reoh;
1558 /* get authority [userinfo@]host[:port] */
1560 /* find end of authority */
1561 eoa = uri + strcspn (uri, "/?#");
1563 /* find end of userinfo */
1564 eoui = strchr (uri, '@');
1565 if (eoui != NULL && eoui < eoa) {
1566 uri_obj->userinfo = g_uri_unescape_segment (uri, eoui, NULL);
1569 /* find end of host */
1570 if (uri[0] == '[') {
1571 eoh = strchr (uri, ']');
1572 if (eoh == NULL || eoh > eoa) {
1573 GST_DEBUG ("Unable to parse the host part of the URI '%s'.",
1575 _gst_uri_free (uri_obj);
1581 reoh = eoh = strchr (uri, ':');
1582 if (eoh == NULL || eoh > eoa)
1585 /* don't capture empty host strings */
1587 uri_obj->host = g_uri_unescape_segment (uri, eoh, NULL);
1591 /* if port number is malformed then we can't parse this */
1592 if (uri[0] != ':' || strspn (uri + 1, "0123456789") != eoa - uri - 1) {
1593 GST_DEBUG ("Unable to parse host/port part of the URI '%s'.",
1595 _gst_uri_free (uri_obj);
1598 /* otherwise treat port as unsigned decimal number */
1601 uri_obj->port = uri_obj->port * 10 + g_ascii_digit_value (*uri);
1607 if (uri != NULL && uri[0] != '\0') {
1610 len = strcspn (uri, "?#");
1611 if (uri[len] == '\0') {
1612 uri_obj->path = _gst_uri_string_to_list (uri, "/", FALSE, TRUE);
1616 gchar *path_str = g_strndup (uri, len);
1617 uri_obj->path = _gst_uri_string_to_list (path_str, "/", FALSE, TRUE);
1623 if (uri != NULL && uri[0] == '?') {
1626 eoq = strchr (++uri, '#');
1628 uri_obj->query = _gst_uri_string_to_table (uri, "&", "=", TRUE, TRUE);
1632 gchar *query_str = g_strndup (uri, eoq - uri);
1633 uri_obj->query = _gst_uri_string_to_table (query_str, "&", "=", TRUE,
1640 if (uri != NULL && uri[0] == '#') {
1641 uri_obj->fragment = g_uri_unescape_string (uri + 1, NULL);
1649 * gst_uri_from_string_with_base:
1650 * @base: (transfer none)(nullable): The base URI to join the new URI with.
1651 * @uri: The URI string to parse.
1653 * Like gst_uri_from_string() but also joins with a base URI.
1655 * Returns: (transfer full): A new #GstUri object.
1660 gst_uri_from_string_with_base (GstUri * base, const gchar * uri)
1662 GstUri *new_rel_uri;
1665 g_return_val_if_fail (base == NULL || GST_IS_URI (base), NULL);
1667 new_rel_uri = gst_uri_from_string (uri);
1668 new_uri = gst_uri_join (base, new_rel_uri);
1669 gst_uri_unref (new_rel_uri);
1676 * @first: First #GstUri to compare.
1677 * @second: Second #GstUri to compare.
1679 * Compares two #GstUri objects to see if they represent the same normalized
1682 * Returns: %TRUE if the normalized versions of the two URI's would be equal.
1687 gst_uri_equal (const GstUri * first, const GstUri * second)
1689 gchar *first_norm = NULL, *second_norm = NULL;
1690 GList *first_norm_list = NULL, *second_norm_list = NULL;
1691 const gchar *first_cmp, *second_cmp;
1692 GHashTableIter table_iter;
1693 gpointer key, value;
1696 g_return_val_if_fail ((first == NULL || GST_IS_URI (first)) &&
1697 (second == NULL || GST_IS_URI (second)), FALSE);
1699 if (first == second)
1702 if (first == NULL || second == NULL)
1705 if (first->port != second->port)
1708 /* work out a version of field value (normalized or not) to compare.
1709 * first_cmp, second_cmp will be the values to compare later.
1710 * first_norm, second_norm will be non-NULL if normalized versions are used,
1711 * and need to be freed later.
1713 #define GST_URI_NORMALIZED_FIELD(pos, field, norm_fn, flags) \
1714 pos##_cmp = pos->field; \
1715 if (_gst_uri_first_non_normalized_char ((gchar*)pos##_cmp, flags) != NULL) { \
1716 pos##_norm = g_strdup (pos##_cmp); \
1717 norm_fn (pos##_norm); \
1718 pos##_cmp = pos##_norm; \
1721 /* compare two string values, normalizing if needed */
1722 #define GST_URI_NORMALIZED_CMP_STR(field, norm_fn, flags) \
1723 GST_URI_NORMALIZED_FIELD (first, field, norm_fn, flags) \
1724 GST_URI_NORMALIZED_FIELD (second, field, norm_fn, flags) \
1725 result = g_strcmp0 (first_cmp, second_cmp); \
1726 g_free (first_norm); \
1727 first_norm = NULL; \
1728 g_free (second_norm); \
1729 second_norm = NULL; \
1730 if (result != 0) return FALSE
1732 /* compare two string values */
1733 #define GST_URI_CMP_STR(field) \
1734 if (g_strcmp0 (first->field, second->field) != 0) return FALSE
1736 /* compare two GLists, normalize lists if needed before comparison */
1737 #define GST_URI_NORMALIZED_CMP_LIST(field, norm_fn, copy_fn, cmp_fn, free_fn) \
1738 first_norm_list = g_list_copy_deep (first->field, (GCopyFunc) copy_fn, NULL); \
1739 norm_fn (&first_norm_list); \
1740 second_norm_list = g_list_copy_deep (second->field, (GCopyFunc) copy_fn, NULL); \
1741 norm_fn (&second_norm_list); \
1742 result = _gst_uri_compare_lists (first_norm_list, second_norm_list, (GCompareFunc) cmp_fn); \
1743 g_list_free_full (first_norm_list, free_fn); \
1744 g_list_free_full (second_norm_list, free_fn); \
1745 if (result != 0) return FALSE
1747 GST_URI_CMP_STR (userinfo);
1749 GST_URI_CMP_STR (fragment);
1751 GST_URI_NORMALIZED_CMP_STR (scheme, _gst_uri_normalize_scheme,
1752 _GST_URI_NORMALIZE_LOWERCASE);
1754 GST_URI_NORMALIZED_CMP_STR (host, _gst_uri_normalize_hostname,
1755 _GST_URI_NORMALIZE_LOWERCASE);
1757 GST_URI_NORMALIZED_CMP_LIST (path, _gst_uri_normalize_path, g_strdup,
1760 if (first->query == NULL && second->query != NULL)
1762 if (first->query != NULL && second->query == NULL)
1764 if (first->query != NULL) {
1765 if (g_hash_table_size (first->query) != g_hash_table_size (second->query))
1768 g_hash_table_iter_init (&table_iter, first->query);
1769 while (g_hash_table_iter_next (&table_iter, &key, &value)) {
1770 if (!g_hash_table_contains (second->query, key))
1772 result = g_strcmp0 (g_hash_table_lookup (second->query, key), value);
1777 #undef GST_URI_NORMALIZED_CMP_STR
1778 #undef GST_URI_CMP_STR
1779 #undef GST_URI_NORMALIZED_CMP_LIST
1780 #undef GST_URI_NORMALIZED_FIELD
1787 * @base_uri: (transfer none)(nullable): The base URI to join another to.
1788 * @ref_uri: (transfer none)(nullable): The reference URI to join onto the
1791 * Join a reference URI onto a base URI using the method from RFC 3986.
1792 * If either URI is %NULL then the other URI will be returned with the ref count
1795 * Returns: (transfer full): A #GstUri which represents the base with the
1796 * reference URI joined on.
1801 gst_uri_join (GstUri * base_uri, GstUri * ref_uri)
1803 const gchar *r_scheme;
1806 g_return_val_if_fail ((base_uri == NULL || GST_IS_URI (base_uri)) &&
1807 (ref_uri == NULL || GST_IS_URI (ref_uri)), NULL);
1809 if (base_uri == NULL && ref_uri == NULL)
1811 if (base_uri == NULL) {
1812 g_return_val_if_fail (GST_IS_URI (ref_uri), NULL);
1813 return gst_uri_ref (ref_uri);
1815 if (ref_uri == NULL) {
1816 g_return_val_if_fail (GST_IS_URI (base_uri), NULL);
1817 return gst_uri_ref (base_uri);
1820 g_return_val_if_fail (GST_IS_URI (base_uri) && GST_IS_URI (ref_uri), NULL);
1822 t = _gst_uri_new ();
1827 /* process according to RFC3986 */
1828 r_scheme = ref_uri->scheme;
1829 if (r_scheme != NULL && g_strcmp0 (base_uri->scheme, r_scheme) == 0) {
1832 if (r_scheme != NULL) {
1833 t->scheme = g_strdup (r_scheme);
1834 t->userinfo = g_strdup (ref_uri->userinfo);
1835 t->host = g_strdup (ref_uri->host);
1836 t->port = ref_uri->port;
1837 t->path = _remove_dot_segments (ref_uri->path);
1838 t->query = _gst_uri_copy_query_table (ref_uri->query);
1840 if (ref_uri->host != NULL) {
1841 t->userinfo = g_strdup (ref_uri->userinfo);
1842 t->host = g_strdup (ref_uri->host);
1843 t->port = ref_uri->port;
1844 t->path = _remove_dot_segments (ref_uri->path);
1845 t->query = _gst_uri_copy_query_table (ref_uri->query);
1847 if (ref_uri->path == NULL) {
1848 t->path = g_list_copy_deep (base_uri->path, (GCopyFunc) g_strdup, NULL);
1849 if (ref_uri->query != NULL)
1850 t->query = _gst_uri_copy_query_table (ref_uri->query);
1852 t->query = _gst_uri_copy_query_table (base_uri->query);
1854 if (ref_uri->path->data == NULL)
1855 t->path = _remove_dot_segments (ref_uri->path);
1857 GList *mrgd = _merge (base_uri->path, ref_uri->path);
1858 t->path = _remove_dot_segments (mrgd);
1859 g_list_free_full (mrgd, g_free);
1861 t->query = _gst_uri_copy_query_table (ref_uri->query);
1863 t->userinfo = g_strdup (base_uri->userinfo);
1864 t->host = g_strdup (base_uri->host);
1865 t->port = base_uri->port;
1867 t->scheme = g_strdup (base_uri->scheme);
1869 t->fragment = g_strdup (ref_uri->fragment);
1875 * gst_uri_join_strings:
1876 * @base_uri: The percent-encoded base URI.
1877 * @ref_uri: The percent-encoded reference URI to join to the @base_uri.
1879 * This is a convenience function to join two URI strings and return the result.
1880 * The returned string should be g_free()'d after use.
1882 * Returns: (transfer full): A string representing the percent-encoded join of
1888 gst_uri_join_strings (const gchar * base_uri, const gchar * ref_uri)
1890 GstUri *base, *result;
1893 base = gst_uri_from_string (base_uri);
1894 result = gst_uri_from_string_with_base (base, ref_uri);
1895 result_uri = gst_uri_to_string (result);
1896 gst_uri_unref (base);
1897 gst_uri_unref (result);
1903 * gst_uri_is_writable:
1904 * @uri: The #GstUri object to test.
1906 * Check if it is safe to write to this #GstUri.
1908 * Check if the refcount of @uri is exactly 1, meaning that no other
1909 * reference exists to the #GstUri and that the #GstUri is therefore writable.
1911 * Modification of a #GstUri should only be done after verifying that it is
1914 * Returns: %TRUE if it is safe to write to the object.
1919 gst_uri_is_writable (const GstUri * uri)
1921 g_return_val_if_fail (GST_IS_URI (uri), FALSE);
1922 return gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (uri));
1926 * gst_uri_make_writable:
1927 * @uri: (transfer full): The #GstUri object to make writable.
1929 * Make the #GstUri writable.
1931 * Checks if @uri is writable, and if so the original object is returned. If
1932 * not, then a writable copy is made and returned. This gives away the
1933 * reference to @uri and returns a reference to the new #GstUri.
1934 * If @uri is %NULL then %NULL is returned.
1936 * Returns: (transfer full): A writable version of @uri.
1941 gst_uri_make_writable (GstUri * uri)
1943 g_return_val_if_fail (GST_IS_URI (uri), NULL);
1945 GST_URI_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (uri)));
1949 * gst_uri_to_string:
1950 * @uri: This #GstUri to convert to a string.
1952 * Convert the URI to a string.
1954 * Returns the URI as held in this object as a #gchar* nul-terminated string.
1955 * The caller should g_free() the string once they are finished with it.
1956 * The string is put together as described in RFC 3986.
1958 * Returns: (transfer full): The string version of the URI.
1963 gst_uri_to_string (const GstUri * uri)
1968 g_return_val_if_fail (GST_IS_URI (uri), NULL);
1970 uri_str = g_string_new (NULL);
1972 if (uri->scheme != NULL)
1973 g_string_append_printf (uri_str, "%s:", uri->scheme);
1975 if (uri->userinfo != NULL || uri->host != NULL ||
1976 uri->port != GST_URI_NO_PORT)
1977 g_string_append (uri_str, "//");
1979 if (uri->userinfo != NULL) {
1980 escaped = _gst_uri_escape_userinfo (uri->userinfo);
1981 g_string_append_printf (uri_str, "%s@", escaped);
1985 if (uri->host != NULL) {
1986 if (strchr (uri->host, ':') != NULL) {
1987 escaped = _gst_uri_escape_host_colon (uri->host);
1988 g_string_append_printf (uri_str, "[%s]", escaped);
1991 escaped = _gst_uri_escape_host (uri->host);
1992 g_string_append (uri_str, escaped);
1997 if (uri->port != GST_URI_NO_PORT)
1998 g_string_append_printf (uri_str, ":%u", uri->port);
2000 if (uri->path != NULL) {
2001 escaped = gst_uri_get_path_string (uri);
2002 g_string_append (uri_str, escaped);
2007 g_string_append (uri_str, "?");
2008 escaped = gst_uri_get_query_string (uri);
2009 g_string_append (uri_str, escaped);
2013 if (uri->fragment != NULL) {
2014 escaped = _gst_uri_escape_fragment (uri->fragment);
2015 g_string_append_printf (uri_str, "#%s", escaped);
2019 return g_string_free (uri_str, FALSE);
2023 * gst_uri_is_normalized:
2024 * @uri: The #GstUri to test to see if it is normalized.
2026 * Tests the @uri to see if it is normalized. A %NULL @uri is considered to be
2029 * Returns: TRUE if the URI is normalized or is %NULL.
2034 gst_uri_is_normalized (const GstUri * uri)
2042 g_return_val_if_fail (GST_IS_URI (uri), FALSE);
2044 /* check for non-normalized characters in uri parts */
2045 if (_gst_uri_first_non_normalized_char (uri->scheme,
2046 _GST_URI_NORMALIZE_LOWERCASE) != NULL ||
2047 /*_gst_uri_first_non_normalized_char (uri->userinfo,
2048 _GST_URI_NORMALIZE_PERCENTAGES) != NULL || */
2049 _gst_uri_first_non_normalized_char (uri->host,
2050 _GST_URI_NORMALIZE_LOWERCASE /*| _GST_URI_NORMALIZE_PERCENTAGES */ )
2052 /*|| _gst_uri_first_non_normalized_char (uri->path,
2053 _GST_URI_NORMALIZE_PERCENTAGES) != NULL
2054 || _gst_uri_first_non_normalized_char (uri->query,
2055 _GST_URI_NORMALIZE_PERCENTAGES) != NULL
2056 || _gst_uri_first_non_normalized_char (uri->fragment,
2057 _GST_URI_NORMALIZE_PERCENTAGES) != NULL */ )
2060 /* also check path has had dot segments removed */
2061 new_path = _remove_dot_segments (uri->path);
2063 (_gst_uri_compare_lists (new_path, uri->path,
2064 (GCompareFunc) g_strcmp0) == 0);
2065 g_list_free_full (new_path, g_free);
2070 * gst_uri_normalize:
2071 * @uri: (transfer none): The #GstUri to normalize.
2073 * Normalization will remove extra path segments ("." and "..") from the URI. It
2074 * will also convert the scheme and host name to lower case and any
2075 * percent-encoded values to uppercase.
2077 * The #GstUri object must be writable. Check with gst_uri_is_writable() or use
2078 * gst_uri_make_writable() first.
2080 * Returns: TRUE if the URI was modified.
2085 gst_uri_normalize (GstUri * uri)
2087 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2089 return _gst_uri_normalize_scheme (uri->scheme) |
2090 _gst_uri_normalize_userinfo (uri->userinfo) |
2091 _gst_uri_normalize_hostname (uri->host) |
2092 _gst_uri_normalize_path (&uri->path) |
2093 _gst_uri_normalize_query (uri->query) |
2094 _gst_uri_normalize_fragment (uri->fragment);
2098 * gst_uri_get_scheme:
2099 * @uri: (nullable): This #GstUri object.
2101 * Get the scheme name from the URI or %NULL if it doesn't exist.
2102 * If @uri is %NULL then returns %NULL.
2104 * Returns: The scheme from the #GstUri object or %NULL.
2107 gst_uri_get_scheme (const GstUri * uri)
2109 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), NULL);
2110 return (uri ? uri->scheme : NULL);
2114 * gst_uri_set_scheme:
2115 * @uri: (transfer none)(nullable): The #GstUri to modify.
2116 * @scheme: The new scheme to set or %NULL to unset the scheme.
2118 * Set or unset the scheme for the URI.
2120 * Returns: %TRUE if the scheme was set/unset successfully.
2125 gst_uri_set_scheme (GstUri * uri, const gchar * scheme)
2128 return scheme == NULL;
2129 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2131 g_free (uri->scheme);
2132 uri->scheme = g_strdup (scheme);
2138 * gst_uri_get_userinfo:
2139 * @uri: (nullable): This #GstUri object.
2141 * Get the userinfo (usually in the form "username:password") from the URI
2142 * or %NULL if it doesn't exist. If @uri is %NULL then returns %NULL.
2144 * Returns: The userinfo from the #GstUri object or %NULL.
2149 gst_uri_get_userinfo (const GstUri * uri)
2151 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), NULL);
2152 return (uri ? uri->userinfo : NULL);
2156 * gst_uri_set_userinfo:
2157 * @uri: (transfer none)(nullable): The #GstUri to modify.
2158 * @userinfo: The new user-information string to set or %NULL to unset.
2160 * Set or unset the user information for the URI.
2162 * Returns: %TRUE if the user information was set/unset successfully.
2167 gst_uri_set_userinfo (GstUri * uri, const gchar * userinfo)
2170 return userinfo == NULL;
2171 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2173 g_free (uri->userinfo);
2174 uri->userinfo = g_strdup (userinfo);
2181 * @uri: (nullable): This #GstUri object.
2183 * Get the host name from the URI or %NULL if it doesn't exist.
2184 * If @uri is %NULL then returns %NULL.
2186 * Returns: The host name from the #GstUri object or %NULL.
2191 gst_uri_get_host (const GstUri * uri)
2193 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), NULL);
2194 return (uri ? uri->host : NULL);
2199 * @uri: (transfer none)(nullable): The #GstUri to modify.
2200 * @host: The new host string to set or %NULL to unset.
2202 * Set or unset the host for the URI.
2204 * Returns: %TRUE if the host was set/unset successfully.
2209 gst_uri_set_host (GstUri * uri, const gchar * host)
2212 return host == NULL;
2213 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2216 uri->host = g_strdup (host);
2223 * @uri: (nullable): This #GstUri object.
2225 * Get the port number from the URI or %GST_URI_NO_PORT if it doesn't exist.
2226 * If @uri is %NULL then returns %GST_URI_NO_PORT.
2228 * Returns: The port number from the #GstUri object or %GST_URI_NO_PORT.
2233 gst_uri_get_port (const GstUri * uri)
2235 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), GST_URI_NO_PORT);
2236 return (uri ? uri->port : GST_URI_NO_PORT);
2241 * @uri: (transfer none)(nullable): The #GstUri to modify.
2242 * @port: The new port number to set or %GST_URI_NO_PORT to unset.
2244 * Set or unset the port number for the URI.
2246 * Returns: %TRUE if the port number was set/unset successfully.
2251 gst_uri_set_port (GstUri * uri, guint port)
2254 return port == GST_URI_NO_PORT;
2255 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2264 * @uri: The #GstUri to get the path from.
2266 * Extract the path string from the URI object.
2268 * Returns: (transfer full): The path from the URI. Once finished with the
2269 * string should be g_free()'d.
2274 gst_uri_get_path (const GstUri * uri)
2276 GList *path_segment;
2277 const gchar *sep = "";
2282 g_return_val_if_fail (GST_IS_URI (uri), NULL);
2286 ret = g_string_new (NULL);
2288 for (path_segment = uri->path; path_segment;
2289 path_segment = path_segment->next) {
2290 g_string_append (ret, sep);
2291 if (path_segment->data) {
2292 g_string_append (ret, path_segment->data);
2297 return g_string_free (ret, FALSE);
2302 * @uri: (transfer none)(nullable): The #GstUri to modify.
2303 * @path: The new path to set with path segments separated by '/', or use %NULL
2304 * to unset the path.
2306 * Sets or unsets the path in the URI.
2308 * Returns: %TRUE if the path was set successfully.
2313 gst_uri_set_path (GstUri * uri, const gchar * path)
2316 return path == NULL;
2317 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2319 g_list_free_full (uri->path, g_free);
2320 uri->path = _gst_uri_string_to_list (path, "/", FALSE, FALSE);
2326 * gst_uri_get_path_string:
2327 * @uri: The #GstUri to get the path from.
2329 * Extract the path string from the URI object as a percent encoded URI path.
2331 * Returns: (transfer full): The path from the URI. Once finished with the
2332 * string should be g_free()'d.
2337 gst_uri_get_path_string (const GstUri * uri)
2339 GList *path_segment;
2340 const gchar *sep = "";
2346 g_return_val_if_fail (GST_IS_URI (uri), NULL);
2350 ret = g_string_new (NULL);
2352 for (path_segment = uri->path; path_segment;
2353 path_segment = path_segment->next) {
2354 g_string_append (ret, sep);
2355 if (path_segment->data) {
2356 escaped = _gst_uri_escape_path_segment (path_segment->data);
2357 g_string_append (ret, escaped);
2363 return g_string_free (ret, FALSE);
2367 * gst_uri_set_path_string:
2368 * @uri: (transfer none)(nullable): The #GstUri to modify.
2369 * @path: The new percent encoded path to set with path segments separated by
2370 * '/', or use %NULL to unset the path.
2372 * Sets or unsets the path in the URI.
2374 * Returns: %TRUE if the path was set successfully.
2379 gst_uri_set_path_string (GstUri * uri, const gchar * path)
2382 return path == NULL;
2383 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2385 g_list_free_full (uri->path, g_free);
2386 uri->path = _gst_uri_string_to_list (path, "/", FALSE, TRUE);
2391 * gst_uri_get_path_segments:
2392 * @uri: (nullable): The #GstUri to get the path from.
2394 * Get a list of path segments from the URI.
2396 * Returns: (transfer full)(element-type gchar*): A #GList of path segment
2397 * strings or %NULL if no path segments are available. Free the list
2398 * when no longer needed with g_list_free_full(list, g_free).
2403 gst_uri_get_path_segments (const GstUri * uri)
2407 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), NULL);
2410 ret = g_list_copy_deep (uri->path, (GCopyFunc) g_strdup, NULL);
2417 * gst_uri_set_path_segments:
2418 * @uri: (transfer none)(nullable): The #GstUri to modify.
2419 * @path_segments: (transfer full)(nullable)(element-type gchar*): The new
2422 * Replace the path segments list in the URI.
2424 * Returns: %TRUE if the path segments were set successfully.
2429 gst_uri_set_path_segments (GstUri * uri, GList * path_segments)
2431 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), FALSE);
2435 g_list_free_full (path_segments, g_free);
2436 return path_segments == NULL;
2439 g_return_val_if_fail (gst_uri_is_writable (uri), FALSE);
2441 g_list_free_full (uri->path, g_free);
2442 uri->path = path_segments;
2447 * gst_uri_append_path:
2448 * @uri: (transfer none)(nullable): The #GstUri to modify.
2449 * @relative_path: Relative path to append to the end of the current path.
2451 * Append a path onto the end of the path in the URI. The path is not
2452 * normalized, call #gst_uri_normalize() to normalize the path.
2454 * Returns: %TRUE if the path was appended successfully.
2459 gst_uri_append_path (GstUri * uri, const gchar * relative_path)
2461 GList *rel_path_list;
2464 return relative_path == NULL;
2465 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2470 GList *last_elem = g_list_last (uri->path);
2471 if (last_elem->data == NULL) {
2472 uri->path = g_list_delete_link (uri->path, last_elem);
2475 rel_path_list = _gst_uri_string_to_list (relative_path, "/", FALSE, FALSE);
2476 /* if path was absolute, make it relative by removing initial NULL element */
2477 if (rel_path_list && rel_path_list->data == NULL) {
2478 rel_path_list = g_list_delete_link (rel_path_list, rel_path_list);
2480 uri->path = g_list_concat (uri->path, rel_path_list);
2485 * gst_uri_append_path_segment:
2486 * @uri: (transfer none)(nullable): The #GstUri to modify.
2487 * @path_segment: The path segment string to append to the URI path.
2489 * Append a single path segment onto the end of the URI path.
2491 * Returns: %TRUE if the path was appended successfully.
2496 gst_uri_append_path_segment (GstUri * uri, const gchar * path_segment)
2499 return path_segment == NULL;
2500 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2504 /* if base path ends in a directory (i.e. last element is NULL), remove it */
2505 if (uri->path && g_list_last (uri->path)->data == NULL) {
2506 uri->path = g_list_delete_link (uri->path, g_list_last (uri->path));
2508 uri->path = g_list_append (uri->path, g_strdup (path_segment));
2513 * gst_uri_get_query_string:
2514 * @uri: (nullable): The #GstUri to get the query string from.
2516 * Get a percent encoded URI query string from the @uri.
2518 * Returns: (transfer full): A percent encoded query string. Use g_free() when
2524 gst_uri_get_query_string (const GstUri * uri)
2526 GHashTableIter iter;
2527 gpointer key, value;
2528 const gchar *sep = "";
2534 g_return_val_if_fail (GST_IS_URI (uri), NULL);
2538 ret = g_string_new (NULL);
2539 g_hash_table_iter_init (&iter, uri->query);
2540 while (g_hash_table_iter_next (&iter, &key, &value)) {
2541 g_string_append (ret, sep);
2542 escaped = _gst_uri_escape_http_query_element (key);
2543 g_string_append (ret, escaped);
2546 escaped = _gst_uri_escape_http_query_element (value);
2547 g_string_append_printf (ret, "=%s", escaped);
2553 return g_string_free (ret, FALSE);
2557 * gst_uri_set_query_string:
2558 * @uri: (transfer none)(nullable): The #GstUri to modify.
2559 * @query: The new percent encoded query string to use to populate the query
2560 * table, or use %NULL to unset the query table.
2562 * Sets or unsets the query table in the URI.
2564 * Returns: %TRUE if the query table was set successfully.
2569 gst_uri_set_query_string (GstUri * uri, const gchar * query)
2572 return query == NULL;
2574 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2577 g_hash_table_unref (uri->query);
2578 uri->query = _gst_uri_string_to_table (query, "&", "=", TRUE, TRUE);
2584 * gst_uri_get_query_table:
2585 * @uri: (nullable): The #GstUri to get the query table from.
2587 * Get the query table from the URI. Keys and values in the table are freed
2588 * with g_free when they are deleted. A value may be %NULL to indicate that
2589 * the key should appear in the query string in the URI, but does not have a
2590 * value. Free the returned #GHashTable with #g_hash_table_unref() when it is
2591 * no longer required. Modifying this hash table will modify the query in the
2594 * Returns: (transfer full)(element-type gchar* gchar*): The query hash table
2600 gst_uri_get_query_table (const GstUri * uri)
2604 g_return_val_if_fail (GST_IS_URI (uri), NULL);
2608 return g_hash_table_ref (uri->query);
2612 * gst_uri_set_query_table:
2613 * @uri: (transfer none)(nullable): The #GstUri to modify.
2614 * @query_table: (transfer none)(nullable)(element-type gchar* gchar*): The new
2615 * query table to use.
2617 * Set the query table to use in the URI. The old table is unreferenced and a
2618 * reference to the new one is used instead. A value if %NULL for @query_table
2619 * will remove the query string from the URI.
2621 * Returns: %TRUE if the new table was sucessfully used for the query table.
2626 gst_uri_set_query_table (GstUri * uri, GHashTable * query_table)
2628 GHashTable *old_table = NULL;
2631 return query_table == NULL;
2632 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2634 old_table = uri->query;
2636 uri->query = g_hash_table_ref (query_table);
2640 g_hash_table_unref (old_table);
2646 * gst_uri_set_query_value:
2647 * @uri: (transfer none)(nullable): The #GstUri to modify.
2648 * @query_key: (transfer none): The key for the query entry.
2649 * @query_value: (transfer none)(nullable): The value for the key.
2651 * This inserts or replaces a key in the query table. A @query_value of %NULL
2652 * indicates that the key has no associated value, but will still be present in
2655 * Returns: %TRUE if the query table was sucessfully updated.
2660 gst_uri_set_query_value (GstUri * uri, const gchar * query_key,
2661 const gchar * query_value)
2665 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2668 uri->query = g_hash_table_new_full (g_str_hash, g_str_equal, g_free,
2671 g_hash_table_insert (uri->query, g_strdup (query_key),
2672 g_strdup (query_value));
2678 * gst_uri_remove_query_key:
2679 * @uri: (transfer none)(nullable): The #GstUri to modify.
2680 * @query_key: The key to remove.
2682 * Remove an entry from the query table by key.
2684 * Returns: %TRUE if the key existed in the table and was removed.
2689 gst_uri_remove_query_key (GstUri * uri, const gchar * query_key)
2695 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2699 result = g_hash_table_remove (uri->query, query_key);
2700 /* if this was the last query entry, remove the query string completely */
2701 if (result && g_hash_table_size (uri->query) == 0) {
2702 g_hash_table_unref (uri->query);
2709 * gst_uri_query_has_key:
2710 * @uri: (nullable): The #GstUri to examine.
2711 * @query_key: The key to lookup.
2713 * Check if there is a query table entry for the @query_key key.
2715 * Returns: %TRUE if @query_key exists in the URI query table.
2720 gst_uri_query_has_key (const GstUri * uri, const gchar * query_key)
2724 g_return_val_if_fail (GST_IS_URI (uri), FALSE);
2728 return g_hash_table_contains (uri->query, query_key);
2732 * gst_uri_get_query_value:
2733 * @uri: (nullable): The #GstUri to examine.
2734 * @query_key: The key to lookup.
2736 * Get the value associated with the @query_key key. Will return %NULL if the
2737 * key has no value or if the key does not exist in the URI query table. Because
2738 * %NULL is returned for both missing keys and keys with no value, you should
2739 * use gst_uri_query_has_key() to determine if a key is present in the URI
2742 * Returns: The value for the given key, or %NULL if not found.
2747 gst_uri_get_query_value (const GstUri * uri, const gchar * query_key)
2751 g_return_val_if_fail (GST_IS_URI (uri), NULL);
2755 return g_hash_table_lookup (uri->query, query_key);
2759 * gst_uri_get_query_keys:
2760 * @uri: (nullable): The #GstUri to examine.
2762 * Get a list of the query keys from the URI.
2764 * Returns: (transfer container)(element-type gchar*): A list of keys from
2765 * the URI query. Free the list with g_list_free().
2770 gst_uri_get_query_keys (const GstUri * uri)
2774 g_return_val_if_fail (GST_IS_URI (uri), NULL);
2778 return g_hash_table_get_keys (uri->query);
2782 * gst_uri_get_fragment:
2783 * @uri: (nullable): This #GstUri object.
2785 * Get the fragment name from the URI or %NULL if it doesn't exist.
2786 * If @uri is %NULL then returns %NULL.
2788 * Returns: The host name from the #GstUri object or %NULL.
2793 gst_uri_get_fragment (const GstUri * uri)
2795 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), NULL);
2796 return (uri ? uri->fragment : NULL);
2800 * gst_uri_set_fragment:
2801 * @uri: (transfer none)(nullable): The #GstUri to modify.
2802 * @fragment: (nullable): The fragment string to set.
2804 * Sets the fragment string in the URI. Use a value of %NULL in @fragment to
2805 * unset the fragment string.
2807 * Returns: %TRUE if the fragment was set/unset successfully.
2812 gst_uri_set_fragment (GstUri * uri, const gchar * fragment)
2815 return fragment == NULL;
2816 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2818 g_free (uri->fragment);
2819 uri->fragment = g_strdup (fragment);