Nit
[privoxy.git] / errlog.h
1 #ifndef ERRLOG_H_INCLUDED
2 #define ERRLOG_H_INCLUDED
3 #define ERRLOG_H_VERSION "$Id: errlog.h,v 1.12 2002/03/24 13:25:43 swa 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 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.12  2002/03/24 13:25:43  swa
39  *    name change related issues
40  *
41  *    Revision 1.11  2002/03/06 23:02:57  jongfoster
42  *    Removing tabs
43  *
44  *    Revision 1.10  2001/09/13 20:08:06  jongfoster
45  *    Adding support for LOG_LEVEL_CGI
46  *
47  *    Revision 1.9  2001/07/30 22:08:36  jongfoster
48  *    Tidying up #defines:
49  *    - All feature #defines are now of the form FEATURE_xxx
50  *    - Permanently turned off WIN_GUI_EDIT
51  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
52  *
53  *    Revision 1.8  2001/07/29 18:43:08  jongfoster
54  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
55  *    ANSI C rules.
56  *
57  *    Revision 1.7  2001/07/19 19:02:53  haroon
58  *    Added define for LOG_LEVEL_POPUPS
59  *
60  *    Revision 1.6  2001/07/13 13:59:22  oes
61  *     - Added LOG_LEVEL_DEANIMATE
62  *     - Changed LOG_LEVEL_CLF
63  *     - Removed all #ifdef PCRS
64  *
65  *    Revision 1.5  2001/05/26 17:25:14  jongfoster
66  *    Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
67  *
68  *    Revision 1.4  2001/05/25 21:56:06  jongfoster
69  *    Added FIXME comment to (broken) LOG_LEVEL_LOG
70  *
71  *    Revision 1.3  2001/05/22 18:46:04  oes
72  *
73  *    - Enabled filtering banners by size rather than URL
74  *      by adding patterns that replace all standard banner
75  *      sizes with the "Junkbuster" gif to the re_filterfile
76  *
77  *    - Enabled filtering WebBugs by providing a pattern
78  *      which kills all 1x1 images
79  *
80  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
81  *      which is selected by the (nonstandard and therefore
82  *      capital) letter 'U' in the option string.
83  *      It causes the quantifiers to be ungreedy by default.
84  *      Appending a ? turns back to greedy (!).
85  *
86  *    - Added a new interceptor ijb-send-banner, which
87  *      sends back the "Junkbuster" gif. Without imagelist or
88  *      MSIE detection support, or if tinygif = 1, or the
89  *      URL isn't recognized as an imageurl, a lame HTML
90  *      explanation is sent instead.
91  *
92  *    - Added new feature, which permits blocking remote
93  *      script redirects and firing back a local redirect
94  *      to the browser.
95  *      The feature is conditionally compiled, i.e. it
96  *      can be disabled with --disable-fast-redirects,
97  *      plus it must be activated by a "fast-redirects"
98  *      line in the config file, has its own log level
99  *      and of course wants to be displayed by show-proxy-args
100  *      Note: Boy, all the #ifdefs in 1001 locations and
101  *      all the fumbling with configure.in and acconfig.h
102  *      were *way* more work than the feature itself :-(
103  *
104  *    - Because a generic redirect template was needed for
105  *      this, tinygif = 3 now uses the same.
106  *
107  *    - Moved GIFs, and other static HTTP response templates
108  *      to project.h
109  *
110  *    - Some minor fixes
111  *
112  *    - Removed some >400 CRs again (Jon, you really worked
113  *      a lot! ;-)
114  *
115  *    Revision 1.2  2001/05/20 01:11:40  jongfoster
116  *    Added support for LOG_LEVEL_FATAL
117  *    Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
118  *    and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
119  *
120  *    Revision 1.1.1.1  2001/05/15 13:58:51  oes
121  *    Initial import of version 2.9.3 source tree
122  *
123  *
124  *********************************************************************/
125 \f
126
127 #ifdef __cplusplus
128 extern "C" {
129 #endif
130
131 /* Debug level for errors */
132
133 #define LOG_LEVEL_GPC        0x0001
134 #define LOG_LEVEL_CONNECT    0x0002
135 #define LOG_LEVEL_IO         0x0004
136 #define LOG_LEVEL_HEADER     0x0008
137 #define LOG_LEVEL_LOG        0x0010
138 #ifdef FEATURE_FORCE_LOAD
139 #define LOG_LEVEL_FORCE      0x0020
140 #endif /* def FEATURE_FORCE_LOAD */
141 #define LOG_LEVEL_RE_FILTER  0x0040
142 #ifdef FEATURE_FAST_REDIRECTS
143 #define LOG_LEVEL_REDIRECTS  0x0080
144 #endif /* def FEATURE_FAST_REDIRECTS */
145 #define LOG_LEVEL_DEANIMATE  0x0100
146
147 #define LOG_LEVEL_CLF        0x0200 /* Common Log File format */
148 #ifdef FEATURE_KILL_POPUPS
149 #define LOG_LEVEL_POPUPS     0x0400 /* Kill Popups */
150 #endif /* def FEATURE_KILL_POPUPS */
151
152 #define LOG_LEVEL_CGI   0x0800 /* CGI / templates */
153
154 /* Following are always on: */
155 #define LOG_LEVEL_INFO    0x1000
156 #define LOG_LEVEL_ERROR   0x2000
157 #define LOG_LEVEL_FATAL   0x4000 /* Exits after writing log */
158
159 extern void init_error_log(const char *prog_name, const char *logfname, int debuglevel);
160 extern void log_error(int loglevel, char *fmt, ...);
161
162 /* Revision control strings from this header and associated .c file */
163 extern const char errlog_rcs[];
164 extern const char errlog_h_rcs[];
165
166 #ifdef __cplusplus
167 } /* extern "C" */
168 #endif
169
170 #endif /* ndef ERRLOG_H_INCLUDED */
171
172 /*
173   Local Variables:
174   tab-width: 3
175   end:
176 */
177