- Don't mistake VC++'s _snprintf() for a snprintf() replacement.
[privoxy.git] / errlog.h
1 #ifndef ERRLOG_H_INCLUDED
2 #define ERRLOG_H_INCLUDED
3 #define ERRLOG_H_VERSION "$Id: errlog.h,v 1.16 2006/11/28 15:29:50 fabiankeil Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/errlog.h,v $
7  *
8  * Purpose     :  Log errors to a designated destination in an elegant,
9  *                printf-like fashion.
10  *
11  * Copyright   :  Written by and Copyright (C) 2001-2007 the SourceForge
12  *                Privoxy team. http://www.privoxy.org/
13  *
14  *                Based on the Internet Junkbuster originally written
15  *                by and Copyright (C) 1997 Anonymous Coders and 
16  *                Junkbusters Corporation.  http://www.junkbusters.com
17  *
18  *                This program is free software; you can redistribute it 
19  *                and/or modify it under the terms of the GNU General
20  *                Public License as published by the Free Software
21  *                Foundation; either version 2 of the License, or (at
22  *                your option) any later version.
23  *
24  *                This program is distributed in the hope that it will
25  *                be useful, but WITHOUT ANY WARRANTY; without even the
26  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
27  *                PARTICULAR PURPOSE.  See the GNU General Public
28  *                License for more details.
29  *
30  *                The GNU General Public License should be included with
31  *                this file.  If not, you can view it at
32  *                http://www.gnu.org/copyleft/gpl.html
33  *                or write to the Free Software Foundation, Inc., 59
34  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
35  *
36  * Revisions   :
37  *    $Log: errlog.h,v $
38  *    Revision 1.16  2006/11/28 15:29:50  fabiankeil
39  *    Define LOG_LEVEL_REDIRECTS independently of
40  *    FEATURE_FAST_REDIRECTS. It is used by redirect{}
41  *    as well.
42  *
43  *    Revision 1.15  2006/07/18 14:48:46  david__schmidt
44  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
45  *    with what was really the latest development (the v_3_0_branch branch)
46  *
47  *    Revision 1.13.2.1  2002/08/05 17:57:06  oes
48  *    Cosmetic change
49  *
50  *    Revision 1.13  2002/03/26 22:29:54  swa
51  *    we have a new homepage!
52  *
53  *    Revision 1.12  2002/03/24 13:25:43  swa
54  *    name change related issues
55  *
56  *    Revision 1.11  2002/03/06 23:02:57  jongfoster
57  *    Removing tabs
58  *
59  *    Revision 1.10  2001/09/13 20:08:06  jongfoster
60  *    Adding support for LOG_LEVEL_CGI
61  *
62  *    Revision 1.9  2001/07/30 22:08:36  jongfoster
63  *    Tidying up #defines:
64  *    - All feature #defines are now of the form FEATURE_xxx
65  *    - Permanently turned off WIN_GUI_EDIT
66  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
67  *
68  *    Revision 1.8  2001/07/29 18:43:08  jongfoster
69  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
70  *    ANSI C rules.
71  *
72  *    Revision 1.7  2001/07/19 19:02:53  haroon
73  *    Added define for LOG_LEVEL_POPUPS
74  *
75  *    Revision 1.6  2001/07/13 13:59:22  oes
76  *     - Added LOG_LEVEL_DEANIMATE
77  *     - Changed LOG_LEVEL_CLF
78  *     - Removed all #ifdef PCRS
79  *
80  *    Revision 1.5  2001/05/26 17:25:14  jongfoster
81  *    Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
82  *
83  *    Revision 1.4  2001/05/25 21:56:06  jongfoster
84  *    Added FIXME comment to (broken) LOG_LEVEL_LOG
85  *
86  *    Revision 1.3  2001/05/22 18:46:04  oes
87  *
88  *    - Enabled filtering banners by size rather than URL
89  *      by adding patterns that replace all standard banner
90  *      sizes with the "Junkbuster" gif to the re_filterfile
91  *
92  *    - Enabled filtering WebBugs by providing a pattern
93  *      which kills all 1x1 images
94  *
95  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
96  *      which is selected by the (nonstandard and therefore
97  *      capital) letter 'U' in the option string.
98  *      It causes the quantifiers to be ungreedy by default.
99  *      Appending a ? turns back to greedy (!).
100  *
101  *    - Added a new interceptor ijb-send-banner, which
102  *      sends back the "Junkbuster" gif. Without imagelist or
103  *      MSIE detection support, or if tinygif = 1, or the
104  *      URL isn't recognized as an imageurl, a lame HTML
105  *      explanation is sent instead.
106  *
107  *    - Added new feature, which permits blocking remote
108  *      script redirects and firing back a local redirect
109  *      to the browser.
110  *      The feature is conditionally compiled, i.e. it
111  *      can be disabled with --disable-fast-redirects,
112  *      plus it must be activated by a "fast-redirects"
113  *      line in the config file, has its own log level
114  *      and of course wants to be displayed by show-proxy-args
115  *      Note: Boy, all the #ifdefs in 1001 locations and
116  *      all the fumbling with configure.in and acconfig.h
117  *      were *way* more work than the feature itself :-(
118  *
119  *    - Because a generic redirect template was needed for
120  *      this, tinygif = 3 now uses the same.
121  *
122  *    - Moved GIFs, and other static HTTP response templates
123  *      to project.h
124  *
125  *    - Some minor fixes
126  *
127  *    - Removed some >400 CRs again (Jon, you really worked
128  *      a lot! ;-)
129  *
130  *    Revision 1.2  2001/05/20 01:11:40  jongfoster
131  *    Added support for LOG_LEVEL_FATAL
132  *    Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
133  *    and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
134  *
135  *    Revision 1.1.1.1  2001/05/15 13:58:51  oes
136  *    Initial import of version 2.9.3 source tree
137  *
138  *
139  *********************************************************************/
140 \f
141
142 #ifdef __cplusplus
143 extern "C" {
144 #endif
145
146 /* Debug level for errors */
147
148 #define LOG_LEVEL_GPC        0x0001
149 #define LOG_LEVEL_CONNECT    0x0002
150 #define LOG_LEVEL_IO         0x0004
151 #define LOG_LEVEL_HEADER     0x0008
152 #define LOG_LEVEL_LOG        0x0010
153 #ifdef FEATURE_FORCE_LOAD
154 #define LOG_LEVEL_FORCE      0x0020
155 #endif /* def FEATURE_FORCE_LOAD */
156 #define LOG_LEVEL_RE_FILTER  0x0040
157 #define LOG_LEVEL_REDIRECTS  0x0080
158 #define LOG_LEVEL_DEANIMATE  0x0100
159
160 #define LOG_LEVEL_CLF        0x0200 /* Common Log File format */
161 #ifdef FEATURE_KILL_POPUPS
162 #define LOG_LEVEL_POPUPS     0x0400 /* Kill Popups */
163 #endif /* def FEATURE_KILL_POPUPS */
164
165 #define LOG_LEVEL_CGI        0x0800 /* CGI / templates */
166
167 /* Following are always on: */
168 #define LOG_LEVEL_INFO    0x1000
169 #define LOG_LEVEL_ERROR   0x2000
170 #define LOG_LEVEL_FATAL   0x4000 /* Exits after writing log */
171
172 extern void init_error_log(const char *prog_name, const char *logfname, int debuglevel);
173 extern void log_error(int loglevel, const char *fmt, ...);
174
175 /* Revision control strings from this header and associated .c file */
176 extern const char errlog_rcs[];
177 extern const char errlog_h_rcs[];
178
179 #ifdef __cplusplus
180 } /* extern "C" */
181 #endif
182
183 #endif /* ndef ERRLOG_H_INCLUDED */
184
185 /*
186   Local Variables:
187   tab-width: 3
188   end:
189 */
190