2 LuCI - Lua Development Framework
4 Copyright 2009 Steven Barth <steven@midlink.org>
6 Licensed under the Apache License, Version 2.0 (the "License");
7 you may not use this file except in compliance with the License.
8 You may obtain a copy of the License at
10 http://www.apache.org/licenses/LICENSE-2.0
16 local nixio = require "nixio"
18 local ltn12 = require "luci.ltn12"
19 local util = require "luci.util"
20 local table = require "table"
21 local http = require "luci.http.protocol"
22 local date = require "luci.http.protocol.date"
24 local type, pairs, ipairs, tonumber = type, pairs, ipairs, tonumber
26 module "luci.httpclient"
28 function chunksource(sock, buffer)
32 local _, endp, count = buffer:find("^([0-9a-fA-F]+);?.-\r\n")
33 while not count and #buffer <= 1024 do
34 local newblock, code = sock:recv(1024 - #buffer)
38 buffer = buffer .. newblock
39 _, endp, count = buffer:find("^([0-9a-fA-F]+);?.-\r\n")
41 count = tonumber(count, 16)
43 return nil, -1, "invalid encoding"
44 elseif count == 0 then
46 elseif count + 2 <= #buffer - endp then
47 output = buffer:sub(endp+1, endp+count)
48 buffer = buffer:sub(endp+count+3)
51 output = buffer:sub(endp+1, endp+count)
53 if count - #output > 0 then
54 local remain, code = sock:recvall(count-#output)
58 output = output .. remain
59 count, code = sock:recvall(2)
61 count, code = sock:recvall(count+2-#buffer+endp)
72 function request_to_buffer(uri, options)
73 local source, code, msg = request_to_source(uri, options)
80 source, code = ltn12.pump.all(source, (ltn12.sink.table(output)))
86 return table.concat(output)
89 function request_to_source(uri, options)
90 local status, response, buffer, sock = request_raw(uri, options)
92 return status, response, buffer
93 elseif status ~= 200 and status ~= 206 then
94 return nil, status, response
97 if response.headers["Transfer-Encoding"] == "chunked" then
98 return chunksource(sock, buffer)
100 return ltn12.source.cat(ltn12.source.string(buffer), sock:blocksource())
107 function request_raw(uri, options)
108 options = options or {}
109 local pr, host, port, path = uri:match("(%w+)://([%w-.]+):?([0-9]*)(.*)")
111 return nil, -1, "unable to parse URI"
114 if pr ~= "http" and pr ~= "https" then
115 return nil, -2, "protocol not supported"
118 port = #port > 0 and port or (pr == "https" and 443 or 80)
119 path = #path > 0 and path or "/"
121 options.depth = options.depth or 10
122 local headers = options.headers or {}
123 local protocol = options.protocol or "HTTP/1.1"
124 headers["User-Agent"] = headers["User-Agent"] or "LuCI httpclient 0.1"
126 if headers.Connection == nil then
127 headers.Connection = "close"
130 local sock, code, msg = nixio.connect(host, port)
132 return nil, code, msg
135 sock:setsockopt("socket", "sndtimeo", options.sndtimeo or 15)
136 sock:setsockopt("socket", "rcvtimeo", options.rcvtimeo or 15)
138 if pr == "https" then
139 local tls = options.tls_context or nixio.tls()
140 sock = tls:create(sock)
141 local stat, code, error = sock:connect()
143 return stat, code, error
147 -- Pre assemble fixes
148 if protocol == "HTTP/1.1" then
149 headers.Host = headers.Host or host
152 if type(options.body) == "table" then
153 options.body = http.urlencode_params(options.body)
156 if type(options.body) == "string" then
157 headers["Content-Length"] = headers["Content-Length"] or #options.body
158 headers["Content-Type"] = headers["Content-Type"] or
159 "application/x-www-form-urlencoded"
160 options.method = options.method or "POST"
164 local message = {(options.method or "GET") .. " " .. path .. " " .. protocol}
166 for k, v in pairs(headers) do
167 if type(v) == "string" or type(v) == "number" then
168 message[#message+1] = k .. ": " .. v
169 elseif type(v) == "table" then
170 for i, j in ipairs(v) do
171 message[#message+1] = k .. ": " .. j
176 if options.cookies then
177 for _, c in ipairs(options.cookies) do
178 local cdo = c.flags.domain
179 local cpa = c.flags.path
180 if (cdo == host or cdo == "."..host or host:sub(-#cdo) == cdo)
181 and (cpa == "/" or cpa .. "/" == path:sub(#cpa+1))
182 and (not c.flags.secure or pr == "https")
184 message[#message+1] = "Cookie: " .. c.key .. "=" .. c.value
189 message[#message+1] = ""
190 message[#message+1] = ""
193 sock:sendall(table.concat(message, "\r\n"))
195 if type(options.body) == "string" then
196 sock:sendall(options.body)
199 -- Create source and fetch response
200 local linesrc = sock:linesource()
201 local line, code, error = linesrc()
204 return nil, code, error
207 local protocol, status, msg = line:match("^(HTTP/[0-9.]+) ([0-9]+) (.*)")
210 return nil, -3, "invalid response magic: " .. line
213 local response = {status = line, headers = {}, code = 0, cookies = {}}
216 while line and line ~= "" do
217 local key, val = line:match("^([%w-]+)%s?:%s?(.*)")
218 if key and key ~= "Status" then
219 if type(response[key]) == "string" then
220 response.headers[key] = {response.headers[key], val}
221 elseif type(response[key]) == "table" then
222 response.headers[key][#response.headers[key]+1] = val
224 response.headers[key] = val
231 return nil, -4, "protocol error"
235 if response.headers["Set-Cookie"] then
236 local cookies = response.headers["Set-Cookie"]
237 for _, c in ipairs(type(cookies) == "table" and cookies or {cookies}) do
238 local cobj = cookie_parse(c)
239 cobj.flags.path = cobj.flags.path or path:match("(/.*)/?[^/]*")
240 if not cobj.flags.domain or cobj.flags.domain == "" then
241 cobj.flags.domain = host
242 response.cookies[#response.cookies+1] = cobj
244 local hprt, cprt = {}, {}
246 -- Split hostnames and save them in reverse order
247 for part in host:gmatch("[^.]*") do
248 table.insert(hprt, 1, part)
250 for part in cobj.flags.domain:gmatch("[^.]*") do
251 table.insert(cprt, 1, part)
255 for i, part in ipairs(cprt) do
256 -- If parts are different and no wildcard
257 if hprt[i] ~= part and #part ~= 0 then
260 -- Wildcard on invalid position
261 elseif hprt[i] ~= part and #part == 0 then
262 if i ~= #cprt or (#hprt ~= i and #hprt+1 ~= i) then
269 if valid and #cprt > 1 and #cprt[2] > 0 then
270 response.cookies[#response.cookies+1] = cobj
277 response.code = tonumber(status)
278 if response.code and options.depth > 0 then
279 if response.code == 301 or response.code == 302 or response.code == 307
280 and response.headers.Location then
281 local nexturi = response.headers.Location
282 if not nexturi:find("https?://") then
283 nexturi = pr .. "://" .. host .. ":" .. port .. nexturi
286 options.depth = options.depth - 1
289 return request_raw(nexturi, options)
293 return response.code, response, linesrc(true), sock
296 function cookie_parse(cookiestr)
297 local key, val, flags = cookiestr:match("%s?([^=;]+)=?([^;]*)(.*)")
302 local cookie = {key = key, value = val, flags = {}}
303 for fkey, fval in flags:gmatch(";%s?([^=;]+)=?([^;]*)") do
305 if fkey == "expires" then
306 fval = date.to_unix(fval:gsub("%-", " "))
308 cookie.flags[fkey] = fval
314 function cookie_create(cookie)
315 local cookiedata = {cookie.key .. "=" .. cookie.value}
317 for k, v in pairs(cookie.flags) do
318 if k == "expires" then
319 v = date.to_http(v):gsub(", (%w+) (%w+) (%w+) ", ", %1-%2-%3 ")
321 cookiedata[#cookiedata+1] = k .. ((#v > 0) and ("=" .. v) or "")
324 return table.concat(cookiedata, "; ")