]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/log.c
New configuration option "SyslogFacility"
[ngircd-alex.git] / src / ngircd / log.c
index e00c7ce7eff94c4aa6ad6b039728de869e87beda..3710142d81e4d0a57f2a50bf84760ddc3efcd955 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2010 Alexander Barton (alex@barton.de)
  *
  * 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
@@ -14,8 +14,6 @@
 
 #include "portab.h"
 
-static char UNUSED id[] = "$Id: log.c,v 1.58 2005/07/31 20:13:08 alex Exp $";
-
 #include "imp.h"
 #include <assert.h>
 #include <errno.h>
@@ -36,9 +34,9 @@ static char UNUSED id[] = "$Id: log.c,v 1.58 2005/07/31 20:13:08 alex Exp $";
 #include "ngircd.h"
 #include "defines.h"
 #include "conn.h"
-#include "client.h"
 #include "channel.h"
 #include "irc-write.h"
+#include "conf.h"
 
 #include "exp.h"
 #include "log.h"
@@ -52,7 +50,21 @@ static char Error_File[FNAME_LEN];
 #endif
 
 
-static void Wall_ServerNotice PARAMS(( char *Msg ));
+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);
+       }
+#ifdef SYSLOG
+       else {
+               syslog(Level, "%s", msg);
+       }
+#endif
+}
 
 
 GLOBAL void
@@ -61,20 +73,15 @@ Log_Init( bool Daemon_Mode )
        Is_Daemon = Daemon_Mode;
        
 #ifdef SYSLOG
-#ifndef LOG_CONS       /* Kludge: mips-dec-ultrix4.5 has no LOG_CONS/LOG_LOCAL5 */
+#ifndef LOG_CONS     /* Kludge: mips-dec-ultrix4.5 has no LOG_CONS */
 #define LOG_CONS 0
 #endif
-#ifndef LOG_LOCAL5
-#define LOG_LOCAL5 0
-#endif
-       /* Syslog initialisieren */
-       openlog( PACKAGE_NAME, LOG_CONS|LOG_PID, LOG_LOCAL5 );
+       openlog(PACKAGE_NAME, LOG_CONS|LOG_PID, Conf_SyslogFacility);
 #endif
 
-       /* Hello World! */
        Log( LOG_NOTICE, "%s started.", NGIRCd_Version );
          
-       /* Informationen uebern den "Operation Mode" */
+       /* Information about "Operation Mode" */
        Init_Txt[0] = '\0';
 #ifdef DEBUG
        if( NGIRCd_Debug )
@@ -108,17 +115,11 @@ Log_Init( bool Daemon_Mode )
 
 
 #ifdef DEBUG
-
 GLOBAL void
 Log_InitErrorfile( void )
 {
-       /* "Error-Log" initialisieren: stderr in Datei umlenken. Dort
-        * landen z.B. alle Ausgaben von assert()-Aufrufen. */
-
-       /* Dateiname zusammen bauen */
        snprintf( Error_File, sizeof Error_File, "%s/%s-%ld.err", ERROR_DIR, PACKAGE_NAME, (long)getpid( ));
 
-       /* stderr umlenken */
        fflush( stderr );
        if( ! freopen( Error_File, "w", stderr ))
        {
@@ -126,17 +127,13 @@ Log_InitErrorfile( void )
                return;
        }
 
-       /* Einige Infos in das Error-File schreiben */
        fputs( ctime( &NGIRCd_Start ), stderr );
        fprintf( stderr, "%s started.\n", NGIRCd_Version );
        fprintf( stderr, "Activating: %s\n\n", Init_Txt[0] ? Init_Txt : "-" );
        fflush( stderr );
 
-#ifdef DEBUG
-       Log( LOG_DEBUG, "Redirected stderr to \"%s\".", Error_File );
-#endif
+       Log(LOG_DEBUG, "Redirected stderr to \"%s\".", Error_File);
 } /* Log_InitErrfile */
-
 #endif
 
 
@@ -144,8 +141,8 @@ GLOBAL void
 Log_Exit( void )
 {
        /* Good Bye! */
-       if( NGIRCd_SignalRestart ) Log( LOG_NOTICE, "%s done (restarting).", PACKAGE_NAME );
-       else Log( LOG_NOTICE, "%s done.", PACKAGE_NAME );
+       Log(LOG_NOTICE, "%s done%s, served %lu connections.", PACKAGE_NAME,
+           NGIRCd_SignalRestart ? " (restarting)" : "", Conn_CountAccepted());
 
 #ifdef DEBUG
        if( Error_File[0] )
@@ -156,12 +153,58 @@ Log_Exit( void )
 #endif
 
 #ifdef SYSLOG
-       /* syslog abmelden */
-       closelog( );
+       closelog();
 #endif
 } /* Log_Exit */
 
 
+/**
+ * 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 DEBUG
+# ifdef PROTOTYPES
+GLOBAL void
+LogDebug( const char *Format, ... )
+# else
+GLOBAL void
+LogDebug( Format, va_alist )
+const char *Format;
+va_dcl
+# endif /* PROTOTYPES */
+{
+       char msg[MAX_LOG_MSG_LEN];
+       va_list ap;
+
+       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);
+}
+#endif /* DEBUG */
+
+
+/**
+ * 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 sould 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, ... )
@@ -173,8 +216,6 @@ const char *Format;
 va_dcl
 #endif
 {
-       /* Eintrag in Logfile(s) schreiben */
-
        char msg[MAX_LOG_MSG_LEN];
        bool snotice;
        va_list ap;
@@ -195,7 +236,6 @@ va_dcl
        if( Level == LOG_DEBUG ) return;
 #endif
 
-       /* String mit variablen Argumenten zusammenbauen ... */
 #ifdef PROTOTYPES
        va_start( ap, Format );
 #else
@@ -204,120 +244,121 @@ va_dcl
        vsnprintf( msg, MAX_LOG_MSG_LEN, Format, ap );
        va_end( ap );
 
-       if( ! Is_Daemon )
-       {
-               /* auf Konsole ausgeben */
-               fprintf( stdout, "[%d:%d] %s\n", (int)getpid( ), Level, msg );
-               fflush( stdout );
-       }
-#ifdef SYSLOG
-       else
-       {
-               /* Syslog */
-               syslog( Level, "%s", msg );
-       }
-#endif
+       Log_Message(Level, msg);
 
-       if( Level <= LOG_CRIT )
-       {
+       if (Level <= LOG_CRIT) {
                /* log critical messages to stderr */
-               fprintf( stderr, "%s\n", msg );
-               fflush( stderr );
+               fprintf(stderr, "%s\n", msg);
+               fflush(stderr);
        }
 
-       if( snotice )
-       {
-               /* NOTICE an lokale User mit "s"-Mode */
-               Wall_ServerNotice( msg );
+       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 )
+Log_Init_Subprocess(char UNUSED *Name)
 {
 #ifdef SYSLOG
-       openlog( PACKAGE_NAME, LOG_CONS|LOG_PID, LOG_LOCAL5 );
+       openlog(PACKAGE_NAME, LOG_CONS|LOG_PID, Conf_SyslogFacility);
 #endif
 #ifdef DEBUG
-       Log_Resolver( LOG_DEBUG, "Resolver sub-process starting, PID %d.", getpid( ));
+       Log_Subprocess(LOG_DEBUG, "%s sub-process starting, PID %ld.",
+                    Name, (long)getpid());
 #endif
-} /* Log_Init_Resolver */
+}
 
 
 GLOBAL void
-Log_Exit_Resolver( void )
+Log_Exit_Subprocess(char UNUSED *Name)
 {
 #ifdef DEBUG
-       Log_Resolver( LOG_DEBUG, "Resolver sub-process %d done.", getpid( ));
+       Log_Subprocess(LOG_DEBUG, "%s sub-process %ld done.",
+                    Name, (long)getpid());
 #endif
 #ifdef SYSLOG
        closelog( );
 #endif
-} /* Log_Exit_Resolver */
+}
 
 
 #ifdef PROTOTYPES
 GLOBAL void
-Log_Resolver( const int Level, const char *Format, ... )
+Log_Subprocess(const int Level, const char *Format, ...)
 #else
 GLOBAL void
-Log_Resolver( Level, Format, va_alist )
+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 );
+       assert(Format != NULL);
 
 #ifdef DEBUG
-       if(( Level == LOG_DEBUG ) && ( ! NGIRCd_Debug )) return;
+       if ((Level == LOG_DEBUG) && (!NGIRCd_Debug))
+               return;
 #else
-       if( Level == LOG_DEBUG ) return;
+       if (Level == LOG_DEBUG)
+               return;
 #endif
 
-       /* String mit variablen Argumenten zusammenbauen ... */
 #ifdef PROTOTYPES
-       va_start( ap, Format );
+       va_start(ap, Format);
 #else
-       va_start( ap );
+       va_start(ap);
 #endif
-       vsnprintf( msg, MAX_LOG_MSG_LEN, Format, ap );
-       va_end( ap );
+       vsnprintf(msg, MAX_LOG_MSG_LEN, Format, ap);
+       va_end(ap);
 
-       if( ! Is_Daemon )
-       {
-               /* Output to console */
-               fprintf( stdout, "[%d:%d] %s\n", (int)getpid( ), Level, msg );
-               fflush( stdout );
-       }
-#ifdef SYSLOG
-       else syslog( Level, "%s", msg );
-#endif
-} /* Log_Resolver */
+       Log_Message(Level, msg);
+}
 
 
-static void
-Wall_ServerNotice( char *Msg )
+/**
+ * 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
+GLOBAL void
+Log_ServerNotice(UserMode, Format, va_alist)
+const char UserMode;
+const char *Format;
+va_dcl
+#endif
 {
-       /* Server-Notice an entsprechende User verschicken */
-
        CLIENT *c;
+       char msg[MAX_LOG_MSG_LEN];
+       va_list ap;
 
-       assert( Msg != NULL );
+       assert(Format != NULL);
 
-       c = Client_First( );
-       while( c )
-       {
-               if(( Client_Conn( c ) > NONE ) && ( Client_HasMode( c, 's' ))) IRC_WriteStrClient( c, "NOTICE %s :%s%s", Client_ThisServer( ), NOTICE_TXTPREFIX, Msg );
-               c = Client_Next( c );
+#ifdef PROTOTYPES
+       va_start(ap, Format);
+#else
+       va_start(ap);
+#endif
+       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);
        }
-} /* Wall_ServerNotice */
+} /* Log_ServerNotice */
 
 
 /* -eof- */