/*
* ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2019 Alexander Barton (alex@barton.de) and Contributors.
*
- * Dieses Programm ist freie Software. Sie koennen es unter den Bedingungen
- * der GNU General Public License (GPL), wie von der Free Software Foundation
- * herausgegeben, weitergeben und/oder modifizieren, entweder unter Version 2
- * der Lizenz oder (wenn Sie es wuenschen) jeder spaeteren Version.
- * Naehere Informationen entnehmen Sie bitter der Datei COPYING. Eine Liste
- * der an ngIRCd beteiligten Autoren finden Sie in der Datei AUTHORS.
- *
- * $Id: log.c,v 1.21 2002/03/12 14:37:52 alex Exp $
- *
- * log.c: Logging-Funktionen
+ * 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 2 of the License, or
+ * (at your option) any later version.
+ * Please read the file COPYING, README and AUTHORS for more information.
*/
-
-#define MAX_LOG_MSG_LEN 256
-
-
#include "portab.h"
-#include "imp.h"
+/**
+ * @file
+ * Logging functions
+ */
+
#include <assert.h>
-#include <errno.h>
-#include <stdarg.h>
+#ifdef PROTOTYPES
+# include <stdarg.h>
+#else
+# include <varargs.h>
+#endif
#include <stdio.h>
-#include <string.h>
#include <sys/types.h>
+#include <time.h>
#include <unistd.h>
-#ifdef USE_SYSLOG
-#include <syslog.h>
+#ifdef SYSLOG
+# include <syslog.h>
#endif
#include "ngircd.h"
-#include "defines.h"
+#include "conn.h"
+#include "channel.h"
+#include "irc-write.h"
+#include "conf.h"
-#include "exp.h"
#include "log.h"
+static bool Is_Daemon;
-GLOBAL VOID Log_Init( VOID )
-{
- CHAR txt[127];
-#ifdef USE_SYSLOG
- /* Syslog initialisieren */
- openlog( PACKAGE, LOG_CONS|LOG_PID, LOG_LOCAL5 );
-#endif
-
- /* Hello World! */
- Log( LOG_NOTICE, "%s started.", NGIRCd_Version( ));
-
- /* Informationen uebern den "Operation Mode" */
- strcpy( txt, "" );
-#ifdef DEBUG
- if( NGIRCd_Debug )
- {
- if( txt[0] ) strcat( txt, ", " );
- strcat( txt, "debug-mode" );
- }
-#endif
- if( NGIRCd_NoDaemon )
- {
- if( txt[0] ) strcat( txt, ", " );
- strcat( txt, "no-daemon-mode" );
+static void
+Log_Message(int Level, const char *msg)
+{
+ if (!Is_Daemon) {
+ /* log to console */
+ fprintf(stdout, "[%ld:%d %4ld] %s\n", (long)getpid(), Level,
+ (long)(time(NULL) - NGIRCd_Start), msg);
+ fflush(stdout);
}
- if( NGIRCd_Passive )
- {
- if( txt[0] ) strcat( txt, ", " );
- strcat( txt, "passive-mode" );
- }
-#ifdef SNIFFER
- if( NGIRCd_Sniffer )
- {
- if( txt[0] ) strcat( txt, ", " );
- strcat( txt, "network sniffer" );
+#ifdef SYSLOG
+ else {
+ syslog(Level, "%s", msg);
}
#endif
- if( txt[0] ) Log( LOG_INFO, "Activating: %s.", txt );
+}
+
- /* stderr in Datei umlenken */
- fflush( stderr );
- if( ! freopen( ERROR_FILE, "a+", stderr )) Log( LOG_ERR, "Can't reopen stderr (\""ERROR_FILE"\"): %s", strerror( errno ));
+/**
+ * Initialitze logging.
+ * This function is called before the configuration file is read in.
+ *
+ * @param Daemon_Mode Set to true if ngIRCd is running as daemon.
+ */
+GLOBAL void
+Log_Init(bool Daemon_Mode)
+{
+ Is_Daemon = Daemon_Mode;
- fprintf( stderr, "\n--- %s ---\n\n", NGIRCd_StartStr );
- fprintf( stderr, "%s started.\npid=%d, ppid=%d, uid=%d, gid=%d [euid=%d, egid=%d].\nActivating: %s\n\n", NGIRCd_Version( ), getpid( ), getppid( ), getuid( ), getgid( ), geteuid( ), getegid( ), txt[0] ? txt : "-" );
- fflush( stderr );
+#ifdef SYSLOG
+#ifndef LOG_CONS /* Kludge: mips-dec-ultrix4.5 has no LOG_CONS */
+#define LOG_CONS 0
+#endif
+#ifdef LOG_DAEMON
+ openlog(PACKAGE, LOG_CONS|LOG_PID, LOG_DAEMON);
+#else
+ openlog(PACKAGE, LOG_CONS|LOG_PID, 0);
+#endif
+#endif
+ Log(LOG_NOTICE, "%s starting ...", NGIRCd_Version);
} /* Log_Init */
-GLOBAL VOID Log_Exit( VOID )
+/**
+ * Re-init logging after reading the configuration file.
+ */
+GLOBAL void
+Log_ReInit(void)
{
- /* Good Bye! */
- Log( LOG_NOTICE, PACKAGE" done.");
- fprintf( stderr, PACKAGE" done (pid=%d).\n", getpid( ));
- fflush( stderr );
+#ifdef SYSLOG
+#ifndef LOG_CONS /* Kludge: mips-dec-ultrix4.5 has no LOG_CONS */
+#define LOG_CONS 0
+#endif
+ closelog();
+ openlog(PACKAGE, LOG_CONS|LOG_PID, Conf_SyslogFacility);
+#endif
+}
-#ifdef USE_SYSLOG
- /* syslog abmelden */
- closelog( );
+
+GLOBAL void
+Log_Exit( void )
+{
+ Log(LOG_NOTICE, "%s done%s, served %lu connection%s.", PACKAGE_NAME,
+ NGIRCd_SignalRestart ? " (restarting)" : "", Conn_CountAccepted(),
+ Conn_CountAccepted() == 1 ? "" : "s");
+#ifdef SYSLOG
+ closelog();
#endif
} /* Log_Exit */
-GLOBAL VOID Log( CONST INT Level, CONST CHAR *Format, ... )
+/**
+ * Log function for debug messages.
+ * This function is only functional when the program is compiled with debug
+ * code enabled; otherwise it is an empty function which the compiler will
+ * hopefully mangle down to "nothing" (see log.h). Therefore you should use
+ * LogDebug(...) in favor to Log(LOG_DEBUG, ...).
+ * @param Format Format string like printf().
+ * @param ... Further arguments.
+ */
+# ifdef PROTOTYPES
+GLOBAL void
+LogDebug( const char *Format, ... )
+# else
+GLOBAL void
+LogDebug( Format, va_alist )
+const char *Format;
+va_dcl
+# endif /* PROTOTYPES */
{
- /* Eintrag in Logfile(s) schreiben */
+ char msg[MAX_LOG_MSG_LEN];
+ va_list ap;
- CHAR msg[MAX_LOG_MSG_LEN];
+ if (!NGIRCd_Debug) return;
+#ifdef PROTOTYPES
+ va_start( ap, Format );
+#else
+ va_start( ap );
+#endif
+ vsnprintf( msg, MAX_LOG_MSG_LEN, Format, ap );
+ va_end( ap );
+ Log(LOG_DEBUG, "%s", msg);
+}
+
+
+/**
+ * Logging function of ngIRCd.
+ * This function logs messages to the console and/or syslog, whichever is
+ * suitable for the mode ngIRCd is running in (daemon vs. non-daemon).
+ * If LOG_snotice is set, the log messages goes to all user with the mode +s
+ * set and the local &SERVER channel, too.
+ * Please note: you should use LogDebug(...) for debug messages!
+ * @param Level syslog level (LOG_xxx)
+ * @param Format Format string like printf().
+ * @param ... Further arguments.
+ */
+#ifdef PROTOTYPES
+GLOBAL void
+Log( int Level, const char *Format, ... )
+#else
+GLOBAL void
+Log( Level, Format, va_alist )
+int Level;
+const char *Format;
+va_dcl
+#endif
+{
+ char msg[MAX_LOG_MSG_LEN];
+ bool snotice;
va_list ap;
assert( Format != NULL );
-#ifdef DEBUG
+ if( Level & LOG_snotice )
+ {
+ /* Notice an User mit "s" Mode */
+ snotice = true;
+ Level &= ~LOG_snotice;
+ }
+ else snotice = false;
+
if(( Level == LOG_DEBUG ) && ( ! NGIRCd_Debug )) return;
-#else
- if( Level == LOG_DEBUG ) return;
-#endif
- /* String mit variablen Argumenten zusammenbauen ... */
+#ifdef PROTOTYPES
va_start( ap, Format );
+#else
+ va_start( ap );
+#endif
vsnprintf( msg, MAX_LOG_MSG_LEN, Format, ap );
va_end( ap );
- /* In Error-File schreiben */
- if( Level <= LOG_ERR ) fprintf( stderr, "[%d] %s\n", Level, msg );
+ Log_Message(Level, msg);
- /* ... und ausgeben */
- if( NGIRCd_NoDaemon ) printf( "[%d] %s\n", Level, msg );
-
-#ifdef USE_SYSLOG
- /* Syslog */
- syslog( Level, msg );
-#endif
+ if (snotice) {
+ /* Send NOTICE to all local users with mode +s and to the
+ * local &SERVER channel */
+ Log_ServerNotice('s', "%s", msg);
+ Channel_LogServer(msg);
+ }
} /* Log */
-GLOBAL VOID Log_Init_Resolver( VOID )
+GLOBAL void
+Log_Init_Subprocess(char UNUSED *Name)
{
-#ifdef USE_SYSLOG
- openlog( PACKAGE, LOG_CONS|LOG_PID, LOG_LOCAL5 );
+#ifdef SYSLOG
+ openlog(PACKAGE, LOG_CONS|LOG_PID, Conf_SyslogFacility);
#endif
-} /* Log_Init_Resolver */
+ Log_Subprocess(LOG_DEBUG, "%s sub-process starting, PID %ld.",
+ Name, (long)getpid());
+}
-GLOBAL VOID Log_Exit_Resolver( VOID )
+GLOBAL void
+Log_Exit_Subprocess(char UNUSED *Name)
{
-#ifdef USE_SYSLOG
+ Log_Subprocess(LOG_DEBUG, "%s sub-process %ld done.",
+ Name, (long)getpid());
+#ifdef SYSLOG
closelog( );
#endif
-} /* Log_Exit_Resolver */
+}
-GLOBAL VOID Log_Resolver( CONST INT Level, CONST CHAR *Format, ... )
+#ifdef PROTOTYPES
+GLOBAL void
+Log_Subprocess(const int Level, const char *Format, ...)
+#else
+GLOBAL void
+Log_Subprocess(Level, Format, va_alist)
+const int Level;
+const char *Format;
+va_dcl
+#endif
{
- /* Eintrag des Resolver in Logfile(s) schreiben */
+ char msg[MAX_LOG_MSG_LEN];
+ va_list ap;
+
+ assert(Format != NULL);
-#ifndef USE_SYSLOG
- return;
+ if ((Level == LOG_DEBUG) && (!NGIRCd_Debug))
+ return;
+
+#ifdef PROTOTYPES
+ va_start(ap, Format);
#else
+ va_start(ap);
+#endif
+ vsnprintf(msg, MAX_LOG_MSG_LEN, Format, ap);
+ va_end(ap);
- CHAR msg[MAX_LOG_MSG_LEN];
- va_list ap;
+ Log_Message(Level, msg);
+}
- assert( Format != NULL );
-#ifdef DEBUG
- if(( Level == LOG_DEBUG ) && ( ! NGIRCd_Debug )) return;
+/**
+ * Send a log message to all local users flagged with the given user mode.
+ * @param UserMode User mode which the target user must have set,
+ * @param Format The format string.
+ */
+#ifdef PROTOTYPES
+GLOBAL void
+Log_ServerNotice(const char UserMode, const char *Format, ... )
#else
- if( Level == LOG_DEBUG ) return;
+GLOBAL void
+Log_ServerNotice(UserMode, Format, va_alist)
+const char UserMode;
+const char *Format;
+va_dcl
#endif
+{
+ CLIENT *c;
+ char msg[MAX_LOG_MSG_LEN];
+ va_list ap;
- /* String mit variablen Argumenten zusammenbauen ... */
- va_start( ap, Format );
- vsnprintf( msg, MAX_LOG_MSG_LEN, Format, ap );
- va_end( ap );
-
- /* ... und ausgeben */
- syslog( Level, msg );
+ assert(Format != NULL);
+#ifdef PROTOTYPES
+ va_start(ap, Format);
+#else
+ va_start(ap);
#endif
-} /* Log_Resolver */
+ vsnprintf(msg, MAX_LOG_MSG_LEN, Format, ap);
+ va_end(ap);
+
+ for(c=Client_First(); c != NULL; c=Client_Next(c)) {
+ if (Client_Conn(c) > NONE && Client_HasMode(c, UserMode))
+ IRC_WriteStrClient(c, "NOTICE %s :%s%s", Client_ID(c),
+ NOTICE_TXTPREFIX, msg);
+ }
+} /* Log_ServerNotice */
/* -eof- */