Gets uri's authentication parameters, which may contain
%-encoding, depending on the flags with which uri was created.
(If uri was not created with %G_URI_FLAGS_HAS_AUTH_PARAMS then this will
be %NULL.)
Depending on the URI scheme, g_uri_parse_params() may be useful for further parsing this information.
Gets uri's fragment, which may contain %-encoding, depending on
the flags with which uri was created.
Gets uri's host. This will never have %-encoded characters,
unless it is non-UTF-8 (which can only be the case if uri was
created with %G_URI_FLAGS_NON_DNS).
If uri contained an IPv6 address literal, this value will be just
that address, without the brackets around it that are necessary in
the string form of the URI. Note that in this case there may also
be a scope ID attached to the address. Eg, fe80::1234%``em1 (or
fe80::1234%``25em1 if the string is still encoded).
Gets uri's password, which may contain %-encoding, depending on
the flags with which uri was created. (If uri was not created
with %G_URI_FLAGS_HAS_PASSWORD then this will be %NULL.)
Gets uri's path, which may contain %-encoding, depending on the
flags with which uri was created.
Gets uri's port.
Gets uri's query, which may contain %-encoding, depending on the
flags with which uri was created.
For queries consisting of a series of name=value parameters,
#GUriParamsIter or g_uri_parse_params() may be useful.
Gets uri's scheme. Note that this will always be all-lowercase,
regardless of the string or strings that uri was created from.
Gets the ‘username’ component of uri's userinfo, which may contain
%-encoding, depending on the flags with which uri was created.
If uri was not created with %G_URI_FLAGS_HAS_PASSWORD or
%G_URI_FLAGS_HAS_AUTH_PARAMS, this is the same as g_uri_get_userinfo().
Gets uri's userinfo, which may contain %-encoding, depending on
the flags with which uri was created.
Parses uri_ref according to flags and, if it is a
[relative URI][relative-absolute-uris], resolves it relative to base_uri.
If the result is not a valid absolute URI, it will be discarded, and an error
returned.
a string representing a relative or absolute URI
flags describing how to parse uri_ref
Returns a string representing uri.
This is not guaranteed to return a string which is identical to the
string that uri was parsed from. However, if the source URI was
syntactically correct (according to RFC 3986), and it was parsed
with %G_URI_FLAGS_ENCODED, then g_uri_to_string() is guaranteed to return
a string which is at least semantically equivalent to the source
URI (according to RFC 3986).
If uri might contain sensitive details, such as authentication parameters,
or private data in its query string, and the returned string is going to be
logged, then consider using g_uri_to_string_partial() to redact parts.
Returns a string representing uri, subject to the options in
flags. See g_uri_to_string() and #GUriHideFlags for more details.
flags describing what parts of uri to hide
Creates a new #GUri from the given components according to flags.
See also g_uri_build_with_user(), which allows specifying the components of the "userinfo" separately.
flags describing how to build the #GUri
the URI scheme
the userinfo component, or %NULL
the host component, or %NULL
the port, or -1
the path component
the query component, or %NULL
the fragment, or %NULL
Creates a new #GUri from the given components according to flags
(%G_URI_FLAGS_HAS_PASSWORD is added unconditionally). The flags must be
coherent with the passed values, in particular use %-encoded values with
%G_URI_FLAGS_ENCODED.
In contrast to g_uri_build(), this allows specifying the components
of the ‘userinfo’ field separately. Note that user must be non-%NULL
if either password or auth_params is non-%NULL.
flags describing how to build the #GUri
the URI scheme
the user component of the userinfo, or %NULL
the password component of the userinfo, or %NULL
the auth params of the userinfo, or %NULL
the host component, or %NULL
the port, or -1
the path component
the query component, or %NULL
the fragment, or %NULL
Escapes arbitrary data for use in a URI.
Normally all characters that are not ‘unreserved’ (i.e. ASCII
alphanumerical characters plus dash, dot, underscore and tilde) are
escaped. But if you specify characters in reserved_chars_allowed
they are not escaped. This is useful for the ‘reserved’ characters
in the URI specification, since those are allowed unescaped in some
portions of a URI.
Though technically incorrect, this will also allow escaping nul
bytes as %``00.
the unescaped input data.
a string of reserved characters that are allowed to be used, or %NULL.
Escapes a string for use in a URI.
Normally all characters that are not "unreserved" (i.e. ASCII
alphanumerical characters plus dash, dot, underscore and tilde) are
escaped. But if you specify characters in reserved_chars_allowed
they are not escaped. This is useful for the "reserved" characters
in the URI specification, since those are allowed unescaped in some
portions of a URI.
the unescaped input string.
a string of reserved characters that are allowed to be used, or %NULL.
%TRUE if the result can include UTF-8 characters.
Parses uri_string according to flags, to determine whether it is a valid
[absolute URI][relative-absolute-uris], i.e. it does not need to be resolved
relative to another URI using g_uri_parse_relative().
If it’s not a valid URI, an error is returned explaining how it’s invalid.
See g_uri_split(), and the definition of #GUriFlags, for more
information on the effect of flags.
a string containing an absolute URI
flags for parsing uri_string
Joins the given components together according to flags to create
an absolute URI string. path may not be %NULL (though it may be the empty
string).
When host is present, path must either be empty or begin with a slash (/)
character. When host is not present, path cannot begin with two slash
characters (//). See
RFC 3986, section 3.
See also g_uri_join_with_user(), which allows specifying the components of the ‘userinfo’ separately.
%G_URI_FLAGS_HAS_PASSWORD and %G_URI_FLAGS_HAS_AUTH_PARAMS are ignored if set
in flags.
flags describing how to build the URI string
the URI scheme, or %NULL
the userinfo component, or %NULL
the host component, or %NULL
the port, or -1
the path component
the query component, or %NULL
the fragment, or %NULL
Joins the given components together according to flags to create
an absolute URI string. path may not be %NULL (though it may be the empty
string).
In contrast to g_uri_join(), this allows specifying the components of the ‘userinfo’ separately. It otherwise behaves the same.
%G_URI_FLAGS_HAS_PASSWORD and %G_URI_FLAGS_HAS_AUTH_PARAMS are ignored if set
in flags.
flags describing how to build the URI string
the URI scheme, or %NULL
the user component of the userinfo, or %NULL
the password component of the userinfo, or %NULL
the auth params of the userinfo, or %NULL
the host component, or %NULL
the port, or -1
the path component
the query component, or %NULL
the fragment, or %NULL
Splits an URI list conforming to the text/uri-list mime type defined in RFC 2483 into individual URIs, discarding any comments. The URIs are not validated.
an URI list
Many URI schemes include one or more attribute/value pairs as part of the URI value. This method can be used to parse them into a hash table. When an attribute has multiple occurrences, the last value is the final returned value. If you need to handle repeated attributes differently, use #GUriParamsIter.
The params string is assumed to still be %-encoded, but the returned
values will be fully decoded. (Thus it is possible that the returned values
may contain = or separators, if the value was encoded in the input.)
Invalid %-encoding is treated as with the %G_URI_FLAGS_PARSE_RELAXED
rules for g_uri_parse(). (However, if params is the path or query string
from a #GUri that was parsed without %G_URI_FLAGS_PARSE_RELAXED and
%G_URI_FLAGS_ENCODED, then you already know that it does not contain any
invalid encoding.)
%G_URI_PARAMS_WWW_FORM is handled as documented for g_uri_params_iter_init().
If %G_URI_PARAMS_CASE_INSENSITIVE is passed to flags, attributes will be
compared case-insensitively, so a params string attr=123&Attr=456 will only
return a single attribute–value pair, Attr=456. Case will be preserved in
the returned attributes.
If params cannot be parsed (for example, it contains two separators
characters in a row), then error is set and %NULL is returned.
a %-encoded string containing attribute=value parameters
the length of params, or -1 if it is nul-terminated
the separator byte character set between parameters. (usually &, but sometimes ; or both &;). Note that this function works on bytes not characters, so it can't be used to delimit UTF-8 strings for anything but ASCII characters. You may pass an empty set, in which case no splitting will occur.
flags to modify the way the parameters are handled.
Gets the scheme portion of a URI string. RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] ```
Common schemes include file, https, svn+ssh, etc.
@param uri a valid URI.
Gets the scheme portion of a URI string. RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] ```
Common schemes include file, https, svn+ssh, etc.
Unlike g_uri_parse_scheme(), the returned scheme is normalized to all-lowercase and does not need to be freed. @param uri a valid URI.
Parses uri_ref according to flags and, if it is a
[relative URI][relative-absolute-uris], resolves it relative to
base_uri_string. If the result is not a valid absolute URI, it will be
discarded, and an error returned.
(If base_uri_string is %NULL, this just returns uri_ref, or
%NULL if uri_ref is invalid or not absolute.)
a string representing a base URI
a string representing a relative or absolute URI
flags describing how to parse uri_ref
Parses uri_ref (which can be an
[absolute or relative URI][relative-absolute-uris]) according to flags, and
returns the pieces. Any component that doesn't appear in uri_ref will be
returned as %NULL (but note that all URIs always have a path component,
though it may be the empty string).
If flags contains %G_URI_FLAGS_ENCODED, then %-encoded characters in
uri_ref will remain encoded in the output strings. (If not,
then all such characters will be decoded.) Note that decoding will
only work if the URI components are ASCII or UTF-8, so you will
need to use %G_URI_FLAGS_ENCODED if they are not.
Note that the %G_URI_FLAGS_HAS_PASSWORD and
%G_URI_FLAGS_HAS_AUTH_PARAMS flags are ignored by g_uri_split(),
since it always returns only the full userinfo; use
g_uri_split_with_user() if you want it split up.
a string containing a relative or absolute URI
flags for parsing uri_ref
Parses uri_string (which must be an [absolute URI][relative-absolute-uris])
according to flags, and returns the pieces relevant to connecting to a host.
See the documentation for g_uri_split() for more details; this is
mostly a wrapper around that function with simpler arguments.
However, it will return an error if uri_string is a relative URI,
or does not contain a hostname component.
a string containing an absolute URI
flags for parsing uri_string
Parses uri_ref (which can be an
[absolute or relative URI][relative-absolute-uris]) according to flags, and
returns the pieces. Any component that doesn't appear in uri_ref will be
returned as %NULL (but note that all URIs always have a path component,
though it may be the empty string).
See g_uri_split(), and the definition of #GUriFlags, for more
information on the effect of flags. Note that password will only
be parsed out if flags contains %G_URI_FLAGS_HAS_PASSWORD, and
auth_params will only be parsed out if flags contains
%G_URI_FLAGS_HAS_AUTH_PARAMS.
a string containing a relative or absolute URI
flags for parsing uri_ref
Unescapes a segment of an escaped string as binary data.
Note that in contrast to g_uri_unescape_string(), this does allow nul bytes to appear in the output.
If any of the characters in illegal_characters appears as an escaped
character in escaped_string, then that is an error and %NULL will be
returned. This is useful if you want to avoid for instance having a slash
being expanded in an escaped path element, which might confuse pathname
handling.
A URI-escaped string
the length (in bytes) of escaped_string to escape, or -1 if it is nul-terminated.
a string of illegal characters not to be allowed, or %NULL.
Unescapes a segment of an escaped string.
If any of the characters in illegal_characters or the NUL
character appears as an escaped character in escaped_string, then
that is an error and %NULL will be returned. This is useful if you
want to avoid for instance having a slash being expanded in an
escaped path element, which might confuse pathname handling.
Note: NUL byte is not accepted in the output, in contrast to
g_uri_unescape_bytes().
A string, may be %NULL
Pointer to end of escaped_string, may be %NULL
An optional string of illegal characters not to be allowed, may be %NULL
Unescapes a whole escaped string.
If any of the characters in illegal_characters or the NUL
character appears as an escaped character in escaped_string, then
that is an error and %NULL will be returned. This is useful if you
want to avoid for instance having a slash being expanded in an
escaped path element, which might confuse pathname handling.
an escaped string to be unescaped.
a string of illegal characters not to be allowed, or %NULL.
The #GUri type and related functions can be used to parse URIs into their components, and build valid URIs from individual components.
Note that #GUri scope is to help manipulate URIs in various applications, following RFC 3986. In particular, it doesn't intend to cover web browser needs, and doesn't implement the WHATWG URL standard. No APIs are provided to help prevent homograph attacks, so #GUri is not suitable for formatting URIs for display to the user for making security-sensitive decisions.
Relative and absolute URIs # {#relative-absolute-uris}
As defined in RFC 3986, the hierarchical nature of URIs means that they can either be ‘relative references’ (sometimes referred to as ‘relative URIs’) or ‘URIs’ (for clarity, ‘URIs’ are referred to in this documentation as ‘absolute URIs’ — although in constrast to RFC 3986, fragment identifiers are always allowed).
Relative references have one or more components of the URI missing. In particular, they have no scheme. Any other component, such as hostname, query, etc. may be missing, apart from a path, which has to be specified (but may be empty). The path may be relative, starting with
./rather than/.For example, a valid relative reference is
./path?query,/?query#fragmentor//example.com.Absolute URIs have a scheme specified. Any other components of the URI which are missing are specified as explicitly unset in the URI, rather than being resolved relative to a base URI using g_uri_parse_relative().
For example, a valid absolute URI is
file:///home/boborhttps://search.com?query=string.A #GUri instance is always an absolute URI. A string may be an absolute URI or a relative reference; see the documentation for individual functions as to what forms they accept.
Parsing URIs
The most minimalist APIs for parsing URIs are g_uri_split() and g_uri_split_with_user(). These split a URI into its component parts, and return the parts; the difference between the two is that g_uri_split() treats the ‘userinfo’ component of the URI as a single element, while g_uri_split_with_user() can (depending on the #GUriFlags you pass) treat it as containing a username, password, and authentication parameters. Alternatively, g_uri_split_network() can be used when you are only interested in the components that are needed to initiate a network connection to the service (scheme, host, and port).
g_uri_parse() is similar to g_uri_split(), but instead of returning individual strings, it returns a #GUri structure (and it requires that the URI be an absolute URI).
g_uri_resolve_relative() and g_uri_parse_relative() allow you to resolve a relative URI relative to a base URI. g_uri_resolve_relative() takes two strings and returns a string, and g_uri_parse_relative() takes a #GUri and a string and returns a #GUri.
All of the parsing functions take a #GUriFlags argument describing exactly how to parse the URI; see the documentation for that type for more details on the specific flags that you can pass. If you need to choose different flags based on the type of URI, you can use g_uri_peek_scheme() on the URI string to check the scheme first, and use that to decide what flags to parse it with.
For example, you might want to use %G_URI_PARAMS_WWW_FORM when parsing the params for a web URI, so compare the result of g_uri_peek_scheme() against
httpandhttps.Building URIs
g_uri_join() and g_uri_join_with_user() can be used to construct valid URI strings from a set of component strings. They are the inverse of g_uri_split() and g_uri_split_with_user().
Similarly, g_uri_build() and g_uri_build_with_user() can be used to construct a #GUri from a set of component strings.
As with the parsing functions, the building functions take a #GUriFlags argument. In particular, it is important to keep in mind whether the URI components you are using are already
%-encoded. If so, you must pass the %G_URI_FLAGS_ENCODED flag.file://URIsNote that Windows and Unix both define special rules for parsing
file://URIs (involving non-UTF-8 character sets on Unix, and the interpretation of path separators on Windows). #GUri does not implement these rules. Use g_filename_from_uri() and g_filename_to_uri() if you want to properly convert betweenfile://URIs and local filenames.URI Equality
Note that there is no
g_uri_equal ()function, because comparing URIs usefully requires scheme-specific knowledge that #GUri does not have. #GUri can help with normalization if you use the various encoded #GUriFlags as well as %G_URI_FLAGS_SCHEME_NORMALIZE however it is not comprehensive. For example,data:,fooanddata:;base64,Zm9vresolve to the same thing according to thedata:URI specification which GLib does not handle.