path: root/PolygLua.lua

#!/usr/bin/env luajit

--[[ PolygLua.  Gluing things onto Lua, making it a polyglot language.

TODO - Make the parsing recursive.  So the command '--fancy' could have it's own options table.
	    --fancy option0 opt1=foo 'Random string!' --somethingElse
	    When to stop and hand back?  First time we see a ' -bar' or ' --foo'?

TODO - Add some sort of alias mechanism for the #! thing.  _.bash'echo "This is bash."':Do()
	The user can define their own aliases in a table, with defaults for bash, sh, luajit, and maybe some others.
	Then extend it to changing language on the fly     _.bash'echo "This is bash."':luajit("print('This is Lua.')"):Do()

TODO - APT also has +/- for adding and removing option values into an options entry.
	Not sure if that is being used.

]]

-- Most of this _ stuff was copied from apt-panopticon.
local _ = {}
_.version = '0.0 crap'


_.verbosity = 2
local log = function(v, t, s)
    if v <= _.verbosity then
	if 3 <= _.verbosity then t = os.date('!%F %T') .. ' ' .. t end
	print(t .. ': ' .. s)
    end
    io.flush()
end

-- This sets the global values, here and in the caller.  The "_G." part isn't needed, it's just there to make things more obvious to the reader.
_G.D = function(s)	log(4,  'DEBUG    ', s) end
_G.I = function(s)	log(3,  'INFO     ', s) end
_G.T = function(s)	log(2,  'TIMEOUT  ', s) end
_G.W = function(s)	log(1,  'WARNING  ', s) end
_G.E = function(s)	log(0,  'ERROR    ', s) end
_G.C = function(s)	log(-1, 'CRITICAL ', s) end


local optionsCommon =
{
    help =	{help = 'Print the help text.',
	func = function(self, options, a, args, i)
	    print(Help)
	    _.usage(args, options, true)
	    os.exit(0)
	end
    },
    version =	{help = 'Print the version details.',
	func = function(self, options, a, args, i)
	    print('This is version ' ..Version .. ' of ' .. args[0])
	    os.exit(0)
	end
    },
    ['-q'] = 		{help = 'Decrease verbosity level.',
	func = function(self, options, a, args, i)
	    if _.verbosity > -1 then _.verbosity = _.verbosity - 1 end
	    print('New verbosity level is ' .. _.verbosity)
	end
    },
    ['-v'] = 		{help = 'Increase verbosity level.',
	func = function(self, options, a, args, i)
	    if _.verbosity < 4 then _.verbosity = _.verbosity + 1 end
	    print('New verbosity level is ' .. _.verbosity)
	end
    },
}

_.usage = function(args, options, all)
	local h = ''
	for k, v in pairs(options) do
	    if 'table' == type(v) then h = h .. k .. ' | ' end
	end
	for k, v in pairs(optionsCommon) do
	    if 'table' == type(v) then h = h .. k .. ' | ' end
	end
	print('Usage: ' .. args[0] .. ' {' .. string.sub(h, 1, -2) .. '}')
	if true == all then
	    for k, v in pairs(options) do
		if 'table' == type(v) then
		    if nil ~= v.help then print(k .. '\t\t' .. v.help) end
		end
	    end
	    for k, v in pairs(optionsCommon) do
		if 'table' == type(v) then
		    if nil ~= v.help then print(k .. '\t\t' .. v.help) end
		end
	    end
	end
end

_.parse = function(args, options, confFile)
    local o = nil

    local doIt = function(name, val, a, args, i)
	    local o = options[name]
	    if nil == o then o = optionsCommon[name] end
	    if nil ~= o then
		if nil ~= val then o.value = val; D(name .. ' = ' .. tostring(val)) end
		if nil ~= o.func then o:func(options, a, args, i) end
	    end
	return o
    end

    if nil ~= confFile then
	for i,v in ipairs{'/etc/', '~/.', './.'} do
	    local p = v .. confFile .. '.conf.lua'
	    local h = io.open(p, 'r')
	    if nil ~= h then
		D('Found configuration file '.. p)
		h:close()
		local ar = dofile(p)
		for k, w in pairs(ar) do
		    if nil == doIt(k, w, k .. '=' .. tostring(w), args, i) then W('config variable not found ' .. k .. ' = ' .. tostring(w)) end
		end
	    end
	end
    end

    if 0 ~= #args then
	for i,a in ipairs(args) do
	    D('Argument ' .. i .. ' = ' .. a)
	    local ds = 0
	    if ('-'  == a:sub(1, 1)) and ('-' ~= a:sub(2, 2)) then ds = 1 end
	    if  '--' == a:sub(1, 2) then                           ds = 2; a = a:sub(3, -1) end
	    local s, e = a:find('=', 1, true)
	    local k , v
	    if not s then
		e = 0
		v = nil
	    else
		v = a:sub(e + 1, -1)
	    end
	    k = a:sub(1, e - 1)
	    if 1 == ds then
		for j = 2, #k do
		    o = doIt('-' .. k:sub(j, j), v, a, args, i)
		end
	    else
		o = doIt(k, v, a, args, i)
	    end
	end
    end

    if nil == o then
	_.usage(args, options)
	os.exit(0)
    end
end

_.runnable = function(c)
    return ( 0 == __('which ' .. c):Do().status )
end

_.running = function(c)
	return ( 1 ~= tonumber(__('pgrep -u $USER -cf ' .. c):Do().lines[1]) )
end

_.exists = function(f)
    local h = io.open(f, 'r')
    if nil == h then return false else h:close(); return true end
end


_.killEmAll = function(all)
    for i,l in ipairs(all) do
	local c = 0
	while 0 ~= tonumber(__('pgrep -u $USER -xc ' .. l):Do().lines[1]) do
	    local s = 'TERM'
	    if c > 1 then s = 'KILL'; __('sleep ' .. c):Do() end
	    __('pkill -' .. s .. ' -u $USER -x ' .. l):log():Do()
	    c = c + 1
	end
    end
end


_.readCmd = function(cmd)
    local result = {}
    local output = io.popen(cmd)
    if nil ~= output then
	for l in output:lines() do
	    table.insert(result, l)
	end
    end
    -- While this does return the same things as os.execute(), it's just as useless.
    output:close()
    return result
end


_G.__ = function(c)
    local exe = {status = 0, lines = {}, logging = false, showing = false, cmd = '', command = c, isScript = false, script = ''}
    local n = 0

    exe.cmd = '{ '
    if 'table' == type(c) then
	for i, l in ipairs(c) do
	    n = n + 1
	    exe.cmd = exe.cmd .. l .. ' ; '
	end
    elseif 'string' == type(c) then
	exe.isScript = (n == 0) and ('#!' == c:sub(1,2))
	for l in string.gmatch(c, '\n*([^\n]+)\n*') do
	    if '' ~= l then
		if exe.isScript then
		    if '' == exe.script then
			exe.scriptFile = os.tmpname()
			D('Creating temporary script file at ' .. exe.scriptFile)
			exe.cmd = exe.cmd .. l:sub(3) .. ' ' .. exe.scriptFile .. ' ; '
			-- PHP wants this to be executable.
			__('chmod u+x ' .. exe.scriptFile)
		    end
		    exe.script = exe.script .. l .. '\n'
		else
		    n = n + 1
		    exe.cmd = exe.cmd .. l .. ' ; '
		end
	    end
	end
    end
    if exe.isScript then
	local a, e = io.open(exe.scriptFile, 'w')
	if nil == a then E('Could not open ' .. exe.scriptFile .. ' - ' .. e) else
	    a:write(exe.script)
	    a:close()
	end
	exe.cmd = exe.cmd .. 'rm ' .. exe.scriptFile .. ' ; '
    end
    exe.cmd = exe.cmd .. ' } '
    if 1 == n then exe.cmd = c end


    function exe:Nice(c)
	if nil == c then
	    self.cmd = 'ionice -c3 nice -n 19 ' .. self.cmd
	else
	    self.cmd = self.cmd .. ' ionice -c3 nice -n 19 ' .. c .. ' '
	end
	return self
    end

    function exe:timeout(c)
	-- timeout returns a status of - command status if --preserve-status; "128+9" (actually 137) if --kill-after ends up being done; 124 if it had to TERM; command status if all went well.
	-- --kill-after means "send KILL after TERM fails".
	if nil == c then
	    self.cmd = 'timeout --kill-after=10.0 --foreground 42.0s ' .. self.cmd
	else
	    self.cmd = 'timeout --kill-after=10.0 --foreground ' .. c .. ' ' .. self.cmd
	end
	return self
    end

    function exe:log()								self.logging = true				return self	end
    function exe:show()								self.showing = true				return self	end
    -- Should be called "then" but that's a reserved word.
    function exe:Then(c)	if nil == c then c = '' else c = ' ' .. c end	self.cmd = self.cmd .. '; ' .. c .. ' '		return self	end
    function exe:And(c)		if nil == c then c = '' else c = ' ' .. c end	self.cmd = self.cmd .. ' && ' .. c .. ' '	return self	end
    function exe:Or(c)		if nil == c then c = '' else c = ' ' .. c end	self.cmd = self.cmd .. ' || ' .. c .. ' '	return self	end
    function exe:noErr()							self.cmd = self.cmd .. ' 2>/dev/null '		return self	end
    function exe:noOut()							self.cmd = self.cmd .. ' 1>/dev/null '		return self	end
    function exe:wait(w)							self.cmd = self.cmd .. ' && touch ' .. w .. ' '	return self	end

    function exe:Do()
    --[[    "The condition expression of a control structure can return any
	    value. Both false and nil are considered false. All values different
	    from nil and false are considered true (in particular, the number 0
	    and the empty string are also true)."
	    says the docs, I beg to differ.]]
	if true == self.logging then D(' executing - ' .. self.cmd) end
	--[[ Damn os.execute()
	    Lua 5.1 says it returns "a status code, which is system-dependent"
	    Lua 5.2 says it returns true/nil, "exit"/"signal", the status code.
	    I'm getting 7168 or 0.  No idea what the fuck that is.
	local ok, rslt, status = os.execute(s)
	]]
	self.lines = _.readCmd(self.cmd .. '; echo "$?"', 'r')
	-- The last line will be the command's returned status, fish that out and collect everything else in lines.
	self.status = tonumber(self.lines[#self.lines])
	self.lines[#self.lines] = nil
	if true == self.showing then for i, l in ipairs(self.lines) do I(l) end end

	if     (nil == self.status)				then	D('STATUS |' .. 'NIL' ..	       '| ' .. self.command)
	elseif (137 == self.status) or (124 == self.status)	then	T('timeout killed ' ..	self.status .. ' '  .. self.command)
	elseif (0   ~= self.status)				then	D('STATUS |' ..		self.status .. '| ' .. self.command)
	end

	return self
    end

    function exe:fork(after, host)
-- The host part is from apt-panopticon, likely needed there, but makes no sense here.
--	if nil ~= host then self.cmd = self.cmd .. ';  r=$?; if [ $r -ge 124 ]; then echo "$r ' .. host .. ' failed forked command ' .. string.gsub(self.cmd, '"', "'") .. '"; fi' end
	if nil == after then after = '' end
	if ''  ~= after then after = ' ; ' .. after end
	self.cmd = '{ ' .. self.cmd .. after .. ' ; } & '
	if true == self.logging then D(' forking - ' .. self.cmd) end
	os.execute(self.cmd)
	return self
    end

    function exe:forkOnce()
	if _.running(self.command) then
	    D('Already running ' .. self.command)
	else
	    self:fork()
	end
    end

    return exe
end


return _