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