ccd29f30d0f4e6260e49d3702c0c00c0a0fc379f
[privoxy.git] / project.h
1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 /** Version string. */
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.132 2009/04/17 11:45:19 fabiankeil Exp $"
5 /*********************************************************************
6  *
7  * File        :  $Source: /cvsroot/ijbswa/current/project.h,v $
8  *
9  * Purpose     :  Defines data structures which are widely used in the
10  *                project.  Does not define any variables or functions
11  *                (though it does declare some macros).
12  *
13  * Copyright   :  Written by and Copyright (C) 2001-2009 the
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: project.h,v $
40  *    Revision 1.132  2009/04/17 11:45:19  fabiankeil
41  *    Replace HAVE_GETADDRINFO and HAVE_GETNAMEINFO macros
42  *    with HAVE_RFC2553 macro. Original patch by Petr Pisar.
43  *
44  *    Revision 1.131  2009/04/17 11:34:35  fabiankeil
45  *    Style cosmetics for the IPv6 code.
46  *
47  *    Revision 1.130  2009/04/17 11:27:49  fabiankeil
48  *    Petr Pisar's privoxy-3.0.12-ipv6-3.diff.
49  *
50  *    Revision 1.129  2009/03/08 14:12:51  fabiankeil
51  *    All the CSP_FLAG_FOO bit masks should be unsigned ints.
52  *
53  *    Revision 1.128  2009/03/07 13:09:17  fabiankeil
54  *    Change csp->expected_content and_csp->expected_content_length from
55  *    size_t to unsigned long long to reduce the likelihood of integer
56  *    overflows that would let us close the connection prematurely.
57  *    Bug found while investigating #2669131, reported by cyberpatrol.
58  *
59  *    Revision 1.127  2008/12/20 14:53:55  fabiankeil
60  *    Add config option socket-timeout to control the time
61  *    Privoxy waits for data to arrive on a socket. Useful
62  *    in case of stale ssh tunnels or when fuzz-testing.
63  *
64  *    Revision 1.126  2008/12/14 17:02:54  fabiankeil
65  *    Fix a cparser warning.
66  *
67  *    Revision 1.125  2008/11/20 08:22:28  fabiankeil
68  *    Remove an obsolete comment.
69  *
70  *    Revision 1.124  2008/11/16 12:43:49  fabiankeil
71  *    Turn keep-alive support into a runtime feature
72  *    that is disabled by setting keep-alive-timeout
73  *    to a negative value.
74  *
75  *    Revision 1.123  2008/11/10 16:55:59  fabiankeil
76  *    Fix a gcc44 warning (in filters.c).
77  *
78  *    Revision 1.122  2008/10/16 07:11:34  fabiankeil
79  *    Fix a bunch of gcc44 conversion warnings.
80  *
81  *    Revision 1.121  2008/10/09 18:21:41  fabiankeil
82  *    Flush work-in-progress changes to keep outgoing connections
83  *    alive where possible. Incomplete and mostly #ifdef'd out.
84  *
85  *    Revision 1.120  2008/09/21 13:36:52  fabiankeil
86  *    If change-x-forwarded-for{add} is used and the client
87  *    sends multiple X-Forwarded-For headers, append the client's
88  *    IP address to each one of them. "Traditionally" we would
89  *    lose all but the last one.
90  *
91  *    Revision 1.119  2008/09/20 10:04:33  fabiankeil
92  *    Remove hide-forwarded-for-headers action which has
93  *    been obsoleted by change-x-forwarded-for{block}.
94  *
95  *    Revision 1.118  2008/09/19 15:26:29  fabiankeil
96  *    Add change-x-forwarded-for{} action to block or add
97  *    X-Forwarded-For headers. Mostly based on code removed
98  *    before 3.0.7.
99  *
100  *    Revision 1.117  2008/08/30 12:03:07  fabiankeil
101  *    Remove FEATURE_COOKIE_JAR.
102  *
103  *    Revision 1.116  2008/05/20 16:05:02  fabiankeil
104  *    Move parsers structure definition from project.h to parsers.h.
105  *
106  *    Revision 1.115  2008/05/19 16:57:20  fabiankeil
107  *    Declare all members of the parsers structure immutable.
108  *
109  *    Revision 1.114  2008/04/11 16:35:39  fabiankeil
110  *    Oops, I forgot to shorten the URL_SPEC_INITIALIZER in my last commit.
111  *
112  *    Revision 1.113  2008/04/10 14:41:04  fabiankeil
113  *    Ditch url_spec's path member now that it's no longer used.
114  *
115  *    Revision 1.112  2008/04/06 15:18:34  fabiankeil
116  *    Oh well, rename the --enable-pcre-host-patterns option to
117  *    --enable-extended-host-patterns as it's not really PCRE syntax.
118  *
119  *    Revision 1.111  2008/04/06 14:54:26  fabiankeil
120  *    Use PCRE syntax in host patterns when configured
121  *    with --enable-pcre-host-patterns.
122  *
123  *    Revision 1.110  2008/03/29 12:13:46  fabiankeil
124  *    Remove send-wafer and send-vanilla-wafer actions.
125  *
126  *    Revision 1.109  2008/03/28 15:13:41  fabiankeil
127  *    Remove inspect-jpegs action.
128  *
129  *    Revision 1.108  2008/03/27 18:27:36  fabiankeil
130  *    Remove kill-popups action.
131  *
132  *    Revision 1.107  2008/03/26 18:07:08  fabiankeil
133  *    Add hostname directive. Closes PR#1918189.
134  *
135  *    Revision 1.106  2008/03/24 11:21:03  fabiankeil
136  *    Share the action settings for multiple patterns in the same
137  *    section so we waste less memory for gigantic block lists
138  *    (and load them slightly faster). Reported by Franz Schwartau.
139  *
140  *    Revision 1.105  2008/03/21 11:16:27  fabiankeil
141  *    Garbage-collect csp->my_ip_addr_str and csp->my_hostname.
142  *
143  *    Revision 1.104  2008/03/04 18:30:40  fabiankeil
144  *    Remove the treat-forbidden-connects-like-blocks action. We now
145  *    use the "blocked" page for forbidden CONNECT requests by default.
146  *
147  *    Revision 1.103  2008/03/01 14:00:45  fabiankeil
148  *    Let the block action take the reason for the block
149  *    as argument and show it on the "blocked" page.
150  *
151  *    Revision 1.102  2008/02/03 13:46:14  fabiankeil
152  *    Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
153  *
154  *    Revision 1.101  2007/12/07 18:29:23  fabiankeil
155  *    Remove now-obsolete csp member x_forwarded.
156  *
157  *    Revision 1.100  2007/09/02 13:42:11  fabiankeil
158  *    - Allow port lists in url patterns.
159  *    - Ditch unused url_spec member pathlen.
160  *
161  *    Revision 1.99  2007/07/21 11:51:36  fabiankeil
162  *    As Hal noticed, checking dispatch_cgi() as the last cruncher
163  *    looks like a bug if CGI requests are blocked unintentionally,
164  *    so don't do it unless the user enabled the new config option
165  *    "allow-cgi-request-crunching".
166  *
167  *    Revision 1.98  2007/07/14 07:31:26  fabiankeil
168  *    Add new csp->content_type flag (CT_DECLARED).
169  *
170  *    Revision 1.97  2007/05/27 12:38:08  fabiankeil
171  *    - Remove some left-overs from the switch to dedicated header filters.
172  *    - Adjust "X-Filter: No" to disable dedicated header filters.
173  *    - Prepare for forward-override{}
174  *
175  *    Revision 1.96  2007/05/14 10:41:15  fabiankeil
176  *    Ditch the csp member cookie_list[] which isn't used anymore.
177  *
178  *    Revision 1.95  2007/04/30 15:02:19  fabiankeil
179  *    Introduce dynamic pcrs jobs that can resolve variables.
180  *
181  *    Revision 1.94  2007/04/15 16:39:21  fabiankeil
182  *    Introduce tags as alternative way to specify which
183  *    actions apply to a request. At the moment tags can be
184  *    created based on client and server headers.
185  *
186  *    Revision 1.93  2007/03/20 15:16:34  fabiankeil
187  *    Use dedicated header filter actions instead of abusing "filter".
188  *    Replace "filter-client-headers" and "filter-client-headers"
189  *    with "server-header-filter" and "client-header-filter".
190  *
191  *    Revision 1.92  2007/03/17 15:20:05  fabiankeil
192  *    New config option: enforce-blocks.
193  *
194  *    Revision 1.91  2007/03/05 13:28:03  fabiankeil
195  *    Add some CSP_FLAGs for the header parsers.
196  *
197  *    Revision 1.90  2007/02/07 10:36:16  fabiankeil
198  *    Add new http_response member to save
199  *    the reason why the response was generated.
200  *
201  *    Revision 1.89  2007/01/27 13:09:16  fabiankeil
202  *    Add new config option "templdir" to
203  *    change the templates directory.
204  *
205  *    Revision 1.88  2007/01/25 13:36:59  fabiankeil
206  *    Add csp->error_message for failure reasons
207  *    that should be embedded into the CGI pages.
208  *
209  *    Revision 1.87  2007/01/01 19:36:37  fabiankeil
210  *    Integrate a modified version of Wil Mahan's
211  *    zlib patch (PR #895531).
212  *
213  *    Revision 1.86  2006/12/31 17:56:37  fabiankeil
214  *    Added config option accept-intercepted-requests
215  *    and disabled it by default.
216  *
217  *    Revision 1.85  2006/12/31 15:03:31  fabiankeil
218  *    Fix gcc43 compiler warnings and a comment.
219  *
220  *    Revision 1.84  2006/12/21 12:57:48  fabiankeil
221  *    Add config option "split-large-forms"
222  *    to work around the browser bug reported
223  *    in BR #1570678.
224  *
225  *    Revision 1.83  2006/12/06 19:26:29  fabiankeil
226  *    Moved HTTP snipplets into jcc.c. They aren't
227  *    used anywhere else.
228  *
229  *    Revision 1.82  2006/09/20 15:50:31  fabiankeil
230  *    Doubled size of HOSTENT_BUFFER_SIZE to mask
231  *    problems with gethostbyname_r and some
232  *    /etc/hosts configurations. Only a workaround
233  *    until we get the real fix ready.
234  *    Thanks FĂ©lix Rauch for reporting.
235  *
236  *    Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
237  *
238  *    Revision 1.81  2006/09/06 13:03:04  fabiankeil
239  *    Respond with 400 and a short text message
240  *    if the client tries to use Privoxy as FTP proxy.
241  *
242  *    Revision 1.80  2006/09/06 10:43:32  fabiankeil
243  *    Added config option enable-remote-http-toggle
244  *    to specify if Privoxy should recognize special
245  *    headers (currently only X-Filter) to change its
246  *    behaviour. Disabled by default.
247  *
248  *    Revision 1.79  2006/09/06 09:23:37  fabiankeil
249  *    Make number of retries in case of forwarded-connect problems
250  *    a config file option (forwarded-connect-retries) and use 0 as
251  *    default.
252  *
253  *    Revision 1.78  2006/08/31 16:25:06  fabiankeil
254  *    Work around a buffer overflow that caused Privoxy to
255  *    segfault if too many trusted referrers were used. Good
256  *    enough for now, but should be replaced with a real
257  *    solution after the next release.
258  *
259  *    Revision 1.77  2006/08/21 12:50:51  david__schmidt
260  *    Formatting cleanup
261  *
262  *    Revision 1.76  2006/08/14 08:25:19  fabiankeil
263  *    Split filter-headers{} into filter-client-headers{}
264  *    and filter-server-headers{}.
265  *    Added parse_header_time() to share some code.
266  *    Replaced timegm() with mktime().
267  *
268  *    Revision 1.75  2006/08/03 02:46:41  david__schmidt
269  *    Incorporate Fabian Keil's patch work:\r *    http://www.fabiankeil.de/sourcecode/privoxy/
270  *
271  *    Revision 1.74  2006/07/18 14:48:47  david__schmidt
272  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
273  *    with what was really the latest development (the v_3_0_branch branch)
274  *
275  *    Revision 1.72.2.7  2006/01/29 23:10:56  david__schmidt
276  *    Multiple filter file support
277  *
278  *    Revision 1.72.2.6  2004/10/03 12:53:46  david__schmidt
279  *    Add the ability to check jpeg images for invalid
280  *    lengths of comment blocks.  Defensive strategy
281  *    against the exploit:
282  *       Microsoft Security Bulletin MS04-028
283  *       Buffer Overrun in JPEG Processing (GDI+) Could
284  *       Allow Code Execution (833987)
285  *    Enabled with +inspect-jpegs in actions files.
286  *
287  *    Revision 1.72.2.5  2004/01/30 15:29:29  oes
288  *    Updated the copyright note
289  *
290  *    Revision 1.72.2.4  2004/01/13 16:12:14  oes
291  *    Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
292  *
293  *    Revision 1.72.2.3  2003/03/11 11:54:37  oes
294  *    Introduced RC_FLAG_* flags for use in child process return code
295  *
296  *    Revision 1.72.2.2  2002/11/28 18:15:44  oes
297  *    Added flag to each cgi_dispatcher that allows or denies
298  *    external linking and removed const qualifier from
299  *    struct list_entry.str.
300  *
301  *    Revision 1.72.2.1  2002/08/10 11:25:18  oes
302  *    - Include config.h for access to config data
303  *    - Include <pcre*.h> depending on where they are
304  *
305  *    Revision 1.72  2002/05/14 21:35:49  oes
306  *    Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
307  *    because of split in user-manual
308  *
309  *    Revision 1.71  2002/05/12 21:39:36  jongfoster
310  *    - Adding Doxygen-style comments to structures and #defines.
311  *
312  *    Revision 1.70  2002/05/12 16:05:50  jongfoster
313  *    Fixing ACTION_MASK_ALL to be unsigned long rather than
314  *    just unsigned int.  I don't know if anyone is porting
315  *    Privoxy to 16-bit platforms, but if so, +limit-connect
316  *    wouldn't have worked because of this bug.
317  *
318  *    Revision 1.69  2002/05/08 16:00:16  oes
319  *    Added size member to struct iob, so it can
320  *    be alloced larger than needed.
321  *
322  *    Revision 1.68  2002/04/26 12:56:00  oes
323  *    Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
324  *
325  *    Revision 1.67  2002/04/24 02:12:43  oes
326  *     - Jon's multiple AF patch:
327  *       - Make csp->actions_list an array
328  *       - #define MAX_AF_FILES
329  *     - Moved CGI_PARAM_LEN_MAX (500) here
330  *
331  *    Revision 1.66  2002/04/15 19:06:43  jongfoster
332  *    Typos
333  *
334  *    Revision 1.65  2002/04/04 00:36:36  gliptak
335  *    always use pcre for matching
336  *
337  *    Revision 1.64  2002/04/03 22:28:03  gliptak
338  *    Removed references to gnu_regex
339  *
340  *    Revision 1.63  2002/03/31 17:19:00  jongfoster
341  *    Win32 only: Enabling STRICT to fix a VC++ compile warning.
342  *
343  *    Revision 1.62  2002/03/26 22:48:49  swa
344  *    new homepage url
345  *
346  *    Revision 1.61  2002/03/26 22:29:55  swa
347  *    we have a new homepage!
348  *
349  *    Revision 1.60  2002/03/24 15:52:17  jongfoster
350  *    Changing CGI URL prefixes for new name
351  *
352  *    Revision 1.59  2002/03/24 15:23:33  jongfoster
353  *    Name changes
354  *
355  *    Revision 1.58  2002/03/24 13:25:43  swa
356  *    name change related issues
357  *
358  *    Revision 1.57  2002/03/16 20:28:34  oes
359  *    Added descriptions to the filters so users will know what they select in the cgi editor
360  *
361  *    Revision 1.56  2002/03/13 20:27:30  oes
362  *    Fixing bug with CT_TABOO
363  *
364  *    Revision 1.55  2002/03/12 01:42:50  oes
365  *    Introduced modular filters
366  *
367  *    Revision 1.54  2002/03/09 20:03:52  jongfoster
368  *    - Making various functions return int rather than size_t.
369  *      (Undoing a recent change).  Since size_t is unsigned on
370  *      Windows, functions like read_socket that return -1 on
371  *      error cannot return a size_t.
372  *
373  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
374  *      crashes, and also frequently caused JB to jump to 100%
375  *      CPU and stay there.  (Because it thought it had just
376  *      read ((unsigned)-1) == 4Gb of data...)
377  *
378  *    - The signature of write_socket has changed, it now simply
379  *      returns success=0/failure=nonzero.
380  *
381  *    - Trying to get rid of a few warnings --with-debug on
382  *      Windows, I've introduced a new type "jb_socket".  This is
383  *      used for the socket file descriptors.  On Windows, this
384  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
385  *      an int.  The error value can't be -1 any more, so it's
386  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
387  *      Windows it maps to the #define INVALID_SOCKET.)
388  *
389  *    - The signature of bind_port has changed.
390  *
391  *    Revision 1.53  2002/03/08 16:48:55  oes
392  *    Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
393  *
394  *    Revision 1.52  2002/03/07 03:46:17  oes
395  *    Fixed compiler warnings
396  *
397  *    Revision 1.51  2002/03/05 04:52:42  oes
398  *    Deleted non-errlog debugging code
399  *
400  *    Revision 1.50  2002/03/04 19:32:07  oes
401  *    Changed default port to 8118
402  *
403  *    Revision 1.49  2002/03/04 18:28:55  oes
404  *    Deleted PID_FILE_NAME
405  *
406  *    Revision 1.48  2002/03/03 14:50:40  oes
407  *    Fixed CLF logging: Added ocmd member for client's request to struct http_request
408  *
409  *    Revision 1.47  2002/02/20 23:15:13  jongfoster
410  *    Parsing functions now handle out-of-memory gracefully by returning
411  *    an error code.
412  *
413  *    Revision 1.46  2002/01/17 21:06:09  jongfoster
414  *    Now #defining the URLs of the config interface
415  *
416  *    Minor changes to struct http_request and struct url_spec due to
417  *    standardizing that struct http_request is used to represent a URL, and
418  *    struct url_spec is used to represent a URL pattern.  (Before, URLs were
419  *    represented as seperate variables and a partially-filled-in url_spec).
420  *
421  *    Revision 1.45  2002/01/09 14:33:27  oes
422  *    Added HOSTENT_BUFFER_SIZE
423  *
424  *    Revision 1.44  2001/12/30 14:07:32  steudten
425  *    - Add signal handling (unix)
426  *    - Add SIGHUP handler (unix)
427  *    - Add creation of pidfile (unix)
428  *    - Add action 'top' in rc file (RH)
429  *    - Add entry 'SIGNALS' to manpage
430  *    - Add exit message to logfile (unix)
431  *
432  *    Revision 1.43  2001/11/22 21:57:51  jongfoster
433  *    Making action_spec->flags into an unsigned long rather than just an
434  *    unsigned int.
435  *    Adding ACTION_NO_COOKIE_KEEP
436  *
437  *    Revision 1.42  2001/11/05 21:42:41  steudten
438  *    Include DBG() macro.
439  *
440  *    Revision 1.41  2001/10/28 19:12:06  jongfoster
441  *    Adding ijb_toupper()
442  *
443  *    Revision 1.40  2001/10/26 17:40:47  oes
444  *    Moved ijb_isspace and ijb_tolower to project.h
445  *    Removed http->user_agent, csp->referrer and csp->accept_types
446  *
447  *    Revision 1.39  2001/10/25 03:45:02  david__schmidt
448  *    Adding a (void*) cast to freez() because Visual Age C++ won't expand the
449  *    macro when called with a cast; so moving the cast to the macro def'n
450  *    seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
451  *    doesn't make macro expansion complain.  Hope this works for everyone else
452  *    too...
453  *
454  *    Revision 1.38  2001/10/23 21:19:04  jongfoster
455  *    New error-handling support: jb_err type and JB_ERR_xxx constants
456  *    CGI functions now return a jb_err, and their parameters map is const.
457  *    Support for RUNTIME_FEATUREs to enable/disable config editor
458  *    Adding a few comments
459  *
460  *    Revision 1.37  2001/10/14 22:14:01  jongfoster
461  *    Removing name_length field from struct cgi_dispatcher, as this is
462  *    now calculated at runtime from the "name" field.
463  *
464  *    Revision 1.36  2001/10/10 16:45:15  oes
465  *    Added LIMIT_CONNECT action and string
466  *    Fixed HTTP message line termination
467  *    Added CFORBIDDEN HTTP message
468  *
469  *    Revision 1.35  2001/10/07 18:06:43  oes
470  *    Added status member to struct http_request
471  *
472  *    Revision 1.34  2001/10/07 15:45:25  oes
473  *    Added url member to struct http_request and commented all
474  *      members
475  *
476  *    Added CT_TABOO
477  *
478  *    Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
479  *
480  *    Replaced struct client_state members rejected,
481  *      force, active and toggled_on with "flags" bitmap.
482  *
483  *    Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
484  *
485  *    Added buffer_limit to struct configuration_spec
486  *
487  *    Revision 1.33  2001/09/20 13:30:08  steudten
488  *
489  *    Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
490  *    Last case will set z to NULL in free(z) and thats bad..
491  *
492  *    Revision 1.32  2001/09/16 23:02:51  jongfoster
493  *    Fixing warning
494  *
495  *    Revision 1.31  2001/09/16 13:20:29  jongfoster
496  *    Rewrite of list library.  Now has seperate header and list_entry
497  *    structures.  Also added a large sprinking of assert()s to the list
498  *    code.
499  *
500  *    Revision 1.30  2001/09/13 23:52:00  jongfoster
501  *    Support for both static and dynamically generated CGI pages
502  *
503  *    Revision 1.29  2001/09/13 23:29:43  jongfoster
504  *    Defining FORWARD_SPEC_INITIALIZER
505  *
506  *    Revision 1.28  2001/09/13 23:05:50  jongfoster
507  *    Changing the string paramater to the header parsers a "const".
508  *
509  *    Revision 1.27  2001/08/05 16:06:20  jongfoster
510  *    Modifiying "struct map" so that there are now separate header and
511  *    "map_entry" structures.  This means that functions which modify a
512  *    map no longer need to return a pointer to the modified map.
513  *    Also, it no longer reverses the order of the entries (which may be
514  *    important with some advanced template substitutions).
515  *
516  *    Revision 1.26  2001/07/30 22:08:36  jongfoster
517  *    Tidying up #defines:
518  *    - All feature #defines are now of the form FEATURE_xxx
519  *    - Permanently turned off WIN_GUI_EDIT
520  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
521  *
522  *    Revision 1.25  2001/07/29 18:43:08  jongfoster
523  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
524  *    ANSI C rules.
525  *
526  *    Revision 1.24  2001/07/25 17:20:27  oes
527  *    Introduced http->user_agent
528  *
529  *    Revision 1.23  2001/07/18 12:32:23  oes
530  *    - Added ACTION_STRING_DEANIMATE
531  *    - moved #define freez from jcc.h to project.h
532  *
533  *    Revision 1.22  2001/07/15 17:51:41  jongfoster
534  *    Renaming #define STATIC to STATIC_PCRE
535  *
536  *    Revision 1.21  2001/07/13 14:03:19  oes
537  *     - Reorganized regex header inclusion and #defines to
538  *       comply to the scheme in configure.in
539  *     - Added csp->content_type and its CT_* keys
540  *     - Added ACTION_DEANIMATE
541  *     - Removed all #ifdef PCRS
542  *
543  *    Revision 1.20  2001/06/29 21:45:41  oes
544  *    Indentation, CRLF->LF, Tab-> Space
545  *
546  *    Revision 1.19  2001/06/29 13:33:36  oes
547  *    - Improved comments
548  *    - Introduced http_request.host_ip_addr_str
549  *    - Introduced http_response.head_length
550  *    - Introduced config.my_ip_addr_str, config.my_hostname,
551  *      config.admin_address and config.proxy_info_url
552  *    - Removed config.proxy_args_header and config.proxy_args_trailer,
553  *      renamed config.proxy_args_invocation to config.proxy_args
554  *    - Removed HTML snipplets and GIFs
555  *    - Removed logentry from cancelled commit
556  *
557  *    Revision 1.18  2001/06/09 10:57:39  jongfoster
558  *    Adding definition of BUFFER_SIZE.
559  *    Changing struct cgi_dispatcher to use "const" strings.
560  *
561  *    Revision 1.17  2001/06/07 23:15:09  jongfoster
562  *    Merging ACL and forward files into config file.
563  *    Moving struct gateway members into struct forward_spec
564  *    Removing config->proxy_args_gateways
565  *    Cosmetic: Adding a few comments
566  *
567  *    Revision 1.16  2001/06/04 18:31:58  swa
568  *    files are now prefixed with either `confdir' or `logdir'.
569  *    `make redhat-dist' replaces both entries confdir and logdir
570  *    with redhat values
571  *
572  *    Revision 1.15  2001/06/04 11:28:53  swa
573  *    redirect did not work due to missing /
574  *
575  *    Revision 1.14  2001/06/03 11:03:48  oes
576  *    Added struct map,
577  *    added struct http_response,
578  *    changed struct interceptors to struct cgi_dispatcher,
579  *    moved HTML stuff to cgi.h
580  *
581  *    Revision 1.13  2001/06/01 20:05:36  jongfoster
582  *    Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
583  *    constant, and removed csp->tinygif.
584  *
585  *    Revision 1.12  2001/06/01 18:49:17  jongfoster
586  *    Replaced "list_share" with "list" - the tiny memory gain was not
587  *    worth the extra complexity.
588  *
589  *    Revision 1.11  2001/06/01 10:32:47  oes
590  *    Added constants for anchoring selection bitmap
591  *
592  *    Revision 1.10  2001/05/31 21:33:53  jongfoster
593  *    Changes for new actions file, replacing permissionsfile
594  *    and parts of the config file.  Also added support for
595  *    list_shared.
596  *
597  *    Revision 1.9  2001/05/31 17:32:31  oes
598  *
599  *     - Enhanced domain part globbing with infix and prefix asterisk
600  *       matching and optional unanchored operation
601  *
602  *    Revision 1.8  2001/05/29 20:09:15  joergs
603  *    HTTP_REDIRECT_TEMPLATE fixed.
604  *
605  *    Revision 1.7  2001/05/29 09:50:24  jongfoster
606  *    Unified blocklist/imagelist/actionslist.
607  *    File format is still under discussion, but the internal changes
608  *    are (mostly) done.
609  *
610  *    Also modified interceptor behaviour:
611  *    - We now intercept all URLs beginning with one of the following
612  *      prefixes (and *only* these prefixes):
613  *        * http://i.j.b/
614  *        * http://ijbswa.sf.net/config/
615  *        * http://ijbswa.sourceforge.net/config/
616  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
617  *    - Internal changes so that intercepted and fast redirect pages
618  *      are not replaced with an image.
619  *    - Interceptors now have the option to send a binary page direct
620  *      to the client. (i.e. ijb-send-banner uses this)
621  *    - Implemented show-url-info interceptor.  (Which is why I needed
622  *      the above interceptors changes - a typical URL is
623  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
624  *      The previous mechanism would not have intercepted that, and
625  *      if it had been intercepted then it then it would have replaced
626  *      it with an image.)
627  *
628  *    Revision 1.6  2001/05/27 22:17:04  oes
629  *
630  *    - re_process_buffer no longer writes the modified buffer
631  *      to the client, which was very ugly. It now returns the
632  *      buffer, which it is then written by chat.
633  *
634  *    - content_length now adjusts the Content-Length: header
635  *      for modified documents rather than crunch()ing it.
636  *      (Length info in csp->content_length, which is 0 for
637  *      unmodified documents)
638  *
639  *    - For this to work, sed() is called twice when filtering.
640  *
641  *    Revision 1.5  2001/05/26 00:28:36  jongfoster
642  *    Automatic reloading of config file.
643  *    Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
644  *    Most of the global variables have been moved to a new
645  *    struct configuration_spec, accessed through csp->config->globalname
646  *    Most of the globals remaining are used by the Win32 GUI.
647  *
648  *    Revision 1.4  2001/05/22 18:46:04  oes
649  *
650  *    - Enabled filtering banners by size rather than URL
651  *      by adding patterns that replace all standard banner
652  *      sizes with the "Junkbuster" gif to the re_filterfile
653  *
654  *    - Enabled filtering WebBugs by providing a pattern
655  *      which kills all 1x1 images
656  *
657  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
658  *      which is selected by the (nonstandard and therefore
659  *      capital) letter 'U' in the option string.
660  *      It causes the quantifiers to be ungreedy by default.
661  *      Appending a ? turns back to greedy (!).
662  *
663  *    - Added a new interceptor ijb-send-banner, which
664  *      sends back the "Junkbuster" gif. Without imagelist or
665  *      MSIE detection support, or if tinygif = 1, or the
666  *      URL isn't recognized as an imageurl, a lame HTML
667  *      explanation is sent instead.
668  *
669  *    - Added new feature, which permits blocking remote
670  *      script redirects and firing back a local redirect
671  *      to the browser.
672  *      The feature is conditionally compiled, i.e. it
673  *      can be disabled with --disable-fast-redirects,
674  *      plus it must be activated by a "fast-redirects"
675  *      line in the config file, has its own log level
676  *      and of course wants to be displayed by show-proxy-args
677  *      Note: Boy, all the #ifdefs in 1001 locations and
678  *      all the fumbling with configure.in and acconfig.h
679  *      were *way* more work than the feature itself :-(
680  *
681  *    - Because a generic redirect template was needed for
682  *      this, tinygif = 3 now uses the same.
683  *
684  *    - Moved GIFs, and other static HTTP response templates
685  *      to project.h
686  *
687  *    - Some minor fixes
688  *
689  *    - Removed some >400 CRs again (Jon, you really worked
690  *      a lot! ;-)
691  *
692  *    Revision 1.3  2001/05/20 01:21:20  jongfoster
693  *    Version 2.9.4 checkin.
694  *    - Merged popupfile and cookiefile, and added control over PCRS
695  *      filtering, in new "actionsfile".
696  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
697  *      file error you now get a message box (in the Win32 GUI) rather
698  *      than the program exiting with no explanation.
699  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
700  *      skipping.
701  *    - Removed tabs from "config"
702  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
703  *    - Bumped up version number.
704  *
705  *    Revision 1.2  2001/05/17 23:01:01  oes
706  *     - Cleaned CRLF's from the sources and related files
707  *
708  *    Revision 1.1.1.1  2001/05/15 13:59:03  oes
709  *    Initial import of version 2.9.3 source tree
710  *
711  *
712  *********************************************************************/
713 \f
714
715 /* Declare struct FILE for vars and funcs. */
716 #include <stdio.h>
717
718 /* Need time_t for file_list */
719 #include <time.h>
720 /* Needed for pcre choice */
721 #include "config.h"
722
723 #ifdef HAVE_RFC2553
724 /* Need for struct sockaddr_storage */
725 #include <sys/socket.h>
726 #endif
727
728
729 /*
730  * Include appropriate regular expression libraries.
731  * Note that pcrs and pcre (native) are needed for cgi
732  * and are included anyway.
733  */
734
735 #ifdef STATIC_PCRE
736 #  include "pcre.h"
737 #else
738 #  ifdef PCRE_H_IN_SUBDIR
739 #    include <pcre/pcre.h>
740 #  else
741 #    include <pcre.h>
742 #  endif
743 #endif
744
745 #ifdef STATIC_PCRS
746 #  include "pcrs.h"
747 #else
748 #  include <pcrs.h>
749 #endif
750
751 #ifdef STATIC_PCRE
752 #  include "pcreposix.h"
753 #else
754 #  ifdef PCRE_H_IN_SUBDIR
755 #    include <pcre/pcreposix.h>
756 #  else
757 #    include <pcreposix.h>
758 #  endif
759 #endif
760
761 #ifdef AMIGA
762 #include "amiga.h"
763 #endif /* def AMIGA */
764
765 #ifdef _WIN32
766 /*
767  * I don't want to have to #include all this just for the declaration
768  * of SOCKET.  However, it looks like we have to...
769  */
770 #ifndef STRICT
771 #define STRICT
772 #endif
773 #include <windows.h>
774 #endif
775
776
777 #ifdef __cplusplus
778 extern "C" {
779 #endif
780
781 #ifdef _WIN32
782
783 typedef SOCKET jb_socket;
784
785 #define JB_INVALID_SOCKET INVALID_SOCKET
786
787 #else /* ndef _WIN32 */
788
789 /**
790  * The type used by sockets.  On UNIX it's an int.  Microsoft decided to
791  * make it an unsigned.
792  */
793 typedef int jb_socket;
794
795 /**
796  * The error value used for variables of type jb_socket.  On UNIX this
797  * is -1, however Microsoft decided to make socket handles unsigned, so
798  * they use a different value.
799  */
800
801 #define JB_INVALID_SOCKET (-1)
802
803 #endif /* ndef _WIN32 */
804
805
806 /**
807  * A standard error code.  This should be JB_ERR_OK or one of the JB_ERR_xxx
808  * series of errors.
809  */
810 typedef int jb_err;
811
812 #define JB_ERR_OK         0 /**< Success, no error                        */
813 #define JB_ERR_MEMORY     1 /**< Out of memory                            */
814 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters        */
815 #define JB_ERR_FILE       3 /**< Error opening, reading or writing a file */
816 #define JB_ERR_PARSE      4 /**< Error parsing file                       */
817 #define JB_ERR_MODIFIED   5 /**< File has been modified outside of the  
818                                  CGI actions editor.                      */
819 #define JB_ERR_COMPRESS   6 /**< Error on decompression                   */
820
821 /**
822  * This macro is used to free a pointer that may be NULL.
823  * It also sets the variable to NULL after it's been freed.
824  * The paramater should be a simple variable without side effects.
825  */
826 #define freez(X)  { if(X) { free((void*)X); X = NULL ; } }
827
828
829 /**
830  * Fix a problem with Solaris.  There should be no effect on other
831  * platforms.
832  *
833  * Solaris's isspace() is a macro which uses it's argument directly
834  * as an array index.  Therefore we need to make sure that high-bit
835  * characters generate +ve values, and ideally we also want to make
836  * the argument match the declared parameter type of "int".
837  *
838  * Note: Remember to #include <ctype.h> if you use these macros.
839  */
840 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
841 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
842 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))  
843
844 /**
845  * Use for statically allocated buffers if you have no other choice.
846  * Remember to check the length of what you write into the buffer
847  * - we don't want any buffer overflows!
848  */
849 #define BUFFER_SIZE 5000
850
851 /**
852  * Max length of CGI parameters (arbitrary limit).
853  */
854 #define CGI_PARAM_LEN_MAX 500U
855
856 /**
857  * Buffer size for capturing struct hostent data in the
858  * gethostby(name|addr)_r library calls. Since we don't
859  * loop over gethostbyname_r, the buffer must be sufficient
860  * to accomodate multiple IN A RRs, as used in DNS round robin
861  * load balancing. W3C's wwwlib uses 1K, so that should be
862  * good enough for us, too.
863  */
864 /**
865  * XXX: Temporary doubled, for some configurations
866  * 1K is still too small and we didn't get the
867  * real fix ready for inclusion.
868  */
869 #define HOSTENT_BUFFER_SIZE 2048
870
871 /**
872  * Do not use.  Originally this was so that you can
873  * say "while (FOREVER) { ...do something... }".
874  * However, this gives a warning with some compilers (e.g. VC++).
875  * Instead, use "for (;;) { ...do something... }".
876  */
877 #define FOREVER 1
878
879 /**
880  * Default TCP/IP address to listen on, as a string.
881  * Set to "127.0.0.1:8118".
882  */
883 #define HADDR_DEFAULT   "127.0.0.1:8118"
884
885
886 /* Forward def for struct client_state */
887 struct configuration_spec;
888
889
890 /**
891  * Entry in a linked list of strings.
892  */
893 struct list_entry
894 {
895    /**
896     * The string pointer. It must point to a dynamically malloc()ed
897     * string or be NULL for the list functions to work. In the latter
898     * case, just be careful next time you iterate through the list in
899     * your own code.
900     */
901    char *str;
902    
903    /** Next entry in the linked list, or NULL if no more. */
904    struct list_entry *next;
905 };
906
907 /**
908  * A header for a linked list of strings.
909  */
910 struct list
911 {
912    /** First entry in the list, or NULL if the list is empty. */
913    struct list_entry *first;
914
915    /** Last entry in the list, or NULL if the list is empty. */
916    struct list_entry *last;
917 };
918
919
920 /**
921  * An entry in a map.  This is a name=value pair.
922  */
923 struct map_entry
924 {
925    /** The key for the map. */
926    const char *name;
927    /** The value associated with that key. */
928    const char *value;
929    /** The next map entry, or NULL if none. */
930    struct map_entry *next;
931 };
932
933 /**
934  * A map from a string to another string.
935  * This is used for the paramaters passed in a HTTP GET request, and
936  * to store the exports when the CGI interface is filling in a template.
937  */
938 struct map
939 {
940    /** The first map entry, or NULL if the map is empty. */
941    struct map_entry *first;
942    /** The last map entry, or NULL if the map is empty. */
943    struct map_entry *last;
944 };
945
946
947 /**
948  * A HTTP request.  This includes the method (GET, POST) and
949  * the parsed URL.
950  *
951  * This is also used whenever we want to match a URL against a
952  * URL pattern.  This always contains the URL to match, and never
953  * a URL pattern.  (See struct url_spec).
954  */
955 struct http_request
956 {
957    char *cmd;      /**< Whole command line: method, URL, Version */
958    char *ocmd;     /**< Backup of original cmd for CLF logging */
959    char *gpc;      /**< HTTP method: GET, POST, ... */
960    char *url;      /**< The URL */
961    char *ver;      /**< Protocol version */
962    int status;     /**< HTTP Status */
963
964    char *host;     /**< Host part of URL */
965    int   port;     /**< Port of URL or 80 (default) */
966    char *path;     /**< Path of URL */
967    char *hostport; /**< host[:port] */
968    int   ssl;      /**< Flag if protocol is https */
969
970    char *host_ip_addr_str; /**< String with dotted decimal representation
971                                 of host's IP. NULL before connect_to() */
972
973    char  *dbuffer; /**< Buffer with '\0'-delimited domain name.           */
974    char **dvec;    /**< List of pointers to the strings in dbuffer.       */
975    int    dcount;  /**< How many parts to this domain? (length of dvec)   */
976 };
977
978 /**
979  * Reasons for generating a http_response instead of delivering
980  * the requested resource. Mostly ordered the way they are checked
981  * for in chat().
982  */
983 #define RSP_REASON_UNSUPPORTED        1
984 #define RSP_REASON_BLOCKED            2
985 #define RSP_REASON_UNTRUSTED          3
986 #define RSP_REASON_REDIRECTED         4
987 #define RSP_REASON_CGI_CALL           5
988 #define RSP_REASON_NO_SUCH_DOMAIN     6
989 #define RSP_REASON_FORWARDING_FAILED  7
990 #define RSP_REASON_CONNECT_FAILED     8
991 #define RSP_REASON_OUT_OF_MEMORY      9
992 #define RSP_REASON_INTERNAL_ERROR     10
993
994 /**
995  * Response generated by CGI, blocker, or error handler
996  */
997 struct http_response
998 {
999   char  *status;          /**< HTTP status (string). */
1000   struct list headers[1]; /**< List of header lines. */
1001   char  *head;            /**< Formatted http response head. */
1002   size_t head_length;     /**< Length of http response head. */
1003   char  *body;            /**< HTTP document body. */
1004   size_t content_length;  /**< Length of body, REQUIRED if binary body. */
1005   int    is_static;       /**< Nonzero if the content will never change and
1006                                should be cached by the browser (e.g. images). */
1007   int reason;             /**< Why the response was generated in the first place. */
1008 };
1009
1010 /**
1011  * A URL or a tag pattern.
1012  */
1013 struct url_spec
1014 {
1015    /** The string which was parsed to produce this url_spec.
1016        Used for debugging or display only.  */
1017    char  *spec;
1018
1019 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
1020    regex_t *host_regex;/**< Regex for host matching                          */
1021 #else
1022    char  *dbuffer;     /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
1023    char **dvec;        /**< List of pointers to the strings in dbuffer.       */
1024    int    dcount;      /**< How many parts to this domain? (length of dvec)   */
1025    int    unanchored;  /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT.  */
1026 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
1027
1028    char  *port_list;   /**< List of acceptable ports, or NULL to match all ports */
1029
1030    regex_t *preg;      /**< Regex for matching path part                      */
1031    regex_t *tag_regex; /**< Regex for matching tags                           */
1032 };
1033
1034 /**
1035  * If you declare a static url_spec, this is the value to initialize it to zero.
1036  */
1037 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
1038 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
1039 #else
1040 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
1041 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
1042
1043 /**
1044  * Constant for host part matching in URLs.  If set, indicates that the start of
1045  * the pattern must match the start of the URL.  E.g. this is not set for the
1046  * pattern ".example.com", so that it will match both "example.com" and
1047  * "www.example.com".  It is set for the pattern "example.com", which makes it
1048  * match "example.com" only, not "www.example.com".
1049  */
1050 #define ANCHOR_LEFT  1
1051
1052 /**
1053  * Constant for host part matching in URLs.  If set, indicates that the end of
1054  * the pattern must match the end of the URL.  E.g. this is not set for the
1055  * pattern "ad.", so that it will match any host called "ad", irrespective
1056  * of how many subdomains are in the fully-qualified domain name.
1057  */
1058 #define ANCHOR_RIGHT 2
1059
1060
1061 /**
1062  * An I/O buffer.  Holds a string which can be appended to, and can have data
1063  * removed from the beginning.
1064  */
1065 struct iob
1066 {
1067    char *buf;    /**< Start of buffer        */
1068    char *cur;    /**< Start of relevant data */
1069    char *eod;    /**< End of relevant data   */
1070    size_t size;  /**< Size as malloc()ed     */
1071 };
1072
1073
1074 /**
1075  * Return the number of bytes in the I/O buffer associated with the passed
1076  * client_state pointer.
1077  * May be zero.
1078  */
1079 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
1080
1081
1082 /**
1083  * Remove any data in the I/O buffer associated with the passed
1084  * client_state pointer.
1085  */
1086 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
1087
1088 /* Bits for csp->content_type bitmask: */
1089 #define CT_TEXT    0x0001U /**< Suitable for pcrs filtering. */
1090 #define CT_GIF     0x0002U /**< Suitable for GIF filtering.  */
1091 #define CT_TABOO   0x0004U /**< DO NOT filter, irrespective of other flags. */
1092
1093 /* Although these are not, strictly speaking, content types
1094  * (they are content encodings), it is simple to handle them
1095  * as such.
1096  */
1097 #define CT_GZIP    0x0010U /**< gzip-compressed data. */
1098 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
1099
1100 /**
1101  * Flag to signal that the server declared the content type,
1102  * so we can differentiate between unknown and undeclared
1103  * content types.
1104  */
1105 #define CT_DECLARED 0x0040U
1106
1107 /**
1108  * The mask which includes all actions.
1109  */
1110 #define ACTION_MASK_ALL        (~0UL)
1111
1112 /**
1113  * The most compatible set of actions - i.e. none.
1114  */
1115 #define ACTION_MOST_COMPATIBLE                       0x00000000UL
1116
1117 /** Action bitmap: Block the request. */
1118 #define ACTION_BLOCK                                 0x00000001UL
1119 /** Action bitmap: Deanimate if it's a GIF. */
1120 #define ACTION_DEANIMATE                             0x00000002UL
1121 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
1122 #define ACTION_DOWNGRADE                             0x00000004UL
1123 /** Action bitmap: Fast redirects. */
1124 #define ACTION_FAST_REDIRECTS                        0x00000008UL
1125 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
1126 #define ACTION_CHANGE_X_FORWARDED_FOR                0x00000010UL
1127 /** Action bitmap: Hide "From" header. */
1128 #define ACTION_HIDE_FROM                             0x00000020UL
1129 /** Action bitmap: Hide "Referer" header.  (sic - follow HTTP, not English). */
1130 #define ACTION_HIDE_REFERER                          0x00000040UL
1131 /** Action bitmap: Hide "User-Agent" and similar headers. */
1132 #define ACTION_HIDE_USER_AGENT                       0x00000080UL
1133 /** Action bitmap: This is an image. */
1134 #define ACTION_IMAGE                                 0x00000100UL
1135 /** Action bitmap: Sets the image blocker. */
1136 #define ACTION_IMAGE_BLOCKER                         0x00000200UL
1137 /** Action bitmap: Prevent compression. */
1138 #define ACTION_NO_COMPRESSION                        0x00000400UL
1139 /** Action bitmap: Change cookies to session only cookies. */
1140 #define ACTION_NO_COOKIE_KEEP                        0x00000800UL
1141 /** Action bitmap: Block rending cookies. */
1142 #define ACTION_NO_COOKIE_READ                        0x00001000UL
1143 /** Action bitmap: Block setting cookies. */
1144 #define ACTION_NO_COOKIE_SET                         0x00002000UL
1145 /** Action bitmap: Override the forward settings in the config file */
1146 #define ACTION_FORWARD_OVERRIDE                      0x00004000UL
1147 /** Action bitmap: Block as empty document */
1148 #define  ACTION_HANDLE_AS_EMPTY_DOCUMENT             0x00008000UL
1149 /** Action bitmap: Limit CONNECT requests to safe ports. */
1150 #define ACTION_LIMIT_CONNECT                         0x00010000UL
1151 /** Action bitmap: Redirect request. */
1152 #define  ACTION_REDIRECT                             0x00020000UL
1153 /** Action bitmap: Crunch or modify "if-modified-since" header. */
1154 #define ACTION_HIDE_IF_MODIFIED_SINCE                0x00040000UL
1155 /** Action bitmap: Overwrite Content-Type header. */
1156 #define ACTION_CONTENT_TYPE_OVERWRITE                0x00080000UL
1157 /** Action bitmap: Crunch specified server header. */
1158 #define ACTION_CRUNCH_SERVER_HEADER                  0x00100000UL
1159 /** Action bitmap: Crunch specified client header */
1160 #define ACTION_CRUNCH_CLIENT_HEADER                  0x00200000UL
1161 /** Action bitmap: Enable text mode by force */
1162 #define ACTION_FORCE_TEXT_MODE                       0x00400000UL
1163 /** Action bitmap: Enable text mode by force */
1164 #define ACTION_CRUNCH_IF_NONE_MATCH                  0x00800000UL
1165 /** Action bitmap: Enable content-dispostion crunching */
1166 #define ACTION_HIDE_CONTENT_DISPOSITION              0x01000000UL
1167 /** Action bitmap: Replace or block Last-Modified header */
1168 #define ACTION_OVERWRITE_LAST_MODIFIED               0x02000000UL
1169 /** Action bitmap: Replace or block Accept-Language header */
1170 #define ACTION_HIDE_ACCEPT_LANGUAGE                  0x04000000UL
1171
1172
1173 /** Action string index: How to deanimate GIFs */
1174 #define ACTION_STRING_DEANIMATE             0
1175 /** Action string index: Replacement for "From:" header */
1176 #define ACTION_STRING_FROM                  1
1177 /** Action string index: How to block images */
1178 #define ACTION_STRING_IMAGE_BLOCKER         2
1179 /** Action string index: Replacement for "Referer:" header */
1180 #define ACTION_STRING_REFERER               3
1181 /** Action string index: Replacement for "User-Agent:" header */
1182 #define ACTION_STRING_USER_AGENT            4
1183 /** Action string index: Legal CONNECT ports. */
1184 #define ACTION_STRING_LIMIT_CONNECT         5
1185 /** Action string index: Server headers containing this pattern are crunched*/
1186 #define ACTION_STRING_SERVER_HEADER         6
1187 /** Action string index: Client headers containing this pattern are crunched*/
1188 #define ACTION_STRING_CLIENT_HEADER         7
1189 /** Action string index: Replacement for the "Accept-Language:" header*/
1190 #define ACTION_STRING_LANGUAGE              8
1191 /** Action string index: Replacement for the "Content-Type:" header*/
1192 #define ACTION_STRING_CONTENT_TYPE          9
1193 /** Action string index: Replacement for the "content-dispostion:" header*/
1194 #define ACTION_STRING_CONTENT_DISPOSITION  10
1195 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1196 #define ACTION_STRING_IF_MODIFIED_SINCE    11
1197 /** Action string index: Replacement for the "Last-Modified:" header. */
1198 #define ACTION_STRING_LAST_MODIFIED        12
1199 /** Action string index: Redirect URL */
1200 #define ACTION_STRING_REDIRECT             13
1201 /** Action string index: Decode before redirect? */
1202 #define ACTION_STRING_FAST_REDIRECTS       14
1203 /** Action string index: Overriding forward rule. */
1204 #define ACTION_STRING_FORWARD_OVERRIDE     15
1205 /** Action string index: Reason for the block. */
1206 #define ACTION_STRING_BLOCK                16
1207 /** Action string index: what to do with the "X-Forwarded-For" header. */
1208 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
1209 /** Number of string actions. */
1210 #define ACTION_STRING_COUNT                18
1211
1212
1213 /* To make the ugly hack in sed easier to understand */
1214 #define CHECK_EVERY_HEADER_REMAINING 0
1215
1216
1217 /** Index into current_action_spec::multi[] for headers to add. */
1218 #define ACTION_MULTI_ADD_HEADER              0
1219 /** Index into current_action_spec::multi[] for content filters to apply. */
1220 #define ACTION_MULTI_FILTER                  1
1221 /** Index into current_action_spec::multi[] for server-header filters to apply. */
1222 #define ACTION_MULTI_SERVER_HEADER_FILTER    2
1223 /** Index into current_action_spec::multi[] for client-header filters to apply. */
1224 #define ACTION_MULTI_CLIENT_HEADER_FILTER    3
1225 /** Index into current_action_spec::multi[] for client-header tags to apply. */
1226 #define ACTION_MULTI_CLIENT_HEADER_TAGGER    4
1227 /** Index into current_action_spec::multi[] for server-header tags to apply. */
1228 #define ACTION_MULTI_SERVER_HEADER_TAGGER    5
1229 /** Number of multi-string actions. */
1230 #define ACTION_MULTI_COUNT                   6
1231
1232
1233 /**
1234  * This structure contains a list of actions to apply to a URL.
1235  * It only contains positive instructions - no "-" options.
1236  * It is not used to store the actions list itself, only for
1237  * url_actions() to return the current values.
1238  */
1239 struct current_action_spec
1240 {
1241    /** Actions to apply.  A bit set to "1" means perform the action. */
1242    unsigned long flags;
1243
1244    /**
1245     * Paramaters for those actions that require them.
1246     * Each entry is valid if & only if the corresponding entry in "flags" is
1247     * set.
1248     */
1249    char * string[ACTION_STRING_COUNT];
1250
1251    /** Lists of strings for multi-string actions. */
1252    struct list multi[ACTION_MULTI_COUNT][1];
1253 };
1254
1255
1256 /**
1257  * This structure contains a set of changes to actions.
1258  * It can contain both positive and negative instructions.
1259  * It is used to store an entry in the actions list.
1260  */
1261 struct action_spec
1262 {
1263    unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1264    unsigned long add;  /**< Actions to add.  A bit set to "1" means add action.    */
1265
1266    /**
1267     * Paramaters for those actions that require them.
1268     * Each entry is valid if & only if the corresponding entry in "flags" is
1269     * set.
1270     */
1271    char * string[ACTION_STRING_COUNT];
1272
1273    /** Lists of strings to remove, for multi-string actions. */
1274    struct list multi_remove[ACTION_MULTI_COUNT][1];
1275
1276    /** If nonzero, remove *all* strings from the multi-string action. */
1277    int         multi_remove_all[ACTION_MULTI_COUNT];
1278
1279    /** Lists of strings to add, for multi-string actions. */
1280    struct list multi_add[ACTION_MULTI_COUNT][1];
1281 };
1282
1283
1284 /**
1285  * This structure is used to store action files.
1286  *
1287  * It contains an URL or tag pattern, and the changes to
1288  * the actions. It's a linked list and should only be
1289  * free'd through unload_actions_file() unless there's
1290  * only a single entry.
1291  */
1292 struct url_actions
1293 {
1294    struct url_spec url[1];     /**< The URL or tag pattern. */
1295
1296    struct action_spec *action; /**< Action settings that might be shared with
1297                                     the list entry before or after the current
1298                                     one and can't be free'd willy nilly. */
1299
1300    struct url_actions *next;   /**< Next action section in file, or NULL. */
1301 };
1302
1303
1304 /*
1305  * Flags for use in csp->flags
1306  */
1307  
1308 /**
1309  * Flag for csp->flags: Set if this client is processing data.
1310  * Cleared when the thread associated with this structure dies.
1311  */
1312 #define CSP_FLAG_ACTIVE     0x01U
1313
1314 /**
1315  * Flag for csp->flags: Set if the server's reply is in "chunked"
1316  * transfer encoding
1317  */
1318 #define CSP_FLAG_CHUNKED    0x02U
1319
1320 /**
1321  * Flag for csp->flags: Set if this request was enforced, although it would
1322  * normally have been blocked.
1323  */
1324 #define CSP_FLAG_FORCED     0x04U
1325
1326 /**
1327  * Flag for csp->flags: Set if any modification to the body was done.
1328  */
1329 #define CSP_FLAG_MODIFIED   0x08U
1330
1331 /**
1332  * Flag for csp->flags: Set if request was blocked.
1333  */
1334 #define CSP_FLAG_REJECTED   0x10U
1335
1336 /**
1337  * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1338  */
1339 #define CSP_FLAG_TOGGLED_ON 0x20U
1340
1341 /**
1342  * Flag for csp->flags: Set if an acceptable Connection header
1343  * is already set.
1344  */
1345 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET  0x00000040U
1346
1347 /**
1348  * Flag for csp->flags: Set if adding the 'Connection: close' header
1349  * for the server isn't necessary.
1350  */
1351 #define CSP_FLAG_SERVER_CONNECTION_CLOSE_SET   0x00000080U
1352
1353 /**
1354  * Flag for csp->flags: Signals header parsers whether they
1355  * are parsing server or client headers.
1356  */
1357 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE    0x00000100U
1358
1359 /**
1360  * Flag for csp->flags: Set if adding the Host: header
1361  * isn't necessary.
1362  */
1363 #define CSP_FLAG_HOST_HEADER_IS_SET            0x00000200U
1364
1365 /**
1366  * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
1367  * XXX: As we now have tags we might as well ditch this.
1368  */
1369 #define CSP_FLAG_NO_FILTERING                  0x00000400U
1370
1371 /**
1372  * Flag for csp->flags: Set the client IP has appended to
1373  * an already existing X-Forwarded-For header in which case
1374  * no new header has to be generated.
1375  */
1376 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED      0x00000800U
1377
1378 /**
1379  * Flag for csp->flags: Set if the server wants to keep
1380  * the connection alive.
1381  */
1382 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE  0x00001000U
1383
1384 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1385 /**
1386  * Flag for csp->flags: Set if the server specified the
1387  * content length.
1388  */
1389 #define CSP_FLAG_CONTENT_LENGTH_SET            0x00002000U
1390 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1391
1392 /*
1393  * Flags for use in return codes of child processes
1394  */
1395
1396 /**
1397  * Flag for process return code: Set if exiting porcess has been toggled
1398  * during its lifetime.
1399  */
1400 #define RC_FLAG_TOGGLED   0x10
1401
1402 /**
1403  * Flag for process return code: Set if exiting porcess has blocked its
1404  * request.
1405  */
1406 #define RC_FLAG_BLOCKED   0x20
1407
1408 /**
1409  * Maximum number of actions/filter files.  This limit is arbitrary - it's just used
1410  * to size an array.
1411  */
1412 #define MAX_AF_FILES 10
1413
1414 /**
1415  * The state of a Privoxy processing thread.
1416  */
1417 struct client_state
1418 {
1419    /** The proxy's configuration */
1420    struct configuration_spec * config;
1421
1422    /** The actions to perform on the current request */
1423    struct current_action_spec  action[1];
1424
1425    /** socket to talk to client (web browser) */
1426    jb_socket cfd;
1427
1428    /** socket to talk to server (web server or proxy) */
1429    jb_socket sfd;
1430
1431    /** Multi-purpose flag container, see CSP_FLAG_* above */
1432    unsigned int flags;
1433
1434    /** Client PC's IP address, as reported by the accept() function.
1435        As a string. */
1436    char *ip_addr_str;
1437 #ifdef HAVE_RFC2553
1438    /** Client PC's TCP address, as reported by the accept() function.
1439        As a sockaddr. */
1440    struct sockaddr_storage tcp_addr;
1441 #else
1442    /** Client PC's IP address, as reported by the accept() function.
1443        As a number. */
1444    unsigned long ip_addr_long;
1445 #endif /* def HAVE_RFC2553 */
1446
1447    /** The URL that was requested */
1448    struct http_request http[1];
1449
1450    /*
1451     * The final forwarding settings.
1452     * XXX: Currently this is only used for forward-override,
1453     * so we can free the space in sweep.
1454     */
1455    struct forward_spec * fwd;
1456
1457    /** An I/O buffer used for buffering data read from the network */
1458    struct iob iob[1];
1459
1460    /** List of all headers for this request */
1461    struct list headers[1];
1462
1463    /** List of all tags that apply to this request */
1464    struct list tags[1];
1465
1466    /** MIME-Type key, see CT_* above */
1467    unsigned int content_type;
1468
1469    /** Actions files associated with this client */
1470    struct file_list *actions_list[MAX_AF_FILES];
1471
1472    /** pcrs job files. */
1473    struct file_list *rlist[MAX_AF_FILES];
1474
1475    /** Length after content modification. */
1476    unsigned long long content_length;
1477
1478 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1479    /** Expected length of content after which we
1480     * should stop reading from the server socket.
1481     */
1482    /* XXX: is this the right location? */
1483    unsigned long long expected_content_length;
1484 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1485
1486 #ifdef FEATURE_TRUST
1487
1488    /** Trust file. */
1489    struct file_list *tlist;
1490
1491 #endif /* def FEATURE_TRUST */
1492
1493    /**
1494     * Failure reason to embedded in the CGI error page,
1495     * or NULL. Currently only used for socks errors.
1496     */
1497    char *error_message;
1498
1499    /** Next thread in linked list. Only read or modify from the main thread! */
1500    struct client_state *next;
1501 };
1502
1503
1504 /**
1505  * A function to add a header
1506  */
1507 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1508
1509 /**
1510  * A function to process a header
1511  */
1512 typedef jb_err (*parser_func_ptr    )(struct client_state *, char **);
1513
1514
1515 /**
1516  * List of available CGI functions.
1517  */
1518 struct cgi_dispatcher
1519 {
1520    /** The URL of the CGI, relative to the CGI root. */
1521    const char * const name;
1522
1523    /** The handler function for the CGI */
1524    jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1525
1526    /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1527    const char * const description;
1528
1529    /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1530    int harmless;
1531 };
1532
1533
1534 /**
1535  * A data file used by Privoxy.  Kept in a linked list.
1536  */
1537 struct file_list
1538 {
1539    /**
1540     * This is a pointer to the data structures associated with the file.
1541     * Read-only once the structure has been created.
1542     */
1543    void *f;
1544
1545    /**
1546     * The unloader function.
1547     * Normally NULL.  When we are finished with file (i.e. when we have
1548     * loaded a new one), set to a pointer to an unloader function.
1549     * Unloader will be called by sweep() (called from main loop) when
1550     * all clients using this file are done.  This prevents threading
1551     * problems.
1552     */
1553    void (*unloader)(void *);
1554
1555    /**
1556     * Used internally by sweep().  Do not access from elsewhere.
1557     */
1558    int active;
1559
1560    /**
1561     * File last-modified time, so we can check if file has been changed.
1562     * Read-only once the structure has been created.
1563     */
1564    time_t lastmodified;
1565    
1566    /**
1567     * The full filename.
1568     */
1569    char * filename;
1570
1571    /**
1572     * Pointer to next entry in the linked list of all "file_list"s.
1573     * This linked list is so that sweep() can navigate it.
1574     * Since sweep() can remove items from the list, we must be careful
1575     * to only access this value from main thread (when we know sweep
1576     * won't be running).
1577     */
1578    struct file_list *next;
1579 };
1580
1581
1582 #ifdef FEATURE_TRUST
1583
1584 /**
1585  * The format of a trust file when loaded into memory.
1586  */
1587 struct block_spec
1588 {
1589    struct url_spec url[1];   /**< The URL pattern              */
1590    int    reject;            /**< FIXME: Please document this! */
1591    struct block_spec *next;  /**< Next entry in linked list    */
1592 };
1593
1594 /**
1595  * Arbitrary limit for the number of trusted referrers.
1596  */
1597 #define MAX_TRUSTED_REFERRERS 512
1598
1599 #endif /* def FEATURE_TRUST */
1600
1601
1602 #define SOCKS_NONE    0    /**< Don't use a SOCKS server               */
1603 #define SOCKS_4      40    /**< original SOCKS 4 protocol              */
1604 #define SOCKS_4A     41    /**< as modified for hosts w/o external DNS */
1605 #define SOCKS_5      50    /**< as modified for hosts w/o external DNS */
1606
1607
1608 /**
1609  * How to forward a connection to a parent proxy.
1610  */
1611 struct forward_spec
1612 {
1613    /** URL pattern that this forward_spec is for. */
1614    struct url_spec url[1];
1615
1616    /** Connection type.  Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1617    int   type;
1618
1619    /** SOCKS server hostname.  Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1620    char *gateway_host;
1621
1622    /** SOCKS server port. */
1623    int   gateway_port;
1624
1625    /** Parent HTTP proxy hostname, or NULL for none. */
1626    char *forward_host;
1627
1628    /** Parent HTTP proxy port. */
1629    int   forward_port;
1630
1631    /** Next entry in the linked list. */
1632    struct forward_spec *next;
1633 };
1634
1635
1636 /**
1637  * Initializer for a static struct forward_spec.
1638  */
1639 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1640
1641 /* Supported filter types */
1642 #define FT_CONTENT_FILTER       0
1643 #define FT_CLIENT_HEADER_FILTER 1
1644 #define FT_SERVER_HEADER_FILTER 2
1645 #define FT_CLIENT_HEADER_TAGGER 3
1646 #define FT_SERVER_HEADER_TAGGER 4
1647
1648 #define MAX_FILTER_TYPES        5
1649
1650 /**
1651  * This struct represents one filter (one block) from
1652  * the re_filterfile. If there is more than one filter
1653  * in the file, the file will be represented by a
1654  * chained list of re_filterfile specs.
1655  */
1656 struct re_filterfile_spec
1657 {
1658    char *name;                      /**< Name from FILTER: statement in re_filterfile. */
1659    char *description;               /**< Description from FILTER: statement in re_filterfile. */
1660    struct list patterns[1];         /**< The patterns from the re_filterfile. */
1661    pcrs_job *joblist;               /**< The resulting compiled pcrs_jobs. */
1662    int type;                        /**< Filter type (content, client-header, server-header). */
1663    int dynamic;                     /**< Set to one if the pattern might contain variables
1664                                          and has to be recompiled for every request. */
1665    struct re_filterfile_spec *next; /**< The pointer for chaining. */
1666 };
1667
1668
1669 #ifdef FEATURE_ACL
1670
1671 #define ACL_PERMIT   1  /**< Accept connection request */
1672 #define ACL_DENY     2  /**< Reject connection request */
1673
1674 /**
1675  * An IP address pattern.  Used to specify networks in the ACL.
1676  */
1677 struct access_control_addr
1678 {
1679 #ifdef HAVE_RFC2553
1680    struct sockaddr_storage addr; /* <The TCP address in network order. */
1681    struct sockaddr_storage mask; /* <The TCP mask in network order. */
1682 #else
1683    unsigned long addr;  /**< The IP address as an integer. */
1684    unsigned long mask;  /**< The network mask as an integer. */
1685    unsigned long port;  /**< The port number. */
1686 #endif /* HAVE_RFC2553 */
1687 };
1688
1689 /**
1690  * An access control list (ACL) entry.
1691  *
1692  * This is a linked list.
1693  */
1694 struct access_control_list
1695 {
1696    struct access_control_addr src[1];  /**< Client IP address */
1697    struct access_control_addr dst[1];  /**< Website or parent proxy IP address */
1698 #ifdef HAVE_RFC2553
1699    int wildcard_dst;                   /** < dst address is wildcard */
1700 #endif
1701
1702    short action;                       /**< ACL_PERMIT or ACL_DENY */
1703    struct access_control_list *next;   /**< The next entry in the ACL. */
1704 };
1705
1706 #endif /* def FEATURE_ACL */
1707
1708
1709 /** Maximum number of loaders (actions, re_filter, ...) */
1710 #define NLOADERS 8
1711
1712
1713 /** configuration_spec::feature_flags: CGI actions editor. */
1714 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS             1U
1715
1716 /** configuration_spec::feature_flags: Web-based toggle. */
1717 #define RUNTIME_FEATURE_CGI_TOGGLE                   2U
1718
1719 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1720 #define RUNTIME_FEATURE_HTTP_TOGGLE                  4U
1721
1722 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1723 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS            8U
1724
1725 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1726 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1727
1728 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1729 #define RUNTIME_FEATURE_ENFORCE_BLOCKS              32U
1730
1731 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1732 #define RUNTIME_FEATURE_CGI_CRUNCHING               64U
1733
1734 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1735 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE      128U
1736
1737 /**
1738  * Data loaded from the configuration file.
1739  *
1740  * (Anomaly: toggle is still handled through a global, not this structure)
1741  */
1742 struct configuration_spec
1743 {
1744    /** What to log */
1745    int debug;
1746    
1747    /** Nonzero to enable multithreading. */
1748    int multi_threaded;
1749
1750    /**
1751     * Bitmask of features that can be enabled/disabled through the config
1752     * file.  Currently defined bits:
1753     *
1754     * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1755     * - RUNTIME_FEATURE_CGI_TOGGLE
1756     * - RUNTIME_FEATURE_HTTP_TOGGLE
1757     * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1758     */
1759    unsigned feature_flags;
1760
1761    /** The log file name. */
1762    const char *logfile;
1763
1764    /** The config file directory. */
1765    const char *confdir;
1766
1767    /** The directory for customized CGI templates. */
1768    const char *templdir;
1769
1770    /** The log file directory. */
1771    const char *logdir;
1772
1773    /** The full paths to the actions files. */
1774    const char *actions_file[MAX_AF_FILES];
1775
1776    /** The short names of the actions files. */
1777    const char *actions_file_short[MAX_AF_FILES];
1778
1779    /** The administrator's email address */
1780    char *admin_address;
1781
1782    /** A URL with info on this proxy */
1783    char *proxy_info_url;
1784
1785    /** URL to the user manual (on our website or local copy) */
1786    char *usermanual;
1787
1788    /** The file names of the pcre filter files. */
1789    const char *re_filterfile[MAX_AF_FILES];
1790
1791    /** The short names of the pcre filter files. */
1792    const char *re_filterfile_short[MAX_AF_FILES];
1793
1794    /** The hostname to show on CGI pages, or NULL to use the real one. */
1795    const char *hostname;
1796
1797    /** IP address to bind to.  Defaults to HADDR_DEFAULT == 127.0.0.1. */
1798    const char *haddr;
1799
1800    /** Port to bind to.  Defaults to HADDR_PORT == 8118. */
1801    int         hport;
1802
1803    /** Size limit for IOB */
1804    size_t buffer_limit;
1805
1806 #ifdef FEATURE_TRUST
1807
1808    /** The file name of the trust file. */
1809    const char * trustfile;
1810
1811    /** FIXME: DOCME: Document this. */
1812    struct list trust_info[1];
1813
1814    /** FIXME: DOCME: Document this. */
1815    struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1816
1817 #endif /* def FEATURE_TRUST */
1818
1819 #ifdef FEATURE_ACL
1820
1821    /** The access control list (ACL). */
1822    struct access_control_list *acl;
1823
1824 #endif /* def FEATURE_ACL */
1825
1826    /** Information about parent proxies (forwarding). */
1827    struct forward_spec *forward;
1828
1829    /** Number of retries in case a forwarded connection attempt fails */
1830    int forwarded_connect_retries;
1831
1832    /** Maximum number of client connections. */
1833    int max_client_connections;
1834
1835    /* Timeout when waiting on sockets for data to become available. */
1836    int socket_timeout;
1837
1838    /** All options from the config file, HTML-formatted. */
1839    char *proxy_args;
1840
1841    /** The configuration file object. */
1842    struct file_list *config_file_list;
1843
1844    /** List of loaders */
1845    int (*loaders[NLOADERS])(struct client_state *);
1846
1847    /** Nonzero if we need to bind() to the new port. */
1848    int need_bind;
1849 };
1850
1851 /** Calculates the number of elements in an array, using sizeof. */
1852 #define SZ(X)  (sizeof(X) / sizeof(*X))
1853
1854 #ifdef FEATURE_FORCE_LOAD
1855 /** The force load URL prefix. */
1856 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1857 #endif /* def FEATURE_FORCE_LOAD */
1858
1859 #ifdef FEATURE_NO_GIFS
1860 /** The MIME type for images ("image/png" or "image/gif"). */
1861 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1862 #else
1863 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1864 #endif /* def FEATURE_NO_GIFS */
1865
1866
1867 /* 
1868  * Hardwired URLs
1869  */
1870
1871 /** URL for the Privoxy home page. */
1872 #define HOME_PAGE_URL     "http://www.privoxy.org/"
1873
1874 /** URL for the Privoxy user manual. */
1875 #define USER_MANUAL_URL   HOME_PAGE_URL VERSION "/user-manual/"
1876
1877 /** Prefix for actions help links  (append to USER_MANUAL_URL). */
1878 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1879
1880 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1881 #define CONFIG_HELP_PREFIX  "config.html#"
1882
1883 /*
1884  * The "hosts" to intercept and display CGI pages.
1885  * First one is a hostname only, second one can specify host and path.
1886  *
1887  * Notes:
1888  * 1) Do not specify the http: prefix
1889  * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1890  * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1891  */
1892 #define CGI_SITE_1_HOST "p.p"
1893 #define CGI_SITE_2_HOST "config.privoxy.org"
1894 #define CGI_SITE_2_PATH ""
1895
1896 /**
1897  * The prefix for CGI pages.  Written out in generated HTML.
1898  * INCLUDES the trailing slash.
1899  */
1900 #define CGI_PREFIX  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1901
1902 #ifdef __cplusplus
1903 } /* extern "C" */
1904 #endif
1905
1906 #endif /* ndef PROJECT_H_INCLUDED */
1907
1908 /*
1909   Local Variables:
1910   tab-width: 3
1911   end:
1912 */