moonbridge

annotate moonbridge_http.lua @ 154:831f2d4b2d73

Initial work on reimplemented HTTP layer (utilizing non-blocking I/O with coroutines and a cleaner object-oriented structure)
author jbe
date Thu May 21 02:40:39 2015 +0200 (2015-05-21)
parents 7014436d88ea
children 2c22b0f222c7
rev   line source
jbe@0 1 #!/usr/bin/env lua
jbe@0 2
jbe@0 3 -- module preamble
jbe@0 4 local _G, _M = _ENV, {}
jbe@0 5 _ENV = setmetatable({}, {
jbe@0 6 __index = function(self, key)
jbe@0 7 local value = _M[key]; if value ~= nil then return value end
jbe@0 8 return _G[key]
jbe@0 9 end,
jbe@63 10 __newindex = _M
jbe@0 11 })
jbe@0 12
jbe@0 13 -- function that encodes certain HTML entities:
jbe@0 14 -- (not used by the library itself)
jbe@0 15 function encode_html(text)
jbe@0 16 return (
jbe@0 17 string.gsub(
jbe@0 18 text, '[<>&"]',
jbe@0 19 function(char)
jbe@0 20 if char == '<' then
jbe@0 21 return "&lt;"
jbe@0 22 elseif char == '>' then
jbe@0 23 return "&gt;"
jbe@0 24 elseif char == '&' then
jbe@0 25 return "&amp;"
jbe@0 26 elseif char == '"' then
jbe@0 27 return "&quot;"
jbe@0 28 end
jbe@0 29 end
jbe@0 30 )
jbe@0 31 )
jbe@0 32
jbe@0 33 end
jbe@0 34
jbe@0 35 -- function that encodes special characters for URIs:
jbe@0 36 -- (not used by the library itself)
jbe@0 37 function encode_uri(text)
jbe@0 38 return (
jbe@0 39 string.gsub(text, "[^0-9A-Za-z_%.~-]",
jbe@0 40 function (char)
jbe@0 41 return string.format("%%%02x", string.byte(char))
jbe@0 42 end
jbe@0 43 )
jbe@0 44 )
jbe@0 45 end
jbe@0 46
jbe@0 47 -- function undoing URL encoding:
jbe@0 48 do
jbe@0 49 local b0 = string.byte("0")
jbe@0 50 local b9 = string.byte("9")
jbe@0 51 local bA = string.byte("A")
jbe@0 52 local bF = string.byte("F")
jbe@0 53 local ba = string.byte("a")
jbe@0 54 local bf = string.byte("f")
jbe@0 55 function decode_uri(str)
jbe@0 56 return (
jbe@0 57 string.gsub(
jbe@0 58 string.gsub(str, "%+", " "),
jbe@0 59 "%%([0-9A-Fa-f][0-9A-Fa-f])",
jbe@0 60 function(hex)
jbe@0 61 local n1, n2 = string.byte(hex, 1, 2)
jbe@0 62 if n1 >= b0 and n1 <= b9 then n1 = n1 - b0
jbe@0 63 elseif n1 >= bA and n1 <= bF then n1 = n1 - bA + 10
jbe@0 64 elseif n1 >= ba and n1 <= bf then n1 = n1 - ba + 10
jbe@0 65 else error("Assertion failed") end
jbe@0 66 if n2 >= b0 and n2 <= b9 then n2 = n2 - b0
jbe@0 67 elseif n2 >= bA and n2 <= bF then n2 = n2 - bA + 10
jbe@0 68 elseif n2 >= ba and n2 <= bf then n2 = n2 - ba + 10
jbe@0 69 else error("Assertion failed") end
jbe@0 70 return string.char(n1 * 16 + n2)
jbe@0 71 end
jbe@0 72 )
jbe@0 73 )
jbe@0 74 end
jbe@0 75 end
jbe@0 76
jbe@0 77 -- status codes that carry no response body (in addition to 1xx):
jbe@0 78 -- (set to "zero_content_length" if Content-Length header is required)
jbe@0 79 status_without_response_body = {
jbe@5 80 ["101"] = true, -- list 101 to allow protocol switch
jbe@0 81 ["204"] = true,
jbe@0 82 ["205"] = "zero_content_length",
jbe@0 83 ["304"] = true
jbe@0 84 }
jbe@0 85
jbe@154 86 -- parses URL encoded form data:
jbe@154 87 local function read_urlencoded_form(data)
jbe@154 88 local tbl = {}
jbe@154 89 for rawkey, rawvalue in string.gmatch(data, "([^?=&]*)=([^?=&]*)") do
jbe@154 90 local key = decode_uri(rawkey)
jbe@154 91 local value = decode_uri(rawvalue)
jbe@154 92 local subtbl = tbl[key]
jbe@154 93 if subtbl then
jbe@154 94 subtbl[#subtbl+1] = value
jbe@154 95 else
jbe@154 96 tbl[key] = {value}
jbe@35 97 end
jbe@35 98 end
jbe@154 99 return tbl
jbe@0 100 end
jbe@0 101
jbe@154 102 -- extracts first value from each subtable:
jbe@154 103 local function get_first_values(tbl)
jbe@154 104 local newtbl = {}
jbe@154 105 for key, subtbl in pairs(tbl) do
jbe@154 106 newtbl[key] = subtbl[1]
jbe@0 107 end
jbe@154 108 return newtbl
jbe@154 109 end
jbe@154 110
jbe@154 111 request_pt = {}
jbe@154 112 request_mt = { __index = request_pt }
jbe@154 113
jbe@154 114 function request_pt:_init(handler, options)
jbe@0 115 -- process options:
jbe@0 116 options = options or {}
jbe@0 117 do
jbe@0 118 -- named arg "static_headers" is used to create the preamble:
jbe@0 119 local s = options.static_headers
jbe@0 120 local t = {}
jbe@0 121 if s then
jbe@0 122 if type(s) == "string" then
jbe@0 123 for line in string.gmatch(s, "[^\r\n]+") do
jbe@0 124 t[#t+1] = line
jbe@0 125 end
jbe@0 126 else
jbe@0 127 for i, kv in ipairs(options.static_headers) do
jbe@0 128 if type(kv) == "string" then
jbe@0 129 t[#t+1] = kv
jbe@0 130 else
jbe@0 131 t[#t+1] = kv[1] .. ": " .. kv[2]
jbe@0 132 end
jbe@0 133 end
jbe@0 134 end
jbe@0 135 end
jbe@0 136 t[#t+1] = ""
jbe@154 137 self._preamble = table.concat(t, "\r\n") -- preamble sent with every(!) HTTP response
jbe@115 138 end
jbe@154 139 self._input_chunk_size = options.maximum_input_chunk_size or options.chunk_size or 16384
jbe@154 140 self._output_chunk_size = options.minimum_output_chunk_size or options.chunk_size or 1024
jbe@154 141 self._header_size_limit = options.header_size_limit or 1024*1024
jbe@154 142 local function init_timeout(name, default)
jbe@154 143 local value = options[name]
jbe@154 144 if value == nil then
jbe@154 145 self["_"..name] = default
jbe@154 146 else
jbe@154 147 self["_"..name] = value or 0
jbe@154 148 end
jbe@53 149 end
jbe@154 150 init_timeout("request_idle_timeout", 330)
jbe@154 151 init_timeout("request_header_timeout", 30)
jbe@154 152 init_timeout("request_body_timeout", 1800)
jbe@154 153 init_timeout("response_timeout", 1830)
jbe@154 154 self._poll = options.poll_function or moonbridge_io.poll
jbe@154 155 self:_create_closure("_write_yield")
jbe@154 156 self:_create_closure("_handler")
jbe@154 157 -- table mapping header field names to value-lists:
jbe@154 158 self._headers_mt = {
jbe@154 159 __index = function(tbl, key)
jbe@154 160 local lowerkey = string.lower(key)
jbe@154 161 local result = self._headers[lowerkey]
jbe@154 162 if result == nil then
jbe@154 163 result = {}
jbe@50 164 end
jbe@154 165 tbl[lowerkey] = result
jbe@154 166 tbl[key] = result
jbe@154 167 return result
jbe@154 168 end
jbe@154 169 }
jbe@154 170 -- table mapping header field names to value-lists
jbe@154 171 -- (for headers with comma separated values):
jbe@154 172 self._headers_csv_table_mt = {
jbe@154 173 __index = function(tbl, key)
jbe@154 174 local result = {}
jbe@154 175 for i, line in ipairs(self.headers[key]) do
jbe@154 176 for entry in string.gmatch(line, "[^,]+") do
jbe@154 177 local value = string.match(entry, "^[ \t]*(..-)[ \t]*$")
jbe@154 178 if value then
jbe@154 179 result[#result+1] = value
jbe@0 180 end
jbe@0 181 end
jbe@0 182 end
jbe@154 183 tbl[key] = result
jbe@154 184 return result
jbe@154 185 end
jbe@154 186 }
jbe@154 187 -- table mapping header field names to a comma separated string
jbe@154 188 -- (for headers with comma separated values):
jbe@154 189 self._headers_csv_string_mt = {
jbe@154 190 __index = function(tbl, key)
jbe@154 191 local result = {}
jbe@154 192 for i, line in ipairs(self.headers[key]) do
jbe@154 193 result[#result+1] = line
jbe@154 194 end
jbe@154 195 result = string.concat(result, ", ")
jbe@154 196 tbl[key] = result
jbe@154 197 return result
jbe@154 198 end
jbe@154 199 }
jbe@154 200 -- table mapping header field names to a single string value
jbe@154 201 -- (or false if header has been sent multiple times):
jbe@154 202 self._headers_value_mt = {
jbe@154 203 __index = function(tbl, key)
jbe@154 204 if self._headers_value_nil[key] then
jbe@154 205 return nil
jbe@154 206 end
jbe@154 207 local result = nil
jbe@154 208 local values = self.headers_csv_table[key]
jbe@154 209 if #values == 0 then
jbe@154 210 self._headers_value_nil[key] = true
jbe@154 211 elseif #values == 1 then
jbe@154 212 result = values[1]
jbe@154 213 else
jbe@154 214 result = false
jbe@154 215 end
jbe@154 216 tbl[key] = result
jbe@154 217 return result
jbe@154 218 end
jbe@154 219 }
jbe@154 220 -- table mapping header field names to a flag table,
jbe@154 221 -- indicating if the comma separated value contains certain entries:
jbe@154 222 self._headers_flags_mt = {
jbe@154 223 __index = function(tbl, key)
jbe@154 224 local result = setmetatable({}, {
jbe@154 225 __index = function(tbl, key)
jbe@154 226 local lowerkey = string.lower(key)
jbe@154 227 local result = rawget(tbl, lowerkey) or false
jbe@154 228 tbl[lowerkey] = result
jbe@154 229 tbl[key] = result
jbe@154 230 return result
jbe@0 231 end
jbe@154 232 })
jbe@154 233 for i, value in ipairs(self.headers_csv_table[key]) do
jbe@154 234 result[string.lower(value)] = true
jbe@0 235 end
jbe@154 236 tbl[key] = result
jbe@154 237 return result
jbe@154 238 end
jbe@154 239 }
jbe@154 240 end
jbe@154 241
jbe@154 242 function request_pt:_create_closure(name)
jbe@154 243 self[name.."_closure"] = function(...)
jbe@154 244 return self[name](self, ...)
jbe@154 245 end
jbe@154 246 end
jbe@154 247
jbe@154 248 function request_pt:_create_magictable(name)
jbe@154 249 self[name] = setmetatable({}, self["_"..name.."_mt"])
jbe@154 250 end
jbe@154 251
jbe@154 252 function request_pt:_handler(socket)
jbe@154 253 self._socket = socket
jbe@154 254 self._survive = true
jbe@154 255 self._socket_set = {[socket] = true}
jbe@154 256 self._faulty = false
jbe@154 257 self._consume_input = self._drain_input
jbe@154 258 self._headers = {}
jbe@154 259 self._headers_value_nil = {}
jbe@154 260 self:_create_magictable("headers")
jbe@154 261 self:_create_magictable("headers_csv_table")
jbe@154 262 self:_create_magictable("headers_csv_string")
jbe@154 263 self:_create_magictable("headers_value")
jbe@154 264 self:_create_magictable("headers_flags")
jbe@154 265 repeat
jbe@154 266 -- wait for input:
jbe@154 267 if not moonbridge_io.poll(self._socket_set, nil, self._request_idle_timeout) then
jbe@154 268 self:_error("408 Request Timeout", "Idle connection timed out")
jbe@154 269 return self._survive
jbe@154 270 end
jbe@154 271 -- read headers (with timeout):
jbe@154 272 do
jbe@154 273 local coro = coroutine.wrap(self._read_headers)
jbe@154 274 local timeout = self._request_header_timeout
jbe@154 275 local starttime = timeout and moonbridge_io.timeref()
jbe@154 276 while true do
jbe@154 277 local status = coro(self)
jbe@154 278 if status == nil then
jbe@154 279 local remaining
jbe@154 280 if timeout then
jbe@154 281 remaining = timeout - moonbridge_io.timeref(starttime)
jbe@0 282 end
jbe@154 283 if not self._poll(self._socket_set, nil, remaining) then
jbe@154 284 self:_error("408 Request Timeout", "Timeout while receiving headers")
jbe@154 285 return self._survive
jbe@0 286 end
jbe@154 287 elseif status == false then
jbe@154 288 return self._survive
jbe@154 289 elseif status == true then
jbe@154 290 break
jbe@154 291 else
jbe@154 292 error("Unexpected yield value")
jbe@0 293 end
jbe@0 294 end
jbe@154 295 end
jbe@154 296 until true
jbe@154 297 end
jbe@154 298
jbe@154 299 function request_pt:_error(status, explanation)
jbe@154 300 end
jbe@154 301
jbe@154 302 function request_pt:_read(...)
jbe@154 303 local line, status = self._socket:read_yield(...)
jbe@154 304 if line == nil then
jbe@154 305 self._faulty = true
jbe@154 306 error(status)
jbe@154 307 else
jbe@154 308 return line, status
jbe@154 309 end
jbe@154 310 end
jbe@154 311
jbe@154 312 function request_pt:_read_headers()
jbe@154 313 local remaining = self._header_size_limit
jbe@154 314 -- read and parse request line:
jbe@154 315 local target, proto
jbe@154 316 do
jbe@154 317 local line, status = self:_read(remaining-2, "\n")
jbe@154 318 if status == "maxlen" then
jbe@154 319 self:_error("414 Request-URI Too Long")
jbe@154 320 return false
jbe@154 321 elseif status == "eof" then
jbe@154 322 if line ~= "" then
jbe@154 323 self:_error("400 Bad Request", "Unexpected EOF in request-URI line")
jbe@115 324 end
jbe@154 325 return false
jbe@154 326 end
jbe@154 327 remaining = remaining - #line
jbe@154 328 self.method, target, proto =
jbe@154 329 line:match("^([^ \t\r]+)[ \t]+([^ \t\r]+)[ \t]*([^ \t\r]*)[ \t]*\r?\n$")
jbe@154 330 if not request.method then
jbe@154 331 self:_error("400 Bad Request", "Invalid request-URI line")
jbe@154 332 return false
jbe@154 333 elseif proto ~= "HTTP/1.1" then
jbe@154 334 self:_error("505 HTTP Version Not Supported")
jbe@154 335 return false
jbe@154 336 end
jbe@154 337 end
jbe@154 338 -- read and parse headers:
jbe@154 339 while true do
jbe@154 340 local line, status = self:_read(remaining, "\n");
jbe@154 341 if status == "maxlen" then
jbe@154 342 self:_error("431 Request Header Fields Too Large")
jbe@154 343 return false
jbe@154 344 elseif status == "eof" then
jbe@154 345 self:_error("400 Bad Request", "Unexpected EOF in request headers")
jbe@154 346 return false
jbe@154 347 end
jbe@154 348 remaining = remaining - #line
jbe@154 349 if line == "\r\n" or line == "\n" then
jbe@154 350 break
jbe@154 351 end
jbe@154 352 local key, value = string.match(line, "^([^ \t\r]+):[ \t]*(.-)[ \t]*\r?\n$")
jbe@154 353 if not key then
jbe@154 354 self:_error("400 Bad Request", "Invalid header line")
jbe@154 355 return false
jbe@154 356 end
jbe@154 357 local lowerkey = key:lower()
jbe@154 358 local values = self._headers[lowerkey]
jbe@154 359 if values then
jbe@154 360 values[#values+1] = value
jbe@154 361 else
jbe@154 362 self._headers[lowerkey] = {value}
jbe@154 363 end
jbe@154 364 end
jbe@154 365 -- process "Connection: close" header if existent:
jbe@154 366 self._connection_close_requested = self.headers_flags["Connection"]["close"]
jbe@154 367 -- process "Content-Length" header if existent:
jbe@154 368 do
jbe@154 369 local values = self.headers_csv_table["Content-Length"]
jbe@154 370 if #values > 0 then
jbe@154 371 self._request_body_content_length = tonumber(values[1])
jbe@154 372 local proper_value = tostring(request_body_content_length)
jbe@154 373 for i, value in ipairs(values) do
jbe@154 374 value = string.match(value, "^0*(.*)")
jbe@154 375 if value ~= proper_value then
jbe@154 376 self:_error("400 Bad Request", "Content-Length header(s) invalid")
jbe@154 377 return false
jbe@0 378 end
jbe@38 379 end
jbe@154 380 if request_body_content_length > self._body_size_limit then
jbe@154 381 self:_error("413 Request Entity Too Large", "Announced request body size is too big")
jbe@154 382 return false
jbe@38 383 end
jbe@154 384 end
jbe@154 385 end
jbe@154 386 -- process "Transfer-Encoding" header if existent:
jbe@154 387 do
jbe@154 388 local flag = self.headers_flags["Transfer-Encoding"]["chunked"]
jbe@154 389 local list = self.headers_csv_table["Transfer-Encoding"]
jbe@154 390 if (flag and #list ~= 1) or (not flag and #list ~= 0) then
jbe@154 391 self:_error("400 Bad Request", "Unexpected Transfer-Encoding")
jbe@154 392 return false
jbe@154 393 end
jbe@154 394 end
jbe@154 395 -- process "Expect" header if existent:
jbe@154 396 for i, value in ipairs(self.headers_csv_table["Expect"]) do
jbe@154 397 if string.lower(value) ~= "100-continue" then
jbe@154 398 self:_error("417 Expectation Failed", "Unexpected Expect header")
jbe@154 399 return false
jbe@154 400 end
jbe@154 401 end
jbe@154 402 -- get mandatory Host header according to RFC 7230:
jbe@154 403 self.host = self.headers_value["Host"]
jbe@154 404 if not self.host then
jbe@154 405 self:_error("400 Bad Request", "No valid host header")
jbe@154 406 return false
jbe@154 407 end
jbe@154 408 -- parse request target:
jbe@154 409 self.path, self.query = string.match(target, "^/([^?]*)(.*)$")
jbe@154 410 if not self.path then
jbe@154 411 local host2
jbe@154 412 host2, self.path, self.query = string.match(target, "^[Hh][Tt][Tt][Pp]://([^/?]+)/?([^?]*)(.*)$")
jbe@154 413 if host2 then
jbe@154 414 if self.host ~= host2 then
jbe@154 415 self:_error("400 Bad Request", "No valid host header")
jbe@154 416 return false
jbe@38 417 end
jbe@154 418 elseif not (target == "*" and self.method == "OPTIONS") then
jbe@154 419 self:_error("400 Bad Request", "Invalid request target")
jbe@154 420 end
jbe@154 421 end
jbe@154 422 -- parse GET params:
jbe@154 423 if self.query then
jbe@154 424 self.get_params_list = read_urlencoded_form(request.query)
jbe@154 425 self.get_params = get_first_values(self.get_params_list)
jbe@154 426 end
jbe@154 427 -- parse cookies:
jbe@154 428 for i, line in ipairs(self.headers["Cookie"]) do
jbe@154 429 for rawkey, rawvalue in
jbe@154 430 string.gmatch(line, "([^=; ]*)=([^=; ]*)")
jbe@154 431 do
jbe@154 432 self.cookies[decode_uri(rawkey)] = decode_uri(rawvalue)
jbe@154 433 end
jbe@0 434 end
jbe@0 435 end
jbe@0 436
jbe@154 437 function request_pt:_assert_not_faulty()
jbe@154 438 assert(not self._faulty, "Tried to use faulty request handle")
jbe@154 439 end
jbe@154 440
jbe@154 441 function request_pt:_write_yield()
jbe@154 442 self:_consume_input()
jbe@154 443 self._poll(self._socket_set, self._socket_set)
jbe@154 444 end
jbe@154 445
jbe@154 446 function request_pt:_write(...)
jbe@154 447 assert(self._socket:write_call(self._write_yield_closure, ...))
jbe@154 448 end
jbe@154 449
jbe@154 450 function request_pt:_flush(...)
jbe@154 451 assert(self._socket:write_call(self._write_yield_closure, ...))
jbe@154 452 end
jbe@154 453
jbe@154 454 function request_pt:_drain_input()
jbe@154 455 socket:drain_nb(self._input_chunk_size)
jbe@154 456 end
jbe@154 457
jbe@154 458
jbe@154 459 -- function creating a HTTP handler:
jbe@154 460 function generate_handler(handler, options)
jbe@154 461 -- swap arguments if necessary (for convenience):
jbe@154 462 if type(handler) ~= "function" and type(options) == "function" then
jbe@154 463 handler, options = options, handler
jbe@154 464 end
jbe@154 465 local request = setmetatable({}, request_mt)
jbe@154 466 request:_init(handler, options)
jbe@154 467 return request._handler_closure
jbe@154 468 end
jbe@154 469
jbe@0 470 return _M
jbe@0 471

Impressum / About Us