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