Panda3D
|
A container for a URL, e.g. More...
#include "urlSpec.h"
Public Member Functions | |
URLSpec (const string &url, bool server_name_expected=false) | |
URLSpec (const URLSpec ©) | |
const char * | c_str () const |
int | compare_to (const URLSpec &other) const |
Returns a number less than zero if this URLSpec sorts before the other one, greater than zero if it sorts after, or zero if they are equivalent. | |
bool | empty () const |
string | get_authority () const |
Returns the authority specified by the URL (this includes username, server, and/or port), or empty string if no authority is specified. | |
string | get_path () const |
Returns the path specified by the URL, or "/" if no path is specified. | |
string | get_path_and_query () const |
Returns the path (or "/" if no path is specified), followed by the query if it is specified. | |
int | get_port () const |
Returns the port number specified by the URL, or the default port if not specified. | |
string | get_port_str () const |
Returns the port specified by the URL as a string, or the empty string if no port is specified. | |
string | get_query () const |
Returns the query specified by the URL, or empty string if no query is specified. | |
string | get_scheme () const |
Returns the scheme specified by the URL, or empty string if no scheme is specified. | |
string | get_server () const |
Returns the server name specified by the URL, if any. | |
string | get_server_and_port () const |
Returns a string consisting of the server name, followed by a colon, followed by the port number. | |
const string & | get_url () const |
Returns the complete URL specification. | |
string | get_username () const |
Returns the username specified by the URL, if any. | |
bool | has_authority () const |
Returns true if the URL specifies an authority (this includes username, server, and/or port), false otherwise. | |
bool | has_path () const |
Returns true if the URL includes a path specification (that is, the particular filename on the server to retrieve), false otherwise. | |
bool | has_port () const |
Returns true if the URL specifies a port number, false otherwise. | |
bool | has_query () const |
Returns true if the URL includes a query specification, false otherwise. | |
bool | has_scheme () const |
Returns true if the URL specifies a scheme (e.g. | |
bool | has_server () const |
Returns true if the URL specifies a server name, false otherwise. | |
bool | has_username () const |
Returns true if the URL specifies a username (and/or password), false otherwise. | |
bool | input (istream &in) |
bool | is_default_port () const |
Returns true if the port number encoded in this URL is the default port number for the scheme (or if there is no port number), or false if it is a nonstandard port. | |
bool | is_ssl () const |
Returns true if the URL's scheme specifies an SSL-secured protocol such as https, or false otherwise. | |
size_t | length () const |
operator const string & () const | |
bool | operator!= (const URLSpec &other) const |
bool | operator< (const URLSpec &other) const |
void | operator= (const string &url) |
void | operator= (const URLSpec ©) |
bool | operator== (const URLSpec &other) const |
char | operator[] (int n) const |
void | output (ostream &out) const |
void | set_authority (const string &authority) |
Replaces the authority part of the URL specification. | |
void | set_path (const string &path) |
Replaces the path part of the URL specification. | |
void | set_port (const string &port) |
Replaces the port part of the URL specification. | |
void | set_port (int port) |
Replaces the port part of the URL specification, given a numeric port number. | |
void | set_query (const string &query) |
Replaces the query part of the URL specification. | |
void | set_scheme (const string &scheme) |
Replaces the scheme part of the URL specification. | |
void | set_server (const string &server) |
Replaces the server part of the URL specification. | |
void | set_server_and_port (const string &server_and_port) |
Replaces the server and port parts of the URL specification simultaneously. | |
void | set_url (const string &url, bool server_name_expected=false) |
Completely replaces the URL with the indicated string. | |
void | set_username (const string &username) |
Replaces the username part of the URL specification. | |
Static Public Member Functions | |
static int | get_default_port_for_scheme (const string &scheme) |
Returns the default port number for the indicated scheme, or 0 if there is no known default. | |
static string | quote (const string &source, const string &safe="/") |
Returns the source string with all "unsafe" characters quoted, making a string suitable for placing in a URL. | |
static string | quote_plus (const string &source, const string &safe="/") |
Behaves like quote() with the additional behavior of replacing spaces with plus signs. | |
static string | unquote (const string &source) |
Reverses the operation of quote(): converts escaped characters of the form "%xx" to their ascii equivalent. | |
static string | unquote_plus (const string &source) |
Reverses the operation of quote_plus(): converts escaped characters of the form "%xx" to their ascii equivalent, and also converts plus signs to spaces. |
A container for a URL, e.g.
"http://server:port/path".
The URLSpec object is similar to a Filename in that it contains logic to identify the various parts of a URL and return (or modify) them separately.
int URLSpec::compare_to | ( | const URLSpec & | other | ) | const [inline] |
string URLSpec::get_authority | ( | ) | const [inline] |
int URLSpec::get_default_port_for_scheme | ( | const string & | scheme | ) | [static] |
Returns the default port number for the indicated scheme, or 0 if there is no known default.
Definition at line 114 of file urlSpec.cxx.
Referenced by get_port(), and is_default_port().
string URLSpec::get_path | ( | ) | const |
Returns the path specified by the URL, or "/" if no path is specified.
Definition at line 153 of file urlSpec.cxx.
References has_path().
string URLSpec::get_path_and_query | ( | ) | const |
Returns the path (or "/" if no path is specified), followed by the query if it is specified.
Definition at line 167 of file urlSpec.cxx.
References get_query(), has_path(), and has_query().
int URLSpec::get_port | ( | ) | const |
Returns the port number specified by the URL, or the default port if not specified.
Definition at line 84 of file urlSpec.cxx.
References get_default_port_for_scheme(), get_scheme(), and has_port().
Referenced by get_server_and_port().
string URLSpec::get_port_str | ( | ) | const [inline] |
Returns the port specified by the URL as a string, or the empty string if no port is specified.
Compare this with get_port(), which returns a default port number if no port is specified.
Definition at line 211 of file urlSpec.I.
Referenced by set_server(), and set_username().
string URLSpec::get_query | ( | ) | const [inline] |
Returns the query specified by the URL, or empty string if no query is specified.
Definition at line 222 of file urlSpec.I.
Referenced by get_path_and_query().
string URLSpec::get_scheme | ( | ) | const |
Returns the scheme specified by the URL, or empty string if no scheme is specified.
Definition at line 70 of file urlSpec.cxx.
References has_scheme().
Referenced by get_port(), and is_default_port().
string URLSpec::get_server | ( | ) | const [inline] |
Returns the server name specified by the URL, if any.
Definition at line 198 of file urlSpec.I.
Referenced by get_server_and_port(), set_port(), and set_username().
string URLSpec::get_server_and_port | ( | ) | const |
Returns a string consisting of the server name, followed by a colon, followed by the port number.
If the port number is not explicitly given in the URL, this string will include the implicit port number.
Definition at line 137 of file urlSpec.cxx.
References get_port(), get_server(), and has_port().
const string & URLSpec::get_url | ( | ) | const [inline] |
string URLSpec::get_username | ( | ) | const [inline] |
Returns the username specified by the URL, if any.
This might also include a password, e.g. "username:password", although putting a password on the URL is probably a bad idea.
Definition at line 188 of file urlSpec.I.
Referenced by set_port(), set_server(), and set_server_and_port().
bool URLSpec::has_authority | ( | ) | const [inline] |
Returns true if the URL specifies an authority (this includes username, server, and/or port), false otherwise.
Definition at line 107 of file urlSpec.I.
Referenced by set_authority(), set_port(), set_server(), set_server_and_port(), set_url(), and set_username().
bool URLSpec::has_path | ( | ) | const [inline] |
Returns true if the URL includes a path specification (that is, the particular filename on the server to retrieve), false otherwise.
Definition at line 152 of file urlSpec.I.
Referenced by get_path(), get_path_and_query(), set_authority(), and set_path().
bool URLSpec::has_port | ( | ) | const [inline] |
Returns true if the URL specifies a port number, false otherwise.
Definition at line 140 of file urlSpec.I.
Referenced by get_port(), get_server_and_port(), is_default_port(), set_server(), and set_username().
bool URLSpec::has_query | ( | ) | const [inline] |
Returns true if the URL includes a query specification, false otherwise.
Definition at line 163 of file urlSpec.I.
Referenced by get_path_and_query(), and set_query().
bool URLSpec::has_scheme | ( | ) | const [inline] |
Returns true if the URL specifies a scheme (e.g.
"http:"), false otherwise.
Definition at line 95 of file urlSpec.I.
Referenced by get_scheme(), is_ssl(), set_scheme(), and set_url().
bool URLSpec::has_server | ( | ) | const [inline] |
bool URLSpec::has_username | ( | ) | const [inline] |
Returns true if the URL specifies a username (and/or password), false otherwise.
Definition at line 118 of file urlSpec.I.
Referenced by set_port(), set_server(), and set_server_and_port().
bool URLSpec::is_default_port | ( | ) | const |
Returns true if the port number encoded in this URL is the default port number for the scheme (or if there is no port number), or false if it is a nonstandard port.
Definition at line 100 of file urlSpec.cxx.
References get_default_port_for_scheme(), get_scheme(), and has_port().
bool URLSpec::is_ssl | ( | ) | const [inline] |
Returns true if the URL's scheme specifies an SSL-secured protocol such as https, or false otherwise.
Definition at line 234 of file urlSpec.I.
References has_scheme().
string URLSpec::quote | ( | const string & | source, |
const string & | safe = "/" |
||
) | [static] |
Returns the source string with all "unsafe" characters quoted, making a string suitable for placing in a URL.
Letters, digits, and the underscore, comma, period, and hyphen characters, as well as any included in the safe string, are left alone; all others are converted to hex representation.
Definition at line 656 of file urlSpec.cxx.
string URLSpec::quote_plus | ( | const string & | source, |
const string & | safe = "/" |
||
) | [static] |
Behaves like quote() with the additional behavior of replacing spaces with plus signs.
Definition at line 697 of file urlSpec.cxx.
void URLSpec::set_authority | ( | const string & | authority | ) |
Replaces the authority part of the URL specification.
This includes the username, server, and port.
Definition at line 254 of file urlSpec.cxx.
References has_authority(), and has_path().
Referenced by set_port(), set_server(), set_server_and_port(), and set_username().
void URLSpec::set_path | ( | const string & | path | ) |
Replaces the path part of the URL specification.
Definition at line 416 of file urlSpec.cxx.
References has_path().
void URLSpec::set_port | ( | const string & | port | ) |
Replaces the port part of the URL specification.
Definition at line 356 of file urlSpec.cxx.
References get_server(), get_username(), has_authority(), has_username(), and set_authority().
Referenced by set_port().
void URLSpec::set_port | ( | int | port | ) |
Replaces the port part of the URL specification, given a numeric port number.
Definition at line 382 of file urlSpec.cxx.
References set_port().
void URLSpec::set_query | ( | const string & | query | ) |
Replaces the query part of the URL specification.
Definition at line 462 of file urlSpec.cxx.
References has_query().
void URLSpec::set_scheme | ( | const string & | scheme | ) |
Replaces the scheme part of the URL specification.
Definition at line 183 of file urlSpec.cxx.
References has_scheme().
void URLSpec::set_server | ( | const string & | server | ) |
Replaces the server part of the URL specification.
Definition at line 332 of file urlSpec.cxx.
References get_port_str(), get_username(), has_authority(), has_port(), has_username(), and set_authority().
void URLSpec::set_server_and_port | ( | const string & | server_and_port | ) |
Replaces the server and port parts of the URL specification simultaneously.
The input string should be of the form "server:port", or just "server" to make the port number implicit.
Definition at line 397 of file urlSpec.cxx.
References get_username(), has_authority(), has_username(), and set_authority().
void URLSpec::set_url | ( | const string & | url, |
bool | server_name_expected = false |
||
) |
Completely replaces the URL with the indicated string.
If server_name_expected is true, it is a hint that an undecorated URL is probably a server name, not a local filename.
Definition at line 493 of file urlSpec.cxx.
References has_authority(), and has_scheme().
void URLSpec::set_username | ( | const string & | username | ) |
Replaces the username part of the URL specification.
Definition at line 308 of file urlSpec.cxx.
References get_port_str(), get_server(), has_authority(), has_port(), and set_authority().
string URLSpec::unquote | ( | const string & | source | ) | [static] |
Reverses the operation of quote(): converts escaped characters of the form "%xx" to their ascii equivalent.
Definition at line 743 of file urlSpec.cxx.
string URLSpec::unquote_plus | ( | const string & | source | ) | [static] |
Reverses the operation of quote_plus(): converts escaped characters of the form "%xx" to their ascii equivalent, and also converts plus signs to spaces.
Definition at line 781 of file urlSpec.cxx.