---

logger.h

Go to the documentation of this file.

/***************************************************************************
                                   logger.h
                             -------------------
    begin                : Sat Nov 3 2001
    copyright            : (C) 2001-2002 by Christian Hoenig & Gunter Ohrner
    email                : pdepp@CustomCDROM.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  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef LOGGER_H_FLAG
#define LOGGER_H_FLAG

#include "common.h"


// If we have stdarg.h, include it. (GNU)
#ifdef HAVE_STDARG_H
# include <stdarg.h>
#else
// Do we have sys/varargs.h?
# ifdef HAVE_SYS_VARARGS_H
#   include <sys/varargs.h>
# else
// We have neither, try the old varargs.h as a last resort and fail
// with compilation errors...
#   warning "stdarg.h not found, compilation will probably fail..."
#   include <varargs.h>
# endif
#endif

/**************************************************************************
 *                                                                        *
 *   functions/macros to retreive information about log message sources   *
 *                                                                        *
 **************************************************************************/

// predefined sources of logging messages
// Don't forget to update the log_src_info_tab if you change anything!!!
#define PDEPP_CORE         0    
#define QUERY_HANDLER      1    
#define LOGGER             2    
#define CONF_TABLE         3    
#define CONN_HANDLER       4    
#define PROT_HANDLER       5    
#define REQUEST_HANDLER    6    
#define MIME_TABLE         7    
#define LOG_SRC_LAST MIME_TABLE 


// it is in fact not unused ;-) but we can avoid some warnings declaring it this way.
__attribute__((unused))
static const char* log_src_info_tab[][2] =
  {
    {"server core", "S"},
    {"dummy", "D"},
    {"logger", "L"},
    {"configuration data", "F"},
    {"connection", "C"},
    {"protocol", "P"},
    {"requested data", "R"},
    {"mime types", "M"}
  };

#define LOG_SRC_PLACEHOLDER_ALL "A"

// severities of logging messages
#define DEBUG       0           
#define LOG_KEY_DEBUG   "d"     
#define INFO        1           
#define LOG_KEY_INFO    "i"     
#define NOTICE      2           
#define LOG_KEY_NOTICE  "n"     
#define WARNING     3           
#define LOG_KEY_WARNING "w"     
#define ERROR       4           
#define LOG_KEY_ERROR   "e"     
#define CRITICAL    5           
#define LOG_KEY_CRITICAL "c"    
#define LOG_LVL_LAST CRITICAL   

// it is in fact not unused ;-) but we can avoid some warnings declaring it this way.
__attribute__((unused))
static const char* log_lvl_info_tab[] =
  {
    LOG_KEY_DEBUG, // these are macros because that is the only way to
    LOG_KEY_INFO,  // use these values as string constants with the cpp
    LOG_KEY_NOTICE,
    LOG_KEY_WARNING,
    LOG_KEY_ERROR,
    LOG_KEY_CRITICAL
  };

#define LOG_LVL_PLACEHOLDER_ALL "a"


// predefined "log files"
#define LOG_NULL_STREAM      "no"         
#define LOG_NULL_FORMAT      "off"        
#define LOG_PANIC_FORMAT     "%h:%m:%s> %S: %L\\n" 

//MP = Mary Poppins' supercalifragelistigexpialidotious-sign ;)
#define MP '%'          

#define MP_YEAR    'Y'  
#define MP_MONTH   'M'  
#define MP_DAY     'D'  
#define MP_WDAY    'w'  
#define MP_WDAYL   'W'  
#define MP_HOUR    'h'  
#define MP_MIN     'm'  
#define MP_SEC     's'  
#define MP_SRC     'S'  
#define MP_LOG     'L'  

#define WD_SHORT 0    
#define WD_LONG  1    

__attribute__ ((unused))
static const char* day_of_week[][2] =
{
  {"Sun", "Sunday"},
  {"Mon", "Monday"},
  {"Tue", "Tueday"},
  {"Wed", "Wednesday"},
  {"Thu", "Thursday"},
  {"Fri", "Friday"},
  {"Sat", "Saturday"}
};

/**************************************************************************
 *                                                                        *
 *           functions for dealing with a single logging stream           *
 *                                                                        *
 **************************************************************************/
/*
  each logging stream is associated with exactly ONE log message source
  and ONE severity level.
 */

struct Logger;
typedef struct Logger* Logger;


Logger logInit(const char * file_name, const char* format);

Logger logInitStream(FILE * log_stream, const char* format);

int logMessagev(Logger this,
                const unsigned int origin, const unsigned int severity,
                const int errno_val, const char *const log_text_format, va_list daten);


int logTerminate(Logger this);

/**************************************************************************
 *                                                                        *
 *           functions for managing a bunch of logging streams            *
 *                                                                        *
 **************************************************************************/

int logfilesInit();

int logerr(const unsigned int source, const unsigned int severity, const int errno_val,
         const char *const log_text_format, ...);

int logger(const unsigned int origin, const unsigned int severity,
           const char *const log_text, ...);

int logfilesTerminate();

#endif

---