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 URIHandler is an interface that is implemented by Source and Sink
31 * #GstElement to simplify then 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);
1241 out = g_list_delete_link (out, elem);
1249 _gst_uri_escape_userinfo (const gchar * userinfo)
1251 return g_uri_escape_string (userinfo,
1252 G_URI_RESERVED_CHARS_ALLOWED_IN_USERINFO, FALSE);
1256 _gst_uri_escape_host (const gchar * host)
1258 return g_uri_escape_string (host,
1259 G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, FALSE);
1263 _gst_uri_escape_host_colon (const gchar * host)
1265 return g_uri_escape_string (host,
1266 G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS ":", FALSE);
1270 _gst_uri_escape_path_segment (const gchar * segment)
1272 return g_uri_escape_string (segment,
1273 G_URI_RESERVED_CHARS_ALLOWED_IN_PATH_ELEMENT, FALSE);
1277 _gst_uri_escape_http_query_element (const gchar * element)
1281 ret = g_uri_escape_string (element, "!$'()*,;:@/? ", FALSE);
1282 for (c = ret; *c; c++)
1289 _gst_uri_escape_fragment (const gchar * fragment)
1291 return g_uri_escape_string (fragment,
1292 G_URI_RESERVED_CHARS_ALLOWED_IN_PATH "?", FALSE);
1296 _gst_uri_string_to_list (const gchar * str, const gchar * sep, gboolean convert,
1299 GList *new_list = NULL;
1302 guint pct_sep_len = 0;
1303 gchar *pct_sep = NULL;
1306 if (convert && !unescape) {
1307 pct_sep = g_strdup_printf ("%%%2.2X", (guint) (*sep));
1311 split_str = g_strsplit (str, sep, -1);
1314 for (next_elem = split_str; *next_elem; next_elem += 1) {
1315 gchar *elem = *next_elem;
1316 if (*elem == '\0') {
1317 new_list = g_list_append (new_list, NULL);
1319 if (convert && !unescape) {
1321 for (next_sep = strcasestr (elem, pct_sep); next_sep;
1322 next_sep = strcasestr (next_sep + 1, pct_sep)) {
1324 memmove (next_sep + 1, next_sep + pct_sep_len,
1325 strlen (next_sep + pct_sep_len) + 1);
1329 *next_elem = g_uri_unescape_string (elem, NULL);
1333 new_list = g_list_append (new_list, g_strdup (elem));
1337 g_strfreev (split_str);
1338 if (convert && !unescape)
1346 _gst_uri_string_to_table (const gchar * str, const gchar * part_sep,
1347 const gchar * kv_sep, gboolean convert, gboolean unescape)
1349 GHashTable *new_table = NULL;
1352 gchar *pct_part_sep = NULL, *pct_kv_sep = NULL;
1353 gchar **split_parts;
1355 new_table = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
1357 if (convert && !unescape) {
1358 pct_part_sep = g_strdup_printf ("%%%2.2X", (guint) (*part_sep));
1359 pct_kv_sep = g_strdup_printf ("%%%2.2X", (guint) (*kv_sep));
1362 split_parts = g_strsplit (str, part_sep, -1);
1365 for (next_part = split_parts; *next_part; next_part += 1) {
1366 gchar *part = *next_part;
1369 /* if we are converting percent encoded versions of separators then
1370 * substitute the part separator now. */
1371 if (convert && !unescape) {
1373 for (next_sep = strcasestr (part, pct_part_sep); next_sep;
1374 next_sep = strcasestr (next_sep + 1, pct_part_sep)) {
1375 *next_sep = *part_sep;
1376 memmove (next_sep + 1, next_sep + 3, strlen (next_sep + 3) + 1);
1379 /* find the key/value separator within the part */
1380 kv_sep_pos = g_strstr_len (part, -1, kv_sep);
1381 if (kv_sep_pos == NULL) {
1383 key = g_uri_unescape_string (part, NULL);
1385 key = g_strdup (part);
1390 key = g_uri_unescape_segment (part, kv_sep_pos, NULL);
1391 value = g_uri_unescape_string (kv_sep_pos + 1, NULL);
1393 key = g_strndup (part, kv_sep_pos - part);
1394 value = g_strdup (kv_sep_pos + 1);
1397 /* if we are converting percent encoded versions of separators then
1398 * substitute the key/value separator in both key and value now. */
1399 if (convert && !unescape) {
1401 for (next_sep = strcasestr (key, pct_kv_sep); next_sep;
1402 next_sep = strcasestr (next_sep + 1, pct_kv_sep)) {
1403 *next_sep = *kv_sep;
1404 memmove (next_sep + 1, next_sep + 3, strlen (next_sep + 3) + 1);
1407 for (next_sep = strcasestr (value, pct_kv_sep); next_sep;
1408 next_sep = strcasestr (next_sep + 1, pct_kv_sep)) {
1409 *next_sep = *kv_sep;
1410 memmove (next_sep + 1, next_sep + 3, strlen (next_sep + 3) + 1);
1414 /* add value to the table */
1415 g_hash_table_insert (new_table, key, value);
1419 g_strfreev (split_parts);
1420 if (convert && !unescape) {
1421 g_free (pct_part_sep);
1422 g_free (pct_kv_sep);
1431 * Method definitions.
1436 * @scheme: (nullable): The scheme for the new URI.
1437 * @userinfo: (nullable): The user-info for the new URI.
1438 * @host: (nullable): The host name for the new URI.
1439 * @port: The port number for the new URI or %GST_URI_NO_PORT.
1440 * @path: (nullable): The path for the new URI with '/' separating path
1442 * @query: (nullable): The query string for the new URI with '&' separating
1443 * query elements. Elements containing '&' characters
1444 * should encode them as "%26".
1445 * @fragment: (nullable): The fragment name for the new URI.
1447 * Creates a new #GstUri object with the given URI parts. The path and query
1448 * strings will be broken down into their elements. All strings should not be
1449 * escaped except where indicated.
1451 * Returns: (transfer full): A new #GstUri object.
1456 gst_uri_new (const gchar * scheme, const gchar * userinfo, const gchar * host,
1457 guint port, const gchar * path, const gchar * query, const gchar * fragment)
1461 new_uri = _gst_uri_new ();
1463 new_uri->scheme = g_strdup (scheme);
1464 new_uri->userinfo = g_strdup (userinfo);
1465 new_uri->host = g_strdup (host);
1466 new_uri->port = port;
1467 new_uri->path = _gst_uri_string_to_list (path, "/", FALSE, FALSE);
1468 new_uri->query = _gst_uri_string_to_table (query, "&", "=", TRUE, FALSE);
1469 new_uri->fragment = g_strdup (fragment);
1476 * gst_uri_new_with_base:
1477 * @base: (transfer none)(nullable): The base URI to join the new URI to.
1478 * @scheme: (nullable): The scheme for the new URI.
1479 * @userinfo: (nullable): The user-info for the new URI.
1480 * @host: (nullable): The host name for the new URI.
1481 * @port: The port number for the new URI or %GST_URI_NO_PORT.
1482 * @path: (nullable): The path for the new URI with '/' separating path
1484 * @query: (nullable): The query string for the new URI with '&' separating
1485 * query elements. Elements containing '&' characters
1486 * should encode them as "%26".
1487 * @fragment: (nullable): The fragment name for the new URI.
1489 * Like gst_uri_new(), but joins the new URI onto a base URI.
1491 * Returns: (transfer full): The new URI joined onto @base.
1496 gst_uri_new_with_base (GstUri * base, const gchar * scheme,
1497 const gchar * userinfo, const gchar * host, guint port, const gchar * path,
1498 const gchar * query, const gchar * fragment)
1500 GstUri *new_rel_uri;
1503 g_return_val_if_fail (base == NULL || GST_IS_URI (base), NULL);
1505 new_rel_uri = gst_uri_new (scheme, userinfo, host, port, path, query,
1507 new_uri = gst_uri_join (base, new_rel_uri);
1508 gst_uri_unref (new_rel_uri);
1514 * gst_uri_from_string:
1515 * @uri: The URI string to parse.
1517 * Parses a URI string into a new #GstUri object. Will return NULL if the URI
1520 * Returns: (transfer full)(nullable): A new #GstUri object, or NULL.
1525 gst_uri_from_string (const gchar * uri)
1527 const gchar *orig_uri = uri;
1530 uri_obj = _gst_uri_new ();
1532 if (uri_obj && uri != NULL) {
1535 /* be helpful and skip initial white space */
1536 while (*uri == '\v' || g_ascii_isspace (*uri))
1539 if (g_ascii_isalpha (uri[i])) {
1540 /* find end of scheme name */
1542 while (g_ascii_isalnum (uri[i]) || uri[i] == '+' || uri[i] == '-' ||
1546 if (i > 0 && uri[i] == ':') {
1548 uri_obj->scheme = g_strndup (uri, i);
1551 if (uri[0] == '/' && uri[1] == '/') {
1552 const gchar *eoa, *eoui, *eoh, *reoh;
1553 /* get authority [userinfo@]host[:port] */
1555 /* find end of authority */
1556 eoa = uri + strcspn (uri, "/?#");
1558 /* find end of userinfo */
1559 eoui = strchr (uri, '@');
1560 if (eoui != NULL && eoui < eoa) {
1561 uri_obj->userinfo = g_uri_unescape_segment (uri, eoui, NULL);
1564 /* find end of host */
1565 if (uri[0] == '[') {
1566 eoh = strchr (uri, ']');
1567 if (eoh == NULL || eoh > eoa) {
1568 GST_DEBUG ("Unable to parse the host part of the URI '%s'.",
1570 _gst_uri_free (uri_obj);
1576 reoh = eoh = strchr (uri, ':');
1577 if (eoh == NULL || eoh > eoa)
1580 /* don't capture empty host strings */
1582 uri_obj->host = g_uri_unescape_segment (uri, eoh, NULL);
1586 /* if port number is malformed then we can't parse this */
1587 if (uri[0] != ':' || strspn (uri + 1, "0123456789") != eoa - uri - 1) {
1588 GST_DEBUG ("Unable to parse host/port part of the URI '%s'.",
1590 _gst_uri_free (uri_obj);
1593 /* otherwise treat port as unsigned decimal number */
1596 uri_obj->port = uri_obj->port * 10 + g_ascii_digit_value (*uri);
1602 if (uri != NULL && uri[0] != '\0') {
1605 len = strcspn (uri, "?#");
1606 if (uri[len] == '\0') {
1607 uri_obj->path = _gst_uri_string_to_list (uri, "/", FALSE, TRUE);
1611 gchar *path_str = g_strndup (uri, len);
1612 uri_obj->path = _gst_uri_string_to_list (path_str, "/", FALSE, TRUE);
1618 if (uri != NULL && uri[0] == '?') {
1621 eoq = strchr (++uri, '#');
1623 uri_obj->query = _gst_uri_string_to_table (uri, "&", "=", TRUE, TRUE);
1627 gchar *query_str = g_strndup (uri, eoq - uri);
1628 uri_obj->query = _gst_uri_string_to_table (query_str, "&", "=", TRUE,
1635 if (uri != NULL && uri[0] == '#') {
1636 uri_obj->fragment = g_uri_unescape_string (uri + 1, NULL);
1644 * gst_uri_from_string_with_base:
1645 * @base: (transfer none)(nullable): The base URI to join the new URI with.
1646 * @uri: The URI string to parse.
1648 * Like gst_uri_from_string() but also joins with a base URI.
1650 * Returns: (transfer full): A new #GstUri object.
1655 gst_uri_from_string_with_base (GstUri * base, const gchar * uri)
1657 GstUri *new_rel_uri;
1660 g_return_val_if_fail (base == NULL || GST_IS_URI (base), NULL);
1662 new_rel_uri = gst_uri_from_string (uri);
1663 new_uri = gst_uri_join (base, new_rel_uri);
1664 gst_uri_unref (new_rel_uri);
1671 * @first: First #GstUri to compare.
1672 * @second: Second #GstUri to compare.
1674 * Compares two #GstUri objects to see if they represent the same normalized
1677 * Returns: %TRUE if the normalized versions of the two URI's would be equal.
1682 gst_uri_equal (const GstUri * first, const GstUri * second)
1684 gchar *first_norm = NULL, *second_norm = NULL;
1685 GList *first_norm_list = NULL, *second_norm_list = NULL;
1686 const gchar *first_cmp, *second_cmp;
1687 GHashTableIter table_iter;
1688 gpointer key, value;
1691 g_return_val_if_fail ((first == NULL || GST_IS_URI (first)) &&
1692 (second == NULL || GST_IS_URI (second)), FALSE);
1694 if (first == second)
1697 if (first == NULL || second == NULL)
1700 if (first->port != second->port)
1703 /* work out a version of field value (normalized or not) to compare.
1704 * first_cmp, second_cmp will be the values to compare later.
1705 * first_norm, second_norm will be non-NULL if normalized versions are used,
1706 * and need to be freed later.
1708 #define GST_URI_NORMALIZED_FIELD(pos, field, norm_fn, flags) \
1709 pos##_cmp = pos->field; \
1710 if (_gst_uri_first_non_normalized_char ((gchar*)pos##_cmp, flags) != NULL) { \
1711 pos##_norm = g_strdup (pos##_cmp); \
1712 norm_fn (pos##_norm); \
1713 pos##_cmp = pos##_norm; \
1716 /* compare two string values, normalizing if needed */
1717 #define GST_URI_NORMALIZED_CMP_STR(field, norm_fn, flags) \
1718 GST_URI_NORMALIZED_FIELD (first, field, norm_fn, flags) \
1719 GST_URI_NORMALIZED_FIELD (second, field, norm_fn, flags) \
1720 result = g_strcmp0 (first_cmp, second_cmp); \
1721 g_free (first_norm); \
1722 first_norm = NULL; \
1723 g_free (second_norm); \
1724 second_norm = NULL; \
1725 if (result != 0) return FALSE
1727 /* compare two string values */
1728 #define GST_URI_CMP_STR(field) \
1729 if (g_strcmp0 (first->field, second->field) != 0) return FALSE
1731 /* compare two GLists, normalize lists if needed before comparison */
1732 #define GST_URI_NORMALIZED_CMP_LIST(field, norm_fn, copy_fn, cmp_fn, free_fn) \
1733 first_norm_list = g_list_copy_deep (first->field, (GCopyFunc) copy_fn, NULL); \
1734 norm_fn (&first_norm_list); \
1735 second_norm_list = g_list_copy_deep (second->field, (GCopyFunc) copy_fn, NULL); \
1736 norm_fn (&second_norm_list); \
1737 result = _gst_uri_compare_lists (first_norm_list, second_norm_list, (GCompareFunc) cmp_fn); \
1738 g_list_free_full (first_norm_list, free_fn); \
1739 g_list_free_full (second_norm_list, free_fn); \
1740 if (result != 0) return FALSE
1742 GST_URI_CMP_STR (userinfo);
1744 GST_URI_CMP_STR (fragment);
1746 GST_URI_NORMALIZED_CMP_STR (scheme, _gst_uri_normalize_scheme,
1747 _GST_URI_NORMALIZE_LOWERCASE);
1749 GST_URI_NORMALIZED_CMP_STR (host, _gst_uri_normalize_hostname,
1750 _GST_URI_NORMALIZE_LOWERCASE);
1752 GST_URI_NORMALIZED_CMP_LIST (path, _gst_uri_normalize_path, g_strdup,
1755 if (first->query == NULL && second->query != NULL)
1757 if (first->query != NULL && second->query == NULL)
1759 if (first->query != NULL) {
1760 if (g_hash_table_size (first->query) != g_hash_table_size (second->query))
1763 g_hash_table_iter_init (&table_iter, first->query);
1764 while (g_hash_table_iter_next (&table_iter, &key, &value)) {
1765 if (!g_hash_table_contains (second->query, key))
1767 result = g_strcmp0 (g_hash_table_lookup (second->query, key), value);
1772 #undef GST_URI_NORMALIZED_CMP_STR
1773 #undef GST_URI_CMP_STR
1774 #undef GST_URI_NORMALIZED_CMP_LIST
1775 #undef GST_URI_NORMALIZED_FIELD
1782 * @base_uri: (transfer none)(nullable): The base URI to join another to.
1783 * @ref_uri: (transfer none)(nullable): The reference URI to join onto the
1786 * Join a reference URI onto a base URI using the method from RFC 3986.
1787 * If either URI is %NULL then the other URI will be returned with the ref count
1790 * Returns: (transfer full): A #GstUri which represents the base with the
1791 * reference URI joined on.
1796 gst_uri_join (GstUri * base_uri, GstUri * ref_uri)
1798 const gchar *r_scheme;
1801 g_return_val_if_fail ((base_uri == NULL || GST_IS_URI (base_uri)) &&
1802 (ref_uri == NULL || GST_IS_URI (ref_uri)), NULL);
1804 if (base_uri == NULL && ref_uri == NULL)
1806 if (base_uri == NULL) {
1807 g_return_val_if_fail (GST_IS_URI (ref_uri), NULL);
1808 return gst_uri_ref (ref_uri);
1810 if (ref_uri == NULL) {
1811 g_return_val_if_fail (GST_IS_URI (base_uri), NULL);
1812 return gst_uri_ref (base_uri);
1815 g_return_val_if_fail (GST_IS_URI (base_uri) && GST_IS_URI (ref_uri), NULL);
1817 t = _gst_uri_new ();
1822 /* process according to RFC3986 */
1823 r_scheme = ref_uri->scheme;
1824 if (r_scheme != NULL && g_strcmp0 (base_uri->scheme, r_scheme) == 0) {
1827 if (r_scheme != NULL) {
1828 t->scheme = g_strdup (r_scheme);
1829 t->userinfo = g_strdup (ref_uri->userinfo);
1830 t->host = g_strdup (ref_uri->host);
1831 t->port = ref_uri->port;
1832 t->path = _remove_dot_segments (ref_uri->path);
1833 t->query = _gst_uri_copy_query_table (ref_uri->query);
1835 if (ref_uri->host != NULL) {
1836 t->userinfo = g_strdup (ref_uri->userinfo);
1837 t->host = g_strdup (ref_uri->host);
1838 t->port = ref_uri->port;
1839 t->path = _remove_dot_segments (ref_uri->path);
1840 t->query = _gst_uri_copy_query_table (ref_uri->query);
1842 if (ref_uri->path == NULL) {
1843 t->path = g_list_copy_deep (base_uri->path, (GCopyFunc) g_strdup, NULL);
1844 if (ref_uri->query != NULL)
1845 t->query = _gst_uri_copy_query_table (ref_uri->query);
1847 t->query = _gst_uri_copy_query_table (base_uri->query);
1849 if (ref_uri->path->data == NULL)
1850 t->path = _remove_dot_segments (ref_uri->path);
1852 GList *mrgd = _merge (base_uri->path, ref_uri->path);
1853 t->path = _remove_dot_segments (mrgd);
1854 g_list_free_full (mrgd, g_free);
1856 t->query = _gst_uri_copy_query_table (ref_uri->query);
1858 t->userinfo = g_strdup (base_uri->userinfo);
1859 t->host = g_strdup (base_uri->host);
1860 t->port = base_uri->port;
1862 t->scheme = g_strdup (base_uri->scheme);
1864 t->fragment = g_strdup (ref_uri->fragment);
1870 * gst_uri_join_strings:
1871 * @base_uri: The percent-encoded base URI.
1872 * @ref_uri: The percent-encoded reference URI to join to the @base_uri.
1874 * This is a convenience function to join two URI strings and return the result.
1875 * The returned string should be g_free()'d after use.
1877 * Returns: (transfer full): A string representing the percent-encoded join of
1883 gst_uri_join_strings (const gchar * base_uri, const gchar * ref_uri)
1885 GstUri *base, *result;
1888 base = gst_uri_from_string (base_uri);
1889 result = gst_uri_from_string_with_base (base, ref_uri);
1890 result_uri = gst_uri_to_string (result);
1891 gst_uri_unref (base);
1892 gst_uri_unref (result);
1898 * gst_uri_is_writable:
1899 * @uri: The #GstUri object to test.
1901 * Check if it is safe to write to this #GstUri.
1903 * Check if the refcount of @uri is exactly 1, meaning that no other
1904 * reference exists to the #GstUri and that the #GstUri is therefore writable.
1906 * Modification of a #GstUri should only be done after verifying that it is
1909 * Returns: %TRUE if it is safe to write to the object.
1914 gst_uri_is_writable (const GstUri * uri)
1916 g_return_val_if_fail (GST_IS_URI (uri), FALSE);
1917 return gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (uri));
1921 * gst_uri_make_writable:
1922 * @uri: (transfer full): The #GstUri object to make writable.
1924 * Make the #GstUri writable.
1926 * Checks if @uri is writable, and if so the original object is returned. If
1927 * not, then a writable copy is made and returned. This gives away the
1928 * reference to @uri and returns a reference to the new #GstUri.
1929 * If @uri is %NULL then %NULL is returned.
1931 * Returns: (transfer full): A writable version of @uri.
1936 gst_uri_make_writable (GstUri * uri)
1938 g_return_val_if_fail (GST_IS_URI (uri), NULL);
1940 GST_URI_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (uri)));
1944 * gst_uri_to_string:
1945 * @uri: This #GstUri to convert to a string.
1947 * Convert the URI to a string.
1949 * Returns the URI as held in this object as a gchar* %NULL terminated string.
1950 * The caller should g_free() the string once they are finished with it.
1951 * The string is put together as described in RFC 3986.
1953 * Returns: (transfer full): The string version of the URI.
1958 gst_uri_to_string (const GstUri * uri)
1963 g_return_val_if_fail (GST_IS_URI (uri), NULL);
1965 uri_str = g_string_new (NULL);
1967 if (uri->scheme != NULL)
1968 g_string_append_printf (uri_str, "%s:", uri->scheme);
1970 if (uri->userinfo != NULL || uri->host != NULL ||
1971 uri->port != GST_URI_NO_PORT)
1972 g_string_append (uri_str, "//");
1974 if (uri->userinfo != NULL) {
1975 escaped = _gst_uri_escape_userinfo (uri->userinfo);
1976 g_string_append_printf (uri_str, "%s@", escaped);
1980 if (uri->host != NULL) {
1981 if (strchr (uri->host, ':') != NULL) {
1982 escaped = _gst_uri_escape_host_colon (uri->host);
1983 g_string_append_printf (uri_str, "[%s]", escaped);
1986 escaped = _gst_uri_escape_host (uri->host);
1987 g_string_append (uri_str, escaped);
1992 if (uri->port != GST_URI_NO_PORT)
1993 g_string_append_printf (uri_str, ":%u", uri->port);
1995 if (uri->path != NULL) {
1996 escaped = gst_uri_get_path_string (uri);
1997 g_string_append (uri_str, escaped);
2002 g_string_append (uri_str, "?");
2003 escaped = gst_uri_get_query_string (uri);
2004 g_string_append (uri_str, escaped);
2008 if (uri->fragment != NULL) {
2009 escaped = _gst_uri_escape_fragment (uri->fragment);
2010 g_string_append_printf (uri_str, "#%s", escaped);
2014 return g_string_free (uri_str, FALSE);
2018 * gst_uri_is_normalized:
2019 * @uri: The #GstUri to test to see if it is normalized.
2021 * Tests the @uri to see if it is normalized. A %NULL @uri is considered to be
2024 * Returns: TRUE if the URI is normalized or is %NULL.
2029 gst_uri_is_normalized (const GstUri * uri)
2037 g_return_val_if_fail (GST_IS_URI (uri), FALSE);
2039 /* check for non-normalized characters in uri parts */
2040 if (_gst_uri_first_non_normalized_char (uri->scheme,
2041 _GST_URI_NORMALIZE_LOWERCASE) != NULL ||
2042 /*_gst_uri_first_non_normalized_char (uri->userinfo,
2043 _GST_URI_NORMALIZE_PERCENTAGES) != NULL || */
2044 _gst_uri_first_non_normalized_char (uri->host,
2045 _GST_URI_NORMALIZE_LOWERCASE /*| _GST_URI_NORMALIZE_PERCENTAGES */ )
2047 /*|| _gst_uri_first_non_normalized_char (uri->path,
2048 _GST_URI_NORMALIZE_PERCENTAGES) != NULL
2049 || _gst_uri_first_non_normalized_char (uri->query,
2050 _GST_URI_NORMALIZE_PERCENTAGES) != NULL
2051 || _gst_uri_first_non_normalized_char (uri->fragment,
2052 _GST_URI_NORMALIZE_PERCENTAGES) != NULL */ )
2055 /* also check path has had dot segments removed */
2056 new_path = _remove_dot_segments (uri->path);
2058 (_gst_uri_compare_lists (new_path, uri->path,
2059 (GCompareFunc) g_strcmp0) == 0);
2060 g_list_free_full (new_path, g_free);
2065 * gst_uri_normalize:
2066 * @uri: (transfer none): The #GstUri to normalize.
2068 * Normalization will remove extra path segments ("." and "..") from the URI. It
2069 * will also convert the scheme and host name to lower case and any
2070 * percent-encoded values to uppercase.
2072 * The #GstUri object must be writable. Check with gst_uri_is_writable() or use
2073 * gst_uri_make_writable() first.
2075 * Returns: TRUE if the URI was modified.
2080 gst_uri_normalize (GstUri * uri)
2082 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2084 return _gst_uri_normalize_scheme (uri->scheme) |
2085 _gst_uri_normalize_userinfo (uri->userinfo) |
2086 _gst_uri_normalize_hostname (uri->host) |
2087 _gst_uri_normalize_path (&uri->path) |
2088 _gst_uri_normalize_query (uri->query) |
2089 _gst_uri_normalize_fragment (uri->fragment);
2093 * gst_uri_get_scheme:
2094 * @uri: (nullable): This #GstUri object.
2096 * Get the scheme name from the URI or %NULL if it doesn't exist.
2097 * If @uri is %NULL then returns %NULL.
2099 * Returns: The scheme from the #GstUri object or %NULL.
2102 gst_uri_get_scheme (const GstUri * uri)
2104 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), NULL);
2105 return (uri ? uri->scheme : NULL);
2109 * gst_uri_set_scheme:
2110 * @uri: (transfer none)(nullable): The #GstUri to modify.
2111 * @scheme: The new scheme to set or %NULL to unset the scheme.
2113 * Set or unset the scheme for the URI.
2115 * Returns: %TRUE if the scheme was set/unset successfully.
2120 gst_uri_set_scheme (GstUri * uri, const gchar * scheme)
2123 return scheme == NULL;
2124 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2126 g_free (uri->scheme);
2127 uri->scheme = g_strdup (scheme);
2133 * gst_uri_get_userinfo:
2134 * @uri: (nullable): This #GstUri object.
2136 * Get the userinfo (usually in the form "username:password") from the URI
2137 * or %NULL if it doesn't exist. If @uri is %NULL then returns %NULL.
2139 * Returns: The userinfo from the #GstUri object or %NULL.
2144 gst_uri_get_userinfo (const GstUri * uri)
2146 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), NULL);
2147 return (uri ? uri->userinfo : NULL);
2151 * gst_uri_set_userinfo:
2152 * @uri: (transfer none)(nullable): The #GstUri to modify.
2153 * @userinfo: The new user-information string to set or %NULL to unset.
2155 * Set or unset the user information for the URI.
2157 * Returns: %TRUE if the user information was set/unset successfully.
2162 gst_uri_set_userinfo (GstUri * uri, const gchar * userinfo)
2165 return userinfo == NULL;
2166 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2168 g_free (uri->userinfo);
2169 uri->userinfo = g_strdup (userinfo);
2176 * @uri: (nullable): This #GstUri object.
2178 * Get the host name from the URI or %NULL if it doesn't exist.
2179 * If @uri is %NULL then returns %NULL.
2181 * Returns: The host name from the #GstUri object or %NULL.
2186 gst_uri_get_host (const GstUri * uri)
2188 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), NULL);
2189 return (uri ? uri->host : NULL);
2194 * @uri: (transfer none)(nullable): The #GstUri to modify.
2195 * @host: The new host string to set or %NULL to unset.
2197 * Set or unset the host for the URI.
2199 * Returns: %TRUE if the host was set/unset successfully.
2204 gst_uri_set_host (GstUri * uri, const gchar * host)
2207 return host == NULL;
2208 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2211 uri->host = g_strdup (host);
2218 * @uri: (nullable): This #GstUri object.
2220 * Get the port number from the URI or %GST_URI_NO_PORT if it doesn't exist.
2221 * If @uri is %NULL then returns %GST_URI_NO_PORT.
2223 * Returns: The port number from the #GstUri object or %GST_URI_NO_PORT.
2228 gst_uri_get_port (const GstUri * uri)
2230 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), GST_URI_NO_PORT);
2231 return (uri ? uri->port : GST_URI_NO_PORT);
2236 * @uri: (transfer none)(nullable): The #GstUri to modify.
2237 * @port: The new port number to set or %GST_URI_NO_PORT to unset.
2239 * Set or unset the port number for the URI.
2241 * Returns: %TRUE if the port number was set/unset successfully.
2246 gst_uri_set_port (GstUri * uri, guint port)
2249 return port == GST_URI_NO_PORT;
2250 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2259 * @uri: The #GstUri to get the path from.
2261 * Extract the path string from the URI object.
2263 * Returns: (transfer full): The path from the URI. Once finished with the
2264 * string should be g_free()'d.
2269 gst_uri_get_path (const GstUri * uri)
2271 GList *path_segment;
2272 const gchar *sep = "";
2277 g_return_val_if_fail (GST_IS_URI (uri), NULL);
2281 ret = g_string_new (NULL);
2283 for (path_segment = uri->path; path_segment;
2284 path_segment = path_segment->next) {
2285 g_string_append (ret, sep);
2286 if (path_segment->data) {
2287 g_string_append (ret, path_segment->data);
2292 return g_string_free (ret, FALSE);
2297 * @uri: (transfer none)(nullable): The #GstUri to modify.
2298 * @path: The new path to set with path segments separated by '/', or use %NULL
2299 * to unset the path.
2301 * Sets or unsets the path in the URI.
2303 * Returns: %TRUE if the path was set successfully.
2308 gst_uri_set_path (GstUri * uri, const gchar * path)
2311 return path == NULL;
2312 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2314 g_list_free_full (uri->path, g_free);
2315 uri->path = _gst_uri_string_to_list (path, "/", FALSE, FALSE);
2321 * gst_uri_get_path_string:
2322 * @uri: The #GstUri to get the path from.
2324 * Extract the path string from the URI object as a percent encoded URI path.
2326 * Returns: (transfer full): The path from the URI. Once finished with the
2327 * string should be g_free()'d.
2332 gst_uri_get_path_string (const GstUri * uri)
2334 GList *path_segment;
2335 const gchar *sep = "";
2341 g_return_val_if_fail (GST_IS_URI (uri), NULL);
2345 ret = g_string_new (NULL);
2347 for (path_segment = uri->path; path_segment;
2348 path_segment = path_segment->next) {
2349 g_string_append (ret, sep);
2350 if (path_segment->data) {
2351 escaped = _gst_uri_escape_path_segment (path_segment->data);
2352 g_string_append (ret, escaped);
2358 return g_string_free (ret, FALSE);
2362 * gst_uri_set_path_string:
2363 * @uri: (transfer none)(nullable): The #GstUri to modify.
2364 * @path: The new percent encoded path to set with path segments separated by
2365 * '/', or use %NULL to unset the path.
2367 * Sets or unsets the path in the URI.
2369 * Returns: %TRUE if the path was set successfully.
2374 gst_uri_set_path_string (GstUri * uri, const gchar * path)
2377 return path == NULL;
2378 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2380 g_list_free_full (uri->path, g_free);
2381 uri->path = _gst_uri_string_to_list (path, "/", FALSE, TRUE);
2386 * gst_uri_get_path_segments:
2387 * @uri: (nullable): The #GstUri to get the path from.
2389 * Get a list of path segments from the URI.
2391 * Returns: (transfer full)(element-type gchar*): A #GList of path segment
2392 * strings or %NULL if no path segments are available. Free the list
2393 * when no longer needed with g_list_free_full(list, g_free).
2398 gst_uri_get_path_segments (const GstUri * uri)
2402 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), NULL);
2405 ret = g_list_copy_deep (uri->path, (GCopyFunc) g_strdup, NULL);
2412 * gst_uri_set_path_segments:
2413 * @uri: (transfer none)(nullable): The #GstUri to modify.
2414 * @path_segments: (transfer full)(nullable)(element-type gchar*): The new
2417 * Replace the path segments list in the URI.
2419 * Returns: %TRUE if the path segments were set successfully.
2424 gst_uri_set_path_segments (GstUri * uri, GList * path_segments)
2426 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), FALSE);
2430 g_list_free_full (path_segments, g_free);
2431 return path_segments == NULL;
2434 g_return_val_if_fail (gst_uri_is_writable (uri), FALSE);
2436 g_list_free_full (uri->path, g_free);
2437 uri->path = path_segments;
2442 * gst_uri_append_path:
2443 * @uri: (transfer none)(nullable): The #GstUri to modify.
2444 * @relative_path: Relative path to append to the end of the current path.
2446 * Append a path onto the end of the path in the URI. The path is not
2447 * normalized, call #gst_uri_normalize() to normalize the path.
2449 * Returns: %TRUE if the path was appended successfully.
2454 gst_uri_append_path (GstUri * uri, const gchar * relative_path)
2456 GList *rel_path_list;
2459 return relative_path == NULL;
2460 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2465 GList *last_elem = g_list_last (uri->path);
2466 if (last_elem->data == NULL) {
2467 uri->path = g_list_delete_link (uri->path, last_elem);
2470 rel_path_list = _gst_uri_string_to_list (relative_path, "/", FALSE, FALSE);
2471 /* if path was absolute, make it relative by removing initial NULL element */
2472 if (rel_path_list && rel_path_list->data == NULL) {
2473 rel_path_list = g_list_delete_link (rel_path_list, rel_path_list);
2475 uri->path = g_list_concat (uri->path, rel_path_list);
2480 * gst_uri_append_path_segment:
2481 * @uri: (transfer none)(nullable): The #GstUri to modify.
2482 * @path_segment: The path segment string to append to the URI path.
2484 * Append a single path segment onto the end of the URI path.
2486 * Returns: %TRUE if the path was appended successfully.
2491 gst_uri_append_path_segment (GstUri * uri, const gchar * path_segment)
2494 return path_segment == NULL;
2495 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2499 /* if base path ends in a directory (i.e. last element is NULL), remove it */
2500 if (uri->path && g_list_last (uri->path)->data == NULL) {
2501 uri->path = g_list_delete_link (uri->path, g_list_last (uri->path));
2503 uri->path = g_list_append (uri->path, g_strdup (path_segment));
2508 * gst_uri_get_query_string:
2509 * @uri: (nullable): The #GstUri to get the query string from.
2511 * Get a percent encoded URI query string from the @uri.
2513 * Returns: (transfer full): A percent encoded query string. Use g_free() when
2519 gst_uri_get_query_string (const GstUri * uri)
2521 GHashTableIter iter;
2522 gpointer key, value;
2523 const gchar *sep = "";
2529 g_return_val_if_fail (GST_IS_URI (uri), NULL);
2533 ret = g_string_new (NULL);
2534 g_hash_table_iter_init (&iter, uri->query);
2535 while (g_hash_table_iter_next (&iter, &key, &value)) {
2536 g_string_append (ret, sep);
2537 escaped = _gst_uri_escape_http_query_element (key);
2538 g_string_append (ret, escaped);
2541 escaped = _gst_uri_escape_http_query_element (value);
2542 g_string_append_printf (ret, "=%s", escaped);
2548 return g_string_free (ret, FALSE);
2552 * gst_uri_set_query_string:
2553 * @uri: (transfer none)(nullable): The #GstUri to modify.
2554 * @query: The new percent encoded query string to use to populate the query
2555 * table, or use %NULL to unset the query table.
2557 * Sets or unsets the query table in the URI.
2559 * Returns: %TRUE if the query table was set successfully.
2564 gst_uri_set_query_string (GstUri * uri, const gchar * query)
2567 return query == NULL;
2569 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2572 g_hash_table_unref (uri->query);
2573 uri->query = _gst_uri_string_to_table (query, "&", "=", TRUE, TRUE);
2579 * gst_uri_get_query_table:
2580 * @uri: (nullable): The #GstUri to get the query table from.
2582 * Get the query table from the URI. Keys and values in the table are freed
2583 * with g_free when they are deleted. A value may be %NULL to indicate that
2584 * the key should appear in the query string in the URI, but does not have a
2585 * value. Free the returned #GHashTable with #g_hash_table_unref() when it is
2586 * no longer required. Modifying this hash table will modify the query in the
2589 * Returns: (transfer full)(element-type gchar* gchar*): The query hash table
2595 gst_uri_get_query_table (const GstUri * uri)
2599 g_return_val_if_fail (GST_IS_URI (uri), NULL);
2603 return g_hash_table_ref (uri->query);
2607 * gst_uri_set_query_table:
2608 * @uri: (transfer none)(nullable): The #GstUri to modify.
2609 * @query_table: (transfer none)(nullable)(element-type gchar* gchar*): The new
2610 * query table to use.
2612 * Set the query table to use in the URI. The old table is unreferenced and a
2613 * reference to the new one is used instead. A value if %NULL for @query_table
2614 * will remove the query string from the URI.
2616 * Returns: %TRUE if the new table was sucessfully used for the query table.
2621 gst_uri_set_query_table (GstUri * uri, GHashTable * query_table)
2623 GHashTable *old_table = NULL;
2626 return query_table == NULL;
2627 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2629 old_table = uri->query;
2631 uri->query = g_hash_table_ref (query_table);
2635 g_hash_table_unref (old_table);
2641 * gst_uri_set_query_value:
2642 * @uri: (transfer none)(nullable): The #GstUri to modify.
2643 * @query_key: (transfer none): The key for the query entry.
2644 * @query_value: (transfer none)(nullable): The value for the key.
2646 * This inserts or replaces a key in the query table. A @query_value of %NULL
2647 * indicates that the key has no associated value, but will still be present in
2650 * Returns: %TRUE if the query table was sucessfully updated.
2655 gst_uri_set_query_value (GstUri * uri, const gchar * query_key,
2656 const gchar * query_value)
2660 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2663 uri->query = g_hash_table_new_full (g_str_hash, g_str_equal, g_free,
2666 g_hash_table_insert (uri->query, g_strdup (query_key),
2667 g_strdup (query_value));
2673 * gst_uri_remove_query_key:
2674 * @uri: (transfer none)(nullable): The #GstUri to modify.
2675 * @query_key: The key to remove.
2677 * Remove an entry from the query table by key.
2679 * Returns: %TRUE if the key existed in the table and was removed.
2684 gst_uri_remove_query_key (GstUri * uri, const gchar * query_key)
2690 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2694 result = g_hash_table_remove (uri->query, query_key);
2695 /* if this was the last query entry, remove the query string completely */
2696 if (result && g_hash_table_size (uri->query) == 0) {
2697 g_hash_table_unref (uri->query);
2704 * gst_uri_query_has_key:
2705 * @uri: (nullable): The #GstUri to examine.
2706 * @query_key: The key to lookup.
2708 * Check if there is a query table entry for the @query_key key.
2710 * Returns: %TRUE if @query_key exists in the URI query table.
2715 gst_uri_query_has_key (const GstUri * uri, const gchar * query_key)
2719 g_return_val_if_fail (GST_IS_URI (uri), FALSE);
2723 return g_hash_table_contains (uri->query, query_key);
2727 * gst_uri_get_query_value:
2728 * @uri: (nullable): The #GstUri to examine.
2729 * @query_key: The key to lookup.
2731 * Get the value associated with the @query_key key. Will return %NULL if the
2732 * key has no value or if the key does not exist in the URI query table. Because
2733 * %NULL is returned for both missing keys and keys with no value, you should
2734 * use gst_uri_query_has_key() to determine if a key is present in the URI
2737 * Returns: The value for the given key, or %NULL if not found.
2742 gst_uri_get_query_value (const GstUri * uri, const gchar * query_key)
2746 g_return_val_if_fail (GST_IS_URI (uri), NULL);
2750 return g_hash_table_lookup (uri->query, query_key);
2754 * gst_uri_get_query_keys:
2755 * @uri: (nullable): The #GstUri to examine.
2757 * Get a list of the query keys from the URI.
2759 * Returns: (transfer container)(element-type gchar*): A list of keys from
2760 * the URI query. Free the list with g_list_free().
2765 gst_uri_get_query_keys (const GstUri * uri)
2769 g_return_val_if_fail (GST_IS_URI (uri), NULL);
2773 return g_hash_table_get_keys (uri->query);
2777 * gst_uri_get_fragment:
2778 * @uri: (nullable): This #GstUri object.
2780 * Get the fragment name from the URI or %NULL if it doesn't exist.
2781 * If @uri is %NULL then returns %NULL.
2783 * Returns: The host name from the #GstUri object or %NULL.
2788 gst_uri_get_fragment (const GstUri * uri)
2790 g_return_val_if_fail (uri == NULL || GST_IS_URI (uri), NULL);
2791 return (uri ? uri->fragment : NULL);
2795 * gst_uri_set_fragment:
2796 * @uri: (transfer none)(nullable): The #GstUri to modify.
2797 * @fragment: (nullable): The fragment string to set.
2799 * Sets the fragment string in the URI. Use a value of %NULL in @fragment to
2800 * unset the fragment string.
2802 * Returns: %TRUE if the fragment was set/unset successfully.
2807 gst_uri_set_fragment (GstUri * uri, const gchar * fragment)
2810 return fragment == NULL;
2811 g_return_val_if_fail (GST_IS_URI (uri) && gst_uri_is_writable (uri), FALSE);
2813 g_free (uri->fragment);
2814 uri->fragment = g_strdup (fragment);