2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
10 local format, rep = string.format, string.rep;
13 local tostring, setmetatable, rawset, pairs, ipairs, type =
14 tostring, setmetatable, rawset, pairs, ipairs, type;
15 local io_open, io_write = io.open, io.write;
16 local math_max, rep = math.max, string.rep;
17 local os_date, os_getenv = os.date, os.getenv;
18 local getstyle, setstyle = require "util.termcolours".getstyle, require "util.termcolours".setstyle;
20 if os.getenv("__FLUSH_LOG") then
21 local io_flush = io.flush;
22 local _io_write = io_write;
23 io_write = function(...) _io_write(...); io_flush(); end
26 local config = require "core.configmanager";
27 local logger = require "util.logger";
28 local prosody = prosody;
30 local debug_mode = config.get("*", "core", "debug");
32 _G.log = logger.init("general");
34 module "loggingmanager"
36 -- The log config used if none specified in the config file (see reload_logging for initialization)
37 local default_logging;
38 local default_file_logging;
39 local default_timestamp = "%b %d %H:%M:%S";
40 -- The actual config loggingmanager is using
43 local apply_sink_rules;
44 local log_sink_types = setmetatable({}, { __newindex = function (t, k, v) rawset(t, k, v); apply_sink_rules(k); end; });
46 local logging_levels = { "debug", "info", "warn", "error", "critical" }
48 -- Put a rule into action. Requires that the sink type has already been registered.
49 -- This function is called automatically when a new sink type is added [see apply_sink_rules()]
50 local function add_rule(sink_config)
51 local sink_maker = log_sink_types[sink_config.to];
53 if sink_config.levels and not sink_config.source then
55 local sink = sink_maker(sink_config);
57 -- Set sink for all chosen levels
58 for level in pairs(get_levels(sink_config.levels)) do
59 logger.add_level_sink(level, sink);
61 elseif sink_config.source and not sink_config.levels then
62 logger.add_name_sink(sink_config.source, sink_maker(sink_config));
63 elseif sink_config.source and sink_config.levels then
64 local levels = get_levels(sink_config.levels);
65 local sink = sink_maker(sink_config);
66 logger.add_name_sink(sink_config.source,
67 function (name, level, ...)
69 return sink(name, level, ...);
75 local sink = sink_maker(sink_config);
77 -- Set sink for all levels
78 for _, level in pairs(logging_levels) do
79 logger.add_level_sink(level, sink);
87 -- Search for all rules using a particular sink type, and apply
88 -- them. Called automatically when a new sink type is added to
89 -- the log_sink_types table.
90 function apply_sink_rules(sink_type)
91 if type(logging_config) == "table" then
93 if sink_type == "file" then
94 for _, level in ipairs(logging_levels) do
95 if type(logging_config[level]) == "string" then
98 filename = logging_config[level],
100 levels = { min = level },
106 for _, sink_config in pairs(logging_config) do
107 if (type(sink_config) == "table" and sink_config.to == sink_type) then
108 add_rule(sink_config);
109 elseif (type(sink_config) == "string" and sink_config:match("^%*(.+)") == sink_type) then
110 add_rule({ levels = { min = "debug" }, to = sink_type });
113 elseif type(logging_config) == "string" and (not logging_config:match("^%*")) and sink_type == "file" then
114 -- User specified simply a filename, and the "file" sink type
116 for _, sink_config in pairs(default_file_logging) do
117 sink_config.filename = logging_config;
118 add_rule(sink_config);
119 sink_config.filename = nil;
121 elseif type(logging_config) == "string" and logging_config:match("^%*(.+)") == sink_type then
122 -- Log all levels (debug+) to this sink
123 add_rule({ levels = { min = "debug" }, to = sink_type });
129 --- Helper function to get a set of levels given a "criteria" table
130 function get_levels(criteria, set)
132 if type(criteria) == "string" then
133 set[criteria] = true;
136 local min, max = criteria.min, criteria.max;
139 for _, level in ipairs(logging_levels) do
143 elseif max == level then
152 for _, level in ipairs(criteria) do
158 -- Initialize config, etc. --
159 function reload_logging()
160 local old_sink_types = {};
162 for name, sink_maker in pairs(log_sink_types) do
163 old_sink_types[name] = sink_maker;
164 log_sink_types[name] = nil;
169 default_logging = { { to = "console" , levels = { min = (debug_mode and "debug") or "info" } } };
170 default_file_logging = {
171 { to = "file", levels = { min = (debug_mode and "debug") or "info" }, timestamps = true }
173 default_timestamp = "%b %d %H:%M:%S";
175 logging_config = config.get("*", "core", "log") or default_logging;
178 for name, sink_maker in pairs(old_sink_types) do
179 log_sink_types[name] = sink_maker;
182 prosody.events.fire_event("logging-reloaded");
186 prosody.events.add_handler("config-reloaded", reload_logging);
188 --- Definition of built-in logging sinks ---
190 -- Null sink, must enter log_sink_types *first*
191 function log_sink_types.nowhere()
192 return function () return false; end;
195 -- Column width for "source" (used by stdout and console)
196 local sourcewidth = 20;
198 function log_sink_types.stdout()
199 local timestamps = config.timestamps;
201 if timestamps == true then
202 timestamps = default_timestamp; -- Default format
205 return function (name, level, message, ...)
206 sourcewidth = math_max(#name+2, sourcewidth);
207 local namelen = #name;
209 io_write(os_date(timestamps), " ");
212 io_write(name, rep(" ", sourcewidth-namelen), level, "\t", format(message, ...), "\n");
214 io_write(name, rep(" ", sourcewidth-namelen), level, "\t", message, "\n");
220 local do_pretty_printing = true;
222 local logstyles = {};
223 if do_pretty_printing then
224 logstyles["info"] = getstyle("bold");
225 logstyles["warn"] = getstyle("bold", "yellow");
226 logstyles["error"] = getstyle("bold", "red");
228 function log_sink_types.console(config)
229 -- Really if we don't want pretty colours then just use plain stdout
230 if not do_pretty_printing then
231 return log_sink_types.stdout(config);
234 local timestamps = config.timestamps;
236 if timestamps == true then
237 timestamps = default_timestamp; -- Default format
240 return function (name, level, message, ...)
241 sourcewidth = math_max(#name+2, sourcewidth);
242 local namelen = #name;
245 io_write(os_date(timestamps), " ");
247 io_write(name, rep(" ", sourcewidth-namelen));
248 setstyle(logstyles[level]);
252 io_write("\t", format(message, ...), "\n");
254 io_write("\t", message, "\n");
260 local empty_function = function () end;
261 function log_sink_types.file(config)
262 local log = config.filename;
263 local logfile = io_open(log, "a+");
265 return empty_function;
267 local write, flush = logfile.write, logfile.flush;
269 prosody.events.add_handler("logging-reloading", function ()
275 local timestamps = config.timestamps;
277 if timestamps == nil or timestamps == true then
278 timestamps = default_timestamp; -- Default format
281 return function (name, level, message, ...)
283 write(logfile, os_date(timestamps), " ");
286 write(logfile, name, "\t", level, "\t", format(message, ...), "\n");
288 write(logfile, name, "\t" , level, "\t", message, "\n");
294 function register_sink_type(name, sink_maker)
295 local old_sink_maker = log_sink_types[name];
296 log_sink_types[name] = sink_maker;
297 return old_sink_maker;