2023-11-11 06:07:36 +01:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
|
2003-08-31 03:00:15 +02:00
|
|
|
"http://www.w3.org/TR/html4/strict.dtd">
|
|
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
2004-06-21 08:07:58 +02:00
|
|
|
<meta name="description" content="LuaSocket: URL manipulation">
|
2023-11-11 06:07:36 +01:00
|
|
|
<meta name="keywords" content="Lua, LuaSocket, URL, Library, Link, Network, Support">
|
2004-06-21 08:07:58 +02:00
|
|
|
<title>LuaSocket: URL support</title>
|
2003-08-31 03:00:15 +02:00
|
|
|
<link rel="stylesheet" href="reference.css" type="text/css">
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<!-- header +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
|
|
|
|
|
|
<div class=header>
|
|
|
|
|
<hr>
|
|
|
|
|
<center>
|
|
|
|
|
<table summary="LuaSocket logo">
|
|
|
|
|
<tr><td align=center><a href="http://www.lua.org">
|
2004-06-21 08:07:58 +02:00
|
|
|
<img width=128 height=128 border=0 alt="LuaSocket" src="luasocket.png">
|
2003-08-31 03:00:15 +02:00
|
|
|
</a></td></tr>
|
|
|
|
|
<tr><td align=center valign=top>Network support for the Lua language
|
|
|
|
|
</td></tr>
|
|
|
|
|
</table>
|
|
|
|
|
<p class=bar>
|
2009-05-27 11:31:38 +02:00
|
|
|
<a href="index.html">home</a> ·
|
|
|
|
|
<a href="index.html#download">download</a> ·
|
2004-12-13 07:26:01 +01:00
|
|
|
<a href="installation.html">installation</a> ·
|
2003-08-31 03:00:15 +02:00
|
|
|
<a href="introduction.html">introduction</a> ·
|
2023-11-11 06:07:36 +01:00
|
|
|
<a href="reference.html">reference</a>
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
</center>
|
|
|
|
|
<hr>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- url ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
|
|
2023-11-11 06:07:36 +01:00
|
|
|
<h2 id="url">URL</h2>
|
2003-08-31 03:00:15 +02:00
|
|
|
|
|
|
|
|
<p>
|
2004-06-17 01:21:49 +02:00
|
|
|
The <tt>url</tt> namespace provides functions to parse, protect,
|
2003-08-31 03:00:15 +02:00
|
|
|
and build URLs, as well as functions to compose absolute URLs
|
2023-11-11 06:07:36 +01:00
|
|
|
from base and relative URLs, according to
|
2011-05-25 22:57:22 +02:00
|
|
|
<a href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>.
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
2023-11-11 06:07:36 +01:00
|
|
|
<p>
|
2004-06-17 01:21:49 +02:00
|
|
|
To obtain the <tt>url</tt> namespace, run:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre class=example>
|
2023-11-11 06:07:36 +01:00
|
|
|
-- loads the URL module
|
2005-02-08 11:01:01 +01:00
|
|
|
local url = require("socket.url")
|
2004-06-17 01:21:49 +02:00
|
|
|
</pre>
|
|
|
|
|
|
2003-08-31 03:00:15 +02:00
|
|
|
<p>
|
|
|
|
|
An URL is defined by the following grammar:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<blockquote>
|
|
|
|
|
<tt>
|
|
|
|
|
<url> ::= [<scheme>:][//<authority>][/<path>][;<params>][?<query>][#<fragment>]<br>
|
|
|
|
|
<authority> ::= [<userinfo>@]<host>[:<port>]<br>
|
|
|
|
|
<userinfo> ::= <user>[:<password>]<br>
|
|
|
|
|
<path> ::= {<segment>/}<segment><br>
|
|
|
|
|
</tt>
|
|
|
|
|
</blockquote>
|
|
|
|
|
|
|
|
|
|
<!-- absolute +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
|
|
2012-04-16 19:15:26 +02:00
|
|
|
<p class=name id="absolute">
|
2004-06-15 08:24:00 +02:00
|
|
|
url.<b>absolute(</b>base, relative<b>)</b>
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=description>
|
2023-11-11 06:07:36 +01:00
|
|
|
Builds an absolute URL from a base URL and a relative URL.
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=parameters>
|
2004-06-17 01:21:49 +02:00
|
|
|
<tt>Base</tt> is a string with the base URL or
|
|
|
|
|
a parsed URL table. <tt>Relative</tt> is a
|
2003-08-31 03:00:15 +02:00
|
|
|
string with the relative URL.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=return>
|
|
|
|
|
The function returns a string with the absolute URL.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=note>
|
|
|
|
|
Note: The rules that
|
|
|
|
|
govern the composition are fairly complex, and are described in detail in
|
2011-05-25 22:57:22 +02:00
|
|
|
<a href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>.
|
2004-06-15 08:24:00 +02:00
|
|
|
The example bellow should give an idea of what the rules are.
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre class=example>
|
|
|
|
|
http://a/b/c/d;p?q
|
|
|
|
|
|
|
|
|
|
+
|
|
|
|
|
|
|
|
|
|
g:h = g:h
|
|
|
|
|
g = http://a/b/c/g
|
|
|
|
|
./g = http://a/b/c/g
|
|
|
|
|
g/ = http://a/b/c/g/
|
|
|
|
|
/g = http://a/g
|
|
|
|
|
//g = http://g
|
|
|
|
|
?y = http://a/b/c/?y
|
|
|
|
|
g?y = http://a/b/c/g?y
|
|
|
|
|
#s = http://a/b/c/d;p?q#s
|
|
|
|
|
g#s = http://a/b/c/g#s
|
|
|
|
|
g?y#s = http://a/b/c/g?y#s
|
|
|
|
|
;x = http://a/b/c/;x
|
|
|
|
|
g;x = http://a/b/c/g;x
|
|
|
|
|
g;x?y#s = http://a/b/c/g;x?y#s
|
|
|
|
|
. = http://a/b/c/
|
|
|
|
|
./ = http://a/b/c/
|
|
|
|
|
.. = http://a/b/
|
|
|
|
|
../ = http://a/b/
|
|
|
|
|
../g = http://a/b/g
|
|
|
|
|
../.. = http://a/
|
|
|
|
|
../../ = http://a/
|
|
|
|
|
../../g = http://a/g
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<!-- build ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
|
|
2012-04-16 19:15:26 +02:00
|
|
|
<p class=name id="build">
|
2004-06-15 08:24:00 +02:00
|
|
|
url.<b>build(</b>parsed_url<b>)</b>
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=description>
|
2023-11-11 06:07:36 +01:00
|
|
|
Rebuilds an URL from its parts.
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=parameters>
|
|
|
|
|
<tt>Parsed_url</tt> is a table with same components returned by
|
|
|
|
|
<a href="#parse"><tt>parse</tt></a>.
|
|
|
|
|
Lower level components, if specified,
|
2023-11-11 06:07:36 +01:00
|
|
|
take precedence over high level components of the URL grammar.
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=return>
|
|
|
|
|
The function returns a string with the built URL.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<!-- build_path +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
|
|
2012-04-16 19:15:26 +02:00
|
|
|
<p class=name id="build_path">
|
2004-06-15 08:24:00 +02:00
|
|
|
url.<b>build_path(</b>segments, unsafe<b>)</b>
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=description>
|
|
|
|
|
Builds a <tt><path></tt> component from a list of
|
2023-11-11 06:07:36 +01:00
|
|
|
<tt><segment></tt> parts.
|
2003-08-31 03:00:15 +02:00
|
|
|
Before composition, any reserved characters found in a segment are escaped into
|
|
|
|
|
their protected form, so that the resulting path is a valid URL path
|
2023-11-11 06:07:36 +01:00
|
|
|
component.
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=parameters>
|
|
|
|
|
<tt>Segments</tt> is a list of strings with the <tt><segment></tt>
|
2004-01-24 03:47:24 +01:00
|
|
|
parts. If <tt>unsafe</tt> is anything but <b><tt>nil</tt></b>, reserved
|
2003-08-31 03:00:15 +02:00
|
|
|
characters are left untouched.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=return>
|
2023-11-11 06:07:36 +01:00
|
|
|
The function returns a string with the
|
|
|
|
|
built <tt><path></tt> component.
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
2004-06-15 08:24:00 +02:00
|
|
|
<!-- escape +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
|
|
|
|
|
|
<p class=name id="escape">
|
|
|
|
|
url.<b>escape(</b>content<b>)</b>
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=description>
|
|
|
|
|
Applies the URL escaping content coding to a string
|
|
|
|
|
Each byte is encoded as a percent character followed
|
2023-11-11 06:07:36 +01:00
|
|
|
by the two byte hexadecimal representation of its integer
|
2004-06-15 08:24:00 +02:00
|
|
|
value.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=parameters>
|
|
|
|
|
<tt>Content</tt> is the string to be encoded.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=result>
|
|
|
|
|
The function returns the encoded string.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre class=example>
|
|
|
|
|
-- load url module
|
2005-02-08 11:01:01 +01:00
|
|
|
url = require("socket.url")
|
2004-06-15 08:24:00 +02:00
|
|
|
|
|
|
|
|
code = url.escape("/#?;")
|
|
|
|
|
-- code = "%2f%23%3f%3b"
|
|
|
|
|
</pre>
|
|
|
|
|
|
2003-08-31 03:00:15 +02:00
|
|
|
<!-- parse ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
|
|
2012-04-16 19:15:26 +02:00
|
|
|
<p class=name id="parse">
|
2004-06-15 08:24:00 +02:00
|
|
|
url.<b>parse(</b>url, default<b>)</b>
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=description>
|
|
|
|
|
Parses an URL given as a string into a Lua table with its components.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=parameters>
|
|
|
|
|
<tt>Url</tt> is the URL to be parsed. If the <tt>default</tt> table is
|
|
|
|
|
present, it is used to store the parsed fields. Only fields present in the
|
|
|
|
|
URL are overwritten. Therefore, this table can be used to pass default
|
|
|
|
|
values for each field.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=return>
|
|
|
|
|
The function returns a table with all the URL components:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<blockquote><tt>
|
|
|
|
|
parsed_url = {<br>
|
|
|
|
|
url = <i>string</i>,<br>
|
|
|
|
|
scheme = <i>string</i>,<br>
|
|
|
|
|
authority = <i>string</i>,<br>
|
|
|
|
|
path = <i>string</i>,<br>
|
|
|
|
|
params = <i>string</i>,<br>
|
|
|
|
|
query = <i>string</i>,<br>
|
|
|
|
|
fragment = <i>string</i>,<br>
|
|
|
|
|
userinfo = <i>string</i>,<br>
|
|
|
|
|
host = <i>string</i>,<br>
|
|
|
|
|
port = <i>string</i>,<br>
|
|
|
|
|
user = <i>string</i>,<br>
|
|
|
|
|
password = <i>string</i><br>
|
|
|
|
|
}
|
|
|
|
|
</tt></blockquote>
|
|
|
|
|
|
|
|
|
|
<pre class=example>
|
2004-06-15 08:24:00 +02:00
|
|
|
-- load url module
|
2005-02-08 11:01:01 +01:00
|
|
|
url = require("socket.url")
|
2004-06-15 08:24:00 +02:00
|
|
|
|
2004-06-21 00:19:54 +02:00
|
|
|
parsed_url = url.parse("http://www.example.com/cgilua/index.lua?a=2#there")
|
2003-08-31 03:00:15 +02:00
|
|
|
-- parsed_url = {
|
|
|
|
|
-- scheme = "http",
|
2004-06-21 00:19:54 +02:00
|
|
|
-- authority = "www.example.com",
|
|
|
|
|
-- path = "/cgilua/index.lua"
|
2003-08-31 03:00:15 +02:00
|
|
|
-- query = "a=2",
|
|
|
|
|
-- fragment = "there",
|
|
|
|
|
-- host = "www.puc-rio.br",
|
|
|
|
|
-- }
|
|
|
|
|
|
2004-06-15 08:24:00 +02:00
|
|
|
parsed_url = url.parse("ftp://root:passwd@unsafe.org/pub/virus.exe;type=i")
|
2003-08-31 03:00:15 +02:00
|
|
|
-- parsed_url = {
|
|
|
|
|
-- scheme = "ftp",
|
|
|
|
|
-- authority = "root:passwd@unsafe.org",
|
|
|
|
|
-- path = "/pub/virus.exe",
|
|
|
|
|
-- params = "type=i",
|
|
|
|
|
-- userinfo = "root:passwd",
|
|
|
|
|
-- host = "unsafe.org",
|
|
|
|
|
-- user = "root",
|
|
|
|
|
-- password = "passwd",
|
|
|
|
|
-- }
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<!-- parse_path +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
|
|
2012-04-16 19:15:26 +02:00
|
|
|
<p class=name id="parse_path">
|
2004-06-15 08:24:00 +02:00
|
|
|
url.<b>parse_path(</b>path<b>)</b>
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=description>
|
2023-11-11 06:07:36 +01:00
|
|
|
Breaks a <tt><path></tt> URL component into all its
|
|
|
|
|
<tt><segment></tt> parts.
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=description>
|
|
|
|
|
<tt>Path</tt> is a string with the path to be parsed.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=return>
|
|
|
|
|
Since some characters are reserved in URLs, they must be escaped
|
|
|
|
|
whenever present in a <tt><path></tt> component. Therefore, before
|
2004-06-21 08:07:58 +02:00
|
|
|
returning a list with all the parsed segments, the function removes
|
2023-11-11 06:07:36 +01:00
|
|
|
escaping from all of them.
|
2003-08-31 03:00:15 +02:00
|
|
|
</p>
|
|
|
|
|
|
2004-02-04 15:29:11 +01:00
|
|
|
<!-- unescape +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
|
|
|
|
|
|
<p class=name id="unescape">
|
2004-06-15 08:24:00 +02:00
|
|
|
url.<b>unescape(</b>content<b>)</b>
|
2004-02-04 15:29:11 +01:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=description>
|
|
|
|
|
Removes the URL escaping content coding from a string.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=parameters>
|
|
|
|
|
<tt>Content</tt> is the string to be decoded.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class=return>
|
2023-11-11 06:07:36 +01:00
|
|
|
The function returns the decoded string.
|
2004-02-04 15:29:11 +01:00
|
|
|
</p>
|
|
|
|
|
|
2003-08-31 03:00:15 +02:00
|
|
|
<!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
|
|
|
|
|
|
|
|
|
|
<div class=footer>
|
|
|
|
|
<hr>
|
|
|
|
|
<center>
|
|
|
|
|
<p class=bar>
|
2009-05-27 11:31:38 +02:00
|
|
|
<a href="index.html">home</a> ·
|
|
|
|
|
<a href="index.html#down">download</a> ·
|
2004-12-13 07:26:01 +01:00
|
|
|
<a href="installation.html">installation</a> ·
|
2003-08-31 03:00:15 +02:00
|
|
|
<a href="introduction.html">introduction</a> ·
|
|
|
|
|
<a href="reference.html">reference</a>
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
<small>
|
|
|
|
|
Last modified by Diego Nehab on <br>
|
2006-04-20 06:27:13 +02:00
|
|
|
Thu Apr 20 00:26:05 EDT 2006
|
2003-08-31 03:00:15 +02:00
|
|
|
</small>
|
|
|
|
|
</p>
|
|
|
|
|
</center>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
