From 971756b5d4fc05887e6491390730a85901943a94 Mon Sep 17 00:00:00 2001 From: FireSiku Date: Mon, 7 May 2018 04:38:17 -0400 Subject: [PATCH 1/4] Deduplicate logging code. --- .../mods/vmf/modules/core/core_functions.lua | 108 ++++-------------- 1 file changed, 25 insertions(+), 83 deletions(-) diff --git a/vmf/scripts/mods/vmf/modules/core/core_functions.lua b/vmf/scripts/mods/vmf/modules/core/core_functions.lua index 3f3407d..6e66330 100644 --- a/vmf/scripts/mods/vmf/modules/core/core_functions.lua +++ b/vmf/scripts/mods/vmf/modules/core/core_functions.lua @@ -40,112 +40,54 @@ local function send_to_log(message) print("[MOD]" .. message) end --- #################################################################################################################### --- ##### VMFMod ####################################################################################################### --- #################################################################################################################### +local function log_message(self, msg_type, message, ...) -VMFMod.echo = function (self, message, ...) - - message = tostring(message) - - message = safe_format(self, message, ...) + message = safe_format(self, tostring(message), ...) if message then - if _LOGGING_SETTINGS.echo.send_to_chat then + if _LOGGING_SETTINGS[msg_type].send_to_chat then send_to_chat(message) end message = "[" .. self:get_name() .. "][ECHO] " .. message - if _LOGGING_SETTINGS.echo.send_to_log then - send_to_log(message) + if _LOGGING_SETTINGS[msg_type].send_to_log then + send_to_log(self, msg_type, message) end end end - -VMFMod.error = function (self, message, ...) - - message = tostring(message) - - message = safe_format(self, message, ...) - - if message then - message = "[" .. self:get_name() .. "][ERROR] " .. message - - if _LOGGING_SETTINGS.error.send_to_chat then - send_to_chat(message) - end - - if _LOGGING_SETTINGS.error.send_to_log then - send_to_log(message) - end - end +-- #################################################################################################################### +-- ##### VMFMod ####################################################################################################### +-- #################################################################################################################### +--_LOGGING_SETTINGS.echo +function VMFMod.echo(self, message, ...) + log_message(self, "echo", message, ...) end -VMFMod.warning = function (self, message, ...) - - message = tostring(message) - - message = safe_format(self, message, ...) - - if message then - message = "[" .. self:get_name() .. "][WARNING] " .. message - - if _LOGGING_SETTINGS.warning.send_to_chat then - send_to_chat(message) - end - - if _LOGGING_SETTINGS.warning.send_to_log then - send_to_log(message) - end - end +function VMFMod.error(self, message, ...) + log_message(self, "error", message, ...) end -VMFMod.info = function (self, message, ...) - - message = tostring(message) - - message = safe_format(self, message, ...) - - if message then - message = "[" .. self:get_name() .. "][INFO] " .. message - - if _LOGGING_SETTINGS.info.send_to_chat then - send_to_chat(message) - end - - if _LOGGING_SETTINGS.info.send_to_log then - send_to_log(message) - end - end +function VMFMod.warning(self, message, ...) + log_message(self, "warning", message, ...) end -VMFMod.debug = function (self, message, ...) - - message = tostring(message) - - message = safe_format(self, message, ...) - - if message then - message = "[" .. self:get_name() .. "][DEBUG] " .. message - - if _LOGGING_SETTINGS.debug.send_to_chat then - send_to_chat(message) - end - - if _LOGGING_SETTINGS.debug.send_to_log then - send_to_log(message) - end - end +function VMFMod.info(self, message, ...) + log_message(self, "info", message, ...) end -VMFMod.pcall = function (self, ...) +function VMFMod.debug(self, message, ...) + log_message(self, "debug", message, ...) +end + + +function VMFMod.pcall(self, ...) local status, values = pack_pcall(pcall(...)) if not status then @@ -156,7 +98,7 @@ VMFMod.pcall = function (self, ...) end -VMFMod.dofile = function (self, script_path) +function VMFMod.dofile(self, script_path) local success, values = pack_pcall(pcall(dofile, script_path)) @@ -195,7 +137,7 @@ end vmf.unsent_chat_messages = _UNSENT_CHAT_MESSAGES -vmf.load_logging_settings = function () +function vmf.load_logging_settings() _LOGGING_SETTINGS = { echo = vmf:get("logging_mode") == "custom" and vmf:get("output_mode_echo") or 3, -- @TODO: clean up? From 1b21550aa5358f1455df31b69e03dd05090fd32d Mon Sep 17 00:00:00 2001 From: FireSiku Date: Mon, 7 May 2018 05:04:52 -0400 Subject: [PATCH 2/4] Don't format string for logging if we aren't sending to log. --- vmf/scripts/mods/vmf/modules/core/core_functions.lua | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/vmf/scripts/mods/vmf/modules/core/core_functions.lua b/vmf/scripts/mods/vmf/modules/core/core_functions.lua index 6e66330..c15eab5 100644 --- a/vmf/scripts/mods/vmf/modules/core/core_functions.lua +++ b/vmf/scripts/mods/vmf/modules/core/core_functions.lua @@ -35,9 +35,9 @@ local function send_to_chat(message) end end -local function send_to_log(message) +local function send_to_log(self, msg_type, message) - print("[MOD]" .. message) + printf("[MOD][%s][%s] %s", self:get_name(), string.upper(msg_type), message) end local function log_message(self, msg_type, message, ...) @@ -50,11 +50,10 @@ local function log_message(self, msg_type, message, ...) send_to_chat(message) end - message = "[" .. self:get_name() .. "][ECHO] " .. message - if _LOGGING_SETTINGS[msg_type].send_to_log then send_to_log(self, msg_type, message) end + end end From 4e0019306ca04d349539e93edb78e7b3184c0b58 Mon Sep 17 00:00:00 2001 From: FireSiku Date: Mon, 7 May 2018 05:52:58 -0400 Subject: [PATCH 3/4] Don't format message if logging is disabled. --- .../mods/vmf/modules/core/core_functions.lua | 25 +++++++++++++------ 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/vmf/scripts/mods/vmf/modules/core/core_functions.lua b/vmf/scripts/mods/vmf/modules/core/core_functions.lua index c15eab5..013749b 100644 --- a/vmf/scripts/mods/vmf/modules/core/core_functions.lua +++ b/vmf/scripts/mods/vmf/modules/core/core_functions.lua @@ -53,7 +53,7 @@ local function log_message(self, msg_type, message, ...) if _LOGGING_SETTINGS[msg_type].send_to_log then send_to_log(self, msg_type, message) end - + end end @@ -62,27 +62,37 @@ end -- #################################################################################################################### --_LOGGING_SETTINGS.echo function VMFMod.echo(self, message, ...) - log_message(self, "echo", message, ...) + if _LOGGING_SETTINGS.echo.enabled then + log_message(self, "echo", message, ...) + end end function VMFMod.error(self, message, ...) - log_message(self, "error", message, ...) + if _LOGGING_SETTINGS.error.enabled then + log_message(self, "error", message, ...) + end end function VMFMod.warning(self, message, ...) - log_message(self, "warning", message, ...) + if _LOGGING_SETTINGS.warning.enabled then + log_message(self, "warning", message, ...) + end end function VMFMod.info(self, message, ...) - log_message(self, "info", message, ...) + if _LOGGING_SETTINGS.info.enabled then + log_message(self, "info", message, ...) + end end function VMFMod.debug(self, message, ...) - log_message(self, "debug", message, ...) + if _LOGGING_SETTINGS.debug.enabled then + log_message(self, "debug", message, ...) + end end @@ -149,7 +159,8 @@ function vmf.load_logging_settings() for method_name, logging_mode in pairs(_LOGGING_SETTINGS) do _LOGGING_SETTINGS[method_name] = { send_to_chat = logging_mode and logging_mode >= 2, - send_to_log = logging_mode and logging_mode % 2 == 1 + send_to_log = logging_mode and logging_mode % 2 == 1, + enabled = logging_mode and logging_mode > 0 } end end From ed31d8e58f2dbcf4fc553cac3ced26b574c303b1 Mon Sep 17 00:00:00 2001 From: FireSiku Date: Mon, 7 May 2018 07:16:27 -0400 Subject: [PATCH 4/4] Changed functions to use implicit self. --- .../mods/vmf/modules/core/core_functions.lua | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/vmf/scripts/mods/vmf/modules/core/core_functions.lua b/vmf/scripts/mods/vmf/modules/core/core_functions.lua index 013749b..ae29274 100644 --- a/vmf/scripts/mods/vmf/modules/core/core_functions.lua +++ b/vmf/scripts/mods/vmf/modules/core/core_functions.lua @@ -61,42 +61,42 @@ end -- ##### VMFMod ####################################################################################################### -- #################################################################################################################### --_LOGGING_SETTINGS.echo -function VMFMod.echo(self, message, ...) +function VMFMod:echo(message, ...) if _LOGGING_SETTINGS.echo.enabled then log_message(self, "echo", message, ...) end end -function VMFMod.error(self, message, ...) +function VMFMod:error(message, ...) if _LOGGING_SETTINGS.error.enabled then log_message(self, "error", message, ...) end end -function VMFMod.warning(self, message, ...) +function VMFMod:warning(message, ...) if _LOGGING_SETTINGS.warning.enabled then log_message(self, "warning", message, ...) end end -function VMFMod.info(self, message, ...) +function VMFMod:info(message, ...) if _LOGGING_SETTINGS.info.enabled then log_message(self, "info", message, ...) end end -function VMFMod.debug(self, message, ...) +function VMFMod:debug(message, ...) if _LOGGING_SETTINGS.debug.enabled then log_message(self, "debug", message, ...) end end -function VMFMod.pcall(self, ...) +function VMFMod:pcall(...) local status, values = pack_pcall(pcall(...)) if not status then @@ -107,7 +107,7 @@ function VMFMod.pcall(self, ...) end -function VMFMod.dofile(self, script_path) +function VMFMod:dofile(script_path) local success, values = pack_pcall(pcall(dofile, script_path))