1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.114 2008/04/11 16:35:39 fabiankeil Exp $"
5 /*********************************************************************
7 * File : $Source: /cvsroot/ijbswa/current/project.h,v $
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).
13 * Copyright : Written by and Copyright (C) 2001-2008 the SourceForge
14 * Privoxy team. http://www.privoxy.org/
16 * Based on the Internet Junkbuster originally written
17 * by and Copyright (C) 1997 Anonymous Coders and
18 * Junkbusters Corporation. http://www.junkbusters.com
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.
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.
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.
40 * Revision 1.114 2008/04/11 16:35:39 fabiankeil
41 * Oops, I forgot to shorten the URL_SPEC_INITIALIZER in my last commit.
43 * Revision 1.113 2008/04/10 14:41:04 fabiankeil
44 * Ditch url_spec's path member now that it's no longer used.
46 * Revision 1.112 2008/04/06 15:18:34 fabiankeil
47 * Oh well, rename the --enable-pcre-host-patterns option to
48 * --enable-extended-host-patterns as it's not really PCRE syntax.
50 * Revision 1.111 2008/04/06 14:54:26 fabiankeil
51 * Use PCRE syntax in host patterns when configured
52 * with --enable-pcre-host-patterns.
54 * Revision 1.110 2008/03/29 12:13:46 fabiankeil
55 * Remove send-wafer and send-vanilla-wafer actions.
57 * Revision 1.109 2008/03/28 15:13:41 fabiankeil
58 * Remove inspect-jpegs action.
60 * Revision 1.108 2008/03/27 18:27:36 fabiankeil
61 * Remove kill-popups action.
63 * Revision 1.107 2008/03/26 18:07:08 fabiankeil
64 * Add hostname directive. Closes PR#1918189.
66 * Revision 1.106 2008/03/24 11:21:03 fabiankeil
67 * Share the action settings for multiple patterns in the same
68 * section so we waste less memory for gigantic block lists
69 * (and load them slightly faster). Reported by Franz Schwartau.
71 * Revision 1.105 2008/03/21 11:16:27 fabiankeil
72 * Garbage-collect csp->my_ip_addr_str and csp->my_hostname.
74 * Revision 1.104 2008/03/04 18:30:40 fabiankeil
75 * Remove the treat-forbidden-connects-like-blocks action. We now
76 * use the "blocked" page for forbidden CONNECT requests by default.
78 * Revision 1.103 2008/03/01 14:00:45 fabiankeil
79 * Let the block action take the reason for the block
80 * as argument and show it on the "blocked" page.
82 * Revision 1.102 2008/02/03 13:46:14 fabiankeil
83 * Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
85 * Revision 1.101 2007/12/07 18:29:23 fabiankeil
86 * Remove now-obsolete csp member x_forwarded.
88 * Revision 1.100 2007/09/02 13:42:11 fabiankeil
89 * - Allow port lists in url patterns.
90 * - Ditch unused url_spec member pathlen.
92 * Revision 1.99 2007/07/21 11:51:36 fabiankeil
93 * As Hal noticed, checking dispatch_cgi() as the last cruncher
94 * looks like a bug if CGI requests are blocked unintentionally,
95 * so don't do it unless the user enabled the new config option
96 * "allow-cgi-request-crunching".
98 * Revision 1.98 2007/07/14 07:31:26 fabiankeil
99 * Add new csp->content_type flag (CT_DECLARED).
101 * Revision 1.97 2007/05/27 12:38:08 fabiankeil
102 * - Remove some left-overs from the switch to dedicated header filters.
103 * - Adjust "X-Filter: No" to disable dedicated header filters.
104 * - Prepare for forward-override{}
106 * Revision 1.96 2007/05/14 10:41:15 fabiankeil
107 * Ditch the csp member cookie_list[] which isn't used anymore.
109 * Revision 1.95 2007/04/30 15:02:19 fabiankeil
110 * Introduce dynamic pcrs jobs that can resolve variables.
112 * Revision 1.94 2007/04/15 16:39:21 fabiankeil
113 * Introduce tags as alternative way to specify which
114 * actions apply to a request. At the moment tags can be
115 * created based on client and server headers.
117 * Revision 1.93 2007/03/20 15:16:34 fabiankeil
118 * Use dedicated header filter actions instead of abusing "filter".
119 * Replace "filter-client-headers" and "filter-client-headers"
120 * with "server-header-filter" and "client-header-filter".
122 * Revision 1.92 2007/03/17 15:20:05 fabiankeil
123 * New config option: enforce-blocks.
125 * Revision 1.91 2007/03/05 13:28:03 fabiankeil
126 * Add some CSP_FLAGs for the header parsers.
128 * Revision 1.90 2007/02/07 10:36:16 fabiankeil
129 * Add new http_response member to save
130 * the reason why the response was generated.
132 * Revision 1.89 2007/01/27 13:09:16 fabiankeil
133 * Add new config option "templdir" to
134 * change the templates directory.
136 * Revision 1.88 2007/01/25 13:36:59 fabiankeil
137 * Add csp->error_message for failure reasons
138 * that should be embedded into the CGI pages.
140 * Revision 1.87 2007/01/01 19:36:37 fabiankeil
141 * Integrate a modified version of Wil Mahan's
142 * zlib patch (PR #895531).
144 * Revision 1.86 2006/12/31 17:56:37 fabiankeil
145 * Added config option accept-intercepted-requests
146 * and disabled it by default.
148 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
149 * Fix gcc43 compiler warnings and a comment.
151 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
152 * Add config option "split-large-forms"
153 * to work around the browser bug reported
156 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
157 * Moved HTTP snipplets into jcc.c. They aren't
158 * used anywhere else.
160 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
161 * Doubled size of HOSTENT_BUFFER_SIZE to mask
162 * problems with gethostbyname_r and some
163 * /etc/hosts configurations. Only a workaround
164 * until we get the real fix ready.
165 * Thanks FĂ©lix Rauch for reporting.
167 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
169 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
170 * Respond with 400 and a short text message
171 * if the client tries to use Privoxy as FTP proxy.
173 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
174 * Added config option enable-remote-http-toggle
175 * to specify if Privoxy should recognize special
176 * headers (currently only X-Filter) to change its
177 * behaviour. Disabled by default.
179 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
180 * Make number of retries in case of forwarded-connect problems
181 * a config file option (forwarded-connect-retries) and use 0 as
184 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
185 * Work around a buffer overflow that caused Privoxy to
186 * segfault if too many trusted referrers were used. Good
187 * enough for now, but should be replaced with a real
188 * solution after the next release.
190 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
193 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
194 * Split filter-headers{} into filter-client-headers{}
195 * and filter-server-headers{}.
196 * Added parse_header_time() to share some code.
197 * Replaced timegm() with mktime().
199 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
200 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
202 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
203 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
204 * with what was really the latest development (the v_3_0_branch branch)
206 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
207 * Multiple filter file support
209 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
210 * Add the ability to check jpeg images for invalid
211 * lengths of comment blocks. Defensive strategy
212 * against the exploit:
213 * Microsoft Security Bulletin MS04-028
214 * Buffer Overrun in JPEG Processing (GDI+) Could
215 * Allow Code Execution (833987)
216 * Enabled with +inspect-jpegs in actions files.
218 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
219 * Updated the copyright note
221 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
222 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
224 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
225 * Introduced RC_FLAG_* flags for use in child process return code
227 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
228 * Added flag to each cgi_dispatcher that allows or denies
229 * external linking and removed const qualifier from
230 * struct list_entry.str.
232 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
233 * - Include config.h for access to config data
234 * - Include <pcre*.h> depending on where they are
236 * Revision 1.72 2002/05/14 21:35:49 oes
237 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
238 * because of split in user-manual
240 * Revision 1.71 2002/05/12 21:39:36 jongfoster
241 * - Adding Doxygen-style comments to structures and #defines.
243 * Revision 1.70 2002/05/12 16:05:50 jongfoster
244 * Fixing ACTION_MASK_ALL to be unsigned long rather than
245 * just unsigned int. I don't know if anyone is porting
246 * Privoxy to 16-bit platforms, but if so, +limit-connect
247 * wouldn't have worked because of this bug.
249 * Revision 1.69 2002/05/08 16:00:16 oes
250 * Added size member to struct iob, so it can
251 * be alloced larger than needed.
253 * Revision 1.68 2002/04/26 12:56:00 oes
254 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
256 * Revision 1.67 2002/04/24 02:12:43 oes
257 * - Jon's multiple AF patch:
258 * - Make csp->actions_list an array
259 * - #define MAX_AF_FILES
260 * - Moved CGI_PARAM_LEN_MAX (500) here
262 * Revision 1.66 2002/04/15 19:06:43 jongfoster
265 * Revision 1.65 2002/04/04 00:36:36 gliptak
266 * always use pcre for matching
268 * Revision 1.64 2002/04/03 22:28:03 gliptak
269 * Removed references to gnu_regex
271 * Revision 1.63 2002/03/31 17:19:00 jongfoster
272 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
274 * Revision 1.62 2002/03/26 22:48:49 swa
277 * Revision 1.61 2002/03/26 22:29:55 swa
278 * we have a new homepage!
280 * Revision 1.60 2002/03/24 15:52:17 jongfoster
281 * Changing CGI URL prefixes for new name
283 * Revision 1.59 2002/03/24 15:23:33 jongfoster
286 * Revision 1.58 2002/03/24 13:25:43 swa
287 * name change related issues
289 * Revision 1.57 2002/03/16 20:28:34 oes
290 * Added descriptions to the filters so users will know what they select in the cgi editor
292 * Revision 1.56 2002/03/13 20:27:30 oes
293 * Fixing bug with CT_TABOO
295 * Revision 1.55 2002/03/12 01:42:50 oes
296 * Introduced modular filters
298 * Revision 1.54 2002/03/09 20:03:52 jongfoster
299 * - Making various functions return int rather than size_t.
300 * (Undoing a recent change). Since size_t is unsigned on
301 * Windows, functions like read_socket that return -1 on
302 * error cannot return a size_t.
304 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
305 * crashes, and also frequently caused JB to jump to 100%
306 * CPU and stay there. (Because it thought it had just
307 * read ((unsigned)-1) == 4Gb of data...)
309 * - The signature of write_socket has changed, it now simply
310 * returns success=0/failure=nonzero.
312 * - Trying to get rid of a few warnings --with-debug on
313 * Windows, I've introduced a new type "jb_socket". This is
314 * used for the socket file descriptors. On Windows, this
315 * is SOCKET (a typedef for unsigned). Everywhere else, it's
316 * an int. The error value can't be -1 any more, so it's
317 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
318 * Windows it maps to the #define INVALID_SOCKET.)
320 * - The signature of bind_port has changed.
322 * Revision 1.53 2002/03/08 16:48:55 oes
323 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
325 * Revision 1.52 2002/03/07 03:46:17 oes
326 * Fixed compiler warnings
328 * Revision 1.51 2002/03/05 04:52:42 oes
329 * Deleted non-errlog debugging code
331 * Revision 1.50 2002/03/04 19:32:07 oes
332 * Changed default port to 8118
334 * Revision 1.49 2002/03/04 18:28:55 oes
335 * Deleted PID_FILE_NAME
337 * Revision 1.48 2002/03/03 14:50:40 oes
338 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
340 * Revision 1.47 2002/02/20 23:15:13 jongfoster
341 * Parsing functions now handle out-of-memory gracefully by returning
344 * Revision 1.46 2002/01/17 21:06:09 jongfoster
345 * Now #defining the URLs of the config interface
347 * Minor changes to struct http_request and struct url_spec due to
348 * standardizing that struct http_request is used to represent a URL, and
349 * struct url_spec is used to represent a URL pattern. (Before, URLs were
350 * represented as seperate variables and a partially-filled-in url_spec).
352 * Revision 1.45 2002/01/09 14:33:27 oes
353 * Added HOSTENT_BUFFER_SIZE
355 * Revision 1.44 2001/12/30 14:07:32 steudten
356 * - Add signal handling (unix)
357 * - Add SIGHUP handler (unix)
358 * - Add creation of pidfile (unix)
359 * - Add action 'top' in rc file (RH)
360 * - Add entry 'SIGNALS' to manpage
361 * - Add exit message to logfile (unix)
363 * Revision 1.43 2001/11/22 21:57:51 jongfoster
364 * Making action_spec->flags into an unsigned long rather than just an
366 * Adding ACTION_NO_COOKIE_KEEP
368 * Revision 1.42 2001/11/05 21:42:41 steudten
369 * Include DBG() macro.
371 * Revision 1.41 2001/10/28 19:12:06 jongfoster
372 * Adding ijb_toupper()
374 * Revision 1.40 2001/10/26 17:40:47 oes
375 * Moved ijb_isspace and ijb_tolower to project.h
376 * Removed http->user_agent, csp->referrer and csp->accept_types
378 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
379 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
380 * macro when called with a cast; so moving the cast to the macro def'n
381 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
382 * doesn't make macro expansion complain. Hope this works for everyone else
385 * Revision 1.38 2001/10/23 21:19:04 jongfoster
386 * New error-handling support: jb_err type and JB_ERR_xxx constants
387 * CGI functions now return a jb_err, and their parameters map is const.
388 * Support for RUNTIME_FEATUREs to enable/disable config editor
389 * Adding a few comments
391 * Revision 1.37 2001/10/14 22:14:01 jongfoster
392 * Removing name_length field from struct cgi_dispatcher, as this is
393 * now calculated at runtime from the "name" field.
395 * Revision 1.36 2001/10/10 16:45:15 oes
396 * Added LIMIT_CONNECT action and string
397 * Fixed HTTP message line termination
398 * Added CFORBIDDEN HTTP message
400 * Revision 1.35 2001/10/07 18:06:43 oes
401 * Added status member to struct http_request
403 * Revision 1.34 2001/10/07 15:45:25 oes
404 * Added url member to struct http_request and commented all
409 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
411 * Replaced struct client_state members rejected,
412 * force, active and toggled_on with "flags" bitmap.
414 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
416 * Added buffer_limit to struct configuration_spec
418 * Revision 1.33 2001/09/20 13:30:08 steudten
420 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
421 * Last case will set z to NULL in free(z) and thats bad..
423 * Revision 1.32 2001/09/16 23:02:51 jongfoster
426 * Revision 1.31 2001/09/16 13:20:29 jongfoster
427 * Rewrite of list library. Now has seperate header and list_entry
428 * structures. Also added a large sprinking of assert()s to the list
431 * Revision 1.30 2001/09/13 23:52:00 jongfoster
432 * Support for both static and dynamically generated CGI pages
434 * Revision 1.29 2001/09/13 23:29:43 jongfoster
435 * Defining FORWARD_SPEC_INITIALIZER
437 * Revision 1.28 2001/09/13 23:05:50 jongfoster
438 * Changing the string paramater to the header parsers a "const".
440 * Revision 1.27 2001/08/05 16:06:20 jongfoster
441 * Modifiying "struct map" so that there are now separate header and
442 * "map_entry" structures. This means that functions which modify a
443 * map no longer need to return a pointer to the modified map.
444 * Also, it no longer reverses the order of the entries (which may be
445 * important with some advanced template substitutions).
447 * Revision 1.26 2001/07/30 22:08:36 jongfoster
448 * Tidying up #defines:
449 * - All feature #defines are now of the form FEATURE_xxx
450 * - Permanently turned off WIN_GUI_EDIT
451 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
453 * Revision 1.25 2001/07/29 18:43:08 jongfoster
454 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
457 * Revision 1.24 2001/07/25 17:20:27 oes
458 * Introduced http->user_agent
460 * Revision 1.23 2001/07/18 12:32:23 oes
461 * - Added ACTION_STRING_DEANIMATE
462 * - moved #define freez from jcc.h to project.h
464 * Revision 1.22 2001/07/15 17:51:41 jongfoster
465 * Renaming #define STATIC to STATIC_PCRE
467 * Revision 1.21 2001/07/13 14:03:19 oes
468 * - Reorganized regex header inclusion and #defines to
469 * comply to the scheme in configure.in
470 * - Added csp->content_type and its CT_* keys
471 * - Added ACTION_DEANIMATE
472 * - Removed all #ifdef PCRS
474 * Revision 1.20 2001/06/29 21:45:41 oes
475 * Indentation, CRLF->LF, Tab-> Space
477 * Revision 1.19 2001/06/29 13:33:36 oes
478 * - Improved comments
479 * - Introduced http_request.host_ip_addr_str
480 * - Introduced http_response.head_length
481 * - Introduced config.my_ip_addr_str, config.my_hostname,
482 * config.admin_address and config.proxy_info_url
483 * - Removed config.proxy_args_header and config.proxy_args_trailer,
484 * renamed config.proxy_args_invocation to config.proxy_args
485 * - Removed HTML snipplets and GIFs
486 * - Removed logentry from cancelled commit
488 * Revision 1.18 2001/06/09 10:57:39 jongfoster
489 * Adding definition of BUFFER_SIZE.
490 * Changing struct cgi_dispatcher to use "const" strings.
492 * Revision 1.17 2001/06/07 23:15:09 jongfoster
493 * Merging ACL and forward files into config file.
494 * Moving struct gateway members into struct forward_spec
495 * Removing config->proxy_args_gateways
496 * Cosmetic: Adding a few comments
498 * Revision 1.16 2001/06/04 18:31:58 swa
499 * files are now prefixed with either `confdir' or `logdir'.
500 * `make redhat-dist' replaces both entries confdir and logdir
503 * Revision 1.15 2001/06/04 11:28:53 swa
504 * redirect did not work due to missing /
506 * Revision 1.14 2001/06/03 11:03:48 oes
508 * added struct http_response,
509 * changed struct interceptors to struct cgi_dispatcher,
510 * moved HTML stuff to cgi.h
512 * Revision 1.13 2001/06/01 20:05:36 jongfoster
513 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
514 * constant, and removed csp->tinygif.
516 * Revision 1.12 2001/06/01 18:49:17 jongfoster
517 * Replaced "list_share" with "list" - the tiny memory gain was not
518 * worth the extra complexity.
520 * Revision 1.11 2001/06/01 10:32:47 oes
521 * Added constants for anchoring selection bitmap
523 * Revision 1.10 2001/05/31 21:33:53 jongfoster
524 * Changes for new actions file, replacing permissionsfile
525 * and parts of the config file. Also added support for
528 * Revision 1.9 2001/05/31 17:32:31 oes
530 * - Enhanced domain part globbing with infix and prefix asterisk
531 * matching and optional unanchored operation
533 * Revision 1.8 2001/05/29 20:09:15 joergs
534 * HTTP_REDIRECT_TEMPLATE fixed.
536 * Revision 1.7 2001/05/29 09:50:24 jongfoster
537 * Unified blocklist/imagelist/actionslist.
538 * File format is still under discussion, but the internal changes
541 * Also modified interceptor behaviour:
542 * - We now intercept all URLs beginning with one of the following
543 * prefixes (and *only* these prefixes):
545 * * http://ijbswa.sf.net/config/
546 * * http://ijbswa.sourceforge.net/config/
547 * - New interceptors "home page" - go to http://i.j.b/ to see it.
548 * - Internal changes so that intercepted and fast redirect pages
549 * are not replaced with an image.
550 * - Interceptors now have the option to send a binary page direct
551 * to the client. (i.e. ijb-send-banner uses this)
552 * - Implemented show-url-info interceptor. (Which is why I needed
553 * the above interceptors changes - a typical URL is
554 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
555 * The previous mechanism would not have intercepted that, and
556 * if it had been intercepted then it then it would have replaced
559 * Revision 1.6 2001/05/27 22:17:04 oes
561 * - re_process_buffer no longer writes the modified buffer
562 * to the client, which was very ugly. It now returns the
563 * buffer, which it is then written by chat.
565 * - content_length now adjusts the Content-Length: header
566 * for modified documents rather than crunch()ing it.
567 * (Length info in csp->content_length, which is 0 for
568 * unmodified documents)
570 * - For this to work, sed() is called twice when filtering.
572 * Revision 1.5 2001/05/26 00:28:36 jongfoster
573 * Automatic reloading of config file.
574 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
575 * Most of the global variables have been moved to a new
576 * struct configuration_spec, accessed through csp->config->globalname
577 * Most of the globals remaining are used by the Win32 GUI.
579 * Revision 1.4 2001/05/22 18:46:04 oes
581 * - Enabled filtering banners by size rather than URL
582 * by adding patterns that replace all standard banner
583 * sizes with the "Junkbuster" gif to the re_filterfile
585 * - Enabled filtering WebBugs by providing a pattern
586 * which kills all 1x1 images
588 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
589 * which is selected by the (nonstandard and therefore
590 * capital) letter 'U' in the option string.
591 * It causes the quantifiers to be ungreedy by default.
592 * Appending a ? turns back to greedy (!).
594 * - Added a new interceptor ijb-send-banner, which
595 * sends back the "Junkbuster" gif. Without imagelist or
596 * MSIE detection support, or if tinygif = 1, or the
597 * URL isn't recognized as an imageurl, a lame HTML
598 * explanation is sent instead.
600 * - Added new feature, which permits blocking remote
601 * script redirects and firing back a local redirect
603 * The feature is conditionally compiled, i.e. it
604 * can be disabled with --disable-fast-redirects,
605 * plus it must be activated by a "fast-redirects"
606 * line in the config file, has its own log level
607 * and of course wants to be displayed by show-proxy-args
608 * Note: Boy, all the #ifdefs in 1001 locations and
609 * all the fumbling with configure.in and acconfig.h
610 * were *way* more work than the feature itself :-(
612 * - Because a generic redirect template was needed for
613 * this, tinygif = 3 now uses the same.
615 * - Moved GIFs, and other static HTTP response templates
620 * - Removed some >400 CRs again (Jon, you really worked
623 * Revision 1.3 2001/05/20 01:21:20 jongfoster
624 * Version 2.9.4 checkin.
625 * - Merged popupfile and cookiefile, and added control over PCRS
626 * filtering, in new "actionsfile".
627 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
628 * file error you now get a message box (in the Win32 GUI) rather
629 * than the program exiting with no explanation.
630 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
632 * - Removed tabs from "config"
633 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
634 * - Bumped up version number.
636 * Revision 1.2 2001/05/17 23:01:01 oes
637 * - Cleaned CRLF's from the sources and related files
639 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
640 * Initial import of version 2.9.3 source tree
643 *********************************************************************/
646 /* Declare struct FILE for vars and funcs. */
649 /* Need time_t for file_list */
651 /* Needed for pcre choice */
655 * Include appropriate regular expression libraries.
656 * Note that pcrs and pcre (native) are needed for cgi
657 * and are included anyway.
663 # ifdef PCRE_H_IN_SUBDIR
664 # include <pcre/pcre.h>
677 # include "pcreposix.h"
679 # ifdef PCRE_H_IN_SUBDIR
680 # include <pcre/pcreposix.h>
682 # include <pcreposix.h>
688 #endif /* def AMIGA */
692 * I don't want to have to #include all this just for the declaration
693 * of SOCKET. However, it looks like we have to...
708 typedef SOCKET jb_socket;
710 #define JB_INVALID_SOCKET INVALID_SOCKET
712 #else /* ndef _WIN32 */
715 * The type used by sockets. On UNIX it's an int. Microsoft decided to
716 * make it an unsigned.
718 typedef int jb_socket;
721 * The error value used for variables of type jb_socket. On UNIX this
722 * is -1, however Microsoft decided to make socket handles unsigned, so
723 * they use a different value.
726 #define JB_INVALID_SOCKET (-1)
728 #endif /* ndef _WIN32 */
732 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
737 #define JB_ERR_OK 0 /**< Success, no error */
738 #define JB_ERR_MEMORY 1 /**< Out of memory */
739 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
740 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
741 #define JB_ERR_PARSE 4 /**< Error parsing file */
742 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
743 CGI actions editor. */
744 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
747 * This macro is used to free a pointer that may be NULL.
748 * It also sets the variable to NULL after it's been freed.
749 * The paramater should be a simple variable without side effects.
751 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
755 * Fix a problem with Solaris. There should be no effect on other
758 * Solaris's isspace() is a macro which uses it's argument directly
759 * as an array index. Therefore we need to make sure that high-bit
760 * characters generate +ve values, and ideally we also want to make
761 * the argument match the declared parameter type of "int".
763 * Note: Remember to #include <ctype.h> if you use these macros.
765 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
766 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
767 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
770 * Use for statically allocated buffers if you have no other choice.
771 * Remember to check the length of what you write into the buffer
772 * - we don't want any buffer overflows!
774 #define BUFFER_SIZE 5000
777 * Max length of CGI parameters (arbitrary limit).
779 #define CGI_PARAM_LEN_MAX 500
782 * Buffer size for capturing struct hostent data in the
783 * gethostby(name|addr)_r library calls. Since we don't
784 * loop over gethostbyname_r, the buffer must be sufficient
785 * to accomodate multiple IN A RRs, as used in DNS round robin
786 * load balancing. W3C's wwwlib uses 1K, so that should be
787 * good enough for us, too.
790 * XXX: Temporary doubled, for some configurations
791 * 1K is still too small and we didn't get the
792 * real fix ready for inclusion.
794 #define HOSTENT_BUFFER_SIZE 2048
797 * Do not use. Originally this was so that you can
798 * say "while (FOREVER) { ...do something... }".
799 * However, this gives a warning with some compilers (e.g. VC++).
800 * Instead, use "for (;;) { ...do something... }".
805 * Default IP address to listen on, as a string.
806 * Set to "127.0.0.1".
808 #define HADDR_DEFAULT "127.0.0.1"
811 * Default port to listen on, as a number.
814 #define HADDR_PORT 8118
817 /* Forward def for struct client_state */
818 struct configuration_spec;
822 * Entry in a linked list of strings.
827 * The string pointer. It must point to a dynamically malloc()ed
828 * string or be NULL for the list functions to work. In the latter
829 * case, just be careful next time you iterate through the list in
834 /** Next entry in the linked list, or NULL if no more. */
835 struct list_entry *next;
839 * A header for a linked list of strings.
843 /** First entry in the list, or NULL if the list is empty. */
844 struct list_entry *first;
846 /** Last entry in the list, or NULL if the list is empty. */
847 struct list_entry *last;
852 * An entry in a map. This is a name=value pair.
856 /** The key for the map. */
858 /** The value associated with that key. */
860 /** The next map entry, or NULL if none. */
861 struct map_entry *next;
865 * A map from a string to another string.
866 * This is used for the paramaters passed in a HTTP GET request, and
867 * to store the exports when the CGI interface is filling in a template.
871 /** The first map entry, or NULL if the map is empty. */
872 struct map_entry *first;
873 /** The last map entry, or NULL if the map is empty. */
874 struct map_entry *last;
879 * A HTTP request. This includes the method (GET, POST) and
882 * This is also used whenever we want to match a URL against a
883 * URL pattern. This always contains the URL to match, and never
884 * a URL pattern. (See struct url_spec).
888 char *cmd; /**< Whole command line: method, URL, Version */
889 char *ocmd; /**< Backup of original cmd for CLF logging */
890 char *gpc; /**< HTTP method: GET, POST, ... */
891 char *url; /**< The URL */
892 char *ver; /**< Protocol version */
893 int status; /**< HTTP Status */
895 char *host; /**< Host part of URL */
896 int port; /**< Port of URL or 80 (default) */
897 char *path; /**< Path of URL */
898 char *hostport; /**< host[:port] */
899 int ssl; /**< Flag if protocol is https */
901 char *host_ip_addr_str; /**< String with dotted decimal representation
902 of host's IP. NULL before connect_to() */
904 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
905 char **dvec; /**< List of pointers to the strings in dbuffer. */
906 int dcount; /**< How many parts to this domain? (length of dvec) */
910 * Reasons for generating a http_response instead of delivering
911 * the requested resource. Mostly ordered the way they are checked
914 #define RSP_REASON_UNSUPPORTED 1
915 #define RSP_REASON_BLOCKED 2
916 #define RSP_REASON_UNTRUSTED 3
917 #define RSP_REASON_REDIRECTED 4
918 #define RSP_REASON_CGI_CALL 5
919 #define RSP_REASON_NO_SUCH_DOMAIN 6
920 #define RSP_REASON_FORWARDING_FAILED 7
921 #define RSP_REASON_CONNECT_FAILED 8
922 #define RSP_REASON_OUT_OF_MEMORY 9
923 #define RSP_REASON_INTERNAL_ERROR 10
926 * Response generated by CGI, blocker, or error handler
930 char *status; /**< HTTP status (string). */
931 struct list headers[1]; /**< List of header lines. */
932 char *head; /**< Formatted http response head. */
933 size_t head_length; /**< Length of http response head. */
934 char *body; /**< HTTP document body. */
935 size_t content_length; /**< Length of body, REQUIRED if binary body. */
936 int is_static; /**< Nonzero if the content will never change and
937 should be cached by the browser (e.g. images). */
938 int reason; /**< Why the response was generated in the first place. */
942 * A URL or a tag pattern.
946 /** The string which was parsed to produce this url_spec.
947 Used for debugging or display only. */
950 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
951 regex_t *host_regex;/**< Regex for host matching */
953 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
954 char **dvec; /**< List of pointers to the strings in dbuffer. */
955 int dcount; /**< How many parts to this domain? (length of dvec) */
956 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
957 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
959 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
961 regex_t *preg; /**< Regex for matching path part */
962 regex_t *tag_regex; /**< Regex for matching tags */
966 * If you declare a static url_spec, this is the value to initialize it to zero.
968 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
969 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
971 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
972 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
975 * Constant for host part matching in URLs. If set, indicates that the start of
976 * the pattern must match the start of the URL. E.g. this is not set for the
977 * pattern ".example.com", so that it will match both "example.com" and
978 * "www.example.com". It is set for the pattern "example.com", which makes it
979 * match "example.com" only, not "www.example.com".
981 #define ANCHOR_LEFT 1
984 * Constant for host part matching in URLs. If set, indicates that the end of
985 * the pattern must match the end of the URL. E.g. this is not set for the
986 * pattern "ad.", so that it will match any host called "ad", irrespective
987 * of how many subdomains are in the fully-qualified domain name.
989 #define ANCHOR_RIGHT 2
993 * An I/O buffer. Holds a string which can be appended to, and can have data
994 * removed from the beginning.
998 char *buf; /**< Start of buffer */
999 char *cur; /**< Start of relevant data */
1000 char *eod; /**< End of relevant data */
1001 size_t size; /**< Size as malloc()ed */
1006 * Return the number of bytes in the I/O buffer associated with the passed
1007 * client_state pointer.
1010 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
1014 * Remove any data in the I/O buffer associated with the passed
1015 * client_state pointer.
1017 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
1019 /* Bits for csp->content_type bitmask: */
1020 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
1021 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
1022 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
1024 /* Although these are not, strictly speaking, content types
1025 * (they are content encodings), it is simple to handle them
1028 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
1029 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
1032 * Flag to signal that the server declared the content type,
1033 * so we can differentiate between unknown and undeclared
1036 #define CT_DECLARED 0x0040U
1039 * The mask which includes all actions.
1041 #define ACTION_MASK_ALL (~0UL)
1044 * The most compatible set of actions - i.e. none.
1046 #define ACTION_MOST_COMPATIBLE 0x00000000UL
1048 /** Action bitmap: Block the request. */
1049 #define ACTION_BLOCK 0x00000001UL
1050 /** Action bitmap: Deanimate if it's a GIF. */
1051 #define ACTION_DEANIMATE 0x00000002UL
1052 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
1053 #define ACTION_DOWNGRADE 0x00000004UL
1054 /** Action bitmap: Fast redirects. */
1055 #define ACTION_FAST_REDIRECTS 0x00000008UL
1056 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
1057 #define ACTION_HIDE_FORWARDED 0x00000010UL
1058 /** Action bitmap: Hide "From" header. */
1059 #define ACTION_HIDE_FROM 0x00000020UL
1060 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
1061 #define ACTION_HIDE_REFERER 0x00000040UL
1062 /** Action bitmap: Hide "User-Agent" and similar headers. */
1063 #define ACTION_HIDE_USER_AGENT 0x00000080UL
1064 /** Action bitmap: This is an image. */
1065 #define ACTION_IMAGE 0x00000100UL
1066 /** Action bitmap: Sets the image blocker. */
1067 #define ACTION_IMAGE_BLOCKER 0x00000200UL
1068 /** Action bitmap: Prevent compression. */
1069 #define ACTION_NO_COMPRESSION 0x00000400UL
1070 /** Action bitmap: Change cookies to session only cookies. */
1071 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
1072 /** Action bitmap: Block rending cookies. */
1073 #define ACTION_NO_COOKIE_READ 0x00001000UL
1074 /** Action bitmap: Block setting cookies. */
1075 #define ACTION_NO_COOKIE_SET 0x00002000UL
1076 /** Action bitmap: Override the forward settings in the config file */
1077 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
1078 /** Action bitmap: Block as empty document */
1079 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
1080 /** Action bitmap: Limit CONNECT requests to safe ports. */
1081 #define ACTION_LIMIT_CONNECT 0x00010000UL
1082 /** Action bitmap: Redirect request. */
1083 #define ACTION_REDIRECT 0x00020000UL
1084 /** Action bitmap: Crunch or modify "if-modified-since" header. */
1085 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
1086 /** Action bitmap: Overwrite Content-Type header. */
1087 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
1088 /** Action bitmap: Crunch specified server header. */
1089 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
1090 /** Action bitmap: Crunch specified client header */
1091 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
1092 /** Action bitmap: Enable text mode by force */
1093 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
1094 /** Action bitmap: Enable text mode by force */
1095 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
1096 /** Action bitmap: Enable content-dispostion crunching */
1097 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
1098 /** Action bitmap: Replace or block Last-Modified header */
1099 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
1100 /** Action bitmap: Replace or block Accept-Language header */
1101 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
1104 /** Action string index: How to deanimate GIFs */
1105 #define ACTION_STRING_DEANIMATE 0
1106 /** Action string index: Replacement for "From:" header */
1107 #define ACTION_STRING_FROM 1
1108 /** Action string index: How to block images */
1109 #define ACTION_STRING_IMAGE_BLOCKER 2
1110 /** Action string index: Replacement for "Referer:" header */
1111 #define ACTION_STRING_REFERER 3
1112 /** Action string index: Replacement for "User-Agent:" header */
1113 #define ACTION_STRING_USER_AGENT 4
1114 /** Action string index: Legal CONNECT ports. */
1115 #define ACTION_STRING_LIMIT_CONNECT 5
1116 /** Action string index: Server headers containing this pattern are crunched*/
1117 #define ACTION_STRING_SERVER_HEADER 6
1118 /** Action string index: Client headers containing this pattern are crunched*/
1119 #define ACTION_STRING_CLIENT_HEADER 7
1120 /** Action string index: Replacement for the "Accept-Language:" header*/
1121 #define ACTION_STRING_LANGUAGE 8
1122 /** Action string index: Replacement for the "Content-Type:" header*/
1123 #define ACTION_STRING_CONTENT_TYPE 9
1124 /** Action string index: Replacement for the "content-dispostion:" header*/
1125 #define ACTION_STRING_CONTENT_DISPOSITION 10
1126 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1127 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1128 /** Action string index: Replacement for the "Last-Modified:" header. */
1129 #define ACTION_STRING_LAST_MODIFIED 12
1130 /** Action string index: Redirect URL */
1131 #define ACTION_STRING_REDIRECT 13
1132 /** Action string index: Decode before redirect? */
1133 #define ACTION_STRING_FAST_REDIRECTS 14
1134 /** Action string index: Overriding forward rule. */
1135 #define ACTION_STRING_FORWARD_OVERRIDE 15
1136 /** Action string index: Reason for the block. */
1137 #define ACTION_STRING_BLOCK 16
1138 /** Number of string actions. */
1139 #define ACTION_STRING_COUNT 17
1142 /* To make the ugly hack in sed easier to understand */
1143 #define CHECK_EVERY_HEADER_REMAINING 0
1146 /** Index into current_action_spec::multi[] for headers to add. */
1147 #define ACTION_MULTI_ADD_HEADER 0
1148 /** Index into current_action_spec::multi[] for content filters to apply. */
1149 #define ACTION_MULTI_FILTER 1
1150 /** Index into current_action_spec::multi[] for server-header filters to apply. */
1151 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
1152 /** Index into current_action_spec::multi[] for client-header filters to apply. */
1153 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
1154 /** Index into current_action_spec::multi[] for client-header tags to apply. */
1155 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
1156 /** Index into current_action_spec::multi[] for server-header tags to apply. */
1157 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
1158 /** Number of multi-string actions. */
1159 #define ACTION_MULTI_COUNT 6
1163 * This structure contains a list of actions to apply to a URL.
1164 * It only contains positive instructions - no "-" options.
1165 * It is not used to store the actions list itself, only for
1166 * url_actions() to return the current values.
1168 struct current_action_spec
1170 /** Actions to apply. A bit set to "1" means perform the action. */
1171 unsigned long flags;
1174 * Paramaters for those actions that require them.
1175 * Each entry is valid if & only if the corresponding entry in "flags" is
1178 char * string[ACTION_STRING_COUNT];
1180 /** Lists of strings for multi-string actions. */
1181 struct list multi[ACTION_MULTI_COUNT][1];
1186 * This structure contains a set of changes to actions.
1187 * It can contain both positive and negative instructions.
1188 * It is used to store an entry in the actions list.
1192 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1193 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1196 * Paramaters for those actions that require them.
1197 * Each entry is valid if & only if the corresponding entry in "flags" is
1200 char * string[ACTION_STRING_COUNT];
1202 /** Lists of strings to remove, for multi-string actions. */
1203 struct list multi_remove[ACTION_MULTI_COUNT][1];
1205 /** If nonzero, remove *all* strings from the multi-string action. */
1206 int multi_remove_all[ACTION_MULTI_COUNT];
1208 /** Lists of strings to add, for multi-string actions. */
1209 struct list multi_add[ACTION_MULTI_COUNT][1];
1214 * This structure is used to store action files.
1216 * It contains an URL or tag pattern, and the changes to
1217 * the actions. It's a linked list and should only be
1218 * free'd through unload_actions_file() unless there's
1219 * only a single entry.
1223 struct url_spec url[1]; /**< The URL or tag pattern. */
1225 struct action_spec *action; /**< Action settings that might be shared with
1226 the list entry before or after the current
1227 one and can't be free'd willy nilly. */
1229 struct url_actions *next; /**< Next action section in file, or NULL. */
1234 * Flags for use in csp->flags
1238 * Flag for csp->flags: Set if this client is processing data.
1239 * Cleared when the thread associated with this structure dies.
1241 #define CSP_FLAG_ACTIVE 0x01
1244 * Flag for csp->flags: Set if the server's reply is in "chunked"
1247 #define CSP_FLAG_CHUNKED 0x02
1250 * Flag for csp->flags: Set if this request was enforced, although it would
1251 * normally have been blocked.
1253 #define CSP_FLAG_FORCED 0x04
1256 * Flag for csp->flags: Set if any modification to the body was done.
1258 #define CSP_FLAG_MODIFIED 0x08
1261 * Flag for csp->flags: Set if request was blocked.
1263 #define CSP_FLAG_REJECTED 0x10
1266 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1268 #define CSP_FLAG_TOGGLED_ON 0x20
1271 * Flag for csp->flags: Set if adding the 'Connection: close' header
1272 * for the client isn't necessary.
1274 #define CSP_FLAG_CLIENT_CONNECTION_CLOSE_SET 0x00000040UL
1277 * Flag for csp->flags: Set if adding the 'Connection: close' header
1278 * for the server isn't necessary.
1280 #define CSP_FLAG_SERVER_CONNECTION_CLOSE_SET 0x00000080UL
1283 * Flag for csp->flags: Signals header parsers whether they
1284 * are parsing server or client headers.
1286 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100UL
1289 * Flag for csp->flags: Set if adding the Host: header
1292 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200UL
1295 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
1296 * XXX: As we now have tags we might as well ditch this.
1298 #define CSP_FLAG_NO_FILTERING 0x00000400UL
1302 * Flags for use in return codes of child processes
1306 * Flag for process return code: Set if exiting porcess has been toggled
1307 * during its lifetime.
1309 #define RC_FLAG_TOGGLED 0x10
1312 * Flag for process return code: Set if exiting porcess has blocked its
1315 #define RC_FLAG_BLOCKED 0x20
1318 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1321 #define MAX_AF_FILES 10
1324 * The state of a Privoxy processing thread.
1328 /** The proxy's configuration */
1329 struct configuration_spec * config;
1331 /** The actions to perform on the current request */
1332 struct current_action_spec action[1];
1334 /** socket to talk to client (web browser) */
1337 /** socket to talk to server (web server or proxy) */
1340 /** Multi-purpose flag container, see CSP_FLAG_* above */
1343 /** Client PC's IP address, as reported by the accept() function.
1346 /** Client PC's IP address, as reported by the accept() function.
1350 /** The URL that was requested */
1351 struct http_request http[1];
1354 * The final forwarding settings.
1355 * XXX: Currently this is only used for forward-override,
1356 * so we can free the space in sweep.
1358 struct forward_spec * fwd;
1360 /** An I/O buffer used for buffering data read from the network */
1363 /** List of all headers for this request */
1364 struct list headers[1];
1366 /** List of all tags that apply to this request */
1367 struct list tags[1];
1369 /** MIME-Type key, see CT_* above */
1370 unsigned int content_type;
1372 /** Actions files associated with this client */
1373 struct file_list *actions_list[MAX_AF_FILES];
1375 /** pcrs job files. */
1376 struct file_list *rlist[MAX_AF_FILES];
1378 /** Length after content modification. */
1379 size_t content_length;
1381 #ifdef FEATURE_TRUST
1384 struct file_list *tlist;
1386 #endif /* def FEATURE_TRUST */
1389 * Failure reason to embedded in the CGI error page,
1390 * or NULL. Currently only used for socks errors.
1392 char *error_message;
1394 /** Next thread in linked list. Only read or modify from the main thread! */
1395 struct client_state *next;
1400 * A function to add a header
1402 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1405 * A function to process a header
1407 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1411 * List of functions to run on a list of headers
1415 /** The header prefix to match */
1418 /** The length of the prefix to match */
1421 /** The function to apply to this line */
1422 const parser_func_ptr parser;
1427 * List of available CGI functions.
1429 struct cgi_dispatcher
1431 /** The URL of the CGI, relative to the CGI root. */
1432 const char * const name;
1434 /** The handler function for the CGI */
1435 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1437 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1438 const char * const description;
1440 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1446 * A data file used by Privoxy. Kept in a linked list.
1451 * This is a pointer to the data structures associated with the file.
1452 * Read-only once the structure has been created.
1457 * The unloader function.
1458 * Normally NULL. When we are finished with file (i.e. when we have
1459 * loaded a new one), set to a pointer to an unloader function.
1460 * Unloader will be called by sweep() (called from main loop) when
1461 * all clients using this file are done. This prevents threading
1464 void (*unloader)(void *);
1467 * Used internally by sweep(). Do not access from elsewhere.
1472 * File last-modified time, so we can check if file has been changed.
1473 * Read-only once the structure has been created.
1475 time_t lastmodified;
1478 * The full filename.
1483 * Pointer to next entry in the linked list of all "file_list"s.
1484 * This linked list is so that sweep() can navigate it.
1485 * Since sweep() can remove items from the list, we must be careful
1486 * to only access this value from main thread (when we know sweep
1487 * won't be running).
1489 struct file_list *next;
1493 #ifdef FEATURE_TRUST
1496 * The format of a trust file when loaded into memory.
1500 struct url_spec url[1]; /**< The URL pattern */
1501 int reject; /**< FIXME: Please document this! */
1502 struct block_spec *next; /**< Next entry in linked list */
1506 * Arbitrary limit for the number of trusted referrers.
1508 #define MAX_TRUSTED_REFERRERS 512
1510 #endif /* def FEATURE_TRUST */
1513 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1514 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1515 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1516 #define SOCKS_5 50 /**< as modified for hosts w/o external DNS */
1520 * How to forward a connection to a parent proxy.
1524 /** URL pattern that this forward_spec is for. */
1525 struct url_spec url[1];
1527 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1530 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1533 /** SOCKS server port. */
1536 /** Parent HTTP proxy hostname, or NULL for none. */
1539 /** Parent HTTP proxy port. */
1542 /** Next entry in the linked list. */
1543 struct forward_spec *next;
1548 * Initializer for a static struct forward_spec.
1550 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1552 /* Supported filter types */
1553 #define FT_CONTENT_FILTER 0
1554 #define FT_CLIENT_HEADER_FILTER 1
1555 #define FT_SERVER_HEADER_FILTER 2
1556 #define FT_CLIENT_HEADER_TAGGER 3
1557 #define FT_SERVER_HEADER_TAGGER 4
1559 #define MAX_FILTER_TYPES 5
1562 * This struct represents one filter (one block) from
1563 * the re_filterfile. If there is more than one filter
1564 * in the file, the file will be represented by a
1565 * chained list of re_filterfile specs.
1567 struct re_filterfile_spec
1569 char *name; /**< Name from FILTER: statement in re_filterfile. */
1570 char *description; /**< Description from FILTER: statement in re_filterfile. */
1571 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1572 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1573 int type; /**< Filter type (content, client-header, server-header). */
1574 int dynamic; /**< Set to one if the pattern might contain variables
1575 and has to be recompiled for every request. */
1576 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1582 #define ACL_PERMIT 1 /**< Accept connection request */
1583 #define ACL_DENY 2 /**< Reject connection request */
1586 * An IP address pattern. Used to specify networks in the ACL.
1588 struct access_control_addr
1590 unsigned long addr; /**< The IP address as an integer. */
1591 unsigned long mask; /**< The network mask as an integer. */
1592 unsigned long port; /**< The port number. */
1596 * An access control list (ACL) entry.
1598 * This is a linked list.
1600 struct access_control_list
1602 struct access_control_addr src[1]; /**< Client IP address */
1603 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1605 short action; /**< ACL_PERMIT or ACL_DENY */
1606 struct access_control_list *next; /**< The next entry in the ACL. */
1609 #endif /* def FEATURE_ACL */
1612 /** Maximum number of loaders (actions, re_filter, ...) */
1616 /** configuration_spec::feature_flags: CGI actions editor. */
1617 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1619 /** configuration_spec::feature_flags: Web-based toggle. */
1620 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1622 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1623 #define RUNTIME_FEATURE_HTTP_TOGGLE 4
1625 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1626 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8
1628 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1629 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16
1631 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1632 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32
1634 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1635 #define RUNTIME_FEATURE_CGI_CRUNCHING 64
1639 * Data loaded from the configuration file.
1641 * (Anomaly: toggle is still handled through a global, not this structure)
1643 struct configuration_spec
1648 /** Nonzero to enable multithreading. */
1652 * Bitmask of features that can be enabled/disabled through the config
1653 * file. Currently defined bits:
1655 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1656 * - RUNTIME_FEATURE_CGI_TOGGLE
1657 * - RUNTIME_FEATURE_HTTP_TOGGLE
1658 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1660 unsigned feature_flags;
1662 /** The log file name. */
1663 const char *logfile;
1665 /** The config file directory. */
1666 const char *confdir;
1668 /** The directory for customized CGI templates. */
1669 const char *templdir;
1671 /** The log file directory. */
1674 /** The full paths to the actions files. */
1675 const char *actions_file[MAX_AF_FILES];
1677 /** The short names of the actions files. */
1678 const char *actions_file_short[MAX_AF_FILES];
1680 /** The administrator's email address */
1681 char *admin_address;
1683 /** A URL with info on this proxy */
1684 char *proxy_info_url;
1686 /** URL to the user manual (on our website or local copy) */
1689 /** The file names of the pcre filter files. */
1690 const char *re_filterfile[MAX_AF_FILES];
1692 /** The short names of the pcre filter files. */
1693 const char *re_filterfile_short[MAX_AF_FILES];
1695 /** The hostname to show on CGI pages, or NULL to use the real one. */
1696 const char *hostname;
1698 #ifdef FEATURE_COOKIE_JAR
1700 /** The file name of the cookie jar file */
1701 const char * jarfile;
1703 /** The handle to the cookie jar file */
1706 #endif /* def FEATURE_COOKIE_JAR */
1708 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1711 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1714 /** Size limit for IOB */
1715 size_t buffer_limit;
1717 #ifdef FEATURE_TRUST
1719 /** The file name of the trust file. */
1720 const char * trustfile;
1722 /** FIXME: DOCME: Document this. */
1723 struct list trust_info[1];
1725 /** FIXME: DOCME: Document this. */
1726 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1728 #endif /* def FEATURE_TRUST */
1732 /** The access control list (ACL). */
1733 struct access_control_list *acl;
1735 #endif /* def FEATURE_ACL */
1737 /** Information about parent proxies (forwarding). */
1738 struct forward_spec *forward;
1740 /** Number of retries in case a forwarded connection attempt fails */
1741 int forwarded_connect_retries;
1743 /** All options from the config file, HTML-formatted. */
1746 /** The configuration file object. */
1747 struct file_list *config_file_list;
1749 /** List of loaders */
1750 int (*loaders[NLOADERS])(struct client_state *);
1752 /** Nonzero if we need to bind() to the new port. */
1756 /** Calculates the number of elements in an array, using sizeof. */
1757 #define SZ(X) (sizeof(X) / sizeof(*X))
1759 #ifdef FEATURE_FORCE_LOAD
1760 /** The force load URL prefix. */
1761 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1762 #endif /* def FEATURE_FORCE_LOAD */
1764 #ifdef FEATURE_NO_GIFS
1765 /** The MIME type for images ("image/png" or "image/gif"). */
1766 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1768 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1769 #endif /* def FEATURE_NO_GIFS */
1776 /** URL for the Privoxy home page. */
1777 #define HOME_PAGE_URL "http://www.privoxy.org/"
1779 /** URL for the Privoxy user manual. */
1780 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1782 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1783 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1785 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1786 #define CONFIG_HELP_PREFIX "config.html#"
1789 * The "hosts" to intercept and display CGI pages.
1790 * First one is a hostname only, second one can specify host and path.
1793 * 1) Do not specify the http: prefix
1794 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1795 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1797 #define CGI_SITE_1_HOST "p.p"
1798 #define CGI_SITE_2_HOST "config.privoxy.org"
1799 #define CGI_SITE_2_PATH ""
1802 * The prefix for CGI pages. Written out in generated HTML.
1803 * INCLUDES the trailing slash.
1805 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1811 #endif /* ndef PROJECT_H_INCLUDED */