You are looking at historical revision 12925 of this page. It may differ significantly from its current revision.

uri-generic

Description

The uri-generic library contains procedures for parsing and manipulation of Uniform Resource Identifiers (RFC 3986). It is intended to conform more closely to the RFC, and uses combinator parsing and character classes rather than regular expressions.

This library should be considered to be a basis for creating scheme-specific URI parser libraries. This library only parses the generic components from an URI. Any specific library can further parse subcomponents. For this reason, encoding and decoding of percent-encoded characters is not done automatically. This should be handled by specific URI scheme implementations.

Library Procedures

Constructors

As specified in section 2.3 of RFC 3986, URI constructors automatically decode percent-encoded octets in the range of unreserved characters. This means that the following holds true:

(equal? (uri-reference "http://example.com/foo-bar")
        (uri-reference "http://example.com/foo%2Dbar"))  => #t
[procedure] (uri-reference STRING) => URI

A URI reference is either a URI or a relative reference (RFC 3986, Section 4.1). If the given string's prefix does not match the syntax of a scheme followed by a colon separator, then the given string is parsed as a relative reference.

[procedure] (absolute-uri STRING) => URI

Parses the given string as an absolute URI, in which no fragments are allowed (RFC 3986, Section 4.2)

Predicates and Accessors

If a component is not defined in the given URI, then the corresponding accessor returns #f.

Update the specified keys in the URI or URI-AUTH object in a functional way (ie, it creates a new copy with the modifications).

String and List Representations

[procedure] (uri->string URI USERINFO) => STRING

Reconstructs the given URI into a string; uses a supplied function LAMBDA USERNAME PASSWORD -> STRING to map the userinfo part of the URI

[procedure] (uri->list URI USERINFO) => LIST

Returns a list of the form (SCHEME SPECIFIC FRAGMENT); SPECIFIC is of the form (AUTHORITY PATH QUERY).

Reference Resolution

[procedure] (uri-relative-to URI URI) => URI

Constructs an absolute URI given a relative URI and a base URI (RFC 3986, Section 5.2.2)

[procedure] (uri-relative-from URI URI) => URI

Constructs a new, possibly relative, URI which represents the location of the first URI with respect to the second URI.

String encoding and decoding

[procedure] (uri-encode-string STRING [CHAR-SET]) => STRING

Returns the percent-encoded form of the given string. The optional char-set argument controls which characters should be encoded. It defaults to the complement of char-set:uri-unreserved. This is always safe, but often overly careful; it is allowed to leave certain characters unquoted depending on the context.

[procedure] (uri-decode-string STRING [CHAR-SET]) => STRING

Returns the decoded form of the given string. The optional char-set argument controls which characters should be decoded. It defaults to char-set:full.

Normalization

[procedure] (uri-normalize-case URI) => URI

URI case normalization (RFC 3986 section 6.2.2.1)

[procedure] (uri-normalize-path-segments URI) => URI

URI path segment normalization (RFC 3986 section 6.2.2.3)

Character sets

As a convenience for sub-parsers or other special-purpose URI handling code, there are a couple of character sets exported by uri-generic.

[constant] char-set:gen-delims

Generic delimiters.

 gen-delims  =  ":" / "/" / "?" / "#" / "[" / "]" / "@"
[constant] char-set:sub-delims

Sub-delimiters.

 sub-delims  =  "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
[constant] char-set:uri-reserved

The union of gen-delims and sub-delims; all reserved URI characters.

 reserved    =  gen-delims / sub-delims
[constant] char-set:uri-unreserved

All unreserved characters that are allowed in an URI.

 unreserved  =  ALPHA / DIGIT / "-" / "." / "_" / "~"

Note that this is _not_ the complement of char-set:uri-reserved! There are several characters (even printable, noncontrol characters) which are not allowed at all in an URI.

Requires

Version History

License

Based on the Haskell URI library by Graham Klyne <gk@ninebynine.org>.

Copyright 2008 Ivan Raikov, Peter Bex.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

- Neither name of the copyright holders nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND THE CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.