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, unpack = select, table.unpack or unpack;
21 local config = require "core.configmanager";
22 local logger = require "util.logger";
23 local prosody = prosody;
25 _G.log = logger.init("general");
26 prosody.log = logger.init("general");
30 -- The log config used if none specified in the config file (see reload_logging for initialization)
31 local default_logging;
32 local default_file_logging;
33 local default_timestamp = "%b %d %H:%M:%S ";
34 -- The actual config loggingmanager is using
37 local apply_sink_rules;
38 local log_sink_types = setmetatable({}, { __newindex = function (t, k, v) rawset(t, k, v); apply_sink_rules(k); end; });
40 local logging_levels = { "debug", "info", "warn", "error" }
42 -- Put a rule into action. Requires that the sink type has already been registered.
43 -- This function is called automatically when a new sink type is added [see apply_sink_rules()]
44 local function add_rule(sink_config)
45 local sink_maker = log_sink_types[sink_config.to];
46 if not sink_maker then
47 return; -- No such sink type
51 local sink = sink_maker(sink_config);
53 -- Set sink for all chosen levels
54 for level in pairs(get_levels(sink_config.levels or logging_levels)) do
55 logger.add_level_sink(level, sink);
59 -- Search for all rules using a particular sink type, and apply
60 -- them. Called automatically when a new sink type is added to
61 -- the log_sink_types table.
62 function apply_sink_rules(sink_type)
63 if type(logging_config) == "table" then
65 for _, level in ipairs(logging_levels) do
66 if type(logging_config[level]) == "string" then
67 local value = logging_config[level];
68 if sink_type == "file" and not value:match("^%*") then
73 levels = { min = level };
75 elseif value == "*"..sink_type then
78 levels = { min = level };
84 for _, sink_config in ipairs(logging_config) do
85 if (type(sink_config) == "table" and sink_config.to == sink_type) then
86 add_rule(sink_config);
87 elseif (type(sink_config) == "string" and sink_config:match("^%*(.+)") == sink_type) then
88 add_rule({ levels = { min = "debug" }, to = sink_type });
91 elseif type(logging_config) == "string" and (not logging_config:match("^%*")) and sink_type == "file" then
92 -- User specified simply a filename, and the "file" sink type
94 for _, sink_config in pairs(default_file_logging) do
95 sink_config.filename = logging_config;
96 add_rule(sink_config);
97 sink_config.filename = nil;
99 elseif type(logging_config) == "string" and logging_config:match("^%*(.+)") == sink_type then
100 -- Log all levels (debug+) to this sink
101 add_rule({ levels = { min = "debug" }, to = sink_type });
107 --- Helper function to get a set of levels given a "criteria" table
108 function get_levels(criteria, set)
110 if type(criteria) == "string" then
111 set[criteria] = true;
114 local min, max = criteria.min, criteria.max;
117 for _, level in ipairs(logging_levels) do
121 elseif max == level then
130 for _, level in ipairs(criteria) do
136 -- Initialize config, etc. --
137 local function reload_logging()
138 local old_sink_types = {};
140 for name, sink_maker in pairs(log_sink_types) do
141 old_sink_types[name] = sink_maker;
142 log_sink_types[name] = nil;
147 local debug_mode = config.get("*", "debug");
149 default_logging = { { to = "console" , levels = { min = (debug_mode and "debug") or "info" } } };
150 default_file_logging = {
151 { to = "file", levels = { min = (debug_mode and "debug") or "info" }, timestamps = true }
154 logging_config = config.get("*", "log") or default_logging;
156 for name, sink_maker in pairs(old_sink_types) do
157 log_sink_types[name] = sink_maker;
160 prosody.events.fire_event("logging-reloaded");
164 prosody.events.add_handler("config-reloaded", reload_logging);
166 --- Definition of built-in logging sinks ---
168 -- Null sink, must enter log_sink_types *first*
169 local function log_to_nowhere()
170 return function () return false; end;
172 log_sink_types.nowhere = log_to_nowhere;
174 local function log_to_file(sink_config, logfile)
175 logfile = logfile or io_open(sink_config.filename, "a+");
177 return log_to_nowhere(sink_config);
179 local write = logfile.write;
181 local timestamps = sink_config.timestamps;
183 if timestamps == true then
184 timestamps = default_timestamp; -- Default format
185 elseif timestamps then
186 timestamps = timestamps .. " ";
189 if sink_config.buffer_mode ~= false then
190 logfile:setvbuf(sink_config.buffer_mode or "line");
193 -- Column width for "source" (used by stdout and console)
194 local sourcewidth = sink_config.source_width;
196 return function (name, level, message, ...)
197 local n = select('#', ...);
201 arg[i] = tostring(arg[i]);
203 message = format(message, unpack(arg, 1, n));
207 sourcewidth = math_max(#name+2, sourcewidth);
208 name = name .. rep(" ", sourcewidth-#name);
212 write(logfile, timestamps and os_date(timestamps) or "", name, level, "\t", message, "\n");
215 log_sink_types.file = log_to_file;
217 local function log_to_stdout(sink_config)
218 if not sink_config.timestamps then
219 sink_config.timestamps = false;
221 if sink_config.source_width == nil then
222 sink_config.source_width = 20;
224 return log_to_file(sink_config, stdout);
226 log_sink_types.stdout = log_to_stdout;
228 local do_pretty_printing = true;
231 if do_pretty_printing then
233 logstyles["info"] = getstyle("bold");
234 logstyles["warn"] = getstyle("bold", "yellow");
235 logstyles["error"] = getstyle("bold", "red");
238 local function log_to_console(sink_config)
239 -- Really if we don't want pretty colours then just use plain stdout
240 local logstdout = log_to_stdout(sink_config);
241 if not do_pretty_printing then
244 return function (name, level, message, ...)
245 local logstyle = logstyles[level];
247 level = getstring(logstyle, level);
249 return logstdout(name, level, message, ...);
252 log_sink_types.console = log_to_console;
254 local function register_sink_type(name, sink_maker)
255 local old_sink_maker = log_sink_types[name];
256 log_sink_types[name] = sink_maker;
257 return old_sink_maker;
261 reload_logging = reload_logging;
262 register_sink_type = register_sink_type;