mirror of
https://github.com/MikaylaFischler/cc-mek-scada.git
synced 2024-08-30 18:22:34 +00:00
335 lines
8.3 KiB
Lua
335 lines
8.3 KiB
Lua
--
|
|
-- File System Logger
|
|
--
|
|
|
|
local util = require("scada-common.util")
|
|
|
|
---@class log
|
|
local log = {}
|
|
|
|
---@alias MODE integer
|
|
local MODE = {
|
|
APPEND = 0,
|
|
NEW = 1
|
|
}
|
|
|
|
log.MODE = MODE
|
|
|
|
-- whether to log debug messages or not
|
|
local LOG_DEBUG = true
|
|
|
|
local log_sys = {
|
|
path = "/log.txt",
|
|
mode = MODE.APPEND,
|
|
file = nil,
|
|
dmesg_out = nil
|
|
}
|
|
|
|
---@type function
|
|
local free_space = fs.getFreeSpace
|
|
|
|
-----------------------
|
|
-- PRIVATE FUNCTIONS --
|
|
-----------------------
|
|
|
|
-- private log write function
|
|
---@param msg string
|
|
local function _log(msg)
|
|
local out_of_space = false
|
|
local time_stamp = os.date("[%c] ")
|
|
local stamped = time_stamp .. util.strval(msg)
|
|
|
|
-- attempt to write log
|
|
local status, result = pcall(function ()
|
|
log_sys.file.writeLine(stamped)
|
|
log_sys.file.flush()
|
|
end)
|
|
|
|
-- if we don't have space, we need to create a new log file
|
|
|
|
if (not status) and (result ~= nil) then
|
|
out_of_space = string.find(result, "Out of space") ~= nil
|
|
|
|
if out_of_space then
|
|
-- will delete log file
|
|
else
|
|
util.println("unknown error writing to logfile: " .. result)
|
|
end
|
|
end
|
|
|
|
if out_of_space or (free_space(log_sys.path) < 100) then
|
|
-- delete the old log file before opening a new one
|
|
log_sys.file.close()
|
|
fs.delete(log_sys.path)
|
|
|
|
-- re-init logger and pass dmesg_out so that it doesn't change
|
|
log.init(log_sys.path, log_sys.mode, log_sys.dmesg_out)
|
|
|
|
-- leave a message
|
|
log_sys.file.writeLine(time_stamp .. "recycled log file")
|
|
log_sys.file.writeLine(stamped)
|
|
log_sys.file.flush()
|
|
end
|
|
end
|
|
|
|
----------------------
|
|
-- PUBLIC FUNCTIONS --
|
|
----------------------
|
|
|
|
-- initialize logger
|
|
---@param path string file path
|
|
---@param write_mode MODE
|
|
---@param dmesg_redirect? table terminal/window to direct dmesg to
|
|
function log.init(path, write_mode, dmesg_redirect)
|
|
log_sys.path = path
|
|
log_sys.mode = write_mode
|
|
|
|
if log_sys.mode == MODE.APPEND then
|
|
log_sys.file = fs.open(path, "a")
|
|
else
|
|
log_sys.file = fs.open(path, "w")
|
|
end
|
|
|
|
if dmesg_redirect then
|
|
log_sys.dmesg_out = dmesg_redirect
|
|
else
|
|
log_sys.dmesg_out = term.current()
|
|
end
|
|
end
|
|
|
|
-- close the log file handle
|
|
function log.close()
|
|
log_sys.file.close()
|
|
end
|
|
|
|
-- direct dmesg output to a monitor/window
|
|
---@param window table window or terminal reference
|
|
function log.direct_dmesg(window) log_sys.dmesg_out = window end
|
|
|
|
-- dmesg style logging for boot because I like linux-y things
|
|
---@param msg string message
|
|
---@param tag? string log tag
|
|
---@param tag_color? integer log tag color
|
|
---@return dmesg_ts_coord coordinates line area to place working indicator
|
|
function log.dmesg(msg, tag, tag_color)
|
|
---@class dmesg_ts_coord
|
|
local ts_coord = { x1 = 2, x2 = 3, y = 1 }
|
|
|
|
msg = util.strval(msg)
|
|
tag = tag or ""
|
|
tag = util.strval(tag)
|
|
|
|
local t_stamp = string.format("%12.2f", os.clock())
|
|
local out = log_sys.dmesg_out
|
|
|
|
if out ~= nil then
|
|
local out_w, out_h = out.getSize()
|
|
|
|
local lines = { msg }
|
|
|
|
-- wrap if needed
|
|
if string.len(msg) > out_w then
|
|
local remaining = true
|
|
local s_start = 1
|
|
local s_end = out_w
|
|
local i = 1
|
|
|
|
lines = {}
|
|
|
|
while remaining do
|
|
local line = string.sub(msg, s_start, s_end)
|
|
|
|
if line == "" then
|
|
remaining = false
|
|
else
|
|
lines[i] = line
|
|
|
|
s_start = s_end + 1
|
|
s_end = s_end + out_w
|
|
i = i + 1
|
|
end
|
|
end
|
|
end
|
|
|
|
-- start output with tag and time, assuming we have enough width for this to be on one line
|
|
local cur_x, cur_y = out.getCursorPos()
|
|
|
|
if cur_x > 1 then
|
|
if cur_y == out_h then
|
|
out.scroll(1)
|
|
out.setCursorPos(1, cur_y)
|
|
else
|
|
out.setCursorPos(1, cur_y + 1)
|
|
end
|
|
end
|
|
|
|
-- colored time
|
|
local initial_color = out.getTextColor()
|
|
out.setTextColor(colors.white)
|
|
out.write("[")
|
|
out.setTextColor(colors.lightGray)
|
|
out.write(t_stamp)
|
|
ts_coord.x2, ts_coord.y = out.getCursorPos()
|
|
ts_coord.x2 = ts_coord.x2 - 1
|
|
out.setTextColor(colors.white)
|
|
out.write("] ")
|
|
|
|
-- print optionally colored tag
|
|
if tag ~= "" then
|
|
out.write("[")
|
|
if tag_color then out.setTextColor(tag_color) end
|
|
out.write(tag)
|
|
out.setTextColor(colors.white)
|
|
out.write("] ")
|
|
end
|
|
|
|
out.setTextColor(initial_color)
|
|
|
|
-- output message
|
|
for i = 1, #lines do
|
|
cur_x, cur_y = out.getCursorPos()
|
|
|
|
if i > 1 and cur_x > 1 then
|
|
if cur_y == out_h then
|
|
out.scroll(1)
|
|
out.setCursorPos(1, cur_y)
|
|
else
|
|
out.setCursorPos(1, cur_y + 1)
|
|
end
|
|
end
|
|
|
|
out.write(lines[i])
|
|
end
|
|
|
|
_log(util.c("[", t_stamp, "] [", tag, "] ", msg))
|
|
end
|
|
|
|
return ts_coord
|
|
end
|
|
|
|
-- print a dmesg message, but then show remaining seconds instead of timestamp
|
|
---@nodiscard
|
|
---@param msg string message
|
|
---@param tag? string log tag
|
|
---@param tag_color? integer log tag color
|
|
---@return function update, function done
|
|
function log.dmesg_working(msg, tag, tag_color)
|
|
local ts_coord = log.dmesg(msg, tag, tag_color)
|
|
|
|
local out = log_sys.dmesg_out
|
|
local width = (ts_coord.x2 - ts_coord.x1) + 1
|
|
|
|
if out ~= nil then
|
|
local initial_color = out.getTextColor()
|
|
|
|
local counter = 0
|
|
|
|
local function update(sec_remaining)
|
|
local time = util.sprintf("%ds", sec_remaining)
|
|
local available = width - (string.len(time) + 2)
|
|
local progress = ""
|
|
|
|
out.setCursorPos(ts_coord.x1, ts_coord.y)
|
|
out.write(" ")
|
|
|
|
if counter % 4 == 0 then
|
|
progress = "|"
|
|
elseif counter % 4 == 1 then
|
|
progress = "/"
|
|
elseif counter % 4 == 2 then
|
|
progress = "-"
|
|
elseif counter % 4 == 3 then
|
|
progress = "\\"
|
|
end
|
|
|
|
out.setTextColor(colors.blue)
|
|
out.write(progress)
|
|
out.setTextColor(colors.lightGray)
|
|
out.write(util.spaces(available) .. time)
|
|
out.setTextColor(initial_color)
|
|
|
|
counter = counter + 1
|
|
end
|
|
|
|
local function done(ok)
|
|
out.setCursorPos(ts_coord.x1, ts_coord.y)
|
|
|
|
if ok or ok == nil then
|
|
out.setTextColor(colors.green)
|
|
out.write(util.pad("DONE", width))
|
|
else
|
|
out.setTextColor(colors.red)
|
|
out.write(util.pad("FAIL", width))
|
|
end
|
|
|
|
out.setTextColor(initial_color)
|
|
end
|
|
|
|
return update, done
|
|
else
|
|
return function () end, function () end
|
|
end
|
|
end
|
|
|
|
-- log debug messages
|
|
---@param msg string message
|
|
---@param trace? boolean include file trace
|
|
function log.debug(msg, trace)
|
|
if LOG_DEBUG then
|
|
local dbg_info = ""
|
|
|
|
if trace then
|
|
local info = debug.getinfo(2)
|
|
local name = ""
|
|
|
|
if info.name ~= nil then
|
|
name = ":" .. info.name .. "():"
|
|
end
|
|
|
|
dbg_info = info.short_src .. ":" .. name .. info.currentline .. " > "
|
|
end
|
|
|
|
_log("[DBG] " .. dbg_info .. util.strval(msg))
|
|
end
|
|
end
|
|
|
|
-- log info messages
|
|
---@param msg string message
|
|
function log.info(msg)
|
|
_log("[INF] " .. util.strval(msg))
|
|
end
|
|
|
|
-- log warning messages
|
|
---@param msg string message
|
|
function log.warning(msg)
|
|
_log("[WRN] " .. util.strval(msg))
|
|
end
|
|
|
|
-- log error messages
|
|
---@param msg string message
|
|
---@param trace? boolean include file trace
|
|
function log.error(msg, trace)
|
|
local dbg_info = ""
|
|
|
|
if trace then
|
|
local info = debug.getinfo(2)
|
|
local name = ""
|
|
|
|
if info.name ~= nil then
|
|
name = ":" .. info.name .. "():"
|
|
end
|
|
|
|
dbg_info = info.short_src .. ":" .. name .. info.currentline .. " > "
|
|
end
|
|
|
|
_log("[ERR] " .. dbg_info .. util.strval(msg))
|
|
end
|
|
|
|
-- log fatal errors
|
|
---@param msg string message
|
|
function log.fatal(msg)
|
|
_log("[FTL] " .. util.strval(msg))
|
|
end
|
|
|
|
return log
|