luasocket/src/http.lua

629 lines
23 KiB
Lua
Raw Normal View History

2000-12-29 23:15:09 +01:00
-----------------------------------------------------------------------------
-- Full HTTP/1.1 client support for the Lua language using the
-- LuaSocket 1.4a toolkit.
2000-12-29 23:15:09 +01:00
-- Author: Diego Nehab
-- Date: 26/12/2000
-- Conforming to: RFC 2068
-----------------------------------------------------------------------------
local Public, Private = {}, {}
HTTP = Public
2000-12-29 23:15:09 +01:00
-----------------------------------------------------------------------------
-- Program constants
-----------------------------------------------------------------------------
-- connection timeout in seconds
Private.TIMEOUT = 60
2000-12-29 23:15:09 +01:00
-- default port for document retrieval
Private.PORT = 80
2000-12-29 23:15:09 +01:00
-- user agent field sent in request
Private.USERAGENT = "LuaSocket 1.4a"
2001-06-06 22:55:45 +02:00
-- block size used in transfers
Private.BLOCKSIZE = 8192
-----------------------------------------------------------------------------
-- Required libraries
-----------------------------------------------------------------------------
dofile "buffer.lua"
dofile "url.lua"
dofile "encode.lua"
2000-12-29 23:15:09 +01:00
-----------------------------------------------------------------------------
-- Tries to get a pattern from the server and closes socket on error
2000-12-29 23:15:09 +01:00
-- sock: socket connected to the server
-- pattern: pattern to receive
2000-12-29 23:15:09 +01:00
-- Returns
-- data: line received or nil in case of error
2000-12-29 23:15:09 +01:00
-- err: error message if any
-----------------------------------------------------------------------------
function Private.try_receive(...)
local sock = arg[1]
local data, err = call(sock.receive, arg)
if err then
sock:close()
return nil, err
end
return data
2000-12-29 23:15:09 +01:00
end
-----------------------------------------------------------------------------
-- Tries to send data to the server and closes socket on error
2000-12-29 23:15:09 +01:00
-- sock: socket connected to the server
-- data: data to send
2000-12-29 23:15:09 +01:00
-- Returns
-- err: error message if any, nil if successfull
2000-12-29 23:15:09 +01:00
-----------------------------------------------------------------------------
function Private.try_send(sock, data)
local err = sock:send(data)
if err then sock:close() end
return err
2000-12-29 23:15:09 +01:00
end
-----------------------------------------------------------------------------
-- Retrieves status code from http status line
2000-12-29 23:15:09 +01:00
-- Input
-- line: http status line
2000-12-29 23:15:09 +01:00
-- Returns
-- code: integer with status code
2000-12-29 23:15:09 +01:00
-----------------------------------------------------------------------------
function Private.get_statuscode(line)
local code, _
_, _, code = strfind(line, "HTTP/%d*%.%d* (%d%d%d)")
return tonumber(code)
2000-12-29 23:15:09 +01:00
end
-----------------------------------------------------------------------------
-- Receive server reply messages, parsing status code
2000-12-29 23:15:09 +01:00
-- Input
-- sock: socket connected to the server
2000-12-29 23:15:09 +01:00
-- Returns
-- code: server status code or nil if error
-- line: full http status line
2000-12-29 23:15:09 +01:00
-- err: error message if any
-----------------------------------------------------------------------------
function Private.receive_status(sock)
local line, err
line, err = %Private.try_receive(sock)
if not err then return %Private.get_statuscode(line), line
2000-12-29 23:15:09 +01:00
else return nil, nil, err end
end
-----------------------------------------------------------------------------
-- Receive and parse response header fields
2000-12-29 23:15:09 +01:00
-- Input
-- sock: socket connected to the server
-- headers: a table that might already contain headers
2000-12-29 23:15:09 +01:00
-- Returns
-- headers: a table with all headers fields in the form
2000-12-29 23:15:09 +01:00
-- {name_1 = "value_1", name_2 = "value_2" ... name_n = "value_n"}
-- all name_i are lowercase
-- nil and error message in case of error
-----------------------------------------------------------------------------
function Private.receive_headers(sock, headers)
2000-12-29 23:15:09 +01:00
local line, err
local name, value, _
-- get first line
line, err = %Private.try_receive(sock)
if err then return nil, err end
2000-12-29 23:15:09 +01:00
-- headers go until a blank line is found
while line ~= "" do
-- get field-name and value
_,_, name, value = strfind(line, "(.-):%s*(.*)")
if not name or not value then
sock:close()
return nil, "malformed reponse headers"
end
2000-12-29 23:15:09 +01:00
name = strlower(name)
-- get next line (value might be folded)
line, err = %Private.try_receive(sock)
if err then return nil, err end
2000-12-29 23:15:09 +01:00
-- unfold any folded values
while not err and strfind(line, "^%s") do
2000-12-29 23:15:09 +01:00
value = value .. line
line, err = %Private.try_receive(sock)
if err then return nil, err end
2000-12-29 23:15:09 +01:00
end
-- save pair in table
if headers[name] then headers[name] = headers[name] .. ", " .. value
else headers[name] = value end
2000-12-29 23:15:09 +01:00
end
return headers
end
-----------------------------------------------------------------------------
-- Receives a chunked message body
-- Input
-- sock: socket connected to the server
-- headers: header set in which to include trailer headers
2001-06-06 22:55:45 +02:00
-- receive_cb: function to receive chunks
-- Returns
-- nil if successfull or an error message in case of error
-----------------------------------------------------------------------------
function Private.receivebody_bychunks(sock, headers, receive_cb)
2001-06-06 22:55:45 +02:00
local chunk, size, line, err, go, uerr, _
while 1 do
-- get chunk size, skip extention
line, err = %Private.try_receive(sock)
if err then
2001-06-06 22:55:45 +02:00
local _, uerr = receive_cb(nil, err)
return uerr or err
end
size = tonumber(gsub(line, ";.*", ""), 16)
if not size then
2001-06-06 22:55:45 +02:00
err = "invalid chunk size"
sock:close()
2001-06-06 22:55:45 +02:00
_, uerr = receive_cb(nil, err)
return uerr or err
end
-- was it the last chunk?
if size <= 0 then break end
-- get chunk
chunk, err = %Private.try_receive(sock, size)
if err then
2001-06-06 22:55:45 +02:00
_, uerr = receive_cb(nil, err)
return uerr or err
end
-- pass chunk to callback
go, uerr = receive_cb(chunk)
if not go then
sock:close()
return uerr or "aborted by callback"
end
-- skip CRLF on end of chunk
_, err = %Private.try_receive(sock)
if err then
2001-06-06 22:55:45 +02:00
_, uerr = receive_cb(nil, err)
return uerr or err
end
end
-- the server should not send trailer headers because we didn't send a
-- header informing it we know how to deal with them. we do not risk
-- being caught unprepaired.
headers, err = %Private.receive_headers(sock, headers)
if err then
_, uerr = receive_cb(nil, err)
return uerr or err
end
2001-06-06 22:55:45 +02:00
-- let callback know we are done
_, uerr = receive_cb("")
return uerr
2000-12-29 23:15:09 +01:00
end
-----------------------------------------------------------------------------
-- Receives a message body by content-length
2000-12-29 23:15:09 +01:00
-- Input
-- sock: socket connected to the server
2001-06-06 22:55:45 +02:00
-- receive_cb: function to receive chunks
2000-12-29 23:15:09 +01:00
-- Returns
-- nil if successfull or an error message in case of error
-----------------------------------------------------------------------------
function Private.receivebody_bylength(sock, length, receive_cb)
2001-06-06 22:55:45 +02:00
local uerr, go
while length > 0 do
local size = min(%Private.BLOCKSIZE, length)
2001-06-06 22:55:45 +02:00
local chunk, err = sock:receive(size)
if err then
go, uerr = receive_cb(nil, err)
return uerr or err
end
go, uerr = receive_cb(chunk)
if not go then
sock:close()
return uerr or "aborted by callback"
end
length = length - size
end
go, uerr = receive_cb("")
return uerr
end
-----------------------------------------------------------------------------
-- Receives a message body by content-length
-- Input
-- sock: socket connected to the server
2001-06-06 22:55:45 +02:00
-- receive_cb: function to receive chunks
-- Returns
-- nil if successfull or an error message in case of error
-----------------------------------------------------------------------------
function Private.receivebody_untilclosed(sock, receive_cb)
2001-06-06 22:55:45 +02:00
local err, go, uerr
while 1 do
local chunk, err = sock:receive(%Private.BLOCKSIZE)
2001-06-06 22:55:45 +02:00
if err == "closed" or not err then
go, uerr = receive_cb(chunk)
if not go then
sock:close()
return uerr or "aborted by callback"
end
if err then break end
else
go, uerr = callback(nil, err)
return uerr or err
end
end
go, uerr = receive_cb("")
return uerr
end
-----------------------------------------------------------------------------
-- Receives http response body
-- Input
-- sock: socket connected to the server
-- headers: response header fields
2001-06-06 22:55:45 +02:00
-- receive_cb: function to receive chunks
-- Returns
-- nil if successfull or an error message in case of error
-----------------------------------------------------------------------------
function Private.receive_body(sock, headers, receive_cb)
local te = headers["transfer-encoding"]
if te and te ~= "identity" then
-- get by chunked transfer-coding of message body
return %Private.receivebody_bychunks(sock, headers, receive_cb)
elseif tonumber(headers["content-length"]) then
-- get by content-length
local length = tonumber(headers["content-length"])
return %Private.receivebody_bylength(sock, length, receive_cb)
2000-12-29 23:15:09 +01:00
else
-- get it all until connection closes
return %Private.receivebody_untilclosed(sock, receive_cb)
2000-12-29 23:15:09 +01:00
end
end
-----------------------------------------------------------------------------
-- Drop http response body
2000-12-29 23:15:09 +01:00
-- Input
-- sock: socket connected to the server
-- headers: response header fields
2000-12-29 23:15:09 +01:00
-- Returns
-- nil if successfull or an error message in case of error
-----------------------------------------------------------------------------
function Private.drop_body(sock, headers)
return %Private.receive_body(sock, headers, function (c, e) return 1 end)
2000-12-29 23:15:09 +01:00
end
2001-06-06 22:55:45 +02:00
-----------------------------------------------------------------------------
-- Sends data comming from a callback
-- Input
-- data: data connection
-- send_cb: callback to produce file contents
-- chunk, size: first callback results
-- Returns
-- nil if successfull, or an error message in case of error
-----------------------------------------------------------------------------
function Private.send_indirect(data, send_cb, chunk, size)
2001-06-06 22:55:45 +02:00
local sent, err
sent = 0
while 1 do
if type(chunk) ~= "string" or type(size) ~= "number" then
data:close()
2001-06-06 22:55:45 +02:00
if not chunk and type(size) == "string" then return size
else return "invalid callback return" end
end
err = data:send(chunk)
if err then
data:close()
return err
end
2001-06-06 22:55:45 +02:00
sent = sent + strlen(chunk)
if sent >= size then break end
chunk, size = send_cb()
end
end
-----------------------------------------------------------------------------
-- Sends a http request message through socket
-- Input
-- sock: socket connected to the server
-- method: request method to be used
-- path: url path
-- headers: request headers to be sent
-- body_cb: callback to send request message body
-- Returns
-- err: nil in case of success, error message otherwise
-----------------------------------------------------------------------------
function Private.send_request(sock, method, path, headers, body_cb)
2001-06-06 22:55:45 +02:00
local chunk, size, done, err
-- send request line
err = %Private.try_send(sock, method .. " " .. path .. " HTTP/1.1\r\n")
if err then return err end
2001-06-06 22:55:45 +02:00
-- if there is a request message body, add content-length header
if body_cb then
chunk, size = body_cb()
2001-06-06 22:55:45 +02:00
if type(chunk) == "string" and type(size) == "number" then
headers["content-length"] = tostring(size)
2001-06-06 22:55:45 +02:00
else
sock:close()
if not chunk and type(size) == "string" then return size
else return "invalid callback return" end
2001-06-06 22:55:45 +02:00
end
end
-- send request headers
for i, v in headers do
err = %Private.try_send(sock, i .. ": " .. v .. "\r\n")
if err then return err end
end
2001-06-06 22:55:45 +02:00
-- mark end of request headers
err = %Private.try_send(sock, "\r\n")
if err then return err end
2001-06-06 22:55:45 +02:00
-- send request message body, if any
if body_cb then
return %Private.send_indirect(sock, body_cb, chunk, size)
2001-06-06 22:55:45 +02:00
end
end
-----------------------------------------------------------------------------
-- Determines if we should read a message body from the server response
-- Input
-- request: a table with the original request information
-- response: a table with the server response information
-- Returns
-- 1 if a message body should be processed, nil otherwise
-----------------------------------------------------------------------------
function Private.has_body(request, response)
if request.method == "HEAD" then return nil end
if response.code == 204 or response.code == 304 then return nil end
if response.code >= 100 and response.code < 200 then return nil end
return 1
2000-12-29 23:15:09 +01:00
end
-----------------------------------------------------------------------------
2001-06-06 22:55:45 +02:00
-- Converts field names to lowercase and adds a few needed headers
2000-12-29 23:15:09 +01:00
-- Input
-- headers: request header fields
2000-12-29 23:15:09 +01:00
-- parsed: parsed url components
-- Returns
-- lower: a table with the same headers, but with lowercase field names
-----------------------------------------------------------------------------
function Private.fill_headers(headers, parsed)
local lower = {}
headers = headers or {}
-- set default headers
lower["user-agent"] = %Private.USERAGENT
lower["host"] = parsed.host
-- override with user values
for i,v in headers do
lower[strlower(i)] = v
end
-- this cannot be overriden
lower["connection"] = "close"
return lower
2000-12-29 23:15:09 +01:00
end
-----------------------------------------------------------------------------
-- Decides wether we should follow retry with authorization formation
2000-12-29 23:15:09 +01:00
-- Input
-- request: a table with the original request information
-- parsed: parsed request url
-- response: a table with the server response information
2000-12-29 23:15:09 +01:00
-- Returns
-- 1 if we should retry, nil otherwise
-----------------------------------------------------------------------------
function Private.should_authorize(request, parsed, response)
-- if there has been an authorization attempt, it must have failed
if request.headers["authorization"] then return nil end
-- if we don't have authorization information, we can't retry
if parsed.user and parsed.password then return 1
else return nil end
end
2001-06-06 22:55:45 +02:00
-----------------------------------------------------------------------------
-- Returns the result of retrying a request with authorization information
-- Input
-- request: a table with the original request information
-- parsed: parsed request url
-- response: a table with the server response information
-- Returns
-- response: result of target redirection
-----------------------------------------------------------------------------
function Private.authorize(request, parsed, response)
request.headers["authorization"] = "Basic " ..
base64(parsed.user .. ":" .. parsed.password)
local authorize = {
redirects = request.redirects,
method = request.method,
url = request.url,
body_cb = request.body_cb,
headers = request.headers
}
return %Public.request_indirect(authorize, response)
end
2001-06-06 22:55:45 +02:00
-----------------------------------------------------------------------------
-- Decides wether we should follow a server redirect message
-- Input
-- request: a table with the original request information
-- response: a table with the server response information
-- Returns
-- 1 if we should redirect, nil otherwise
-----------------------------------------------------------------------------
function Private.should_redirect(request, response)
local follow = not request.stay
follow = follow and (response.code == 301 or response.code == 302)
follow = follow and (request.method == "GET" or request.method == "HEAD")
follow = follow and not (request.redirects and request.redirects >= 5)
return follow
end
-----------------------------------------------------------------------------
-- Returns the result of a request following a server redirect message.
-- Input
-- request: a table with the original request information
-- response: a table with the following fields:
-- body_cb: response method body receive-callback
-- Returns
-- response: result of target redirection
-----------------------------------------------------------------------------
function Private.redirect(request, response)
local redirects = request.redirects or 0
redirects = redirects + 1
local redirect = {
redirects = redirects,
method = request.method,
-- the RFC says the redirect url has to be absolute, but some
-- servers do not respect that
url = URL.build_absolute(request.url,response.headers["location"]),
body_cb = request.body_cb,
headers = request.headers
}
return %Public.request_indirect(redirect, response)
end
-----------------------------------------------------------------------------
-- Computes the request URI from the given URL
-- Input
-- parsed: parsed url
-- Returns
-- uri: request URI for parsed URL
-----------------------------------------------------------------------------
function Private.request_uri(parsed)
local uri = ""
if parsed.path then uri = uri .. parsed.path end
if parsed.params then uri = uri .. ";" .. parsed.params end
if parsed.query then uri = uri .. "?" .. parsed.query end
if parsed.fragment then uri = uri .. "#" .. parsed.fragment end
return uri
end
-----------------------------------------------------------------------------
-- Sends a HTTP request and retrieves the server reply using callbacks to
-- send the request body and receive the response body
-- Input
-- request: a table with the following fields
-- method: "GET", "PUT", "POST" etc (defaults to "GET")
-- url: target uniform resource locator
-- user, password: authentication information
-- headers: request headers to send, or nil if none
-- body_cb: request message body send-callback, or nil if none
-- stay: should we refrain from following a server redirect message?
-- response: a table with the following fields:
-- body_cb: response method body receive-callback
-- Returns
-- response: a table with the following fields:
-- headers: response header fields received, or nil if failed
-- status: server response status line, or nil if failed
-- code: server status code, or nil if failed
-- error: error message, or nil if successfull
2001-06-06 22:55:45 +02:00
-----------------------------------------------------------------------------
function Public.request_indirect(request, response)
-- get url components
local parsed = URL.parse(request.url, {port = %Private.PORT, path ="/"})
-- explicit authentication info overrides that given by the url
parsed.user = request.user or parsed.user
parsed.password = request.password or parsed.password
-- default method
request.method = request.method or "GET"
-- fill default headers
request.headers = %Private.fill_headers(request.headers, parsed)
-- try to connect to server
local sock
sock, response.error = connect(parsed.host, parsed.port)
if not sock then return response end
-- set connection timeout so that we do not hang forever
sock:timeout(%Private.TIMEOUT)
-- send request message
response.error = %Private.send_request(sock, request.method,
%Private.request_uri(parsed), request.headers, request.body_cb)
if response.error then return response end
-- get server response message
response.code, response.status, response.error =
%Private.receive_status(sock)
if response.error then return response end
-- receive all headers
response.headers, response.error = %Private.receive_headers(sock, {})
if response.error then return response end
-- decide what to do based on request and response parameters
if %Private.should_redirect(request, response) then
%Private.drop_body(sock, response.headers)
sock:close()
return %Private.redirect(request, response)
elseif %Private.should_authorize(request, parsed, response) then
%Private.drop_body(sock, response.headers)
sock:close()
return %Private.authorize(request, parsed, response)
elseif %Private.has_body(request, response) then
response.error = %Private.receive_body(sock, response.headers,
response.body_cb)
if response.error then return response end
sock:close()
return response
end
sock:close()
2001-06-06 22:55:45 +02:00
end
-----------------------------------------------------------------------------
-- Sends a HTTP request and retrieves the server reply
2001-06-06 22:55:45 +02:00
-- Input
-- request: a table with the following fields
-- method: "GET", "PUT", "POST" etc (defaults to "GET")
-- url: target url, i.e. the document to be retrieved
-- user, password: authentication information
-- headers: request header fields, or nil if none
-- body: request message body as a string, or nil if none
-- stay: should we refrain from following a server redirect message?
2001-06-06 22:55:45 +02:00
-- Returns
-- response: a table with the following fields:
-- body: response message body, or nil if failed
-- headers: response header fields, or nil if failed
-- status: server response status line, or nil if failed
-- code: server response status code, or nil if failed
-- error: error message if any
-----------------------------------------------------------------------------
function Public.request(request)
local response = {}
if request.body then
request.body_cb = function()
return %request.body, strlen(%request.body)
end
end
local auxiliar = { buf = buf_create() }
response.body_cb = function(chunk, err)
if not chunk then %auxiliar.buf = nil end
buf_addstring(%auxiliar.buf, chunk)
return 1
end
%Public.request_indirect(request, response)
response.body = buf_getresult(auxiliar.buf)
response.body_cb = nil
return response
end
2001-06-06 22:55:45 +02:00
-----------------------------------------------------------------------------
-- Retrieves a URL by the method "GET"
-- Input
-- url: target url, i.e. the document to be retrieved
-- Returns
-- body: response message body, or nil if failed
-- headers: response header fields received, or nil if failed
-- status: server response status line, or nil if failed
-- error: error message if any
-----------------------------------------------------------------------------
function Public.get(url)
local response = %Public.request {
method = "GET",
url = url
}
return response.body, response.headers,
response.status, response.error
2001-06-06 22:55:45 +02:00
end
-----------------------------------------------------------------------------
-- Retrieves a URL by the method "POST"
-- Input
-- url: target url, i.e. the document to be retrieved
-- body: request message body, or nil if none
2001-06-06 22:55:45 +02:00
-- Returns
-- body: response message body, or nil if failed
-- headers: response header fields received, or nil if failed
-- status: server response status line, or nil if failed
-- error: error message, or nil if successfull
-----------------------------------------------------------------------------
function Public.post(url, body)
local response = %Public.request {
method = "POST",
url = url,
body = body
}
return response.body, response.headers,
response.status, response.error
2000-12-29 23:15:09 +01:00
end