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