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 -- COMPAT: This should no longer be needed since the addition of setvbuf calls
19 if os.getenv("__FLUSH_LOG") then
20 local io_flush = io.flush;
21 local _io_write = io_write;
22 io_write = function(...) _io_write(...); io_flush(); end
25 local config = require "core.configmanager";
26 local logger = require "util.logger";
27 local prosody = prosody;
29 _G.log = logger.init("general");
30 prosody.log = logger.init("general");
34 -- The log config used if none specified in the config file (see reload_logging for initialization)
35 local default_logging;
36 local default_file_logging;
37 local default_timestamp = "%b %d %H:%M:%S";
38 -- The actual config loggingmanager is using
41 local apply_sink_rules;
42 local log_sink_types = setmetatable({}, { __newindex = function (t, k, v) rawset(t, k, v); apply_sink_rules(k); end; });
44 local logging_levels = { "debug", "info", "warn", "error" }
46 -- Put a rule into action. Requires that the sink type has already been registered.
47 -- This function is called automatically when a new sink type is added [see apply_sink_rules()]
48 local function add_rule(sink_config)
49 local sink_maker = log_sink_types[sink_config.to];
50 if not sink_maker then
51 return; -- No such sink type
55 local sink = sink_maker(sink_config);
57 -- Set sink for all chosen levels
58 for level in pairs(get_levels(sink_config.levels or logging_levels)) do
59 logger.add_level_sink(level, sink);
63 -- Search for all rules using a particular sink type, and apply
64 -- them. Called automatically when a new sink type is added to
65 -- the log_sink_types table.
66 function apply_sink_rules(sink_type)
67 if type(logging_config) == "table" then
69 for _, level in ipairs(logging_levels) do
70 if type(logging_config[level]) == "string" then
71 local value = logging_config[level];
72 if sink_type == "file" and not value:match("^%*") then
77 levels = { min = level };
79 elseif value == "*"..sink_type then
82 levels = { min = level };
88 for _, sink_config in ipairs(logging_config) do
89 if (type(sink_config) == "table" and sink_config.to == sink_type) then
90 add_rule(sink_config);
91 elseif (type(sink_config) == "string" and sink_config:match("^%*(.+)") == sink_type) then
92 add_rule({ levels = { min = "debug" }, to = sink_type });
95 elseif type(logging_config) == "string" and (not logging_config:match("^%*")) and sink_type == "file" then
96 -- User specified simply a filename, and the "file" sink type
98 for _, sink_config in pairs(default_file_logging) do
99 sink_config.filename = logging_config;
100 add_rule(sink_config);
101 sink_config.filename = nil;
103 elseif type(logging_config) == "string" and logging_config:match("^%*(.+)") == sink_type then
104 -- Log all levels (debug+) to this sink
105 add_rule({ levels = { min = "debug" }, to = sink_type });
111 --- Helper function to get a set of levels given a "criteria" table
112 function get_levels(criteria, set)
114 if type(criteria) == "string" then
115 set[criteria] = true;
118 local min, max = criteria.min, criteria.max;
121 for _, level in ipairs(logging_levels) do
125 elseif max == level then
134 for _, level in ipairs(criteria) do
140 -- Initialize config, etc. --
141 local function reload_logging()
142 local old_sink_types = {};
144 for name, sink_maker in pairs(log_sink_types) do
145 old_sink_types[name] = sink_maker;
146 log_sink_types[name] = nil;
151 local debug_mode = config.get("*", "debug");
153 default_logging = { { to = "console" , levels = { min = (debug_mode and "debug") or "info" } } };
154 default_file_logging = {
155 { to = "file", levels = { min = (debug_mode and "debug") or "info" }, timestamps = true }
157 default_timestamp = "%b %d %H:%M:%S";
159 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 if sink_config.buffer_mode ~= false then
189 io.stdout:setvbuf(sink_config.buffer_mode or "line");
192 return function (name, level, message, ...)
193 sourcewidth = math_max(#name+2, sourcewidth);
194 local namelen = #name;
196 io_write(os_date(timestamps), " ");
199 io_write(name, rep(" ", sourcewidth-namelen), level, "\t", format(message, ...), "\n");
201 io_write(name, rep(" ", sourcewidth-namelen), level, "\t", message, "\n");
207 local do_pretty_printing = true;
209 local logstyles = {};
210 if do_pretty_printing then
211 logstyles["info"] = getstyle("bold");
212 logstyles["warn"] = getstyle("bold", "yellow");
213 logstyles["error"] = getstyle("bold", "red");
215 function log_sink_types.console(sink_config)
216 -- Really if we don't want pretty colours then just use plain stdout
217 if not do_pretty_printing then
218 return log_sink_types.stdout(sink_config);
221 local timestamps = sink_config.timestamps;
223 if timestamps == true then
224 timestamps = default_timestamp; -- Default format
227 if sink_config.buffer_mode ~= false then
228 io.stdout:setvbuf(sink_config.buffer_mode or "line");
231 return function (name, level, message, ...)
232 sourcewidth = math_max(#name+2, sourcewidth);
233 local namelen = #name;
236 io_write(os_date(timestamps), " ");
238 io_write(name, rep(" ", sourcewidth-namelen));
239 setstyle(logstyles[level]);
243 io_write("\t", format(message, ...), "\n");
245 io_write("\t", message, "\n");
251 local empty_function = function () end;
252 function log_sink_types.file(sink_config)
253 local log = sink_config.filename;
254 local logfile = io_open(log, "a+");
256 return empty_function;
259 if sink_config.buffer_mode ~= false then
260 logfile:setvbuf(sink_config.buffer_mode or "line");
263 local write = logfile.write;
265 local timestamps = sink_config.timestamps;
267 if timestamps == nil or timestamps == true then
268 timestamps = default_timestamp; -- Default format
271 return function (name, level, message, ...)
273 write(logfile, os_date(timestamps), " ");
276 write(logfile, name, "\t", level, "\t", format(message, ...), "\n");
278 write(logfile, name, "\t" , level, "\t", message, "\n");
283 local function register_sink_type(name, sink_maker)
284 local old_sink_maker = log_sink_types[name];
285 log_sink_types[name] = sink_maker;
286 return old_sink_maker;
290 reload_logging = reload_logging;
291 register_sink_type = register_sink_type;