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");
30 module "loggingmanager"
32 -- The log config used if none specified in the config file (see reload_logging for initialization)
33 local default_logging;
34 local default_file_logging;
35 local default_timestamp = "%b %d %H:%M:%S";
36 -- The actual config loggingmanager is using
39 local apply_sink_rules;
40 local log_sink_types = setmetatable({}, { __newindex = function (t, k, v) rawset(t, k, v); apply_sink_rules(k); end; });
42 local logging_levels = { "debug", "info", "warn", "error" }
44 -- Put a rule into action. Requires that the sink type has already been registered.
45 -- This function is called automatically when a new sink type is added [see apply_sink_rules()]
46 local function add_rule(sink_config)
47 local sink_maker = log_sink_types[sink_config.to];
50 local sink = sink_maker(sink_config);
52 -- Set sink for all chosen levels
53 for level in pairs(get_levels(sink_config.levels or logging_levels)) do
54 logger.add_level_sink(level, sink);
61 -- Search for all rules using a particular sink type, and apply
62 -- them. Called automatically when a new sink type is added to
63 -- the log_sink_types table.
64 function apply_sink_rules(sink_type)
65 if type(logging_config) == "table" then
67 for _, level in ipairs(logging_levels) do
68 if type(logging_config[level]) == "string" then
69 local value = logging_config[level];
70 if sink_type == "file" then
75 levels = { min = level };
77 elseif value == "*"..sink_type then
80 levels = { min = level };
86 for _, sink_config in ipairs(logging_config) do
87 if (type(sink_config) == "table" and sink_config.to == sink_type) then
88 add_rule(sink_config);
89 elseif (type(sink_config) == "string" and sink_config:match("^%*(.+)") == sink_type) then
90 add_rule({ levels = { min = "debug" }, to = sink_type });
93 elseif type(logging_config) == "string" and (not logging_config:match("^%*")) and sink_type == "file" then
94 -- User specified simply a filename, and the "file" sink type
96 for _, sink_config in pairs(default_file_logging) do
97 sink_config.filename = logging_config;
98 add_rule(sink_config);
99 sink_config.filename = nil;
101 elseif type(logging_config) == "string" and logging_config:match("^%*(.+)") == sink_type then
102 -- Log all levels (debug+) to this sink
103 add_rule({ levels = { min = "debug" }, to = sink_type });
109 --- Helper function to get a set of levels given a "criteria" table
110 function get_levels(criteria, set)
112 if type(criteria) == "string" then
113 set[criteria] = true;
116 local min, max = criteria.min, criteria.max;
119 for _, level in ipairs(logging_levels) do
123 elseif max == level then
132 for _, level in ipairs(criteria) do
138 -- Initialize config, etc. --
139 function reload_logging()
140 local old_sink_types = {};
142 for name, sink_maker in pairs(log_sink_types) do
143 old_sink_types[name] = sink_maker;
144 log_sink_types[name] = nil;
149 local debug_mode = config.get("*", "core", "debug");
151 default_logging = { { to = "console" , levels = { min = (debug_mode and "debug") or "info" } } };
152 default_file_logging = {
153 { to = "file", levels = { min = (debug_mode and "debug") or "info" }, timestamps = true }
155 default_timestamp = "%b %d %H:%M:%S";
157 logging_config = config.get("*", "core", "log") or default_logging;
160 for name, sink_maker in pairs(old_sink_types) do
161 log_sink_types[name] = sink_maker;
164 prosody.events.fire_event("logging-reloaded");
168 prosody.events.add_handler("config-reloaded", reload_logging);
170 --- Definition of built-in logging sinks ---
172 -- Null sink, must enter log_sink_types *first*
173 function log_sink_types.nowhere()
174 return function () return false; end;
177 -- Column width for "source" (used by stdout and console)
178 local sourcewidth = 20;
180 function log_sink_types.stdout(config)
181 local timestamps = config.timestamps;
183 if timestamps == true then
184 timestamps = default_timestamp; -- Default format
187 return function (name, level, message, ...)
188 sourcewidth = math_max(#name+2, sourcewidth);
189 local namelen = #name;
191 io_write(os_date(timestamps), " ");
194 io_write(name, rep(" ", sourcewidth-namelen), level, "\t", format(message, ...), "\n");
196 io_write(name, rep(" ", sourcewidth-namelen), level, "\t", message, "\n");
202 local do_pretty_printing = true;
204 local logstyles = {};
205 if do_pretty_printing then
206 logstyles["info"] = getstyle("bold");
207 logstyles["warn"] = getstyle("bold", "yellow");
208 logstyles["error"] = getstyle("bold", "red");
210 function log_sink_types.console(config)
211 -- Really if we don't want pretty colours then just use plain stdout
212 if not do_pretty_printing then
213 return log_sink_types.stdout(config);
216 local timestamps = config.timestamps;
218 if timestamps == true then
219 timestamps = default_timestamp; -- Default format
222 return function (name, level, message, ...)
223 sourcewidth = math_max(#name+2, sourcewidth);
224 local namelen = #name;
227 io_write(os_date(timestamps), " ");
229 io_write(name, rep(" ", sourcewidth-namelen));
230 setstyle(logstyles[level]);
234 io_write("\t", format(message, ...), "\n");
236 io_write("\t", message, "\n");
242 local empty_function = function () end;
243 function log_sink_types.file(config)
244 local log = config.filename;
245 local logfile = io_open(log, "a+");
247 return empty_function;
249 local write, flush = logfile.write, logfile.flush;
251 local timestamps = config.timestamps;
253 if timestamps == nil or timestamps == true then
254 timestamps = default_timestamp; -- Default format
257 return function (name, level, message, ...)
259 write(logfile, os_date(timestamps), " ");
262 write(logfile, name, "\t", level, "\t", format(message, ...), "\n");
264 write(logfile, name, "\t" , level, "\t", message, "\n");
270 function register_sink_type(name, sink_maker)
271 local old_sink_maker = log_sink_types[name];
272 log_sink_types[name] = sink_maker;
273 return old_sink_maker;