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