d06eb10755878f1974a84c58fb6cc6a8365ddcb8
[privoxy.git] / acconfig.h
1 #ifndef CONFIG_H_INCLUDED
2 #define CONFIG_H_INCLUDED
3 /*********************************************************************
4  *
5  * File        :  $Source: /cvsroot/ijbswa/current/acconfig.h,v $
6  *
7  * Purpose     :  This file should be the first thing included in every
8  *                .c file.  (Before even system headers).  It contains 
9  *                #define statements for various features.  It was
10  *                introduced because the compile command line started
11  *                getting ludicrously long with feature defines.
12  *
13  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
14  *                Privoxy team. http://www.privoxy.org/
15  *
16  *                Based on the Internet Junkbuster originally written
17  *                by and Copyright (C) 1997 Anonymous Coders and 
18  *                Junkbusters Corporation.  http://www.junkbusters.com
19  *
20  *                This program is free software; you can redistribute it 
21  *                and/or modify it under the terms of the GNU General
22  *                Public License as published by the Free Software
23  *                Foundation; either version 2 of the License, or (at
24  *                your option) any later version.
25  *
26  *                This program is distributed in the hope that it will
27  *                be useful, but WITHOUT ANY WARRANTY; without even the
28  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
29  *                PARTICULAR PURPOSE.  See the GNU General Public
30  *                License for more details.
31  *
32  *                The GNU General Public License should be included with
33  *                this file.  If not, you can view it at
34  *                http://www.gnu.org/copyleft/gpl.html
35  *                or write to the Free Software Foundation, Inc., 59
36  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
37  *
38  * Revisions   :
39  *    $Log: acconfig.h,v $
40  *    Revision 1.24  2002/04/04 00:36:36  gliptak
41  *    always use pcre for matching
42  *
43  *    Revision 1.23  2002/04/03 22:28:03  gliptak
44  *    Removed references to gnu_regex
45  *
46  *    Revision 1.22  2002/03/26 22:29:54  swa
47  *    we have a new homepage!
48  *
49  *    Revision 1.21  2002/03/24 14:31:08  swa
50  *    remove more crappy files. set RPM
51  *    release version correctly.
52  *
53  *    Revision 1.20  2002/03/24 13:46:44  swa
54  *    name change related issue.
55  *
56  *    Revision 1.19  2002/03/24 13:25:42  swa
57  *    name change related issues
58  *
59  *    Revision 1.18  2002/03/08 16:40:28  oes
60  *    Added FEATURE_NO_GIFS
61  *
62  *    Revision 1.17  2002/03/04 17:52:44  oes
63  *    Deleted PID_FILE_PATH
64  *
65  *    Revision 1.16  2002/01/10 12:36:18  oes
66  *    Moved HAVE_*_R to acconfig.h, where they belong.
67  *
68  *    Revision 1.15  2001/12/30 14:07:31  steudten
69  *    - Add signal handling (unix)
70  *    - Add SIGHUP handler (unix)
71  *    - Add creation of pidfile (unix)
72  *    - Add action 'top' in rc file (RH)
73  *    - Add entry 'SIGNALS' to manpage
74  *    - Add exit message to logfile (unix)
75  *
76  *    Revision 1.14  2001/10/23 21:24:09  jongfoster
77  *    Support for FEATURE_CGI_EDIT_ACTIONS
78  *
79  *    Revision 1.13  2001/10/07 15:30:41  oes
80  *    Removed FEATURE_DENY_GZIP
81  *
82  *    Revision 1.12  2001/09/13 19:56:37  jongfoster
83  *    Reverting to revision 1.10 - previous checking was majorly broken.
84  *
85  *    Revision 1.10  2001/07/30 22:08:36  jongfoster
86  *    Tidying up #defines:
87  *    - All feature #defines are now of the form FEATURE_xxx
88  *    - Permanently turned off WIN_GUI_EDIT
89  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
90  *
91  *    Revision 1.9  2001/07/29 19:08:52  jongfoster
92  *    Changing _CONFIG_H to CONFIG_H_INCLUDED.
93  *    Also added protection against using a MinGW32 or CygWin version of
94  *    config.h from within MS Visual C++
95  *
96  *    Revision 1.8  2001/07/29 17:09:17  jongfoster
97  *    Major changes to build system in order to fix these bugs:
98  *    - pthreads under Linux was broken - changed -lpthread to -pthread
99  *    - Compiling in MinGW32 mode under CygWin now correctly detects
100  *      which shared libraries are available
101  *    - Solaris support (?) (Not tested under Solaris yet)
102  *
103  *    Revision 1.7  2001/07/25 22:53:59  jongfoster
104  *    Will #error if pthreads is enabled under BeOs
105  *
106  *    Revision 1.6  2001/07/15 17:54:29  jongfoster
107  *    Renaming #define STATIC to STATIC_PCRE
108  *    Adding new #define FEATURE_PTHREAD that will be used to enable
109  *    POSIX threads support.
110  *
111  *    Revision 1.5  2001/07/13 13:48:37  oes
112  *     - (Fix:) Copied CODE_STATUS #define from config.h.in
113  *     - split REGEX #define into REGEX_GNU and REGEX_PCRE
114  *       and removed PCRE.
115  *       (REGEX = REGEX_GNU || REGEX_PCRE per project.h)
116  *     - Moved STATIC (for pcre) here from Makefile.in
117  *     - Introduced STATIC_PCRS #define to allow for dynaimc linking with
118  *       libpcrs
119  *     - Removed PCRS #define, since pcrs is now needed for CGI anyway
120  *
121  *    Revision 1.4  2001/05/29 09:50:24  jongfoster
122  *    Unified blocklist/imagelist/permissionslist.
123  *    File format is still under discussion, but the internal changes
124  *    are (mostly) done.
125  *
126  *    Also modified interceptor behaviour:
127  *    - We now intercept all URLs beginning with one of the following
128  *      prefixes (and *only* these prefixes):
129  *        * http://i.j.b/
130  *        * http://ijbswa.sf.net/config/
131  *        * http://ijbswa.sourceforge.net/config/
132  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
133  *    - Internal changes so that intercepted and fast redirect pages
134  *      are not replaced with an image.
135  *    - Interceptors now have the option to send a binary page direct
136  *      to the client. (i.e. ijb-send-banner uses this)
137  *    - Implemented show-url-info interceptor.  (Which is why I needed
138  *      the above interceptors changes - a typical URL is
139  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
140  *      The previous mechanism would not have intercepted that, and
141  *      if it had been intercepted then it then it would have replaced
142  *      it with an image.)
143  *
144  *    Revision 1.3  2001/05/26 01:26:34  jongfoster
145  *    New #define, WIN_GUI_EDIT, enables the (embryonic) Win32 GUI editor.
146  *    This #define cannot be set from ./configure - there's no point, it
147  *    doesn't work yet.  See feature request # 425722
148  *
149  *    Revision 1.2  2001/05/22 17:43:35  oes
150  *
151  *    - Enabled filtering banners by size rather than URL
152  *      by adding patterns that replace all standard banner
153  *      sizes with the "Junkbuster" gif to the re_filterfile
154  *
155  *    - Enabled filtering WebBugs by providing a pattern
156  *      which kills all 1x1 images
157  *
158  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
159  *      which is selected by the (nonstandard and therefore
160  *      capital) letter 'U' in the option string.
161  *      It causes the quantifiers to be ungreedy by default.
162  *      Appending a ? turns back to greedy (!).
163  *
164  *    - Added a new interceptor ijb-send-banner, which
165  *      sends back the "Junkbuster" gif. Without imagelist or
166  *      MSIE detection support, or if tinygif = 1, or the
167  *      URL isn't recognized as an imageurl, a lame HTML
168  *      explanation is sent instead.
169  *
170  *    - Added new feature, which permits blocking remote
171  *      script redirects and firing back a local redirect
172  *      to the browser.
173  *      The feature is conditionally compiled, i.e. it
174  *      can be disabled with --disable-fast-redirects,
175  *      plus it must be activated by a "fast-redirects"
176  *      line in the config file, has its own log level
177  *      and of course wants to be displayed by show-proxy-args
178  *      Note: Boy, all the #ifdefs in 1001 locations and
179  *      all the fumbling with configure.in and acconfig.h
180  *      were *way* more work than the feature itself :-(
181  *
182  *    - Because a generic redirect template was needed for
183  *      this, tinygif = 3 now uses the same.
184  *
185  *    - Moved GIFs, and other static HTTP response templates
186  *      to project.h
187  *
188  *    - Many minor fixes
189  *
190  *    - Removed some >400 CRs again (Jon, you really worked
191  *      a lot! ;-)
192  *
193  *    Revision 1.1.1.1  2001/05/15 13:58:45  oes
194  *    Initial import of version 2.9.3 source tree
195  *
196  *
197  *********************************************************************/
198 \f
199 @TOP@
200
201 /*
202  * Version number - Major (X._._)
203  */
204 #undef VERSION_MAJOR
205
206 /*
207  * Version number - Minor (_.X._)
208  */
209 #undef VERSION_MINOR
210
211 /*
212  * Version number - Point (_._.X)
213  */
214 #undef VERSION_POINT
215
216 /*
217  * Version number - RPM-release
218  */
219 #undef VERSION_RPM_PACKAGE
220
221 /*
222  * Version number, as a string
223  */
224 #undef VERSION
225
226 /*
227  * Status of the code: "alpha", "beta" or "stable".
228  */
229 #undef CODE_STATUS
230
231 /* 
232  * Should pcre be statically built in instead of linkling with libpcre?
233  * (This is determined by configure depending on the availiability of
234  * libpcre and user preferences). The name is ugly, but pcre needs it.
235  * Don't bother to change this here! Use configure instead.
236  */
237 #undef STATIC_PCRE
238
239 /* 
240  * Should pcrs be statically built in instead of linkling with libpcrs?
241  * (This is determined by configure depending on the availiability of
242  * libpcrs and user preferences).
243  * Don't bother to change this here! Use configure instead.
244  */
245 #undef STATIC_PCRS
246
247 /*
248  * Allows the use of an ACL to control access to the proxy by IP address.
249  */
250 #undef FEATURE_ACL
251
252 /*
253  * Enables the web-based configuration (actionsfile) editor.  If you
254  * have a shared proxy, you might want to turn this off.
255  */
256 #undef FEATURE_CGI_EDIT_ACTIONS
257
258 /*
259  * Allows the use of jar files to capture cookies.
260  */
261 #undef FEATURE_COOKIE_JAR
262
263 /*
264  * Locally redirect remote script-redirect URLs
265  */
266 #undef FEATURE_FAST_REDIRECTS
267
268 /*
269  * Bypass filtering for 1 page only
270  */
271 #undef FEATURE_FORCE_LOAD
272
273 /*
274  * Allow blocking using images as well as HTML.
275  * If you do not define this then everything is blocked as HTML.
276  *
277  * Note that this is required if you want to use FEATURE_IMAGE_DETECT_MSIE.
278  */
279 #undef FEATURE_IMAGE_BLOCKING
280
281 /*
282  * Detect image requests automatically for MSIE.  Will fall back to
283  * other image-detection methods (i.e. "+image" permission) for other
284  * browsers.
285  *
286  * You must also define FEATURE_IMAGE_BLOCKING to use this feature.
287  *
288  * It detects the following header pair as an image request:
289  *
290  * User-Agent: Mozilla/4.0 (compatible; MSIE 5.5; Windows NT 5.0)
291  * Accept: * / *
292  *
293  * And the following as a HTML request:
294  *
295  * User-Agent: Mozilla/4.0 (compatible; MSIE 5.5; Windows NT 5.0)
296  * Accept: image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, * / *
297  *
298  * And no, I haven't got that backwards - IE is being wierd.
299  *
300  * Known limitations: 
301  * 1) If you press shift-reload on a blocked HTML page, you get
302  *    the image "blocked" page, not the HTML "blocked" page.
303  * 2) Once an image "blocked" page has been sent, viewing it 
304  *    in it's own browser window *should* bring up the HTML
305  *    "blocked" page, but it doesn't.  You need to clear the 
306  *    browser cache to get the HTML version again.
307  *
308  * These limitations are due to IE making inconsistent choices
309  * about which "Accept:" header to send.
310  */
311 #undef FEATURE_IMAGE_DETECT_MSIE
312
313 /*
314  * Kills JavaScript popups - window.open, onunload, etc.
315  */
316 #undef FEATURE_KILL_POPUPS
317
318 /*
319  * Use PNG instead of GIF for built-in images
320  */
321 #undef FEATURE_NO_GIFS
322
323 /*
324  * Use POSIX threads instead of native threads.
325  */
326 #undef FEATURE_PTHREAD
327
328 /*
329  * Enables statistics function.
330  */
331 #undef FEATURE_STATISTICS
332
333 /*
334  * Allow Privoxy to be "disabled" so it is just a normal non-blocking
335  * non-anonymizing proxy.  This is useful if you're trying to access a
336  * blocked or broken site - just change the setting in the config file,
337  * or use the handy "Disable" menu option in the Windows GUI.
338  */
339 #undef FEATURE_TOGGLE
340
341 /*
342  * Allows the use of trust files.
343  */
344 #undef FEATURE_TRUST
345
346 /*
347  * Defined on Solaris only.  Makes the system libraries thread safe.
348  */
349 #undef _REENTRANT
350
351 /*
352  * Defined on Solaris only.  Without this, many important functions are not
353  * defined in the system headers.
354  */
355 #undef __EXTENSIONS__
356
357 /*
358  * Defined always.
359  * FIXME: Don't know what it does or why we need it.
360  * (presumably something to do with MultiThreading?)
361  */
362 #undef __MT__
363
364 /* If the (nonstandard and thread-safe) function gethostbyname_r
365  * is available, select which signature to use
366  */
367 #undef HAVE_GETHOSTBYNAME_R_6_ARGS
368 #undef HAVE_GETHOSTBYNAME_R_5_ARGS
369 #undef HAVE_GETHOSTBYNAME_R_3_ARGS
370
371 /* If the (nonstandard and thread-safe) function gethostbyaddr_r
372  * is available, select which signature to use
373  */
374 #undef HAVE_GETHOSTBYADDR_R_8_ARGS
375 #undef HAVE_GETHOSTBYADDR_R_7_ARGS
376 #undef HAVE_GETHOSTBYADDR_R_5_ARGS
377
378 /* Define if you have gmtime_r and localtime_r with a signature
379  * of (struct time *, struct tm *)
380  */
381 #undef HAVE_GMTIME_R
382 #undef HAVE_LOCALTIME_R
383
384 @BOTTOM@
385
386 /*
387  * Defined always.
388  * FIXME: Don't know what it does or why we need it.
389  * (presumably something to do with ANSI Standard C?)
390  */
391 #ifndef __STDC__
392 #define __STDC__ 1
393 #endif /* ndef __STDC__ */
394
395 /*
396  * Need to set up this define only for the Pthreads library for
397  * Win32, available from http://sources.redhat.com/pthreads-win32/
398  */
399 #if defined(FEATURE_PTHREAD) && defined(_WIN32)
400 #define __CLEANUP_C
401 #endif /* defined(FEATURE_PTHREAD) && defined(_WIN32) */
402
403 /*
404  * BEOS does not currently support POSIX threads.
405  * This *should* be detected by ./configure, but let's be sure.
406  */
407 #if defined(FEATURE_PTHREAD) && defined(__BEOS__)
408 #error BEOS does not support pthread - please run ./configure again with "--disable-pthread"
409
410 #endif /* defined(FEATURE_PTHREAD) && defined(__BEOS__) */
411
412
413 /*
414  * It's too easy to accidentally use a Cygwin or MinGW32 version of config.h
415  * under VC++, and it usually gives many wierd error messages.  Let's make
416  * the error messages understandable, by bailing out now.
417  */
418 #ifdef _MSC_VER
419 #error For MS VC++, please use vc_config_winthreads.h or vc_config_pthreads.h.  You can usually do this by selecting the "Build", "Clean" menu option.
420 #endif /* def _MSC_VER */
421
422 #endif /* CONFIG_H_INCLUDED */