From 85193866e9f4f7af3f0dd958e05e583d8f388760 Mon Sep 17 00:00:00 2001 From: Connor O'Connor Date: Sun, 5 Oct 2025 15:44:58 -0400 Subject: [PATCH] Formatter run --- .editorconfig | 9 + .gitignore | 1 + lualib/ltn12.lua | 385 +++++++++++++----------- lualib/mime.lua | 53 ++-- lualib/socket.lua | 160 +++++----- lualib/socket/ftp.lua | 349 +++++++++++----------- lualib/socket/http.lua | 479 ++++++++++++++--------------- lualib/socket/smtp.lua | 269 +++++++++-------- lualib/socket/tp.lua | 118 ++++---- lualib/socket/url.lua | 244 ++++++++------- src/lua-env-safe.lua | 38 +-- src/lua-env.lua | 10 +- src/util/libbl-types.lua | 246 +++++++-------- src/util/libbl.lua | 630 ++++++++++++++++++++++----------------- src/util/libts-lua.lua | 95 +++--- src/util/std.lua | 231 +++++++------- src/util/vector.lua | 173 ++++++----- 17 files changed, 1865 insertions(+), 1625 deletions(-) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..1b83267 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*] +indent_style = tab +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true diff --git a/.gitignore b/.gitignore index 9ea0f13..8bc269d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .* !.gitignore +!.editorconfig diff --git a/lualib/ltn12.lua b/lualib/ltn12.lua index 7822e53..19244ba 100644 --- a/lualib/ltn12.lua +++ b/lualib/ltn12.lua @@ -27,43 +27,50 @@ _VERSION = "LTN12 1.0.1" ----------------------------------------------------------------------------- -- returns a high level filter that cycles a low-level filter function filter.cycle(low, ctx, extra) - base.assert(low) - return function(chunk) - local ret - ret, ctx = low(ctx, chunk, extra) - return ret - end + base.assert(low) + return function(chunk) + local ret + ret, ctx = low(ctx, chunk, extra) + return ret + end end -- chains a bunch of filters together -- (thanks to Wim Couwenberg) function filter.chain(...) - local n = #arg - local top, index = 1, 1 - local retry = "" - return function(chunk) - retry = chunk and retry - while true do - if index == top then - chunk = arg[index](chunk) - if chunk == "" or top == n then return chunk - elseif chunk then index = index + 1 - else - top = top+1 - index = top - end - else - chunk = arg[index](chunk or "") - if chunk == "" then - index = index - 1 - chunk = retry - elseif chunk then - if index == n then return chunk - else index = index + 1 end - else base.error("filter returned inappropriate nil") end - end - end - end + local n = #arg + local top, index = 1, 1 + local retry = "" + return function(chunk) + retry = chunk and retry + while true do + if index == top then + chunk = arg[index](chunk) + if chunk == "" or top == n then + return chunk + elseif chunk then + index = index + 1 + else + top = top + 1 + index = top + end + else + chunk = arg[index](chunk or "") + if chunk == "" then + index = index - 1 + chunk = retry + elseif chunk then + if index == n then + return chunk + else + index = index + 1 + end + else + base.error("filter returned inappropriate nil") + end + end + end + end end ----------------------------------------------------------------------------- @@ -71,130 +78,143 @@ end ----------------------------------------------------------------------------- -- create an empty source local function empty() - return nil + return nil end function source.empty() - return empty + return empty end -- returns a source that just outputs an error function source.error(err) - return function() - return nil, err - end + return function() + return nil, err + end end -- creates a file source function source.file(handle, io_err) - if handle then - return function() - local chunk = handle:read(BLOCKSIZE) - if not chunk then handle:close() end - return chunk - end - else return source.error(io_err or "unable to open file") end + if handle then + return function() + local chunk = handle:read(BLOCKSIZE) + if not chunk then handle:close() end + return chunk + end + else + return source.error(io_err or "unable to open file") + end end -- turns a fancy source into a simple source function source.simplify(src) - base.assert(src) - return function() - local chunk, err_or_new = src() - src = err_or_new or src - if not chunk then return nil, err_or_new - else return chunk end - end + base.assert(src) + return function() + local chunk, err_or_new = src() + src = err_or_new or src + if not chunk then + return nil, err_or_new + else + return chunk + end + end end -- creates string source function source.string(s) - if s then - local i = 1 - return function() - local chunk = string.sub(s, i, i+BLOCKSIZE-1) - i = i + BLOCKSIZE - if chunk ~= "" then return chunk - else return nil end - end - else return source.empty() end + if s then + local i = 1 + return function() + local chunk = string.sub(s, i, i + BLOCKSIZE - 1) + i = i + BLOCKSIZE + if chunk ~= "" then + return chunk + else + return nil + end + end + else + return source.empty() + end end -- creates rewindable source function source.rewind(src) - base.assert(src) - local t = {} - return function(chunk) - if not chunk then - chunk = table.remove(t) - if not chunk then return src() - else return chunk end - else - table.insert(t, chunk) - end - end + base.assert(src) + local t = {} + return function(chunk) + if not chunk then + chunk = table.remove(t) + if not chunk then + return src() + else + return chunk + end + else + table.insert(t, chunk) + end + end end function source.chain(src, f) - base.assert(src and f) - local last_in, last_out = "", "" - local state = "feeding" - local err - return function() - if not last_out then - base.error('source is empty!', 2) - end - while true do - if state == "feeding" then - last_in, err = src() - if err then return nil, err end - last_out = f(last_in) - if not last_out then - if last_in then - base.error('filter returned inappropriate nil') - else - return nil - end - elseif last_out ~= "" then - state = "eating" - if last_in then last_in = "" end - return last_out - end - else - last_out = f(last_in) - if last_out == "" then - if last_in == "" then - state = "feeding" - else - base.error('filter returned ""') - end - elseif not last_out then - if last_in then - base.error('filter returned inappropriate nil') - else - return nil - end - else - return last_out - end - end - end - end + base.assert(src and f) + local last_in, last_out = "", "" + local state = "feeding" + local err + return function() + if not last_out then + base.error('source is empty!', 2) + end + while true do + if state == "feeding" then + last_in, err = src() + if err then return nil, err end + last_out = f(last_in) + if not last_out then + if last_in then + base.error('filter returned inappropriate nil') + else + return nil + end + elseif last_out ~= "" then + state = "eating" + if last_in then last_in = "" end + return last_out + end + else + last_out = f(last_in) + if last_out == "" then + if last_in == "" then + state = "feeding" + else + base.error('filter returned ""') + end + elseif not last_out then + if last_in then + base.error('filter returned inappropriate nil') + else + return nil + end + else + return last_out + end + end + end + end end -- creates a source that produces contents of several sources, one after the -- other, as if they were concatenated -- (thanks to Wim Couwenberg) function source.cat(...) - local src = table.remove(arg, 1) - return function() - while src do - local chunk, err = src() - if chunk then return chunk end - if err then return nil, err end - src = table.remove(arg, 1) - end - end + local src = table.remove(arg, 1) + return function() + while src do + local chunk, err = src() + if chunk then return chunk end + if err then return nil, err end + src = table.remove(arg, 1) + end + end end ----------------------------------------------------------------------------- @@ -202,68 +222,74 @@ end ----------------------------------------------------------------------------- -- creates a sink that stores into a table function sink.table(t) - t = t or {} - local f = function(chunk, err) - if chunk then table.insert(t, chunk) end - return 1 - end - return f, t + t = t or {} + local f = function(chunk, err) + if chunk then table.insert(t, chunk) end + return 1 + end + return f, t end -- turns a fancy sink into a simple sink function sink.simplify(snk) - base.assert(snk) - return function(chunk, err) - local ret, err_or_new = snk(chunk, err) - if not ret then return nil, err_or_new end - snk = err_or_new or snk - return 1 - end + base.assert(snk) + return function(chunk, err) + local ret, err_or_new = snk(chunk, err) + if not ret then return nil, err_or_new end + snk = err_or_new or snk + return 1 + end end -- creates a file sink function sink.file(handle, io_err) - if handle then - return function(chunk, err) - if not chunk then - handle:close() - return 1 - else return handle:write(chunk) end - end - else return sink.error(io_err or "unable to open file") end + if handle then + return function(chunk, err) + if not chunk then + handle:close() + return 1 + else + return handle:write(chunk) + end + end + else + return sink.error(io_err or "unable to open file") + end end -- creates a sink that discards data local function null() - return 1 + return 1 end function sink.null() - return null + return null end -- creates a sink that just returns an error function sink.error(err) - return function() - return nil, err - end + return function() + return nil, err + end end -- chains a sink with a filter function sink.chain(f, snk) - base.assert(f and snk) - return function(chunk, err) - if chunk ~= "" then - local filtered = f(chunk) - local done = chunk and "" - while true do - local ret, snkerr = snk(filtered, err) - if not ret then return nil, snkerr end - if filtered == done then return 1 end - filtered = f(done) - end - else return 1 end - end + base.assert(f and snk) + return function(chunk, err) + if chunk ~= "" then + local filtered = f(chunk) + local done = chunk and "" + while true do + local ret, snkerr = snk(filtered, err) + if not ret then return nil, snkerr end + if filtered == done then return 1 end + filtered = f(done) + end + else + return 1 + end + end end ----------------------------------------------------------------------------- @@ -271,22 +297,27 @@ end ----------------------------------------------------------------------------- -- pumps one chunk from the source to the sink function pump.step(src, snk) - local chunk, src_err = src() - local ret, snk_err = snk(chunk, src_err) - if chunk and ret then return 1 - else return nil, src_err or snk_err end + local chunk, src_err = src() + local ret, snk_err = snk(chunk, src_err) + if chunk and ret then + return 1 + else + return nil, src_err or snk_err + end end -- pumps all data from a source to a sink, using a step function function pump.all(src, snk, step) - base.assert(src and snk) - step = step or pump.step - while true do - local ret, err = step(src, snk) - if not ret then - if err then return nil, err - else return 1 end - end - end + base.assert(src and snk) + step = step or pump.step + while true do + local ret, err = step(src, snk) + if not ret then + if err then + return nil, err + else + return 1 + end + end + end end - diff --git a/lualib/mime.lua b/lualib/mime.lua index 7fdd9ed..7290f33 100644 --- a/lualib/mime.lua +++ b/lualib/mime.lua @@ -22,53 +22,60 @@ wrapt = {} -- creates a function that chooses a filter by name from a given table local function choose(table) - return function(name, opt1, opt2) - if base.type(name) ~= "string" then - name, opt1, opt2 = "default", name, opt1 - end - local f = table[name or "nil"] - if not f then - base.error("unknown key (" .. base.tostring(name) .. ")", 3) - else return f(opt1, opt2) end - end + return function(name, opt1, opt2) + if base.type(name) ~= "string" then + name, opt1, opt2 = "default", name, opt1 + end + local f = table[name or "nil"] + if not f then + base.error("unknown key (" .. base.tostring(name) .. ")", 3) + else + return f(opt1, opt2) + end + end end -- define the encoding filters encodet['base64'] = function() - return ltn12.filter.cycle(b64, "") + return ltn12.filter.cycle(b64, "") end encodet['quoted-printable'] = function(mode) - return ltn12.filter.cycle(qp, "", - (mode == "binary") and "=0D=0A" or "\r\n") + return ltn12.filter.cycle(qp, "", + (mode == "binary") and "=0D=0A" or "\r\n") end -- define the decoding filters decodet['base64'] = function() - return ltn12.filter.cycle(unb64, "") + return ltn12.filter.cycle(unb64, "") end decodet['quoted-printable'] = function() - return ltn12.filter.cycle(unqp, "") + return ltn12.filter.cycle(unqp, "") end local function format(chunk) - if chunk then - if chunk == "" then return "''" - else return string.len(chunk) end - else return "nil" end + if chunk then + if chunk == "" then + return "''" + else + return string.len(chunk) + end + else + return "nil" + end end -- define the line-wrap filters wrapt['text'] = function(length) - length = length or 76 - return ltn12.filter.cycle(wrp, length, length) + length = length or 76 + return ltn12.filter.cycle(wrp, length, length) end wrapt['base64'] = wrapt['text'] wrapt['default'] = wrapt['text'] wrapt['quoted-printable'] = function() - return ltn12.filter.cycle(qpwrp, 76, 76) + return ltn12.filter.cycle(qpwrp, 76, 76) end -- function that choose the encoding, decoding or wrap algorithm @@ -78,10 +85,10 @@ wrap = choose(wrapt) -- define the end-of-line normalization filter function normalize(marker) - return ltn12.filter.cycle(eol, 0, marker) + return ltn12.filter.cycle(eol, 0, marker) end -- high level stuffing filter function stuff() - return ltn12.filter.cycle(dot, 2) + return ltn12.filter.cycle(dot, 2) end diff --git a/lualib/socket.lua b/lualib/socket.lua index 211adcd..b2ed37d 100644 --- a/lualib/socket.lua +++ b/lualib/socket.lua @@ -17,39 +17,42 @@ module("socket") -- Exported auxiliar functions ----------------------------------------------------------------------------- function connect(address, port, laddress, lport) - local sock, err = socket.tcp() - if not sock then return nil, err end - if laddress then - local res, err = sock:bind(laddress, lport, -1) - if not res then return nil, err end - end - local res, err = sock:connect(address, port) - if not res then return nil, err end - return sock + local sock, err = socket.tcp() + if not sock then return nil, err end + if laddress then + local res, err = sock:bind(laddress, lport, -1) + if not res then return nil, err end + end + local res, err = sock:connect(address, port) + if not res then return nil, err end + return sock end function bind(host, port, backlog) - local sock, err = socket.tcp() - if not sock then return nil, err end - sock:setoption("reuseaddr", true) - local res, err = sock:bind(host, port) - if not res then return nil, err end - res, err = sock:listen(backlog) - if not res then return nil, err end - return sock + local sock, err = socket.tcp() + if not sock then return nil, err end + sock:setoption("reuseaddr", true) + local res, err = sock:bind(host, port) + if not res then return nil, err end + res, err = sock:listen(backlog) + if not res then return nil, err end + return sock end try = newtry() function choose(table) - return function(name, opt1, opt2) - if base.type(name) ~= "string" then - name, opt1, opt2 = "default", name, opt1 - end - local f = table[name or "nil"] - if not f then base.error("unknown key (".. base.tostring(name) ..")", 3) - else return f(opt1, opt2) end - end + return function(name, opt1, opt2) + if base.type(name) ~= "string" then + name, opt1, opt2 = "default", name, opt1 + end + local f = table[name or "nil"] + if not f then + base.error("unknown key (" .. base.tostring(name) .. ")", 3) + else + return f(opt1, opt2) + end + end end ----------------------------------------------------------------------------- @@ -62,29 +65,34 @@ sinkt = {} BLOCKSIZE = 2048 sinkt["close-when-done"] = function(sock) - return base.setmetatable({ - getfd = function() return sock:getfd() end, - dirty = function() return sock:dirty() end - }, { - __call = function(self, chunk, err) - if not chunk then - sock:close() - return 1 - else return sock:send(chunk) end - end - }) + return base.setmetatable({ + getfd = function() return sock:getfd() end, + dirty = function() return sock:dirty() end + }, { + __call = function(self, chunk, err) + if not chunk then + sock:close() + return 1 + else + return sock:send(chunk) + end + end + }) end sinkt["keep-open"] = function(sock) - return base.setmetatable({ - getfd = function() return sock:getfd() end, - dirty = function() return sock:dirty() end - }, { - __call = function(self, chunk, err) - if chunk then return sock:send(chunk) - else return 1 end - end - }) + return base.setmetatable({ + getfd = function() return sock:getfd() end, + dirty = function() return sock:dirty() end + }, { + __call = function(self, chunk, err) + if chunk then + return sock:send(chunk) + else + return 1 + end + end + }) end sinkt["default"] = sinkt["keep-open"] @@ -92,42 +100,44 @@ sinkt["default"] = sinkt["keep-open"] sink = choose(sinkt) sourcet["by-length"] = function(sock, length) - return base.setmetatable({ - getfd = function() return sock:getfd() end, - dirty = function() return sock:dirty() end - }, { - __call = function() - if length <= 0 then return nil end - local size = math.min(socket.BLOCKSIZE, length) - local chunk, err = sock:receive(size) - if err then return nil, err end - length = length - string.len(chunk) - return chunk - end - }) + return base.setmetatable({ + getfd = function() return sock:getfd() end, + dirty = function() return sock:dirty() end + }, { + __call = function() + if length <= 0 then return nil end + local size = math.min(socket.BLOCKSIZE, length) + local chunk, err = sock:receive(size) + if err then return nil, err end + length = length - string.len(chunk) + return chunk + end + }) end sourcet["until-closed"] = function(sock) - local done - return base.setmetatable({ - getfd = function() return sock:getfd() end, - dirty = function() return sock:dirty() end - }, { - __call = function() - if done then return nil end - local chunk, err, partial = sock:receive(socket.BLOCKSIZE) - if not err then return chunk - elseif err == "closed" then - sock:close() - done = 1 - return partial - else return nil, err end - end - }) + local done + return base.setmetatable({ + getfd = function() return sock:getfd() end, + dirty = function() return sock:dirty() end + }, { + __call = function() + if done then return nil end + local chunk, err, partial = sock:receive(socket.BLOCKSIZE) + if not err then + return chunk + elseif err == "closed" then + sock:close() + done = 1 + return partial + else + return nil, err + end + end + }) end sourcet["default"] = sourcet["until-closed"] source = choose(sourcet) - diff --git a/lualib/socket/ftp.lua b/lualib/socket/ftp.lua index 598f65d..1d70f44 100644 --- a/lualib/socket/ftp.lua +++ b/lualib/socket/ftp.lua @@ -36,179 +36,181 @@ PASSWORD = "anonymous@anonymous.org" local metat = { __index = {} } function open(server, port, create) - local tp = socket.try(tp.connect(server, port or PORT, TIMEOUT, create)) - local f = base.setmetatable({ tp = tp }, metat) - -- make sure everything gets closed in an exception - f.try = socket.newtry(function() f:close() end) - return f + local tp = socket.try(tp.connect(server, port or PORT, TIMEOUT, create)) + local f = base.setmetatable({ tp = tp }, metat) + -- make sure everything gets closed in an exception + f.try = socket.newtry(function() f:close() end) + return f end function metat.__index:portconnect() - self.try(self.server:settimeout(TIMEOUT)) - self.data = self.try(self.server:accept()) - self.try(self.data:settimeout(TIMEOUT)) + self.try(self.server:settimeout(TIMEOUT)) + self.data = self.try(self.server:accept()) + self.try(self.data:settimeout(TIMEOUT)) end function metat.__index:pasvconnect() - self.data = self.try(socket.tcp()) - self.try(self.data:settimeout(TIMEOUT)) - self.try(self.data:connect(self.pasvt.ip, self.pasvt.port)) + self.data = self.try(socket.tcp()) + self.try(self.data:settimeout(TIMEOUT)) + self.try(self.data:connect(self.pasvt.ip, self.pasvt.port)) end function metat.__index:login(user, password) - self.try(self.tp:command("user", user or USER)) - local code, reply = self.try(self.tp:check{"2..", 331}) - if code == 331 then - self.try(self.tp:command("pass", password or PASSWORD)) - self.try(self.tp:check("2..")) - end - return 1 + self.try(self.tp:command("user", user or USER)) + local code, reply = self.try(self.tp:check { "2..", 331 }) + if code == 331 then + self.try(self.tp:command("pass", password or PASSWORD)) + self.try(self.tp:check("2..")) + end + return 1 end function metat.__index:pasv() - self.try(self.tp:command("pasv")) - local code, reply = self.try(self.tp:check("2..")) - local pattern = "(%d+)%D(%d+)%D(%d+)%D(%d+)%D(%d+)%D(%d+)" - local a, b, c, d, p1, p2 = socket.skip(2, string.find(reply, pattern)) - self.try(a and b and c and d and p1 and p2, reply) - self.pasvt = { - ip = string.format("%d.%d.%d.%d", a, b, c, d), - port = p1*256 + p2 - } - if self.server then - self.server:close() - self.server = nil - end - return self.pasvt.ip, self.pasvt.port + self.try(self.tp:command("pasv")) + local code, reply = self.try(self.tp:check("2..")) + local pattern = "(%d+)%D(%d+)%D(%d+)%D(%d+)%D(%d+)%D(%d+)" + local a, b, c, d, p1, p2 = socket.skip(2, string.find(reply, pattern)) + self.try(a and b and c and d and p1 and p2, reply) + self.pasvt = { + ip = string.format("%d.%d.%d.%d", a, b, c, d), + port = p1 * 256 + p2 + } + if self.server then + self.server:close() + self.server = nil + end + return self.pasvt.ip, self.pasvt.port end function metat.__index:port(ip, port) - self.pasvt = nil - if not ip then - ip, port = self.try(self.tp:getcontrol():getsockname()) - self.server = self.try(socket.bind(ip, 0)) - ip, port = self.try(self.server:getsockname()) - self.try(self.server:settimeout(TIMEOUT)) - end - local pl = math.mod(port, 256) - local ph = (port - pl)/256 - local arg = string.gsub(string.format("%s,%d,%d", ip, ph, pl), "%.", ",") - self.try(self.tp:command("port", arg)) - self.try(self.tp:check("2..")) - return 1 + self.pasvt = nil + if not ip then + ip, port = self.try(self.tp:getcontrol():getsockname()) + self.server = self.try(socket.bind(ip, 0)) + ip, port = self.try(self.server:getsockname()) + self.try(self.server:settimeout(TIMEOUT)) + end + local pl = math.mod(port, 256) + local ph = (port - pl) / 256 + local arg = string.gsub(string.format("%s,%d,%d", ip, ph, pl), "%.", ",") + self.try(self.tp:command("port", arg)) + self.try(self.tp:check("2..")) + return 1 end function metat.__index:send(sendt) - self.try(self.pasvt or self.server, "need port or pasv first") - -- if there is a pasvt table, we already sent a PASV command - -- we just get the data connection into self.data - if self.pasvt then self:pasvconnect() end - -- get the transfer argument and command - local argument = sendt.argument or - url.unescape(string.gsub(sendt.path or "", "^[/\\]", "")) - if argument == "" then argument = nil end - local command = sendt.command or "stor" - -- send the transfer command and check the reply - self.try(self.tp:command(command, argument)) - local code, reply = self.try(self.tp:check{"2..", "1.."}) - -- if there is not a a pasvt table, then there is a server - -- and we already sent a PORT command - if not self.pasvt then self:portconnect() end - -- get the sink, source and step for the transfer - local step = sendt.step or ltn12.pump.step - local readt = {self.tp.c} - local checkstep = function(src, snk) - -- check status in control connection while downloading - local readyt = socket.select(readt, nil, 0) - if readyt[tp] then code = self.try(self.tp:check("2..")) end - return step(src, snk) - end - local sink = socket.sink("close-when-done", self.data) - -- transfer all data and check error - self.try(ltn12.pump.all(sendt.source, sink, checkstep)) - if string.find(code, "1..") then self.try(self.tp:check("2..")) end - -- done with data connection - self.data:close() - -- find out how many bytes were sent - local sent = socket.skip(1, self.data:getstats()) - self.data = nil - return sent + self.try(self.pasvt or self.server, "need port or pasv first") + -- if there is a pasvt table, we already sent a PASV command + -- we just get the data connection into self.data + if self.pasvt then self:pasvconnect() end + -- get the transfer argument and command + local argument = sendt.argument or + url.unescape(string.gsub(sendt.path or "", "^[/\\]", "")) + if argument == "" then argument = nil end + local command = sendt.command or "stor" + -- send the transfer command and check the reply + self.try(self.tp:command(command, argument)) + local code, reply = self.try(self.tp:check { "2..", "1.." }) + -- if there is not a a pasvt table, then there is a server + -- and we already sent a PORT command + if not self.pasvt then self:portconnect() end + -- get the sink, source and step for the transfer + local step = sendt.step or ltn12.pump.step + local readt = { self.tp.c } + local checkstep = function(src, snk) + -- check status in control connection while downloading + local readyt = socket.select(readt, nil, 0) + if readyt[tp] then code = self.try(self.tp:check("2..")) end + return step(src, snk) + end + local sink = socket.sink("close-when-done", self.data) + -- transfer all data and check error + self.try(ltn12.pump.all(sendt.source, sink, checkstep)) + if string.find(code, "1..") then self.try(self.tp:check("2..")) end + -- done with data connection + self.data:close() + -- find out how many bytes were sent + local sent = socket.skip(1, self.data:getstats()) + self.data = nil + return sent end function metat.__index:receive(recvt) - self.try(self.pasvt or self.server, "need port or pasv first") - if self.pasvt then self:pasvconnect() end - local argument = recvt.argument or - url.unescape(string.gsub(recvt.path or "", "^[/\\]", "")) - if argument == "" then argument = nil end - local command = recvt.command or "retr" - self.try(self.tp:command(command, argument)) - local code = self.try(self.tp:check{"1..", "2.."}) - if not self.pasvt then self:portconnect() end - local source = socket.source("until-closed", self.data) - local step = recvt.step or ltn12.pump.step - self.try(ltn12.pump.all(source, recvt.sink, step)) - if string.find(code, "1..") then self.try(self.tp:check("2..")) end - self.data:close() - self.data = nil - return 1 + self.try(self.pasvt or self.server, "need port or pasv first") + if self.pasvt then self:pasvconnect() end + local argument = recvt.argument or + url.unescape(string.gsub(recvt.path or "", "^[/\\]", "")) + if argument == "" then argument = nil end + local command = recvt.command or "retr" + self.try(self.tp:command(command, argument)) + local code = self.try(self.tp:check { "1..", "2.." }) + if not self.pasvt then self:portconnect() end + local source = socket.source("until-closed", self.data) + local step = recvt.step or ltn12.pump.step + self.try(ltn12.pump.all(source, recvt.sink, step)) + if string.find(code, "1..") then self.try(self.tp:check("2..")) end + self.data:close() + self.data = nil + return 1 end function metat.__index:cwd(dir) - self.try(self.tp:command("cwd", dir)) - self.try(self.tp:check(250)) - return 1 + self.try(self.tp:command("cwd", dir)) + self.try(self.tp:check(250)) + return 1 end function metat.__index:type(type) - self.try(self.tp:command("type", type)) - self.try(self.tp:check(200)) - return 1 + self.try(self.tp:command("type", type)) + self.try(self.tp:check(200)) + return 1 end function metat.__index:greet() - local code = self.try(self.tp:check{"1..", "2.."}) - if string.find(code, "1..") then self.try(self.tp:check("2..")) end - return 1 + local code = self.try(self.tp:check { "1..", "2.." }) + if string.find(code, "1..") then self.try(self.tp:check("2..")) end + return 1 end function metat.__index:quit() - self.try(self.tp:command("quit")) - self.try(self.tp:check("2..")) - return 1 + self.try(self.tp:command("quit")) + self.try(self.tp:check("2..")) + return 1 end function metat.__index:close() - if self.data then self.data:close() end - if self.server then self.server:close() end - return self.tp:close() + if self.data then self.data:close() end + if self.server then self.server:close() end + return self.tp:close() end ----------------------------------------------------------------------------- -- High level FTP API ----------------------------------------------------------------------------- local function override(t) - if t.url then - local u = url.parse(t.url) - for i,v in base.pairs(t) do - u[i] = v - end - return u - else return t end + if t.url then + local u = url.parse(t.url) + for i, v in base.pairs(t) do + u[i] = v + end + return u + else + return t + end end local function tput(putt) - putt = override(putt) - socket.try(putt.host, "missing hostname") - local f = open(putt.host, putt.port, putt.create) - f:greet() - f:login(putt.user, putt.password) - if putt.type then f:type(putt.type) end - f:pasv() - local sent = f:send(putt) - f:quit() - f:close() - return sent + putt = override(putt) + socket.try(putt.host, "missing hostname") + local f = open(putt.host, putt.port, putt.create) + f:greet() + f:login(putt.user, putt.password) + if putt.type then f:type(putt.type) end + f:pasv() + local sent = f:send(putt) + f:quit() + f:close() + return sent end local default = { @@ -217,65 +219,70 @@ local default = { } local function parse(u) - local t = socket.try(url.parse(u, default)) - socket.try(t.scheme == "ftp", "wrong scheme '" .. t.scheme .. "'") - socket.try(t.host, "missing hostname") - local pat = "^type=(.)$" - if t.params then - t.type = socket.skip(2, string.find(t.params, pat)) - socket.try(t.type == "a" or t.type == "i", - "invalid type '" .. t.type .. "'") - end - return t + local t = socket.try(url.parse(u, default)) + socket.try(t.scheme == "ftp", "wrong scheme '" .. t.scheme .. "'") + socket.try(t.host, "missing hostname") + local pat = "^type=(.)$" + if t.params then + t.type = socket.skip(2, string.find(t.params, pat)) + socket.try(t.type == "a" or t.type == "i", + "invalid type '" .. t.type .. "'") + end + return t end local function sput(u, body) - local putt = parse(u) - putt.source = ltn12.source.string(body) - return tput(putt) + local putt = parse(u) + putt.source = ltn12.source.string(body) + return tput(putt) end put = socket.protect(function(putt, body) - if base.type(putt) == "string" then return sput(putt, body) - else return tput(putt) end + if base.type(putt) == "string" then + return sput(putt, body) + else + return tput(putt) + end end) local function tget(gett) - gett = override(gett) - socket.try(gett.host, "missing hostname") - local f = open(gett.host, gett.port, gett.create) - f:greet() - f:login(gett.user, gett.password) - if gett.type then f:type(gett.type) end - f:pasv() - f:receive(gett) - f:quit() - return f:close() + gett = override(gett) + socket.try(gett.host, "missing hostname") + local f = open(gett.host, gett.port, gett.create) + f:greet() + f:login(gett.user, gett.password) + if gett.type then f:type(gett.type) end + f:pasv() + f:receive(gett) + f:quit() + return f:close() end local function sget(u) - local gett = parse(u) - local t = {} - gett.sink = ltn12.sink.table(t) - tget(gett) - return table.concat(t) + local gett = parse(u) + local t = {} + gett.sink = ltn12.sink.table(t) + tget(gett) + return table.concat(t) end command = socket.protect(function(cmdt) - cmdt = override(cmdt) - socket.try(cmdt.host, "missing hostname") - socket.try(cmdt.command, "missing command") - local f = open(cmdt.host, cmdt.port, cmdt.create) - f:greet() - f:login(cmdt.user, cmdt.password) - f.try(f.tp:command(cmdt.command, cmdt.argument)) - if cmdt.check then f.try(f.tp:check(cmdt.check)) end - f:quit() - return f:close() + cmdt = override(cmdt) + socket.try(cmdt.host, "missing hostname") + socket.try(cmdt.command, "missing command") + local f = open(cmdt.host, cmdt.port, cmdt.create) + f:greet() + f:login(cmdt.user, cmdt.password) + f.try(f.tp:command(cmdt.command, cmdt.argument)) + if cmdt.check then f.try(f.tp:check(cmdt.check)) end + f:quit() + return f:close() end) get = socket.protect(function(gett) - if base.type(gett) == "string" then return sget(gett) - else return tget(gett) end + if base.type(gett) == "string" then + return sget(gett) + else + return tget(gett) + end end) - diff --git a/lualib/socket/http.lua b/lualib/socket/http.lua index c020d8e..d9d0696 100644 --- a/lualib/socket/http.lua +++ b/lualib/socket/http.lua @@ -31,73 +31,76 @@ USERAGENT = socket._VERSION -- Reads MIME headers from a connection, unfolding where needed ----------------------------------------------------------------------------- local function receiveheaders(sock, headers) - local line, name, value, err - headers = headers or {} - -- get first line - line, err = sock:receive() - if err then return nil, err end - -- headers go until a blank line is found - while line ~= "" do - -- get field-name and value - name, value = socket.skip(2, string.find(line, "^(.-):%s*(.*)")) - if not (name and value) then return nil, "malformed reponse headers" end - name = string.lower(name) - -- get next line (value might be folded) - line, err = sock:receive() - if err then return nil, err end - -- unfold any folded values - while string.find(line, "^%s") do - value = value .. line - line = sock:receive() - if err then return nil, err end - end - -- save pair in table - if headers[name] then headers[name] = headers[name] .. ", " .. value - else headers[name] = value end - end - return headers + local line, name, value, err + headers = headers or {} + -- get first line + line, err = sock:receive() + if err then return nil, err end + -- headers go until a blank line is found + while line ~= "" do + -- get field-name and value + name, value = socket.skip(2, string.find(line, "^(.-):%s*(.*)")) + if not (name and value) then return nil, "malformed reponse headers" end + name = string.lower(name) + -- get next line (value might be folded) + line, err = sock:receive() + if err then return nil, err end + -- unfold any folded values + while string.find(line, "^%s") do + value = value .. line + line = sock:receive() + if err then return nil, err end + end + -- save pair in table + if headers[name] then + headers[name] = headers[name] .. ", " .. value + else + headers[name] = value + end + end + return headers end ----------------------------------------------------------------------------- -- Extra sources and sinks ----------------------------------------------------------------------------- socket.sourcet["http-chunked"] = function(sock, headers) - return base.setmetatable({ - getfd = function() return sock:getfd() end, - dirty = function() return sock:dirty() end - }, { - __call = function() - -- get chunk size, skip extention - local line, err = sock:receive() - if err then return nil, err end - local size = base.tonumber(string.gsub(line, ";.*", ""), 16) - if not size then return nil, "invalid chunk size" end - -- was it the last chunk? - if size > 0 then - -- if not, get chunk and skip terminating CRLF - local chunk, err, part = sock:receive(size) - if chunk then sock:receive() end - return chunk, err - else - -- if it was, read trailers into headers table - headers, err = receiveheaders(sock, headers) - if not headers then return nil, err end - end - end - }) + return base.setmetatable({ + getfd = function() return sock:getfd() end, + dirty = function() return sock:dirty() end + }, { + __call = function() + -- get chunk size, skip extention + local line, err = sock:receive() + if err then return nil, err end + local size = base.tonumber(string.gsub(line, ";.*", ""), 16) + if not size then return nil, "invalid chunk size" end + -- was it the last chunk? + if size > 0 then + -- if not, get chunk and skip terminating CRLF + local chunk, err, part = sock:receive(size) + if chunk then sock:receive() end + return chunk, err + else + -- if it was, read trailers into headers table + headers, err = receiveheaders(sock, headers) + if not headers then return nil, err end + end + end + }) end socket.sinkt["http-chunked"] = function(sock) - return base.setmetatable({ - getfd = function() return sock:getfd() end, - dirty = function() return sock:dirty() end - }, { - __call = function(self, chunk, err) - if not chunk then return sock:send("0\r\n\r\n") end - local size = string.format("%X\r\n", string.len(chunk)) - return sock:send(size .. chunk .. "\r\n") - end - }) + return base.setmetatable({ + getfd = function() return sock:getfd() end, + dirty = function() return sock:dirty() end + }, { + __call = function(self, chunk, err) + if not chunk then return sock:send("0\r\n\r\n") end + local size = string.format("%X\r\n", string.len(chunk)) + return sock:send(size .. chunk .. "\r\n") + end + }) end ----------------------------------------------------------------------------- @@ -106,245 +109,251 @@ end local metat = { __index = {} } function open(host, port, create) - -- create socket with user connect function, or with default - local c = socket.try((create or socket.tcp)()) - local h = base.setmetatable({ c = c }, metat) - -- create finalized try - h.try = socket.newtry(function() h:close() end) - -- set timeout before connecting - h.try(c:settimeout(TIMEOUT)) - h.try(c:connect(host, port or PORT)) - -- here everything worked - return h + -- create socket with user connect function, or with default + local c = socket.try((create or socket.tcp)()) + local h = base.setmetatable({ c = c }, metat) + -- create finalized try + h.try = socket.newtry(function() h:close() end) + -- set timeout before connecting + h.try(c:settimeout(TIMEOUT)) + h.try(c:connect(host, port or PORT)) + -- here everything worked + return h end function metat.__index:sendrequestline(method, uri) - local reqline = string.format("%s %s HTTP/1.1\r\n", method or "GET", uri) - return self.try(self.c:send(reqline)) + local reqline = string.format("%s %s HTTP/1.1\r\n", method or "GET", uri) + return self.try(self.c:send(reqline)) end function metat.__index:sendheaders(headers) - local h = "\r\n" - for i, v in base.pairs(headers) do - h = i .. ": " .. v .. "\r\n" .. h - end - self.try(self.c:send(h)) - return 1 + local h = "\r\n" + for i, v in base.pairs(headers) do + h = i .. ": " .. v .. "\r\n" .. h + end + self.try(self.c:send(h)) + return 1 end function metat.__index:sendbody(headers, source, step) - source = source or ltn12.source.empty() - step = step or ltn12.pump.step - -- if we don't know the size in advance, send chunked and hope for the best - local mode = "http-chunked" - if headers["content-length"] then mode = "keep-open" end - return self.try(ltn12.pump.all(source, socket.sink(mode, self.c), step)) + source = source or ltn12.source.empty() + step = step or ltn12.pump.step + -- if we don't know the size in advance, send chunked and hope for the best + local mode = "http-chunked" + if headers["content-length"] then mode = "keep-open" end + return self.try(ltn12.pump.all(source, socket.sink(mode, self.c), step)) end function metat.__index:receivestatusline() - local status = self.try(self.c:receive(5)) - -- identify HTTP/0.9 responses, which do not contain a status line - -- this is just a heuristic, but is what the RFC recommends - if status ~= "HTTP/" then return nil, status end - -- otherwise proceed reading a status line - status = self.try(self.c:receive("*l", status)) - local code = socket.skip(2, string.find(status, "HTTP/%d*%.%d* (%d%d%d)")) - return self.try(base.tonumber(code), status) + local status = self.try(self.c:receive(5)) + -- identify HTTP/0.9 responses, which do not contain a status line + -- this is just a heuristic, but is what the RFC recommends + if status ~= "HTTP/" then return nil, status end + -- otherwise proceed reading a status line + status = self.try(self.c:receive("*l", status)) + local code = socket.skip(2, string.find(status, "HTTP/%d*%.%d* (%d%d%d)")) + return self.try(base.tonumber(code), status) end function metat.__index:receiveheaders() - return self.try(receiveheaders(self.c)) + return self.try(receiveheaders(self.c)) end function metat.__index:receivebody(headers, sink, step) - sink = sink or ltn12.sink.null() - step = step or ltn12.pump.step - local length = base.tonumber(headers["content-length"]) - local t = headers["transfer-encoding"] -- shortcut - local mode = "default" -- connection close - if t and t ~= "identity" then mode = "http-chunked" - elseif base.tonumber(headers["content-length"]) then mode = "by-length" end - return self.try(ltn12.pump.all(socket.source(mode, self.c, length), - sink, step)) + sink = sink or ltn12.sink.null() + step = step or ltn12.pump.step + local length = base.tonumber(headers["content-length"]) + local t = headers["transfer-encoding"] -- shortcut + local mode = "default" -- connection close + if t and t ~= "identity" then + mode = "http-chunked" + elseif base.tonumber(headers["content-length"]) then + mode = "by-length" + end + return self.try(ltn12.pump.all(socket.source(mode, self.c, length), + sink, step)) end function metat.__index:receive09body(status, sink, step) - local source = ltn12.source.rewind(socket.source("until-closed", self.c)) - source(status) - return self.try(ltn12.pump.all(source, sink, step)) + local source = ltn12.source.rewind(socket.source("until-closed", self.c)) + source(status) + return self.try(ltn12.pump.all(source, sink, step)) end function metat.__index:close() - return self.c:close() + return self.c:close() end ----------------------------------------------------------------------------- -- High level HTTP API ----------------------------------------------------------------------------- local function adjusturi(reqt) - local u = reqt - -- if there is a proxy, we need the full url. otherwise, just a part. - if not reqt.proxy and not PROXY then - u = { - path = socket.try(reqt.path, "invalid path 'nil'"), - params = reqt.params, - query = reqt.query, - fragment = reqt.fragment - } - end - return url.build(u) + local u = reqt + -- if there is a proxy, we need the full url. otherwise, just a part. + if not reqt.proxy and not PROXY then + u = { + path = socket.try(reqt.path, "invalid path 'nil'"), + params = reqt.params, + query = reqt.query, + fragment = reqt.fragment + } + end + return url.build(u) end local function adjustproxy(reqt) - local proxy = reqt.proxy or PROXY - if proxy then - proxy = url.parse(proxy) - return proxy.host, proxy.port or 3128 - else - return reqt.host, reqt.port - end + local proxy = reqt.proxy or PROXY + if proxy then + proxy = url.parse(proxy) + return proxy.host, proxy.port or 3128 + else + return reqt.host, reqt.port + end end local function adjustheaders(reqt) - -- default headers - local lower = { - ["user-agent"] = USERAGENT, - ["host"] = reqt.host, - ["connection"] = "close, TE", - ["te"] = "trailers" - } - -- if we have authentication information, pass it along - if reqt.user and reqt.password then - lower["authorization"] = - "Basic " .. (mime.b64(reqt.user .. ":" .. reqt.password)) - end - -- override with user headers - for i,v in base.pairs(reqt.headers or lower) do - lower[string.lower(i)] = v - end - return lower + -- default headers + local lower = { + ["user-agent"] = USERAGENT, + ["host"] = reqt.host, + ["connection"] = "close, TE", + ["te"] = "trailers" + } + -- if we have authentication information, pass it along + if reqt.user and reqt.password then + lower["authorization"] = + "Basic " .. (mime.b64(reqt.user .. ":" .. reqt.password)) + end + -- override with user headers + for i, v in base.pairs(reqt.headers or lower) do + lower[string.lower(i)] = v + end + return lower end -- default url parts local default = { - host = "", - port = PORT, - path ="/", - scheme = "http" + host = "", + port = PORT, + path = "/", + scheme = "http" } local function adjustrequest(reqt) - -- parse url if provided - local nreqt = reqt.url and url.parse(reqt.url, default) or {} - -- explicit components override url - for i,v in base.pairs(reqt) do nreqt[i] = v end - if nreqt.port == "" then nreqt.port = 80 end - socket.try(nreqt.host and nreqt.host ~= "", - "invalid host '" .. base.tostring(nreqt.host) .. "'") - -- compute uri if user hasn't overriden - nreqt.uri = reqt.uri or adjusturi(nreqt) - -- ajust host and port if there is a proxy - nreqt.host, nreqt.port = adjustproxy(nreqt) - -- adjust headers in request - nreqt.headers = adjustheaders(nreqt) - return nreqt + -- parse url if provided + local nreqt = reqt.url and url.parse(reqt.url, default) or {} + -- explicit components override url + for i, v in base.pairs(reqt) do nreqt[i] = v end + if nreqt.port == "" then nreqt.port = 80 end + socket.try(nreqt.host and nreqt.host ~= "", + "invalid host '" .. base.tostring(nreqt.host) .. "'") + -- compute uri if user hasn't overriden + nreqt.uri = reqt.uri or adjusturi(nreqt) + -- ajust host and port if there is a proxy + nreqt.host, nreqt.port = adjustproxy(nreqt) + -- adjust headers in request + nreqt.headers = adjustheaders(nreqt) + return nreqt end local function shouldredirect(reqt, code, headers) - return headers.location and - string.gsub(headers.location, "%s", "") ~= "" and - (reqt.redirect ~= false) and - (code == 301 or code == 302) and - (not reqt.method or reqt.method == "GET" or reqt.method == "HEAD") - and (not reqt.nredirects or reqt.nredirects < 5) + return headers.location and + string.gsub(headers.location, "%s", "") ~= "" and + (reqt.redirect ~= false) and + (code == 301 or code == 302) and + (not reqt.method or reqt.method == "GET" or reqt.method == "HEAD") + and (not reqt.nredirects or reqt.nredirects < 5) end local function shouldreceivebody(reqt, code) - if reqt.method == "HEAD" then return nil end - if code == 204 or code == 304 then return nil end - if code >= 100 and code < 200 then return nil end - return 1 + if reqt.method == "HEAD" then return nil end + if code == 204 or code == 304 then return nil end + if code >= 100 and code < 200 then return nil end + return 1 end -- forward declarations local trequest, tredirect function tredirect(reqt, location) - local result, code, headers, status = trequest { - -- the RFC says the redirect URL has to be absolute, but some - -- servers do not respect that - url = url.absolute(reqt.url, location), - source = reqt.source, - sink = reqt.sink, - headers = reqt.headers, - proxy = reqt.proxy, - nredirects = (reqt.nredirects or 0) + 1, - create = reqt.create - } - -- pass location header back as a hint we redirected - headers = headers or {} - headers.location = headers.location or location - return result, code, headers, status + local result, code, headers, status = trequest { + -- the RFC says the redirect URL has to be absolute, but some + -- servers do not respect that + url = url.absolute(reqt.url, location), + source = reqt.source, + sink = reqt.sink, + headers = reqt.headers, + proxy = reqt.proxy, + nredirects = (reqt.nredirects or 0) + 1, + create = reqt.create + } + -- pass location header back as a hint we redirected + headers = headers or {} + headers.location = headers.location or location + return result, code, headers, status end function trequest(reqt) - -- we loop until we get what we want, or - -- until we are sure there is no way to get it - local nreqt = adjustrequest(reqt) - local h = open(nreqt.host, nreqt.port, nreqt.create) - -- send request line and headers - h:sendrequestline(nreqt.method, nreqt.uri) - h:sendheaders(nreqt.headers) - -- if there is a body, send it - if nreqt.source then - h:sendbody(nreqt.headers, nreqt.source, nreqt.step) - end - local code, status = h:receivestatusline() - -- if it is an HTTP/0.9 server, simply get the body and we are done - if not code then - h:receive09body(status, nreqt.sink, nreqt.step) - return 1, 200 - end - local headers - -- ignore any 100-continue messages - while code == 100 do - headers = h:receiveheaders() - code, status = h:receivestatusline() - end - headers = h:receiveheaders() - -- at this point we should have a honest reply from the server - -- we can't redirect if we already used the source, so we report the error - if shouldredirect(nreqt, code, headers) and not nreqt.source then - h:close() - return tredirect(reqt, headers.location) - end - -- here we are finally done - if shouldreceivebody(nreqt, code) then - h:receivebody(headers, nreqt.sink, nreqt.step) - end - h:close() - return 1, code, headers, status + -- we loop until we get what we want, or + -- until we are sure there is no way to get it + local nreqt = adjustrequest(reqt) + local h = open(nreqt.host, nreqt.port, nreqt.create) + -- send request line and headers + h:sendrequestline(nreqt.method, nreqt.uri) + h:sendheaders(nreqt.headers) + -- if there is a body, send it + if nreqt.source then + h:sendbody(nreqt.headers, nreqt.source, nreqt.step) + end + local code, status = h:receivestatusline() + -- if it is an HTTP/0.9 server, simply get the body and we are done + if not code then + h:receive09body(status, nreqt.sink, nreqt.step) + return 1, 200 + end + local headers + -- ignore any 100-continue messages + while code == 100 do + headers = h:receiveheaders() + code, status = h:receivestatusline() + end + headers = h:receiveheaders() + -- at this point we should have a honest reply from the server + -- we can't redirect if we already used the source, so we report the error + if shouldredirect(nreqt, code, headers) and not nreqt.source then + h:close() + return tredirect(reqt, headers.location) + end + -- here we are finally done + if shouldreceivebody(nreqt, code) then + h:receivebody(headers, nreqt.sink, nreqt.step) + end + h:close() + return 1, code, headers, status end local function srequest(u, b) - local t = {} - local reqt = { - url = u, - sink = ltn12.sink.table(t) - } - if b then - reqt.source = ltn12.source.string(b) - reqt.headers = { - ["content-length"] = string.len(b), - ["content-type"] = "application/x-www-form-urlencoded" - } - reqt.method = "POST" - end - local code, headers, status = socket.skip(1, trequest(reqt)) - return table.concat(t), code, headers, status + local t = {} + local reqt = { + url = u, + sink = ltn12.sink.table(t) + } + if b then + reqt.source = ltn12.source.string(b) + reqt.headers = { + ["content-length"] = string.len(b), + ["content-type"] = "application/x-www-form-urlencoded" + } + reqt.method = "POST" + end + local code, headers, status = socket.skip(1, trequest(reqt)) + return table.concat(t), code, headers, status end request = socket.protect(function(reqt, body) - if base.type(reqt) == "string" then return srequest(reqt, body) - else return trequest(reqt) end + if base.type(reqt) == "string" then + return srequest(reqt, body) + else + return trequest(reqt) + end end) diff --git a/lualib/socket/smtp.lua b/lualib/socket/smtp.lua index 8f3cfcf..a5d1ac1 100644 --- a/lualib/socket/smtp.lua +++ b/lualib/socket/smtp.lua @@ -40,95 +40,95 @@ ZONE = "-0000" local metat = { __index = {} } function metat.__index:greet(domain) - self.try(self.tp:check("2..")) - self.try(self.tp:command("EHLO", domain or DOMAIN)) - return socket.skip(1, self.try(self.tp:check("2.."))) + self.try(self.tp:check("2..")) + self.try(self.tp:command("EHLO", domain or DOMAIN)) + return socket.skip(1, self.try(self.tp:check("2.."))) end function metat.__index:mail(from) - self.try(self.tp:command("MAIL", "FROM:" .. from)) - return self.try(self.tp:check("2..")) + self.try(self.tp:command("MAIL", "FROM:" .. from)) + return self.try(self.tp:check("2..")) end function metat.__index:rcpt(to) - self.try(self.tp:command("RCPT", "TO:" .. to)) - return self.try(self.tp:check("2..")) + self.try(self.tp:command("RCPT", "TO:" .. to)) + return self.try(self.tp:check("2..")) end function metat.__index:data(src, step) - self.try(self.tp:command("DATA")) - self.try(self.tp:check("3..")) - self.try(self.tp:source(src, step)) - self.try(self.tp:send("\r\n.\r\n")) - return self.try(self.tp:check("2..")) + self.try(self.tp:command("DATA")) + self.try(self.tp:check("3..")) + self.try(self.tp:source(src, step)) + self.try(self.tp:send("\r\n.\r\n")) + return self.try(self.tp:check("2..")) end function metat.__index:quit() - self.try(self.tp:command("QUIT")) - return self.try(self.tp:check("2..")) + self.try(self.tp:command("QUIT")) + return self.try(self.tp:check("2..")) end function metat.__index:close() - return self.tp:close() + return self.tp:close() end function metat.__index:login(user, password) - self.try(self.tp:command("AUTH", "LOGIN")) - self.try(self.tp:check("3..")) - self.try(self.tp:command(mime.b64(user))) - self.try(self.tp:check("3..")) - self.try(self.tp:command(mime.b64(password))) - return self.try(self.tp:check("2..")) + self.try(self.tp:command("AUTH", "LOGIN")) + self.try(self.tp:check("3..")) + self.try(self.tp:command(mime.b64(user))) + self.try(self.tp:check("3..")) + self.try(self.tp:command(mime.b64(password))) + return self.try(self.tp:check("2..")) end function metat.__index:plain(user, password) - local auth = "PLAIN " .. mime.b64("\0" .. user .. "\0" .. password) - self.try(self.tp:command("AUTH", auth)) - return self.try(self.tp:check("2..")) + local auth = "PLAIN " .. mime.b64("\0" .. user .. "\0" .. password) + self.try(self.tp:command("AUTH", auth)) + return self.try(self.tp:check("2..")) end function metat.__index:auth(user, password, ext) - if not user or not password then return 1 end - if string.find(ext, "AUTH[^\n]+LOGIN") then - return self:login(user, password) - elseif string.find(ext, "AUTH[^\n]+PLAIN") then - return self:plain(user, password) - else - self.try(nil, "authentication not supported") - end + if not user or not password then return 1 end + if string.find(ext, "AUTH[^\n]+LOGIN") then + return self:login(user, password) + elseif string.find(ext, "AUTH[^\n]+PLAIN") then + return self:plain(user, password) + else + self.try(nil, "authentication not supported") + end end -- send message or throw an exception function metat.__index:send(mailt) - self:mail(mailt.from) - if base.type(mailt.rcpt) == "table" then - for i,v in base.ipairs(mailt.rcpt) do - self:rcpt(v) - end - else - self:rcpt(mailt.rcpt) - end - self:data(ltn12.source.chain(mailt.source, mime.stuff()), mailt.step) + self:mail(mailt.from) + if base.type(mailt.rcpt) == "table" then + for i, v in base.ipairs(mailt.rcpt) do + self:rcpt(v) + end + else + self:rcpt(mailt.rcpt) + end + self:data(ltn12.source.chain(mailt.source, mime.stuff()), mailt.step) end function open(server, port, create) - local tp = socket.try(tp.connect(server or SERVER, port or PORT, - TIMEOUT, create)) - local s = base.setmetatable({tp = tp}, metat) - -- make sure tp is closed if we get an exception - s.try = socket.newtry(function() - s:close() - end) - return s + local tp = socket.try(tp.connect(server or SERVER, port or PORT, + TIMEOUT, create)) + local s = base.setmetatable({ tp = tp }, metat) + -- make sure tp is closed if we get an exception + s.try = socket.newtry(function() + s:close() + end) + return s end -- convert headers to lowercase local function lower_headers(headers) - local lower = {} - for i,v in base.pairs(headers or lower) do - lower[string.lower(i)] = v - end - return lower + local lower = {} + for i, v in base.pairs(headers or lower) do + lower[string.lower(i)] = v + end + return lower end --------------------------------------------------------------------------- @@ -137,9 +137,9 @@ end -- returns a hopefully unique mime boundary local seqno = 0 local function newboundary() - seqno = seqno + 1 - return string.format('%s%05d==%05u', os.date('%d%m%Y%H%M%S'), - math.random(0, 99999), seqno) + seqno = seqno + 1 + return string.format('%s%05d==%05u', os.date('%d%m%Y%H%M%S'), + math.random(0, 99999), seqno) end -- send_message forward declaration @@ -147,105 +147,116 @@ local send_message -- yield the headers all at once, it's faster local function send_headers(headers) - local h = "\r\n" - for i,v in base.pairs(headers) do - h = i .. ': ' .. v .. "\r\n" .. h - end - coroutine.yield(h) + local h = "\r\n" + for i, v in base.pairs(headers) do + h = i .. ': ' .. v .. "\r\n" .. h + end + coroutine.yield(h) end -- yield multipart message body from a multipart message table local function send_multipart(mesgt) - -- make sure we have our boundary and send headers - local bd = newboundary() - local headers = lower_headers(mesgt.headers or {}) - headers['content-type'] = headers['content-type'] or 'multipart/mixed' - headers['content-type'] = headers['content-type'] .. - '; boundary="' .. bd .. '"' - send_headers(headers) - -- send preamble - if mesgt.body.preamble then - coroutine.yield(mesgt.body.preamble) - coroutine.yield("\r\n") - end - -- send each part separated by a boundary - for i, m in base.ipairs(mesgt.body) do - coroutine.yield("\r\n--" .. bd .. "\r\n") - send_message(m) - end - -- send last boundary - coroutine.yield("\r\n--" .. bd .. "--\r\n\r\n") - -- send epilogue - if mesgt.body.epilogue then - coroutine.yield(mesgt.body.epilogue) - coroutine.yield("\r\n") - end + -- make sure we have our boundary and send headers + local bd = newboundary() + local headers = lower_headers(mesgt.headers or {}) + headers['content-type'] = headers['content-type'] or 'multipart/mixed' + headers['content-type'] = headers['content-type'] .. + '; boundary="' .. bd .. '"' + send_headers(headers) + -- send preamble + if mesgt.body.preamble then + coroutine.yield(mesgt.body.preamble) + coroutine.yield("\r\n") + end + -- send each part separated by a boundary + for i, m in base.ipairs(mesgt.body) do + coroutine.yield("\r\n--" .. bd .. "\r\n") + send_message(m) + end + -- send last boundary + coroutine.yield("\r\n--" .. bd .. "--\r\n\r\n") + -- send epilogue + if mesgt.body.epilogue then + coroutine.yield(mesgt.body.epilogue) + coroutine.yield("\r\n") + end end -- yield message body from a source local function send_source(mesgt) - -- make sure we have a content-type - local headers = lower_headers(mesgt.headers or {}) - headers['content-type'] = headers['content-type'] or - 'text/plain; charset="iso-8859-1"' - send_headers(headers) - -- send body from source - while true do - local chunk, err = mesgt.body() - if err then coroutine.yield(nil, err) - elseif chunk then coroutine.yield(chunk) - else break end - end + -- make sure we have a content-type + local headers = lower_headers(mesgt.headers or {}) + headers['content-type'] = headers['content-type'] or + 'text/plain; charset="iso-8859-1"' + send_headers(headers) + -- send body from source + while true do + local chunk, err = mesgt.body() + if err then + coroutine.yield(nil, err) + elseif chunk then + coroutine.yield(chunk) + else + break + end + end end -- yield message body from a string local function send_string(mesgt) - -- make sure we have a content-type - local headers = lower_headers(mesgt.headers or {}) - headers['content-type'] = headers['content-type'] or - 'text/plain; charset="iso-8859-1"' - send_headers(headers) - -- send body from string - coroutine.yield(mesgt.body) + -- make sure we have a content-type + local headers = lower_headers(mesgt.headers or {}) + headers['content-type'] = headers['content-type'] or + 'text/plain; charset="iso-8859-1"' + send_headers(headers) + -- send body from string + coroutine.yield(mesgt.body) end -- message source function send_message(mesgt) - if base.type(mesgt.body) == "table" then send_multipart(mesgt) - elseif base.type(mesgt.body) == "function" then send_source(mesgt) - else send_string(mesgt) end + if base.type(mesgt.body) == "table" then + send_multipart(mesgt) + elseif base.type(mesgt.body) == "function" then + send_source(mesgt) + else + send_string(mesgt) + end end -- set defaul headers local function adjust_headers(mesgt) - local lower = lower_headers(mesgt.headers) - lower["date"] = lower["date"] or - os.date("!%a, %d %b %Y %H:%M:%S ") .. (mesgt.zone or ZONE) - lower["x-mailer"] = lower["x-mailer"] or socket._VERSION - -- this can't be overriden - lower["mime-version"] = "1.0" - return lower + local lower = lower_headers(mesgt.headers) + lower["date"] = lower["date"] or + os.date("!%a, %d %b %Y %H:%M:%S ") .. (mesgt.zone or ZONE) + lower["x-mailer"] = lower["x-mailer"] or socket._VERSION + -- this can't be overriden + lower["mime-version"] = "1.0" + return lower end function message(mesgt) - mesgt.headers = adjust_headers(mesgt) - -- create and return message source - local co = coroutine.create(function() send_message(mesgt) end) - return function() - local ret, a, b = coroutine.resume(co) - if ret then return a, b - else return nil, a end - end + mesgt.headers = adjust_headers(mesgt) + -- create and return message source + local co = coroutine.create(function() send_message(mesgt) end) + return function() + local ret, a, b = coroutine.resume(co) + if ret then + return a, b + else + return nil, a + end + end end --------------------------------------------------------------------------- -- High level SMTP API ----------------------------------------------------------------------------- send = socket.protect(function(mailt) - local s = open(mailt.server, mailt.port, mailt.create) - local ext = s:greet(mailt.domain) - s:auth(mailt.user, mailt.password, ext) - s:send(mailt) - s:quit() - return s:close() + local s = open(mailt.server, mailt.port, mailt.create) + local ext = s:greet(mailt.domain) + s:auth(mailt.user, mailt.password, ext) + s:send(mailt) + s:quit() + return s:close() end) diff --git a/lualib/socket/tp.lua b/lualib/socket/tp.lua index 0683869..6a88155 100644 --- a/lualib/socket/tp.lua +++ b/lualib/socket/tp.lua @@ -24,100 +24,104 @@ TIMEOUT = 60 ----------------------------------------------------------------------------- -- gets server reply (works for SMTP and FTP) local function get_reply(c) - local code, current, sep - local line, err = c:receive() - local reply = line - if err then return nil, err end - code, sep = socket.skip(2, string.find(line, "^(%d%d%d)(.?)")) - if not code then return nil, "invalid server reply" end - if sep == "-" then -- reply is multiline - repeat - line, err = c:receive() - if err then return nil, err end - current, sep = socket.skip(2, string.find(line, "^(%d%d%d)(.?)")) - reply = reply .. "\n" .. line - -- reply ends with same code - until code == current and sep == " " - end - return code, reply + local code, current, sep + local line, err = c:receive() + local reply = line + if err then return nil, err end + code, sep = socket.skip(2, string.find(line, "^(%d%d%d)(.?)")) + if not code then return nil, "invalid server reply" end + if sep == "-" then -- reply is multiline + repeat + line, err = c:receive() + if err then return nil, err end + current, sep = socket.skip(2, string.find(line, "^(%d%d%d)(.?)")) + reply = reply .. "\n" .. line + -- reply ends with same code + until code == current and sep == " " + end + return code, reply end -- metatable for sock object local metat = { __index = {} } function metat.__index:check(ok) - local code, reply = get_reply(self.c) - if not code then return nil, reply end - if base.type(ok) ~= "function" then - if base.type(ok) == "table" then - for i, v in base.ipairs(ok) do - if string.find(code, v) then - return base.tonumber(code), reply - end - end - return nil, reply - else - if string.find(code, ok) then return base.tonumber(code), reply - else return nil, reply end - end - else return ok(base.tonumber(code), reply) end + local code, reply = get_reply(self.c) + if not code then return nil, reply end + if base.type(ok) ~= "function" then + if base.type(ok) == "table" then + for i, v in base.ipairs(ok) do + if string.find(code, v) then + return base.tonumber(code), reply + end + end + return nil, reply + else + if string.find(code, ok) then + return base.tonumber(code), reply + else + return nil, reply + end + end + else + return ok(base.tonumber(code), reply) + end end function metat.__index:command(cmd, arg) - if arg then - return self.c:send(cmd .. " " .. arg.. "\r\n") - else - return self.c:send(cmd .. "\r\n") - end + if arg then + return self.c:send(cmd .. " " .. arg .. "\r\n") + else + return self.c:send(cmd .. "\r\n") + end end function metat.__index:sink(snk, pat) - local chunk, err = c:receive(pat) - return snk(chunk, err) + local chunk, err = c:receive(pat) + return snk(chunk, err) end function metat.__index:send(data) - return self.c:send(data) + return self.c:send(data) end function metat.__index:receive(pat) - return self.c:receive(pat) + return self.c:receive(pat) end function metat.__index:getfd() - return self.c:getfd() + return self.c:getfd() end function metat.__index:dirty() - return self.c:dirty() + return self.c:dirty() end function metat.__index:getcontrol() - return self.c + return self.c end function metat.__index:source(source, step) - local sink = socket.sink("keep-open", self.c) - local ret, err = ltn12.pump.all(source, sink, step or ltn12.pump.step) - return ret, err + local sink = socket.sink("keep-open", self.c) + local ret, err = ltn12.pump.all(source, sink, step or ltn12.pump.step) + return ret, err end -- closes the underlying c function metat.__index:close() - self.c:close() + self.c:close() return 1 end -- connect with server and return c object function connect(host, port, timeout, create) - local c, e = (create or socket.tcp)() - if not c then return nil, e end - c:settimeout(timeout or TIMEOUT) - local r, e = c:connect(host, port) - if not r then - c:close() - return nil, e - end - return base.setmetatable({c = c}, metat) + local c, e = (create or socket.tcp)() + if not c then return nil, e end + c:settimeout(timeout or TIMEOUT) + local r, e = c:connect(host, port) + if not r then + c:close() + return nil, e + end + return base.setmetatable({ c = c }, metat) end - diff --git a/lualib/socket/url.lua b/lualib/socket/url.lua index f05d91c..b26f102 100644 --- a/lualib/socket/url.lua +++ b/lualib/socket/url.lua @@ -26,9 +26,9 @@ _VERSION = "URL 1.0.1" -- escaped representation of string binary ----------------------------------------------------------------------------- function escape(s) - return string.gsub(s, "([^A-Za-z0-9_])", function(c) - return string.format("%%%02x", string.byte(c)) - end) + return string.gsub(s, "([^A-Za-z0-9_])", function(c) + return string.format("%%%02x", string.byte(c)) + end) end ----------------------------------------------------------------------------- @@ -41,7 +41,7 @@ end ----------------------------------------------------------------------------- local function make_set(t) local s = {} - for i,v in base.ipairs(t) do + for i, v in base.ipairs(t) do s[t[i]] = 1 end return s @@ -50,14 +50,17 @@ end -- these are allowed withing a path segment, along with alphanum -- other characters must be escaped local segment_set = make_set { - "-", "_", ".", "!", "~", "*", "'", "(", + "-", "_", ".", "!", "~", "*", "'", "(", ")", ":", "@", "&", "=", "+", "$", ",", } local function protect_segment(s) - return string.gsub(s, "([^A-Za-z0-9_])", function (c) - if segment_set[c] then return c - else return string.format("%%%02x", string.byte(c)) end + return string.gsub(s, "([^A-Za-z0-9_])", function(c) + if segment_set[c] then + return c + else + return string.format("%%%02x", string.byte(c)) + end end) end @@ -69,9 +72,9 @@ end -- escaped representation of string binary ----------------------------------------------------------------------------- function unescape(s) - return string.gsub(s, "%%(%x%x)", function(hex) - return string.char(base.tonumber(hex, 16)) - end) + return string.gsub(s, "%%(%x%x)", function(hex) + return string.char(base.tonumber(hex, 16)) + end) end ----------------------------------------------------------------------------- @@ -83,24 +86,24 @@ end -- corresponding absolute path ----------------------------------------------------------------------------- local function absolute_path(base_path, relative_path) - if string.sub(relative_path, 1, 1) == "/" then return relative_path end - local path = string.gsub(base_path, "[^/]*$", "") - path = path .. relative_path - path = string.gsub(path, "([^/]*%./)", function (s) - if s ~= "./" then return s else return "" end - end) - path = string.gsub(path, "/%.$", "/") - local reduced - while reduced ~= path do - reduced = path - path = string.gsub(reduced, "([^/]*/%.%./)", function (s) - if s ~= "../../" then return "" else return s end - end) - end - path = string.gsub(reduced, "([^/]*/%.%.)$", function (s) - if s ~= "../.." then return "" else return s end - end) - return path + if string.sub(relative_path, 1, 1) == "/" then return relative_path end + local path = string.gsub(base_path, "[^/]*$", "") + path = path .. relative_path + path = string.gsub(path, "([^/]*%./)", function(s) + if s ~= "./" then return s else return "" end + end) + path = string.gsub(path, "/%.$", "/") + local reduced + while reduced ~= path do + reduced = path + path = string.gsub(reduced, "([^/]*/%.%./)", function(s) + if s ~= "../../" then return "" else return s end + end) + end + path = string.gsub(reduced, "([^/]*/%.%.)$", function(s) + if s ~= "../.." then return "" else return s end + end) + return path end ----------------------------------------------------------------------------- @@ -122,51 +125,59 @@ end -- the leading '/' in {/} is considered part of ----------------------------------------------------------------------------- function parse(url, default) - -- initialize default parameters - local parsed = {} - for i,v in base.pairs(default or parsed) do parsed[i] = v end - -- empty url is parsed to nil - if not url or url == "" then return nil, "invalid url" end - -- remove whitespace - -- url = string.gsub(url, "%s", "") - -- get fragment - url = string.gsub(url, "#(.*)$", function(f) - parsed.fragment = f - return "" - end) - -- get scheme - url = string.gsub(url, "^([%w][%w%+%-%.]*)%:", - function(s) parsed.scheme = s; return "" end) - -- get authority - url = string.gsub(url, "^//([^/]*)", function(n) - parsed.authority = n - return "" - end) - -- get query stringing - url = string.gsub(url, "%?(.*)", function(q) - parsed.query = q - return "" - end) - -- get params - url = string.gsub(url, "%;(.*)", function(p) - parsed.params = p - return "" - end) - -- path is whatever was left - if url ~= "" then parsed.path = url end - local authority = parsed.authority - if not authority then return parsed end - authority = string.gsub(authority,"^([^@]*)@", - function(u) parsed.userinfo = u; return "" end) - authority = string.gsub(authority, ":([^:]*)$", - function(p) parsed.port = p; return "" end) - if authority ~= "" then parsed.host = authority end - local userinfo = parsed.userinfo - if not userinfo then return parsed end - userinfo = string.gsub(userinfo, ":([^:]*)$", - function(p) parsed.password = p; return "" end) - parsed.user = userinfo - return parsed + -- initialize default parameters + local parsed = {} + for i, v in base.pairs(default or parsed) do parsed[i] = v end + -- empty url is parsed to nil + if not url or url == "" then return nil, "invalid url" end + -- remove whitespace + -- url = string.gsub(url, "%s", "") + -- get fragment + url = string.gsub(url, "#(.*)$", function(f) + parsed.fragment = f + return "" + end) + -- get scheme + url = string.gsub(url, "^([%w][%w%+%-%.]*)%:", + function(s) + parsed.scheme = s; return "" + end) + -- get authority + url = string.gsub(url, "^//([^/]*)", function(n) + parsed.authority = n + return "" + end) + -- get query stringing + url = string.gsub(url, "%?(.*)", function(q) + parsed.query = q + return "" + end) + -- get params + url = string.gsub(url, "%;(.*)", function(p) + parsed.params = p + return "" + end) + -- path is whatever was left + if url ~= "" then parsed.path = url end + local authority = parsed.authority + if not authority then return parsed end + authority = string.gsub(authority, "^([^@]*)@", + function(u) + parsed.userinfo = u; return "" + end) + authority = string.gsub(authority, ":([^:]*)$", + function(p) + parsed.port = p; return "" + end) + if authority ~= "" then parsed.host = authority end + local userinfo = parsed.userinfo + if not userinfo then return parsed end + userinfo = string.gsub(userinfo, ":([^:]*)$", + function(p) + parsed.password = p; return "" + end) + parsed.user = userinfo + return parsed end ----------------------------------------------------------------------------- @@ -178,10 +189,10 @@ end -- a stringing with the corresponding URL ----------------------------------------------------------------------------- function build(parsed) - local ppath = parse_path(parsed.path or "") - local url = build_path(ppath) - if parsed.params then url = url .. ";" .. parsed.params end - if parsed.query then url = url .. "?" .. parsed.query end + local ppath = parse_path(parsed.path or "") + local url = build_path(ppath) + if parsed.params then url = url .. ";" .. parsed.params end + if parsed.query then url = url .. "?" .. parsed.query end local authority = parsed.authority if parsed.host then authority = parsed.host @@ -195,11 +206,11 @@ function build(parsed) end if userinfo then authority = userinfo .. "@" .. authority end end - if authority then url = "//" .. authority .. url end - if parsed.scheme then url = parsed.scheme .. ":" .. url end - if parsed.fragment then url = url .. "#" .. parsed.fragment end - -- url = string.gsub(url, "%s", "") - return url + if authority then url = "//" .. authority .. url end + if parsed.scheme then url = parsed.scheme .. ":" .. url end + if parsed.fragment then url = url .. "#" .. parsed.fragment end + -- url = string.gsub(url, "%s", "") + return url end ----------------------------------------------------------------------------- @@ -211,35 +222,38 @@ end -- corresponding absolute url ----------------------------------------------------------------------------- function absolute(base_url, relative_url) - if base.type(base_url) == "table" then - base_parsed = base_url - base_url = build(base_parsed) - else - base_parsed = parse(base_url) - end - local relative_parsed = parse(relative_url) - if not base_parsed then return relative_url - elseif not relative_parsed then return base_url - elseif relative_parsed.scheme then return relative_url - else - relative_parsed.scheme = base_parsed.scheme - if not relative_parsed.authority then - relative_parsed.authority = base_parsed.authority - if not relative_parsed.path then - relative_parsed.path = base_parsed.path - if not relative_parsed.params then - relative_parsed.params = base_parsed.params - if not relative_parsed.query then - relative_parsed.query = base_parsed.query - end - end - else - relative_parsed.path = absolute_path(base_parsed.path or "", - relative_parsed.path) - end - end - return build(relative_parsed) - end + if base.type(base_url) == "table" then + base_parsed = base_url + base_url = build(base_parsed) + else + base_parsed = parse(base_url) + end + local relative_parsed = parse(relative_url) + if not base_parsed then + return relative_url + elseif not relative_parsed then + return base_url + elseif relative_parsed.scheme then + return relative_url + else + relative_parsed.scheme = base_parsed.scheme + if not relative_parsed.authority then + relative_parsed.authority = base_parsed.authority + if not relative_parsed.path then + relative_parsed.path = base_parsed.path + if not relative_parsed.params then + relative_parsed.params = base_parsed.params + if not relative_parsed.query then + relative_parsed.query = base_parsed.query + end + end + else + relative_parsed.path = absolute_path(base_parsed.path or "", + relative_parsed.path) + end + end + return build(relative_parsed) + end end ----------------------------------------------------------------------------- @@ -253,7 +267,7 @@ function parse_path(path) local parsed = {} path = path or "" --path = string.gsub(path, "%s", "") - string.gsub(path, "([^/]+)", function (s) table.insert(parsed, s) end) + string.gsub(path, "([^/]+)", function(s) table.insert(parsed, s) end) for i = 1, #parsed do parsed[i] = unescape(parsed[i]) end @@ -274,7 +288,7 @@ function build_path(parsed, unsafe) local path = "" local n = #parsed if unsafe then - for i = 1, n-1 do + for i = 1, n - 1 do path = path .. parsed[i] path = path .. "/" end @@ -283,7 +297,7 @@ function build_path(parsed, unsafe) if parsed.is_directory then path = path .. "/" end end else - for i = 1, n-1 do + for i = 1, n - 1 do path = path .. protect_segment(parsed[i]) path = path .. "/" end diff --git a/src/lua-env-safe.lua b/src/lua-env-safe.lua index c64a30e..023515e 100644 --- a/src/lua-env-safe.lua +++ b/src/lua-env-safe.lua @@ -1,10 +1,12 @@ -- Sanitize the Lua environment to: -- Prevent scripts from accessing files outside the game directory --- Prevent usage of libraries other than +-- Prevent usage of libraries other than -- Utility: Convert a list of strings into a map of string->true -local function tmap(t) local u = {}; for _, n in ipairs(t) do u[n] = true end; return u; end +local function tmap(t) + local u = {}; for _, n in ipairs(t) do u[n] = true end; return u; +end -- Save banned global variables for wrapping with safe functions local old_io = io @@ -50,13 +52,13 @@ local allowed_dirs_readonly = tmap { -- so this is just a precaution. local disallowed_exts = tmap { -- windows - 'bat','bin','cab','cmd','com','cpl','ex_','exe','gadget','inf','ins','inx','isu', - 'job','jse','lnk','msc','msi','msp','mst','paf','pif','ps1','reg','rgs','scr', - 'sct','shb','shs','u3p','vb','vbe','vbs','vbscript','ws','wsf','wsh', + 'bat', 'bin', 'cab', 'cmd', 'com', 'cpl', 'ex_', 'exe', 'gadget', 'inf', 'ins', 'inx', 'isu', + 'job', 'jse', 'lnk', 'msc', 'msi', 'msp', 'mst', 'paf', 'pif', 'ps1', 'reg', 'rgs', 'scr', + 'sct', 'shb', 'shs', 'u3p', 'vb', 'vbe', 'vbs', 'vbscript', 'ws', 'wsf', 'wsh', -- linux - 'csh','ksh','out','run','sh', + 'csh', 'ksh', 'out', 'run', 'sh', -- mac/other - 'action','apk','app','command','ipa','osx','prg','workflow', + 'action', 'apk', 'app', 'command', 'ipa', 'osx', 'prg', 'workflow', } -- Arguments: file name (relative to game directory), boolean true if only reading -- Return: clean file path if allowed (or nil if disallowed), @@ -68,27 +70,27 @@ local function safe_path(fn, readonly) -- whitelist characters local ic = fn:find('[^a-zA-Z0-9_%-/ %.]') if ic then - return nil, 'Filename \''..fn..'\' contains invalid character \''.. - fn:sub(ic, ic)..'\' at position '..ic + return nil, 'Filename \'' .. fn .. '\' contains invalid character \'' .. + fn:sub(ic, ic) .. '\' at position ' .. ic end -- disallow up-dirs, absolute paths, and relative paths -- './' and '../' are possible in scripts, because they're processed into -- absolute paths in util.lua before reaching here if fn:find('^%.') or fn:find('%.%.') or fn:find(':') or fn:find('^/') then - return nil, 'Filename \''..fn..'\' contains invalid sequence' + return nil, 'Filename \'' .. fn .. '\' contains invalid sequence' end -- allow only whitelisted dirs local dir = fn:match('^([^/]+)/') if (not dir) or ( - (not allowed_dirs[dir:lower()]) and - ((not readonly) or (not allowed_dirs_readonly[dir:lower()])) ) then - return nil, 'filename is in disallowed directory '..(dir or 'nil') + (not allowed_dirs[dir:lower()]) and + ((not readonly) or (not allowed_dirs_readonly[dir:lower()]))) then + return nil, 'filename is in disallowed directory ' .. (dir or 'nil') end -- disallow blacklisted extensions or no extension local ext = fn:match('%.([^/%.]+)$') if (not ext) or (disallowed_exts[ext:lower()]) then - return nil, 'Filename \''..fn..'\' has disallowed extension \''.. - (ext or '')..'\'' + return nil, 'Filename \'' .. fn .. '\' has disallowed extension \'' .. + (ext or '') .. '\'' end return fn, nil end @@ -96,7 +98,7 @@ end -- Wrap io.open with path sanitization function _bllua_io_open(fn, md) md = md or 'r' - local readonly = md=='r' or md=='rb' + local readonly = md == 'r' or md == 'rb' local fns, err = safe_path(fn, readonly) if fns then return old_io.open(fns, md) @@ -104,6 +106,7 @@ function _bllua_io_open(fn, md) return nil, err end end + -- Allow io.type (works on file handles returned by io.open) function _bllua_io_type(f) return old_io.type(f) @@ -122,12 +125,13 @@ function _bllua_requiresecure(name) name:find('^%.') or name:find('%.$') then error('require: package name contains invalid character', 3) elseif disallowed_packages[name] then - error('require: attempt to require disallowed module \''..name..'\'', 3) + error('require: attempt to require disallowed module \'' .. name .. '\'', 3) else -- todo: reimplement require to not use package.* stuff? return old_require(name) end end + package = { seeall = old_package.seeall, } diff --git a/src/lua-env.lua b/src/lua-env.lua index f485ee2..0de9dd1 100644 --- a/src/lua-env.lua +++ b/src/lua-env.lua @@ -9,7 +9,7 @@ _bllua_on_unload = {} -- Utility for getting the current filename function debug.getfilename(level) - if type(level) == 'number' then level = level+1 end + if type(level) == 'number' then level = level + 1 end local info = debug.getinfo(level) if not info then return nil end local filename = info.source:match('^%-%-%[%[([^%]]+)%]%]') @@ -19,20 +19,20 @@ end -- Called when pcall fails on a ts->lua call, used to print detailed error info function _bllua_on_error(err) err = err:match(': (.+)$') or err - local tracelines = {err} + local tracelines = { err } local level = 2 while true do local info = debug.getinfo(level) if not info then break end local filename = debug.getfilename(level) or info.short_src local funcname = info.name - if funcname=='dofile' then break end + if funcname == 'dofile' then break end table.insert(tracelines, string.format('%s:%s in function \'%s\'', filename, - info.currentline==-1 and '' or info.currentline..':', + info.currentline == -1 and '' or info.currentline .. ':', funcname )) - level = level+1 + level = level + 1 end return table.concat(tracelines, '\n') end diff --git a/src/util/libbl-types.lua b/src/util/libbl-types.lua index 26deec1..b531bf7 100644 --- a/src/util/libbl-types.lua +++ b/src/util/libbl-types.lua @@ -4,129 +4,129 @@ -- Class hierarchy, adapted from https://notabug.org/Queuenard/blockland-DLL-tools/src/master/class_hierarchy bl.class('SimObject') - bl.class('ScriptObject', 'SimObject') - bl.class('SimSet', 'SimObject') - bl.class('SimGroup', 'SimSet') - bl.class('GuiControl', 'SimGroup') - bl.class('GuiTextCtrl' , 'GuiControl') - bl.class('GuiSwatchCtrl' , 'GuiControl') - bl.class('GuiButtonBaseCtrl' , 'GuiControl') - bl.class('GuiArrayCtrl' , 'GuiControl') - bl.class('GuiScrollCtrl' , 'GuiControl') - bl.class('GuiMouseEventCtrl' , 'GuiControl') - bl.class('GuiProgressCtrl' , 'GuiControl') - bl.class('GuiSliderCtrl' , 'GuiControl') - bl.class('GuiConsoleTextCtrl' , 'GuiControl') - bl.class('GuiTSCtrl' , 'GuiControl') - bl.class('GuiObjectView', 'GuiTSCtrl') - bl.class('GameTSCtrl' , 'GuiTSCtrl') - bl.class('EditTSCtrl' , 'GuiTSCtrl') - bl.class('GuiPlayerView', 'GuiTSCtrl') - bl.class('GuiShapeNameHud' , 'GuiControl') - bl.class('GuiHealthBarHud' , 'GuiControl') - bl.class('GuiGraphCtrl' , 'GuiControl') - bl.class('GuiInspector' , 'GuiControl') - bl.class('GuiChunkedBitmapCtrl', 'GuiControl') - bl.class('GuiInputCtrl' , 'GuiControl') - bl.class('GuiNoMouseCtrl' , 'GuiControl') - bl.class('GuiBitmapBorderCtrl' , 'GuiControl') - bl.class('GuiBackgroundCtrl' , 'GuiControl') - bl.class('GuiEditorRuler' , 'GuiControl') - bl.class('GuiClockHud' , 'GuiControl') - bl.class('GuiEditCtrl' , 'GuiControl') - bl.class('GuiFilterCtrl' , 'GuiControl') - bl.class('GuiFrameSetCtrl' , 'GuiControl') - bl.class('GuiMenuBar' , 'GuiControl') - bl.class('GuiMessageVectorCtrl', 'GuiControl') - bl.class('GuiBitmapCtrl' , 'GuiControl') - bl.class('GuiCrossHairHud', 'GuiBitmapCtrl') - bl.class('ScriptGroup', 'SimGroup') - bl.class('NetConnection', 'SimGroup') - bl.class('GameConnection', 'NetConnection') - bl.class('Path', 'SimGroup') - bl.class('TCPObject', 'SimObject') - bl.class('SOCKObject', 'TCPObject') - bl.class('HTTPObject', 'TCPObject') - bl.class('SimDataBlock', 'SimObject') - bl.class('AudioEnvironment' , 'SimDataBlock') - bl.class('AudioSampleEnvironment', 'SimDataBlock') - bl.class('AudioDescription' , 'SimDataBlock') - bl.class('GameBaseData' , 'SimDataBlock') - bl.class('ShapeBaseData' , 'GameBaseData') - bl.class('CameraData' , 'ShapeBaseData') - bl.class('ItemData' , 'ShapeBaseData') - bl.class('MissionMarkerData', 'ShapeBaseData') - bl.class('PathCameraData' , 'ShapeBaseData') - bl.class('PlayerData' , 'ShapeBaseData') - bl.class('StaticShapeData' , 'ShapeBaseData') - bl.class('VehicleData' , 'ShapeBaseData') - bl.class('FlyingVehicleData' , 'VehicleData') - bl.class('WheeledVehicleData', 'VehicleData') - bl.class('DebrisData' , 'GameBaseData') - bl.class('ProjectileData' , 'GameBaseData') - bl.class('ShapeBaseImageData' , 'GameBaseData') - bl.class('TriggerData' , 'GameBaseData') - bl.class('ExplosionData' , 'GameBaseData') - bl.class('fxLightData' , 'GameBaseData') - bl.class('LightningData' , 'GameBaseData') - bl.class('ParticleEmitterNodeData', 'GameBaseData') - bl.class('SplashData' , 'GameBaseData') - bl.class('fxDTSBrickData' , 'GameBaseData') - bl.class('ParticleEmitterData' , 'GameBaseData') - bl.class('WheeledVehicleTire' , 'SimDataBlock') - bl.class('WheeledVehicleSpring' , 'SimDataBlock') - bl.class('TSShapeConstructor' , 'SimDataBlock') - bl.class('AudioProfile' , 'SimDataBlock') - bl.class('ParticleData' , 'SimDataBlock') - bl.class('MaterialPropertyMap', 'SimObject') - bl.class('NetObject', 'SimObject') - bl.class('SceneObject', 'NetObject') - bl.class('GameBase', 'SceneObject') - bl.class('ShapeBase', 'GameBase') - bl.class('MissionMarker', 'ShapeBase') - bl.class('SpawnSphere' , 'MissionMarker') - bl.class('VehicleSpawnMarker', 'MissionMarker') - bl.class('Waypoint' , 'MissionMarker') - bl.class('StaticShape' , 'ShapeBase') - bl.class('ScopeAlwaysShape', 'StaticShape') - bl.class('Player' , 'ShapeBase') - bl.class('AIPlayer', 'Player') - bl.class('Camera' , 'ShapeBase') - bl.class('Item' , 'ShapeBase') - bl.class('PathCamera' , 'ShapeBase') - bl.class('Vehicle' , 'ShapeBase') - bl.class('FlyingVehicle' , 'Vehicle') - bl.class('WheeledVehicle', 'Vehicle') - bl.class('Explosion' , 'GameBase') - bl.class('Splash' , 'GameBase') - bl.class('Debris' , 'GameBase') - bl.class('Projectile' , 'GameBase') - bl.class('Trigger' , 'GameBase') - bl.class('fxLight' , 'GameBase') - bl.class('Lightning' , 'GameBase') - bl.class('ParticleEmitterNode', 'GameBase') - bl.class('ParticleEmitter' , 'GameBase') - bl.class('Precipitation' , 'GameBase') - bl.class('TSStatic' , 'SceneObject') - bl.class('VehicleBlocker', 'SceneObject') - bl.class('Marker' , 'SceneObject') - bl.class('AudioEmitter' , 'SceneObject') - bl.class('PhysicalZone' , 'SceneObject') - bl.class('fxDayCycle' , 'SceneObject') - bl.class('fxDTSBrick' , 'SceneObject') - bl.class('fxPlane' , 'SceneObject') - bl.class('fxSunLight' , 'SceneObject') - bl.class('Sky' , 'SceneObject') - bl.class('SceneRoot' , 'SceneObject') - bl.class('Sun', 'NetObject') - bl.class('GuiCursor', 'SimObject') - bl.class('ConsoleLogger' , 'SimObject') - bl.class('QuotaObject' , 'SimObject') - bl.class('FileObject' , 'SimObject') - bl.class('BanList' , 'SimObject') - bl.class('GuiControlProfile', 'SimObject') - bl.class('MessageVector' , 'SimObject') - bl.class('ActionMap' , 'SimObject') +bl.class('ScriptObject', 'SimObject') +bl.class('SimSet', 'SimObject') +bl.class('SimGroup', 'SimSet') +bl.class('GuiControl', 'SimGroup') +bl.class('GuiTextCtrl', 'GuiControl') +bl.class('GuiSwatchCtrl', 'GuiControl') +bl.class('GuiButtonBaseCtrl', 'GuiControl') +bl.class('GuiArrayCtrl', 'GuiControl') +bl.class('GuiScrollCtrl', 'GuiControl') +bl.class('GuiMouseEventCtrl', 'GuiControl') +bl.class('GuiProgressCtrl', 'GuiControl') +bl.class('GuiSliderCtrl', 'GuiControl') +bl.class('GuiConsoleTextCtrl', 'GuiControl') +bl.class('GuiTSCtrl', 'GuiControl') +bl.class('GuiObjectView', 'GuiTSCtrl') +bl.class('GameTSCtrl', 'GuiTSCtrl') +bl.class('EditTSCtrl', 'GuiTSCtrl') +bl.class('GuiPlayerView', 'GuiTSCtrl') +bl.class('GuiShapeNameHud', 'GuiControl') +bl.class('GuiHealthBarHud', 'GuiControl') +bl.class('GuiGraphCtrl', 'GuiControl') +bl.class('GuiInspector', 'GuiControl') +bl.class('GuiChunkedBitmapCtrl', 'GuiControl') +bl.class('GuiInputCtrl', 'GuiControl') +bl.class('GuiNoMouseCtrl', 'GuiControl') +bl.class('GuiBitmapBorderCtrl', 'GuiControl') +bl.class('GuiBackgroundCtrl', 'GuiControl') +bl.class('GuiEditorRuler', 'GuiControl') +bl.class('GuiClockHud', 'GuiControl') +bl.class('GuiEditCtrl', 'GuiControl') +bl.class('GuiFilterCtrl', 'GuiControl') +bl.class('GuiFrameSetCtrl', 'GuiControl') +bl.class('GuiMenuBar', 'GuiControl') +bl.class('GuiMessageVectorCtrl', 'GuiControl') +bl.class('GuiBitmapCtrl', 'GuiControl') +bl.class('GuiCrossHairHud', 'GuiBitmapCtrl') +bl.class('ScriptGroup', 'SimGroup') +bl.class('NetConnection', 'SimGroup') +bl.class('GameConnection', 'NetConnection') +bl.class('Path', 'SimGroup') +bl.class('TCPObject', 'SimObject') +bl.class('SOCKObject', 'TCPObject') +bl.class('HTTPObject', 'TCPObject') +bl.class('SimDataBlock', 'SimObject') +bl.class('AudioEnvironment', 'SimDataBlock') +bl.class('AudioSampleEnvironment', 'SimDataBlock') +bl.class('AudioDescription', 'SimDataBlock') +bl.class('GameBaseData', 'SimDataBlock') +bl.class('ShapeBaseData', 'GameBaseData') +bl.class('CameraData', 'ShapeBaseData') +bl.class('ItemData', 'ShapeBaseData') +bl.class('MissionMarkerData', 'ShapeBaseData') +bl.class('PathCameraData', 'ShapeBaseData') +bl.class('PlayerData', 'ShapeBaseData') +bl.class('StaticShapeData', 'ShapeBaseData') +bl.class('VehicleData', 'ShapeBaseData') +bl.class('FlyingVehicleData', 'VehicleData') +bl.class('WheeledVehicleData', 'VehicleData') +bl.class('DebrisData', 'GameBaseData') +bl.class('ProjectileData', 'GameBaseData') +bl.class('ShapeBaseImageData', 'GameBaseData') +bl.class('TriggerData', 'GameBaseData') +bl.class('ExplosionData', 'GameBaseData') +bl.class('fxLightData', 'GameBaseData') +bl.class('LightningData', 'GameBaseData') +bl.class('ParticleEmitterNodeData', 'GameBaseData') +bl.class('SplashData', 'GameBaseData') +bl.class('fxDTSBrickData', 'GameBaseData') +bl.class('ParticleEmitterData', 'GameBaseData') +bl.class('WheeledVehicleTire', 'SimDataBlock') +bl.class('WheeledVehicleSpring', 'SimDataBlock') +bl.class('TSShapeConstructor', 'SimDataBlock') +bl.class('AudioProfile', 'SimDataBlock') +bl.class('ParticleData', 'SimDataBlock') +bl.class('MaterialPropertyMap', 'SimObject') +bl.class('NetObject', 'SimObject') +bl.class('SceneObject', 'NetObject') +bl.class('GameBase', 'SceneObject') +bl.class('ShapeBase', 'GameBase') +bl.class('MissionMarker', 'ShapeBase') +bl.class('SpawnSphere', 'MissionMarker') +bl.class('VehicleSpawnMarker', 'MissionMarker') +bl.class('Waypoint', 'MissionMarker') +bl.class('StaticShape', 'ShapeBase') +bl.class('ScopeAlwaysShape', 'StaticShape') +bl.class('Player', 'ShapeBase') +bl.class('AIPlayer', 'Player') +bl.class('Camera', 'ShapeBase') +bl.class('Item', 'ShapeBase') +bl.class('PathCamera', 'ShapeBase') +bl.class('Vehicle', 'ShapeBase') +bl.class('FlyingVehicle', 'Vehicle') +bl.class('WheeledVehicle', 'Vehicle') +bl.class('Explosion', 'GameBase') +bl.class('Splash', 'GameBase') +bl.class('Debris', 'GameBase') +bl.class('Projectile', 'GameBase') +bl.class('Trigger', 'GameBase') +bl.class('fxLight', 'GameBase') +bl.class('Lightning', 'GameBase') +bl.class('ParticleEmitterNode', 'GameBase') +bl.class('ParticleEmitter', 'GameBase') +bl.class('Precipitation', 'GameBase') +bl.class('TSStatic', 'SceneObject') +bl.class('VehicleBlocker', 'SceneObject') +bl.class('Marker', 'SceneObject') +bl.class('AudioEmitter', 'SceneObject') +bl.class('PhysicalZone', 'SceneObject') +bl.class('fxDayCycle', 'SceneObject') +bl.class('fxDTSBrick', 'SceneObject') +bl.class('fxPlane', 'SceneObject') +bl.class('fxSunLight', 'SceneObject') +bl.class('Sky', 'SceneObject') +bl.class('SceneRoot', 'SceneObject') +bl.class('Sun', 'NetObject') +bl.class('GuiCursor', 'SimObject') +bl.class('ConsoleLogger', 'SimObject') +bl.class('QuotaObject', 'SimObject') +bl.class('FileObject', 'SimObject') +bl.class('BanList', 'SimObject') +bl.class('GuiControlProfile', 'SimObject') +bl.class('MessageVector', 'SimObject') +bl.class('ActionMap', 'SimObject') -- Auto-generated from game scripts bl.type('ActionMap::blockBind:1', 'object') diff --git a/src/util/libbl.lua b/src/util/libbl.lua index 62ea1a6..7508e19 100644 --- a/src/util/libbl.lua +++ b/src/util/libbl.lua @@ -10,69 +10,69 @@ bl = bl or {} -- Misc -- Apply a function to each element in a list, building a new list from the returns -local function map(t,f) +local function map(t, f) local u = {} - for i,v in ipairs(t) do + for i, v in ipairs(t) do u[i] = f(v) end return u end local function isValidFuncName(name) - return type(name)=='string' and name:find('^[a-zA-Z0-9_]+$') + return type(name) == 'string' and name:find('^[a-zA-Z0-9_]+$') end local function isValidFuncNameNs(name) - return type(name)=='string' and ( + return type(name) == 'string' and ( name:find('^[a-zA-Z0-9_]+$') or - name:find('^[a-zA-Z0-9_]+::[a-zA-Z0-9_]+$') ) + name:find('^[a-zA-Z0-9_]+::[a-zA-Z0-9_]+$')) end local function isValidFuncNameNsArgn(name) - return type(name)=='string' and ( + return type(name) == 'string' and ( name:find('^[a-zA-Z0-9_]+$') or name:find('^[a-zA-Z0-9_]+%.[a-zA-Z0-9_]+$') or name:find('^[a-zA-Z0-9_]+::[a-zA-Z0-9_]+$') or name:find('^[a-zA-Z0-9_]+:[0-9]+$') or - name:find('^[a-zA-Z0-9_]+::[a-zA-Z0-9_]+:[0-9]+$') ) + name:find('^[a-zA-Z0-9_]+::[a-zA-Z0-9_]+:[0-9]+$')) end -- Whether a var can be converted into a TS vector local function isTsVector(val) - if type(val)~='table' then return false end - if #val~=3 and #val~=2 then return false end + if type(val) ~= 'table' then return false end + if #val ~= 3 and #val ~= 2 then return false end if val.__is_vector then return true end - for _,v in ipairs(val) do - if type(v)~='number' then return false end + for _, v in ipairs(val) do + if type(v) ~= 'number' then return false end end return true end -- Use strings for object types instead of integer bitmasks like in TS local tsTypesByName = { - ['all'] = -1, - ['static'] = 1, - ['environment'] = 2, - ['terrain'] = 4, - ['water'] = 16, - ['trigger'] = 32, - ['marker'] = 64, - ['gamebase'] = 1024, - ['shapebase'] = 2048, - ['camera'] = 4096, - ['staticshape'] = 8192, - ['player'] = 16384, - ['item'] = 32768, - ['vehicle'] = 65536, - ['vehicleblocker'] = 131072, - ['projectile'] = 262144, - ['explosion'] = 524288, - ['corpse'] = 1048576, - ['debris'] = 4194304, - ['physicalzone'] = 8388608, - ['staticts'] = 16777216, - ['brick'] = 33554432, - ['brickalways'] = 67108864, + ['all'] = -1, + ['static'] = 1, + ['environment'] = 2, + ['terrain'] = 4, + ['water'] = 16, + ['trigger'] = 32, + ['marker'] = 64, + ['gamebase'] = 1024, + ['shapebase'] = 2048, + ['camera'] = 4096, + ['staticshape'] = 8192, + ['player'] = 16384, + ['item'] = 32768, + ['vehicle'] = 65536, + ['vehicleblocker'] = 131072, + ['projectile'] = 262144, + ['explosion'] = 524288, + ['corpse'] = 1048576, + ['debris'] = 4194304, + ['physicalzone'] = 8388608, + ['staticts'] = 16777216, + ['brick'] = 33554432, + ['brickalways'] = 67108864, ['staticrendered'] = 134217728, ['damagableitem'] = 268435456, } local tsTypesByNum = {} -for k,v in pairs(tsTypesByName) do +for k, v in pairs(tsTypesByName) do tsTypesByNum[v] = k end @@ -80,45 +80,46 @@ end local toTsObject -- Convert a string from TS into a boolean -- Note: Nonempty nonnumeric strings evaluate to 1, unlike in TS -local function tsBool(v) return v~='' and v~='0' end +local function tsBool(v) return v ~= '' and v ~= '0' end -- Convert a Lua var into a TS string, or error if not possible local function valToTs(val) - if val==nil then -- nil -> '' + if val == nil then -- nil -> '' return '' - elseif type(val)=='boolean' then -- bool -> 0 or 1 + elseif type(val) == 'boolean' then -- bool -> 0 or 1 return val and '1' or '0' - elseif type(val)=='number' then -- number + elseif type(val) == 'number' then -- number return tostring(val) - elseif type(val)=='string' then -- string + elseif type(val) == 'string' then -- string return val - elseif type(val)=='table' then - if val._tsObjectId then -- object -> object id + elseif type(val) == 'table' then + if val._tsObjectId then -- object -> object id return tostring(val._tsObjectId) - elseif isTsVector(val) then -- vector - > 3 numbers + elseif isTsVector(val) then -- vector - > 3 numbers return table.concat(val, ' ') - elseif #val==2 and isTsVector(val[1]) and isTsVector(val[2]) then + elseif #val == 2 and isTsVector(val[1]) and isTsVector(val[2]) then -- box - > 6 numbers - return table.concat(val[1], ' ')..' '..table.concat(val[2], ' ') + return table.concat(val[1], ' ') .. ' ' .. table.concat(val[2], ' ') else error('valToTs: could not convert table', 3) end else - error('valToTs: could not convert '..type(val), 3) + error('valToTs: could not convert ' .. type(val), 3) end end local function convertValFromTs(val, typ) - if typ=='boolean' then + if typ == 'boolean' then return tsBool(val) - elseif typ=='object' then + elseif typ == 'object' then return toTsObject(val) else - error('valFromTs: invalid force type '..typ, 4) + error('valFromTs: invalid force type ' .. typ, 4) end end bl._forceType = bl._forceType or {} local function valFromTs(val, name, name2) -- todo: ensure name and name2 are already lowercase - if type(val)~='string' then - error('valFromTs: expected string, got '..type(val), 3) end + if type(val) ~= 'string' then + error('valFromTs: expected string, got ' .. type(val), 3) + end if name then name = name:lower() if bl._forceType[name] then @@ -132,27 +133,29 @@ local function valFromTs(val, name, name2) -- todo: ensure name and name2 are al end end -- '' -> nil - if val=='' then return nil end + if val == '' then return nil end -- number local num = tonumber(val) if num then return num end -- vector - local xS,yS,zS = val:match('^(%-?[0-9%.e]+) (%-?[0-9%.e]+) (%-?[0-9%.e]+)$') - if xS then return vector{tonumber(xS),tonumber(yS),tonumber(zS)} end - local x1S,y1S,z1S,x2S,y2S,z2S = val:match( - '^(%-?[0-9%.e]+) (%-?[0-9%.e]+) (%-?[0-9%.e]+) '.. + local xS, yS, zS = val:match('^(%-?[0-9%.e]+) (%-?[0-9%.e]+) (%-?[0-9%.e]+)$') + if xS then return vector { tonumber(xS), tonumber(yS), tonumber(zS) } end + local x1S, y1S, z1S, x2S, y2S, z2S = val:match( + '^(%-?[0-9%.e]+) (%-?[0-9%.e]+) (%-?[0-9%.e]+) ' .. '(%-?[0-9%.e]+) (%-?[0-9%.e]+) (%-?[0-9%.e]+)$') -- box (2 vectors) - if x1S then return { - vector{tonumber(x1S),tonumber(y1S),tonumber(z1S)}, - vector{tonumber(x2S),tonumber(y2S),tonumber(z2S)} } end + if x1S then + return { + vector { tonumber(x1S), tonumber(y1S), tonumber(z1S) }, + vector { tonumber(x2S), tonumber(y2S), tonumber(z2S) } } + end -- string return val end local function arglistFromTs(name, argsS) local args = {} - for i,arg in ipairs(argsS) do - args[i] = valFromTs(arg, name..':'..i) + for i, arg in ipairs(argsS) do + args[i] = valFromTs(arg, name .. ':' .. i) end return args end @@ -162,27 +165,30 @@ end local function classFromForceTypeStr(name) local class, rest = name:match('^([a-zA-Z0-9_]+)(::.+)$') if not class then - class, rest = name:match('^([a-zA-Z0-9_]+)(%..+)$') end - return class,rest + class, rest = name:match('^([a-zA-Z0-9_]+)(%..+)$') + end + return class, rest end local setForceType setForceType = function(ftname, typ) - if typ~='boolean' and typ~='object' and typ~=nil then - error('bl.type: can only set type to \'boolean\', \'object\', or nil', 2) end + if typ ~= 'boolean' and typ ~= 'object' and typ ~= nil then + error('bl.type: can only set type to \'boolean\', \'object\', or nil', 2) + end if not isValidFuncNameNsArgn(ftname) then - error('bl.type: invalid function or variable name \''..ftname..'\'', 2) end - + error('bl.type: invalid function or variable name \'' .. ftname .. '\'', 2) + end + ftname = ftname:lower() - + bl._forceType[ftname] = typ - + -- apply to child classes if present local cname, rest = classFromForceTypeStr(ftname) if cname then local meta = bl._objectUserMetas[cname] if meta then - for chcname,_ in pairs(meta._children) do - setForceType(chcname..rest, typ) + for chcname, _ in pairs(meta._children) do + setForceType(chcname .. rest, typ) end end end @@ -193,7 +199,7 @@ bl.type = setForceType -- Value detection local function isTsObject(t) - return type(t)=='table' and t._tsObjectId~=nil + return type(t) == 'table' and t._tsObjectId ~= nil end local function tsIsObject(name) return tsBool(_bllua_ts.call('isObject', name)) end @@ -201,26 +207,32 @@ local function tsIsFunction(name) return tsBool(_bllua_ts.call('isFunction', nam local function tsIsFunctionNs(ns, name) return tsBool(_bllua_ts.call('isFunction', ns, name)) end local function tsIsFunctionNsname(nsname) local ns, name = nsname:match('^([^:]+)::([^:]+)$') - if ns then return tsIsFunctionNs(ns, name) - else return tsIsFunction(nsname) end + if ns then + return tsIsFunctionNs(ns, name) + else + return tsIsFunction(nsname) + end end function bl.isObject(obj) if isTsObject(obj) then obj = obj._tsObjectId - elseif type(obj)=='number' then + elseif type(obj) == 'number' then obj = tostring(obj) - elseif type(obj)~='string' then + elseif type(obj) ~= 'string' then error('bl.isObject: argument #1: expected torque object, number, or string', 2) end return tsIsObject(obj) end + function bl.isFunction(a1, a2) - if type(a1)~='string' then - error('bl.isFunction: argument #1: expected string', 2) end + if type(a1) ~= 'string' then + error('bl.isFunction: argument #1: expected string', 2) + end if a2 then - if type(a2)~='string' then - error('bl.isFunction: argument #2: expected string', 2) end + if type(a2) ~= 'string' then + error('bl.isFunction: argument #2: expected string', 2) + end return tsIsFunctionNs(a1, a2) else return tsIsFunction(a1) @@ -230,18 +242,20 @@ end -- Torque object pseudo-class local tsClassMeta = { __tostring = function(t) - return 'torqueClass:'..t._name.. - (t._inherit and (':'..t._inherit._name) or '') + return 'torqueClass:' .. t._name .. + (t._inherit and (':' .. t._inherit._name) or '') end, } bl._objectUserMetas = bl._objectUserMetas or {} function bl.class(cname, inhname) - if not ( type(cname)=='string' and isValidFuncName(cname) ) then - error('bl.class: argument #1: invalid class name', 2) end - if not ( inhname==nil or (type(inhname)=='string' and isValidFuncName(inhname)) ) then - error('bl.class: argument #2: inherit name must be a string or nil', 2) end + if not (type(cname) == 'string' and isValidFuncName(cname)) then + error('bl.class: argument #1: invalid class name', 2) + end + if not (inhname == nil or (type(inhname) == 'string' and isValidFuncName(inhname))) then + error('bl.class: argument #2: inherit name must be a string or nil', 2) + end cname = cname:lower() - + local met = bl._objectUserMetas[cname] or { _name = cname, _inherit = nil, @@ -249,36 +263,40 @@ function bl.class(cname, inhname) } bl._objectUserMetas[cname] = met setmetatable(met, tsClassMeta) - + if inhname then inhname = inhname:lower() - + local inh = bl._objectUserMetas[inhname] - if not inh then error('bl.class: argument #2: \''..inhname..'\' is not the '.. - 'name of an existing class', 2) end - + if not inh then + error('bl.class: argument #2: \'' .. inhname .. '\' is not the ' .. + 'name of an existing class', 2) + end + inh._children[cname] = true - + local inhI = met._inherit - if inhI and inhI~=inh then - error('bl.class: argument #2: class already exists and '.. - 'inherits a different parent.', 2) end + if inhI and inhI ~= inh then + error('bl.class: argument #2: class already exists and ' .. + 'inherits a different parent.', 2) + end met._inherit = inh - + -- apply inherited method and field types for ftname, typ in pairs(bl._forceType) do local cname2, rest = classFromForceTypeStr(ftname) - if cname2==inhname then - setForceType(cname..rest, typ) + if cname2 == inhname then + setForceType(cname .. rest, typ) end end end end + local function objectInheritedMetas(name) local inh = bl._objectUserMetas[name:lower()] return function() local inhP = inh - if inhP==nil then return nil end + if inhP == nil then return nil end inh = inh._inherit return inhP end @@ -287,36 +305,39 @@ local tsObjectMeta = { -- __index: Called when accessing fields that don't exist in the object itself -- Return torque member function or value __index = function(t, name) - if rawget(t,'_deleted') then - error('ts object index: object no longer exists', 2) end - if type(name)~='string' and type(name)~='number' then - error('ts object index: index must be a string or number', 2) end + if rawget(t, '_deleted') then + error('ts object index: object no longer exists', 2) + end + if type(name) ~= 'string' and type(name) ~= 'number' then + error('ts object index: index must be a string or number', 2) + end if getmetatable(t)[name] then return getmetatable(t)[name] - elseif type(name)=='number' then - if not tsIsFunctionNs(rawget(t,'_tsNamespace'), 'getObject') then - error('ts object __index: index is number, but object does not have '.. - 'getObject method', 2) end + elseif type(name) == 'number' then + if not tsIsFunctionNs(rawget(t, '_tsNamespace'), 'getObject') then + error('ts object __index: index is number, but object does not have ' .. + 'getObject method', 2) + end return toTsObject(_bllua_ts.callobj(t._tsObjectId, 'getObject', tostring(name))) else - for inh in objectInheritedMetas(rawget(t,'_tsClassName')) do + for inh in objectInheritedMetas(rawget(t, '_tsClassName')) do if inh[name] then return inh[name] end end - if tsIsFunctionNs(rawget(t,'_tsNamespace'), name) then + if tsIsFunctionNs(rawget(t, '_tsNamespace'), name) then return function(t, ...) - local args = {...} + local args = { ... } local argsS = arglistToTs(args) return valFromTs( - _bllua_ts.callobj(rawget(t,'_tsObjectId'), name, unpack(argsS)), - rawget(t,'_tsName') and rawget(t,'_tsName')..'::'..name, - rawget(t,'_tsNamespace')..'::'..name) + _bllua_ts.callobj(rawget(t, '_tsObjectId'), name, unpack(argsS)), + rawget(t, '_tsName') and rawget(t, '_tsName') .. '::' .. name, + rawget(t, '_tsNamespace') .. '::' .. name) end else return valFromTs( - _bllua_ts.getfield(rawget(t,'_tsObjectId'), name), - rawget(t,'_tsName') and rawget(t,'_tsName')..'.'..name, - rawget(t,'_tsNamespace')..'.'..name) + _bllua_ts.getfield(rawget(t, '_tsObjectId'), name), + rawget(t, '_tsName') and rawget(t, '_tsName') .. '.' .. name, + rawget(t, '_tsNamespace') .. '.' .. name) end end end, @@ -324,61 +345,71 @@ local tsObjectMeta = { -- Set lua data -- Use :set() to set Torque data __newindex = function(t, name, val) - if rawget(t,'_deleted') then - error('ts object newindex: object no longer exists', 2) end - if type(name)~='string' then - error('ts object newindex: index must be a string', 2) end + if rawget(t, '_deleted') then + error('ts object newindex: object no longer exists', 2) + end + if type(name) ~= 'string' then + error('ts object newindex: index must be a string', 2) + end rawset(t, name, val) -- create strong reference since it's now storing lua data - bl._objectsStrong[rawget(t,'_tsObjectId')] = t + bl._objectsStrong[rawget(t, '_tsObjectId')] = t end, -- object:set(fieldName, value) -- Use to set torque data set = function(t, name, val) - if t==nil or type(t)~='table' or not t._tsObjectId then - error('ts object method: be sure to use :func() not .func()', 2) end + if t == nil or type(t) ~= 'table' or not t._tsObjectId then + error('ts object method: be sure to use :func() not .func()', 2) + end if t._deleted then - error('ts object method: object no longer exists', 2) end - if type(name)~='string' then - error('ts object :set(): index must be a string', 2) end + error('ts object method: object no longer exists', 2) + end + if type(name) ~= 'string' then + error('ts object :set(): index must be a string', 2) + end _bllua_ts.setfield(t._tsObjectId, name, valToTs(val)) end, -- __tostring: Called when printing -- Display a nice info string __tostring = function(t) - return 'torque:'..t._tsNamespace..':'..t._tsObjectId.. - (t._tsName~='' and ('('..t._tsName..')') or '') + return 'torque:' .. t._tsNamespace .. ':' .. t._tsObjectId .. + (t._tsName ~= '' and ('(' .. t._tsName .. ')') or '') end, -- #object -- If the object has a getCount method, return its count __len = function(t) if t._deleted then - error('ts object __len: object no longer exists', 2) end + error('ts object __len: object no longer exists', 2) + end if not tsIsFunctionNs(t._tsNamespace, 'getCount') then - error('ts object __len: object has no getCount method', 2) end + error('ts object __len: object has no getCount method', 2) + end return tonumber(_bllua_ts.callobj(t._tsObjectId, 'getCount')) end, -- object:members() -- Return an iterator for Torque objects with the getCount and getObject methods -- for index, object in group:members() do ... end members = function(t) - if t==nil then - error('ts object method: be sure to use :func() not .func()', 2) end + if t == nil then + error('ts object method: be sure to use :func() not .func()', 2) + end if t._deleted then - error('ts object method: object no longer exists', 2) end + error('ts object method: object no longer exists', 2) + end if not ( - tsIsFunctionNs(t._tsNamespace, 'getCount' ) and - tsIsFunctionNs(t._tsNamespace, 'getObject')) then - error('ts object :members() - '.. - 'Object does not have getCount and getObject methods', 2) end + tsIsFunctionNs(t._tsNamespace, 'getCount') and + tsIsFunctionNs(t._tsNamespace, 'getObject')) then + error('ts object :members() - ' .. + 'Object does not have getCount and getObject methods', 2) + end local count = tonumber(_bllua_ts.callobj(t._tsObjectId, 'getCount')) local idx = 0 return function() if idx < count then local obj = toTsObject(_bllua_ts.callobj(t._tsObjectId, 'getObject', tostring(idx))) - idx = idx+1 - return idx-1, obj + idx = idx + 1 + return idx - 1, obj else return nil end @@ -386,24 +417,30 @@ local tsObjectMeta = { end, -- Wrap some Torque functions for performance and error checking getName = function(t) - if t==nil then - error('ts object method: be sure to use :func() not .func()', 2) end + if t == nil then + error('ts object method: be sure to use :func() not .func()', 2) + end if t._deleted then - error('ts object method: object no longer exists', 2) end + error('ts object method: object no longer exists', 2) + end return t._tsName end, getId = function(t) - if t==nil then - error('ts object method: be sure to use :func() not .func()', 2) end + if t == nil then + error('ts object method: be sure to use :func() not .func()', 2) + end if t._deleted then - error('ts object method: object no longer exists', 2) end + error('ts object method: object no longer exists', 2) + end return tonumber(t._tsObjectId) end, getType = function(t) - if t==nil then - error('ts object method: be sure to use :func() not .func()', 2) end + if t == nil then + error('ts object method: be sure to use :func() not .func()', 2) + end if t._deleted then - error('ts object method: object no longer exists', 2) end + error('ts object method: object no longer exists', 2) + end return tsTypesByNum[_bllua_ts.callobj(t._tsObjectId, 'getType')] end, ---- Schedule method for objects @@ -424,10 +461,12 @@ local tsObjectMeta = { -- end) --end, exists = function(t) - if t==nil then - error('ts object method: be sure to use :func() not .func()', 2) end + if t == nil then + error('ts object method: be sure to use :func() not .func()', 2) + end if t._deleted then - return false end + return false + end return tsIsObject(t._tsObjectId) end, } @@ -435,7 +474,7 @@ local tsObjectMeta = { -- Objects in this table can be garbage collected if there are no other refs to them if not bl._objectsWeak then bl._objectsWeak = {} - setmetatable(bl._objectsWeak, { __mode='v' }) + setmetatable(bl._objectsWeak, { __mode = 'v' }) end -- Strong table for preserving Torque object references containing lua data -- If an object in this table, it will remain here and in the Weak table until deleted @@ -456,25 +495,27 @@ end -- Return a Torque object for the object ID string, or create one if none exists toTsObject = function(idiS) - if type(idiS)~='string' then - error('toTsObject: input must be a string', 2) end + if type(idiS) ~= 'string' then + error('toTsObject: input must be a string', 2) + end idiS = idiS:lower() if bl._objectsWeak[idiS] then return bl._objectsWeak[idiS] end - + if not tsBool(_bllua_ts.call('isObject', idiS)) then --error('toTsObject: object \''..idiS..'\' does not exist', 2) end - return nil end - + return nil + end + local className = _bllua_ts.callobj(idiS, 'getClassName') local obj = { - _tsObjectId = _bllua_ts.callobj(idiS, 'getId' ), - _tsName = _bllua_ts.callobj(idiS, 'getName' ), + _tsObjectId = _bllua_ts.callobj(idiS, 'getId'), + _tsName = _bllua_ts.callobj(idiS, 'getName'), _tsNamespace = className, _tsClassName = className:lower(), } setmetatable(obj, tsObjectMeta) - - bl._objectsWeak[obj._tsObjectId ] = obj + + bl._objectsWeak[obj._tsObjectId] = obj bl._objectsWeak[obj._tsName:lower()] = obj return obj end @@ -490,14 +531,14 @@ local tsMeta = { __index = function(t, name) if getmetatable(t)[name] then return getmetatable(t)[name] - elseif type(name)=='string' and bl._objectUserMetas[name:lower()] then + elseif type(name) == 'string' and bl._objectUserMetas[name:lower()] then return bl._objectUserMetas[name:lower()] else - if type(name)=='number' then + if type(name) == 'number' then return toTsObject(tostring(name)) elseif name:find('::') then local ns, rest = name:match('^([^:]+)::(.+)$') - if not ns then error('ts index: invalid name \''..name..'\'', 2) end + if not ns then error('ts index: invalid name \'' .. name .. '\'', 2) end if not rest:find('::') and tsIsFunctionNs(ns, rest) then error('ts index: can\'t call a namespaced function from lua', 2) else @@ -505,7 +546,7 @@ local tsMeta = { end elseif tsIsFunction(name) then return function(...) - local args = {...} + local args = { ... } local argsS = arglistToTs(args) return valFromTs(_bllua_ts.call(name, unpack(argsS)), name) end @@ -526,40 +567,47 @@ end -- Utility functions function bl.call(func, ...) - local args = {...} + local args = { ... } local argsS = arglistToTs(args) return _bllua_ts.call(func, unpack(argsS)) end + function bl.eval(code) return valFromTs(_bllua_ts.eval(code)) end + function bl.exec(file) return valFromTs(_bllua_ts.call('exec', file)) end + function bl.boolean(val) - return val~=nil and - val~=false and + return val ~= nil and + val ~= false and --val~='' and --val~='0' and - val~=0 + val ~= 0 end + function bl.object(id) - if type(id)=='table' and id._tsObjectId then + if type(id) == 'table' and id._tsObjectId then return id - elseif type(id)=='string' or type(id)=='number' then + elseif type(id) == 'string' or type(id) == 'number' then return toTsObject(tostring(id)) else error('bl.toobject: id must be a ts object, number, or string', 2) end end + function bl.array(name, ...) - local rest = {...} - return name..table.concat(rest, '_') + local rest = { ... } + return name .. table.concat(rest, '_') end + function _bllua_call(fnameS, ...) - local args = arglistFromTs(fnameS:lower(), {...}) + local args = arglistFromTs(fnameS:lower(), { ... }) if not _G[fnameS] then - error('luacall: no global lua function named \''..fnameS..'\'') end + error('luacall: no global lua function named \'' .. fnameS .. '\'') + end -- todo: library fields and object methods local res = _G[fnameS](args) return valToTs(res) @@ -567,7 +615,7 @@ end -- bl.schedule: Use TS's schedule function to schedule lua calls -- bl.schedule(time, function, args...) -bl._scheduleTable = bl._scheduleTable or {} +bl._scheduleTable = bl._scheduleTable or {} bl._scheduleNextId = bl._scheduleNextId or 1 local function cancelTsSched(sched) if not (sched and sched.handle) then @@ -578,8 +626,8 @@ local function cancelTsSched(sched) end function bl.schedule(time, cb, ...) local id = bl._scheduleNextId - bl._scheduleNextId = bl._scheduleNextId+1 - local args = {...} + bl._scheduleNextId = bl._scheduleNextId + 1 + local args = { ... } local handle = tonumber(_bllua_ts.call('schedule', time, 0, '_bllua_luacall', '_bllua_schedule_callback', id)) local sch = { @@ -591,11 +639,12 @@ function bl.schedule(time, cb, ...) bl._scheduleTable[id] = sch return sch end + function _bllua_schedule_callback(idS) local id = tonumber(idS) or - error('_bllua_schedule_callback: invalid id: '..tostring(idS)) + error('_bllua_schedule_callback: invalid id: ' .. tostring(idS)) local sch = bl._scheduleTable[id] - if not sch then error('_bllua_schedule_callback: no schedule with id '..id) end + if not sch then error('_bllua_schedule_callback: no schedule with id ' .. id) end bl._scheduleTable[id] = nil sch.callback(unpack(sch.args)) end @@ -604,52 +653,57 @@ end bl._cmds = bl._cmds or {} function _bllua_process_cmd(cmdS, ...) local cmd = cmdS:lower() - local args = arglistFromTs(cmd, {...}) + local args = arglistFromTs(cmd, { ... }) local func = bl._cmds[cmd] - if not func then error('_bllua_process_cmd: no cmd named \''..cmd..'\'') end + if not func then error('_bllua_process_cmd: no cmd named \'' .. cmd .. '\'') end func(unpack(args)) --pcall(func, unpack(args)) end + local function addCmd(cmd, func) if not isValidFuncName(cmd) then - error('addCmd: invalid function name \''..tostring(cmd)..'\'') end + error('addCmd: invalid function name \'' .. tostring(cmd) .. '\'') + end bl._cmds[cmd] = func local arglist = '%a,%b,%c,%d,%e,%f,%g,%h,%i,%j,%k,%l,%m,%n,%o,%p' - _bllua_ts.eval('function '..cmd..'('..arglist..'){'.. - '_bllua_luacall(_bllua_process_cmd,"'..cmd..'",'..arglist..');}') + _bllua_ts.eval('function ' .. cmd .. '(' .. arglist .. '){' .. + '_bllua_luacall(_bllua_process_cmd,"' .. cmd .. '",' .. arglist .. ');}') end function bl.addServerCmd(name, func) name = name:lower() - addCmd('servercmd'..name, func) - bl._forceType['servercmd'..name..':1'] = 'object' + addCmd('servercmd' .. name, func) + bl._forceType['servercmd' .. name .. ':1'] = 'object' end + function bl.addClientCmd(name, func) name = name:lower() - addCmd('clientcmd'..name, func) + addCmd('clientcmd' .. name, func) end -- commandToServer and commandToClient function bl.commandToServer(cmd, ...) _bllua_ts.call('commandToServer', _bllua_ts.call('addTaggedString', cmd), - unpack(arglistToTs({...}))) + unpack(arglistToTs({ ... }))) end + function bl.commandToClient(cmd, ...) _bllua_ts.call('commandToClient', _bllua_ts.call('addTaggedString', cmd), - unpack(arglistToTs({...}))) + unpack(arglistToTs({ ... }))) end + function bl.commandToAll(cmd, ...) _bllua_ts.call('commandToAll', _bllua_ts.call('addTaggedString', cmd), - unpack(arglistToTs({...}))) + unpack(arglistToTs({ ... }))) end -- Hooks (using TS packages) local function isPackageActive(pkg) local numpkgs = tonumber(_bllua_ts.call('getNumActivePackages')) - for i = 0, numpkgs-1 do + for i = 0, numpkgs - 1 do local apkg = _bllua_ts.call('getActivePackage', tostring(i)) - if apkg==pkg then return true end + if apkg == pkg then return true end end return false end @@ -665,89 +719,102 @@ local function deactivatePackage(pkg) end local hookNargs = 8 local hookArglistLocal = '%a,%b,%c,%d,%e,%f,%g,%h' -local hookArglistGlobal = '$_bllua_hook_arg1,$_bllua_hook_arg2,$_bllua_hook_arg3,$_bllua_hook_arg4,$_bllua_hook_arg5,$_bllua_hook_arg6,$_bllua_hook_arg7,$_bllua_hook_arg8' +local hookArglistGlobal = +'$_bllua_hook_arg1,$_bllua_hook_arg2,$_bllua_hook_arg3,$_bllua_hook_arg4,$_bllua_hook_arg5,$_bllua_hook_arg6,$_bllua_hook_arg7,$_bllua_hook_arg8' bl._hooks = bl._hooks or {} function _bllua_process_hook_before(pkgS, nameS, ...) - local args = arglistFromTs(nameS, {...}) + local args = arglistFromTs(nameS, { ... }) local func = bl._hooks[pkgS] and bl._hooks[pkgS][nameS] and bl._hooks[pkgS][nameS].before if not func then - error('_bllua_process_hook_before: no hook for '..pkgs..':'..nameS) end + error('_bllua_process_hook_before: no hook for ' .. pkgs .. ':' .. nameS) + end _bllua_ts.setvar('_bllua_hook_abort', '0') func(args) --pcall(func, args) if args._return then _bllua_ts.setvar('_bllua_hook_abort', '1') _bllua_ts.setvar('_bllua_hook_return', valToTs(args._return)) end - for i=1,hookNargs do - _bllua_ts.setvar('_bllua_hook_arg'..i, valToTs(args[i])) + for i = 1, hookNargs do + _bllua_ts.setvar('_bllua_hook_arg' .. i, valToTs(args[i])) end end + function _bllua_process_hook_after(pkgS, nameS, resultS, ...) nameS = nameS:lower() - local args = arglistFromTs(nameS, {...}) + local args = arglistFromTs(nameS, { ... }) args._return = valFromTs(resultS, nameS) local func = bl._hooks[pkgS] and bl._hooks[pkgS][nameS] and bl._hooks[pkgS][nameS].after if not func then - error('_bllua_process_hook_after: no hook for '..pkgs..':'..nameS) end + error('_bllua_process_hook_after: no hook for ' .. pkgs .. ':' .. nameS) + end func(args) --pcall(func, args) return valToTs(args._return) end + local function updateHook(pkg, name, hk) local beforeCode = hk.before and - ('_bllua_luacall("_bllua_process_hook_before", "'..pkg..'","'..name.. - '",'..hookArglistLocal..');') or '' + ('_bllua_luacall("_bllua_process_hook_before", "' .. pkg .. '","' .. name .. + '",' .. hookArglistLocal .. ');') or '' local arglist = (hk.before and hookArglistGlobal or hookArglistLocal) local parentCode = tsIsFunctionNsname(name) and -- only call parent if it exists - (hk.before and - 'if($_bllua_hook_abort)return $_bllua_hook_return; else ' or '').. - ((hk.after and '%result=' or 'return ').. - 'parent::'..name:match('[^:]+$').. - '('..arglist..');') or '' + (hk.before and + 'if($_bllua_hook_abort)return $_bllua_hook_return; else ' or '') .. + ((hk.after and '%result=' or 'return ') .. + 'parent::' .. name:match('[^:]+$') .. + '(' .. arglist .. ');') or '' local afterCode = hk.after and - ('return _bllua_luacall("_bllua_process_hook_after","'..pkg..'","'..name..'",%result,'.. - arglist..');') or '' + ('return _bllua_luacall("_bllua_process_hook_after","' .. pkg .. '","' .. name .. '",%result,' .. + arglist .. ');') or '' local code = - 'package '..pkg..'{'.. - 'function '..name..'('..hookArglistLocal..'){'.. - beforeCode..parentCode..afterCode.. - '}'.. + 'package ' .. pkg .. '{' .. + 'function ' .. name .. '(' .. hookArglistLocal .. '){' .. + beforeCode .. parentCode .. afterCode .. + '}' .. '};' _bllua_ts.eval(code) end function bl.hook(pkg, name, time, func) if not isValidFuncName(pkg) then - error('bl.hook: argument #1: invalid package name \''..tostring(pkg)..'\'', 2) end + error('bl.hook: argument #1: invalid package name \'' .. tostring(pkg) .. '\'', 2) + end if not isValidFuncNameNs(name) then - error('bl.hook: argument #2: invalid function name \''..tostring(name)..'\'', 2) end - if time~='before' and time~='after' then - error('bl.hook: argument #3: time must be \'before\' or \'after\'', 2) end - if type(func)~='function' then - error('bl.hook: argument #4: expected a function', 2) end - - bl._hooks[pkg] = bl._hooks[pkg] or {} + error('bl.hook: argument #2: invalid function name \'' .. tostring(name) .. '\'', 2) + end + if time ~= 'before' and time ~= 'after' then + error('bl.hook: argument #3: time must be \'before\' or \'after\'', 2) + end + if type(func) ~= 'function' then + error('bl.hook: argument #4: expected a function', 2) + end + + bl._hooks[pkg] = bl._hooks[pkg] or {} bl._hooks[pkg][name] = bl._hooks[pkg][name] or {} bl._hooks[pkg][name][time] = func - + updateHook(pkg, name, bl._hooks[pkg][name]) activatePackage(pkg) end + local function tableEmpty(t) - return next(t)~=nil + return next(t) ~= nil end function bl.unhook(pkg, name, time) if not isValidFuncName(pkg) then - error('bl.unhook: argument #1: invalid package name \''..tostring(pkg)..'\'', 2) end + error('bl.unhook: argument #1: invalid package name \'' .. tostring(pkg) .. '\'', 2) + end if not isValidFuncNameNs(name) then - error('bl.unhook: argument #2: invalid function name \''..tostring(name)..'\'', 2) end - if time~='before' and time~='after' then - error('bl.unhook: argument #3: time must be \'before\' or \'after\'', 2) end - + error('bl.unhook: argument #2: invalid function name \'' .. tostring(name) .. '\'', 2) + end + if time ~= 'before' and time ~= 'after' then + error('bl.unhook: argument #3: time must be \'before\' or \'after\'', 2) + end + if not name then if bl._hooks[pkg] then - for name,hk in pairs(bl._hooks[pkg]) do + for name, hk in pairs(bl._hooks[pkg]) do updateHook(pkg, name, {}) end bl._hooks[pkg] = nil @@ -766,8 +833,9 @@ function bl.unhook(pkg, name, time) end updateHook(pkg, name, {}) else - if time~='before' and time~='after' then - error('bl.unhook: argument #3: time must be nil, \'before\', or \'after\'', 2) end + if time ~= 'before' and time ~= 'after' then + error('bl.unhook: argument #3: time must be nil, \'before\', or \'after\'', 2) + end bl._hooks[pkg][name][time] = nil if tableEmpty(bl._hooks[pkg][name]) and tableEmpty(bl._hooks[pkg]) then bl._hooks[pkg] = nil @@ -787,24 +855,27 @@ end -- Container search/raycast local function vecToTs(v) if not isTsVector(v) then - error('vecToTs: argument is not a vector', 3) end + error('vecToTs: argument is not a vector', 3) + end return table.concat(v, ' ') end local function maskToTs(mask) - if type(mask)=='string' then + if type(mask) == 'string' then local val = tsTypesByName[mask:lower()] if not val then - error('maskToTs: invalid mask \''..mask..'\'', 3) end + error('maskToTs: invalid mask \'' .. mask .. '\'', 3) + end return tostring(val) - elseif type(mask)=='table' then + elseif type(mask) == 'table' then local tval = 0 local seen = {} - for i,v in ipairs(mask) do + for i, v in ipairs(mask) do if not seen[v] then local val = tsTypesByName[v:lower()] if not val then - error('maskToTs: invalid mask \''..v.. - '\' at index '..i..' in mask list', 3) end + error('maskToTs: invalid mask \'' .. v .. + '\' at index ' .. i .. ' in mask list', 3) + end tval = tval + val seen[v] = true end @@ -815,12 +886,12 @@ local function maskToTs(mask) end end local function objToTs(obj) - if type(obj)=='number' or type(obj)=='string' then + if type(obj) == 'number' or type(obj) == 'string' then return tostring(obj) - elseif type(obj)=='table' and obj._tsObjectId then + elseif type(obj) == 'table' and obj._tsObjectId then return tostring(obj._tsObjectId) else - error('objToTs: invalid object \''..tostring(obj)..'\'', 3) + error('objToTs: invalid object \'' .. tostring(obj) .. '\'', 3) end end function bl.raycast(start, stop, mask, ignores) @@ -828,27 +899,28 @@ function bl.raycast(start, stop, mask, ignores) local stopS = vecToTs(start) local maskS = maskToTs(mask) local ignoresS = {} - for _,v in ipairs(ignores) do + for _, v in ipairs(ignores) do table.insert(ignoresS, objToTs(v)) end - + local retS = _bllua_ts.call('containerRaycast', startS, stopS, maskS, unpack(ignoresS)) - - if retS=='0' then + + if retS == '0' then return nil else - local hitS, pxS,pyS,pzS, nxS,nyS,nzS = retS:match('^([0-9]+) '.. - '(%-?[0-9%.e]+) (%-?[0-9%.e]+) (%-?[0-9%.e]+) '.. + local hitS, pxS, pyS, pzS, nxS, nyS, nzS = retS:match('^([0-9]+) ' .. + '(%-?[0-9%.e]+) (%-?[0-9%.e]+) (%-?[0-9%.e]+) ' .. '(%-?[0-9%.e]+) (%-?[0-9%.e]+) (%-?[0-9%.e]+)$') local hit = toTsObject(hitS) - local pos = vector{tonumber(pxS),tonumber(pyS),tonumber(pzS)} - local norm = vector{tonumber(nxS),tonumber(nyS),tonumber(nzS)} + local pos = vector { tonumber(pxS), tonumber(pyS), tonumber(pzS) } + local norm = vector { tonumber(nxS), tonumber(nyS), tonumber(nzS) } return hit, pos, norm end end + local function tsContainerSearchIterator() local retS = _bllua_ts.call('containerSearchNext') - if retS=='0' then + if retS == '0' then return nil else return toTsObject(retS) @@ -858,17 +930,19 @@ function bl.boxSearch(pos, size, mask) local posS = vecToTs(pos) local sizeS = vecToTs(size) local maskS = maskToTs(mask) - + _bllua_ts.call('initContainerBoxSearch', posS, sizeS, maskS) return tsContainerSearchIterator end + function bl.radiusSearch(pos, radius, mask) local posS = vecToTs(pos) - if type(radius)~='number' then - error('bl.radiusSearch: argument #2: radius must be a number', 2) end + if type(radius) ~= 'number' then + error('bl.radiusSearch: argument #2: radius must be a number', 2) + end local radiusS = tostring(radius) local maskS = maskToTs(mask) - + _bllua_ts.call('initContainerRadiusSearch', posS, radiusS, maskS) return tsContainerSearchIterator end @@ -877,9 +951,9 @@ end local maxTsArgLen = 8192 local function valsToString(vals) local strs = {} - for i,v in ipairs(vals) do + for i, v in ipairs(vals) do local tstr = table.tostring(v) - if #tstr>maxTsArgLen then + if #tstr > maxTsArgLen then tstr = tostring(v) end strs[i] = tstr @@ -887,12 +961,12 @@ local function valsToString(vals) return table.concat(strs, ' ') end bl.echo = function(...) - local str = valsToString({...}) + local str = valsToString({ ... }) _bllua_ts.call('echo', str) end print = bl.echo bl.talk = function(...) - local str = valsToString({...}) + local str = valsToString({ ... }) _bllua_ts.call('echo', str) _bllua_ts.call('talk', str) end @@ -900,20 +974,22 @@ end -- bl.new and bl.datablock local function createTsObj(keyword, class, name, inherit, props) local propsT = {} - for k,v in pairs(props) do + for k, v in pairs(props) do if not isValidFuncName(k) then - error('bl.new/bl.datablock: invalid property name \''..k..'\'') end - table.insert(propsT, k..'="'..valToTs(v)..'";') + error('bl.new/bl.datablock: invalid property name \'' .. k .. '\'') + end + table.insert(propsT, k .. '="' .. valToTs(v) .. '";') end - + local objS = _bllua_ts.eval( - 'return '..keyword..' '..class..'('.. - (name or '')..(inherit and (':'..inherit) or '')..'){'.. - table.concat(propsT)..'};') + 'return ' .. keyword .. ' ' .. class .. '(' .. + (name or '') .. (inherit and (':' .. inherit) or '') .. '){' .. + table.concat(propsT) .. '};') local obj = toTsObject(objS) if not obj then - error('bl.new/bl.datablock: failed to create object', 3) end - + error('bl.new/bl.datablock: failed to create object', 3) + end + return obj end local function parseTsDecl(decl) @@ -921,10 +997,10 @@ local function parseTsDecl(decl) if decl:find(' ') then -- class ... local cl, rest = decl:match('^([^ ]+) ([^ ]+)$') class = cl - if rest:find(':') then -- class name:inherit + if rest:find(':') then -- class name:inherit name, inherit = rest:match('^([^:]*):([^:]+)$') if not name then class = nil end -- error - if name=='' then name = nil end -- class :inherit + if name == '' then name = nil end -- class :inherit else name = rest end @@ -932,18 +1008,20 @@ local function parseTsDecl(decl) class = decl end if not ( - isValidFuncName(class) and - (name==nil or isValidFuncName(name)) and - (inherit==nil or isValidFuncName(inherit)) ) then - error('bl.new/bl.datablock: invalid decl \''..decl..'\'\n'.. - 'must be of the format: \'className\', \'className name\', '.. - '\'className :inherit\', or \'className name:inherit\'', 3) end + isValidFuncName(class) and + (name == nil or isValidFuncName(name)) and + (inherit == nil or isValidFuncName(inherit))) then + error('bl.new/bl.datablock: invalid decl \'' .. decl .. '\'\n' .. + 'must be of the format: \'className\', \'className name\', ' .. + '\'className :inherit\', or \'className name:inherit\'', 3) + end return class, name, inherit end function bl.new(decl, props) local class, name, inherit = parseTsDecl(decl) return createTsObj('new', class, name, inherit, props) end + function bl.datablock(decl, props) local class, name, inherit = parseTsDecl(decl) if not name then error('bl.datablock: must specify a name', 2) end diff --git a/src/util/libts-lua.lua b/src/util/libts-lua.lua index 96ef5fc..c881ead 100644 --- a/src/util/libts-lua.lua +++ b/src/util/libts-lua.lua @@ -1,4 +1,3 @@ - -- This Lua code provides some built-in utilities for writing Lua add-ons -- It is eval'd automatically once BLLua3 has loaded the TS API and environment -- It only has access to the sandboxed lua environment, just like user code. @@ -7,8 +6,9 @@ ts = _bllua_ts -- Provide limited OS functions os = os or {} -function os.time() return math.floor(tonumber(_bllua_ts.call('getSimTime'))/1000) end -function os.clock() return tonumber(_bllua_ts.call('getSimTime'))/1000 end +function os.time() return math.floor(tonumber(_bllua_ts.call('getSimTime')) / 1000) end + +function os.clock() return tonumber(_bllua_ts.call('getSimTime')) / 1000 end -- Virtual file class, emulating a file object as returned by io.open -- Used to wrap io.open to allow reading from zips (using TS) @@ -18,9 +18,9 @@ function os.clock() return tonumber(_bllua_ts.call('getSimTime'))/1000 end local file_meta = { read = function(file, mode) file:_init() - if not file or type(file)~='table' or not file._is_file then error('File:read: Not a file', 2) end + if not file or type(file) ~= 'table' or not file._is_file then error('File:read: Not a file', 2) end if file._is_open ~= true then error('File:read: File is closed', 2) end - if mode=='*n' then + if mode == '*n' then local ws, n = file.data:match('^([ \t\r\n]*)([0-9%.%-e]+)', file.pos) if n then file.pos = file.pos + #ws + #n @@ -28,15 +28,15 @@ local file_meta = { else return nil end - elseif mode=='*a' then + elseif mode == '*a' then local d = file.data:sub(file.pos, #file.data) file.pos = #file.data + 1 return d - elseif mode=='*l' then + elseif mode == '*l' then local l, ws = file.data:match('^([^\r\n]*)(\r?\n)', file.pos) if not l then l = file.data:match('^([^\r\n]*)$', file.pos); ws = ''; - if l=='' then return nil end + if l == '' then return nil end end if l then file.pos = file.pos + #l + #ws @@ -44,12 +44,12 @@ local file_meta = { else return nil end - elseif type(mode)=='number' then - local d = file.data:sub(file.pos, file.pos+mode) + elseif type(mode) == 'number' then + local d = file.data:sub(file.pos, file.pos + mode) file.pos = file.pos + #d return d else - error('File:read: Invalid mode \''..mode..'\'', 2) + error('File:read: Invalid mode \'' .. mode .. '\'', 2) end end, lines = function(file) @@ -82,24 +82,27 @@ local function new_file_obj(fn) return file end -local function tflip(t) local u = {}; for _, n in ipairs(t) do u[n] = true end; return u; end -local allowed_zip_dirs = tflip{ +local function tflip(t) + local u = {}; for _, n in ipairs(t) do u[n] = true end; return u; +end +local allowed_zip_dirs = tflip { 'add-ons', 'base', 'config', 'saves', 'screenshots', 'shaders' } local function io_open_absolute(fn, mode) -- if file exists, use original mode local res, err = _bllua_io_open(fn, mode) if res then return res end - + -- otherwise, if TS sees file but Lua doesn't, it must be in a zip, so use TS reader local dir = fn:match('^[^/]+') if not allowed_zip_dirs[dir:lower()] then return nil, 'File is not in one of the allowed directories' end local exist = _bllua_ts.call('isFile', fn) == '1' if not exist then return nil, err end - - if mode~=nil and mode~='r' and mode~='rb' then - return nil, 'Files in zips can only be opened in read mode' end - + + if mode ~= nil and mode ~= 'r' and mode ~= 'rb' then + return nil, 'Files in zips can only be opened in read mode' + end + -- return a temp lua file object with the data local fi = new_file_obj(fn) return fi @@ -108,13 +111,13 @@ end io = io or {} function io.open(fn, mode, errn) errn = errn or 1 - + -- try to open the file with relative path, otherwise use absolute path local curfn = debug.getfilename(errn + 1) or _bllua_ts.getvar('Con::File') if curfn == '' then curfn = nil end if fn:find('^%.') then local relfn = curfn and fn:find('^%./') and - curfn:gsub('[^/]+$', '')..fn:gsub('^%./', '') + curfn:gsub('[^/]+$', '') .. fn:gsub('^%./', '') if relfn then local fi, err = io_open_absolute(relfn, mode) return fi, err, relfn @@ -126,13 +129,15 @@ function io.open(fn, mode, errn) return fi, err, fn end end + function io.lines(fn) local fi, err, fn2 = io.open(fn, nil, 2) - if not fi then error('Error opening file \''..fn2..'\': '..err, 2) end + if not fi then error('Error opening file \'' .. fn2 .. '\': ' .. err, 2) end return fi:lines() end + function io.type(f) - if type(f)=='table' and f._is_file then + if type(f) == 'table' and f._is_file then return f._is_open and 'file' or 'closed file' else return _bllua_io_type(f) @@ -142,14 +147,14 @@ end -- provide dofile function dofile(fn, errn) errn = errn or 1 - - local fi, err, fn2 = io.open(fn, 'r', errn+1) - if not fi then error('Error executing file \''..fn2..'\': '..err, errn+1) end - - print('Executing '..fn2) + + local fi, err, fn2 = io.open(fn, 'r', errn + 1) + if not fi then error('Error executing file \'' .. fn2 .. '\': ' .. err, errn + 1) end + + print('Executing ' .. fn2) local text = fi:read('*a') fi:close() - return assert(loadstring('--[['..fn2..']]'..text))() + return assert(loadstring('--[[' .. fn2 .. ']]' .. text))() end -- provide require (just a wrapper for dofile) @@ -158,7 +163,7 @@ end -- blockland directory -- current add-on local function file_exists(fn, errn) - local fi, err, fn2 = io.open(fn, 'r', errn+1) + local fi, err, fn2 = io.open(fn, 'r', errn + 1) if fi then fi:close() return fn2 @@ -171,20 +176,20 @@ function require(mod) if require_memo[mod] then return unpack(require_memo[mod]) end local fp = mod:gsub('%.', '/') local fns = { - './'..fp..'.lua', -- local file - './'..fp..'/init.lua', -- local library - fp..'.lua', -- global file - fp..'/init.lua', -- global library + './' .. fp .. '.lua', -- local file + './' .. fp .. '/init.lua', -- local library + fp .. '.lua', -- global file + fp .. '/init.lua', -- global library } if fp:lower():find('^add-ons/') then - local addonpath = fp:lower():match('^add-ons/[^/]+')..'/' - table.insert(fns, addonpath..fp..'.lua') -- add-on file - table.insert(fns, addonpath..fp..'/init.lua') -- add-on library + local addonpath = fp:lower():match('^add-ons/[^/]+') .. '/' + table.insert(fns, addonpath .. fp .. '.lua') -- add-on file + table.insert(fns, addonpath .. fp .. '/init.lua') -- add-on library end - for _,fn in ipairs(fns) do + for _, fn in ipairs(fns) do local fne = file_exists(fn, 2) if fne then - local res = {dofile(fne, 2)} + local res = { dofile(fne, 2) } require_memo[mod] = res return unpack(res) end @@ -194,18 +199,22 @@ end -- Exposure to TS function _bllua_getvar(name) return _G[name] end + function _bllua_setvar(name, val) _G[name] = val end + function _bllua_eval(code) return loadstring(code)() end + function _bllua_exec(fn) return dofile(fn, 2) end local function isValidCode(code) - local f,e = loadstring(code) - return f~=nil + local f, e = loadstring(code) + return f ~= nil end function _bllua_smarteval(code) - if (not code:find('^print%(')) and isValidCode('print('..code..')') then - code = 'print('..code..')' end - local f,e = loadstring(code) + if (not code:find('^print%(')) and isValidCode('print(' .. code .. ')') then + code = 'print(' .. code .. ')' + end + local f, e = loadstring(code) if f then return f() else diff --git a/src/util/std.lua b/src/util/std.lua index f1041cf..436d63e 100644 --- a/src/util/std.lua +++ b/src/util/std.lua @@ -1,263 +1,285 @@ - -- Basic functionality that should be standard in Lua -- Table / List -- Whether a table contains no keys function table.empty(t) - return next(t)~=nil + return next(t) ~= nil end + -- Apply a function to each key in a table function table.map(f, ...) - local ts = {...} + local ts = { ... } local u = {} - for k,_ in pairs(ts[1]) do + for k, _ in pairs(ts[1]) do local args = {} - for j=1,#ts do args[j] = ts[j][i] end + for j = 1, #ts do args[j] = ts[j][i] end u[i] = f(unpack(args)) end return u end + function table.map_list(f, ...) - local ts = {...} + local ts = { ... } local u = {} - for i=1,#ts[1] do + for i = 1, #ts[1] do local args = {} - for j=1,#ts do args[j] = ts[j][i] end + for j = 1, #ts do args[j] = ts[j][i] end u[i] = f(unpack(args)) end return u end + -- Swap keys/values function table.swap(t) local u = {} - for k,v in pairs(t) do u[v] = k end + for k, v in pairs(t) do u[v] = k end return u end + -- Reverse a list function table.reverse(l) local m = {} - for i=1,#l do m[#l-i+1] = l[i] end + for i = 1, #l do m[#l - i + 1] = l[i] end return m end + -- Whether a table is a list/array (has only monotonic integer keys) function table.islist(t) local n = 0 - for i,_ in pairs(t) do - if type(i)~='number' or i%1~=0 then return false end - n = n+1 + for i, _ in pairs(t) do + if type(i) ~= 'number' or i % 1 ~= 0 then return false end + n = n + 1 end - return n==#t + return n == #t end + -- Append contents of other tables to first table function table.append(t, ...) - local a = {...} - for _,u in ipairs(a) do - for _,v in ipairs(u) do table.insert(t,v) end + local a = { ... } + for _, u in ipairs(a) do + for _, v in ipairs(u) do table.insert(t, v) end end return t end + -- Create a new table containing all keys from any number of tables -- latter tables in the arg list override prior ones -- overlaps, NOT appends, integer keys function table.join(...) - local ts = {...} + local ts = { ... } local w = {} - for _,t in ipairs(ts) do - for k,v in pairs(t) do w[k] = v end + for _, t in ipairs(ts) do + for k, v in pairs(t) do w[k] = v end end return w end + -- Whether a table contains a certain value in any key -function table.contains(t,s) - for _,v in pairs(t) do - if v==s then return true end +function table.contains(t, s) + for _, v in pairs(t) do + if v == s then return true end end return false end -function table.contains_list(t,s) - for _,v in ipairs(t) do - if v==s then return true end + +function table.contains_list(t, s) + for _, v in ipairs(t) do + if v == s then return true end end return false end + -- Copy a table to another table function table.copy(t) local u = {} - for k,v in pairs(t) do u[k] = v end + for k, v in pairs(t) do u[k] = v end return u end + function table.copy_list(l) local m = {} - for i,v in ipairs(l) do m[i] = v end + for i, v in ipairs(l) do m[i] = v end return m end + -- Sort a table in a new copy function table.sortcopy(t, f) local u = table.copy_list(t) table.sort(u, f) return u end + -- Remove a value from a table function table.removevalue(t, r) local rem = {} - for k,v in pairs(t) do - if v==r then table.insert(rem, k) end + for k, v in pairs(t) do + if v == r then table.insert(rem, k) end end - for _,k in ipairs(rem) do t[k] = nil end + for _, k in ipairs(rem) do t[k] = nil end end + function table.removevalue_list(t, r) for i = #t, 1, -1 do - if t[i]==r then + if t[i] == r then table.remove(t, i) end end end + -- Export tables into formatted executable strings local function tabs(tabLevel) return (' '):rep(tabLevel) end local valueToString local function tableToString(t, tabLevel, seen) - if type(t)~='table' or (getmetatable(t) and getmetatable(t).__tostring) then + if type(t) ~= 'table' or (getmetatable(t) and getmetatable(t).__tostring) then return tostring(t) elseif table.islist(t) then - if #t==0 then + if #t == 0 then return '{}' else local strs = {} local containsTables = false - for _,v in ipairs(t) do - if type(v)=='table' then containsTables = true end - table.insert(strs, valueToString(v, tabLevel+1, seen)..',') + for _, v in ipairs(t) do + if type(v) == 'table' then containsTables = true end + table.insert(strs, valueToString(v, tabLevel + 1, seen) .. ',') end - if containsTables or #t>3 then - return '{\n'..tabs(tabLevel+1) - ..table.concat(strs, '\n'..tabs(tabLevel+1)) - ..'\n'..tabs(tabLevel)..'}' + if containsTables or #t > 3 then + return '{\n' .. tabs(tabLevel + 1) + .. table.concat(strs, '\n' .. tabs(tabLevel + 1)) + .. '\n' .. tabs(tabLevel) .. '}' else - return '{ '..table.concat(strs, ' ')..' }' + return '{ ' .. table.concat(strs, ' ') .. ' }' end end else local containsNonStringKeys = false - for k,v in pairs(t) do - if type(k)~='string' or k:find('[^a-zA-Z0-9_]') then + for k, v in pairs(t) do + if type(k) ~= 'string' or k:find('[^a-zA-Z0-9_]') then containsNonStringKeys = true - elseif type(k)=='table' then + elseif type(k) == 'table' then error('table.tostring: table contains a table as key, cannot serialize') end end local strs = {} if containsNonStringKeys then - for k,v in pairs(t) do - table.insert(strs, '\n'..tabs(tabLevel+1) - ..'['..valueToString(k, tabLevel+1, seen)..'] = ' - ..valueToString(v, tabLevel+1, seen)..',') + for k, v in pairs(t) do + table.insert(strs, '\n' .. tabs(tabLevel + 1) + .. '[' .. valueToString(k, tabLevel + 1, seen) .. '] = ' + .. valueToString(v, tabLevel + 1, seen) .. ',') end else - for k,v in pairs(t) do - table.insert(strs, '\n'..tabs(tabLevel+1) - ..k..' = '..valueToString(v, tabLevel+1, seen)..',') + for k, v in pairs(t) do + table.insert(strs, '\n' .. tabs(tabLevel + 1) + .. k .. ' = ' .. valueToString(v, tabLevel + 1, seen) .. ',') end end - return '{'..table.concat(strs)..'\n'..tabs(tabLevel)..'}' + return '{' .. table.concat(strs) .. '\n' .. tabs(tabLevel) .. '}' end end valueToString = function(v, tabLevel, seen) local t = type(v) - if t=='table' then + if t == 'table' then if seen[v] then - return 'nil --[[ already seen: '..tostring(v)..' ]]' + return 'nil --[[ already seen: ' .. tostring(v) .. ' ]]' else seen[v] = true return tableToString(v, tabLevel, seen) end - elseif t=='string' then - return '\''..string.escape(v)..'\'' - elseif t=='number' or t=='boolean' then + elseif t == 'string' then + return '\'' .. string.escape(v) .. '\'' + elseif t == 'number' or t == 'boolean' then return tostring(v) else --error('table.tostring: table contains a '..t..' value, cannot serialize') - return 'nil --[[ cannot serialize '..t..': '..tostring(v)..' ]]' + return 'nil --[[ cannot serialize ' .. t .. ': ' .. tostring(v) .. ' ]]' end end function table.tostring(t) return tableToString(t, 0, {}) end - -- String -- Split string into table by separator -- or by chars if no separator given -- if regex is not true, sep is treated as a regex pattern function string.split(str, sep, noregex) - if type(str)~='string' then - error('string.split: argument #1: expected string, got '..type(str), 2) end - if sep==nil or sep=='' then + if type(str) ~= 'string' then + error('string.split: argument #1: expected string, got ' .. type(str), 2) + end + if sep == nil or sep == '' then local t = {} local ns = #str for x = 1, ns do table.insert(t, str:sub(x, x)) end return t - elseif type(sep)=='string' then + elseif type(sep) == 'string' then local t = {} - if #str>0 then + if #str > 0 then local first = 1 while true do local last, newfirst = str:find(sep, first, noregex) if not last then break end - table.insert(t, str:sub(first, last-1)) - first = newfirst+1 + table.insert(t, str:sub(first, last - 1)) + first = newfirst + 1 end table.insert(t, str:sub(first, #str)) end return t else error( - 'string.split: argument #2: expected string or nil, got '..type(sep), 2) + 'string.split: argument #2: expected string or nil, got ' .. type(sep), 2) end end + -- Split string to a list of char bytes function string.bytes(s) local b = {} - for i=1,#s do - local c = s:sub(i,i) + for i = 1, #s do + local c = s:sub(i, i) table.insert(b, c:byte()) end return b end + -- Trim leading and trailing whitespace function string.trim(s, ws) ws = ws or ' \t\r\n' - return s:gsub('^['..ws..']+', ''):gsub('['..ws..']+$', '')..'' + return s:gsub('^[' .. ws .. ']+', ''):gsub('[' .. ws .. ']+$', '') .. '' end + -- String slicing and searching using [] operator local str_meta = getmetatable('') -local str_meta_index_old= str_meta.__index -function str_meta.__index(s,k) - if type(k)=='string' then +local str_meta_index_old = str_meta.__index +function str_meta.__index(s, k) + if type(k) == 'string' then return str_meta_index_old[k] - elseif type(k)=='number' then - if k<0 then k = #s+k+1 end - return string.sub(s,k,k) - elseif type(k)=='table' then - local a = k[1]<0 and (#s+k[1]+1) or k[1] - local b = k[2]<0 and (#s+k[2]+1) or k[2] - return string.sub(s,a,b) + elseif type(k) == 'number' then + if k < 0 then k = #s + k + 1 end + return string.sub(s, k, k) + elseif type(k) == 'table' then + local a = k[1] < 0 and (#s + k[1] + 1) or k[1] + local b = k[2] < 0 and (#s + k[2] + 1) or k[2] + return string.sub(s, a, b) end end + -- String iterator function string.chars(s) local i = 0 return function() - i = i+1 - if i<=#s then return s:sub(i,i) - else return nil end + i = i + 1 + if i <= #s then + return s:sub(i, i) + else + return nil + end end end + -- Escape sequences local defaultEscapes = { ['\\'] = '\\\\', @@ -271,12 +293,13 @@ local defaultEscapes = { function string.escape(s, escapes) escapes = escapes or defaultEscapes local t = {} - for i=1,#s do - local c = s:sub(i,i) + for i = 1, #s do + local c = s:sub(i, i) table.insert(t, escapes[c] or c) end return table.concat(t) end + local defaultEscapeChar = '\\' local defaultUnescapes = { ['\\'] = '\\', @@ -292,13 +315,13 @@ function string.unescape(s, escapeChar, unescapes) unescapes = unescapes or defaultUnescapes local t = {} local inEscape = false - for i=1,#s do - local c = s:sub(i,i) + for i = 1, #s do + local c = s:sub(i, i) if inEscape then table.insert(t, unescapes[c] or error('string.unescape: invalid escape sequence: \'' - ..escapeChar..c..'\'')) - elseif c==escapeChar then + .. escapeChar .. c .. '\'')) + elseif c == escapeChar then inEscape = true else table.insert(t, c) @@ -307,40 +330,44 @@ function string.unescape(s, escapeChar, unescapes) return table.concat(t) end - -- IO io = io or {} -- Read entire file at once, return nil,err if access failed function io.readall(filename) - local fi,err = io.open(filename, 'rb') - if not fi then return nil,err end + local fi, err = io.open(filename, 'rb') + if not fi then return nil, err end local s = fi:read("*a") fi:close() return s end + -- Write data to file all at once, return true if success / false,err if failure function io.writeall(filename, data) - local fi,err = io.open(filename, 'wb') - if not fi then return false,err end + local fi, err = io.open(filename, 'wb') + if not fi then return false, err end fi:write(data) fi:close() - return true,nil + return true, nil end - -- Math -- Round function math.round(x) - return math.floor(x+0.5) + return math.floor(x + 0.5) end + -- Mod that accounts for floating point inaccuracy -function math.mod(a,b) - local m = a%b - if m==0 or math.abs(m)<1e-15 or math.abs(m-b)<1e-15 then return 0 - else return m end +function math.mod(a, b) + local m = a % b + if m == 0 or math.abs(m) < 1e-15 or math.abs(m - b) < 1e-15 then + return 0 + else + return m + end end + -- Clamp value between min and max function math.clamp(v, n, x) return math.min(x, math.max(v, n)) diff --git a/src/util/vector.lua b/src/util/vector.lua index f166719..10b73bc 100644 --- a/src/util/vector.lua +++ b/src/util/vector.lua @@ -1,26 +1,28 @@ - -- Vector math class with operators local vector_meta local vector_new local function vector_check(v, n, name, argn) if not v.__is_vector then - error('vector '..name..': argument #'..(argn or 1) - ..': expected vector, got '..type(v), n+1) end + error('vector ' .. name .. ': argument #' .. (argn or 1) + .. ': expected vector, got ' .. type(v), n + 1) + end end local function vector_checksamelen(v1, v2, name) vector_check(v1, 3, name, 1) vector_check(v2, 3, name, 2) - if #v1~=#v2 then - error('vector '..name..': vector lengths do not match (lengths are ' - ..#v1..' and '..#v2..')', 3) end + if #v1 ~= #v2 then + error('vector ' .. name .. ': vector lengths do not match (lengths are ' + .. #v1 .. ' and ' .. #v2 .. ')', 3) + end return #v1 end local function vector_checklen(v1, v2, name, len) vector_check(v1, 3, name, 1) vector_check(v2, 3, name, 2) - if #v1~=len or #v2~=len then - error('vector '..name..': vector lengths are not '..len..' (lengths are ' - ..#v1..' and '..#v2..')', 3) end + if #v1 ~= len or #v2 ~= len then + error('vector ' .. name .. ': vector lengths are not ' .. len .. ' (lengths are ' + .. #v1 .. ' and ' .. #v2 .. ')', 3) + end end local function vector_opnnn(name, op) return function(v1, v2) @@ -34,8 +36,8 @@ local function vector_opnnn(name, op) end local function vector_opnxn(name, op) return function(v1, v2) - local v1v = type(v1)=='table' and v1.__is_vector - local v2v = type(v2)=='table' and v2.__is_vector + local v1v = type(v1) == 'table' and v1.__is_vector + local v2v = type(v2) == 'table' and v2.__is_vector if v1v and v2v then local len = vector_checksamelen(v1, v2, name) local v3 = {} @@ -44,7 +46,7 @@ local function vector_opnxn(name, op) end return vector_new(v3) else - if v2v then v1,v2 = v2,v1 end + if v2v then v1, v2 = v2, v1 end local len = #v1 local v3 = {} for i = 1, len do @@ -65,146 +67,163 @@ local function vector_opn0n(name, op) return vector_new(v2) end end -local vector_indices = {x = 1, y = 2, z = 3, w = 4, r = 1, g = 2, b = 3, a = 4} +local vector_indices = { x = 1, y = 2, z = 3, w = 4, r = 1, g = 2, b = 3, a = 4 } local vector_meta = { - __is_vector = true, - __index = function(t, k) - if tonumber(k) then return rawget(t, k) - elseif vector_indices[k] then return rawget(t, vector_indices[k]) - else return getmetatable(t)[k] + __is_vector = true, + __index = function(t, k) + if tonumber(k) then + return rawget(t, k) + elseif vector_indices[k] then + return rawget(t, vector_indices[k]) + else + return getmetatable(t)[k] end end, - __newindex = function(t, k, v) - if tonumber(k) then rawset(t, k, v) - elseif vector_indices[k] then rawset(t, vector_indices[k], v) - else return + __newindex = function(t, k, v) + if tonumber(k) then + rawset(t, k, v) + elseif vector_indices[k] then + rawset(t, vector_indices[k], v) + else + return end end, - __add = vector_opnnn('add', function(x1, x2) return x1+x2 end), - __sub = vector_opnnn('sub', function(x1, x2) return x1-x2 end), - __mul = vector_opnxn('mul', function(x1, x2) return x1*x2 end), - __div = vector_opnxn('div', function(x1, x2) return x1/x2 end), - __pow = vector_opnxn('pow', function(x1, x2) return x1^x2 end), - __unm = vector_opn0n('inv', function(x1) return -x1 end), - __concat = nil, + __add = vector_opnnn('add', function(x1, x2) return x1 + x2 end), + __sub = vector_opnnn('sub', function(x1, x2) return x1 - x2 end), + __mul = vector_opnxn('mul', function(x1, x2) return x1 * x2 end), + __div = vector_opnxn('div', function(x1, x2) return x1 / x2 end), + __pow = vector_opnxn('pow', function(x1, x2) return x1 ^ x2 end), + __unm = vector_opn0n('inv', function(x1) return -x1 end), + __concat = nil, --__len = function(v1) return #v1 end, - __len = nil, - __eq = function(v1, v2) + __len = nil, + __eq = function(v1, v2) local len = vector_checksamelen(v1, v2, 'equals') for i = 1, len do - if v1[i]~=v2[i] then return false end + if v1[i] ~= v2[i] then return false end end return true end, - __lt = nil, - __le = nil, - __call = nil, - abs = vector_opn0n('abs', math.abs), - length = function(v1) + __lt = nil, + __le = nil, + __call = nil, + abs = vector_opn0n('abs', math.abs), + length = function(v1) --vector_check(v1, 2, 'length') local len = #v1 local l = 0 for i = 1, len do - l = l + v1[i]^2 + l = l + v1[i] ^ 2 end return math.sqrt(l) end, - normalize = function(v1) + normalize = function(v1) --vector_check(v1, 2, 'normal') local length = v1:length() local len = #v1 local v3 = {} for i = 1, len do - if length==0 then v3[i] = 0 - else v3[i] = v1[i]/length end + if length == 0 then + v3[i] = 0 + else + v3[i] = v1[i] / length + end end return vector_new(v3) end, - __tostring = function(v1) + __tostring = function(v1) --vector_check(v1, 2, 'tostring') local st = {} local len = #v1 for i = 1, len do table.insert(st, tostring(v1[i])) end - return 'vector{ '..table.concat(st, ', ')..' }' + return 'vector{ ' .. table.concat(st, ', ') .. ' }' end, - unpack = function(v1) return unpack(v1) end, - floor = vector_opn0n('floor', function(x1) return math.floor(x1) end), - ceil = vector_opn0n('ceil' , function(x1) return math.ceil (x1) end), - round = vector_opn0n('round', function(x1) return math.floor(x1+0.5) end), - dot = function(v1, v2) + unpack = function(v1) return unpack(v1) end, + floor = vector_opn0n('floor', function(x1) return math.floor(x1) end), + ceil = vector_opn0n('ceil', function(x1) return math.ceil(x1) end), + round = vector_opn0n('round', function(x1) return math.floor(x1 + 0.5) end), + dot = function(v1, v2) local len = vector_checksamelen(v1, v2, 'dot') local x = 0 for i = 1, len do - x = x + v1[i]*v2[i] + x = x + v1[i] * v2[i] end return x end, - cross = function(v1, v2) + cross = function(v1, v2) vector_checklen(v1, v2, 'cross', 3) - return vector_new{ - v1[2]*v2[3] - v1[3]*v2[2], - v1[3]*v2[1] - v1[1]*v2[3], - v1[1]*v2[2] - v1[2]*v2[1], + return vector_new { + v1[2] * v2[3] - v1[3] * v2[2], + v1[3] * v2[1] - v1[1] * v2[3], + v1[1] * v2[2] - v1[2] * v2[1], } end, rotateByAngleId = function(v1, r) --vector_check(v1, 2, 'rotate') - if type(r)~='number' or r%1~=0 then - error('vector rotateByAngleId: invalid rotation '..tostring(r), 2) end - r = r%4 + if type(r) ~= 'number' or r % 1 ~= 0 then + error('vector rotateByAngleId: invalid rotation ' .. tostring(r), 2) + end + r = r % 4 local v2 - if r==0 then v2 = vector_new{ v1[1], v1[2], v1[3] } - elseif r==1 then v2 = vector_new{ v1[2], -v1[1], v1[3] } - elseif r==2 then v2 = vector_new{ -v1[1], -v1[2], v1[3] } - elseif r==3 then v2 = vector_new{ -v1[2], v1[1], v1[3] } - else error('vector rotateByAngleId: invalid rotation '..r, 2) end + if r == 0 then + v2 = vector_new { v1[1], v1[2], v1[3] } + elseif r == 1 then + v2 = vector_new { v1[2], -v1[1], v1[3] } + elseif r == 2 then + v2 = vector_new { -v1[1], -v1[2], v1[3] } + elseif r == 3 then + v2 = vector_new { -v1[2], v1[1], v1[3] } + else + error('vector rotateByAngleId: invalid rotation ' .. r, 2) + end return v2 end, - rotateZ = function(v, r) + rotateZ = function(v, r) --vector_check(v, 2, 'rotate2d') - if type(r)~='number' then - error('vector rotateZ: invalid rotation '..tostring(r), 2) end - local len = math.sqrt(v[1]^2 + v[2]^2) + if type(r) ~= 'number' then + error('vector rotateZ: invalid rotation ' .. tostring(r), 2) + end + local len = math.sqrt(v[1] ^ 2 + v[2] ^ 2) local ang = math.atan2(v[2], v[1]) + r - local v2 = vector_new{ math.cos(ang)*len, math.sin(ang)*len } + local v2 = vector_new { math.cos(ang) * len, math.sin(ang) * len } return v2 end, - tsString = function(v) + tsString = function(v) --vector_check(v, 2, 'tsString') return table.concat(v, ' ') end, - distance = function(v1, v2) + distance = function(v1, v2) local len = vector_checksamelen(v1, v2, 'distance') local sum = 0 - for i=1,len do - sum = sum + (v1[i] - v2[i])^2 + for i = 1, len do + sum = sum + (v1[i] - v2[i]) ^ 2 end return math.sqrt(sum) end, - copy = function(v) + copy = function(v) --vector_check(v, 2, 'copy') return vector_new(v) end, } vector_new = function(vi) if vi then - if type(vi)=='string' then + if type(vi) == 'string' then local vi2 = {} for val in vi:gmatch('[0-9%.%-e]+') do table.insert(vi2, tonumber(val)) end vi = vi2 - elseif type(vi)~='table' then - error('vector: argument #1: expected input table, got '..type(vi), 2) + elseif type(vi) ~= 'table' then + error('vector: argument #1: expected input table, got ' .. type(vi), 2) end local v = {} - if #vi>0 then + if #vi > 0 then for i = 1, #vi do v[i] = vi[i] end else for n, i in pairs(vector_indices) do v[i] = vi[n] end - if #v==0 then + if #v == 0 then error('vector: argument #1: table contains no values', 2) end end