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 = string.format;
11 local setmetatable, rawset, pairs, ipairs, type =
12 setmetatable, rawset, pairs, ipairs, type;
13 local stdout = io.stdout;
14 local io_open = io.open;
15 local math_max, rep = math.max, string.rep;
16 local os_date = os.date;
17 local getstyle, getstring = require "util.termcolours".getstyle, require "util.termcolours".getstring;
18 local tostring = tostring;
19 local select = select;
20 local unpack = table.unpack or unpack; --luacheck: ignore 113
22 local config = require "core.configmanager";
23 local logger = require "util.logger";
24 local prosody = prosody;
26 _G.log = logger.init("general");
27 prosody.log = logger.init("general");
31 -- The log config used if none specified in the config file (see reload_logging for initialization)
32 local default_logging;
33 local default_file_logging;
34 local default_timestamp = "%b %d %H:%M:%S ";
35 -- The actual config loggingmanager is using
38 local apply_sink_rules;
39 local log_sink_types = setmetatable({}, { __newindex = function (t, k, v) rawset(t, k, v); apply_sink_rules(k); end; });
41 local logging_levels = { "debug", "info", "warn", "error" }
43 -- Put a rule into action. Requires that the sink type has already been registered.
44 -- This function is called automatically when a new sink type is added [see apply_sink_rules()]
45 local function add_rule(sink_config)
46 local sink_maker = log_sink_types[sink_config.to];
47 if not sink_maker then
48 return; -- No such sink type
52 local sink = sink_maker(sink_config);
54 -- Set sink for all chosen levels
55 for level in pairs(get_levels(sink_config.levels or logging_levels)) do
56 logger.add_level_sink(level, sink);
60 -- Search for all rules using a particular sink type, and apply
61 -- them. Called automatically when a new sink type is added to
62 -- the log_sink_types table.
63 function apply_sink_rules(sink_type)
64 if type(logging_config) == "table" then
66 for _, level in ipairs(logging_levels) do
67 if type(logging_config[level]) == "string" then
68 local value = logging_config[level];
69 if sink_type == "file" and not value:match("^%*") then
74 levels = { min = level };
76 elseif value == "*"..sink_type then
79 levels = { min = level };
85 for _, sink_config in ipairs(logging_config) do
86 if (type(sink_config) == "table" and sink_config.to == sink_type) then
87 add_rule(sink_config);
88 elseif (type(sink_config) == "string" and sink_config:match("^%*(.+)") == sink_type) then
89 add_rule({ levels = { min = "debug" }, to = sink_type });
92 elseif type(logging_config) == "string" and (not logging_config:match("^%*")) and sink_type == "file" then
93 -- User specified simply a filename, and the "file" sink type
95 for _, sink_config in pairs(default_file_logging) do
96 sink_config.filename = logging_config;
97 add_rule(sink_config);
98 sink_config.filename = nil;
100 elseif type(logging_config) == "string" and logging_config:match("^%*(.+)") == sink_type then
101 -- Log all levels (debug+) to this sink
102 add_rule({ levels = { min = "debug" }, to = sink_type });
108 --- Helper function to get a set of levels given a "criteria" table
109 function get_levels(criteria, set)
111 if type(criteria) == "string" then
112 set[criteria] = true;
115 local min, max = criteria.min, criteria.max;
118 for _, level in ipairs(logging_levels) do
122 elseif max == level then
131 for _, level in ipairs(criteria) do
137 -- Initialize config, etc. --
138 local function reload_logging()
139 local old_sink_types = {};
141 for name, sink_maker in pairs(log_sink_types) do
142 old_sink_types[name] = sink_maker;
143 log_sink_types[name] = nil;
148 local debug_mode = config.get("*", "debug");
150 default_logging = { { to = "console" , levels = { min = (debug_mode and "debug") or "info" } } };
151 default_file_logging = {
152 { to = "file", levels = { min = (debug_mode and "debug") or "info" }, timestamps = true }
155 logging_config = config.get("*", "log") or default_logging;
157 for name, sink_maker in pairs(old_sink_types) do
158 log_sink_types[name] = sink_maker;
161 prosody.events.fire_event("logging-reloaded");
165 prosody.events.add_handler("config-reloaded", reload_logging);
167 --- Definition of built-in logging sinks ---
169 -- Null sink, must enter log_sink_types *first*
170 local function log_to_nowhere()
171 return function () return false; end;
173 log_sink_types.nowhere = log_to_nowhere;
175 local function log_to_file(sink_config, logfile)
176 logfile = logfile or io_open(sink_config.filename, "a+");
178 return log_to_nowhere(sink_config);
180 local write = logfile.write;
182 local timestamps = sink_config.timestamps;
184 if timestamps == true then
185 timestamps = default_timestamp; -- Default format
186 elseif timestamps then
187 timestamps = timestamps .. " ";
190 if sink_config.buffer_mode ~= false then
191 logfile:setvbuf(sink_config.buffer_mode or "line");
194 -- Column width for "source" (used by stdout and console)
195 local sourcewidth = sink_config.source_width;
197 return function (name, level, message, ...)
198 local n = select('#', ...);
202 arg[i] = tostring(arg[i]);
204 message = format(message, unpack(arg, 1, n));
208 sourcewidth = math_max(#name+2, sourcewidth);
209 name = name .. rep(" ", sourcewidth-#name);
213 write(logfile, timestamps and os_date(timestamps) or "", name, level, "\t", message, "\n");
216 log_sink_types.file = log_to_file;
218 local function log_to_stdout(sink_config)
219 if not sink_config.timestamps then
220 sink_config.timestamps = false;
222 if sink_config.source_width == nil then
223 sink_config.source_width = 20;
225 return log_to_file(sink_config, stdout);
227 log_sink_types.stdout = log_to_stdout;
229 local do_pretty_printing = true;
232 if do_pretty_printing then
234 logstyles["info"] = getstyle("bold");
235 logstyles["warn"] = getstyle("bold", "yellow");
236 logstyles["error"] = getstyle("bold", "red");
239 local function log_to_console(sink_config)
240 -- Really if we don't want pretty colours then just use plain stdout
241 local logstdout = log_to_stdout(sink_config);
242 if not do_pretty_printing then
245 return function (name, level, message, ...)
246 local logstyle = logstyles[level];
248 level = getstring(logstyle, level);
250 return logstdout(name, level, message, ...);
253 log_sink_types.console = log_to_console;
255 local function register_sink_type(name, sink_maker)
256 local old_sink_maker = log_sink_types[name];
257 log_sink_types[name] = sink_maker;
258 return old_sink_maker;
262 reload_logging = reload_logging;
263 register_sink_type = register_sink_type;