Class Poco::URI

Library: Foundation
Package: URI
Header: Poco/URI.h

Description

A Uniform Resource Identifier, as specified in RFC 3986.

The URI class provides methods for building URIs from their parts, as well as for splitting URIs into their parts. Furthermore, the class provides methods for resolving relative URIs against base URIs.

The class automatically performs a few normalizations on all URIs and URI parts passed to it:

scheme identifiers are converted to lower case
percent-encoded characters are decoded (except for the query string and fragment string)
optionally, dot segments are removed from paths (see normalize())

Note that dealing with query strings and fragment strings requires some precautions, as, internally, query strings and fragment strings are stored in percent-encoded form, while all other parts of the URI are stored in decoded form. While parsing query strings and fragment strings from properly encoded URLs generally works, explicitly setting query strings (fragment strings) with setQuery() (setFragment()) or extracting query strings (fragment strings) with getQuery() (getFragment()) may lead to ambiguities. See the descriptions of setQuery(), setRawQuery(), getQuery(), getRawQuery(), setFragment(), setRawFragment(), getFragment() and getRawFragment() for more information.

Member Summary

Member Functions: addQueryParameter, buildPath, clear, decode, empty, encode, equals, getAuthority, getFragment, getHost, getPath, getPathAndQuery, getPathEtc, getPathSegments, getPort, getQuery, getQueryParameters, getRawFragment, getRawQuery, getScheme, getSpecifiedPort, getUserInfo, getWellKnownPort, isRelative, isWellKnownPort, mergePath, normalize, operator !=, operator =, operator ==, parse, parseAuthority, parseFragment, parseHostAndPort, parsePath, parsePathEtc, parseQuery, removeDotSegments, resolve, setAuthority, setFragment, setHost, setPath, setPathEtc, setPort, setQuery, setQueryParameters, setRawFragment, setRawQuery, setScheme, setUserInfo, swap, toString

Types Aliases

QueryParameters

using QueryParameters = std::vector < std::pair < std::string, std::string >>;

Constructors

URI

URI();

Creates an empty URI.

URI

explicit URI(
const std::string & uri
);

Parses an URI from the given string. Throws a SyntaxException if the uri is not valid.

URI

explicit URI(
const char * uri
);

Parses an URI from the given string. Throws a SyntaxException if the uri is not valid.

URI

URI(
const URI & uri
);

Copy constructor. Creates an URI from another one.

URI

URI(
URI && uri
) noexcept;

Move constructor.

URI

explicit URI(
const Path & path
);

Creates a URI from a path.

The path will be made absolute, and a file:// URI will be built from it.

URI

URI(
const std::string & scheme,
const std::string & pathEtc
);

Creates an URI from its parts.

URI

URI(
const URI & baseURI,
const std::string & relativeURI
);

Creates an URI from a base URI and a relative URI, according to the algorithm in section 5.2 of RFC 3986.

URI

URI(
    const std::string & scheme,
    const std::string & authority,
    const std::string & pathEtc
);

Creates an URI from its parts.

URI

URI(
    const std::string & scheme,
    const std::string & authority,
    const std::string & path,
    const std::string & query
);

Creates an URI from its parts.

URI

URI(
    const std::string & scheme,
    const std::string & authority,
    const std::string & path,
    const std::string & query,
    const std::string & fragment
);

Creates an URI from its parts.

Destructor

~URI

~URI();

Destroys the URI.

Member Functions

addQueryParameter

void addQueryParameter(
const std::string & param,
const std::string & val = ""
);

Adds "param=val" to the query; "param" may not be empty. If val is empty, only '=' is appended to the parameter.

In addition to regular encoding, function also encodes '&' and '=', if found in param or val.

clear

void clear();

Clears all parts of the URI.

decode

static void decode(
    const std::string & str,
    std::string & decodedStr,
    bool plusAsSpace = false
);

URI-decodes the given string by replacing percent-encoded characters with the actual character. The decoded string is appended to decodedStr.

When plusAsSpace is true, non-encoded plus signs in the query are decoded as spaces. (http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1)

empty

bool empty() const;

Returns true if the URI is empty, false otherwise.

encode

static void encode(
    const std::string & str,
    const std::string & reserved,
    std::string & encodedStr
);

URI-encodes the given string by escaping reserved and non-ASCII characters. The encoded string is appended to encodedStr.

getAuthority

std::string getAuthority() const;

Returns the authority part (userInfo, host and port) of the URI.

If the port number is a well-known port number for the given scheme (e.g., 80 for http), it is not included in the authority.

getFragment

std::string getFragment() const;

Returns the fragment part of the URI.

getHost

const std::string & getHost() const;

Returns the host part of the URI.

getPath

const std::string & getPath() const;

Returns the decoded path part of the URI.

getPathAndQuery

std::string getPathAndQuery() const;

Returns the encoded path and query parts of the URI.

getPathEtc

std::string getPathEtc() const;

Returns the encoded path, query and fragment parts of the URI.

getPathSegments

void getPathSegments(
std::vector < std::string > & segments
) const;

Places the single path segments (delimited by slashes) into the given vector.

getPort

unsigned short getPort() const;

Returns the port number part of the URI.

If no port number (0) has been specified, the well-known port number (e.g., 80 for http) for the given scheme is returned if it is known. Otherwise, 0 is returned.

getQuery

std::string getQuery() const;

Returns the decoded query part of the URI.

Note that encoded ampersand characters ('&', "%26") will be decoded, which could cause ambiguities if the query string contains multiple parameters and a parameter name or value contains an ampersand as well. In such a case it's better to use getRawQuery() or getQueryParameters().

getQueryParameters

QueryParameters getQueryParameters(
bool plusIsSpace = true
) const;

Returns the decoded query string parameters as a vector of name-value pairs.

getRawFragment

std::string getRawFragment() const;

Returns the fragment part of the URI in raw form.

getRawQuery

const std::string & getRawQuery() const;

Returns the query string in raw form, which usually means percent encoded.

getScheme

const std::string & getScheme() const;

Returns the scheme part of the URI.

getSpecifiedPort

unsigned short getSpecifiedPort() const;

Returns the port number part of the URI.

If no explicit port number has been specified, returns 0.

getUserInfo

const std::string & getUserInfo() const;

Returns the user-info part of the URI.

isRelative

bool isRelative() const;

Returns true if the URI is a relative reference, false otherwise.

A relative reference does not contain a scheme identifier. Relative references are usually resolved against an absolute base reference.

normalize

void normalize();

Normalizes the URI by removing all but leading . and .. segments from the path.

If the first path segment in a relative path contains a colon (:), such as in a Windows path containing a drive letter, a dot segment (./) is prepended in accordance with section 3.3 of RFC 3986.

operator !=

bool operator != (
const URI & uri
) const;

Returns true if both URIs are identical, false otherwise.

operator !=

bool operator != (
const std::string & uri
) const;

Parses the given URI and returns true if both URIs are identical, false otherwise.

operator =

URI & operator = (
const URI & uri
);

Assignment operator.

operator =

URI & operator = (
URI && uri
) noexcept;

Move assignment.

operator =

URI & operator = (
const std::string & uri
);

Parses and assigns an URI from the given string. Throws a SyntaxException if the uri is not valid.

operator =

URI & operator = (
const char * uri
);

Parses and assigns an URI from the given string. Throws a SyntaxException if the uri is not valid.

operator ==

bool operator == (
const URI & uri
) const;

Returns true if both URIs are identical, false otherwise.

Two URIs are identical if their scheme, authority, path, query and fragment part are identical.

operator ==

bool operator == (
const std::string & uri
) const;

Parses the given URI and returns true if both URIs are identical, false otherwise.

resolve

void resolve(
const std::string & relativeURI
);

Resolves the given relative URI against the base URI. See section 5.2 of RFC 3986 for the algorithm used.

resolve

void resolve(
const URI & relativeURI
);

Resolves the given relative URI against the base URI. See section 5.2 of RFC 3986 for the algorithm used.

setAuthority

void setAuthority(
const std::string & authority
);

Parses the given authority part for the URI and sets the user-info, host, port components accordingly.

setFragment

void setFragment(
const std::string & fragment
);

Sets the fragment part of the URI.

setHost

void setHost(
const std::string & host
);

Sets the host part of the URI.

setPath

void setPath(
const std::string & path
);

Sets the path part of the URI.

setPathEtc

void setPathEtc(
const std::string & pathEtc
);

Sets the path, query and fragment parts of the URI.

setPort

void setPort(
unsigned short port
);

Sets the port number part of the URI.

setQuery

void setQuery(
const std::string & query
);

Sets the query part of the URI.

The query string will be percent-encoded. If the query already contains percent-encoded characters, these will be double-encoded, which is probably not what's intended by the caller. Furthermore, ampersand ('&') characters in the query will not be encoded. This could lead to ambiguity issues if the query string contains multiple name-value parameters separated by ampersand, and if any name or value also contains an ampersand. In such a case, it's better to use setRawQuery() with a properly percent-encoded query string, or use addQueryParameter() or setQueryParameters(), which take care of appropriate percent encoding of parameter names and values.