mirror of
https://github.com/unrealircd/unrealircd.git
synced 2026-07-08 22:03:13 +02:00
c22207c4ca
Also rename them to describe better what they do. ConfigFile: cf_filename -> filename cf_next -> next cf_entries -> items ConfigEntry: ce_fileptr -> file ce_varlinenum -> line_number ce_fileposstart -> file_position_start ce_fileposend -> file_position_end ce_sectlinenum -> section_linenumber ce_varname -> name ce_vardata -> value ce_cond -> conditional_config ce_entries -> items ce_next -> next ce_prevlevel -> parent Also add doxygen docs for both structs.
1284 lines
33 KiB
C
1284 lines
33 KiB
C
/************************************************************************
|
|
* IRC - Internet Relay Chat, src/api-channelmode.c
|
|
* (C) 2021 Bram Matthys (Syzop) and the UnrealIRCd Team
|
|
*
|
|
* See file AUTHORS in IRC package for additional names of
|
|
* the programmers.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 1, or (at your option)
|
|
* any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
*/
|
|
|
|
/** @file
|
|
* @brief The logging API
|
|
*/
|
|
|
|
#include "unrealircd.h"
|
|
|
|
#define SNO_ALL INT_MAX
|
|
|
|
/* Forward declarations */
|
|
static int valid_event_id(const char *s);
|
|
static int valid_subsystem(const char *s);
|
|
LogLevel log_level_stringtoval(const char *str);
|
|
void do_unreal_log_internal(LogLevel loglevel, char *subsystem, char *event_id, Client *client, int expand_msg, char *msg, va_list vl);
|
|
|
|
json_t *json_string_possibly_null(char *s)
|
|
{
|
|
if (s)
|
|
return json_string(s);
|
|
return json_null();
|
|
}
|
|
|
|
LogType log_type_stringtoval(char *str)
|
|
{
|
|
if (!strcmp(str, "json"))
|
|
return LOG_TYPE_JSON;
|
|
if (!strcmp(str, "text"))
|
|
return LOG_TYPE_TEXT;
|
|
return LOG_TYPE_INVALID;
|
|
}
|
|
|
|
char *log_type_valtostring(LogType v)
|
|
{
|
|
switch(v)
|
|
{
|
|
case LOG_TYPE_TEXT:
|
|
return "text";
|
|
case LOG_TYPE_JSON:
|
|
return "json";
|
|
default:
|
|
return NULL;
|
|
}
|
|
}
|
|
|
|
/***** CONFIGURATION ******/
|
|
|
|
int config_test_log(ConfigFile *conf, ConfigEntry *ce)
|
|
{
|
|
int fd, errors = 0;
|
|
ConfigEntry *cep, *cepp;
|
|
char has_flags = 0, has_maxsize = 0;
|
|
char *fname;
|
|
|
|
if (!ce->value)
|
|
{
|
|
config_error("%s:%i: log block without filename",
|
|
ce->file->filename, ce->line_number);
|
|
return 1;
|
|
}
|
|
if (!ce->items)
|
|
{
|
|
config_error("%s:%i: empty log block",
|
|
ce->file->filename, ce->line_number);
|
|
return 1;
|
|
}
|
|
|
|
/* Convert to absolute path (if needed) unless it's "syslog" */
|
|
if (strcmp(ce->value, "syslog"))
|
|
convert_to_absolute_path(&ce->value, LOGDIR);
|
|
|
|
for (cep = ce->items; cep; cep = cep->next)
|
|
{
|
|
if (!strcmp(cep->name, "flags"))
|
|
{
|
|
if (has_flags)
|
|
{
|
|
config_warn_duplicate(cep->file->filename,
|
|
cep->line_number, "log::flags");
|
|
continue;
|
|
}
|
|
has_flags = 1;
|
|
if (!cep->items)
|
|
{
|
|
config_error_empty(cep->file->filename,
|
|
cep->line_number, "log", cep->name);
|
|
errors++;
|
|
continue;
|
|
}
|
|
for (cepp = cep->items; cepp; cepp = cepp->next)
|
|
{
|
|
// FIXME: old flags shit
|
|
}
|
|
}
|
|
else if (!strcmp(cep->name, "maxsize"))
|
|
{
|
|
if (has_maxsize)
|
|
{
|
|
config_warn_duplicate(cep->file->filename,
|
|
cep->line_number, "log::maxsize");
|
|
continue;
|
|
}
|
|
has_maxsize = 1;
|
|
if (!cep->value)
|
|
{
|
|
config_error_empty(cep->file->filename,
|
|
cep->line_number, "log", cep->name);
|
|
errors++;
|
|
}
|
|
}
|
|
else if (!strcmp(cep->name, "type"))
|
|
{
|
|
if (!cep->value)
|
|
{
|
|
config_error_empty(cep->file->filename,
|
|
cep->line_number, "log", cep->name);
|
|
errors++;
|
|
continue;
|
|
}
|
|
if (!log_type_stringtoval(cep->value))
|
|
{
|
|
config_error("%s:%i: unknown log type '%s'",
|
|
cep->file->filename, cep->line_number,
|
|
cep->value);
|
|
errors++;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
config_error_unknown(cep->file->filename, cep->line_number,
|
|
"log", cep->name);
|
|
errors++;
|
|
continue;
|
|
}
|
|
}
|
|
|
|
if (!has_flags)
|
|
{
|
|
config_error_missing(ce->file->filename, ce->line_number,
|
|
"log::flags");
|
|
errors++;
|
|
}
|
|
|
|
fname = unreal_strftime(ce->value);
|
|
if ((fd = fd_fileopen(fname, O_WRONLY|O_CREAT)) == -1)
|
|
{
|
|
config_error("%s:%i: Couldn't open logfile (%s) for writing: %s",
|
|
ce->file->filename, ce->line_number,
|
|
fname, strerror(errno));
|
|
errors++;
|
|
} else
|
|
{
|
|
fd_close(fd);
|
|
}
|
|
|
|
return errors;
|
|
}
|
|
|
|
int config_run_log(ConfigFile *conf, ConfigEntry *ce)
|
|
{
|
|
ConfigEntry *cep, *cepp;
|
|
ConfigItem_log *ca;
|
|
|
|
ca = safe_alloc(sizeof(ConfigItem_log));
|
|
ca->logfd = -1;
|
|
ca->type = LOG_TYPE_TEXT; /* default */
|
|
if (strchr(ce->value, '%'))
|
|
safe_strdup(ca->filefmt, ce->value);
|
|
else
|
|
safe_strdup(ca->file, ce->value);
|
|
|
|
for (cep = ce->items; cep; cep = cep->next)
|
|
{
|
|
if (!strcmp(cep->name, "maxsize"))
|
|
{
|
|
ca->maxsize = config_checkval(cep->value,CFG_SIZE);
|
|
}
|
|
else if (!strcmp(cep->name, "type"))
|
|
{
|
|
ca->type = log_type_stringtoval(cep->value);
|
|
}
|
|
else if (!strcmp(cep->name, "flags"))
|
|
{
|
|
for (cepp = cep->items; cepp; cepp = cepp->next)
|
|
{
|
|
// FIXME: old flags shit
|
|
}
|
|
}
|
|
}
|
|
AddListItem(ca, conf_log);
|
|
return 1;
|
|
}
|
|
|
|
int config_test_set_logging(ConfigFile *conf, ConfigEntry *ce)
|
|
{
|
|
int errors = 0;
|
|
|
|
for (ce = ce->items; ce; ce = ce->next)
|
|
{
|
|
if (!strcmp(ce->name, "snomask") ||
|
|
!strcmp(ce->name, "all-opers") ||
|
|
!strcmp(ce->name, "global") ||
|
|
!strcmp(ce->name, "channel"))
|
|
{
|
|
/* TODO: Validate the subsystem lightly */
|
|
} else
|
|
{
|
|
config_error_unknownopt(ce->file->filename, ce->line_number, "set::logging", ce->name);
|
|
errors++;
|
|
continue;
|
|
}
|
|
|
|
if (!strcmp(ce->name, "snomask"))
|
|
{
|
|
/* We need to validate the parameter here as well */
|
|
if (!ce->value)
|
|
{
|
|
config_error_blank(ce->file->filename, ce->line_number, "set::logging::snomask");
|
|
errors++;
|
|
} else
|
|
if ((strlen(ce->value) != 1) || !(islower(ce->value[0]) || isupper(ce->value[0])))
|
|
{
|
|
config_error("%s:%d: snomask must be a single letter",
|
|
ce->file->filename, ce->line_number);
|
|
errors++;
|
|
}
|
|
}
|
|
if (!strcmp(ce->name, "channel"))
|
|
{
|
|
/* We need to validate the parameter here as well */
|
|
if (!ce->value)
|
|
{
|
|
config_error_blank(ce->file->filename, ce->line_number, "set::logging::channel");
|
|
errors++;
|
|
} else
|
|
if (!valid_channelname(ce->value))
|
|
{
|
|
config_error("%s:%d: Invalid channel name '%s'",
|
|
ce->file->filename, ce->line_number, ce->value);
|
|
errors++;
|
|
}
|
|
}
|
|
}
|
|
|
|
return errors;
|
|
}
|
|
|
|
LogSource *add_log_source(const char *str)
|
|
{
|
|
LogSource *ls;
|
|
char buf[256];
|
|
char *p;
|
|
LogLevel loglevel = ULOG_INVALID;
|
|
char *subsystem = NULL;
|
|
char *event_id = NULL;
|
|
strlcpy(buf, str, sizeof(buf));
|
|
p = strchr(buf, '.');
|
|
if (p)
|
|
*p++ = '\0';
|
|
loglevel = log_level_stringtoval(buf);
|
|
if (loglevel == ULOG_INVALID)
|
|
{
|
|
if (isupper(*buf))
|
|
event_id = buf;
|
|
else
|
|
subsystem = buf;
|
|
}
|
|
if (p)
|
|
{
|
|
if (isupper(*p))
|
|
{
|
|
event_id = p;
|
|
} else
|
|
if (loglevel == ULOG_INVALID)
|
|
{
|
|
loglevel = log_level_stringtoval(p);
|
|
if ((loglevel == ULOG_INVALID) && !subsystem)
|
|
subsystem = p;
|
|
} else if (!subsystem)
|
|
{
|
|
subsystem = p;
|
|
}
|
|
}
|
|
ls = safe_alloc(sizeof(LogSource));
|
|
ls->loglevel = loglevel;
|
|
if (!BadPtr(subsystem))
|
|
strlcpy(ls->subsystem, subsystem, sizeof(ls->subsystem));
|
|
if (!BadPtr(event_id))
|
|
strlcpy(ls->event_id, event_id, sizeof(ls->event_id));
|
|
|
|
return ls;
|
|
}
|
|
|
|
int config_run_set_logging(ConfigFile *conf, ConfigEntry *ce)
|
|
{
|
|
ConfigEntry *cep;
|
|
|
|
for (ce = ce->items; ce; ce = ce->next)
|
|
{
|
|
LogSource *sources = NULL;
|
|
LogSource *s;
|
|
|
|
for (cep = ce->items; cep; cep = cep->next)
|
|
{
|
|
s = add_log_source(cep->name);
|
|
AddListItem(s, sources);
|
|
}
|
|
if (!strcmp(ce->name, "snomask"))
|
|
{
|
|
LogDestination *d = safe_alloc(sizeof(LogDestination));
|
|
strlcpy(d->destination, ce->value, sizeof(d->destination)); /* destination is the snomask */
|
|
d->sources = sources;
|
|
AddListItem(d, tempiConf.logging_snomasks);
|
|
} else
|
|
if (!strcmp(ce->name, "channel"))
|
|
{
|
|
LogDestination *d = safe_alloc(sizeof(LogDestination));
|
|
strlcpy(d->destination, ce->value, sizeof(d->destination)); /* destination is the channel */
|
|
d->sources = sources;
|
|
AddListItem(d, tempiConf.logging_channels);
|
|
} else
|
|
if (!strcmp(ce->name, "all-opers"))
|
|
{
|
|
LogDestination *d = safe_alloc(sizeof(LogDestination));
|
|
/* destination stays empty */
|
|
d->sources = sources;
|
|
AddListItem(d, tempiConf.logging_all_ircops);
|
|
} else
|
|
if (!strcmp(ce->name, "global"))
|
|
{
|
|
LogDestination *d = safe_alloc(sizeof(LogDestination));
|
|
/* destination stays empty */
|
|
d->sources = sources;
|
|
AddListItem(d, tempiConf.logging_global);
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
|
|
|
|
/***** RUNTIME *****/
|
|
|
|
// TODO: validate that all 'key' values are lowercase+underscore+digits in all functions below.
|
|
|
|
void json_expand_client_security_groups(json_t *parent, Client *client)
|
|
{
|
|
SecurityGroup *s;
|
|
json_t *child = json_array();
|
|
json_object_set_new(parent, "security-groups", child);
|
|
|
|
/* We put known-users or unknown-users at the beginning.
|
|
* The latter is special and doesn't actually exist
|
|
* in the linked list, hence the special code here,
|
|
* and again later in the for loop to skip it.
|
|
*/
|
|
if (user_allowed_by_security_group_name(client, "known-users"))
|
|
json_array_append_new(child, json_string("known-users"));
|
|
else
|
|
json_array_append_new(child, json_string("unknown-users"));
|
|
|
|
for (s = securitygroups; s; s = s->next)
|
|
if (strcmp(s->name, "known-users") && user_allowed_by_security_group(client, s))
|
|
json_array_append_new(child, json_string(s->name));
|
|
}
|
|
|
|
void json_expand_client(json_t *j, char *key, Client *client, int detail)
|
|
{
|
|
char buf[BUFSIZE+1];
|
|
json_t *child = json_object();
|
|
json_object_set_new(j, key, child);
|
|
|
|
json_object_set_new(child, "name", json_string(client->name));
|
|
|
|
if (client->user)
|
|
json_object_set_new(child, "username", json_string(client->user->username));
|
|
|
|
if (client->user && *client->user->realhost)
|
|
json_object_set_new(child, "hostname", json_string(client->user->realhost));
|
|
else if (client->local && *client->local->sockhost)
|
|
json_object_set_new(child, "hostname", json_string(client->local->sockhost));
|
|
else
|
|
json_object_set_new(child, "hostname", json_string(GetIP(client)));
|
|
|
|
json_object_set_new(child, "ip", json_string_possibly_null(client->ip));
|
|
|
|
if (client->user)
|
|
{
|
|
snprintf(buf, sizeof(buf), "%s!%s@%s", client->name, client->user->username, client->user->realhost);
|
|
json_object_set_new(child, "nuh", json_string(buf));
|
|
} else if (client->ip) {
|
|
snprintf(buf, sizeof(buf), "%s@%s", client->name, client->ip);
|
|
json_object_set_new(child, "nuh", json_string(buf));
|
|
} else {
|
|
json_object_set_new(child, "nuh", json_string(client->name));
|
|
}
|
|
|
|
if (*client->info)
|
|
json_object_set_new(child, "info", json_string(client->info));
|
|
|
|
if (client->srvptr && client->srvptr->name)
|
|
json_object_set_new(child, "servername", json_string(client->srvptr->name));
|
|
|
|
if (IsLoggedIn(client))
|
|
json_object_set_new(child, "account", json_string(client->user->svid));
|
|
|
|
if (IsUser(client))
|
|
{
|
|
json_object_set_new(child, "reputation", json_integer(GetReputation(client)));
|
|
json_expand_client_security_groups(child, client);
|
|
}
|
|
}
|
|
|
|
void json_expand_channel(json_t *j, char *key, Channel *channel, int detail)
|
|
{
|
|
json_t *child = json_object();
|
|
json_object_set_new(j, key, child);
|
|
json_object_set_new(child, "name", json_string(channel->name));
|
|
}
|
|
|
|
char *timestamp_iso8601_now(void)
|
|
{
|
|
struct timeval t;
|
|
struct tm *tm;
|
|
time_t sec;
|
|
static char buf[64];
|
|
|
|
gettimeofday(&t, NULL);
|
|
sec = t.tv_sec;
|
|
tm = gmtime(&sec);
|
|
|
|
snprintf(buf, sizeof(buf), "%04d-%02d-%02dT%02d:%02d:%02d.%03dZ",
|
|
tm->tm_year + 1900,
|
|
tm->tm_mon + 1,
|
|
tm->tm_mday,
|
|
tm->tm_hour,
|
|
tm->tm_min,
|
|
tm->tm_sec,
|
|
(int)(t.tv_usec / 1000));
|
|
|
|
return buf;
|
|
}
|
|
|
|
char *timestamp_iso8601(time_t v)
|
|
{
|
|
struct tm *tm;
|
|
static char buf[64];
|
|
|
|
if (v == 0)
|
|
return NULL;
|
|
|
|
tm = gmtime(&v);
|
|
|
|
if (tm == NULL)
|
|
return NULL;
|
|
|
|
snprintf(buf, sizeof(buf), "%04d-%02d-%02dT%02d:%02d:%02d.%03dZ",
|
|
tm->tm_year + 1900,
|
|
tm->tm_mon + 1,
|
|
tm->tm_mday,
|
|
tm->tm_hour,
|
|
tm->tm_min,
|
|
tm->tm_sec,
|
|
0);
|
|
|
|
return buf;
|
|
}
|
|
|
|
LogData *log_data_string(const char *key, const char *str)
|
|
{
|
|
LogData *d = safe_alloc(sizeof(LogData));
|
|
d->type = LOG_FIELD_STRING;
|
|
safe_strdup(d->key, key);
|
|
safe_strdup(d->value.string, str);
|
|
return d;
|
|
}
|
|
|
|
LogData *log_data_char(const char *key, const char c)
|
|
{
|
|
LogData *d = safe_alloc(sizeof(LogData));
|
|
d->type = LOG_FIELD_STRING;
|
|
safe_strdup(d->key, key);
|
|
d->value.string = safe_alloc(2);
|
|
d->value.string[0] = c;
|
|
d->value.string[1] = '\0';
|
|
return d;
|
|
}
|
|
|
|
LogData *log_data_integer(const char *key, int64_t integer)
|
|
{
|
|
LogData *d = safe_alloc(sizeof(LogData));
|
|
d->type = LOG_FIELD_INTEGER;
|
|
safe_strdup(d->key, key);
|
|
d->value.integer = integer;
|
|
return d;
|
|
}
|
|
|
|
LogData *log_data_timestamp(const char *key, time_t ts)
|
|
{
|
|
LogData *d = safe_alloc(sizeof(LogData));
|
|
d->type = LOG_FIELD_STRING;
|
|
safe_strdup(d->key, key);
|
|
safe_strdup(d->value.string, timestamp_iso8601(ts));
|
|
return d;
|
|
}
|
|
|
|
LogData *log_data_client(const char *key, Client *client)
|
|
{
|
|
LogData *d = safe_alloc(sizeof(LogData));
|
|
d->type = LOG_FIELD_CLIENT;
|
|
safe_strdup(d->key, key);
|
|
d->value.client = client;
|
|
return d;
|
|
}
|
|
|
|
LogData *log_data_source(const char *file, int line, const char *function)
|
|
{
|
|
LogData *d = safe_alloc(sizeof(LogData));
|
|
json_t *j;
|
|
|
|
d->type = LOG_FIELD_OBJECT;
|
|
safe_strdup(d->key, "source");
|
|
d->value.object = j = json_object();
|
|
json_object_set_new(j, "file", json_string(file));
|
|
json_object_set_new(j, "line", json_integer(line));
|
|
json_object_set_new(j, "function", json_string(function));
|
|
return d;
|
|
}
|
|
|
|
LogData *log_data_socket_error(int fd)
|
|
{
|
|
/* First, grab the error number very early here: */
|
|
#ifndef _WIN32
|
|
int sockerr = errno;
|
|
#else
|
|
int sockerr = WSAGetLastError();
|
|
#endif
|
|
int v;
|
|
int len = sizeof(v);
|
|
LogData *d;
|
|
json_t *j;
|
|
|
|
#ifdef SO_ERROR
|
|
/* Try to get the "real" error from the underlying socket.
|
|
* If we succeed then we will override "sockerr" with it.
|
|
*/
|
|
if ((fd >= 0) && !getsockopt(fd, SOL_SOCKET, SO_ERROR, (void *)&v, &len) && v)
|
|
sockerr = v;
|
|
#endif
|
|
|
|
d = safe_alloc(sizeof(LogData));
|
|
d->type = LOG_FIELD_OBJECT;
|
|
safe_strdup(d->key, "socket_error");
|
|
d->value.object = j = json_object();
|
|
json_object_set_new(j, "error_code", json_integer(sockerr));
|
|
json_object_set_new(j, "error_string", json_string(STRERROR(sockerr)));
|
|
return d;
|
|
}
|
|
|
|
LogData *log_data_link_block(ConfigItem_link *link)
|
|
{
|
|
LogData *d = safe_alloc(sizeof(LogData));
|
|
json_t *j;
|
|
char *bind_ip;
|
|
|
|
d->type = LOG_FIELD_OBJECT;
|
|
safe_strdup(d->key, "link_block");
|
|
d->value.object = j = json_object();
|
|
json_object_set_new(j, "name", json_string(link->servername));
|
|
json_object_set_new(j, "hostname", json_string(link->outgoing.hostname));
|
|
json_object_set_new(j, "ip", json_string(link->connect_ip));
|
|
json_object_set_new(j, "port", json_integer(link->outgoing.port));
|
|
|
|
if (!link->outgoing.bind_ip && iConf.link_bindip)
|
|
bind_ip = iConf.link_bindip;
|
|
else
|
|
bind_ip = link->outgoing.bind_ip;
|
|
if (!bind_ip)
|
|
bind_ip = "*";
|
|
json_object_set_new(j, "bind_ip", json_string(bind_ip));
|
|
|
|
return d;
|
|
}
|
|
|
|
json_t *json_timestamp(time_t v)
|
|
{
|
|
char *ts = timestamp_iso8601(v);
|
|
if (ts)
|
|
return json_string(ts);
|
|
return json_null();
|
|
}
|
|
|
|
LogData *log_data_tkl(const char *key, TKL *tkl)
|
|
{
|
|
char buf[BUFSIZE];
|
|
LogData *d = safe_alloc(sizeof(LogData));
|
|
json_t *j;
|
|
|
|
d->type = LOG_FIELD_OBJECT;
|
|
safe_strdup(d->key, key);
|
|
d->value.object = j = json_object();
|
|
|
|
json_object_set_new(j, "type", json_string(tkl_type_config_string(tkl))); // Eg 'kline'
|
|
json_object_set_new(j, "type_string", json_string(tkl_type_string(tkl))); // Eg 'Soft K-Line'
|
|
json_object_set_new(j, "set_by", json_string(tkl->set_by));
|
|
json_object_set_new(j, "set_at", json_timestamp(tkl->set_at));
|
|
json_object_set_new(j, "expire_at", json_timestamp(tkl->expire_at));
|
|
*buf = '\0';
|
|
short_date(tkl->set_at, buf);
|
|
strlcat(buf, " GMT", sizeof(buf));
|
|
json_object_set_new(j, "set_at_string", json_string(buf));
|
|
if (tkl->expire_at <= 0)
|
|
{
|
|
json_object_set_new(j, "expire_at_string", json_string("Never"));
|
|
} else {
|
|
*buf = '\0';
|
|
short_date(tkl->expire_at, buf);
|
|
strlcat(buf, " GMT", sizeof(buf));
|
|
json_object_set_new(j, "expire_at_string", json_string(buf));
|
|
}
|
|
json_object_set_new(j, "set_at_delta", json_integer(TStime() - tkl->set_at));
|
|
if (TKLIsServerBan(tkl))
|
|
{
|
|
json_object_set_new(j, "name", json_string(tkl_uhost(tkl, buf, sizeof(buf), 0)));
|
|
json_object_set_new(j, "reason", json_string(tkl->ptr.serverban->reason));
|
|
} else
|
|
if (TKLIsNameBan(tkl))
|
|
{
|
|
json_object_set_new(j, "name", json_string(tkl->ptr.nameban->name));
|
|
json_object_set_new(j, "reason", json_string(tkl->ptr.nameban->reason));
|
|
} else
|
|
if (TKLIsBanException(tkl))
|
|
{
|
|
json_object_set_new(j, "name", json_string(tkl_uhost(tkl, buf, sizeof(buf), 0)));
|
|
json_object_set_new(j, "reason", json_string(tkl->ptr.banexception->reason));
|
|
json_object_set_new(j, "exception_types", json_string(tkl->ptr.banexception->bantypes));
|
|
} else
|
|
if (TKLIsSpamfilter(tkl))
|
|
{
|
|
json_object_set_new(j, "name", json_string(tkl->ptr.spamfilter->match->str));
|
|
json_object_set_new(j, "match_type", json_string(unreal_match_method_valtostr(tkl->ptr.spamfilter->match->type)));
|
|
json_object_set_new(j, "ban_action", json_string(banact_valtostring(tkl->ptr.spamfilter->action)));
|
|
json_object_set_new(j, "spamfilter_targets", json_string(spamfilter_target_inttostring(tkl->ptr.spamfilter->target)));
|
|
json_object_set_new(j, "reason", json_string(unreal_decodespace(tkl->ptr.spamfilter->tkl_reason)));
|
|
}
|
|
|
|
return d;
|
|
}
|
|
|
|
void log_data_free(LogData *d)
|
|
{
|
|
if (d->type == LOG_FIELD_STRING)
|
|
safe_free(d->value.string);
|
|
safe_free(d->key);
|
|
safe_free(d);
|
|
}
|
|
|
|
char *log_level_valtostring(LogLevel loglevel)
|
|
{
|
|
switch(loglevel)
|
|
{
|
|
case ULOG_DEBUG:
|
|
return "debug";
|
|
case ULOG_INFO:
|
|
return "info";
|
|
case ULOG_WARNING:
|
|
return "warn";
|
|
case ULOG_ERROR:
|
|
return "error";
|
|
case ULOG_FATAL:
|
|
return "fatal";
|
|
default:
|
|
return NULL;
|
|
}
|
|
}
|
|
|
|
LogLevel log_level_stringtoval(const char *str)
|
|
{
|
|
if (!strcmp(str, "info"))
|
|
return ULOG_INFO;
|
|
if (!strcmp(str, "warn"))
|
|
return ULOG_WARNING;
|
|
if (!strcmp(str, "error"))
|
|
return ULOG_ERROR;
|
|
if (!strcmp(str, "fatal"))
|
|
return ULOG_FATAL;
|
|
if (!strcmp(str, "debug"))
|
|
return ULOG_DEBUG;
|
|
return ULOG_INVALID;
|
|
}
|
|
|
|
#define validvarcharacter(x) (isalnum((x)) || ((x) == '_'))
|
|
#define valideventidcharacter(x) (isupper((x)) || isdigit((x)) || ((x) == '_'))
|
|
#define validsubsystemcharacter(x) (islower((x)) || isdigit((x)) || ((x) == '_'))
|
|
|
|
static int valid_event_id(const char *s)
|
|
{
|
|
if (!*s)
|
|
return 0;
|
|
for (; *s; s++)
|
|
if (!valideventidcharacter(*s))
|
|
return 0;
|
|
return 1;
|
|
}
|
|
|
|
static int valid_subsystem(const char *s)
|
|
{
|
|
if (!*s)
|
|
return 0;
|
|
for (; *s; s++)
|
|
if (!validsubsystemcharacter(*s))
|
|
return 0;
|
|
return 1;
|
|
}
|
|
|
|
const char *json_get_value(json_t *t)
|
|
{
|
|
static char buf[32];
|
|
|
|
if (json_is_string(t))
|
|
return json_string_value(t);
|
|
|
|
if (json_is_integer(t))
|
|
{
|
|
snprintf(buf, sizeof(buf), "%lld", (long long)json_integer_value(t));
|
|
return buf;
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
// TODO: if in the function below we keep adding auto expanshion shit,
|
|
// like we currently have $client automatically expanding to $client.name
|
|
// and $socket_error to $socket_error.error_string,
|
|
// if this gets more than we should use some kind of array for it,
|
|
// especially for the hardcoded name shit like $socket_error.
|
|
|
|
/** Build a string and replace $variables where needed.
|
|
* See src/modules/blacklist.c for an example.
|
|
* @param inbuf The input string
|
|
* @param outbuf The output string
|
|
* @param len The maximum size of the output string (including NUL)
|
|
* @param name Array of variables names
|
|
* @param value Array of variable values
|
|
*/
|
|
void buildlogstring(const char *inbuf, char *outbuf, size_t len, json_t *details)
|
|
{
|
|
const char *i, *p;
|
|
char *o;
|
|
int left = len - 1;
|
|
int cnt, found;
|
|
char varname[256], *varp;
|
|
json_t *t;
|
|
|
|
#ifdef DEBUGMODE
|
|
if (len <= 0)
|
|
abort();
|
|
#endif
|
|
|
|
for (i = inbuf, o = outbuf; *i; i++)
|
|
{
|
|
if (*i == '$')
|
|
{
|
|
i++;
|
|
|
|
/* $$ = literal $ */
|
|
if (*i == '$')
|
|
goto literal;
|
|
|
|
if (!validvarcharacter(*i))
|
|
{
|
|
/* What do we do with things like '$/' ? -- treat literal */
|
|
i--;
|
|
goto literal;
|
|
}
|
|
|
|
/* find termination */
|
|
for (p=i; validvarcharacter(*p) || ((*p == '.') && validvarcharacter(p[1])); p++);
|
|
|
|
/* find variable name in list */
|
|
*varname = '\0';
|
|
strlncat(varname, i, sizeof(varname), p - i);
|
|
varp = strchr(varname, '.');
|
|
if (varp)
|
|
*varp++ = '\0';
|
|
t = json_object_get(details, varname);
|
|
if (t)
|
|
{
|
|
const char *output = NULL;
|
|
if (varp)
|
|
{
|
|
/* Fetch explicit object.key */
|
|
t = json_object_get(t, varp);
|
|
if (t)
|
|
output = json_get_value(t);
|
|
} else
|
|
if (!strcmp(varname, "socket_error"))
|
|
{
|
|
/* Fetch socket_error.error_string */
|
|
t = json_object_get(t, "error_string");
|
|
if (t)
|
|
output = json_get_value(t);
|
|
} else
|
|
if (json_is_object(t))
|
|
{
|
|
/* Fetch object.name */
|
|
t = json_object_get(t, "name");
|
|
if (t)
|
|
output = json_get_value(t);
|
|
} else
|
|
{
|
|
output = json_get_value(t);
|
|
}
|
|
if (output)
|
|
{
|
|
strlcpy(o, output, left);
|
|
left -= strlen(output); /* may become <0 */
|
|
if (left <= 0)
|
|
return; /* return - don't write \0 to 'o'. ensured by strlcpy already */
|
|
o += strlen(output); /* value entirely written */
|
|
}
|
|
} else
|
|
{
|
|
/* variable name does not exist -- treat as literal string */
|
|
i--;
|
|
goto literal;
|
|
}
|
|
|
|
/* value written. we're done. */
|
|
i = p - 1;
|
|
continue;
|
|
}
|
|
literal:
|
|
if (!left)
|
|
break;
|
|
*o++ = *i;
|
|
left--;
|
|
if (!left)
|
|
break;
|
|
}
|
|
*o = '\0';
|
|
}
|
|
|
|
/** Do the actual writing to log files */
|
|
void do_unreal_log_disk(LogLevel loglevel, char *subsystem, char *event_id, char *msg, char *json_serialized)
|
|
{
|
|
static int last_log_file_warning = 0;
|
|
ConfigItem_log *l;
|
|
char text_buf[2048], timebuf[128];
|
|
struct stat fstats;
|
|
int n;
|
|
int write_error;
|
|
long snomask;
|
|
|
|
snprintf(timebuf, sizeof(timebuf), "[%s] ", myctime(TStime()));
|
|
snprintf(text_buf, sizeof(text_buf), "%s %s %s: %s\n",
|
|
log_level_valtostring(loglevel), subsystem, event_id, msg);
|
|
|
|
//RunHook3(HOOKTYPE_LOG, flags, timebuf, text_buf); // FIXME: call with more parameters and possibly not even 'text_buf' at all
|
|
|
|
if (!loop.ircd_forked && (loglevel > ULOG_DEBUG))
|
|
{
|
|
#ifdef _WIN32
|
|
win_log("* %s", text_buf);
|
|
#else
|
|
fprintf(stderr, "%s", text_buf);
|
|
#endif
|
|
}
|
|
|
|
/* In case of './unrealircd configtest': don't write to log file, only to stderr */
|
|
if (loop.config_test)
|
|
return;
|
|
|
|
for (l = conf_log; l; l = l->next)
|
|
{
|
|
// FIXME: implement the proper log filters (eg what 'flags' previously was)
|
|
//if (!(l->flags & flags))
|
|
// continue;
|
|
|
|
#ifdef HAVE_SYSLOG
|
|
if (l->file && !strcasecmp(l->file, "syslog"))
|
|
{
|
|
syslog(LOG_INFO, "%s", text_buf);
|
|
continue;
|
|
}
|
|
#endif
|
|
|
|
/* This deals with dynamic log file names, such as ircd.%Y-%m-%d.log */
|
|
if (l->filefmt)
|
|
{
|
|
char *fname = unreal_strftime(l->filefmt);
|
|
if (l->file && (l->logfd != -1) && strcmp(l->file, fname))
|
|
{
|
|
/* We are logging already and need to switch over */
|
|
fd_close(l->logfd);
|
|
l->logfd = -1;
|
|
}
|
|
safe_strdup(l->file, fname);
|
|
}
|
|
|
|
/* log::maxsize code */
|
|
if (l->maxsize && (stat(l->file, &fstats) != -1) && fstats.st_size >= l->maxsize)
|
|
{
|
|
char oldlog[512];
|
|
if (l->logfd == -1)
|
|
{
|
|
/* Try to open, so we can write the 'Max file size reached' message. */
|
|
l->logfd = fd_fileopen(l->file, O_CREAT|O_APPEND|O_WRONLY);
|
|
}
|
|
if (l->logfd != -1)
|
|
{
|
|
if (write(l->logfd, "Max file size reached, starting new log file\n", 45) < 0)
|
|
{
|
|
/* We already handle the unable to write to log file case for normal data.
|
|
* I think we can get away with not handling this one.
|
|
*/
|
|
;
|
|
}
|
|
fd_close(l->logfd);
|
|
}
|
|
l->logfd = -1;
|
|
|
|
/* Rename log file to xxxxxx.old */
|
|
snprintf(oldlog, sizeof(oldlog), "%s.old", l->file);
|
|
unlink(oldlog); /* windows rename cannot overwrite, so unlink here.. ;) */
|
|
rename(l->file, oldlog);
|
|
}
|
|
|
|
/* generic code for opening log if not open yet.. */
|
|
if (l->logfd == -1)
|
|
{
|
|
l->logfd = fd_fileopen(l->file, O_CREAT|O_APPEND|O_WRONLY);
|
|
if (l->logfd == -1)
|
|
{
|
|
if (!loop.ircd_booted)
|
|
{
|
|
config_status("WARNING: Unable to write to '%s': %s", l->file, strerror(errno));
|
|
} else {
|
|
if (last_log_file_warning + 300 < TStime())
|
|
{
|
|
config_status("WARNING: Unable to write to '%s': %s. This warning will not re-appear for at least 5 minutes.", l->file, strerror(errno));
|
|
last_log_file_warning = TStime();
|
|
}
|
|
}
|
|
continue;
|
|
}
|
|
}
|
|
|
|
/* Now actually WRITE to the log... */
|
|
write_error = 0;
|
|
if ((l->type == LOG_TYPE_JSON) && strcmp(subsystem, "traffic"))
|
|
{
|
|
n = write(l->logfd, json_serialized, strlen(json_serialized));
|
|
if (n < strlen(text_buf))
|
|
write_error = 1;
|
|
else
|
|
write(l->logfd, "\n", 1); // FIXME: no.. we should do it this way..... and why do we use direct I/O at all?
|
|
} else
|
|
if (l->type == LOG_TYPE_TEXT)
|
|
{
|
|
// FIXME: don't write in 2 stages, waste of slow system calls
|
|
if (write(l->logfd, timebuf, strlen(timebuf)) < 0)
|
|
{
|
|
/* Let's ignore any write errors for this one. Next write() will catch it... */
|
|
;
|
|
}
|
|
n = write(l->logfd, text_buf, strlen(text_buf));
|
|
if (n < strlen(text_buf))
|
|
write_error = 1;
|
|
}
|
|
|
|
if (write_error)
|
|
{
|
|
if (!loop.ircd_booted)
|
|
{
|
|
config_status("WARNING: Unable to write to '%s': %s", l->file, strerror(errno));
|
|
} else {
|
|
if (last_log_file_warning + 300 < TStime())
|
|
{
|
|
config_status("WARNING: Unable to write to '%s': %s. This warning will not re-appear for at least 5 minutes.", l->file, strerror(errno));
|
|
last_log_file_warning = TStime();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
int log_sources_match(LogSource *ls, LogLevel loglevel, char *subsystem, char *event_id)
|
|
{
|
|
// NOTE: This routine works by exclusion, so a bad struct would
|
|
// cause everything to match!!
|
|
for (; ls; ls = ls->next)
|
|
{
|
|
if (*ls->subsystem && strcmp(ls->subsystem, subsystem))
|
|
continue;
|
|
if (*ls->event_id && strcmp(ls->event_id, event_id))
|
|
continue;
|
|
if ((ls->loglevel != ULOG_INVALID) && (ls->loglevel != loglevel))
|
|
continue;
|
|
return 1; /* MATCH */
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/** Convert loglevel/subsystem/event_id to a snomask.
|
|
* @returns The snomask letters (may be more than one),
|
|
* an asterisk (for all ircops), or NULL (no delivery)
|
|
*/
|
|
char *log_to_snomask(LogLevel loglevel, char *subsystem, char *event_id)
|
|
{
|
|
LogDestination *ld;
|
|
static char snomasks[64];
|
|
|
|
/* At the top right now. TODO: "nomatch" support */
|
|
if (iConf.logging_all_ircops && log_sources_match(iConf.logging_all_ircops->sources, loglevel, subsystem, event_id))
|
|
return "*";
|
|
|
|
*snomasks = '\0';
|
|
for (ld = iConf.logging_snomasks; ld; ld = ld->next)
|
|
{
|
|
if (log_sources_match(ld->sources, loglevel, subsystem, event_id))
|
|
strlcat(snomasks, ld->destination, sizeof(snomasks));
|
|
}
|
|
|
|
return *snomasks ? snomasks : NULL;
|
|
}
|
|
|
|
/** Do the actual writing to log files */
|
|
void do_unreal_log_ircops(LogLevel loglevel, char *subsystem, char *event_id, char *msg, char *json_serialized)
|
|
{
|
|
Client *client;
|
|
char *snomask_destinations;
|
|
char *client_snomasks;
|
|
char *p;
|
|
|
|
/* If not fully booted then we don't have a logging to snomask mapping so can't do much.. */
|
|
if (!loop.ircd_booted)
|
|
return;
|
|
|
|
/* Never send these */
|
|
if (!strcmp(subsystem, "traffic"))
|
|
return;
|
|
|
|
snomask_destinations = log_to_snomask(loglevel, subsystem, event_id);
|
|
|
|
/* Zero destinations? Then return.
|
|
* XXX temporarily log to all ircops until we ship with default conf ;)
|
|
*/
|
|
if (snomask_destinations == NULL)
|
|
{
|
|
sendto_realops("[%s] %s.%s %s", log_level_valtostring(loglevel), subsystem, event_id, msg);
|
|
return;
|
|
}
|
|
|
|
/* All ircops? Simple case. */
|
|
if (!strcmp(snomask_destinations, "*"))
|
|
{
|
|
sendto_realops("[%s] %s.%s %s", log_level_valtostring(loglevel), subsystem, event_id, msg);
|
|
return;
|
|
}
|
|
|
|
/* To specific snomasks... */
|
|
list_for_each_entry(client, &oper_list, special_node)
|
|
{
|
|
client_snomasks = get_snomask_string(client);
|
|
for (p = snomask_destinations; *p; p++)
|
|
{
|
|
if (strchr(client_snomasks, *p))
|
|
{
|
|
sendnotice(client, "[%s] %s.%s %s", log_level_valtostring(loglevel), subsystem, event_id, msg);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
static int unreal_log_recursion_trap = 0;
|
|
|
|
/* Logging function, called by the unreal_log() macro. */
|
|
void do_unreal_log(LogLevel loglevel, char *subsystem, char *event_id,
|
|
Client *client, char *msg, ...)
|
|
{
|
|
if (unreal_log_recursion_trap)
|
|
return;
|
|
unreal_log_recursion_trap = 1;
|
|
va_list vl;
|
|
va_start(vl, msg);
|
|
do_unreal_log_internal(loglevel, subsystem, event_id, client, 1, msg, vl);
|
|
va_end(vl);
|
|
unreal_log_recursion_trap = 0;
|
|
}
|
|
|
|
/* Logging function, called by the unreal_log_raw() macro. */
|
|
void do_unreal_log_raw(LogLevel loglevel, char *subsystem, char *event_id,
|
|
Client *client, char *msg, ...)
|
|
{
|
|
if (unreal_log_recursion_trap)
|
|
return;
|
|
unreal_log_recursion_trap = 1;
|
|
va_list vl;
|
|
va_start(vl, msg);
|
|
do_unreal_log_internal(loglevel, subsystem, event_id, client, 0, msg, vl);
|
|
va_end(vl);
|
|
unreal_log_recursion_trap = 0;
|
|
}
|
|
|
|
void do_unreal_log_internal(LogLevel loglevel, char *subsystem, char *event_id,
|
|
Client *client, int expand_msg, char *msg, va_list vl)
|
|
{
|
|
LogData *d;
|
|
char *json_serialized;
|
|
json_t *j = NULL;
|
|
json_t *j_details = NULL;
|
|
char msgbuf[1024];
|
|
char *loglevel_string = log_level_valtostring(loglevel);
|
|
|
|
/* TODO: Enforcement:
|
|
* - loglevel must be valid
|
|
* - subsystem may only contain lowercase, underscore and numbers
|
|
* - event_id may only contain UPPERCASE, underscore and numbers (but not start with a number)
|
|
* - msg may not contain percent signs (%) as that is an obvious indication something is wrong?
|
|
* or maybe a temporary restriction while upgrading that can be removed later ;)
|
|
*/
|
|
if (loglevel_string == NULL)
|
|
abort();
|
|
if (!valid_subsystem(subsystem))
|
|
abort();
|
|
if (!valid_event_id(event_id))
|
|
abort();
|
|
if (expand_msg && strchr(msg, '%'))
|
|
abort();
|
|
|
|
j = json_object();
|
|
j_details = json_object();
|
|
|
|
json_object_set_new(j, "timestamp", json_string(timestamp_iso8601_now()));
|
|
json_object_set_new(j, "level", json_string(loglevel_string));
|
|
json_object_set_new(j, "subsystem", json_string(subsystem));
|
|
json_object_set_new(j, "event_id", json_string(event_id));
|
|
|
|
/* We put all the rest in j_details because we want to enforce
|
|
* a certain ordering of the JSON output. We will merge these
|
|
* details later on.
|
|
*/
|
|
if (client)
|
|
json_expand_client(j_details, "client", client, 0);
|
|
/* Additional details (if any) */
|
|
while ((d = va_arg(vl, LogData *)))
|
|
{
|
|
switch(d->type)
|
|
{
|
|
case LOG_FIELD_INTEGER:
|
|
json_object_set_new(j_details, d->key, json_integer(d->value.integer));
|
|
break;
|
|
case LOG_FIELD_STRING:
|
|
if (d->value.string)
|
|
json_object_set_new(j_details, d->key, json_string(d->value.string));
|
|
else
|
|
json_object_set_new(j_details, d->key, json_null());
|
|
break;
|
|
case LOG_FIELD_CLIENT:
|
|
json_expand_client(j_details, d->key, d->value.client, 0);
|
|
break;
|
|
case LOG_FIELD_OBJECT:
|
|
json_object_set_new(j_details, d->key, d->value.object);
|
|
break;
|
|
default:
|
|
#ifdef DEBUGMODE
|
|
abort();
|
|
#endif
|
|
break;
|
|
}
|
|
log_data_free(d);
|
|
}
|
|
|
|
if (expand_msg)
|
|
buildlogstring(msg, msgbuf, sizeof(msgbuf), j_details);
|
|
else
|
|
strlcpy(msgbuf, msg, sizeof(msgbuf));
|
|
|
|
json_object_set_new(j, "msg", json_string(msgbuf));
|
|
|
|
/* Now merge the details into root object 'j': */
|
|
json_object_update_missing(j, j_details);
|
|
/* Generate the JSON */
|
|
json_serialized = json_dumps(j, 0);
|
|
|
|
/* Now call the disk loggers */
|
|
do_unreal_log_disk(loglevel, subsystem, event_id, msgbuf, json_serialized);
|
|
|
|
/* And the ircops stuff */
|
|
do_unreal_log_ircops(loglevel, subsystem, event_id, msgbuf, json_serialized);
|
|
|
|
|
|
/* Free everything */
|
|
safe_free(json_serialized);
|
|
json_decref(j_details);
|
|
json_decref(j);
|
|
}
|
|
|
|
void simpletest(void)
|
|
{
|
|
char *str;
|
|
json_t *j = json_object();
|
|
json_t *j_client = json_array();
|
|
|
|
json_object_set_new(j, "id", json_integer(1));
|
|
json_object_set_new(j, "data", j_client);
|
|
json_array_append_new(j_client, json_integer(1));
|
|
json_array_append_new(j_client, json_integer(2));
|
|
json_array_append_new(j_client, json_integer(3));
|
|
|
|
str = json_dumps(j, 0);
|
|
printf("RESULT:\n%s\n", str);
|
|
free(str);
|
|
|
|
json_decref(j);
|
|
}
|
|
|
|
void logtest(void)
|
|
{
|
|
strcpy(me.name, "irc.test.net");
|
|
unreal_log(ULOG_INFO, "test", "TEST", &me, "Hello there!");
|
|
unreal_log(ULOG_INFO, "test", "TEST", &me, "Hello there i like $client!");
|
|
unreal_log(ULOG_INFO, "test", "TEST", &me, "Hello there i like $client with IP $client.ip!");
|
|
unreal_log(ULOG_INFO, "test", "TEST", &me, "More data!", log_data_string("fun", "yes lots of fun"));
|
|
unreal_log(ULOG_INFO, "test", "TEST", &me, "More data, fun: $fun!", log_data_string("fun", "yes lots of fun"), log_data_integer("some_integer", 1337));
|
|
unreal_log(ULOG_INFO, "sacmds", "SAJOIN_COMMAND", &me, "Client $client used SAJOIN to join $target to y!", log_data_client("target", &me));
|
|
}
|
|
|
|
void add_log_snomask(Configuration *i, char *subsystem, long snomask)
|
|
{
|
|
LogSnomask *l = safe_alloc(sizeof(LogSnomask));
|
|
safe_strdup(l->subsystem, subsystem);
|
|
l->snomask = snomask;
|
|
AppendListItem(l, i->log_snomasks);
|
|
}
|
|
|
|
void log_snomask_free(LogSnomask *l)
|
|
{
|
|
safe_free(l->subsystem);
|
|
safe_free(l);
|
|
}
|
|
|
|
void log_snomask_free_settings(Configuration *i)
|
|
{
|
|
LogSnomask *l, *l_next;
|
|
for (l = i->log_snomasks; l; l = l_next)
|
|
{
|
|
l_next = l->next;
|
|
log_snomask_free(l);
|
|
}
|
|
i->log_snomasks = NULL;
|
|
}
|
|
|
|
void log_snomask_setdefaultsettings(Configuration *i)
|
|
{
|
|
add_log_snomask(i, "linking", SNO_ALL);
|
|
add_log_snomask(i, "traffic", 0);
|
|
add_log_snomask(i, "*", SNO_ALL);
|
|
}
|