libs/httpclient/luasrc/httpclient.lua

   1 --[[
   2 LuCI - Lua Development Framework
   3
   4 Copyright 2009 Steven Barth <steven@midlink.org>
   5
   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
   9
  10         http://www.apache.org/licenses/LICENSE-2.0
  11
  12 $Id$
  13 ]]--
  14
  15 require "nixio.util"
  16 local nixio = require "nixio"
  17
  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"
  23
  24 local type, pairs, ipairs, tonumber = type, pairs, ipairs, tonumber
  25 local unpack = unpack
  26
  27 module "luci.httpclient"
  28
  29 function chunksource(sock, buffer)
  30         buffer = buffer or ""
  31         return function()
  32                 local output
  33                 local _, endp, count = buffer:find("^([0-9a-fA-F]+);?.-\r\n")
  34                 while not count and #buffer <= 1024 do
  35                         local newblock, code = sock:recv(1024 - #buffer)
  36                         if not newblock then
  37                                 return nil, code
  38                         end
  39                         buffer = buffer .. newblock
  40                         _, endp, count = buffer:find("^([0-9a-fA-F]+);?.-\r\n")
  41                 end
  42                 count = tonumber(count, 16)
  43                 if not count then
  44                         return nil, -1, "invalid encoding"
  45                 elseif count == 0 then
  46                         return nil
  47                 elseif count + 2 <= #buffer - endp then
  48                         output = buffer:sub(endp+1, endp+count)
  49                         buffer = buffer:sub(endp+count+3)
  50                         return output
  51                 else
  52                         output = buffer:sub(endp+1, endp+count)
  53                         buffer = ""
  54                         if count - #output > 0 then
  55                                 local remain, code = sock:recvall(count-#output)
  56                                 if not remain then
  57                                         return nil, code
  58                                 end
  59                                 output = output .. remain
  60                                 count, code = sock:recvall(2)
  61                         else
  62                                 count, code = sock:recvall(count+2-#buffer+endp)
  63                         end
  64                         if not count then
  65                                 return nil, code
  66                         end
  67                         return output
  68                 end
  69         end
  70 end
  71
  72
  73 function request_to_buffer(uri, options)
  74         local source, code, msg = request_to_source(uri, options)
  75         local output = {}
  76
  77         if not source then
  78                 return nil, code, msg
  79         end
  80
  81         source, code = ltn12.pump.all(source, (ltn12.sink.table(output)))
  82
  83         if not source then
  84                 return nil, code
  85         end
  86
  87         return table.concat(output)
  88 end
  89
  90 function request_to_source(uri, options)
  91         local status, response, buffer, sock = request_raw(uri, options)
  92         if not status then
  93                 return status, response, buffer
  94         elseif status ~= 200 and status ~= 206 then
  95                 return nil, status, response
  96         end
  97
  98         if response.headers["Transfer-Encoding"] == "chunked" then
  99                 return chunksource(sock, buffer)
 100         else
 101                 return ltn12.source.cat(ltn12.source.string(buffer), sock:blocksource())
 102         end
 103 end
 104
 105 --
 106 -- GET HTTP-resource
 107 --
 108 function request_raw(uri, options)
 109         options = options or {}
 110         local pr, auth, host, port, path
 111         if uri:find("@") then
 112                 pr, auth, host, port, path =
 113                         uri:match("(%w+)://(.+)@([%w-.]+):?([0-9]*)(.*)")
 114         else
 115                 pr, host, port, path = uri:match("(%w+)://([%w-.]+):?([0-9]*)(.*)")
 116         end
 117
 118         if not host then
 119                 return nil, -1, "unable to parse URI"
 120         end
 121
 122         if pr ~= "http" and pr ~= "https" then
 123                 return nil, -2, "protocol not supported"
 124         end
 125
 126         port = #port > 0 and port or (pr == "https" and 443 or 80)
 127         path = #path > 0 and path or "/"
 128
 129         options.depth = options.depth or 10
 130         local headers = options.headers or {}
 131         local protocol = options.protocol or "HTTP/1.1"
 132         headers["User-Agent"] = headers["User-Agent"] or "LuCI httpclient 0.1"
 133
 134         if headers.Connection == nil then
 135                 headers.Connection = "close"
 136         end
 137
 138         if auth and not headers.Authorization then
 139                 headers.Authorization = "Basic " .. nixio.bin.b64encode(auth)
 140         end
 141
 142         local sock, code, msg = nixio.connect(host, port)
 143         if not sock then
 144                 return nil, code, msg
 145         end
 146
 147         sock:setsockopt("socket", "sndtimeo", options.sndtimeo or 15)
 148         sock:setsockopt("socket", "rcvtimeo", options.rcvtimeo or 15)
 149
 150         if pr == "https" then
 151                 local tls = options.tls_context or nixio.tls()
 152                 sock = tls:create(sock)
 153                 local stat, code, error = sock:connect()
 154                 if not stat then
 155                         return stat, code, error
 156                 end
 157         end
 158
 159         -- Pre assemble fixes
 160         if protocol == "HTTP/1.1" then
 161                 headers.Host = headers.Host or host
 162         end
 163
 164         if type(options.body) == "table" then
 165                 options.body = http.urlencode_params(options.body)
 166         end
 167
 168         if type(options.body) == "string" then
 169                 headers["Content-Length"] = headers["Content-Length"] or #options.body
 170                 headers["Content-Type"] = headers["Content-Type"] or
 171                         "application/x-www-form-urlencoded"
 172                 options.method = options.method or "POST"
 173         end
 174
 175         if type(options.body) == "function" then
 176                 options.method = options.method or "POST"
 177         end
 178
 179         -- Assemble message
 180         local message = {(options.method or "GET") .. " " .. path .. " " .. protocol}
 181
 182         for k, v in pairs(headers) do
 183                 if type(v) == "string" or type(v) == "number" then
 184                         message[#message+1] = k .. ": " .. v
 185                 elseif type(v) == "table" then
 186                         for i, j in ipairs(v) do
 187                                 message[#message+1] = k .. ": " .. j
 188                         end
 189                 end
 190         end
 191
 192         if options.cookies then
 193                 for _, c in ipairs(options.cookies) do
 194                         local cdo = c.flags.domain
 195                         local cpa = c.flags.path
 196                         if   (cdo == host or cdo == "."..host or host:sub(-#cdo) == cdo)
 197                          and (cpa == path or cpa == "/" or cpa .. "/" == path:sub(#cpa+1))
 198                          and (not c.flags.secure or pr == "https")
 199                         then
 200                                 message[#message+1] = "Cookie: " .. c.key .. "=" .. c.value
 201                         end
 202                 end
 203         end
 204
 205         message[#message+1] = ""
 206         message[#message+1] = ""
 207
 208         -- Send request
 209         sock:sendall(table.concat(message, "\r\n"))
 210
 211         if type(options.body) == "string" then
 212                 sock:sendall(options.body)
 213         elseif type(options.body) == "function" then
 214                 local res = {options.body(sock)}
 215                 if not res[1] then
 216                         sock:close()
 217                         return unpack(res)
 218                 end
 219         end
 220
 221         -- Create source and fetch response
 222         local linesrc = sock:linesource()
 223         local line, code, error = linesrc()
 224
 225         if not line then
 226                 sock:close()
 227                 return nil, code, error
 228         end
 229
 230         local protocol, status, msg = line:match("^([%w./]+) ([0-9]+) (.*)")
 231
 232         if not protocol then
 233                 sock:close()
 234                 return nil, -3, "invalid response magic: " .. line
 235         end
 236
 237         local response = {
 238                 status = line, headers = {}, code = 0, cookies = {}, uri = uri
 239         }
 240
 241         line = linesrc()
 242         while line and line ~= "" do
 243                 local key, val = line:match("^([%w-]+)%s?:%s?(.*)")
 244                 if key and key ~= "Status" then
 245                         if type(response.headers[key]) == "string" then
 246                                 response.headers[key] = {response.headers[key], val}
 247                         elseif type(response.headers[key]) == "table" then
 248                                 response.headers[key][#response.headers[key]+1] = val
 249                         else
 250                                 response.headers[key] = val
 251                         end
 252                 end
 253                 line = linesrc()
 254         end
 255
 256         if not line then
 257                 sock:close()
 258                 return nil, -4, "protocol error"
 259         end
 260
 261         -- Parse cookies
 262         if response.headers["Set-Cookie"] then
 263                 local cookies = response.headers["Set-Cookie"]
 264                 for _, c in ipairs(type(cookies) == "table" and cookies or {cookies}) do
 265                         local cobj = cookie_parse(c)
 266                         cobj.flags.path = cobj.flags.path or path:match("(/.*)/?[^/]*")
 267                         if not cobj.flags.domain or cobj.flags.domain == "" then
 268                                 cobj.flags.domain = host
 269                                 response.cookies[#response.cookies+1] = cobj
 270                         else
 271                                 local hprt, cprt = {}, {}
 272
 273                                 -- Split hostnames and save them in reverse order
 274                                 for part in host:gmatch("[^.]*") do
 275                                         table.insert(hprt, 1, part)
 276                                 end
 277                                 for part in cobj.flags.domain:gmatch("[^.]*") do
 278                                         table.insert(cprt, 1, part)
 279                                 end
 280
 281                                 local valid = true
 282                                 for i, part in ipairs(cprt) do
 283                                         -- If parts are different and no wildcard
 284                                         if hprt[i] ~= part and #part ~= 0 then
 285                                                 valid = false
 286                                                 break
 287                                         -- Wildcard on invalid position
 288                                         elseif hprt[i] ~= part and #part == 0 then
 289                                                 if i ~= #cprt or (#hprt ~= i and #hprt+1 ~= i) then
 290                                                         valid = false
 291                                                         break
 292                                                 end
 293                                         end
 294                                 end
 295                                 -- No TLD cookies
 296                                 if valid and #cprt > 1 and #cprt[2] > 0 then
 297                                         response.cookies[#response.cookies+1] = cobj
 298                                 end
 299                         end
 300                 end
 301         end
 302
 303         -- Follow
 304         response.code = tonumber(status)
 305         if response.code and options.depth > 0 then
 306                 if response.code == 301 or response.code == 302 or response.code == 307
 307                  and response.headers.Location then
 308                         local nuri = response.headers.Location or response.headers.location
 309                         if not nuri then
 310                                 return nil, -5, "invalid reference"
 311                         end
 312                         if not nuri:find("https?://") then
 313                                 nuri = pr .. "://" .. host .. ":" .. port .. nuri
 314                         end
 315
 316                         options.depth = options.depth - 1
 317                         if options.headers then
 318                                 options.headers.Host = nil
 319                         end
 320                         sock:close()
 321
 322                         return request_raw(nuri, options)
 323                 end
 324         end
 325
 326         return response.code, response, linesrc(true), sock
 327 end
 328
 329 function cookie_parse(cookiestr)
 330         local key, val, flags = cookiestr:match("%s?([^=;]+)=?([^;]*)(.*)")
 331         if not key then
 332                 return nil
 333         end
 334
 335         local cookie = {key = key, value = val, flags = {}}
 336         for fkey, fval in flags:gmatch(";%s?([^=;]+)=?([^;]*)") do
 337                 fkey = fkey:lower()
 338                 if fkey == "expires" then
 339                         fval = date.to_unix(fval:gsub("%-", " "))
 340                 end
 341                 cookie.flags[fkey] = fval
 342         end
 343
 344         return cookie
 345 end
 346
 347 function cookie_create(cookie)
 348         local cookiedata = {cookie.key .. "=" .. cookie.value}
 349
 350         for k, v in pairs(cookie.flags) do
 351                 if k == "expires" then
 352                         v = date.to_http(v):gsub(", (%w+) (%w+) (%w+) ", ", %1-%2-%3 ")
 353                 end
 354                 cookiedata[#cookiedata+1] = k .. ((#v > 0) and ("=" .. v) or "")
 355         end
 356
 357         return table.concat(cookiedata, "; ")
 358 end