URL
Living Standard — Last Updated 23 October 2014
- Participate:
- Send feedback to
whatwg@whatwg.org
(archives) or
file a bug
(open bugs)
- IRC: #whatwg on Freenode
- Version History:
- https://github.com/whatwg/url/commits
- @urlstandard
application/x-www-form-urlencoded
The URL standard takes the following approach towards making URLs fully interoperable:
Align RFC 3986 and RFC 3987 with contemporary implementations and obsolete them in the process. (E.g. spaces, other "illegal" code points, query encoding, equality, canonicalization, are all concepts not entirely shared, or defined.) URL parsing needs to become as solid as HTML parsing. [URI] [IRI]
Standardize on the term URL. URI and IRI are just confusing. In practice a single algorithm is used for both so keeping them distinct is not helping anyone. URL also easily wins the search result popularity contest.
Supplanting Origin of a URI [sic]. [ORIGIN]
Define URL's existing JavaScript API in full detail and add
enhancements to make it easier to work with. Add a new URL
object as well for URL manipulation without usage of HTML elements. (Useful
for JavaScript worker environments.)
As the editor learns more about the subject matter the goals might increase in scope somewhat.
All diagrams, examples, and notes in this specification are non-normative, as are all sections explicitly marked non-normative. Everything else in this specification is normative.
The key words "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in the normative parts of this specification are to be interpreted as described in RFC2119. For readability, these words do not appear in all uppercase letters in this specification. [RFC2119]
Conformance requirements phrased as algorithms or specific steps may be implemented in any manner, so long as the end result is equivalent. (In particular, the algorithms defined in this specification are intended to be easy to follow, and not intended to be performant.)
Some terms used in this specification are defined in the DOM, Encoding, IDNA, and Web IDL Standards. [DOM] [ENCODING] [IDNA] [WEBIDL]
The ASCII digits are code points in the range U+0030 to U+0039.
The ASCII hex digits are ASCII digits or are code points in the range U+0041 to U+0046 or in the range U+0061 to U+0066.
The ASCII alpha are code points in the range U+0041 to U+005A or in the range U+0061 to U+007A.
The ASCII alphanumeric are ASCII digits or ASCII alpha.
The EOF code point is a conceptual code point that signifies the end of a string or code point stream.
A parse error indicates a non-fatal mismatch between input and requirements. User agents are encouraged to expose parse errors somehow.
Within a parser algorithm that uses a pointer variable, c references the code point the pointer variable points to.
Within a string-based parser algorithm that uses a pointer variable, remaining references the substring after pointer in the string being processed.
If "mailto:username@example" is a string being
processed and pointer points to "@",
c is "@" and remaining is
"example".
A percent-encoded byte is "%", followed by
two ASCII hex digits. Sequences of
percent-encoded bytes, after
conversion to bytes, should not cause a
utf-8 decoder to run into any
errors.
To percent encode a byte into a
percent-encoded byte, return a string consisting of
"%", followed by a double-digit, uppercase, hexadecimal
representation of byte.
To percent decode a byte sequence input, run these steps:
Using anything but a utf-8 decoder when the input contains bytes outside the range 0x00 to 0x7F might be insecure and is not recommended.
Let output be an empty byte sequence.
For each byte byte in input, run these steps:
If byte is not `%`, append
byte to output.
Otherwise, if byte is `%` and the next two
bytes after byte in input are not in the ranges
0x30 to 0x39, 0x41 to 0x46, and 0x61 to 0x66, append byte to
output.
Otherwise, run these substeps:
Let bytePoint be the two bytes after byte in input, decoded, and then interpreted as hexadecimal number.
Append a byte whose value is bytePoint to output.
Skip the next two bytes in input.
Return output.
The simple encode set are all code points less than U+0020 (i.e. excluding U+0020) and all code points greater than U+007E.
The default encode set is the
simple encode set and code points U+0020,
'"',
"#",
"<",
">",
"?",
and
"`".
The password encode set is the
default encode set and code points
"/",
"@",
and
"\".
The username encode set is the
password encode set and code point
":".
To utf-8 percent encode a code point, using an encode set, run these steps:
If code point is not in encode set, return code point.
Let bytes be the result of running utf-8 encode on code point.
Percent encode each byte in bytes, and then return them concatenated, in the same order.
A host is a network address in the form of a domain or an IPv6 address.
A domain identifies a realm within a network.
An IPv6 address is a 128-bit identifier and for the purposes of this specification represented as an ordered list of eight 16-bit pieces. [IPV6]
The domain to ASCII given a domain domain, runs these steps:
Let result be the result of running Unicode ToASCII with domain_name set to domain, UseSTD3ASCIIRules set to false, processing_option set to Transitional_Processing, and VerifyDnsLength set to false.
If result is a failure value, return failure.
Return result.
The domain to Unicode given a domain domain, runs these steps:
Let result be the result of running Unicode ToUnicode with domain_name set to domain, UseSTD3ASCIIRules set to false.
Return result, ignoring any returned errors.
User agents are encouraged to report errors through a developer console.
A host must be either a
domain or "[", followed
by an IPv6 address, followed by
"]".
A domain is a valid domain if these steps return success:
Let result be the result of running Unicode ToASCII with domain_name set to domain, UseSTD3ASCIIRules set to true, processing_option set to Nontransitional_Processing, and VerifyDnsLength set to true.
If result is a failure value, return failure.
Set result to the result of running Unicode ToUnicode with domain_name set to result, UseSTD3ASCIIRules set to true.
If result contains any errors, return failure.
Return success.
Ideally we define this in terms of a sequence of code points that make up a valid domain rather than through a whack-a-mole: bug 25334.
A domain must be a string that is a valid domain.
An IPv6 address is defined in the "Text Representation of Addresses" chapter of IP Version 6 Addressing Architecture. [IPV6]
The host parser takes a string input and optionally a Unicode flag, and then runs these steps:
If input is the empty string, return failure.
If input starts with "[", run these
substeps:
If input does not end with
"]", parse error, return failure.
Return the result of
IPv6 parsing input
with its leading "[" and trailing
"]" removed.
Let domain be the result of utf-8 decode without BOM on the percent decoding of utf-8 encode on input.
Let asciiDomain be the result of running domain to ASCII on domain.
If asciiDomain is failure, return failure.
If asciiDomain contains one of
U+0000,
U+0009,
U+000A,
U+000D,
U+0020,
"#",
"%",
"/",
":",
"?",
"@",
"[",
"\",
and
"]",
return failure.
Return asciiDomain if the Unicode flag is unset, and the result of running domain to Unicode on asciiDomain otherwise.
The IPv6 parser takes a string input and then runs these steps:
Let address be a new IPv6 address with its 16-bit pieces initialized to 0.
Let piece pointer be a pointer into address's 16-bit pieces, initially zero (pointing to the first 16-bit piece), and let piece be the 16-bit piece it points to.
Let compress pointer be another pointer into address's 16-bit pieces, initially null and pointing to nothing.
Let pointer be a pointer into input, initially zero (pointing to the first code point).
If c is ":", run these substeps:
If remaining does not start with
":", parse error, return failure.
Increase pointer by two.
Increase piece pointer by one and then set compress pointer to piece pointer.
Main: While c is not the EOF code point, run these substeps:
If piece pointer is eight, parse error, return failure.
If c is ":", run these inner
substeps:
If compress pointer is not null, parse error, return failure.
Let value and length be 0.
While length is less than 4 and c is an ASCII hex digit, set value to value × 0x10 + c interpreted as hexadecimal number, and increase pointer and length by one.
Based on c:
."
If length is 0, parse error, return failure.
Decrease pointer by length.
Jump to IPv4.
:"
Increase pointer by one.
If c is the EOF code point, parse error, return failure.
Parse error, return failure.
Set piece to value.
Increase piece pointer by one.
If c is the EOF code point, jump to Finale.
IPv4: If piece pointer is greater than six, parse error, return failure.
Let dots seen be 0.
While c is not the EOF code point, run these substeps:
Let value be null.
If c is not an ASCII digit, parse error, return failure.
While c is an ASCII digit, run these subsubsteps:
Let number be c interpreted as decimal number.
If value is null, set value to number.
Otherwise, if value is 0, parse error, return failure.
Otherwise, set value to value × 10 + number.
Increase pointer by one.
If value is greater than 255, parse error, return failure.
If dots seen is less than 3 and
c is not a ".",
parse error, return failure.
Set piece to piece × 0x100 + value.
If dots seen is 1 or 3, increase piece pointer by one.
Increase pointer by one.
If dots seen is 3 and c is not the EOF code point, parse error, return failure.
Increase dots seen by one.
Finale: If compress pointer is not null, run these substeps:
Let swaps be piece pointer − compress pointer.
Set piece pointer to seven.
While piece pointer is not zero and swaps is greater than zero, swap piece with the piece at pointer compress pointer + swaps − 1, and then decrease both piece pointer and swaps by one.
Otherwise, if compress pointer is null and piece pointer is not eight, parse error, return failure.
Return address.
The host serializer takes null or a host host and then runs these steps:
If host is null, return the empty string.
If host is an
IPv6 address, return
"[", followed by the result of running the
IPv6 serializer on host,
followed by "]".
Otherwise, host is a domain, return host.
The IPv6 serializer takes an IPv6 address address and then runs these steps:
Let output be the empty string.
Let compress pointer be a pointer to the first 16-bit piece in the first longest sequences of address's 16-bit pieces that are 0.
In 0:f:0:0:f:f:0:0 it would point to
the second 0.
If there is no sequence of address's 16-bit pieces that are 0 longer than one, set compress pointer to null.
For each piece in address's pieces, run these substeps:
If compress pointer points to
piece, append "::" to
output if piece is
address's first piece and append
":" otherwise, and then run these substeps again with all
subsequent pieces in
address's pieces
that are 0 skipped or go the next step in the overall set of steps if
that leaves no pieces.
Append piece, represented as the shortest possible lowercase hexadecimal number, to output.
If piece is not
address's last piece,
append ":" to output.
Return output.
This algorithm requires the recommendation from A Recommendation for IPv6 Address Text Representation. [IPV6TEXT]
A URL is a universal identifier.
A URL consists of components, namely a scheme, scheme data, username, password, host, port, path, query, and fragment.
A URL's scheme is a string that identifies the type of URL and can be used to dispatch a URL for further processing after parsing. It is initially the empty string.
A URL's scheme data is a string holding the contents of a URL. It is initially the empty string.
A URL's scheme data will be its initial value if its scheme is a relative scheme, and otherwise will be the only component without an initial value.
A URL's username is a string identifying a user. It is initially the empty string.
A URL's password is either null or a string identifying a user's credentials. It is initially null.
A URL's host is either null or a host. It is initially null.
A URL's port is a string that identifies a networking port. It is initially the empty string.
A URL's path is a list of zero or more strings holding data, usually identifying a location in hierarchical form. It is initially the empty list.
A URL's query is either null or a string holding data. It is initially null.
A URL's fragment is either null or a string holding data that can be used for further processing on the resource the URL's other components identify. It is initially null.
A URL also has an associated relative flag. It is initially unset.
The relative flag exists as checking if a
URL's scheme is a
relative scheme can give incorrect results due to the
protocol attribute.
A URL also has an associated
object that is either null or a
Blob. It is initially null.
[FILEAPI]
At this point this is used primarily to support "blob"
URLs, but others can be added going forward, hence "object".
A relative scheme is a scheme listed in the first column of the following table. A default port is a relative scheme's optional corresponding port and is listed in the second column on the same row.
| scheme | port |
|---|---|
"ftp" | "21"
|
"file" | |
"gopher" | "70"
|
"http" | "80"
|
"https" | "443"
|
"ws" | "80"
|
"wss" | "443"
|
A URL includes credentials if either its username is not the empty string or its password is non-null.
A URL can be designated as base URL.
A base URL is useful for the URL parser when the input is potentially a relative URL.
A URL must be written as either a
relative URL or an
absolute URL, optionally followed by
"#" and a
fragment.
An absolute URL must be a
scheme, followed by
":", followed by either a
scheme-relative URL, if
scheme is a relative scheme, or
scheme data otherwise, optionally followed
by "?" and a query.
A scheme must be one
ASCII alpha, followed by zero or more of
ASCII alphanumeric, "+",
"-", and ".". A
scheme must be registered
....
The syntax of scheme data depends on the scheme and is typically defined alongside it. Standards must define scheme data within the constraints of zero or more URL units.
A relative URL must be either a
scheme-relative URL, an
absolute-path-relative URL,
or a path-relative URL that
does not start with a scheme and
":", optionally followed by a "?" and
a query.
At the point where a relative URL is parsed, a base URL must be in scope.
A scheme-relative URL must be
"//", optionally followed by
userinfo and "@",
followed by a host, optionally followed
by ":" and a port,
optionally followed by an
absolute-path-relative URL.
Userinfo must be a
username, optionally followed by a
":" and a
password.
A username must be zero or more
URL units, excluding "/",
":, "?", and "@".
A password must be zero or more
URL units, excluding "/",
"?", and "@".
A port must be zero or more ASCII digits.
An
absolute-path-relative URL
must be "/", followed by a
path-relative URL that does not
start with "/".
A path-relative URL must be zero or
more path segments separated from each
other by a "/".
A path segment must be zero or more URL units,
excluding "/" and "?".
A query must be zero or more URL units.
A fragment must be zero or more URL units.
The URL code points are ASCII alphanumeric,
"!",
"$",
"&",
"'",
"(",
")",
"*",
"+",
",",
"-",
".",
"/",
":",
";",
"=",
"?",
"@",
"_",
"~",
and code points in the ranges
U+00A0 to U+D7FF,
U+E000 to U+FDCF,
U+FDF0 to U+FFFD,
U+10000 to U+1FFFD,
U+20000 to U+2FFFD,
U+30000 to U+3FFFD,
U+40000 to U+4FFFD,
U+50000 to U+5FFFD,
U+60000 to U+6FFFD,
U+70000 to U+7FFFD,
U+80000 to U+8FFFD,
U+90000 to U+9FFFD,
U+A0000 to U+AFFFD,
U+B0000 to U+BFFFD,
U+C0000 to U+CFFFD,
U+D0000 to U+DFFFD,
U+E0000 to U+EFFFD,
U+F0000 to U+FFFFD,
U+100000 to U+10FFFD.
Code points higher than U+009F will be converted to percent-encoded bytes by the URL parser.
The URL units are URL code points and percent-encoded bytes.
Add the ability to halt on the first conformance error.
The URL parser takes a string input, optionally with a base URL base, and optionally with an encoding encoding override, and then runs these steps:
Let url be the result of running the basic URL parser on input with base, and encoding override as provided.
If url is failure, return failure.
If url's scheme is not
"blob", return url.
If url's scheme data is not in the blob URL store, return url. [FILEAPI]
Set url's object to a structured clone of the entry in the blob URL store corresponding to url's scheme data. [HTML]
Return url.
The basic URL parser takes a string input, optionally with a base URL base, optionally with an encoding encoding override, optionally with an URL url and a state override state override, and then runs these steps:
The encoding override argument is a legacy concept only relevant for
HTML. The url and state override arguments are only for
use by methods of objects implementing the URLUtils interface.
[HTML]
When the url and state override arguments are not passed the basic URL parser returns either a URL or failure. If they are passed the algorithm simply modifies the passed url and can terminate without returning anything.
If url is not given:
Set url to a new URL.
Remove any leading and trailing ASCII whitespace from input.
Let state be state override if given, or scheme start state otherwise.
If base is not given, set it to null.
If encoding override is not given, set it to utf-8.
Let buffer be the empty string.
Let the @ flag and the [] flag be unset.
Let pointer be a pointer to first code point in input.
Keep running the following state machine by switching on state. If after a run pointer points to the EOF code point, go to the next step. Otherwise, increase pointer by one and continue with the state machine.
If c is an ASCII alpha, append c, lowercased, to buffer, and set state to scheme state.
Otherwise, if state override is not given, set state to no scheme state, and decrease pointer by one.
Otherwise, parse error, terminate this algorithm.
If c is an ASCII alphanumeric,
"+", "-", or
".", append c, lowercased, to
buffer.
Otherwise, if c is ":", set
url's scheme to
buffer, buffer to the empty string,
and then run these substeps:
If state override is given, terminate this algorithm.
If url's scheme is a relative scheme, set url's relative flag.
If url's
scheme is
"file", set state to
relative state.
Otherwise, if url's relative flag is set, base is not null and base's scheme is equal to url's scheme, set state to relative or authority state.
Otherwise, if url's relative flag is set, set state to authority first slash state.
Otherwise, set state to scheme data state.
Otherwise, if state override is not given, set buffer to the empty string, state to no scheme state, and start over (from the first code point in input).
Otherwise, if c is the EOF code point, terminate this algorithm.
Otherwise, parse error, terminate this algorithm.
If c is "?", set
url's query
to the empty string and state to
query state.
Otherwise, if c is "#", set
url's fragment
to the empty string and state to
fragment state.
Otherwise, run these substeps:
If c is not the EOF code point, not a
URL code point, and not
"%", parse error.
If c is "%" and remaining does
not start with two ASCII hex digits, parse error.
If c is none of EOF code point, U+0009, U+000A, and U+000D, utf-8 percent encode c using the simple encode set, and append the result to url's scheme data.
If base is null, or base's scheme is not a relative scheme, parse error, return failure.
Due to the protocol attribute's
ability to change base's
scheme, base's
relative flag is not used here.
Otherwise, set state to relative state, and decrease pointer by one.
If c is "/" and
remaining starts with "/", set
state to authority ignore slashes state
and increase pointer by one.
Otherwise, parse error, set state to relative state and decrease pointer by one.
Set url's relative flag, set
url's scheme to
base's scheme if
url's scheme is not
"file", and then, based on c:
Set url's host to base's host, url's port to base's port, url's path to base's path, and url's query to base's query.
/"
\"
If c is "\",
parse error.
Set state to relative slash state.
?"
Set url's host to base's host, url's port to base's port, url's path to base's path, url's query to the empty string, and state to query state.
#"
Set url's host to base's host, url's port to base's port, url's path to base's path, url's query to base's query, url's fragment to the empty string, and state to fragment state.
If url's scheme is not
"file", or c is not an
ASCII alpha, or remaining does not start with either
":" or "|", or remaining
consists of one code point, or remaining's second code point is
not one of "/", "\", "?",
and "#", then set
url's host to
base's host,
url's port to
base's port,
url's path to
base's path, and then remove
url's path's last entry.
This is a (platform-independent) Windows drive letter quirk.
When found at the start of a file URL it is treated as an
absolute path rather than one relative to
base's path.
Set state to relative path state, and decrease pointer by one.
If c is either "/" or
"\", run these steps:
If c is "\",
parse error.
If url's
scheme is
"file", set state to
file host state.
Otherwise, set state to authority ignore slashes state.
Otherwise, run these steps:
If c is "/", set
state to authority second slash state.
Otherwise, parse error, set state to authority ignore slashes state, and decrease pointer by one.
If c is "/", set
state to authority ignore slashes state.
Otherwise, parse error, set state to authority ignore slashes state, and decrease pointer by one.
If c is neither "/" nor
"\", set state to
authority state, and decrease pointer by one.
Otherwise, parse error.
If c is "@", run these substeps:
If the @ flag is set,
parse error, prepend "%40" to
buffer.
Set the @ flag.
For each code point in buffer, run these substeps:
If code point is U+0009, U+000A, or U+000D, parse error, continue.
If code point is not a
URL code point and not
"%", parse error.
If code point is "%" and
remaining does not start with two
ASCII hex digits, parse error.
If code point is ":" and
url's
password is null, set
url's password
to the empty string and continue.
utf-8 percent encode code point using the default encode set and append the result to url's password if url's password is non-null, and to url's username otherwise.
Set buffer to the empty string.
Otherwise, if c is one of EOF code point,
"/", "\", "?",
and "#", decrease pointer by the
number of code points in buffer plus one, set
buffer to the empty string, and
state to host state.
Otherwise, append c to buffer.
If c is one of EOF code point,
"/", "\", "?",
and "#", decrease pointer by one,
and run these substeps:
If buffer consists of two code points, of
which the first is an ASCII alpha and the second is
either ":" or "|", set
state to relative path state.
This is a (platform-independent) Windows drive letter quirk. buffer is not reset here and instead used in the relative path state.
Otherwise, if buffer is the empty string, set state to relative path start state.
Otherwise, run these steps:
Let host be the result of host parsing buffer.
If host is failure, return failure.
Set url's host to host, buffer to the empty string, and state to relative path start state.
Otherwise, if c is U+0009, U+000A, or U+000D, parse error.
Otherwise, append c to buffer.
If c is ":" and the
[] flag is unset, run these substeps:
Let host be the result of host parsing buffer.
If host is failure, return failure.
Set url's host to host, buffer to the empty string, and state to port state.
If state override is hostname state, terminate this algorithm.
Otherwise, if c is the
EOF code point, "/",
"\", "?", or
"#", decrease pointer by one, and
run these substeps:
Let host be the result of host parsing buffer.
If host is failure, return failure.
Set url's host to host, buffer to the empty string, and state to relative path start state.
If state override is given, terminate this algorithm.
Otherwise, if c is U+0009, U+000A, or U+000D, parse error.
Otherwise, run these substeps:
If c is an ASCII digit, append c to buffer.
Otherwise, if c is one of
EOF code point, "/",
"\", "?", and
"#", or state override is given, run
these substeps:
Remove leading U+0030 code points from buffer until either the leading code point is not U+0030 or buffer is one code point.
| Input | Output |
|---|---|
"42" | "42"
|
"031" | "31"
|
"080" | "80"
|
"0000" | "0"
|
If buffer is equal to url's scheme's default port, set buffer to the empty string.
Set url's port to buffer.
If state override is given, terminate this algorithm.
Set buffer to the empty string, state to relative path start state, and decrease pointer by one.
Otherwise, if c is U+0009, U+000A, or U+000D, parse error.
Otherwise, parse error, return failure.
If c is "\",
parse error.
Set state to relative path state
and if c is neither "/" nor
"\", decrease pointer by one.
If either c is one of
EOF code point, "/", and
"\", or state override is not given and
c is one of "?" and
"#", run these substeps:
If c is "\", parse error.
If buffer, lowercased, matches any row in the first column of the following table, set buffer to the contents of the cell in the second column of the matched row:
"%2e" | "."
|
".%2e" | ".."
|
"%2e."
| |
"%2e%2e"
|
If buffer is "..", remove
url's path's last entry, if
any, and then if c is neither "/" nor
"\", append the empty string to url's
path.
Otherwise, if buffer is "." and
c is neither "/" nor "\",
append an empty string to
url's path.
Otherwise, if buffer is not
".", run these subsubsteps:
If url's scheme is
"file", url's path
is empty, buffer consists of two
code points, of which the first is an ASCII alpha,
and the second is "|", replace the second code point in
buffer with ":".
This is a (platform-independent) Windows drive letter quirk. They are beautiful, no?
Append buffer to url's path.
Set buffer to the empty string.
If c is "?", set
url's query to the empty string,
and state to query state.
If c is "#", set
url's fragment to the empty string,
and state to fragment state.
Otherwise, if c is U+0009, U+000A, or U+000D, parse error.
Otherwise, run these steps:
If c is not a
URL code point and not "%",
parse error.
If c is "%" and remaining does
not start with two ASCII hex digits, parse error.
utf-8 percent encode c using the default encode set, and append the result to buffer.
If c is the EOF code point, or
state override is not given and c
is "#", run these substeps:
If url's relative flag is unset or
url's scheme is either
"ws" or "wss", set
encoding override to utf-8.
Set buffer to the result of encoding buffer using encoding override.
For each byte in buffer run these subsubsteps:
If byte is less than 0x21, greater than 0x7E, or is one of 0x22, 0x23, 0x3C, 0x3E, and 0x60, append byte, percent encoded, to url's query.
Otherwise, append a code point whose value is byte to url's query.
Set buffer to the empty string.
If c is "#", set
url's
fragment to the empty string,
and state to fragment state.
Otherwise, if c is U+0009, U+000A, or U+000D, parse error.
Otherwise, run these substeps:
If c is not a
URL code point and not "%",
parse error.
If c is "%" and remaining does
not start with two ASCII hex digits, parse error.
Append c to buffer.
Based on c:
Do nothing.
If c is not a
URL code point and not
"%", parse error.
If c is "%" and remaining does
not start with two ASCII hex digits, parse error.
utf-8 percent encode c using the simple encode set, and append the result to url's fragment.
Return url.
To set the username given a url and username, run these steps:
Set url's username to the empty string.
For each code point in username, utf-8 percent encode it using the username encode set, and append the result to url's username.
To set the password given a url and password, run these steps:
If password is the empty string, set url's password to null.
Otherwise, run these substeps:
Set url's password to the empty string.
For each code point in password, utf-8 percent encode it using the password encode set, and append the result to url's password.
The URL serializer takes a URL url, optionally an exclude fragment flag, and then runs these steps:
Let output be url's
scheme and
":" concatenated.
If url's relative flag is set:
Append "//" to output.
If url's username is not the empty string or url's password is non-null, run these substeps:
Append url's host, serialized, to output.
If url's port
is not the empty string, append ":" concatenated with
url's port to
output.
Append "/" concatenated with the strings in
url's path
(including empty strings), separated from each other by
"/" to output.
Otherwise, if url's relative flag is unset, append url's scheme data to output.
If url's query is non-null,
append "?" concatenated with url's
query to output.
If the exclude fragment flag is unset and
url's fragment is
non-null, append "#" concatenated with
url's fragment to
output.
Return output.
See origin's definition in HTML for the necessary background information. [HTML]
A URL's origin is the origin returned by running these steps, switching on URL's scheme:
blob"
Let url be the result of parsing URL's scheme data.
If url is failure, return a new globally unique identifier. Otherwise, return url's origin.
The origin of
blob:https://whatwg.org/d0360e2f-caee-469f-9a2f-87d5b0456f6f is
the tuple
(https, whatwg.org, 443).
ftp"
gopher"
http"
https"
ws"
wss"
Return a tuple consisting of URL's scheme, its host, and its default port if its port is the empty string, and its port otherwise.
file"
Unfortunate as it is, this is left as an exercise to the reader. When in doubt, return a new globally unique identifier.
Return a new globally unique identifier.
application/x-www-form-urlencodedThe application/x-www-form-urlencoded format is a simple way to
encode name-value pairs in a byte sequence where all bytes are in the 0x00 to 0x7F range.
While this description makes
application/x-www-form-urlencoded sound dated — and really, it is — the
format is in widespread use due to its prevalence of HTML forms.
[HTML]
application/x-www-form-urlencoded parsingThe features provided by the
application/x-www-form-urlencoded parser
are mainly relevant for server-oriented implementations. A browser-based implementation
only needs what the
application/x-www-form-urlencoded string parser
requires.
The
application/x-www-form-urlencoded parser
takes a byte sequence input, optionally with an
encoding encoding override,
optionally with a use _charset_ flag, and optionally with an
isindex flag, and then runs these steps:
If encoding override is not given, set it to utf-8.
If encoding override is not utf-8 and input contains bytes whose value is greater than 0x7F, return failure.
This can only happen if input was not
generated through the serializer or
URLSearchParams.
Let sequences be the result of splitting
input on `&`.
If the isindex flag is set and the first byte sequence in
sequences does not contain a `=`, prepend
`=` to the first byte sequence in sequences.
Let pairs be an empty list of name-value pairs where both name and value hold a byte sequence.
For each byte sequence bytes in sequences, run these substeps:
If bytes is the empty byte sequence, run these substeps for the next byte sequence.
If bytes contains a `=`, then let
name be the bytes from the start of bytes up to but
excluding its first `=`, and let value be the
bytes, if any, after the first `=` up to the end of
bytes. If `=` is the first byte, then
name will be the empty byte sequence. If it is the last, then
value will be the empty byte sequence.
Otherwise, let name have the value of bytes and let value be the empty byte sequence.
Replace any `+` in name and
value with 0x20.
If use _charset_ flag is set, name is
`_charset_`, run these substeps:
Let result be the result of getting an encoding for value, decoded.
If result is not failure, unset use _charset_ flag and set encoding override to result.
Add a pair consisting of name and value to pairs.
Let output be an empty list of name-value pairs where both name and value hold a string.
For each name-value pair in pairs, append a name-value pair to output where the new name and value appended to output are the result of running encoding override's decoder on the percent decoding of the name and value from pairs, respectively.
Return output.
application/x-www-form-urlencoded serializingThe
application/x-www-form-urlencoded byte serializer
takes a byte sequence input and then runs these steps:
Let output be the empty string.
For each byte in input, depending on byte:
Append U+002B to output.
Append a code point whose value is byte to output.
Append byte, percent encoded, to output.
Return output.
The
application/x-www-form-urlencoded serializer
takes a list of name-value pairs pairs, optionally with an
encoding
encoding override, and then runs these steps:
If encoding override is not given, set it to utf-8.
Let output be the empty string.
For each pair in pairs, run these substeps:
Let outputPair be a copy of pair.
Replace outputPair's name and value with the result of running encode on them using encoding override, respectively.
Replace outputPair's name and value with their serialization.
If pair is not the first pair in pairs, append
"&" to output.
Append outputPair's name, followed by "=",
followed by outputPair's value to output.
The
application/x-www-form-urlencoded string parser
takes a string input,
utf-8 encodes it, and then
returns the result of
application/x-www-form-urlencoded parsing
it.
[Constructor(USVString url, optional USVString base = "about:blank"),
Exposed=(Window,Worker)]
interface URL {
static USVString domainToASCII(USVString domain);
static USVString domainToUnicode(USVString domain);
};
URL implements URLUtils;
[NoInterfaceObject,
Exposed=(Window,Worker)]
interface URLUtils {
stringifier attribute USVString href;
readonly attribute USVString origin;
attribute USVString protocol;
attribute USVString username;
attribute USVString password;
attribute USVString host;
attribute USVString hostname;
attribute USVString port;
attribute USVString pathname;
attribute USVString search;
attribute URLSearchParams searchParams;
attribute USVString hash;
};
[NoInterfaceObject,
Exposed=(Window,Worker)]
interface URLUtilsReadOnly {
stringifier readonly attribute USVString href;
readonly attribute USVString origin;
readonly attribute USVString protocol;
readonly attribute USVString host;
readonly attribute USVString hostname;
readonly attribute USVString port;
readonly attribute USVString pathname;
readonly attribute USVString search;
readonly attribute USVString hash;
};
Except where different objects implementing URLUtilsReadOnly are identical
to objects implementing URLUtils.
Since all members are readonly and certain members from
URLUtils are not exposed a number of potential optimizations is possible
compared to objects implementing URLUtils. These are left as an exercise to
the reader.
Specifications defining objects implementing URLUtils or
URLUtilsReadOnly must define a
get the base algorithm, which must return the
appropriate base URL for the object.
Specifications defining objects implementing URLUtils may
define update steps to make it possible for an
underlying string (such as an
attribute value)
to be updated. The update steps are passed a string
value for this purpose.
An object implementing URLUtils or URLUtilsReadOnly has an
associated input (a string),
query encoding
(an encoding),
query object
(a URLSearchParams object or null), and a
url (a URL or null).
Unless stated otherwise, query encoding is
utf-8 and
query object is null. The others follow
from the set the input algorithm.
The associated query encoding is a legacy concept only relevant for HTML. [HTML]
Specifications defining objects implementing URLUtils or
URLUtilsReadOnly must use the
set the input algorithms to set
input, url, and
query object. To
set the input given input
and optionally a url, run these steps:
Otherwise, run these substeps:
Set url to null.
If input is null, set input to the empty string.
Otherwise, run these subsubsteps:
Set input to input.
Let url be the result of running the URL parser on input with base URL being the result of running get the base and query encoding as encoding override.
If url is not failure, set url to url.
Let query be url's query if url is non-null, and the empty string otherwise.
If query object is null, set
query object to a
new URLSearchParams object
using query, and then append the
context object to
query object's list of
url objects.
Otherwise, set query object's list to the result of parsing query.
To run the pre-update steps for an object implementing
URLUtils, optionally given a value, run these steps:
If value is not given, let value be the result of serializing the associated url.
Run the update steps with value.
The
URL(url, base)
constructor, when invoked, must run these steps:
Let parsedBase be the result of running the basic URL parser on base.
If parsedBase is failure,
throw a TypeError exception.
Set parsedURL to the result of running the basic URL parser on url with parsedBase.
If parsedURL is failure,
throw a TypeError exception.
Let result be a new URL object.
Let result's get the base return parsedBase.
Run result's set the input given the empty string and parsedURL.
Return result.
To Basic URL parse a string into a URL without using a base URL, invoke the constructor with a single argument:
var input = "https://example.org/💩",
url = new URL(input)
url.pathname // "/%F0%9F%92%A9"
Alternatively you can use the base URL of a
document through
baseURI:
var input = "/💩",
url = new URL(input, document.baseURI)
url.href // "https://url.spec.whatwg.org/%F0%9F%92%A9"
URL staticsThe
domainToASCII(domain)
static method, when invoked, must run these steps:
Let asciiDomain be the result of host parsing domain.
If asciiDomain is an IPv6 address or failure, return the empty string.
Return asciiDomain.
The
domainToUnicode(domain)
static method, when invoked, must run these steps:
Let unicodeDomain be the result of host parsing domain with the Unicode flag set.
If unicodeDomain is an IPv6 address or failure, return the empty string.
Return unicodeDomain.
Add domainToUI() which follows the UA conventions for when to use the Unicode representation?
URLUtils and URLUtilsReadOnly membersThe URLUtils and URLUtilsReadOnly interfaces are
not exposed on the global object. They are meant to augment other interfaces, such as
URL.
The href attribute's getter must run
these steps:
Return the serialization of url.
The href attribute's setter must run these steps:
Let input be the given value.
If the context object is a URL object,
run these substeps:
Let parsedURL be the result of running the basic URL parser on input with base URL being the result of running get the base.
If parsedURL is failure,
throw a TypeError exception.
Run set the input given the empty string and parsedURL.
Otherwise, run these substeps:
Run the set the input algorithm for input.
Run the pre-update steps with the input.
This means that if the href attribute is set to
value that would cause the URL parser to return
failure, that value is still passed through unchanged. This is one of those unfortunate
legacy incidents.
var a = document.createElement("a"),
input = "https://test:test/" // invalid port makes the parser return failure
a.href = test
a.href === test // true
The origin attribute's getter must
run these steps:
If url is null, return the empty string.
Return the Unicode serialization of url's origin. [HTML]
It returns the Unicode rather than the ASCII serialization for
compatibility with HTML's MessageEvent feature.
[HTML]
The protocol attribute's getter
must run these steps:
The protocol attribute's setter must
run these steps:
If url is null, terminate these steps.
Basic URL parse the given value and
":" concatenated with
url as url and
scheme start state as state override.
Run the pre-update steps.
The username attribute's getter
must run these steps:
The username attribute's setter must
run these steps:
If url is null, or its relative flag is unset, terminate these steps.
Set the username given url and the given value.
Run the pre-update steps.
The password attribute's getter
must run these steps:
The password attribute's setter must
run these steps:
If url is null, or its relative flag is unset, terminate these steps.
Set the password given url and the given value.
Run the pre-update steps.
The host attribute's getter must run
these steps:
If url is null, return the empty string.
If port is the empty string, return host, serialized.
Return host,
serialized,
":", and port
concatenated.
The host attribute's setter must run these
steps:
If url is null, or its relative flag is unset, terminate these steps.
Basic URL parse the given value with url as url and host state as state override.
Run the pre-update steps.
The hostname attribute's getter
must run these steps:
If url is null, return the empty string.
Return host, serialized.
The hostname attribute's setter must
run these steps:
If url is null, or its relative flag is unset, terminate these steps.
Basic URL parse the given value with url as url and hostname state as state override.
Run the pre-update steps.
The port attribute's getter must run
these steps:
The port attribute's setter must run these steps:
If url is null, its
relative flag is unset, or its
scheme is "file",
terminate these steps.
Otherwise, Basic URL parse the given value with url as url and port state as state override.
Run the pre-update steps.
The pathname attribute's getter
must run these steps:
If url is null, return the empty string.
If the relative flag is unset, return scheme data.
Return "/" concatenated with the strings in
path (including empty strings),
separated from each other by "/".
The pathname attribute's setter must
run these steps:
If url is null, or its relative flag is unset, terminate these steps.
Empty path.
Basic URL parse the given value with url as url and relative path start state as state override.
Run the pre-update steps.
The search attribute's getter must
run these steps:
If url is null, or its query is either null or the empty string, return the empty string.
Return "?" concatenated with
query.
The search attribute's setter must run these steps:
If url is null, terminate these steps.
If the given value is the empty string, set query to null, empty query object's list, run its update steps, and terminate these steps.
Let input be the given value with a single leading
"?" removed, if any.
Set query to the empty string.
Basic URL parse input with url as url, query state as state override, and the associated query encoding as encoding override.
Set query object's list to the result of parsing input.
Run query object's update steps.
The update steps of query object are run to ensure all url objects remain synchronized.
The searchParams attribute's getter
must return the query object.
The searchParams attribute's setter must run
these steps:
Let object be the given value.
Remove the context object from query object's list of url objects.
Append the context object to object's list of url objects.
Set query object to object.
Set query to the serialization of the query object's list.
Run the pre-update steps.
The hash attribute's getter must run
these steps:
If url is null, or its fragment is either null or the empty string, return the empty string.
Return "#" concatenated with
fragment.
The hash attribute's setter must run these steps:
If url is null, or its
scheme is
"javascript", terminate these steps.
If the given value is the empty string, set fragment to null, run the pre-update steps, and terminate these steps.
Let input be the given value with a single leading
"#" removed, if any.
Set fragment to the empty string.
Basic URL parse input with url as url and fragment state as state override.
Run the pre-update steps.
URLSearchParams[Constructor(optional (USVString or URLSearchParams) init = ""),
Exposed=(Window,Worker)]
interface URLSearchParams {
void append(USVString name, USVString value);
void delete(USVString name);
USVString? get(USVString name);
sequence<USVString> getAll(USVString name);
boolean has(USVString name);
void set(USVString name, USVString value);
iterable<USVString, USVString>;
stringifier;
};
A URLSearchParams object has an associated
list of name-value pairs, which is initially
empty.
A URLSearchParams object has an associated list of zero or more
url objects, which is initially empty.
URLSearchParams objects always use
utf-8 as
encoding, despite the existence of
concepts such as
query encoding. This is to
encourage developers to migrate towards
utf-8, which they really ought to
have done a long time ago now.
To create a
new URLSearchParams object, optionally
using init, run these steps:
Let query be a new URLSearchParams object.
If init is the empty string or null, return query.
If init is a string, set query's list to the result of parsing init.
If init is a URLSearchParams object, set
query's list to a copy
of init's list.
Return query.
A URLSearchParams object's
update steps are to run these steps for
each associated url object
urlObject, in order:
Set urlObject's url's
query to the
serialization of
URLSearchParams object's
list.
Run urlObject's pre-update steps.
The
URLSearchParams(init)
constructor, when invoked, must return a
new URLSearchParams object
using init if given.
The
append(name, value)
method, when invoked, must run these steps:
Append a new name-value pair whose name is name and value is value, to list.
Run the update steps.
The
delete(name)
method, when invoked, must run these steps:
Remove all name-value pairs whose name is name from list.
Run the update steps.
The
get(name)
method, when invoked, must return the value of the first name-value pair whose name is
name in list, and null if
there is no such pair.
The
getAll(name)
method, when invoked, must return the values of all name-value pairs whose name is
name, in list,
in list order, and the empty sequence otherwise.
The
set(name, value)
method, when invoked, must run these steps:
If there are any name-value pairs whose name is name, in list, set the value of the first such name-value pair to value and remove the others.
Otherwise, append a new name-value pair whose name is name and value is value, to list.
Run the update steps.
The
has(name)
method, when invoked, must return true if there is a name-value pair whose name is
name in list, and false
otherwise.
The value pairs to iterate over are the list name-value pairs with the key being the name and the value the value.
The stringifier must return the
serialization of the
URLSearchParams object's
list.
A standard that exposes URLs, should expose the
URL as a string (by
serializing an internal
URL). A standard should not expose a
URL using a URL object. URL
objects are meant for URL manipulation. In IDL the
USVString type should be used.
The higher-level notion here is that values are to be exposed as immutable data structures.
If a standard decides to use a variant of the name "URL" for a feature it defines, it should name such a feature "url" (i.e. lowercase and with an "l" at the end). Names such as "URL", "URI", and "IRI" should not be used. However, if the name is a compound, "URL" (i.e. uppercase) is preferred, e.g. "newURL" and "oldURL".
The EventSource and
HashChangeEvent interfaces in HTML are examples of
proper naming. [HTML]
There have been a lot of people that have helped make URLs more interoperable over the years and thereby furthered the goals of this standard. Likewise many people have helped making this standard what it is today.
With that, many thanks to Adam Barth, Albert Wiersch, Alexandre Morgaut, Arkadiusz Michalski, Behnam Esfahbod, Bobby Holley, Boris Zbarsky, Brandon Ross, Dan Appelquist, Daniel Bratell, David Håsäther, David Sheets, David Singer, Erik Arvidsson, Gavin Carothers, Geoff Richards, Glenn Maynard, Henri Sivonen, Ian Hickson, James Graham, James Manger, James Ross, Joshua Bell, Kevin Grandon, Larry Masinter, Mark Davis, Marcos Cáceres, Martin Dürst, Mathias Bynens, Michael Peick, Michael™ Smith, Michel Suignard, Peter Occil, Rodney Rehm, Roy Fielding, Sam Ruby, Santiago M. Mola, Simon Pieters, Simon Sapin, Tab Atkins, Tantek Çelik, Tim Berners-Lee, Vyacheslav Matva, and 成瀬ゆい (Yui Naruse) for being awesome!
This standard is written by Anne van Kesteren (Mozilla, annevk@annevk.nl).
Per CC0, to the extent possible under law, the editor has waived all copyright and related or neighboring rights to this work.