123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822 |
- /*-
- * Copyright 2016 Vsevolod Stakhov
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- #include "lua_common.h"
- #include "libutil/map.h"
- #include "libutil/map_private.h"
-
- /***
- * @module rspamd_logger
- * Rspamd logger module is used to log messages from LUA API to the main rspamd logger.
- * It supports legacy and modern interfaces allowing highly customized an convenient log functions.
- * Here is an example of logger usage:
- * @example
- local rspamd_logger = require "rspamd_logger"
-
- local a = 'string'
- local b = 1.5
- local c = 1
- local d = {
- 'aa',
- 1,
- 'bb'
- }
- local e = {
- key = 'value',
- key2 = 1.0
- }
-
- -- New extended interface
- -- %<number> means numeric arguments and %s means the next argument
- -- for example %1, %2, %s: %s would mean the third argument
-
- rspamd_logger.infox('a=%1, b=%2, c=%3, d=%4, e=%s', a, b, c, d, e)
- -- Output: a=string, b=1.50000, c=1, d={[1] = aa, [2] = 1, [3] = bb} e={[key]=value, [key2]=1.0}
-
- -- Legacy interface (can handle merely strings)
- rspamd_logger.info('Old stupid API')
-
- -- Create string using logger API
- local str = rspamd_logger.slog('a=%1, b=%2, c=%3, d=%4, e=%5', a, b, c, d, e)
-
- print(str)
- -- Output: a=string, b=1.50000, c=1, d={[1] = aa, [2] = 1, [3] = bb} e={[key]=value, [key2]=1.0}
- */
-
- /* Logger methods */
- /***
- * @function logger.err(msg)
- * Log message as an error
- * @param {string} msg string to be logged
- */
- LUA_FUNCTION_DEF (logger, err);
- /***
- * @function logger.warn(msg)
- * Log message as a warning
- * @param {string} msg string to be logged
- */
- LUA_FUNCTION_DEF (logger, warn);
- /***
- * @function logger.info(msg)
- * Log message as an informational message
- * @param {string} msg string to be logged
- */
- LUA_FUNCTION_DEF (logger, info);
- /***
- * @function logger.message(msg)
- * Log message as an notice message
- * @param {string} msg string to be logged
- */
- LUA_FUNCTION_DEF (logger, message);
- /***
- * @function logger.debug(msg)
- * Log message as a debug message
- * @param {string} msg string to be logged
- */
- LUA_FUNCTION_DEF (logger, debug);
- /***
- * @function logger.errx(fmt[, args)
- * Extended interface to make an error log message
- * @param {string} fmt format string, arguments are encoded as %<number>
- * @param {any} args list of arguments to be replaced in %<number> positions
- */
- LUA_FUNCTION_DEF (logger, errx);
- /***
- * @function logger.warn(fmt[, args)
- * Extended interface to make a warning log message
- * @param {string} fmt format string, arguments are encoded as %<number>
- * @param {any} args list of arguments to be replaced in %<number> positions
- */
- LUA_FUNCTION_DEF (logger, warnx);
- /***
- * @function logger.infox(fmt[, args)
- * Extended interface to make an informational log message
- * @param {string} fmt format string, arguments are encoded as %<number>
- * @param {any} args list of arguments to be replaced in %<number> positions
- */
- LUA_FUNCTION_DEF (logger, infox);
- /***
- * @function logger.infox(fmt[, args)
- * Extended interface to make an informational log message
- * @param {string} fmt format string, arguments are encoded as %<number>
- * @param {any} args list of arguments to be replaced in %<number> positions
- */
- LUA_FUNCTION_DEF (logger, messagex);
- /***
- * @function logger.debugx(fmt[, args)
- * Extended interface to make a debug log message
- * @param {string} fmt format string, arguments are encoded as %<number>
- * @param {any} args list of arguments to be replaced in %<number> positions
- */
- LUA_FUNCTION_DEF (logger, debugx);
-
- /***
- * @function logger.debugm(module, id, fmt[, args)
- * Extended interface to make a debug log message
- * @param {string} module debug module
- * @param {task|cfg|pool|string} id id to log
- * @param {string} fmt format string, arguments are encoded as %<number>
- * @param {any} args list of arguments to be replaced in %<number> positions
- */
- LUA_FUNCTION_DEF (logger, debugm);
- /***
- * @function logger.slog(fmt[, args)
- * Create string replacing percent params with corresponding arguments
- * @param {string} fmt format string, arguments are encoded as %<number>
- * @param {any} args list of arguments to be replaced in %<number> positions
- * @return {string} string with percent parameters substituted
- */
- LUA_FUNCTION_DEF (logger, slog);
-
- static const struct luaL_reg loggerlib_f[] = {
- LUA_INTERFACE_DEF (logger, err),
- LUA_INTERFACE_DEF (logger, warn),
- LUA_INTERFACE_DEF (logger, message),
- {"msg", lua_logger_message},
- LUA_INTERFACE_DEF (logger, info),
- LUA_INTERFACE_DEF (logger, debug),
- LUA_INTERFACE_DEF (logger, errx),
- LUA_INTERFACE_DEF (logger, warnx),
- LUA_INTERFACE_DEF (logger, infox),
- LUA_INTERFACE_DEF (logger, messagex),
- {"msgx", lua_logger_messagex},
- LUA_INTERFACE_DEF (logger, debugx),
- LUA_INTERFACE_DEF (logger, debugm),
- LUA_INTERFACE_DEF (logger, slog),
- {"__tostring", rspamd_lua_class_tostring},
- {NULL, NULL}
- };
-
- static void
- lua_common_log_line (GLogLevelFlags level, lua_State *L,
- const gchar *msg, const gchar *uid, const gchar *module)
- {
- lua_Debug d;
- gchar func_buf[128], *p;
-
- if (lua_getstack (L, 1, &d) == 1) {
- (void) lua_getinfo (L, "Sl", &d);
- if ((p = strrchr (d.short_src, '/')) == NULL) {
- p = d.short_src;
- }
- else {
- p++;
- }
-
- if (strlen (p) > 30) {
- rspamd_snprintf (func_buf, sizeof (func_buf), "%27s...:%d", p,
- d.currentline);
- }
- else {
- rspamd_snprintf (func_buf, sizeof (func_buf), "%s:%d", p,
- d.currentline);
- }
-
- if (level == G_LOG_LEVEL_DEBUG) {
- rspamd_conditional_debug (NULL,
- NULL,
- module,
- uid,
- func_buf,
- "%s",
- msg);
- }
- else {
- rspamd_common_log_function (NULL,
- level,
- module,
- uid,
- func_buf,
- "%s",
- msg);
- }
- }
- else {
- if (level == G_LOG_LEVEL_DEBUG) {
- rspamd_conditional_debug (NULL,
- NULL,
- module,
- uid,
- G_STRFUNC,
- "%s",
- msg);
- }
- else {
- rspamd_common_log_function (NULL,
- level,
- module,
- uid,
- G_STRFUNC,
- "%s",
- msg);
- }
- }
- }
-
- /*** Logger interface ***/
- static gint
- lua_logger_err (lua_State *L)
- {
- const gchar *msg;
- msg = luaL_checkstring (L, 1);
- lua_common_log_line (G_LOG_LEVEL_CRITICAL, L, msg, NULL, NULL);
- return 0;
- }
-
- static gint
- lua_logger_warn (lua_State *L)
- {
- const gchar *msg;
- msg = luaL_checkstring (L, 1);
- lua_common_log_line (G_LOG_LEVEL_WARNING, L, msg, NULL, NULL);
- return 0;
- }
-
- static gint
- lua_logger_info (lua_State *L)
- {
- const gchar *msg;
- msg = luaL_checkstring (L, 1);
- lua_common_log_line (G_LOG_LEVEL_INFO, L, msg, NULL, NULL);
- return 0;
- }
-
- static gint
- lua_logger_message (lua_State *L)
- {
- const gchar *msg;
- msg = luaL_checkstring (L, 1);
- lua_common_log_line (G_LOG_LEVEL_MESSAGE, L, msg, NULL, NULL);
- return 0;
- }
-
- static gint
- lua_logger_debug (lua_State *L)
- {
- const gchar *msg;
- msg = luaL_checkstring (L, 1);
- lua_common_log_line (G_LOG_LEVEL_DEBUG, L, msg, NULL, NULL);
- return 0;
- }
-
- static gsize
- lua_logger_out_str (lua_State *L, gint pos, gchar *outbuf, gsize len)
- {
- gsize slen;
- const gchar *str = lua_tolstring (L, pos, &slen);
- gsize r = 0;
-
- if (str) {
- r = rspamd_strlcpy (outbuf, str, MIN (slen, len) + 1);
- }
-
- return r;
- }
-
- static gsize
- lua_logger_out_num (lua_State *L, gint pos, gchar *outbuf, gsize len)
- {
- gdouble num = lua_tonumber (L, pos);
- glong inum;
- gsize r = 0;
-
- if ((gdouble) (glong) num == num) {
- inum = num;
- r = rspamd_snprintf (outbuf, len + 1, "%l", inum);
- }
- else {
- r = rspamd_snprintf (outbuf, len + 1, "%f", num);
- }
-
- return r;
- }
-
- static gsize
- lua_logger_out_boolean (lua_State *L, gint pos, gchar *outbuf, gsize len)
- {
- gboolean val = lua_toboolean (L, pos);
- gsize r = 0;
-
- r = rspamd_strlcpy (outbuf, val ? "true" : "false", len + 1);
-
- return r;
- }
-
- static gsize
- lua_logger_out_userdata (lua_State *L, gint pos, gchar *outbuf, gsize len)
- {
- gint r, top;
- const gchar *str = NULL;
- gboolean converted_to_str = FALSE;
-
- top = lua_gettop (L);
-
- if (!lua_getmetatable (L, pos)) {
- return 0;
- }
-
- lua_pushstring (L, "__index");
- lua_gettable (L, -2);
-
- if (!lua_istable (L, -1)) {
- lua_settop (L, top);
-
- return 0;
- }
-
- lua_pushstring (L, "__tostring");
- lua_gettable (L, -2);
-
- if (lua_isfunction (L, -1)) {
- lua_pushvalue (L, pos);
-
- if (lua_pcall (L, 1, 1, 0) != 0) {
- lua_settop (L, top);
-
- return 0;
- }
-
- str = lua_tostring (L, -1);
-
- if (str) {
- converted_to_str = TRUE;
- }
- }
- else {
- lua_pushstring (L, "class");
- lua_gettable (L, -2);
-
- if (!lua_isstring (L, -1)) {
- lua_settop (L, top);
-
- return 0;
- }
-
- str = lua_tostring (L, -1);
- }
-
- if (converted_to_str) {
- r = rspamd_snprintf (outbuf, len + 1, "%s", str);
- }
- else {
- /* Print raw pointer */
- r = rspamd_snprintf (outbuf, len + 1, "%s(%p)", str, lua_touserdata (L, pos));
- }
-
- lua_settop (L, top);
-
- return r;
- }
-
- #define MOVE_BUF(d, remain, r) \
- (d) += (r); (remain) -= (r); \
- if ((remain) == 0) { lua_pop (L, 1); break; }
-
- static gsize
- lua_logger_out_table (lua_State *L, gint pos, gchar *outbuf, gsize len)
- {
- gchar *d = outbuf;
- gsize remain = len, r;
- gboolean first = TRUE;
- gint i;
-
- if (!lua_istable (L, pos) || remain == 0) {
- return 0;
- }
-
- lua_pushvalue (L, pos);
- r = rspamd_snprintf (d, remain + 1, "{");
- remain -= r;
- d += r;
-
- /* Get numeric keys (ipairs) */
- for (i = 1; ; i++) {
- lua_rawgeti (L, -1, i);
-
- if (lua_isnil (L, -1)) {
- lua_pop (L, 1);
- break;
- }
-
- if (!first) {
- r = rspamd_snprintf (d, remain + 1, ", ");
- MOVE_BUF(d, remain, r);
- }
-
- r = rspamd_snprintf (d, remain + 1, "[%d] = ", i);
- MOVE_BUF(d, remain, r);
- r = lua_logger_out_type (L, lua_gettop (L), d, remain);
- MOVE_BUF(d, remain, r);
-
- first = FALSE;
- lua_pop (L, 1);
- }
-
- /* Get string keys (pairs) */
- for (lua_pushnil (L); lua_next (L, -2); lua_pop (L, 1)) {
- /* 'key' is at index -2 and 'value' is at index -1 */
-
- if (lua_type (L, -2) == LUA_TNUMBER) {
- continue;
- }
-
- if (!first) {
- r = rspamd_snprintf (d, remain + 1, ", ");
- MOVE_BUF(d, remain, r);
- }
-
- r = rspamd_snprintf (d, remain + 1, "[%s] = ",
- lua_tostring (L, -2));
- MOVE_BUF(d, remain, r);
- r = lua_logger_out_type (L, lua_gettop (L), d, remain);
- MOVE_BUF(d, remain, r);
-
- first = FALSE;
- }
-
- lua_pop (L, 1);
-
- r = rspamd_snprintf (d, remain + 1, "}");
- d += r;
-
- return (d - outbuf);
- }
-
- #undef MOVE_BUF
-
- gsize
- lua_logger_out_type (lua_State *L, gint pos, gchar *outbuf, gsize len)
- {
- gint type;
- gsize r = 0;
-
- if (len == 0) {
- return 0;
- }
-
- type = lua_type (L, pos);
-
- switch (type) {
- case LUA_TNUMBER:
- r = lua_logger_out_num (L, pos, outbuf, len);
- break;
- case LUA_TBOOLEAN:
- r = lua_logger_out_boolean (L, pos, outbuf, len);
- break;
- case LUA_TTABLE:
- r = lua_logger_out_table (L, pos, outbuf, len);
- break;
- case LUA_TUSERDATA:
- r = lua_logger_out_userdata (L, pos, outbuf, len);
- break;
- case LUA_TFUNCTION:
- r = rspamd_snprintf (outbuf, len + 1, "function");
- break;
- case LUA_TNIL:
- r = rspamd_snprintf (outbuf, len + 1, "nil");
- break;
- case LUA_TNONE:
- r = rspamd_snprintf (outbuf, len + 1, "no value");
- break;
- default:
- /* Try to push everything as string using tostring magic */
- r = lua_logger_out_str (L, pos, outbuf, len);
- break;
- }
-
- return r;
- }
-
- static const gchar *
- lua_logger_get_id (lua_State *L, gint pos)
- {
- const gchar *uid = NULL, *clsname;
-
- if (lua_getmetatable (L, pos) != 0) {
- uid = "";
- lua_pushstring (L, "__index");
- lua_gettable (L, -2);
-
- lua_pushstring (L, "class");
- lua_gettable (L, -2);
-
- clsname = lua_tostring (L, -1);
-
- if (strcmp (clsname, "rspamd{task}") == 0) {
- struct rspamd_task *task = lua_check_task (L, pos);
-
- if (task) {
- uid = task->task_pool->tag.uid;
- }
- }
- else if (strcmp (clsname, "rspamd{mempool}") == 0) {
- rspamd_mempool_t *pool;
-
- pool = rspamd_lua_check_mempool (L, pos);
-
- if (pool) {
- uid = pool->tag.uid;
- }
- }
- else if (strcmp (clsname, "rspamd{config}") == 0) {
- struct rspamd_config *cfg;
-
- cfg = lua_check_config (L, pos);
-
- if (cfg) {
- uid = cfg->checksum;
- }
- }
- else if (strcmp (clsname, "rspamd{map}") == 0) {
- struct rspamd_lua_map *map;
-
- map = lua_check_map (L, pos);
-
- if (map) {
- if (map->map) {
- uid = map->map->tag;
- }
- else {
- uid = "embedded";
- }
- }
- }
-
-
- /* Metatable, __index, classname */
- lua_pop (L, 3);
- }
-
- return uid;
- }
-
- static gboolean
- lua_logger_log_format (lua_State *L, gint fmt_pos, gboolean is_string,
- gchar *logbuf, gsize remain)
- {
- gchar *d;
- const gchar *s, *c;
- gsize r, cpylen = 0;
- guint arg_num = 0, cur_arg;
- bool num_arg = false;
- enum {
- copy_char = 0,
- got_percent,
- parse_arg_num
- } state = copy_char;
-
- d = logbuf;
- s = lua_tostring (L, fmt_pos);
- c = s;
- cur_arg = fmt_pos;
-
- if (s == NULL) {
- return FALSE;
- }
-
- while (remain > 0 && *s != '\0') {
- switch (state) {
- case copy_char:
- if (*s == '%') {
- state = got_percent;
- s++;
- if (cpylen > 0) {
- memcpy (d, c, cpylen);
- d += cpylen;
- }
- cpylen = 0;
- }
- else {
- s++;
- cpylen ++;
- remain--;
- }
- break;
- case got_percent:
- if (g_ascii_isdigit (*s) || *s == 's') {
- state = parse_arg_num;
- c = s;
- }
- else {
- *d++ = *s++;
- c = s;
- state = copy_char;
- }
- break;
- case parse_arg_num:
- if (g_ascii_isdigit (*s)) {
- s++;
- num_arg = true;
- }
- else {
- if (num_arg) {
- arg_num = strtoul (c, NULL, 10);
- arg_num += fmt_pos - 1;
- /* Update the current argument */
- cur_arg = arg_num;
- }
- else {
- /* We have non numeric argument, e.g. %s */
- arg_num = cur_arg ++;
- s ++;
- }
-
- if (arg_num < 1 || arg_num > (guint) lua_gettop (L) + 1) {
- msg_err ("wrong argument number: %ud", arg_num);
-
- return FALSE;
- }
-
- r = lua_logger_out_type (L, arg_num + 1, d, remain);
- g_assert (r <= remain);
- remain -= r;
- d += r;
- state = copy_char;
- c = s;
- }
- break;
- }
- }
-
- if (state == parse_arg_num) {
- if (num_arg) {
- arg_num = strtoul (c, NULL, 10);
- arg_num += fmt_pos - 1;
- }
- else {
- /* We have non numeric argument, e.g. %s */
- arg_num = cur_arg;
- }
-
- if (arg_num < 1 || arg_num > (guint) lua_gettop (L) + 1) {
- msg_err ("wrong argument number: %ud", arg_num);
-
- return FALSE;
- }
-
- r = lua_logger_out_type (L, arg_num + 1, d, remain);
- g_assert (r <= remain);
- remain -= r;
- d += r;
- }
- else if (state == copy_char) {
- if (cpylen > 0 && remain > 0) {
- memcpy (d, c, cpylen);
- d += cpylen;
- }
- }
-
- *d = '\0';
-
-
- return TRUE;
- }
-
- static gint
- lua_logger_logx (lua_State *L, GLogLevelFlags level, gboolean is_string)
- {
- gchar logbuf[RSPAMD_LOGBUF_SIZE - 128];
- const gchar *uid = NULL;
- gint fmt_pos = 1;
- gboolean ret;
-
- if (lua_type (L, 1) == LUA_TSTRING) {
- fmt_pos = 1;
- }
- else if (lua_type (L, 1) == LUA_TUSERDATA) {
- fmt_pos = 2;
-
- uid = lua_logger_get_id (L, 1);
-
- if (uid == NULL) {
- return luaL_error (L, "bad userdata for logging");
- }
- }
- else {
- /* Bad argument type */
- msg_err ("bad format string type: %s", lua_typename (L, lua_type (L,
- 1)));
- lua_error (L);
-
- return 0;
- }
-
- ret = lua_logger_log_format (L, fmt_pos, is_string,
- logbuf, sizeof (logbuf) - 1);
-
- if (ret) {
- if (is_string) {
- lua_pushstring (L, logbuf);
- return 1;
- }
- else {
- lua_common_log_line (level, L, logbuf, uid, "lua");
- }
- }
- else {
- if (is_string) {
- lua_pushnil (L);
-
- return 1;
- }
- }
-
- return 0;
- }
-
- static gint
- lua_logger_errx (lua_State *L)
- {
- return lua_logger_logx (L, G_LOG_LEVEL_CRITICAL, FALSE);
- }
-
- static gint
- lua_logger_warnx (lua_State *L)
- {
- return lua_logger_logx (L, G_LOG_LEVEL_WARNING, FALSE);
- }
-
- static gint
- lua_logger_infox (lua_State *L)
- {
- return lua_logger_logx (L, G_LOG_LEVEL_INFO, FALSE);
- }
-
- static gint
- lua_logger_messagex (lua_State *L)
- {
- return lua_logger_logx (L, G_LOG_LEVEL_MESSAGE, FALSE);
- }
-
- static gint
- lua_logger_debugx (lua_State *L)
- {
- return lua_logger_logx (L, G_LOG_LEVEL_DEBUG, FALSE);
- }
-
- static gint
- lua_logger_debugm (lua_State *L)
- {
- gchar logbuf[RSPAMD_LOGBUF_SIZE - 128];
- const gchar *uid = NULL, *module = NULL;
- gboolean ret;
-
- module = luaL_checkstring (L, 1);
-
- if (lua_type (L, 2) == LUA_TSTRING) {
- uid = luaL_checkstring (L, 2);
- }
- else {
- uid = lua_logger_get_id (L, 2);
- }
-
- if (uid && module && lua_type (L, 3) == LUA_TSTRING) {
- ret = lua_logger_log_format (L, 3, FALSE, logbuf, sizeof (logbuf) - 1);
-
- if (ret) {
- lua_common_log_line (G_LOG_LEVEL_DEBUG, L, logbuf, uid, module);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 0;
- }
-
-
-
- static gint
- lua_logger_slog (lua_State *L)
- {
- return lua_logger_logx (L, 0, TRUE);
- }
-
- /*** Init functions ***/
-
- static gint
- lua_load_logger (lua_State *L)
- {
- lua_newtable (L);
- luaL_register (L, NULL, loggerlib_f);
-
- return 1;
- }
-
- void
- luaopen_logger (lua_State *L)
- {
- rspamd_lua_add_preload (L, "rspamd_logger", lua_load_logger);
- }
|