1 /************************************************************************
2 * IRC - Internet Relay Chat, src/ircd_log.c
3 * Copyright (C) 1999 Thomas Helvey (BleepSoft)
4 * Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
6 * See file AUTHORS in IRC package for additional names of
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 1, or (at your option)
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #include "ircd_alloc.h"
29 #include "ircd_reply.h"
30 #include "ircd_snprintf.h"
31 #include "ircd_string.h"
44 #include <sys/types.h>
50 #define LOG_BUFSIZE 2048
52 /* select default log level cutoff */
54 # define L_DEFAULT L_DEBUG
56 # define L_DEFAULT L_INFO
59 #define LOG_DOSYSLOG 0x10
60 #define LOG_DOFILELOG 0x20
61 #define LOG_DOSNOTICE 0x40
63 #define LOG_DOMASK (LOG_DOSYSLOG | LOG_DOFILELOG | LOG_DOSNOTICE)
65 /* Map severity levels to strings and syslog levels */
66 static struct LevelData {
70 unsigned int snomask; /* 0 means use default in LogDesc */
72 #define L(level, syslog, mask) { L_ ## level, #level, (syslog), (mask) }
73 L(CRIT, LOG_CRIT, SNO_OLDSNO),
75 L(WARNING, LOG_WARNING, 0),
76 L(NOTICE, LOG_NOTICE, 0),
77 L(TRACE, LOG_INFO, 0),
79 L(DEBUG, LOG_INFO, SNO_DEBUG),
81 { L_LAST_LEVEL, 0, 0, 0 }
84 /* Just in case some implementation of syslog has them... */
89 #define LOG_NONE -1 /* don't syslog */
90 #define LOG_DEFAULT 0 /* syslog to logInfo.facility */
91 #define LOG_NOTFOUND -2 /* didn't find a facility corresponding to name */
93 /* Map names to syslog facilities--allows syslog configuration from .conf */
98 #define F(fac) { #fac, LOG_ ## fac }
99 F(NONE), F(DEFAULT), F(AUTH),
103 F(CRON), F(DAEMON), F(LOCAL0), F(LOCAL1), F(LOCAL2), F(LOCAL3),
104 F(LOCAL4), F(LOCAL5), F(LOCAL6), F(LOCAL7), F(LPR), F(MAIL),
105 F(NEWS), F(USER), F(UUCP),
110 #define SNO_NONE 0x00000000 /* don't send server notices */
111 #define SNO_NOTFOUND 0xffffffff /* didn't find a SNO_MASK value for name */
113 /* Map names to snomask values--allows configuration from .conf */
116 unsigned int snomask;
118 #define M(mask) { #mask, SNO_ ## mask }
119 M(NONE), M(OLDSNO), M(SERVKILL), M(OPERKILL), M(HACK2),
120 M(HACK3), M(UNAUTH), M(TCPCOMMON), M(TOOMANY), M(HACK4),
121 M(GLINE), M(NETWORK), M(IPMISMATCH), M(THROTTLE), M(OLDREALOP),
122 M(CONNEXIT), M(DEBUG),
127 /* Descriptions of all logging subsystems */
128 static struct LogDesc {
129 enum LogSys subsys; /* number for subsystem */
130 char *name; /* subsystem name */
131 struct LogFile *file; /* file descriptor for subsystem */
132 int def_fac; /* default facility */
133 unsigned int def_sno; /* default snomask */
134 int facility; /* -1 means don't use syslog */
135 unsigned int snomask; /* 0 means no server message */
136 enum LogLevel level; /* logging level */
138 #define S(sys, p, sn) { LS_ ## sys, #sys, 0, (p), (sn), (p), (sn), L_DEFAULT }
140 S(CONFIG, 0, SNO_OLDSNO),
141 S(OPERMODE, -1, SNO_HACK4),
142 S(GLINE, -1, SNO_GLINE),
143 S(JUPE, -1, SNO_NETWORK),
145 S(NETWORK, -1, SNO_NETWORK),
149 S(OPER, -1, SNO_OLDREALOP),
152 S(DEBUG, -1, SNO_DEBUG),
155 { LS_LAST_SYSTEM, 0, 0, -1, 0, -1, 0 }
158 /* describes a log file */
160 struct LogFile *next; /* next log file descriptor */
161 struct LogFile **prev_p; /* what points to us */
162 int fd; /* file's descriptor-- -1 if not open */
163 int ref; /* how many things refer to us? */
164 char *file; /* file name */
167 /* modifiable static information */
169 struct LogFile *filelist; /* list of log files */
170 struct LogFile *freelist; /* list of free'd log files */
171 int facility; /* default facility */
172 const char *procname; /* process's name */
173 struct LogFile *dbfile; /* debug file */
174 } logInfo = { 0, 0, LOG_USER, "ircd", 0 };
176 /* helper routine to open a log file if needed */
178 log_open(struct LogFile *lf)
180 /* only open the file if we haven't already */
181 if (lf && lf->fd < 0) {
182 alarm(3); /* if NFS hangs, we hang only for 3 seconds */
183 lf->fd = open(lf->file, O_WRONLY | O_CREAT | O_APPEND,
191 /* reopen debug log */
193 log_debug_reopen(void)
195 if (!logInfo.dbfile) /* no open debugging file */
198 if (!logInfo.dbfile->file) { /* using terminal output */
199 logInfo.dbfile->fd = 2;
203 /* Ok, it's a real file; close it if necessary and use log_open to open it */
204 if (logInfo.dbfile->fd >= 0)
205 close(logInfo.dbfile->fd);
207 log_open(logInfo.dbfile);
209 if (logInfo.dbfile->fd < 0) { /* try again with /dev/null */
210 if ((logInfo.dbfile->fd = open("/dev/null", O_WRONLY)) < 0)
214 /* massage the file descriptor to be stderr */
215 if (logInfo.dbfile->fd != 2) {
216 dup2(logInfo.dbfile->fd, 2);
217 close(logInfo.dbfile->fd);
218 logInfo.dbfile->fd = 2;
222 /* initialize debugging log */
224 log_debug_init(char *file)
226 logInfo.dbfile = MyMalloc(sizeof(struct LogFile));
228 logInfo.dbfile->next = 0; /* initialize debugging filename */
229 logInfo.dbfile->prev_p = 0;
230 logInfo.dbfile->fd = -1;
231 logInfo.dbfile->ref = 1;
233 if (file) /* store pathname to use */
234 DupString(logInfo.dbfile->file, file);
236 logInfo.dbfile->file = 0;
238 log_debug_reopen(); /* open the debug log */
240 logDesc[LS_DEBUG].file = logInfo.dbfile; /* remember where it went */
243 #endif /* DEBUGMODE */
245 /* set the debug log file */
247 log_debug_file(const char *file)
252 /* If we weren't started with debugging enabled, or if we're using
253 * the terminal, don't do anything at all.
255 if (!logInfo.dbfile || !logInfo.dbfile->file)
258 MyFree(logInfo.dbfile->file); /* free old pathname */
259 DupString(logInfo.dbfile->file, file); /* store new pathname */
261 log_debug_reopen(); /* reopen the debug log */
262 #endif /* DEBUGMODE */
266 /* called in place of open_log(), this stores the process name and prepares
270 log_init(const char *process_name)
272 /* store the process name; probably belongs in ircd.c, but oh well... */
273 if (!EmptyString(process_name))
274 logInfo.procname = process_name;
276 /* ok, open syslog; default facility: LOG_USER */
277 openlog(logInfo.procname, LOG_PID | LOG_NDELAY, logInfo.facility);
280 /* Files are persistently open; this closes and reopens them to allow
286 log_close(); /* close everything...we reopen on demand */
289 log_debug_reopen(); /* reopen debugging log if necessary */
290 #endif /* DEBUGMODE */
292 /* reopen syslog, if needed; default facility: LOG_USER */
293 openlog(logInfo.procname, LOG_PID | LOG_NDELAY, logInfo.facility);
296 /* close the log files */
302 closelog(); /* close syslog */
304 for (ptr = logInfo.filelist; ptr; ptr = ptr->next) {
306 close(ptr->fd); /* close all the files... */
311 if (logInfo.dbfile && logInfo.dbfile->file) {
312 if (logInfo.dbfile->fd >= 0)
313 close(logInfo.dbfile->fd); /* close the debug log file */
315 logInfo.dbfile->fd = -1;
319 /* These write entries to a log file */
321 log_write(enum LogSys subsys, enum LogLevel severity, unsigned int flags,
322 const char *fmt, ...)
327 log_vwrite(subsys, severity, flags, fmt, vl);
332 log_vwrite(enum LogSys subsys, enum LogLevel severity, unsigned int flags,
333 const char *fmt, va_list vl)
336 struct LogDesc *desc;
337 struct LevelData *ldata;
339 struct iovec vector[3];
341 char buf[LOG_BUFSIZE];
342 /* 1234567890123456789012 3 */
343 /* [2000-11-28 16:11:20] \0 */
346 /* check basic assumptions */
347 assert(-1 < (int)subsys);
348 assert((int)subsys < LS_LAST_SYSTEM);
349 assert(-1 < (int)severity);
350 assert((int)severity < L_LAST_LEVEL);
351 assert(0 == (flags & ~LOG_NOMASK));
354 /* find the log data and the severity data */
355 desc = &logDesc[subsys];
356 ldata = &levelData[severity];
358 /* check the set of ordering assumptions */
359 assert(desc->subsys == subsys);
360 assert(ldata->level == severity);
362 /* check severity... */
363 if (severity > desc->level)
366 /* figure out where all we need to log */
367 if (!(flags & LOG_NOFILELOG) && desc->file) {
368 log_open(desc->file);
369 if (desc->file->fd >= 0) /* don't log to file if we can't open the file */
370 flags |= LOG_DOFILELOG;
373 if (!(flags & LOG_NOSYSLOG) && desc->facility >= 0)
374 flags |= LOG_DOSYSLOG; /* will syslog */
376 if (!(flags & LOG_NOSNOTICE) && (desc->snomask != 0 || ldata->snomask != 0))
377 flags |= LOG_DOSNOTICE; /* will send a server notice */
379 /* short-circuit if there's nothing to do... */
380 if (!(flags & LOG_DOMASK))
383 /* Build the basic log string */
387 /* save the length for writev */
388 /* Log format: "SYSTEM [SEVERITY]: log message" */
390 ircd_snprintf(0, buf, sizeof(buf), "%s [%s]: %v", desc->name,
393 /* if we have something to write to... */
394 if (flags & LOG_DOFILELOG) {
396 tstamp = localtime(&curtime); /* build the timestamp */
399 ircd_snprintf(0, timebuf, sizeof(timebuf), "[%d-%d-%d %d:%02d:%02d] ",
400 tstamp->tm_year + 1900, tstamp->tm_mon + 1,
401 tstamp->tm_mday, tstamp->tm_hour, tstamp->tm_min,
404 /* set up the remaining parts of the writev vector... */
405 vector[0].iov_base = timebuf;
406 vector[1].iov_base = buf;
408 vector[2].iov_base = "\n"; /* terminate lines with a \n */
409 vector[2].iov_len = 1;
411 /* write it out to the log file */
412 writev(desc->file->fd, vector, 3);
415 /* oh yeah, syslog it too... */
416 if (flags & LOG_DOSYSLOG)
417 syslog(ldata->syslog | desc->facility, "%s", buf);
419 /* can't forget server notices... */
420 if (flags & LOG_DOSNOTICE)
421 sendto_opmask_butone(0, ldata->snomask ? ldata->snomask : desc->snomask,
425 /* log kills for fun and profit */
427 log_write_kill(const struct Client *victim, const struct Client *killer,
428 const char *inpath, const char *path)
431 log_write(IsServer(killer) ? LS_SERVKILL : LS_OPERKILL, L_TRACE, 0,
432 "A local client %#C KILLED by %#C Path: %s!%s",
433 victim, killer, inpath, path);
435 log_write(IsServer(killer) ? LS_SERVKILL : LS_OPERKILL, L_TRACE, 0,
436 "KILL from %C For %C Path: %s!%s", killer, victim, inpath, path);
439 /* return a struct LogFile for a specific filename--reference counted */
440 static struct LogFile *
441 log_file_create(const char *file)
447 /* if one already exists for that file, return it */
448 for (tmp = logInfo.filelist; tmp; tmp = tmp->next)
449 if (!strcmp(tmp->file, file)) {
454 if (logInfo.freelist) { /* pop one off the free list */
455 tmp = logInfo.freelist;
456 logInfo.freelist = tmp->next;
457 } else /* allocate a new one */
458 tmp = MyMalloc(sizeof(struct LogFile));
460 tmp->fd = -1; /* initialize the structure */
462 DupString(tmp->file, file);
464 tmp->next = logInfo.filelist; /* link it into the list... */
465 tmp->prev_p = &logInfo.filelist;
466 if (logInfo.filelist)
467 logInfo.filelist->prev_p = &tmp->next;
468 logInfo.filelist = tmp;
473 /* destroy a log file descriptor, under the control of the reference count */
475 log_file_destroy(struct LogFile *lf)
479 if (--lf->ref == 0) {
480 if (lf->next) /* clip it out of the list */
481 lf->next->prev_p = lf->prev_p;
482 *lf->prev_p = lf->next;
484 lf->prev_p = 0; /* we won't use it for the free list */
488 MyFree(lf->file); /* free the file name */
490 lf->next = logInfo.freelist; /* stack it onto the free list */
491 logInfo.freelist = lf;
495 /* finds a subsystem given its name */
496 static struct LogDesc *
497 log_find(const char *subsys)
503 /* find the named subsystem */
504 for (i = 0; i < LS_LAST_SYSTEM; i++)
505 if (!ircd_strcmp(subsys, logDesc[i].name))
508 return 0; /* not found */
511 /* canonicalize subsystem names */
513 log_canon(const char *subsys)
515 struct LogDesc *desc;
517 if (!(desc = log_find(subsys)))
523 /* find a level given its name */
525 log_lev_find(const char *level)
531 /* find the named level */
532 for (i = 0; levelData[i].string; i++)
533 if (!ircd_strcmp(level, levelData[i].string))
534 return levelData[i].level;
536 return L_LAST_LEVEL; /* not found */
539 /* return a name for a level */
541 log_lev_name(enum LogLevel lev)
543 assert(-1 < (int)lev);
544 assert((int)lev < L_LAST_LEVEL);
545 assert(lev == levelData[lev].level);
547 return levelData[lev].string;
550 /* find a facility given its name */
552 log_fac_find(const char *facility)
556 assert(0 != facility);
558 /* find the named facility */
559 for (i = 0; facilities[i].name; i++)
560 if (!ircd_strcmp(facility, facilities[i].name))
561 return facilities[i].facility;
563 return LOG_NOTFOUND; /* not found */
566 /* return a name for a facility */
568 log_fac_name(int fac)
572 /* find the facility */
573 for (i = 0; facilities[i].name; i++)
574 if (facilities[i].facility == fac)
575 return facilities[i].name;
577 return 0; /* not found; should never happen */
580 /* find a snomask value given its name */
582 log_sno_find(const char *maskname)
586 assert(0 != maskname);
588 /* find the named snomask */
589 for (i = 0; masks[i].name; i++)
590 if (!ircd_strcmp(maskname, masks[i].name))
591 return masks[i].snomask;
593 return SNO_NOTFOUND; /* not found */
596 /* return a name for a snomask value */
598 log_sno_name(unsigned int sno)
602 /* find the snomask */
603 for (i = 0; masks[i].name; i++)
604 if (masks[i].snomask == sno)
605 return masks[i].name;
607 return 0; /* not found; should never happen */
610 /* set the log file for a subsystem */
612 log_set_file(const char *subsys, const char *filename)
614 struct LogDesc *desc;
617 if (!(desc = log_find(subsys)))
620 /* no change, don't go to the trouble of destroying and recreating */
621 if (desc->file && filename && !strcmp(desc->file->file, filename))
624 /* debug log is special, since it has to be opened on fd 2 */
625 if (desc->subsys == LS_DEBUG) {
626 return log_debug_file(filename);
629 if (desc->file) /* destroy previous entry... */
630 log_file_destroy(desc->file);
632 /* set the file to use */
633 desc->file = filename ? log_file_create(filename) : 0;
638 /* get the log file for a subsystem */
640 log_get_file(const char *subsys)
642 struct LogDesc *desc;
645 if (!(desc = log_find(subsys)))
648 return desc->file ? desc->file->file : 0;
651 /* set the facility for a subsystem */
653 log_set_facility(const char *subsys, const char *facility)
655 struct LogDesc *desc;
659 if (!(desc = log_find(subsys)))
662 /* set syslog facility */
663 if (EmptyString(facility))
664 desc->facility = desc->def_fac;
665 else if ((fac = log_fac_find(facility)) != LOG_NOTFOUND)
666 desc->facility = fac;
673 /* get the facility for a subsystem */
675 log_get_facility(const char *subsys)
677 struct LogDesc *desc;
680 if (!(desc = log_find(subsys)))
683 /* find the facility's name */
684 return log_fac_name(desc->facility);
687 /* set the snomask value for a subsystem */
689 log_set_snomask(const char *subsys, const char *snomask)
691 struct LogDesc *desc;
692 unsigned int sno = SNO_DEFAULT;
695 if (!(desc = log_find(subsys)))
698 /* set snomask value */
699 if (EmptyString(snomask))
700 desc->snomask = desc->def_sno;
701 else if ((sno = log_sno_find(snomask)) != SNO_NOTFOUND)
709 /* get the snomask value for a subsystem */
711 log_get_snomask(const char *subsys)
713 struct LogDesc *desc;
716 if (!(desc = log_find(subsys)))
719 /* find the snomask value's name */
720 return log_sno_name(desc->snomask);
723 /* set the level for a subsystem */
725 log_set_level(const char *subsys, const char *level)
727 struct LogDesc *desc;
731 if (!(desc = log_find(subsys)))
734 /* set logging level */
735 if (EmptyString(level))
736 desc->level = L_DEFAULT;
737 else if ((lev = log_lev_find(level)) != L_LAST_LEVEL)
745 /* get the level for a subsystem */
747 log_get_level(const char *subsys)
749 struct LogDesc *desc;
752 if (!(desc = log_find(subsys)))
755 /* find the level's name */
756 return log_lev_name(desc->level);
759 /* set the overall default syslog facility */
761 log_set_default(const char *facility)
765 oldfac = logInfo.facility;
767 if (EmptyString(facility))
768 logInfo.facility = LOG_USER;
769 else if ((fac = log_fac_find(facility)) != LOG_NOTFOUND &&
770 fac != LOG_NONE && fac != LOG_DEFAULT)
771 logInfo.facility = fac;
775 if (logInfo.facility != oldfac) {
776 closelog(); /* reopen syslog with new facility setting */
777 openlog(logInfo.procname, LOG_PID | LOG_NDELAY, logInfo.facility);
783 /* get the overall default syslog facility */
785 log_get_default(void)
787 /* find the facility's name */
788 return log_fac_name(logInfo.facility);
791 /* Report feature settings */
793 log_feature_report(struct Client *to)
797 for (i = 0; i < LS_LAST_SYSTEM; i++) {
798 if (logDesc[i].file && logDesc[i].file->file) /* report file */
799 send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F LOG %s FILE %s",
800 logDesc[i].name, logDesc[i].file->file);
802 if (logDesc[i].facility != logDesc[i].def_fac) /* report facility */
803 send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F LOG %s FACILITY %s",
804 logDesc[i].name, log_fac_name(logDesc[i].facility));
806 if (logDesc[i].snomask != logDesc[i].def_sno) /* report snomask */
807 send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F LOG %s SNOMASK %s",
808 logDesc[i].name, log_sno_name(logDesc[i].snomask));
810 if (logDesc[i].level != L_DEFAULT) /* report log level */
811 send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F LOG %s LEVEL %s",
812 logDesc[i].name, log_lev_name(logDesc[i].level));
815 if (logInfo.facility != LOG_USER) /* report default facility */
816 send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F LOG %s",
817 log_fac_name(logInfo.facility));