This module defines functions for handling URIs. It presents the same interface as the GHC Network.URI module, but is implemented using Parsec rather than a Regex library that is not available with Hugs. The internal representation of URI has been changed so that URI strings are more completely preserved when round-tripping to a URI value and back.
The current official reference for URI handling is RFC2396 , as updated by RFC 2732 .
These are being merged into RFC2396bis , a work-in-progress copy of which is available at the URI indicated. This document has been used as the primary reference for constructing the URI parser implemented here, and it is intended that there is a direct relationship between the syntax definition in that document and the parser implementation.
RFC 1808  contains a number of test cases for relative URI handling. Dan Connolly's Python module uripath.py  also contains useful details and test cases.
Some of the code has been copied from the GHC implementation, but the parser is replaced with one that performs more complete syntax checking of the URI itself, according to RFC2396bis .
|The URI type|
|nullURI :: URI|
|parseURI :: String -> Maybe URI|
NOTE: this is different from network.URI, whose parseURI function works like parseURIReference in this module.
|parseURIReference :: String -> Maybe URI|
|Parse a URI reference to a URI value. Returns Nothing if the string is not a valid URI reference. (an absolute or relative URI with optional fragment identifier).|
|parseRelativeReference :: String -> Maybe URI|
|Parse a relative URI to a URI value. Returns Nothing if the string is not a valid relative URI. (a relative URI with optional fragment identifier).|
|parseabsoluteURI :: String -> Maybe URI|
|Parse an absolute URI to a URI value. Returns Nothing if the string is not a valid absolute URI. (an absolute URI without a fragment identifier).|
|Test for strings containing various kinds of URI|
|isURI :: String -> Bool|
|Test if string contains a valid URI;|
|isURIReference :: String -> Bool|
|Test if string contains a valid URI reference|
|isRelativeReference :: String -> Bool|
|Test if string contains a valid relative URI.|
|isAbsoluteURI :: String -> Bool|
|Test if string contains a valid absolute URI.|
|isIPv6address :: String -> Bool|
|Test if string contains a valid IPv6 address|
|isIPv4address :: String -> Bool|
|Test if string contains a valid IPv4 address|
|relativeTo :: URI -> URI -> Maybe URI|
|Compute an absolute URI for a supplied URI relative to a given base.|
|nonStrictRelativeTo :: URI -> URI -> Maybe URI|
"foo" `relativeTo` "http://bar.org/" = "http://bar.org/foo" "http:foo" `nonStrictRelativeTo` "http://bar.org/" = "http://bar.org/foo"
Algorithm from RFC2396bis , section 5.2.2
|relativeFrom :: URI -> URI -> URI|
Returns a new URI which represents the ralative location of the first URI with respect to the second URI. Thus, the values supplied are expected to be absolure URIs, and the result returned may be a relative URI.
"http://example.com/Root/sub1/name2#frag" `relativeFrom` "http://example.com/Root/sub2/name2#frag" == "../sub2/name2#frag"
There is no single correct implementation of this function, but any accesptable implementation must satisfy the following:
(uabs `relativeFrom` ubase) `relativeTo` ubase == uabs
For any valid absolute URI. cf. http://lists.w3.org/Archives/Public/uri/2003Jan/0008.html http://lists.w3.org/Archives/Public/uri/2003Jan/0005.html
|Operations on URI strings|
|Support for putting strings into URI-friendly escaped format and getting them back again. This can't be done transparently in all cases, because certain characters have different meanings in different kinds of URI. The URI spec , section 2.4, indicates that all URI compenents should be escaped before they are assembled as a URI: "Once produced, a URI is always in its percent-encoded form"|
|uriToString :: (String -> String) -> URI -> ShowS|
Turn a URI into a string.
Uses a supplied function to map the userinfo part of the URI.
The Show instance for URI uses a mapping that hides any password that may be present in the URI. Use this function with argument id to preserve the password in the formatted output.
|isReserved :: Char -> Bool|
|Returns True if the character is a "reserved" character in a URI. To include a literal instance of one of these characters in a component of a URI, it must be escaped.|
|isUnreserved :: Char -> Bool|
|Returns True if the character is an "unreserved" character in a URI. These characters do not need to be escaped in a URI. The only characters allowed in a URI are either "reserved", "unreserved", or an escape sequence (% followed by two hex digits).|
|isAllowedInURI :: Char -> Bool|
|Returns True if the character is allowed in a URI.|
|isUnescapedInURI :: Char -> Bool|
|Returns True if the character is allowed unescaped in a URI.|
|escapeURIChar :: (Char -> Bool) -> Char -> String|
|Escape character if supplied predicate is not satisfied, otherwise return character as singleton string.|
|unEscapeString :: String -> String|
|Turns all instances of escaped characters in the string back into literal characters.|
|URI Normalization functions|
|normalizeCase :: String -> String|
|Case normalization; cf. RFC2396bis section 188.8.131.52 NOTE: authority case normalization is not performed|
|normalizeEscape :: String -> String|
|Encoding normalization; cf. RFC2396bis section 184.108.40.206|
|normalizePathSegments :: String -> String|
|Path segment normalization; cf. RFC2396bis section 220.127.116.11|
|escapeString :: String -> (Char -> Bool) -> String|
|reserved :: Char -> Bool|
|unreserved :: Char -> Bool|
|scheme :: URI -> String|
|authority :: URI -> String|
|path :: URI -> String|
|query :: URI -> String|
|fragment :: URI -> String|
|Produced by Haddock version 0.7|