You are looking at historical revision 12991 of this page. It may differ significantly from its current revision.
The uri-common library provides simple and easy-to-use parsing and manipulation procedures for URIs using common schemes.
These "common schemes" all have the following rules:
- An empty path after the hostname is considered to be identical to the root path.
- All components are to be fully URI-decoded (so no percent-encoded characters in it).
- The query argument will be in application/x-www-form-urlencoded form.
- The port is automatically determined if it is omitted and the URI scheme is known.
Constructors[procedure] (uri-common-reference string) => uri-common
[procedure] (absolute-uri-common string) => uri-common
Construct a new uri-common object, analogous to uri-reference and absolute-uri from uri-generic.
uri-generic and string representation[procedure] (uri-common->uri-generic uri-common) => uri-generic
[procedure] (uri-generic->uri-common uri-common) => uri-common
To convert between uri-generic and uri-common objects, use these procedures.[procedure] (uri-common->string uri-common 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
Predicates and Accessors
- <procedure>(uri-common? uri-common) => bool</procedure>
- <procedure>(uri-common-scheme uri-common) => symbol</procedure>
- <procedure>(uri-common-path uri-common) => list</procedure>
- <procedure>(uri-common-query uri-common) => alist</procedure>
- <procedure>(uri-common-fragment uri-common) => string</procedure>
- <procedure>(uri-common-host uri-common) => string</procedure>
- <procedure>(uri-common-port uri-common) => integer</procedure>
- <procedure>(uri-common-username uri-common) => string</procedure>
- <procedure>(uri-common-password uri-common) => string</procedure>
If a component is not defined in the given URI-common, then the corresponding accessor returns #f.
- <procedure>(update-uri-common URI-common #!key scheme path query fragment host port username password) => URI-common</procedure>
Update the specified keys in the URI-common object in a functional way (ie, it creates a new copy with the modifications).
Reference Resolution[procedure] (uri-common-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-common-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.
Query encoding and decoding
- <parameter>(form-urlencoded-separator [char-set/char/string])</parameter>
- <procedure>(form-urlencode alist #!key (separator (form-urlencoded-separator))) => string</procedure>
- <procedure>(form-urldecode string #!key (separator (form-urlencoded-separator))) => alist</procedure>
Encode or decode an alist using the encoding corresponding to the form-urlencoded media type, using the given separator character(s).
When encoding, if separator is a string, the first character will be used as the separator in the resulting querystring. If it is a char-set, it will be converted to a string and its first character will be taken. In either case, all of these characters are encoded if they occur inside the key/value pairs.
When decoding, any character in the set (or string) will be seen as a separator.
The separator defaults to the string ";&". This means that ampersands are allowed as separators, but semicolons are preferred, and generated URI string always contain semicolons as separators.
If you would like to use a different separator for output, you should parameterize all calls to procedures that return an uri-common object.
Normalization[procedure] (uri-common-normalize-case URI) => URI
URI case normalization (RFC 3986 section 188.8.131.52)[procedure] (uri-common-normalize-path-segments URI) => URI
URI path segment normalization (RFC 3986 section 184.108.40.206)
- 0.1 Initial Release
Copyright 2008-2009 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.