Blame src/http.lua.noglobal

Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
-- HTTP/1.1 client support for the Lua language.
Packit cbb7bf
-- LuaSocket toolkit.
Packit cbb7bf
-- Author: Diego Nehab
Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
-- Declare module and import dependencies
Packit cbb7bf
-------------------------------------------------------------------------------
Packit cbb7bf
local socket = require("socket")
Packit cbb7bf
local url = require("socket.url")
Packit cbb7bf
local ltn12 = require("ltn12")
Packit cbb7bf
local mime = require("mime")
Packit cbb7bf
local string = require("string")
Packit cbb7bf
local headers = require("socket.headers")
Packit cbb7bf
local base = _G
Packit cbb7bf
local table = require("table")
Packit cbb7bf
socket.http = {}
Packit cbb7bf
local _M = socket.http
Packit cbb7bf
Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
-- Program constants
Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
-- connection timeout in seconds
Packit cbb7bf
TIMEOUT = 60
Packit cbb7bf
-- default port for document retrieval
Packit cbb7bf
_M.PORT = 80
Packit cbb7bf
-- user agent field sent in request
Packit cbb7bf
_M.USERAGENT = socket._VERSION
Packit cbb7bf
Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
-- Reads MIME headers from a connection, unfolding where needed
Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
local function receiveheaders(sock, headers)
Packit cbb7bf
    local line, name, value, err
Packit cbb7bf
    headers = headers or {}
Packit cbb7bf
    -- get first line
Packit cbb7bf
    line, err = sock:receive()
Packit cbb7bf
    if err then return nil, err end
Packit cbb7bf
    -- headers go until a blank line is found
Packit cbb7bf
    while line ~= "" do
Packit cbb7bf
        -- get field-name and value
Packit cbb7bf
        name, value = socket.skip(2, string.find(line, "^(.-):%s*(.*)"))
Packit cbb7bf
        if not (name and value) then return nil, "malformed reponse headers" end
Packit cbb7bf
        name = string.lower(name)
Packit cbb7bf
        -- get next line (value might be folded)
Packit cbb7bf
        line, err  = sock:receive()
Packit cbb7bf
        if err then return nil, err end
Packit cbb7bf
        -- unfold any folded values
Packit cbb7bf
        while string.find(line, "^%s") do
Packit cbb7bf
            value = value .. line
Packit cbb7bf
            line = sock:receive()
Packit cbb7bf
            if err then return nil, err end
Packit cbb7bf
        end
Packit cbb7bf
        -- save pair in table
Packit cbb7bf
        if headers[name] then headers[name] = headers[name] .. ", " .. value
Packit cbb7bf
        else headers[name] = value end
Packit cbb7bf
    end
Packit cbb7bf
    return headers
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
-- Extra sources and sinks
Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
socket.sourcet["http-chunked"] = function(sock, headers)
Packit cbb7bf
    return base.setmetatable({
Packit cbb7bf
        getfd = function() return sock:getfd() end,
Packit cbb7bf
        dirty = function() return sock:dirty() end
Packit cbb7bf
    }, {
Packit cbb7bf
        __call = function()
Packit cbb7bf
            -- get chunk size, skip extention
Packit cbb7bf
            local line, err = sock:receive()
Packit cbb7bf
            if err then return nil, err end
Packit cbb7bf
            local size = base.tonumber(string.gsub(line, ";.*", ""), 16)
Packit cbb7bf
            if not size then return nil, "invalid chunk size" end
Packit cbb7bf
            -- was it the last chunk?
Packit cbb7bf
            if size > 0 then
Packit cbb7bf
                -- if not, get chunk and skip terminating CRLF
Packit cbb7bf
                local chunk, err, part = sock:receive(size)
Packit cbb7bf
                if chunk then sock:receive() end
Packit cbb7bf
                return chunk, err
Packit cbb7bf
            else
Packit cbb7bf
                -- if it was, read trailers into headers table
Packit cbb7bf
                headers, err = receiveheaders(sock, headers)
Packit cbb7bf
                if not headers then return nil, err end
Packit cbb7bf
            end
Packit cbb7bf
        end
Packit cbb7bf
    })
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
socket.sinkt["http-chunked"] = function(sock)
Packit cbb7bf
    return base.setmetatable({
Packit cbb7bf
        getfd = function() return sock:getfd() end,
Packit cbb7bf
        dirty = function() return sock:dirty() end
Packit cbb7bf
    }, {
Packit cbb7bf
        __call = function(self, chunk, err)
Packit cbb7bf
            if not chunk then return sock:send("0\r\n\r\n") end
Packit cbb7bf
            local size = string.format("%X\r\n", string.len(chunk))
Packit cbb7bf
            return sock:send(size ..  chunk .. "\r\n")
Packit cbb7bf
        end
Packit cbb7bf
    })
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
-- Low level HTTP API
Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
local metat = { __index = {} }
Packit cbb7bf
Packit cbb7bf
function _M.open(host, port, create)
Packit cbb7bf
    -- create socket with user connect function, or with default
Packit cbb7bf
    local c = socket.try((create or socket.tcp)())
Packit cbb7bf
    local h = base.setmetatable({ c = c }, metat)
Packit cbb7bf
    -- create finalized try
Packit cbb7bf
    h.try = socket.newtry(function() h:close() end)
Packit cbb7bf
    -- set timeout before connecting
Packit cbb7bf
    h.try(c:settimeout(_M.TIMEOUT))
Packit cbb7bf
    h.try(c:connect(host, port or _M.PORT))
Packit cbb7bf
    -- here everything worked
Packit cbb7bf
    return h
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
function metat.__index:sendrequestline(method, uri)
Packit cbb7bf
    local reqline = string.format("%s %s HTTP/1.1\r\n", method or "GET", uri)
Packit cbb7bf
    return self.try(self.c:send(reqline))
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
function metat.__index:sendheaders(tosend)
Packit cbb7bf
    local canonic = headers.canonic
Packit cbb7bf
    local h = "\r\n"
Packit cbb7bf
    for f, v in base.pairs(tosend) do
Packit cbb7bf
        h = (canonic[f] or f) .. ": " .. v .. "\r\n" .. h
Packit cbb7bf
    end
Packit cbb7bf
    self.try(self.c:send(h))
Packit cbb7bf
    return 1
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
function metat.__index:sendbody(headers, source, step)
Packit cbb7bf
    source = source or ltn12.source.empty()
Packit cbb7bf
    step = step or ltn12.pump.step
Packit cbb7bf
    -- if we don't know the size in advance, send chunked and hope for the best
Packit cbb7bf
    local mode = "http-chunked"
Packit cbb7bf
    if headers["content-length"] then mode = "keep-open" end
Packit cbb7bf
    return self.try(ltn12.pump.all(source, socket.sink(mode, self.c), step))
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
function metat.__index:receivestatusline()
Packit cbb7bf
    local status = self.try(self.c:receive(5))
Packit cbb7bf
    -- identify HTTP/0.9 responses, which do not contain a status line
Packit cbb7bf
    -- this is just a heuristic, but is what the RFC recommends
Packit cbb7bf
    if status ~= "HTTP/" then return nil, status end
Packit cbb7bf
    -- otherwise proceed reading a status line
Packit cbb7bf
    status = self.try(self.c:receive("*l", status))
Packit cbb7bf
    local code = socket.skip(2, string.find(status, "HTTP/%d*%.%d* (%d%d%d)"))
Packit cbb7bf
    return self.try(base.tonumber(code), status)
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
function metat.__index:receiveheaders()
Packit cbb7bf
    return self.try(receiveheaders(self.c))
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
function metat.__index:receivebody(headers, sink, step)
Packit cbb7bf
    sink = sink or ltn12.sink.null()
Packit cbb7bf
    step = step or ltn12.pump.step
Packit cbb7bf
    local length = base.tonumber(headers["content-length"])
Packit cbb7bf
    local t = headers["transfer-encoding"] -- shortcut
Packit cbb7bf
    local mode = "default" -- connection close
Packit cbb7bf
    if t and t ~= "identity" then mode = "http-chunked"
Packit cbb7bf
    elseif base.tonumber(headers["content-length"]) then mode = "by-length" end
Packit cbb7bf
    return self.try(ltn12.pump.all(socket.source(mode, self.c, length),
Packit cbb7bf
        sink, step))
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
function metat.__index:receive09body(status, sink, step)
Packit cbb7bf
    local source = ltn12.source.rewind(socket.source("until-closed", self.c))
Packit cbb7bf
    source(status)
Packit cbb7bf
    return self.try(ltn12.pump.all(source, sink, step))
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
function metat.__index:close()
Packit cbb7bf
    return self.c:close()
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
-- High level HTTP API
Packit cbb7bf
-----------------------------------------------------------------------------
Packit cbb7bf
local function adjusturi(reqt)
Packit cbb7bf
    local u = reqt
Packit cbb7bf
    -- if there is a proxy, we need the full url. otherwise, just a part.
Packit cbb7bf
    if not reqt.proxy and not PROXY then
Packit cbb7bf
        u = {
Packit cbb7bf
           path = socket.try(reqt.path, "invalid path 'nil'"),
Packit cbb7bf
           params = reqt.params,
Packit cbb7bf
           query = reqt.query,
Packit cbb7bf
           fragment = reqt.fragment
Packit cbb7bf
        }
Packit cbb7bf
    end
Packit cbb7bf
    return url.build(u)
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
local function adjustproxy(reqt)
Packit cbb7bf
    local proxy = reqt.proxy or PROXY
Packit cbb7bf
    if proxy then
Packit cbb7bf
        proxy = url.parse(proxy)
Packit cbb7bf
        return proxy.host, proxy.port or 3128
Packit cbb7bf
    else
Packit cbb7bf
        return reqt.host, reqt.port
Packit cbb7bf
    end
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
local function adjustheaders(reqt)
Packit cbb7bf
    -- default headers
Packit cbb7bf
    local lower = {
Packit cbb7bf
        ["user-agent"] = _M.USERAGENT,
Packit cbb7bf
        ["host"] = reqt.host,
Packit cbb7bf
        ["connection"] = "close, TE",
Packit cbb7bf
        ["te"] = "trailers"
Packit cbb7bf
    }
Packit cbb7bf
    -- if we have authentication information, pass it along
Packit cbb7bf
    if reqt.user and reqt.password then
Packit cbb7bf
        lower["authorization"] = 
Packit cbb7bf
            "Basic " ..  (mime.b64(reqt.user .. ":" .. reqt.password))
Packit cbb7bf
    end
Packit cbb7bf
    -- override with user headers
Packit cbb7bf
    for i,v in base.pairs(reqt.headers or lower) do
Packit cbb7bf
        lower[string.lower(i)] = v
Packit cbb7bf
    end
Packit cbb7bf
    return lower
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
-- default url parts
Packit cbb7bf
local default = {
Packit cbb7bf
    host = "",
Packit cbb7bf
    port = _M.PORT,
Packit cbb7bf
    path ="/",
Packit cbb7bf
    scheme = "http"
Packit cbb7bf
}
Packit cbb7bf
Packit cbb7bf
local function adjustrequest(reqt)
Packit cbb7bf
    -- parse url if provided
Packit cbb7bf
    local nreqt = reqt.url and url.parse(reqt.url, default) or {}
Packit cbb7bf
    -- explicit components override url
Packit cbb7bf
    for i,v in base.pairs(reqt) do nreqt[i] = v end
Packit cbb7bf
    if nreqt.port == "" then nreqt.port = 80 end
Packit cbb7bf
    socket.try(nreqt.host and nreqt.host ~= "", 
Packit cbb7bf
        "invalid host '" .. base.tostring(nreqt.host) .. "'")
Packit cbb7bf
    -- compute uri if user hasn't overriden
Packit cbb7bf
    nreqt.uri = reqt.uri or adjusturi(nreqt)
Packit cbb7bf
    -- ajust host and port if there is a proxy
Packit cbb7bf
    nreqt.host, nreqt.port = adjustproxy(nreqt)
Packit cbb7bf
    -- adjust headers in request
Packit cbb7bf
    nreqt.headers = adjustheaders(nreqt)
Packit cbb7bf
    return nreqt
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
local function shouldredirect(reqt, code, headers)
Packit cbb7bf
    return headers.location and
Packit cbb7bf
           string.gsub(headers.location, "%s", "") ~= "" and
Packit cbb7bf
           (reqt.redirect ~= false) and
Packit cbb7bf
           (code == 301 or code == 302 or code == 303 or code == 307) and
Packit cbb7bf
           (not reqt.method or reqt.method == "GET" or reqt.method == "HEAD")
Packit cbb7bf
           and (not reqt.nredirects or reqt.nredirects < 5)
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
local function shouldreceivebody(reqt, code)
Packit cbb7bf
    if reqt.method == "HEAD" then return nil end
Packit cbb7bf
    if code == 204 or code == 304 then return nil end
Packit cbb7bf
    if code >= 100 and code < 200 then return nil end
Packit cbb7bf
    return 1
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
-- forward declarations
Packit cbb7bf
local trequest, tredirect
Packit cbb7bf
Packit cbb7bf
--[[local]] function tredirect(reqt, location)
Packit cbb7bf
    local result, code, headers, status = trequest {
Packit cbb7bf
        -- the RFC says the redirect URL has to be absolute, but some
Packit cbb7bf
        -- servers do not respect that
Packit cbb7bf
        url = url.absolute(reqt.url, location),
Packit cbb7bf
        source = reqt.source,
Packit cbb7bf
        sink = reqt.sink,
Packit cbb7bf
        headers = reqt.headers,
Packit cbb7bf
        proxy = reqt.proxy, 
Packit cbb7bf
        nredirects = (reqt.nredirects or 0) + 1,
Packit cbb7bf
        create = reqt.create
Packit cbb7bf
    }   
Packit cbb7bf
    -- pass location header back as a hint we redirected
Packit cbb7bf
    headers = headers or {}
Packit cbb7bf
    headers.location = headers.location or location
Packit cbb7bf
    return result, code, headers, status
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
--[[local]] function trequest(reqt)
Packit cbb7bf
    -- we loop until we get what we want, or
Packit cbb7bf
    -- until we are sure there is no way to get it
Packit cbb7bf
    local nreqt = adjustrequest(reqt)
Packit cbb7bf
    local h = _M.open(nreqt.host, nreqt.port, nreqt.create)
Packit cbb7bf
    -- send request line and headers
Packit cbb7bf
    h:sendrequestline(nreqt.method, nreqt.uri)
Packit cbb7bf
    h:sendheaders(nreqt.headers)
Packit cbb7bf
    -- if there is a body, send it
Packit cbb7bf
    if nreqt.source then
Packit cbb7bf
        h:sendbody(nreqt.headers, nreqt.source, nreqt.step) 
Packit cbb7bf
    end
Packit cbb7bf
    local code, status = h:receivestatusline()
Packit cbb7bf
    -- if it is an HTTP/0.9 server, simply get the body and we are done
Packit cbb7bf
    if not code then
Packit cbb7bf
        h:receive09body(status, nreqt.sink, nreqt.step)
Packit cbb7bf
        return 1, 200
Packit cbb7bf
    end
Packit cbb7bf
    local headers
Packit cbb7bf
    -- ignore any 100-continue messages
Packit cbb7bf
    while code == 100 do 
Packit cbb7bf
        headers = h:receiveheaders()
Packit cbb7bf
        code, status = h:receivestatusline()
Packit cbb7bf
    end
Packit cbb7bf
    headers = h:receiveheaders()
Packit cbb7bf
    -- at this point we should have a honest reply from the server
Packit cbb7bf
    -- we can't redirect if we already used the source, so we report the error 
Packit cbb7bf
    if shouldredirect(nreqt, code, headers) and not nreqt.source then
Packit cbb7bf
        h:close()
Packit cbb7bf
        return tredirect(reqt, headers.location)
Packit cbb7bf
    end
Packit cbb7bf
    -- here we are finally done
Packit cbb7bf
    if shouldreceivebody(nreqt, code) then
Packit cbb7bf
        h:receivebody(headers, nreqt.sink, nreqt.step)
Packit cbb7bf
    end
Packit cbb7bf
    h:close()
Packit cbb7bf
    return 1, code, headers, status
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
local function srequest(u, b)
Packit cbb7bf
    local t = {}
Packit cbb7bf
    local reqt = {
Packit cbb7bf
        url = u,
Packit cbb7bf
        sink = ltn12.sink.table(t)
Packit cbb7bf
    }
Packit cbb7bf
    if b then
Packit cbb7bf
        reqt.source = ltn12.source.string(b)
Packit cbb7bf
        reqt.headers = {
Packit cbb7bf
            ["content-length"] = string.len(b),
Packit cbb7bf
            ["content-type"] = "application/x-www-form-urlencoded"
Packit cbb7bf
        }
Packit cbb7bf
        reqt.method = "POST"
Packit cbb7bf
    end
Packit cbb7bf
    local code, headers, status = socket.skip(1, trequest(reqt))
Packit cbb7bf
    return table.concat(t), code, headers, status
Packit cbb7bf
end
Packit cbb7bf
Packit cbb7bf
_M.request = socket.protect(function(reqt, body)
Packit cbb7bf
    if base.type(reqt) == "string" then return srequest(reqt, body)
Packit cbb7bf
    else return trequest(reqt) end
Packit cbb7bf
end)
Packit cbb7bf
Packit cbb7bf
return _M