]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/log.c
New configuration option "SyslogFacility"
[ngircd-alex.git] / src / ngircd / log.c
index d0608cbc248cf10745abecedbf5af2173c1546ce..3710142d81e4d0a57f2a50bf84760ddc3efcd955 100644 (file)
 /*
  * 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)
  *
- * 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.
+ * 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.
  *
- * $Id: log.c,v 1.18 2002/02/19 20:07:13 alex Exp $
- *
- * log.c: Logging-Funktionen
- *
- * $Log: log.c,v $
- * Revision 1.18  2002/02/19 20:07:13  alex
- * - direkt nach dem Start werden die aktiven "Modes" ins Log geschrieben.
- *
- * Revision 1.17  2002/01/11 14:45:37  alex
- * - Anpassungen an neue Kommandozeilen-Optionen "--debug" und "--nodaemon".
- *
- * Revision 1.16  2002/01/05 15:54:40  alex
- * - syslog() etc. wurde verwendet, auch wenn USE_SYSLOG nicht definiert war.
- *
- * Revision 1.15  2002/01/02 02:42:58  alex
- * - Copyright-Texte aktualisiert.
- *
- * Revision 1.14  2002/01/01 18:01:43  alex
- * - Architektur und Betriebssystem in Start-Meldung aufgenommen.
- *
- * Revision 1.13  2001/12/31 02:18:51  alex
- * - viele neue Befehle (WHOIS, ISON, OPER, DIE, RESTART),
- * - neuen Header "defines.h" mit (fast) allen Konstanten.
- * - Code Cleanups und viele "kleine" Aenderungen & Bugfixes.
- *
- * Revision 1.12  2001/12/29 20:16:31  alex
- * - Log-Funktionen fuer Resolver-Sub-Prozess implementiert.
- *
- * Revision 1.11  2001/12/29 03:08:49  alex
- * - neue configure-Option "--enable-strict-rfc".
- *
- * Revision 1.10  2001/12/27 01:44:49  alex
- * - die Verwendung von syslog kann nun abgeschaltet werden.
- *
- * Revision 1.9  2001/12/26 03:22:16  alex
- * - string.h wird nun includiert.
- *
- * Revision 1.8  2001/12/25 23:13:00  alex
- * - Versionsstring bei Programmstart verbessert.
- *
- * Revision 1.7  2001/12/25 22:04:26  alex
- * - Aenderungen an den Debug- und Logging-Funktionen.
- *
- * Revision 1.6  2001/12/25 19:20:39  alex
- * - es wird nun die Facility LOG_LOCAL5 zum Loggen verwendet.
- *
- * Revision 1.5  2001/12/15 00:07:56  alex
- * - Log-Level der Start- und Stop-Meldungen angehoben.
- *
- * Revision 1.4  2001/12/13 02:04:16  alex
- * - boesen "Speicherschiesser" in Log() gefixt.
- *
- * Revision 1.3  2001/12/12 23:31:24  alex
- * - Zum Loggen wird nun auch syslog verwendet.
- *
- * Revision 1.2  2001/12/12 17:19:12  alex
- * - in Log-Meldungen wird nun auch der Level der Meldung ausgegeben.
- *
- * Revision 1.1.1.1  2001/12/11 21:53:04  alex
- * - Imported sources to CVS.
+ * Logging functions
  */
 
 
-#define MAX_LOG_MSG_LEN 256
-
-
-#include <portab.h>
-#include "global.h"
+#include "portab.h"
 
-#include <imp.h>
+#include "imp.h"
 #include <assert.h>
-#include <stdarg.h>
+#include <errno.h>
+#ifdef PROTOTYPES
+#      include <stdarg.h>
+#else
+#      include <varargs.h>
+#endif
 #include <stdio.h>
 #include <string.h>
+#include <sys/types.h>
+#include <unistd.h>
 
-#ifdef USE_SYSLOG
+#ifdef SYSLOG
 #include <syslog.h>
 #endif
 
-#include "global.h"
 #include "ngircd.h"
+#include "defines.h"
+#include "conn.h"
+#include "channel.h"
+#include "irc-write.h"
+#include "conf.h"
 
-#include <exp.h>
+#include "exp.h"
 #include "log.h"
 
 
-GLOBAL VOID Log_Init( VOID )
-{
-       CHAR txt[127];
+static char Init_Txt[127];
+static bool Is_Daemon;
 
-#ifdef USE_SYSLOG
-       /* Syslog initialisieren */
-       openlog( PACKAGE, LOG_CONS|LOG_PID, LOG_LOCAL5 );
+#ifdef DEBUG
+static char Error_File[FNAME_LEN];
 #endif
 
-       /* Hello World! */
-       Log( LOG_NOTICE, "%s started.", NGIRCd_Version( ));
 
-       /* Informationen uebern den "Operation Mode" */
-       strcpy( txt, "" );
+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
+Log_Init( bool Daemon_Mode )
+{
+       Is_Daemon = Daemon_Mode;
+       
+#ifdef SYSLOG
+#ifndef LOG_CONS     /* Kludge: mips-dec-ultrix4.5 has no LOG_CONS */
+#define LOG_CONS 0
+#endif
+       openlog(PACKAGE_NAME, LOG_CONS|LOG_PID, Conf_SyslogFacility);
+#endif
+
+       Log( LOG_NOTICE, "%s started.", NGIRCd_Version );
+         
+       /* Information about "Operation Mode" */
+       Init_Txt[0] = '\0';
 #ifdef DEBUG
        if( NGIRCd_Debug )
        {
-               if( txt[0] ) strcat( txt, ", " );
-               strcat( txt, "debug-mode" );
+               strlcpy( Init_Txt, "debug-mode", sizeof Init_Txt );
        }
 #endif
-       if( NGIRCd_NoDaemon )
+       if( ! Is_Daemon )
        {
-               if( txt[0] ) strcat( txt, ", " );
-               strcat( txt, "no-daemon-mode" );
+               if( Init_Txt[0] ) strlcat( Init_Txt, ", ", sizeof Init_Txt );
+               strlcat( Init_Txt, "no-daemon-mode", sizeof Init_Txt );
        }
        if( NGIRCd_Passive )
        {
-               if( txt[0] ) strcat( txt, ", " );
-               strcat( txt, "passive-mode" );
+               if( Init_Txt[0] ) strlcat( Init_Txt, ", ", sizeof Init_Txt );
+               strlcat( Init_Txt, "passive-mode", sizeof Init_Txt );
        }
 #ifdef SNIFFER
        if( NGIRCd_Sniffer )
        {
-               if( txt[0] ) strcat( txt, ", " );
-               strcat( txt, "network sniffer" );
+               if( Init_Txt[0] ) strlcat( Init_Txt, ", ", sizeof Init_Txt );
+               strlcat( Init_Txt, "network sniffer", sizeof Init_Txt );
        }
 #endif
-       if( txt[0] ) Log( LOG_INFO, "Activating: %s.", txt );
+       if( Init_Txt[0] ) Log( LOG_INFO, "Activating: %s.", Init_Txt );
+
+#ifdef DEBUG
+       Error_File[0] = '\0';
+#endif
 } /* Log_Init */
 
 
-GLOBAL VOID Log_Exit( VOID )
+#ifdef DEBUG
+GLOBAL void
+Log_InitErrorfile( 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 */
+#endif
+
+
+GLOBAL void
+Log_Exit( void )
 {
        /* Good Bye! */
-       Log( LOG_NOTICE, PACKAGE" done.");
-       
-#ifdef USE_SYSLOG
-       /* syslog abmelden */
-       closelog( );
+       Log(LOG_NOTICE, "%s done%s, served %lu connections.", PACKAGE_NAME,
+           NGIRCd_SignalRestart ? " (restarting)" : "", Conn_CountAccepted());
+
+#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
+
+#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 DEBUG
+# 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);
+}
+#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, ... )
+#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 );
 
+       if( Level & LOG_snotice )
+       {
+               /* Notice an User mit "s" Mode */
+               snotice = true;
+               Level &= ~LOG_snotice;
+       }
+       else snotice = false;
+
 #ifdef DEBUG
        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 );
-       vsnprintf( msg, MAX_LOG_MSG_LEN - 1, Format, ap );
-       msg[MAX_LOG_MSG_LEN - 1] = '\0';
-
-       /* ... und ausgeben */
-       if( NGIRCd_NoDaemon ) printf( "[%d] %s\n", Level, msg );
-#ifdef USE_SYSLOG
-       syslog( Level, msg );
+#else
+       va_start( ap );
 #endif
-
+       vsnprintf( msg, MAX_LOG_MSG_LEN, Format, ap );
        va_end( ap );
+
+       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 */
+               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_NAME, LOG_CONS|LOG_PID, Conf_SyslogFacility);
 #endif
-} /* Log_Init_Resolver */
+#ifdef DEBUG
+       Log_Subprocess(LOG_DEBUG, "%s sub-process starting, PID %ld.",
+                    Name, (long)getpid());
+#endif
+}
 
 
-GLOBAL VOID Log_Exit_Resolver( VOID )
+GLOBAL void
+Log_Exit_Subprocess(char UNUSED *Name)
 {
-#ifdef USE_SYSLOG
+#ifdef DEBUG
+       Log_Subprocess(LOG_DEBUG, "%s sub-process %ld done.",
+                    Name, (long)getpid());
+#endif
+#ifdef SYSLOG
        closelog( );
 #endif
-} /* Log_Exit_Resolver */
+}
 
 
-GLOBAL VOID Log_Resolver( CONST INT Level, CONST CHAR *Format, ... )
-{
-       /* Eintrag des Resolver in Logfile(s) schreiben */
-
-#ifndef USE_SYSLOG
-       return;
+#ifdef PROTOTYPES
+GLOBAL void
+Log_Subprocess(const int Level, const char *Format, ...)
 #else
-
-       CHAR msg[MAX_LOG_MSG_LEN];
+GLOBAL void
+Log_Subprocess(Level, Format, va_alist)
+const int Level;
+const char *Format;
+va_dcl
+#endif
+{
+       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 ... */
-       va_start( ap, Format );
-       vsnprintf( msg, MAX_LOG_MSG_LEN - 1, Format, ap );
-       msg[MAX_LOG_MSG_LEN - 1] = '\0';
+#ifdef PROTOTYPES
+       va_start(ap, Format);
+#else
+       va_start(ap);
+#endif
+       vsnprintf(msg, MAX_LOG_MSG_LEN, Format, ap);
+       va_end(ap);
 
-       /* ... und ausgeben */
-       syslog( Level, msg );
+       Log_Message(Level, msg);
+}
 
-       va_end( ap );
+
+/**
+ * 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
-} /* Log_Resolver */
+{
+       CLIENT *c;
+       char msg[MAX_LOG_MSG_LEN];
+       va_list ap;
+
+       assert(Format != NULL);
+
+#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);
+       }
+} /* Log_ServerNotice */
 
 
 /* -eof- */