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