2
0
mirror of https://github.com/koreader/koreader synced 2024-11-10 01:10:34 +00:00
koreader/plugins/backgroundrunner.koplugin/commandrunner.lua
NiLuJe fadee1f5dc
Clarify our OOP semantics across the codebase (#9586)
Basically:

* Use `extend` for class definitions
* Use `new` for object instantiations

That includes some minor code cleanups along the way:

* Updated `Widget`'s docs to make the semantics clearer.
* Removed `should_restrict_JIT` (it's been dead code since https://github.com/koreader/android-luajit-launcher/pull/283)
* Minor refactoring of LuaSettings/LuaData/LuaDefaults/DocSettings to behave (mostly, they are instantiated via `open` instead of `new`) like everything else and handle inheritance properly (i.e., DocSettings is now a proper LuaSettings subclass).
* Default to `WidgetContainer` instead of `InputContainer` for stuff that doesn't actually setup key/gesture events.
* Ditto for explicit `*Listener` only classes, make sure they're based on `EventListener` instead of something uselessly fancier.
* Unless absolutely necessary, do not store references in class objects, ever; only values. Instead, always store references in instances, to avoid both sneaky inheritance issues, and sneaky GC pinning of stale references.
  * ReaderUI: Fix one such issue with its `active_widgets` array, with critical implications, as it essentially pinned *all* of ReaderUI's modules, including their reference to the `Document` instance (i.e., that was a big-ass leak).
* Terminal: Make sure the shell is killed on plugin teardown.
* InputText: Fix Home/End/Del physical keys to behave sensibly.
* InputContainer/WidgetContainer: If necessary, compute self.dimen at paintTo time (previously, only InputContainers did, which might have had something to do with random widgets unconcerned about input using it as a baseclass instead of WidgetContainer...).
* OverlapGroup: Compute self.dimen at *init* time, because for some reason it needs to do that, but do it directly in OverlapGroup instead of going through a weird WidgetContainer method that it was the sole user of.
* ReaderCropping: Under no circumstances should a Document instance member (here, self.bbox) risk being `nil`ed!
* Kobo: Minor code cleanups.
2022-10-06 02:14:48 +02:00

92 lines
2.6 KiB
Lua

local logger = require("logger")
local UIManager = require("ui/uimanager")
local time = require("ui/time")
local CommandRunner = {
pio = nil,
job = nil,
}
function CommandRunner:createEnvironmentFromTable(t)
if t == nil then return "" end
local r = ""
for k, v in pairs(t) do
r = r .. k .. "=" .. v .. " "
end
if string.len(r) > 0 then r = "export " .. r .. ";" end
return r
end
function CommandRunner:createEnvironment()
if type(self.job.environment) == "table" then
return self:createEnvironmentFromTable(self.job.environment)
end
if type(self.job.environment) == "function" then
local status, result = pcall(self.job.environment)
if status then
return self:createEnvironmentFromTable(result)
end
end
return ""
end
function CommandRunner:start(job)
assert(self.pio == nil)
assert(self.job == nil)
self.job = job
self.job.start_time = UIManager:getTime()
assert(type(self.job.executable) == "string")
local command = self:createEnvironment() .. " " ..
"sh plugins/backgroundrunner.koplugin/luawrapper.sh " ..
"\"" .. self.job.executable .. "\""
logger.dbg("CommandRunner: Will execute command " .. command)
UIManager:preventStandby()
self.pio = io.popen(command)
end
--- Polls the status of self.pio.
-- @return a table contains the result from luawrapper.sh. Returns nil if the
-- command has not been finished.
function CommandRunner:poll()
assert(self.pio ~= nil)
assert(self.job ~= nil)
local line = self.pio:read()
if line == "" then
return nil
else
if line == nil then
-- The binary crashes without output. This should not happen.
self.job.result = 223
else
line = line .. self.pio:read("*a")
logger.dbg("CommandRunner: Receive output " .. line)
local status, result = pcall(loadstring(line))
if status and result ~= nil then
for k, v in pairs(result) do
self.job[k] = v
end
else
-- The output from binary is invalid.
self.job.result = 222
end
end
UIManager:allowStandby()
self.pio:close()
self.pio = nil
self.job.end_time = time.now()
local job = self.job
self.job = nil
return job
end
end
--- Whether this is a running job.
-- @treturn boolean
function CommandRunner:pending()
return self.pio ~= nil
end
return CommandRunner