]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/log.c
Slightly reoder startup steps, and enhance logging
[ngircd-alex.git] / src / ngircd / log.c
index 5a81b5b3e03083451d65150b033e04ce4d873151..a47ce92cd81571025a446ecd0f54b8553dcf9020 100644 (file)
@@ -1,56 +1,46 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001-2005 Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2019 Alexander Barton (alex@barton.de) and Contributors.
  *
  * 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.
- *
- * Logging functions
  */
 
-
 #include "portab.h"
 
-#include "imp.h"
+/**
+ * @file
+ * Logging functions
+ */
+
 #include <assert.h>
-#include <errno.h>
 #ifdef PROTOTYPES
-#      include <stdarg.h>
+# include <stdarg.h>
 #else
-#      include <varargs.h>
+# include <varargs.h>
 #endif
 #include <stdio.h>
-#include <string.h>
 #include <sys/types.h>
+#include <time.h>
 #include <unistd.h>
 
 #ifdef SYSLOG
-#include <syslog.h>
+# include <syslog.h>
 #endif
 
 #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"
 
-
-static char Init_Txt[127];
 static bool Is_Daemon;
 
-#ifdef DEBUG
-static char Error_File[FNAME_LEN];
-#endif
-
-
-static void Wall_ServerNotice PARAMS(( char *Msg ));
 
 static void
 Log_Message(int Level, const char *msg)
@@ -58,7 +48,7 @@ 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);
+                               (long)(time(NULL) - NGIRCd_Start), msg);
                fflush(stdout);
        }
 #ifdef SYSLOG
@@ -69,94 +59,53 @@ Log_Message(int Level, const char *msg)
 }
 
 
+/**
+ * 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 )
+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
-       openlog( PACKAGE_NAME, LOG_CONS|LOG_PID, LOG_LOCAL5 );
-#endif
-
-       Log( LOG_NOTICE, "%s started.", NGIRCd_Version );
-         
-       /* Information about "Operation Mode" */
-       Init_Txt[0] = '\0';
-#ifdef DEBUG
-       if( NGIRCd_Debug )
-       {
-               strlcpy( Init_Txt, "debug-mode", sizeof Init_Txt );
-       }
-#endif
-       if( ! Is_Daemon )
-       {
-               if( Init_Txt[0] ) strlcat( Init_Txt, ", ", sizeof Init_Txt );
-               strlcat( Init_Txt, "no-daemon-mode", sizeof Init_Txt );
-       }
-       if( NGIRCd_Passive )
-       {
-               if( Init_Txt[0] ) strlcat( Init_Txt, ", ", sizeof Init_Txt );
-               strlcat( Init_Txt, "passive-mode", sizeof Init_Txt );
-       }
-#ifdef SNIFFER
-       if( NGIRCd_Sniffer )
-       {
-               if( Init_Txt[0] ) strlcat( Init_Txt, ", ", sizeof Init_Txt );
-               strlcat( Init_Txt, "network sniffer", sizeof Init_Txt );
-       }
+#ifdef LOG_DAEMON
+       openlog(PACKAGE, LOG_CONS|LOG_PID, LOG_DAEMON);
+#else
+       openlog(PACKAGE, LOG_CONS|LOG_PID, 0);
 #endif
-       if( Init_Txt[0] ) Log( LOG_INFO, "Activating: %s.", Init_Txt );
-
-#ifdef DEBUG
-       Error_File[0] = '\0';
 #endif
+       Log(LOG_NOTICE, "%s starting ...", NGIRCd_Version);
 } /* Log_Init */
 
 
-#ifdef DEBUG
+/**
+ * Re-init logging after reading the configuration file.
+ */
 GLOBAL void
-Log_InitErrorfile( void )
+Log_ReInit(void)
 {
-       snprintf( Error_File, sizeof Error_File, "%s/%s-%ld.err", ERROR_DIR, PACKAGE_NAME, (long)getpid( ));
-
-       fflush( stderr );
-       if( ! freopen( Error_File, "w", stderr ))
-       {
-               Log( LOG_ERR, "Can't reopen stderr (\"%s\"): %s", Error_File, strerror( errno ));
-               return;
-       }
-
-       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 );
-
-       Log(LOG_DEBUG, "Redirected stderr to \"%s\".", Error_File);
-} /* Log_InitErrfile */
+#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
+}
 
 
 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 );
-
-#ifdef DEBUG
-       if( Error_File[0] )
-       {
-               /* Error-File (stderr) loeschen */
-               if( unlink( Error_File ) != 0 ) Log( LOG_ERR, "Can't delete \"%s\": %s", Error_File, strerror( errno ));
-       }
-#endif
-
+       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
@@ -205,7 +154,7 @@ va_dcl
  * 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!
+ * Please note: you should use LogDebug(...) for debug messages!
  * @param Level syslog level (LOG_xxx)
  * @param Format Format string like printf().
  * @param ... Further arguments.
@@ -251,102 +200,113 @@ va_dcl
 
        Log_Message(Level, msg);
 
-       if (Level <= LOG_CRIT) {
-               /* log critical messages to stderr */
-               fprintf(stderr, "%s\n", msg);
-               fflush(stderr);
-       }
-
        if (snotice) {
                /* Send NOTICE to all local users with mode +s and to the
                 * local &SERVER channel */
-               Wall_ServerNotice(msg);
+               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, LOG_CONS|LOG_PID, Conf_SyslogFacility);
 #endif
 #ifdef DEBUG
-       Log_Resolver(LOG_DEBUG, "Resolver sub-process starting, PID %ld.", (long)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 %ld done.", (long)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);
 
        Log_Message(Level, msg);
-} /* Log_Resolver */
+}
 
 
 /**
- * Send log messages to users flagged with the "s" mode.
- * @param Msg The message to send.
+ * 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.
  */
-static void
-Wall_ServerNotice( char *Msg )
+#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
 {
        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_ID(c),
-                                                       NOTICE_TXTPREFIX, Msg);
+#ifdef PROTOTYPES
+       va_start(ap, Format);
+#else
+       va_start(ap);
+#endif
+       vsnprintf(msg, MAX_LOG_MSG_LEN, Format, ap);
+       va_end(ap);
 
-               c = Client_Next( c );
+       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- */