lua-url

url string utility.

Installation

luarocks install url

Encoding

str = encode_uri( str )
str = encode_form( str )
str = encode2396( str )
str = encode3986( str )

encode a string to a percent-encoded string.

• encode_uri encodes characters except ALPHA_DIGIT (a-zA-Z0-9) and !#$&'()*+,./:;=?@_~-.
  • based on ECMAScript. please see developer.mozilla.org for more details.
• encode_form encodes characters except ALPHA_DIGIT and *-._~.
  • based on https://url.spec.whatwg.org/#application-x-www-form-urlencoded-percent-encode-set
• encode2396 encodes characters except ALPHA_DIGIT and !'()*._~-.
  • based on RFC 2396.
• encode3986 encodes characters except ALPHA_DIGIT and ._~-.
  • based on RFC 3986.

Parameters

• str:string: a string.

Returns

• str:string: a encoded string.

Decoding

str, err = decode_uri( str )
str, err = decode_form( str )
str, err = decode( str )

decode a percent-encoded string.

• decode_uri decodes percent-encoded characters except #$&+,/:;=?@.
  • based on ECMAScript. please see developer.mozilla.org for more details.
• decode_form decodes all percent-encoded characters, and replaces any + characters with spaces .
• decode decodes all percent-encoded characters.

Parameters

• str:string: encoded uri string.

Returns

• str:string: decoded string on success, or nil on failure.
• err:integer: position at where the illegal character was found.

Parser

res, cur, err = parse( url [, parse_query [, init [, is_querystring]]] )

returns the table of parsed url.

Parameters

• url:string: url string.
• parse_query:boolean: parse query-string if true.
• init:integer: where to cursor start position. (default 0)
• is_querystring:boolean: url is query string. (default false)

Returns

• res:table: url info table.
• cur:number: cursor stop position.
• err:string: error character.

Example

local dump = require('dump')
local url = require('url')

local res, cur, err = url.parse(
                          'head http://user:pass@host.com:8080/p/a/t/h/?query=string&query=value#hash tail',
                          true, 5)
print(dump({
    res = res,
    cur = cur,
    err = err,
}))
--[[
{
    cur = 74,
    err = " ",
    res = {
        fragment = "hash",
        host = "host.com:8080",
        hostname = "host.com",
        password = "pass",
        path = "/p/a/t/h/",
        port = "8080",
        query = "?query=string&query=value",
        query_params = {
            query = {
                [1] = "string",
                [2] = "value"
            }
        },
        scheme = "http",
        user = "user",
        userinfo = "user:pass"
    }
}
--]]

res, cur, err = url.parse(
                    'head http://user:pass@host.com:8080/p/a/t/h/?query=string&query=value#hash tail',
                    false, 5)
print(dump({
    res = res,
    cur = cur,
    err = err,
}))
--[[
{
    cur = 74,
    err = " ",
    res = {
        fragment = "hash",
        host = "host.com:8080",
        hostname = "host.com",
        password = "pass",
        path = "/p/a/t/h/",
        port = "8080",
        query = "?query=string&query=value",
        scheme = "http",
        user = "user",
        userinfo = "user:pass"
    }
}
--]]

-- parse query
res, cur, err = url.parse('head query=string&query=value#hash tail', true, 5,
                          true)
print(dump({
    res = res,
    cur = cur,
    err = err,
}))
--[[
{
    cur = 34,
    err = " ",
    res = {
        fragment = "hash",
        query = "query=string&query=value",
        query_params = {
            query = {
                [1] = "string",
                [2] = "value"
            }
        }
    }
}
--]]