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 io_open, io_write = io.open, io.write;
14 local math_max, rep = math.max, string.rep;
15 local os_date = os.date;
16 local getstyle, setstyle = require "util.termcolours".getstyle, require "util.termcolours".setstyle;
18 if os.getenv("__FLUSH_LOG") then
19 local io_flush = io.flush;
20 local _io_write = io_write;
21 io_write = function(...) _io_write(...); io_flush(); end
24 local config = require "core.configmanager";
25 local logger = require "util.logger";
26 local prosody = prosody;
28 _G.log = logger.init("general");
29 prosody.log = logger.init("general");
33 -- The log config used if none specified in the config file (see reload_logging for initialization)
34 local default_logging;
35 local default_file_logging;
36 local default_timestamp = "%b %d %H:%M:%S";
37 -- The actual config loggingmanager is using
40 local apply_sink_rules;
41 local log_sink_types = setmetatable({}, { __newindex = function (t, k, v) rawset(t, k, v); apply_sink_rules(k); end; });
43 local logging_levels = { "debug", "info", "warn", "error" }
45 -- Put a rule into action. Requires that the sink type has already been registered.
46 -- This function is called automatically when a new sink type is added [see apply_sink_rules()]
47 local function add_rule(sink_config)
48 local sink_maker = log_sink_types[sink_config.to];
49 if not sink_maker then
50 return; -- No such sink type
54 local sink = sink_maker(sink_config);
56 -- Set sink for all chosen levels
57 for level in pairs(get_levels(sink_config.levels or logging_levels)) do
58 logger.add_level_sink(level, sink);
62 -- Search for all rules using a particular sink type, and apply
63 -- them. Called automatically when a new sink type is added to
64 -- the log_sink_types table.
65 function apply_sink_rules(sink_type)
66 if type(logging_config) == "table" then
68 for _, level in ipairs(logging_levels) do
69 if type(logging_config[level]) == "string" then
70 local value = logging_config[level];
71 if sink_type == "file" and not value:match("^%*") then
76 levels = { min = level };
78 elseif value == "*"..sink_type then
81 levels = { min = level };
87 for _, sink_config in ipairs(logging_config) do
88 if (type(sink_config) == "table" and sink_config.to == sink_type) then
89 add_rule(sink_config);
90 elseif (type(sink_config) == "string" and sink_config:match("^%*(.+)") == sink_type) then
91 add_rule({ levels = { min = "debug" }, to = sink_type });
94 elseif type(logging_config) == "string" and (not logging_config:match("^%*")) and sink_type == "file" then
95 -- User specified simply a filename, and the "file" sink type
97 for _, sink_config in pairs(default_file_logging) do
98 sink_config.filename = logging_config;
99 add_rule(sink_config);
100 sink_config.filename = nil;
102 elseif type(logging_config) == "string" and logging_config:match("^%*(.+)") == sink_type then
103 -- Log all levels (debug+) to this sink
104 add_rule({ levels = { min = "debug" }, to = sink_type });
110 --- Helper function to get a set of levels given a "criteria" table
111 function get_levels(criteria, set)
113 if type(criteria) == "string" then
114 set[criteria] = true;
117 local min, max = criteria.min, criteria.max;
120 for _, level in ipairs(logging_levels) do
124 elseif max == level then
133 for _, level in ipairs(criteria) do
139 -- Initialize config, etc. --
140 local function reload_logging()
141 local old_sink_types = {};
143 for name, sink_maker in pairs(log_sink_types) do
144 old_sink_types[name] = sink_maker;
145 log_sink_types[name] = nil;
150 local debug_mode = config.get("*", "debug");
152 default_logging = { { to = "console" , levels = { min = (debug_mode and "debug") or "info" } } };
153 default_file_logging = {
154 { to = "file", levels = { min = (debug_mode and "debug") or "info" }, timestamps = true }
156 default_timestamp = "%b %d %H:%M:%S";
158 logging_config = config.get("*", "log") or default_logging;
161 for name, sink_maker in pairs(old_sink_types) do
162 log_sink_types[name] = sink_maker;
165 prosody.events.fire_event("logging-reloaded");
169 prosody.events.add_handler("config-reloaded", reload_logging);
171 --- Definition of built-in logging sinks ---
173 -- Null sink, must enter log_sink_types *first*
174 function log_sink_types.nowhere()
175 return function () return false; end;
178 -- Column width for "source" (used by stdout and console)
179 local sourcewidth = 20;
181 function log_sink_types.stdout(sink_config)
182 local timestamps = sink_config.timestamps;
184 if timestamps == true then
185 timestamps = default_timestamp; -- Default format
188 return function (name, level, message, ...)
189 sourcewidth = math_max(#name+2, sourcewidth);
190 local namelen = #name;
192 io_write(os_date(timestamps), " ");
195 io_write(name, rep(" ", sourcewidth-namelen), level, "\t", format(message, ...), "\n");
197 io_write(name, rep(" ", sourcewidth-namelen), level, "\t", message, "\n");
203 local do_pretty_printing = true;
205 local logstyles = {};
206 if do_pretty_printing then
207 logstyles["info"] = getstyle("bold");
208 logstyles["warn"] = getstyle("bold", "yellow");
209 logstyles["error"] = getstyle("bold", "red");
211 function log_sink_types.console(sink_config)
212 -- Really if we don't want pretty colours then just use plain stdout
213 if not do_pretty_printing then
214 return log_sink_types.stdout(sink_config);
217 local timestamps = sink_config.timestamps;
219 if timestamps == true then
220 timestamps = default_timestamp; -- Default format
223 return function (name, level, message, ...)
224 sourcewidth = math_max(#name+2, sourcewidth);
225 local namelen = #name;
228 io_write(os_date(timestamps), " ");
230 io_write(name, rep(" ", sourcewidth-namelen));
231 setstyle(logstyles[level]);
235 io_write("\t", format(message, ...), "\n");
237 io_write("\t", message, "\n");
243 local empty_function = function () end;
244 function log_sink_types.file(sink_config)
245 local log = sink_config.filename;
246 local logfile = io_open(log, "a+");
248 return empty_function;
250 local write, flush = logfile.write, logfile.flush;
252 local timestamps = sink_config.timestamps;
254 if timestamps == nil or timestamps == true then
255 timestamps = default_timestamp; -- Default format
258 return function (name, level, message, ...)
260 write(logfile, os_date(timestamps), " ");
263 write(logfile, name, "\t", level, "\t", format(message, ...), "\n");
265 write(logfile, name, "\t" , level, "\t", message, "\n");
271 local function register_sink_type(name, sink_maker)
272 local old_sink_maker = log_sink_types[name];
273 log_sink_types[name] = sink_maker;
274 return old_sink_maker;
278 reload_logging = reload_logging;
279 register_sink_type = register_sink_type;