2 * Copyright (c) 1995, the EUROPAGATE consortium (see below).
4 * The EUROPAGATE consortium members are:
6 * University College Dublin
7 * Danmarks Teknologiske Videnscenter
8 * An Chomhairle Leabharlanna
9 * Consejo Superior de Investigaciones Cientificas
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,
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.
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.
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.
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.
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.
48 * Europagate, 1994-1995.
51 * Revision 1.8 1995/12/01 12:24:14 adam
52 * New function: gw_log_mask_str.
54 * Revision 1.7 1995/05/16 09:39:39 adam
57 * Revision 1.6 1995/03/30 07:32:42 adam
58 * New log-level: GW_LOG_NOTICE. New 2709 function: iso2709_mk.
60 * Revision 1.5 1995/03/28 07:52:35 adam
61 * Bug fix: Bad log masks.
63 * Revision 1.4 1995/03/27 12:50:40 adam
64 * New level: GW_LOG_ERRNO.
66 * Revision 1.3 1995/02/23 08:32:11 adam
69 * Revision 1.1.1.1 1995/02/09 17:27:12 adam
70 * Initial version of email gateway under CVS control.
72 * Initial: Dec 7, 94 (Adam Dickmeiss)
77 /* The log level is an unsigned integer value with at least 16 bits */
79 /* The log levels are defined below */
80 #define GW_LOG_FATAL 0x01
81 #define GW_LOG_WARN 0x02
82 #define GW_LOG_ACCT 0x04
83 #define GW_LOG_STAT 0x08
84 #define GW_LOG_ERRNO 0x10
85 #define GW_LOG_NOTICE 0x20
87 /* All debug levels */
88 #define GW_LOG_DEBUG 0xffc0
89 /* Individual debug levels, x sould be in range 0-9 */
90 #define GW_LOG_DEBUGN(x) (0x40<<(x))
92 /* All levels on / All levels except debugging */
93 #define GW_LOG_ALL 0xffef
94 #define GW_LOG_DEFAULT 0x2f
96 void gw_log_init (const char *app_name);
98 Initialises the log-system. Application name is given by 'app_name' -
99 could be specified as argv[0]. The application name should not
102 All log messages are directed to stderr on return from this function.
103 Override this behaviour by using the gw_log_file function.
105 The log level is set to GW_LOG_DEFAULT. Override this with the
106 gw_log_level function.
108 The session id is set to 0. Use gw_log_session to change this.
111 void gw_log_level (unsigned level);
113 Sets the log to 'level' by using the GW_LOG_xxxx masks as described
117 void gw_log_session (int session);
119 Sets the session id to 'session'.
122 int gw_log_file (unsigned level, const char *fname);
124 Specifies that output given by 'level' should be appended to file 'fname'.
125 Thus, all log messages can be written to one file or several files.
126 If 'level' is GW_LOG_ALL all output is appended to the same file.
127 If 'fname' is NULL it means that the output is written to stderr.
128 If 'fname' is "" it means the output is written to stdout.
130 This function returns 0 on success; -1 on failure.
133 int gw_log (unsigned level, const char *event_type, const char *format, ...);
135 Append log message to one or more files. The value of parameter
136 'level' and the value given by the last gw_log_level call are bitwise
137 AND'ed. This value represents the log level for this message.
138 If this value is non-zero the 'event_type' and 'format' are used to
139 create the log entries which are appended to the log files specified by
140 the gw_log_file call(s).
142 The 'event_type' should not contain blanks.
143 This function returns 0 on success; -1 on failure.
146 unsigned gw_log_mask_str (const char *str);
148 Return the log level corresponding to str.
149 str is a comma separated sequence of tokens. A token is one of:
150 "all", "default", "def", "fatal", "warn", "stat", "debug", "none"
151 or "debug"<n> where n is 0..9.
152 The level of each token are ORed with initial level being GW_LOG_DEFAULT
153 unless first token is "none" in which case the initial level is 0 (none).
157 char *gw_strdup (const char *s);
159 Works as strdup(3s), which is not defined by ANSI.
164 <appname> <session> <date> <level> <type> <parameter>
166 Assuming that a 'token' is separated by one or more blanks we have:
170 <date> one token yymmddhhmmss
174 <parameter> zero or more tokens.