/************************************************************************
* IRC - Internet Relay Chat, src/ircd_log.c
* Copyright (C) 1999 Thomas Helvey (BleepSoft)
- *
+ * Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
+ *
* See file AUTHORS in IRC package for additional names of
- * the programmers.
+ * 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
* 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.
- *
- * $Id$
*/
+/** @file
+ * @brief IRC logging implementation.
+ * @version $Id$
+ */
+#include "config.h"
+
#include "ircd_log.h"
#include "client.h"
-#include "config.h"
+#include "ircd_alloc.h"
+#include "ircd_reply.h"
#include "ircd_snprintf.h"
#include "ircd_string.h"
#include "ircd.h"
+#include "numeric.h"
#include "s_debug.h"
+#include "send.h"
#include "struct.h"
-#include <assert.h>
+/* #include <assert.h> -- Now using assert in ircd_log.h */
+#include <errno.h>
#include <fcntl.h>
#include <stdarg.h>
#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <sys/uio.h>
#include <time.h>
#include <unistd.h>
-#define LOG_BUFSIZE 2048
+int log_inassert = 0;
-/* These constants are present even if we don't use syslog */
-#ifndef LOG_CRIT
-# define LOG_CRIT 0
-#endif
-#ifndef LOG_ERR
-# define LOG_ERR 0
-#endif
-#ifndef LOG_WARNING
-# define LOG_WARNING 0
-#endif
-#ifndef LOG_NOTICE
-# define LOG_NOTICE 0
-#endif
-#ifndef LOG_INFO
-# define LOG_INFO 0
+#define LOG_BUFSIZE 2048 /**< Maximum length for a log message. */
+
+/** Select default log level cutoff. */
+#ifdef DEBUGMODE
+# define L_DEFAULT L_DEBUG
+#else
+# define L_DEFAULT L_INFO
#endif
-/* Map severity levels to strings and syslog levels */
+#define LOG_DOSYSLOG 0x10 /**< Try to use syslog. */
+#define LOG_DOFILELOG 0x20 /**< Try to log to a file. */
+#define LOG_DOSNOTICE 0x40 /**< Try to notify operators via notice. */
+/** Bitmask of valid delivery mechanisms. */
+#define LOG_DOMASK (LOG_DOSYSLOG | LOG_DOFILELOG | LOG_DOSNOTICE)
+
+/** Map severity levels to strings and syslog levels */
static struct LevelData {
- enum LogLevel level;
- char *string;
- int syslog;
+ enum LogLevel level; /**< Log level being described. */
+ char *string; /**< Textual name of level. */
+ int syslog; /**< Syslog priority for log level. */
+ unsigned int snomask; /**< Server notice mask; 0 means use default in LogDesc. */
} levelData[] = {
-#define L(level, syslog) { L_ ## level, #level, (syslog) }
- L(CRIT, LOG_CRIT),
- L(ERROR, LOG_ERR),
- L(WARNING, LOG_WARNING),
- L(NOTICE, LOG_NOTICE),
- L(TRACE, LOG_INFO),
- L(INFO, LOG_INFO),
- L(DEBUG, LOG_INFO),
+#define L(level, syslog, mask) { L_ ## level, #level, (syslog), (mask) }
+ L(CRIT, LOG_CRIT, SNO_OLDSNO),
+ L(ERROR, LOG_ERR, 0),
+ L(WARNING, LOG_WARNING, 0),
+ L(NOTICE, LOG_NOTICE, 0),
+ L(TRACE, LOG_INFO, 0),
+ L(INFO, LOG_INFO, 0),
+ L(DEBUG, LOG_INFO, SNO_DEBUG),
#undef L
- { L_LAST_LEVEL, 0 }
+ { L_LAST_LEVEL, 0, 0, 0 }
+};
+
+/* Just in case some implementation of syslog has them... */
+#undef LOG_NONE
+#undef LOG_DEFAULT
+#undef LOG_NOTFOUND
+
+#define LOG_NONE -1 /**< don't syslog */
+#define LOG_DEFAULT 0 /**< syslog to logInfo.facility */
+#define LOG_NOTFOUND -2 /**< didn't find a facility corresponding to name */
+
+/** Map names to syslog facilities. */
+static struct {
+ char *name; /**< Textual name of facility. */
+ int facility; /**< Facility value for syslog(). */
+} facilities[] = {
+#define F(fac) { #fac, LOG_ ## fac }
+ F(NONE), F(DEFAULT), F(AUTH),
+#ifdef LOG_AUTHPRIV
+ F(AUTHPRIV),
+#endif
+ F(CRON), F(DAEMON), F(LOCAL0), F(LOCAL1), F(LOCAL2), F(LOCAL3),
+ F(LOCAL4), F(LOCAL5), F(LOCAL6), F(LOCAL7), F(LPR), F(MAIL),
+ F(NEWS), F(USER), F(UUCP),
+#undef F
+ { 0, 0 }
+};
+
+#define SNO_NONE 0x00000000 /**< don't send server notices */
+#define SNO_NOTFOUND 0xffffffff /**< didn't find a SNO_MASK value for name */
+
+/** Map names to snomask values. */
+static struct {
+ char *name; /**< Name of server notice bit. */
+ unsigned int snomask; /**< Bitmask corresponding to name. */
+} masks[] = {
+#define M(mask) { #mask, SNO_ ## mask }
+ M(NONE), M(OLDSNO), M(SERVKILL), M(OPERKILL), M(HACK2),
+ M(HACK3), M(UNAUTH), M(TCPCOMMON), M(TOOMANY), M(HACK4),
+ M(GLINE), M(NETWORK), M(IPMISMATCH), M(THROTTLE), M(OLDREALOP),
+ M(CONNEXIT), M(DEBUG), M(AUTH),
+#undef M
+ { 0, 0 }
};
-/* Descriptions of all logging subsystems */
+#define LOG_MARK_FILE 0x0001 /**< file has been changed */
+#define LOG_MARK_FACILITY 0x0002 /**< facility has been changed */
+#define LOG_MARK_SNOMASK 0x0004 /**< snomask has been changed */
+#define LOG_MARK_LEVEL 0x0008 /**< level has been changed */
+
+/** Descriptions of all logging subsystems. */
static struct LogDesc {
- enum LogSys subsys; /* number for subsystem */
- char *name; /* subsystem name */
- struct LogFile *file; /* file descriptor for subsystem */
- int facility; /* -1 means don't use syslog */
+ enum LogSys subsys; /**< number for subsystem */
+ char *name; /**< subsystem name */
+ struct LogFile *file; /**< file descriptor for subsystem */
+ unsigned int mark; /**< subsystem has been changed */
+ int def_fac; /**< default facility */
+ unsigned int def_sno; /**< default snomask */
+ int facility; /**< -1 means don't use syslog */
+ unsigned int snomask; /**< 0 means no server message */
+ enum LogLevel level; /**< logging level */
} logDesc[] = {
-#define S(system, defprio) { LS_ ## system, #system, 0, (defprio) }
- S(GLINE, -1),
+#define S(sys, p, sn) { LS_##sys, #sys, 0, 0, (p), (sn), (p), (sn), L_DEFAULT }
+ S(SYSTEM, -1, 0),
+ S(CONFIG, 0, SNO_OLDSNO),
+ S(OPERMODE, -1, SNO_HACK4),
+ S(GLINE, -1, SNO_GLINE),
+ S(JUPE, -1, SNO_NETWORK),
+ S(WHO, -1, 0),
+ S(NETWORK, -1, SNO_NETWORK),
+ S(OPERKILL, -1, 0),
+ S(SERVKILL, -1, 0),
+ S(USER, -1, 0),
+ S(OPER, -1, SNO_OLDREALOP),
+ S(RESOLVER, -1, 0),
+ S(SOCKET, -1, 0),
+ S(IAUTH, -1, SNO_NETWORK),
+ S(DEBUG, -1, SNO_DEBUG),
#undef S
- { LS_LAST_SYSTEM, 0, 0, -1 }
+ { LS_LAST_SYSTEM, 0, 0, -1, 0, -1, 0 }
};
+/** Describes a log file. */
struct LogFile {
- struct LogFile *next; /* next log file descriptor */
- int fd; /* file's descriptor-- -1 if not open */
- char *file; /* file name */
+ struct LogFile *next; /**< next log file descriptor */
+ struct LogFile **prev_p; /**< what points to us */
+ int fd; /**< file's descriptor-- -1 if not open */
+ int ref; /**< how many things refer to us? */
+ char *file; /**< file name */
};
-static struct LogFile *logFileList = 0; /* list of log files */
-
-static const char *procname = "ircd"; /* process's name */
-
-static int logLevel = L_INFO;
+/** Modifiable static information. */
+static struct {
+ struct LogFile *filelist; /**< list of log files */
+ struct LogFile *freelist; /**< list of free'd log files */
+ int facility; /**< default facility */
+ const char *procname; /**< process's name */
+ struct LogFile *dbfile; /**< debug file */
+} logInfo = { 0, 0, LOG_USER, "ircd", 0 };
+
+/** Helper routine to open a log file if needed.
+ * If the log file is already open, do nothing.
+ * @param[in,out] lf Log file to open.
+ */
+static void
+log_open(struct LogFile *lf)
+{
+ /* only open the file if we haven't already */
+ if (lf && lf->fd < 0) {
+ lf->fd = open(lf->file, O_WRONLY | O_CREAT | O_APPEND,
+ S_IRUSR | S_IWUSR);
+ }
+}
-#ifdef USE_SYSLOG
-static int sysLogLevel[] = {
- LOG_CRIT,
- LOG_ERR,
- LOG_WARNING,
- LOG_NOTICE,
- LOG_INFO,
- LOG_INFO,
- LOG_INFO
-};
-#endif
+#ifdef DEBUGMODE
-void ircd_log(int priority, const char* fmt, ...)
+/** Reopen debug log file. */
+static void
+log_debug_reopen(void)
{
-#if defined(USE_SYSLOG) || defined(DEBUGMODE)
- char buf[LOG_BUFSIZE];
- va_list args;
- assert(-1 < priority);
- assert(priority < L_LAST_LEVEL);
- assert(0 != fmt);
+ if (!logInfo.dbfile) /* no open debugging file */
+ return;
- if (priority > logLevel)
+ if (!logInfo.dbfile->file) { /* using terminal output */
+ logInfo.dbfile->fd = 2;
return;
+ }
- va_start(args, fmt);
- vsprintf(buf, fmt, args);
- va_end(args);
-#endif
-#ifdef USE_SYSLOG
- syslog(sysLogLevel[priority], "%s", buf);
-#endif
-#ifdef DEBUGMODE
- Debug((DEBUG_INFO, "LOG: %s", buf));
-#endif
-}
+ /* Ok, it's a real file; close it if necessary and use log_open to open it */
+ if (logInfo.dbfile->fd >= 0) {
+ close(logInfo.dbfile->fd);
+ logInfo.dbfile->fd = -1; /* mark that it's closed for log_open */
+ }
-void open_log(const char* process_name)
-{
-#ifdef USE_SYSLOG
- if (EmptyString(process_name))
- process_name = "ircd";
- openlog(process_name, LOG_PID | LOG_NDELAY, LOG_USER);
-#endif
-}
+ log_open(logInfo.dbfile);
-void close_log(void)
-{
-#ifdef USE_SYSLOG
- closelog();
-#endif
-}
+ if (logInfo.dbfile->fd < 0) { /* try again with /dev/null */
+ if ((logInfo.dbfile->fd = open("/dev/null", O_WRONLY)) < 0)
+ exit(-1);
+ }
-void set_log_level(int level)
-{
- if (L_ERROR < level && level < L_LAST_LEVEL)
- logLevel = level;
+ /* massage the file descriptor to be stderr */
+ if (logInfo.dbfile->fd != 2) {
+ int fd;
+ fd = dup2(logInfo.dbfile->fd, 2);
+ close(logInfo.dbfile->fd);
+ logInfo.dbfile->fd = fd;
+ }
}
-int get_log_level(void)
+/** initialize debugging log file.
+ * @param[in] usetty If non-zero, log to terminal instead of file.
+ */
+void
+log_debug_init(int usetty)
{
- return(logLevel);
-}
+ logInfo.dbfile = (struct LogFile*) MyMalloc(sizeof(struct LogFile));
-/*
- * ircd_log_kill - log information about a kill
- */
-void ircd_log_kill(const struct Client* victim, const struct Client* killer,
- const char* inpath, const char* path)
-{
- if (MyUser(victim)) {
- /*
- * get more infos when your local clients are killed -- _dl
- */
- if (IsServer(killer))
- ircd_log(L_TRACE,
- "A local client %s!%s@%s KILLED from %s [%s] Path: %s!%s)",
- victim->name, victim->user->username, victim->user->host,
- killer->name, killer->name, inpath, path);
- else
- ircd_log(L_TRACE,
- "A local client %s!%s@%s KILLED by %s [%s!%s@%s] (%s!%s)",
- victim->name, victim->user->username, victim->user->host,
- killer->name, killer->name, killer->user->username, killer->user->host,
- inpath, path);
- }
+ logInfo.dbfile->next = 0; /* initialize debugging filename */
+ logInfo.dbfile->prev_p = 0;
+ logInfo.dbfile->fd = -1;
+ logInfo.dbfile->ref = 1;
+
+ if (usetty) /* store pathname to use */
+ logInfo.dbfile->file = 0;
else
- ircd_log(L_TRACE, "KILL From %s For %s Path %s!%s",
- killer->name, victim->name, inpath, path);
+ DupString(logInfo.dbfile->file, LOGFILE);
+
+ log_debug_reopen(); /* open the debug log */
+
+ logDesc[LS_DEBUG].file = logInfo.dbfile; /* remember where it went */
}
+#endif /* DEBUGMODE */
+
+/** Set the debug log file name.
+ * @param[in] file File name, or NULL to select the default.
+ * @return Zero if the file was reopened; non-zero if not debugging to file.
+ */
+static int
+log_debug_file(const char *file)
+{
+#ifdef DEBUGMODE
+ if (!file)
+ file = LOGFILE;
+
+ /* If we weren't started with debugging enabled, or if we're using
+ * the terminal, don't do anything at all.
+ */
+ if (!logInfo.dbfile || !logInfo.dbfile->file)
+ return 1;
+
+ MyFree(logInfo.dbfile->file); /* free old pathname */
+ DupString(logInfo.dbfile->file, file); /* store new pathname */
+ log_debug_reopen(); /* reopen the debug log */
+#endif /* DEBUGMODE */
+ return 0;
+}
+
+/** Initialize logging subsystem.
+ * @param[in] process_name Process name to interactions with syslog.
+ */
void
log_init(const char *process_name)
{
/* store the process name; probably belongs in ircd.c, but oh well... */
if (!EmptyString(process_name))
- procname = process_name;
+ logInfo.procname = process_name;
-#ifdef USE_SYSLOG
/* ok, open syslog; default facility: LOG_USER */
- openlog(procname, LOG_PID | LOG_NDELAY, LOG_USER);
-#endif
+ openlog(logInfo.procname, LOG_PID | LOG_NDELAY, logInfo.facility);
}
+/** Reopen log files (so admins can do things like rotate log files). */
void
log_reopen(void)
{
log_close(); /* close everything...we reopen on demand */
-#ifdef USE_SYSLOG
+#ifdef DEBUGMODE
+ log_debug_reopen(); /* reopen debugging log if necessary */
+#endif /* DEBUGMODE */
+
/* reopen syslog, if needed; default facility: LOG_USER */
- openlog(procname, LOG_PID | LOG_NDELAY, LOG_USER);
-#endif
+ openlog(logInfo.procname, LOG_PID | LOG_NDELAY, logInfo.facility);
}
-/* close the log files */
+/** Close all log files. */
void
log_close(void)
{
struct LogFile *ptr;
-#ifdef USE_SYSLOG
closelog(); /* close syslog */
-#endif
- for (ptr = logFileList; ptr; ptr = ptr->next) {
+ for (ptr = logInfo.filelist; ptr; ptr = ptr->next) {
if (ptr->fd >= 0)
- close(ptr->fd);
+ close(ptr->fd); /* close all the files... */
ptr->fd = -1;
}
+
+ if (logInfo.dbfile && logInfo.dbfile->file) {
+ if (logInfo.dbfile->fd >= 0)
+ close(logInfo.dbfile->fd); /* close the debug log file */
+
+ logInfo.dbfile->fd = -1;
+ }
}
-static void
-log_open(struct LogFile *lf)
+/** Write a logging entry.
+ * @param[in] subsys Target subsystem.
+ * @param[in] severity Severity of message.
+ * @param[in] flags Combination of zero or more of LOG_NOSYSLOG, LOG_NOFILELOG, LOG_NOSNOTICE to suppress certain output.
+ * @param[in] fmt Format string for message.
+ */
+void
+log_write(enum LogSys subsys, enum LogLevel severity, unsigned int flags,
+ const char *fmt, ...)
{
- /* only open the file if we haven't already */
- if (lf && lf->fd < 0) {
- alarm(3);
- lf->fd = open(lf->file, O_WRONLY | O_CREAT | O_APPEND,
- S_IREAD | S_IWRITE);
- alarm(0);
- }
+ va_list vl;
+
+ va_start(vl, fmt);
+ log_vwrite(subsys, severity, flags, fmt, vl);
+ va_end(vl);
}
-/* This writes an entry to a log file */
+/** Write a logging entry using a va_list.
+ * @param[in] subsys Target subsystem.
+ * @param[in] severity Severity of message.
+ * @param[in] flags Combination of zero or more of LOG_NOSYSLOG, LOG_NOFILELOG, LOG_NOSNOTICE to suppress certain output.
+ * @param[in] fmt Format string for message.
+ * @param[in] vl Variable-length argument list for message.
+ */
void
-log_write(enum LogSys subsys, enum LogLevel severity, const char *fmt, ...)
+log_vwrite(enum LogSys subsys, enum LogLevel severity, unsigned int flags,
+ const char *fmt, va_list vl)
{
struct VarData vd;
struct LogDesc *desc;
char timebuf[23];
/* check basic assumptions */
- assert(-1 < subsys);
- assert(subsys < LS_LAST_SYSTEM);
- assert(-1 < severity);
- assert(severity < L_LAST_LEVEL);
+ assert(-1 < (int)subsys);
+ assert((int)subsys < LS_LAST_SYSTEM);
+ assert(-1 < (int)severity);
+ assert((int)severity < L_LAST_LEVEL);
+ assert(0 == (flags & ~LOG_NOMASK));
assert(0 != fmt);
/* find the log data and the severity data */
assert(desc->subsys == subsys);
assert(ldata->level == severity);
- /* if we don't have anything to log to, short-circuit */
- if (!desc->file
-#ifdef USE_SYSLOG
- && desc->facility < 0
-#endif
- )
+ /* check severity... */
+ if (severity > desc->level)
+ return;
+
+ /* figure out where all we need to log */
+ if (!(flags & LOG_NOFILELOG) && desc->file) {
+ log_open(desc->file);
+ if (desc->file->fd >= 0) /* don't log to file if we can't open the file */
+ flags |= LOG_DOFILELOG;
+ }
+
+ if (!(flags & LOG_NOSYSLOG) && desc->facility >= 0)
+ flags |= LOG_DOSYSLOG; /* will syslog */
+
+ if (!(flags & LOG_NOSNOTICE) && (desc->snomask != 0 || ldata->snomask != 0))
+ flags |= LOG_DOSNOTICE; /* will send a server notice */
+
+ /* short-circuit if there's nothing to do... */
+ if (!(flags & LOG_DOMASK))
return;
/* Build the basic log string */
vd.vd_format = fmt;
- va_start(vd.vd_args, fmt);
+ va_copy(vd.vd_args, vl);
/* save the length for writev */
- /* Log format: "SYSTEM [SEVERITY] log message */
+ /* Log format: "SYSTEM [SEVERITY]: log message" */
vector[1].iov_len =
- ircd_snprintf(0, buf, sizeof(buf), "%s [%s] %v", desc->name,
- ldata->string, &vd) - 1;
+ ircd_snprintf(0, buf, sizeof(buf), "%s [%s]: %v", desc->name,
+ ldata->string, &vd);
- va_end(vd.vd_args);
-
- /* open the log file if we haven't already */
- log_open(desc->file);
/* if we have something to write to... */
- if (desc->file && desc->file->fd >= 0) {
+ if (flags & LOG_DOFILELOG) {
curtime = TStime();
tstamp = localtime(&curtime); /* build the timestamp */
ircd_snprintf(0, timebuf, sizeof(timebuf), "[%d-%d-%d %d:%02d:%02d] ",
tstamp->tm_year + 1900, tstamp->tm_mon + 1,
tstamp->tm_mday, tstamp->tm_hour, tstamp->tm_min,
- tstamp->tm_sec) - 1;
+ tstamp->tm_sec);
/* set up the remaining parts of the writev vector... */
vector[0].iov_base = timebuf;
vector[1].iov_base = buf;
- vector[2].iov_base = "\n"; /* terminate lines with a \n */
+ vector[2].iov_base = (void*) "\n"; /* terminate lines with a \n */
vector[2].iov_len = 1;
/* write it out to the log file */
writev(desc->file->fd, vector, 3);
}
-#ifdef USE_SYSLOG
/* oh yeah, syslog it too... */
- if (desc->facility >= 0)
+ if (flags & LOG_DOSYSLOG)
syslog(ldata->syslog | desc->facility, "%s", buf);
-#endif
+
+ /* can't forget server notices... */
+ if (flags & LOG_DOSNOTICE)
+ sendto_opmask_butone(0, ldata->snomask ? ldata->snomask : desc->snomask,
+ "%s", buf);
+}
+
+/** Log an appropriate message for kills.
+ * @param[in] victim %Client being killed.
+ * @param[in] killer %User or server doing the killing.
+ * @param[in] inpath Peer that sent us the KILL message.
+ * @param[in] path Kill path that sent to us by \a inpath.
+ * @param[in] msg Kill reason.
+ */
+void
+log_write_kill(const struct Client *victim, const struct Client *killer,
+ const char *inpath, const char *path, const char *msg)
+{
+ if (MyUser(victim))
+ log_write(IsServer(killer) ? LS_SERVKILL : LS_OPERKILL, L_TRACE, 0,
+ "A local client %#C KILLED by %#C Path: %s!%s %s",
+ victim, killer, inpath, path, msg);
+ else
+ log_write(IsServer(killer) ? LS_SERVKILL : LS_OPERKILL, L_TRACE, 0,
+ "KILL from %C For %C Path: %s!%s %s", killer, victim, inpath,
+ path, msg);
+}
+
+/** Find a reference-counted LogFile by file name.
+ * @param[in] file Name of file.
+ * @return A log file descriptor with LogFile::ref at least 1.
+ */
+static struct LogFile *
+log_file_create(const char *file)
+{
+ struct LogFile *tmp;
+
+ assert(0 != file);
+
+ /* if one already exists for that file, return it */
+ for (tmp = logInfo.filelist; tmp; tmp = tmp->next)
+ if (!strcmp(tmp->file, file)) {
+ tmp->ref++;
+ return tmp;
+ }
+
+ if (logInfo.freelist) { /* pop one off the free list */
+ tmp = logInfo.freelist;
+ logInfo.freelist = tmp->next;
+ } else /* allocate a new one */
+ tmp = (struct LogFile*) MyMalloc(sizeof(struct LogFile));
+
+ tmp->fd = -1; /* initialize the structure */
+ tmp->ref = 1;
+ DupString(tmp->file, file);
+
+ tmp->next = logInfo.filelist; /* link it into the list... */
+ tmp->prev_p = &logInfo.filelist;
+ if (logInfo.filelist)
+ logInfo.filelist->prev_p = &tmp->next;
+ logInfo.filelist = tmp;
+
+ return tmp;
+}
+
+/** Dereference a log file.
+ * If the reference count is exactly one on entry to this function,
+ * the file is closed and its structure is freed.
+ * @param[in] lf Log file to dereference.
+ */
+static void
+log_file_destroy(struct LogFile *lf)
+{
+ assert(0 != lf);
+
+ if (--lf->ref == 0) {
+ if (lf->next) /* clip it out of the list */
+ lf->next->prev_p = lf->prev_p;
+ *lf->prev_p = lf->next;
+
+ lf->prev_p = 0; /* we won't use it for the free list */
+ if (lf->fd >= 0)
+ close(lf->fd);
+ lf->fd = -1;
+ MyFree(lf->file); /* free the file name */
+
+ lf->next = logInfo.freelist; /* stack it onto the free list */
+ logInfo.freelist = lf;
+ }
+}
+
+/** Look up a log subsystem by name.
+ * @param[in] subsys Subsystem name.
+ * @return Pointer to the subsystem's LogDesc, or NULL if none exists.
+ */
+static struct LogDesc *
+log_find(const char *subsys)
+{
+ int i;
+
+ assert(0 != subsys);
+
+ /* find the named subsystem */
+ for (i = 0; i < LS_LAST_SYSTEM; i++)
+ if (!ircd_strcmp(subsys, logDesc[i].name))
+ return &logDesc[i];
+
+ return 0; /* not found */
+}
+
+/** Return canonical version of log subsystem name.
+ * @param[in] subsys Subsystem name.
+ * @return A constant string containing the canonical name.
+ */
+char *
+log_canon(const char *subsys)
+{
+ struct LogDesc *desc;
+
+ if (!(desc = log_find(subsys)))
+ return 0;
+
+ return desc->name;
+}
+
+/** Look up a log level by name.
+ * @param[in] level Log level name.
+ * @return LogLevel enumeration, or L_LAST_LEVEL if none exists.
+ */
+static enum LogLevel
+log_lev_find(const char *level)
+{
+ int i;
+
+ assert(0 != level);
+
+ /* find the named level */
+ for (i = 0; levelData[i].string; i++)
+ if (!ircd_strcmp(level, levelData[i].string))
+ return levelData[i].level;
+
+ return L_LAST_LEVEL; /* not found */
+}
+
+/** Look up the canonical name for a log level.
+ * @param[in] lev
+ * @return A constant string containing the level's canonical name.
+ */
+static char *
+log_lev_name(enum LogLevel lev)
+{
+ assert(-1 < (int)lev);
+ assert((int)lev < L_LAST_LEVEL);
+ assert(lev == levelData[lev].level);
+
+ return levelData[lev].string;
+}
+
+/** Look up a syslog facility by name.
+ * @param[in] facility Facility name.
+ * @return Syslog facility value, or LOG_NOTFOUND if none exists.
+ */
+static int
+log_fac_find(const char *facility)
+{
+ int i;
+
+ assert(0 != facility);
+
+ /* find the named facility */
+ for (i = 0; facilities[i].name; i++)
+ if (!ircd_strcmp(facility, facilities[i].name))
+ return facilities[i].facility;
+
+ return LOG_NOTFOUND; /* not found */
+}
+
+/** Look up the name for a syslog facility.
+ * @param[in] fac Facility value.
+ * @return Canonical name for facility, or NULL if none exists.
+ */
+static char *
+log_fac_name(int fac)
+{
+ int i;
+
+ /* find the facility */
+ for (i = 0; facilities[i].name; i++)
+ if (facilities[i].facility == fac)
+ return facilities[i].name;
+
+ return 0; /* not found; should never happen */
+}
+
+/** Look up a server notice mask by name.
+ * @param[in] maskname Name of server notice mask.
+ * @return Bitmask for server notices, or 0 if none exists.
+ */
+static unsigned int
+log_sno_find(const char *maskname)
+{
+ int i;
+
+ assert(0 != maskname);
+
+ /* find the named snomask */
+ for (i = 0; masks[i].name; i++)
+ if (!ircd_strcmp(maskname, masks[i].name))
+ return masks[i].snomask;
+
+ return SNO_NOTFOUND; /* not found */
+}
+
+/** Look up the canonical name for a server notice mask.
+ * @param[in] sno Server notice mask.
+ * @return Canonical name for the mask, or NULL if none exists.
+ */
+static char *
+log_sno_name(unsigned int sno)
+{
+ int i;
+
+ /* find the snomask */
+ for (i = 0; masks[i].name; i++)
+ if (masks[i].snomask == sno)
+ return masks[i].name;
+
+ return 0; /* not found; should never happen */
+}
+
+/** Set a log file for a particular subsystem.
+ * @param[in] subsys Subsystem name.
+ * @param[in] filename Log file to write to.
+ * @return Zero on success; non-zero on error.
+ */
+int
+log_set_file(const char *subsys, const char *filename)
+{
+ struct LogDesc *desc;
+
+ /* find subsystem */
+ if (!(desc = log_find(subsys)))
+ return 2;
+
+ if (filename)
+ desc->mark |= LOG_MARK_FILE; /* mark that file has been changed */
+ else
+ desc->mark &= ~LOG_MARK_FILE; /* file has been reset to defaults */
+
+ /* no change, don't go to the trouble of destroying and recreating */
+ if (desc->file && desc->file->file && filename &&
+ !strcmp(desc->file->file, filename))
+ return 0;
+
+ /* debug log is special, since it has to be opened on fd 2 */
+ if (desc->subsys == LS_DEBUG)
+ return log_debug_file(filename);
+
+ if (desc->file) /* destroy previous entry... */
+ log_file_destroy(desc->file);
+
+ /* set the file to use */
+ desc->file = filename ? log_file_create(filename) : 0;
+
+ return 0;
+}
+
+/** Find the log file name for a subsystem.
+ * @param[in] subsys Subsystem name.
+ * @return Log file for the subsystem, or NULL if not being logged to a file.
+ */
+char *
+log_get_file(const char *subsys)
+{
+ struct LogDesc *desc;
+
+ /* find subsystem */
+ if (!(desc = log_find(subsys)))
+ return 0;
+
+ return desc->file ? desc->file->file : 0;
+}
+
+/** Set the syslog facility for a particular subsystem.
+ * @param[in] subsys Subsystem name.
+ * @param[in] facility Facility name to log to.
+ * @return Zero on success; non-zero on error.
+ */
+int
+log_set_facility(const char *subsys, const char *facility)
+{
+ struct LogDesc *desc;
+ int fac;
+
+ /* find subsystem */
+ if (!(desc = log_find(subsys)))
+ return 2;
+
+ /* set syslog facility */
+ if (EmptyString(facility)) {
+ desc->facility = desc->def_fac;
+ desc->mark &= ~LOG_MARK_FACILITY;
+ } else if ((fac = log_fac_find(facility)) != LOG_NOTFOUND) {
+ desc->facility = fac;
+ if (fac == desc->def_fac)
+ desc->mark &= ~LOG_MARK_FACILITY;
+ else
+ desc->mark |= LOG_MARK_FACILITY;
+ } else
+ return 1;
+
+ return 0;
+}
+
+/** Find the facility name for a subsystem.
+ * @param[in] subsys Subsystem name.
+ * @return Facility name being used, or NULL if not being logged to syslog.
+ */
+char *
+log_get_facility(const char *subsys)
+{
+ struct LogDesc *desc;
+
+ /* find subsystem */
+ if (!(desc = log_find(subsys)))
+ return 0;
+
+ /* find the facility's name */
+ return log_fac_name(desc->facility);
+}
+
+/** Set the server notice mask for a subsystem.
+ * @param[in] subsys Subsystem name.
+ * @param[in] snomask Server notice mask name.
+ * @return Zero on success; non-zero on error.
+ */
+int
+log_set_snomask(const char *subsys, const char *snomask)
+{
+ struct LogDesc *desc;
+ unsigned int sno = SNO_DEFAULT;
+
+ /* find subsystem */
+ if (!(desc = log_find(subsys)))
+ return 2;
+
+ /* set snomask value */
+ if (EmptyString(snomask)) {
+ desc->snomask = desc->def_sno;
+ desc->mark &= ~LOG_MARK_SNOMASK;
+ } else if ((sno = log_sno_find(snomask)) != SNO_NOTFOUND) {
+ desc->snomask = sno;
+ if (sno == desc->def_sno)
+ desc->mark &= ~LOG_MARK_SNOMASK;
+ else
+ desc->mark |= LOG_MARK_SNOMASK;
+ } else
+ return 1;
+
+ return 0;
+}
+
+/** Find the server notice mask name for a subsystem.
+ * @param[in] subsys Subsystem name.
+ * @return Name of server notice mask being used, or NULL if none.
+ */
+char *
+log_get_snomask(const char *subsys)
+{
+ struct LogDesc *desc;
+
+ /* find subsystem */
+ if (!(desc = log_find(subsys)))
+ return 0;
+
+ /* find the snomask value's name */
+ return log_sno_name(desc->snomask);
+}
+
+/** Set the verbosity level for a subsystem.
+ * @param[in] subsys Subsystem name.
+ * @param[in] level Minimum log level.
+ * @return Zero on success; non-zero on error.
+ */
+int
+log_set_level(const char *subsys, const char *level)
+{
+ struct LogDesc *desc;
+ enum LogLevel lev;
+
+ /* find subsystem */
+ if (!(desc = log_find(subsys)))
+ return 2;
+
+ /* set logging level */
+ if (EmptyString(level)) {
+ desc->level = L_DEFAULT;
+ desc->mark &= ~LOG_MARK_LEVEL;
+ } else if ((lev = log_lev_find(level)) != L_LAST_LEVEL) {
+ desc->level = lev;
+ if (lev == L_DEFAULT)
+ desc->mark &= ~LOG_MARK_LEVEL;
+ else
+ desc->mark |= LOG_MARK_LEVEL;
+ } else
+ return 1;
+
+ return 0;
+}
+
+/** Find the verbosity level for a subsystem.
+ * @param[in] subsys Subsystem name.
+ * @return Minimum verbosity level being used, or NULL on error.
+ */
+char *
+log_get_level(const char *subsys)
+{
+ struct LogDesc *desc;
+
+ /* find subsystem */
+ if (!(desc = log_find(subsys)))
+ return 0;
+
+ /* find the level's name */
+ return log_lev_name(desc->level);
+}
+
+/** Set the default syslog facility.
+ * @param[in] facility Syslog facility name.
+ * @return Zero on success, non-zero on error.
+ */
+int
+log_set_default(const char *facility)
+{
+ int fac, oldfac;
+
+ oldfac = logInfo.facility;
+
+ if (EmptyString(facility))
+ logInfo.facility = LOG_USER;
+ else if ((fac = log_fac_find(facility)) != LOG_NOTFOUND &&
+ fac != LOG_NONE && fac != LOG_DEFAULT)
+ logInfo.facility = fac;
+ else
+ return 1;
+
+ if (logInfo.facility != oldfac) {
+ closelog(); /* reopen syslog with new facility setting */
+ openlog(logInfo.procname, LOG_PID | LOG_NDELAY, logInfo.facility);
+ }
+
+ return 0;
+}
+
+/** Find the default syslog facility name.
+ * @return Canonical name of default syslog facility, or NULL if none.
+ */
+char *
+log_get_default(void)
+{
+ /* find the facility's name */
+ return log_fac_name(logInfo.facility);
+}
+
+/** Clear all marks. */
+void
+log_feature_unmark(void)
+{
+ int i;
+
+ for (i = 0; i < LS_LAST_SYSTEM; i++)
+ logDesc[i].mark = 0;
+}
+
+/** Reset unmodified fields in all log subsystems to their defaults.
+ * @param[in] flag If non-zero, clear default syslog facility.
+ */
+int
+log_feature_mark(int flag)
+{
+ int i;
+
+ if (flag)
+ log_set_default(0);
+
+ for (i = 0; i < LS_LAST_SYSTEM; i++) {
+ if (!(logDesc[i].mark & LOG_MARK_FILE)) {
+ if (logDesc[i].subsys != LS_DEBUG) { /* debug is special */
+ if (logDesc[i].file) /* destroy previous entry... */
+ log_file_destroy(logDesc[i].file);
+ logDesc[i].file = 0;
+ }
+ }
+
+ if (!(logDesc[i].mark & LOG_MARK_FACILITY)) /* set default facility */
+ logDesc[i].facility = logDesc[i].def_fac;
+
+ if (!(logDesc[i].mark & LOG_MARK_SNOMASK)) /* set default snomask */
+ logDesc[i].snomask = logDesc[i].def_sno;
+
+ if (!(logDesc[i].mark & LOG_MARK_LEVEL)) /* set default level */
+ logDesc[i].level = L_DEFAULT;
+ }
+
+ return 0; /* we don't have a notify handler */
+}
+
+/** Feature list callback to report log settings.
+ * @param[in] to Client requesting list.
+ * @param[in] flag If non-zero, report default syslog facility.
+ */
+void
+log_feature_report(struct Client *to, int flag)
+{
+ int i;
+
+ for (i = 0; i < LS_LAST_SYSTEM; i++)
+ {
+ if (logDesc[i].mark & LOG_MARK_FILE) /* report file */
+ send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F LOG %s FILE %s",
+ logDesc[i].name, (logDesc[i].file && logDesc[i].file->file ?
+ logDesc[i].file->file : "(terminal)"));
+
+ if (logDesc[i].mark & LOG_MARK_FACILITY) /* report facility */
+ send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F LOG %s FACILITY %s",
+ logDesc[i].name, log_fac_name(logDesc[i].facility));
+
+ if (logDesc[i].mark & LOG_MARK_SNOMASK) /* report snomask */
+ send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F LOG %s SNOMASK %s",
+ logDesc[i].name, log_sno_name(logDesc[i].snomask));
+
+ if (logDesc[i].mark & LOG_MARK_LEVEL) /* report log level */
+ send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F LOG %s LEVEL %s",
+ logDesc[i].name, log_lev_name(logDesc[i].level));
+ }
+
+ if (flag) /* report default facility */
+ send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F LOG %s",
+ log_fac_name(logInfo.facility));
}
projects / ircu2.10.12-pk.git / blobdiff