util.cache: Add support for creating a proxy table to a cache, that looks and acts...
[prosody.git] / core / loggingmanager.lua
index c26fdc719d57ea2c1753e20facc6fbdeeddcc327..e3a83817b5d239c2009bc0261b674ad71ef98b7b 100644 (file)
@@ -1,79 +1,59 @@
 -- Prosody IM
--- Copyright (C) 2008-2009 Matthew Wild
--- Copyright (C) 2008-2009 Waqas Hussain
--- 
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+--
 -- This project is MIT/X11 licensed. Please see the
 -- COPYING file in the source package for more information.
 --
 
 
-local format, rep = string.format, string.rep;
-local pcall = pcall;
-local debug = debug;
-local tostring, setmetatable, rawset, pairs, ipairs, type = 
-       tostring, setmetatable, rawset, pairs, ipairs, type;
-local io_open, io_write = io.open, io.write;
+local format = string.format;
+local setmetatable, rawset, pairs, ipairs, type =
+       setmetatable, rawset, pairs, ipairs, type;
+local stdout = io.stdout;
+local io_open = io.open;
 local math_max, rep = math.max, string.rep;
-local os_date, os_getenv = os.date, os.getenv;
+local os_date = os.date;
 local getstyle, getstring = require "util.termcolours".getstyle, require "util.termcolours".getstring;
+local tostring = tostring;
+local select = select;
+local unpack = table.unpack or unpack; --luacheck: ignore 113
 
 local config = require "core.configmanager";
-local eventmanager = require "core.eventmanager";
 local logger = require "util.logger";
-local debug_mode = config.get("*", "core", "debug");
+local prosody = prosody;
 
 _G.log = logger.init("general");
+prosody.log = logger.init("general");
 
-module "loggingmanager"
+local _ENV = nil;
 
--- The log config used if none specified in the config file
-local default_logging = { { to = "console" } };
-local default_file_logging = { { to = "file", levels = { min = (debug_mode and "debug") or "info" }, timestamps = true } };
-local default_timestamp = "%b %d %T";
+-- The log config used if none specified in the config file (see reload_logging for initialization)
+local default_logging;
+local default_file_logging;
+local default_timestamp = "%b %d %H:%M:%S ";
 -- The actual config loggingmanager is using
-local logging_config = config.get("*", "core", "log") or default_logging;
+local logging_config;
 
 local apply_sink_rules;
 local log_sink_types = setmetatable({}, { __newindex = function (t, k, v) rawset(t, k, v); apply_sink_rules(k); end; });
 local get_levels;
-local logging_levels = { "debug", "info", "warn", "error", "critical" }
+local logging_levels = { "debug", "info", "warn", "error" }
 
 -- Put a rule into action. Requires that the sink type has already been registered.
 -- This function is called automatically when a new sink type is added [see apply_sink_rules()]
 local function add_rule(sink_config)
        local sink_maker = log_sink_types[sink_config.to];
-       if sink_maker then
-               if sink_config.levels and not sink_config.source then
-                       -- Create sink
-                       local sink = sink_maker(sink_config);
-                       
-                       -- Set sink for all chosen levels
-                       for level in pairs(get_levels(sink_config.levels)) do
-                               logger.add_level_sink(level, sink);
-                       end
-               elseif sink_config.source and not sink_config.levels then
-                       logger.add_name_sink(sink_config.source, sink_maker(sink_config));
-               elseif sink_config.source and sink_config.levels then
-                       local levels = get_levels(sink_config.levels);
-                       local sink = sink_maker(sink_config);
-                       logger.add_name_sink(sink_config.source,
-                               function (name, level, ...)
-                                       if levels[level] then
-                                               return sink(name, level, ...);
-                                       end
-                               end);
-               else
-                       -- All sources
-                       -- Create sink
-                       local sink = sink_maker(sink_config);
-                       
-                       -- Set sink for all levels
-                       for _, level in pairs(logging_levels) do
-                               logger.add_level_sink(level, sink);
-                       end
-               end
-       else
-               -- No such sink type
+       if not sink_maker then
+               return; -- No such sink type
+       end
+
+       -- Create sink
+       local sink = sink_maker(sink_config);
+
+       -- Set sink for all chosen levels
+       for level in pairs(get_levels(sink_config.levels or logging_levels)) do
+               logger.add_level_sink(level, sink);
        end
 end
 
@@ -82,13 +62,35 @@ end
 -- the log_sink_types table.
 function apply_sink_rules(sink_type)
        if type(logging_config) == "table" then
-               for _, sink_config in pairs(logging_config) do
-                       if sink_config.to == sink_type then
+
+               for _, level in ipairs(logging_levels) do
+                       if type(logging_config[level]) == "string" then
+                               local value = logging_config[level];
+                               if sink_type == "file" and not value:match("^%*") then
+                                       add_rule({
+                                               to = sink_type;
+                                               filename = value;
+                                               timestamps = true;
+                                               levels = { min = level };
+                                       });
+                               elseif value == "*"..sink_type then
+                                       add_rule({
+                                               to = sink_type;
+                                               levels = { min = level };
+                                       });
+                               end
+                       end
+               end
+
+               for _, sink_config in ipairs(logging_config) do
+                       if (type(sink_config) == "table" and sink_config.to == sink_type) then
                                add_rule(sink_config);
+                       elseif (type(sink_config) == "string" and sink_config:match("^%*(.+)") == sink_type) then
+                               add_rule({ levels = { min = "debug" }, to = sink_type });
                        end
                end
        elseif type(logging_config) == "string" and (not logging_config:match("^%*")) and sink_type == "file" then
-               -- User specified simply a filename, and the "file" sink type 
+               -- User specified simply a filename, and the "file" sink type
                -- was just added
                for _, sink_config in pairs(default_file_logging) do
                        sink_config.filename = logging_config;
@@ -122,128 +124,141 @@ function get_levels(criteria, set)
                                return set;
                        elseif in_range then
                                set[level] = true;
-                       end     
+                       end
                end
        end
-       
+
        for _, level in ipairs(criteria) do
                set[level] = true;
        end
        return set;
 end
 
+-- Initialize config, etc. --
+local function reload_logging()
+       local old_sink_types = {};
+
+       for name, sink_maker in pairs(log_sink_types) do
+               old_sink_types[name] = sink_maker;
+               log_sink_types[name] = nil;
+       end
+
+       logger.reset();
+
+       local debug_mode = config.get("*", "debug");
+
+       default_logging = { { to = "console" , levels = { min = (debug_mode and "debug") or "info" } } };
+       default_file_logging = {
+               { to = "file", levels = { min = (debug_mode and "debug") or "info" }, timestamps = true }
+       };
+
+       logging_config = config.get("*", "log") or default_logging;
+
+       for name, sink_maker in pairs(old_sink_types) do
+               log_sink_types[name] = sink_maker;
+       end
+
+       prosody.events.fire_event("logging-reloaded");
+end
+
+reload_logging();
+prosody.events.add_handler("config-reloaded", reload_logging);
+
 --- Definition of built-in logging sinks ---
 
 -- Null sink, must enter log_sink_types *first*
-function log_sink_types.nowhere()
+local function log_to_nowhere()
        return function () return false; end;
 end
+log_sink_types.nowhere = log_to_nowhere;
 
--- Column width for "source" (used by stdout and console)
-local sourcewidth = 20;
+local function log_to_file(sink_config, logfile)
+       logfile = logfile or io_open(sink_config.filename, "a+");
+       if not logfile then
+               return log_to_nowhere(sink_config);
+       end
+       local write = logfile.write;
+
+       local timestamps = sink_config.timestamps;
 
-function log_sink_types.stdout()
-       local timestamps = config.timestamps;
-       
        if timestamps == true then
                timestamps = default_timestamp; -- Default format
+       elseif timestamps then
+               timestamps = timestamps .. " ";
        end
-       
-       return function (name, level, message, ...)
-               sourcewidth = math_max(#name+2, sourcewidth);
-               local namelen = #name;
-               if timestamps then
-                       io_write(os_date(timestamps), " ");
-               end
-               if ... then 
-                       io_write(name, rep(" ", sourcewidth-namelen), level, "\t", format(message, ...), "\n");
-               else
-                       io_write(name, rep(" ", sourcewidth-namelen), level, "\t", message, "\n");
-               end
-       end     
-end
 
-do
-       local do_pretty_printing = not os_getenv("WINDIR");
-       
-       local logstyles = {};
-       if do_pretty_printing then
-               logstyles["info"] = getstyle("bold");
-               logstyles["warn"] = getstyle("bold", "yellow");
-               logstyles["error"] = getstyle("bold", "red");
-       end
-       function log_sink_types.console(config)
-               -- Really if we don't want pretty colours then just use plain stdout
-               if not do_pretty_printing then
-                       return log_sink_types.stdout(config);
-               end
-               
-               local timestamps = config.timestamps;
+       if sink_config.buffer_mode ~= false then
+               logfile:setvbuf(sink_config.buffer_mode or "line");
+       end
+
+       -- Column width for "source" (used by stdout and console)
+       local sourcewidth = sink_config.source_width;
 
-               if timestamps == true then
-                       timestamps = default_timestamp; -- Default format
+       return function (name, level, message, ...)
+               local n = select('#', ...);
+               if n ~= 0 then
+                       local arg = { ... };
+                       for i = 1, n do
+                               arg[i] = tostring(arg[i]);
+                       end
+                       message = format(message, unpack(arg, 1, n));
                end
 
-               return function (name, level, message, ...)
+               if sourcewidth then
                        sourcewidth = math_max(#name+2, sourcewidth);
-                       local namelen = #name;
-                       
-                       if timestamps then
-                               io_write(os_date(timestamps), " ");
-                       end
-                       if ... then 
-                               io_write(name, rep(" ", sourcewidth-namelen), getstring(logstyles[level], level), "\t", format(message, ...), "\n");
-                       else
-                               io_write(name, rep(" ", sourcewidth-namelen), getstring(logstyles[level], level), "\t", message, "\n");
-                       end
+                       name = name ..  rep(" ", sourcewidth-#name);
+               else
+                       name = name .. "\t";
                end
+               write(logfile, timestamps and os_date(timestamps) or "", name, level, "\t", message, "\n");
        end
 end
+log_sink_types.file = log_to_file;
 
-local empty_function = function () end;
-function log_sink_types.file(config)
-       local log = config.filename;
-       local logfile = io_open(log, "a+");
-       if not logfile then
-               return empty_function;
+local function log_to_stdout(sink_config)
+       if not sink_config.timestamps then
+               sink_config.timestamps = false;
+       end
+       if sink_config.source_width == nil then
+               sink_config.source_width = 20;
        end
-       local write, flush = logfile.write, logfile.flush;
+       return log_to_file(sink_config, stdout);
+end
+log_sink_types.stdout = log_to_stdout;
 
-       eventmanager.add_event_hook("reopen-log-files", function ()
-                       if logfile then
-                               logfile:close();
-                       end
-                       logfile = io_open(log, "a+");
-                       if not logfile then
-                               write, flush = empty_function, empty_function;
-                       else
-                               write, flush = logfile.write, logfile.flush;
-                       end
-               end);
+local do_pretty_printing = true;
 
-       local timestamps = config.timestamps;
+local logstyles;
+if do_pretty_printing then
+       logstyles = {};
+       logstyles["info"] = getstyle("bold");
+       logstyles["warn"] = getstyle("bold", "yellow");
+       logstyles["error"] = getstyle("bold", "red");
+end
 
-       if timestamps == nil or timestamps == true then
-               timestamps = default_timestamp; -- Default format
+local function log_to_console(sink_config)
+       -- Really if we don't want pretty colours then just use plain stdout
+       local logstdout = log_to_stdout(sink_config);
+       if not do_pretty_printing then
+               return logstdout;
        end
-
        return function (name, level, message, ...)
-               if timestamps then
-                       write(logfile, os_date(timestamps), " ");
+               local logstyle = logstyles[level];
+               if logstyle then
+                       level = getstring(logstyle, level);
                end
-               if ... then 
-                       write(logfile, name, "\t", level, "\t", format(message, ...), "\n");
-               else
-                       write(logfile, name, "\t" , level, "\t", message, "\n");
-               end
-               flush(logfile);
-       end;
+               return logstdout(name, level, message, ...);
+       end
 end
+log_sink_types.console = log_to_console;
 
-function register_sink_type(name, sink_maker)
+local function register_sink_type(name, sink_maker)
        local old_sink_maker = log_sink_types[name];
        log_sink_types[name] = sink_maker;
        return old_sink_maker;
 end
 
-return _M;
+return {
+       reload_logging = reload_logging;
+       register_sink_type = register_sink_type;
+}