include/gw-log.h

   1 /*
   2  * Copyright (c) 1995, the EUROPAGATE consortium (see below).
   3  *
   4  * The EUROPAGATE consortium members are:
   5  *
   6  *    University College Dublin
   7  *    Danmarks Teknologiske Videnscenter
   8  *    An Chomhairle Leabharlanna
   9  *    Consejo Superior de Investigaciones Cientificas
  10  *
  11  * Permission to use, copy, modify, distribute, and sell this software and
  12  * its documentation, in whole or in part, for any purpose, is hereby granted,
  13  * provided that:
  14  *
  15  * 1. This copyright and permission notice appear in all copies of the
  16  * software and its documentation. Notices of copyright or attribution
  17  * which appear at the beginning of any file must remain unchanged.
  18  *
  19  * 2. The names of EUROPAGATE or the project partners may not be used to
  20  * endorse or promote products derived from this software without specific
  21  * prior written permission.
  22  *
  23  * 3. Users of this software (implementors and gateway operators) agree to
  24  * inform the EUROPAGATE consortium of their use of the software. This
  25  * information will be used to evaluate the EUROPAGATE project and the
  26  * software, and to plan further developments. The consortium may use
  27  * the information in later publications.
  28  *
  29  * 4. Users of this software agree to make their best efforts, when
  30  * documenting their use of the software, to acknowledge the EUROPAGATE
  31  * consortium, and the role played by the software in their work.
  32  *
  33  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  34  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  35  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  36  * IN NO EVENT SHALL THE EUROPAGATE CONSORTIUM OR ITS MEMBERS BE LIABLE
  37  * FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF
  38  * ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
  39  * OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND
  40  * ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
  41  * USE OR PERFORMANCE OF THIS SOFTWARE.
  42  *
  43  */
  44
  45 /*
  46  * Logging facilities.
  47  *
  48  * Europagate, 1994-1995.
  49  *
  50  * $Log: gw-log.h,v $
  51  * Revision 1.7  1995/05/16 09:39:39  adam
  52  * LICENSE.
  53  *
  54  * Revision 1.6  1995/03/30  07:32:42  adam
  55  * New log-level: GW_LOG_NOTICE. New 2709 function: iso2709_mk.
  56  *
  57  * Revision 1.5  1995/03/28  07:52:35  adam
  58  * Bug fix: Bad log masks.
  59  *
  60  * Revision 1.4  1995/03/27  12:50:40  adam
  61  * New level: GW_LOG_ERRNO.
  62  *
  63  * Revision 1.3  1995/02/23  08:32:11  adam
  64  * Changed header.
  65  *
  66  * Revision 1.1.1.1  1995/02/09  17:27:12  adam
  67  * Initial version of email gateway under CVS control.
  68  *
  69  * Initial:       Dec  7, 94 (Adam Dickmeiss)
  70  */
  71
  72 #ifndef GW_LOG_H
  73 #define GW_LOG_H
  74 /* The log level is an unsigned integer value with at least 16 bits */
  75
  76 /* The log levels are defined below */
  77 #define GW_LOG_FATAL  0x01
  78 #define GW_LOG_WARN   0x02
  79 #define GW_LOG_ACCT   0x04
  80 #define GW_LOG_STAT   0x08
  81 #define GW_LOG_ERRNO  0x10
  82 #define GW_LOG_NOTICE 0x20
  83
  84 /* All debug levels */
  85 #define GW_LOG_DEBUG 0xffc0
  86 /* Individual debug levels, x sould be in range 0-9 */
  87 #define GW_LOG_DEBUGN(x) (0x40<<(x))
  88
  89 /* All levels on / All levels except debugging */
  90 #define GW_LOG_ALL   0xffef
  91 #define GW_LOG_DEFAULT 0x2f
  92
  93 void gw_log_init (const char *app_name);
  94 /*
  95    Initialises the log-system. Application name is given by 'app_name' -
  96    could be specified as argv[0]. The application name should not
  97    contain blanks!
  98
  99    All log messages are directed to stderr on return from this function.
 100    Override this behaviour by using the gw_log_file function.
 101
 102    The log level is set to GW_LOG_DEFAULT. Override this with the
 103    gw_log_level function.
 104
 105    The session id is set to 0. Use gw_log_session to change this.
 106  */
 107
 108 void gw_log_level (unsigned level);
 109 /*
 110    Sets the log to 'level' by using the GW_LOG_xxxx masks as described
 111    above.
 112  */
 113
 114 void gw_log_session (int session);
 115 /*
 116    Sets the session id to 'session'.
 117  */
 118
 119 int gw_log_file (unsigned level, const char *fname);
 120 /*
 121    Specifies that output given by 'level' should be appended to file 'fname'.
 122    Thus, all log messages can be written to one file or several files.
 123    If 'level' is GW_LOG_ALL all output is appended to the same file.
 124    If 'fname' is NULL it means that the output is written to stderr.
 125    If 'fname' is "" it means the output is written to stdout.
 126
 127    This function returns 0 on success; -1 on failure.
 128  */
 129
 130 int gw_log (unsigned level, const char *event_type, const char *format, ...);
 131 /*
 132    Append log message to one or more files. The value of parameter
 133    'level' and the value given by the last gw_log_level call are bitwise
 134    AND'ed. This value represents the log level for this message.
 135    If this value is non-zero the 'event_type' and 'format' are used to
 136    create the log entries which are appended to the log files specified by
 137    the gw_log_file call(s).
 138
 139    The 'event_type' should not contain blanks.
 140    This function returns 0 on success; -1 on failure.
 141  */
 142
 143 char *gw_strdup (const char *s);
 144 /*
 145    Works as strdup(3s), which is not defined by ANSI.
 146  */
 147
 148
 149 /* log file format:
 150    <appname> <session> <date> <level> <type> <parameter>
 151
 152    Assuming that a 'token' is separated by one or more blanks we have:
 153
 154    <appname>   one token
 155    <session>   one token
 156    <date>      one token yymmddhhmmss
 157    <level>     one token
 158    <type>      one token
 159
 160    <parameter> zero or more tokens.
 161  */
 162 #endif