1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.90 2007/02/07 10:36:16 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 - 2007 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.90 2007/02/07 10:36:16 fabiankeil
41 * Add new http_response member to save
42 * the reason why the response was generated.
44 * Revision 1.89 2007/01/27 13:09:16 fabiankeil
45 * Add new config option "templdir" to
46 * change the templates directory.
48 * Revision 1.88 2007/01/25 13:36:59 fabiankeil
49 * Add csp->error_message for failure reasons
50 * that should be embedded into the CGI pages.
52 * Revision 1.87 2007/01/01 19:36:37 fabiankeil
53 * Integrate a modified version of Wil Mahan's
54 * zlib patch (PR #895531).
56 * Revision 1.86 2006/12/31 17:56:37 fabiankeil
57 * Added config option accept-intercepted-requests
58 * and disabled it by default.
60 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
61 * Fix gcc43 compiler warnings and a comment.
63 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
64 * Add config option "split-large-forms"
65 * to work around the browser bug reported
68 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
69 * Moved HTTP snipplets into jcc.c. They aren't
72 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
73 * Doubled size of HOSTENT_BUFFER_SIZE to mask
74 * problems with gethostbyname_r and some
75 * /etc/hosts configurations. Only a workaround
76 * until we get the real fix ready.
77 * Thanks FĂ©lix Rauch for reporting.
79 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
81 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
82 * Respond with 400 and a short text message
83 * if the client tries to use Privoxy as FTP proxy.
85 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
86 * Added config option enable-remote-http-toggle
87 * to specify if Privoxy should recognize special
88 * headers (currently only X-Filter) to change its
89 * behaviour. Disabled by default.
91 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
92 * Make number of retries in case of forwarded-connect problems
93 * a config file option (forwarded-connect-retries) and use 0 as
96 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
97 * Work around a buffer overflow that caused Privoxy to
98 * segfault if too many trusted referrers were used. Good
99 * enough for now, but should be replaced with a real
100 * solution after the next release.
102 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
105 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
106 * Split filter-headers{} into filter-client-headers{}
107 * and filter-server-headers{}.
108 * Added parse_header_time() to share some code.
109 * Replaced timegm() with mktime().
111 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
112 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
114 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
115 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
116 * with what was really the latest development (the v_3_0_branch branch)
118 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
119 * Multiple filter file support
121 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
122 * Add the ability to check jpeg images for invalid
123 * lengths of comment blocks. Defensive strategy
124 * against the exploit:
125 * Microsoft Security Bulletin MS04-028
126 * Buffer Overrun in JPEG Processing (GDI+) Could
127 * Allow Code Execution (833987)
128 * Enabled with +inspect-jpegs in actions files.
130 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
131 * Updated the copyright note
133 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
134 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
136 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
137 * Introduced RC_FLAG_* flags for use in child process return code
139 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
140 * Added flag to each cgi_dispatcher that allows or denies
141 * external linking and removed const qualifier from
142 * struct list_entry.str.
144 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
145 * - Include config.h for access to config data
146 * - Include <pcre*.h> depending on where they are
148 * Revision 1.72 2002/05/14 21:35:49 oes
149 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
150 * because of split in user-manual
152 * Revision 1.71 2002/05/12 21:39:36 jongfoster
153 * - Adding Doxygen-style comments to structures and #defines.
155 * Revision 1.70 2002/05/12 16:05:50 jongfoster
156 * Fixing ACTION_MASK_ALL to be unsigned long rather than
157 * just unsigned int. I don't know if anyone is porting
158 * Privoxy to 16-bit platforms, but if so, +limit-connect
159 * wouldn't have worked because of this bug.
161 * Revision 1.69 2002/05/08 16:00:16 oes
162 * Added size member to struct iob, so it can
163 * be alloced larger than needed.
165 * Revision 1.68 2002/04/26 12:56:00 oes
166 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
168 * Revision 1.67 2002/04/24 02:12:43 oes
169 * - Jon's multiple AF patch:
170 * - Make csp->actions_list an array
171 * - #define MAX_AF_FILES
172 * - Moved CGI_PARAM_LEN_MAX (500) here
174 * Revision 1.66 2002/04/15 19:06:43 jongfoster
177 * Revision 1.65 2002/04/04 00:36:36 gliptak
178 * always use pcre for matching
180 * Revision 1.64 2002/04/03 22:28:03 gliptak
181 * Removed references to gnu_regex
183 * Revision 1.63 2002/03/31 17:19:00 jongfoster
184 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
186 * Revision 1.62 2002/03/26 22:48:49 swa
189 * Revision 1.61 2002/03/26 22:29:55 swa
190 * we have a new homepage!
192 * Revision 1.60 2002/03/24 15:52:17 jongfoster
193 * Changing CGI URL prefixes for new name
195 * Revision 1.59 2002/03/24 15:23:33 jongfoster
198 * Revision 1.58 2002/03/24 13:25:43 swa
199 * name change related issues
201 * Revision 1.57 2002/03/16 20:28:34 oes
202 * Added descriptions to the filters so users will know what they select in the cgi editor
204 * Revision 1.56 2002/03/13 20:27:30 oes
205 * Fixing bug with CT_TABOO
207 * Revision 1.55 2002/03/12 01:42:50 oes
208 * Introduced modular filters
210 * Revision 1.54 2002/03/09 20:03:52 jongfoster
211 * - Making various functions return int rather than size_t.
212 * (Undoing a recent change). Since size_t is unsigned on
213 * Windows, functions like read_socket that return -1 on
214 * error cannot return a size_t.
216 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
217 * crashes, and also frequently caused JB to jump to 100%
218 * CPU and stay there. (Because it thought it had just
219 * read ((unsigned)-1) == 4Gb of data...)
221 * - The signature of write_socket has changed, it now simply
222 * returns success=0/failure=nonzero.
224 * - Trying to get rid of a few warnings --with-debug on
225 * Windows, I've introduced a new type "jb_socket". This is
226 * used for the socket file descriptors. On Windows, this
227 * is SOCKET (a typedef for unsigned). Everywhere else, it's
228 * an int. The error value can't be -1 any more, so it's
229 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
230 * Windows it maps to the #define INVALID_SOCKET.)
232 * - The signature of bind_port has changed.
234 * Revision 1.53 2002/03/08 16:48:55 oes
235 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
237 * Revision 1.52 2002/03/07 03:46:17 oes
238 * Fixed compiler warnings
240 * Revision 1.51 2002/03/05 04:52:42 oes
241 * Deleted non-errlog debugging code
243 * Revision 1.50 2002/03/04 19:32:07 oes
244 * Changed default port to 8118
246 * Revision 1.49 2002/03/04 18:28:55 oes
247 * Deleted PID_FILE_NAME
249 * Revision 1.48 2002/03/03 14:50:40 oes
250 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
252 * Revision 1.47 2002/02/20 23:15:13 jongfoster
253 * Parsing functions now handle out-of-memory gracefully by returning
256 * Revision 1.46 2002/01/17 21:06:09 jongfoster
257 * Now #defining the URLs of the config interface
259 * Minor changes to struct http_request and struct url_spec due to
260 * standardizing that struct http_request is used to represent a URL, and
261 * struct url_spec is used to represent a URL pattern. (Before, URLs were
262 * represented as seperate variables and a partially-filled-in url_spec).
264 * Revision 1.45 2002/01/09 14:33:27 oes
265 * Added HOSTENT_BUFFER_SIZE
267 * Revision 1.44 2001/12/30 14:07:32 steudten
268 * - Add signal handling (unix)
269 * - Add SIGHUP handler (unix)
270 * - Add creation of pidfile (unix)
271 * - Add action 'top' in rc file (RH)
272 * - Add entry 'SIGNALS' to manpage
273 * - Add exit message to logfile (unix)
275 * Revision 1.43 2001/11/22 21:57:51 jongfoster
276 * Making action_spec->flags into an unsigned long rather than just an
278 * Adding ACTION_NO_COOKIE_KEEP
280 * Revision 1.42 2001/11/05 21:42:41 steudten
281 * Include DBG() macro.
283 * Revision 1.41 2001/10/28 19:12:06 jongfoster
284 * Adding ijb_toupper()
286 * Revision 1.40 2001/10/26 17:40:47 oes
287 * Moved ijb_isspace and ijb_tolower to project.h
288 * Removed http->user_agent, csp->referrer and csp->accept_types
290 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
291 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
292 * macro when called with a cast; so moving the cast to the macro def'n
293 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
294 * doesn't make macro expansion complain. Hope this works for everyone else
297 * Revision 1.38 2001/10/23 21:19:04 jongfoster
298 * New error-handling support: jb_err type and JB_ERR_xxx constants
299 * CGI functions now return a jb_err, and their parameters map is const.
300 * Support for RUNTIME_FEATUREs to enable/disable config editor
301 * Adding a few comments
303 * Revision 1.37 2001/10/14 22:14:01 jongfoster
304 * Removing name_length field from struct cgi_dispatcher, as this is
305 * now calculated at runtime from the "name" field.
307 * Revision 1.36 2001/10/10 16:45:15 oes
308 * Added LIMIT_CONNECT action and string
309 * Fixed HTTP message line termination
310 * Added CFORBIDDEN HTTP message
312 * Revision 1.35 2001/10/07 18:06:43 oes
313 * Added status member to struct http_request
315 * Revision 1.34 2001/10/07 15:45:25 oes
316 * Added url member to struct http_request and commented all
321 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
323 * Replaced struct client_state members rejected,
324 * force, active and toggled_on with "flags" bitmap.
326 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
328 * Added buffer_limit to struct configuration_spec
330 * Revision 1.33 2001/09/20 13:30:08 steudten
332 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
333 * Last case will set z to NULL in free(z) and thats bad..
335 * Revision 1.32 2001/09/16 23:02:51 jongfoster
338 * Revision 1.31 2001/09/16 13:20:29 jongfoster
339 * Rewrite of list library. Now has seperate header and list_entry
340 * structures. Also added a large sprinking of assert()s to the list
343 * Revision 1.30 2001/09/13 23:52:00 jongfoster
344 * Support for both static and dynamically generated CGI pages
346 * Revision 1.29 2001/09/13 23:29:43 jongfoster
347 * Defining FORWARD_SPEC_INITIALIZER
349 * Revision 1.28 2001/09/13 23:05:50 jongfoster
350 * Changing the string paramater to the header parsers a "const".
352 * Revision 1.27 2001/08/05 16:06:20 jongfoster
353 * Modifiying "struct map" so that there are now separate header and
354 * "map_entry" structures. This means that functions which modify a
355 * map no longer need to return a pointer to the modified map.
356 * Also, it no longer reverses the order of the entries (which may be
357 * important with some advanced template substitutions).
359 * Revision 1.26 2001/07/30 22:08:36 jongfoster
360 * Tidying up #defines:
361 * - All feature #defines are now of the form FEATURE_xxx
362 * - Permanently turned off WIN_GUI_EDIT
363 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
365 * Revision 1.25 2001/07/29 18:43:08 jongfoster
366 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
369 * Revision 1.24 2001/07/25 17:20:27 oes
370 * Introduced http->user_agent
372 * Revision 1.23 2001/07/18 12:32:23 oes
373 * - Added ACTION_STRING_DEANIMATE
374 * - moved #define freez from jcc.h to project.h
376 * Revision 1.22 2001/07/15 17:51:41 jongfoster
377 * Renaming #define STATIC to STATIC_PCRE
379 * Revision 1.21 2001/07/13 14:03:19 oes
380 * - Reorganized regex header inclusion and #defines to
381 * comply to the scheme in configure.in
382 * - Added csp->content_type and its CT_* keys
383 * - Added ACTION_DEANIMATE
384 * - Removed all #ifdef PCRS
386 * Revision 1.20 2001/06/29 21:45:41 oes
387 * Indentation, CRLF->LF, Tab-> Space
389 * Revision 1.19 2001/06/29 13:33:36 oes
390 * - Improved comments
391 * - Introduced http_request.host_ip_addr_str
392 * - Introduced http_response.head_length
393 * - Introduced config.my_ip_addr_str, config.my_hostname,
394 * config.admin_address and config.proxy_info_url
395 * - Removed config.proxy_args_header and config.proxy_args_trailer,
396 * renamed config.proxy_args_invocation to config.proxy_args
397 * - Removed HTML snipplets and GIFs
398 * - Removed logentry from cancelled commit
400 * Revision 1.18 2001/06/09 10:57:39 jongfoster
401 * Adding definition of BUFFER_SIZE.
402 * Changing struct cgi_dispatcher to use "const" strings.
404 * Revision 1.17 2001/06/07 23:15:09 jongfoster
405 * Merging ACL and forward files into config file.
406 * Moving struct gateway members into struct forward_spec
407 * Removing config->proxy_args_gateways
408 * Cosmetic: Adding a few comments
410 * Revision 1.16 2001/06/04 18:31:58 swa
411 * files are now prefixed with either `confdir' or `logdir'.
412 * `make redhat-dist' replaces both entries confdir and logdir
415 * Revision 1.15 2001/06/04 11:28:53 swa
416 * redirect did not work due to missing /
418 * Revision 1.14 2001/06/03 11:03:48 oes
420 * added struct http_response,
421 * changed struct interceptors to struct cgi_dispatcher,
422 * moved HTML stuff to cgi.h
424 * Revision 1.13 2001/06/01 20:05:36 jongfoster
425 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
426 * constant, and removed csp->tinygif.
428 * Revision 1.12 2001/06/01 18:49:17 jongfoster
429 * Replaced "list_share" with "list" - the tiny memory gain was not
430 * worth the extra complexity.
432 * Revision 1.11 2001/06/01 10:32:47 oes
433 * Added constants for anchoring selection bitmap
435 * Revision 1.10 2001/05/31 21:33:53 jongfoster
436 * Changes for new actions file, replacing permissionsfile
437 * and parts of the config file. Also added support for
440 * Revision 1.9 2001/05/31 17:32:31 oes
442 * - Enhanced domain part globbing with infix and prefix asterisk
443 * matching and optional unanchored operation
445 * Revision 1.8 2001/05/29 20:09:15 joergs
446 * HTTP_REDIRECT_TEMPLATE fixed.
448 * Revision 1.7 2001/05/29 09:50:24 jongfoster
449 * Unified blocklist/imagelist/actionslist.
450 * File format is still under discussion, but the internal changes
453 * Also modified interceptor behaviour:
454 * - We now intercept all URLs beginning with one of the following
455 * prefixes (and *only* these prefixes):
457 * * http://ijbswa.sf.net/config/
458 * * http://ijbswa.sourceforge.net/config/
459 * - New interceptors "home page" - go to http://i.j.b/ to see it.
460 * - Internal changes so that intercepted and fast redirect pages
461 * are not replaced with an image.
462 * - Interceptors now have the option to send a binary page direct
463 * to the client. (i.e. ijb-send-banner uses this)
464 * - Implemented show-url-info interceptor. (Which is why I needed
465 * the above interceptors changes - a typical URL is
466 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
467 * The previous mechanism would not have intercepted that, and
468 * if it had been intercepted then it then it would have replaced
471 * Revision 1.6 2001/05/27 22:17:04 oes
473 * - re_process_buffer no longer writes the modified buffer
474 * to the client, which was very ugly. It now returns the
475 * buffer, which it is then written by chat.
477 * - content_length now adjusts the Content-Length: header
478 * for modified documents rather than crunch()ing it.
479 * (Length info in csp->content_length, which is 0 for
480 * unmodified documents)
482 * - For this to work, sed() is called twice when filtering.
484 * Revision 1.5 2001/05/26 00:28:36 jongfoster
485 * Automatic reloading of config file.
486 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
487 * Most of the global variables have been moved to a new
488 * struct configuration_spec, accessed through csp->config->globalname
489 * Most of the globals remaining are used by the Win32 GUI.
491 * Revision 1.4 2001/05/22 18:46:04 oes
493 * - Enabled filtering banners by size rather than URL
494 * by adding patterns that replace all standard banner
495 * sizes with the "Junkbuster" gif to the re_filterfile
497 * - Enabled filtering WebBugs by providing a pattern
498 * which kills all 1x1 images
500 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
501 * which is selected by the (nonstandard and therefore
502 * capital) letter 'U' in the option string.
503 * It causes the quantifiers to be ungreedy by default.
504 * Appending a ? turns back to greedy (!).
506 * - Added a new interceptor ijb-send-banner, which
507 * sends back the "Junkbuster" gif. Without imagelist or
508 * MSIE detection support, or if tinygif = 1, or the
509 * URL isn't recognized as an imageurl, a lame HTML
510 * explanation is sent instead.
512 * - Added new feature, which permits blocking remote
513 * script redirects and firing back a local redirect
515 * The feature is conditionally compiled, i.e. it
516 * can be disabled with --disable-fast-redirects,
517 * plus it must be activated by a "fast-redirects"
518 * line in the config file, has its own log level
519 * and of course wants to be displayed by show-proxy-args
520 * Note: Boy, all the #ifdefs in 1001 locations and
521 * all the fumbling with configure.in and acconfig.h
522 * were *way* more work than the feature itself :-(
524 * - Because a generic redirect template was needed for
525 * this, tinygif = 3 now uses the same.
527 * - Moved GIFs, and other static HTTP response templates
532 * - Removed some >400 CRs again (Jon, you really worked
535 * Revision 1.3 2001/05/20 01:21:20 jongfoster
536 * Version 2.9.4 checkin.
537 * - Merged popupfile and cookiefile, and added control over PCRS
538 * filtering, in new "actionsfile".
539 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
540 * file error you now get a message box (in the Win32 GUI) rather
541 * than the program exiting with no explanation.
542 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
544 * - Removed tabs from "config"
545 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
546 * - Bumped up version number.
548 * Revision 1.2 2001/05/17 23:01:01 oes
549 * - Cleaned CRLF's from the sources and related files
551 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
552 * Initial import of version 2.9.3 source tree
555 *********************************************************************/
558 /* Declare struct FILE for vars and funcs. */
561 /* Need time_t for file_list */
563 /* Needed for pcre choice */
567 * Include appropriate regular expression libraries.
568 * Note that pcrs and pcre (native) are needed for cgi
569 * and are included anyway.
575 # ifdef PCRE_H_IN_SUBDIR
576 # include <pcre/pcre.h>
589 # include "pcreposix.h"
591 # ifdef PCRE_H_IN_SUBDIR
592 # include <pcre/pcreposix.h>
594 # include <pcreposix.h>
600 #endif /* def AMIGA */
604 * I don't want to have to #include all this just for the declaration
605 * of SOCKET. However, it looks like we have to...
620 typedef SOCKET jb_socket;
622 #define JB_INVALID_SOCKET INVALID_SOCKET
624 #else /* ndef _WIN32 */
627 * The type used by sockets. On UNIX it's an int. Microsoft decided to
628 * make it an unsigned.
630 typedef int jb_socket;
633 * The error value used for variables of type jb_socket. On UNIX this
634 * is -1, however Microsoft decided to make socket handles unsigned, so
635 * they use a different value.
638 #define JB_INVALID_SOCKET (-1)
640 #endif /* ndef _WIN32 */
644 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
649 #define JB_ERR_OK 0 /**< Success, no error */
650 #define JB_ERR_MEMORY 1 /**< Out of memory */
651 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
652 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
653 #define JB_ERR_PARSE 4 /**< Error parsing file */
654 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
655 CGI actions editor. */
656 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
659 * This macro is used to free a pointer that may be NULL.
660 * It also sets the variable to NULL after it's been freed.
661 * The paramater should be a simple variable without side effects.
663 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
667 * Fix a problem with Solaris. There should be no effect on other
670 * Solaris's isspace() is a macro which uses it's argument directly
671 * as an array index. Therefore we need to make sure that high-bit
672 * characters generate +ve values, and ideally we also want to make
673 * the argument match the declared parameter type of "int".
675 * Note: Remember to #include <ctype.h> if you use these macros.
677 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
678 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
679 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
682 * Use for statically allocated buffers if you have no other choice.
683 * Remember to check the length of what you write into the buffer
684 * - we don't want any buffer overflows!
686 #define BUFFER_SIZE 5000
689 * Max length of CGI parameters (arbitrary limit).
691 #define CGI_PARAM_LEN_MAX 500
694 * Buffer size for capturing struct hostent data in the
695 * gethostby(name|addr)_r library calls. Since we don't
696 * loop over gethostbyname_r, the buffer must be sufficient
697 * to accomodate multiple IN A RRs, as used in DNS round robin
698 * load balancing. W3C's wwwlib uses 1K, so that should be
699 * good enough for us, too.
702 * XXX: Temporary doubled, for some configurations
703 * 1K is still too small and we didn't get the
704 * real fix ready for inclusion.
706 #define HOSTENT_BUFFER_SIZE 2048
709 * Do not use. Originally this was so that you can
710 * say "while (FOREVER) { ...do something... }".
711 * However, this gives a warning with some compilers (e.g. VC++).
712 * Instead, use "for (;;) { ...do something... }".
717 * Default IP address to listen on, as a string.
718 * Set to "127.0.0.1".
720 #define HADDR_DEFAULT "127.0.0.1"
723 * Default port to listen on, as a number.
726 #define HADDR_PORT 8118
729 /* Forward def for struct client_state */
730 struct configuration_spec;
734 * Entry in a linked list of strings.
739 * The string pointer. It must point to a dynamically malloc()ed
740 * string or be NULL for the list functions to work. In the latter
741 * case, just be careful next time you iterate through the list in
746 /** Next entry in the linked list, or NULL if no more. */
747 struct list_entry *next;
751 * A header for a linked list of strings.
755 /** First entry in the list, or NULL if the list is empty. */
756 struct list_entry *first;
758 /** Last entry in the list, or NULL if the list is empty. */
759 struct list_entry *last;
764 * An entry in a map. This is a name=value pair.
768 /** The key for the map. */
770 /** The value associated with that key. */
772 /** The next map entry, or NULL if none. */
773 struct map_entry *next;
777 * A map from a string to another string.
778 * This is used for the paramaters passed in a HTTP GET request, and
779 * to store the exports when the CGI interface is filling in a template.
783 /** The first map entry, or NULL if the map is empty. */
784 struct map_entry *first;
785 /** The last map entry, or NULL if the map is empty. */
786 struct map_entry *last;
791 * A HTTP request. This includes the method (GET, POST) and
794 * This is also used whenever we want to match a URL against a
795 * URL pattern. This always contains the URL to match, and never
796 * a URL pattern. (See struct url_spec).
800 char *cmd; /**< Whole command line: method, URL, Version */
801 char *ocmd; /**< Backup of original cmd for CLF logging */
802 char *gpc; /**< HTTP method: GET, POST, ... */
803 char *url; /**< The URL */
804 char *ver; /**< Protocol version */
805 int status; /**< HTTP Status */
807 char *host; /**< Host part of URL */
808 int port; /**< Port of URL or 80 (default) */
809 char *path; /**< Path of URL */
810 char *hostport; /**< host[:port] */
811 int ssl; /**< Flag if protocol is https */
813 char *host_ip_addr_str; /**< String with dotted decimal representation
814 of host's IP. NULL before connect_to() */
816 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
817 char **dvec; /**< List of pointers to the strings in dbuffer. */
818 int dcount; /**< How many parts to this domain? (length of dvec) */
822 * Reasons for generating a http_response instead of delivering
823 * the requested resource. Mostly ordered the way they are checked
826 #define RSP_REASON_UNSUPPORTED 1
827 #define RSP_REASON_BLOCKED 2
828 #define RSP_REASON_UNTRUSTED 3
829 #define RSP_REASON_REDIRECTED 4
830 #define RSP_REASON_CGI_CALL 5
831 #define RSP_REASON_NO_SUCH_DOMAIN 6
832 #define RSP_REASON_FORWARDING_FAILED 7
833 #define RSP_REASON_CONNECT_FAILED 8
834 #define RSP_REASON_OUT_OF_MEMORY 9
835 #define RSP_REASON_INTERNAL_ERROR 10
838 * Response generated by CGI, blocker, or error handler
842 char *status; /**< HTTP status (string). */
843 struct list headers[1]; /**< List of header lines. */
844 char *head; /**< Formatted http response head. */
845 size_t head_length; /**< Length of http response head. */
846 char *body; /**< HTTP document body. */
847 size_t content_length; /**< Length of body, REQUIRED if binary body. */
848 int is_static; /**< Nonzero if the content will never change and
849 should be cached by the browser (e.g. images). */
850 int reason; /**< Why the response was generated in the first place. */
858 /** The string which was parsed to produce this url_spec.
859 Used for debugging or display only. */
862 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
863 char **dvec; /**< List of pointers to the strings in dbuffer. */
864 int dcount; /**< How many parts to this domain? (length of dvec) */
865 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
867 int port; /**< The port number, or 0 to match all ports. */
869 char *path; /**< The source for the regex. */
870 size_t pathlen; /**< ==strlen(path). Needed for prefix matching. FIXME: Now obsolete? */
871 regex_t *preg; /**< Regex for matching path part */
875 * If you declare a static url_spec, this is the value to initialize it to zero.
877 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
880 * Constant for host part matching in URLs. If set, indicates that the start of
881 * the pattern must match the start of the URL. E.g. this is not set for the
882 * pattern ".example.com", so that it will match both "example.com" and
883 * "www.example.com". It is set for the pattern "example.com", which makes it
884 * match "example.com" only, not "www.example.com".
886 #define ANCHOR_LEFT 1
889 * Constant for host part matching in URLs. If set, indicates that the end of
890 * the pattern must match the end of the URL. E.g. this is not set for the
891 * pattern "ad.", so that it will match any host called "ad", irrespective
892 * of how many subdomains are in the fully-qualified domain name.
894 #define ANCHOR_RIGHT 2
898 * An I/O buffer. Holds a string which can be appended to, and can have data
899 * removed from the beginning.
903 char *buf; /**< Start of buffer */
904 char *cur; /**< Start of relevant data */
905 char *eod; /**< End of relevant data */
906 size_t size; /**< Size as malloc()ed */
911 * Return the number of bytes in the I/O buffer associated with the passed
912 * client_state pointer.
915 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
919 * Remove any data in the I/O buffer associated with the passed
920 * client_state pointer.
922 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
924 /* Bits for csp->content_type bitmask: */
925 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
926 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
927 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
928 #define CT_JPEG 0x0008U /**< Suitable for JPEG filtering. */
930 /* Although these are not, strictly speaking, content types
931 * (they are content encodings), it is simple to handle them
934 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
935 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
938 * The mask which includes all actions.
940 #define ACTION_MASK_ALL (~0UL)
943 * The most compatible set of actions - i.e. none.
945 #define ACTION_MOST_COMPATIBLE 0x00000000UL
947 /** Action bitmap: Block the request. */
948 #define ACTION_BLOCK 0x00000001UL
949 /** Action bitmap: Deanimate if it's a GIF. */
950 #define ACTION_DEANIMATE 0x00000002UL
951 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
952 #define ACTION_DOWNGRADE 0x00000004UL
953 /** Action bitmap: Fast redirects. */
954 #define ACTION_FAST_REDIRECTS 0x00000008UL
955 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
956 #define ACTION_HIDE_FORWARDED 0x00000010UL
957 /** Action bitmap: Hide "From" header. */
958 #define ACTION_HIDE_FROM 0x00000020UL
959 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
960 #define ACTION_HIDE_REFERER 0x00000040UL
961 /** Action bitmap: Hide "User-Agent" and similar headers. */
962 #define ACTION_HIDE_USER_AGENT 0x00000080UL
963 /** Action bitmap: This is an image. */
964 #define ACTION_IMAGE 0x00000100UL
965 /** Action bitmap: Sets the image blocker. */
966 #define ACTION_IMAGE_BLOCKER 0x00000200UL
967 /** Action bitmap: Prevent compression. */
968 #define ACTION_NO_COMPRESSION 0x00000400UL
969 /** Action bitmap: Change cookies to session only cookies. */
970 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
971 /** Action bitmap: Block rending cookies. */
972 #define ACTION_NO_COOKIE_READ 0x00001000UL
973 /** Action bitmap: Block setting cookies. */
974 #define ACTION_NO_COOKIE_SET 0x00002000UL
975 /** Action bitmap: Filter out popups. */
976 #define ACTION_NO_POPUPS 0x00004000UL
977 /** Action bitmap: Send a vanilla wafer. */
978 #define ACTION_VANILLA_WAFER 0x00008000UL
979 /** Action bitmap: Limit CONNECT requests to safe ports. */
980 #define ACTION_LIMIT_CONNECT 0x00010000UL
981 /** Action bitmap: Inspect if it's a JPEG. */
982 #define ACTION_JPEG_INSPECT 0x00020000UL
983 /** Action bitmap: Crunch or modify "if-modified-since" header. */
984 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
985 /** Action bitmap: Overwrite Content-Type header. */
986 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
987 /** Action bitmap: Crunch specified server header. */
988 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
989 /** Action bitmap: Crunch specified client header */
990 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
991 /** Action bitmap: Enable text mode by force */
992 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
993 /** Action bitmap: Enable text mode by force */
994 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
995 /** Action bitmap: Enable content-dispostion crunching */
996 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
997 /** Action bitmap: Replace or block Last-Modified header */
998 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
999 /** Action bitmap: Replace or block Accept-Language header */
1000 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
1001 /** Action bitmap: Block as empty document */
1002 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x08000000UL
1003 /** Action bitmap: Redirect request. */
1004 #define ACTION_REDIRECT 0x10000000UL
1005 /** Action bitmap: Answer blocked Connects verbosely */
1006 #define ACTION_TREAT_FORBIDDEN_CONNECTS_LIKE_BLOCKS 0x20000000UL
1007 /** Action bitmap: Filter server headers with pcre */
1008 #define ACTION_FILTER_SERVER_HEADERS 0x40000000UL
1009 /** Action bitmap: Filter client headers with pcre */
1010 #define ACTION_FILTER_CLIENT_HEADERS 0x80000000UL
1013 /** Action string index: How to deanimate GIFs */
1014 #define ACTION_STRING_DEANIMATE 0
1015 /** Action string index: Replacement for "From:" header */
1016 #define ACTION_STRING_FROM 1
1017 /** Action string index: How to block images */
1018 #define ACTION_STRING_IMAGE_BLOCKER 2
1019 /** Action string index: Replacement for "Referer:" header */
1020 #define ACTION_STRING_REFERER 3
1021 /** Action string index: Replacement for "User-Agent:" header */
1022 #define ACTION_STRING_USER_AGENT 4
1023 /** Action string index: Legal CONNECT ports. */
1024 #define ACTION_STRING_LIMIT_CONNECT 5
1025 /** Action string index: Server headers containing this pattern are crunched*/
1026 #define ACTION_STRING_SERVER_HEADER 6
1027 /** Action string index: Client headers containing this pattern are crunched*/
1028 #define ACTION_STRING_CLIENT_HEADER 7
1029 /** Action string index: Replacement for the "Accept-Language:" header*/
1030 #define ACTION_STRING_LANGUAGE 8
1031 /** Action string index: Replacement for the "Content-Type:" header*/
1032 #define ACTION_STRING_CONTENT_TYPE 9
1033 /** Action string index: Replacement for the "content-dispostion:" header*/
1034 #define ACTION_STRING_CONTENT_DISPOSITION 10
1035 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1036 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1037 /** Action string index: Replacement for the "Last-Modified:" header. */
1038 #define ACTION_STRING_LAST_MODIFIED 12
1039 /** Action string index: Redirect URL */
1040 #define ACTION_STRING_REDIRECT 13
1041 /** Action string index: Decode before redirect? */
1042 #define ACTION_STRING_FAST_REDIRECTS 14
1043 /** Number of string actions. */
1044 #define ACTION_STRING_COUNT 15
1047 /*To make the ugly hack in sed easier to understand*/
1048 #define CHECK_EVERY_HEADER_REMAINING 0
1051 /** Index into current_action_spec::multi[] for headers to add. */
1052 #define ACTION_MULTI_ADD_HEADER 0
1053 /** Index into current_action_spec::multi[] for headers to add. */
1054 #define ACTION_MULTI_WAFER 1
1055 /** Index into current_action_spec::multi[] for filters to apply. */
1056 #define ACTION_MULTI_FILTER 2
1057 /** Number of multi-string actions. */
1058 #define ACTION_MULTI_COUNT 3
1062 * This structure contains a list of actions to apply to a URL.
1063 * It only contains positive instructions - no "-" options.
1064 * It is not used to store the actions list itself, only for
1065 * url_actions() to return the current values.
1067 struct current_action_spec
1069 /** Actions to apply. A bit set to "1" means perform the action. */
1070 unsigned long flags;
1073 * Paramaters for those actions that require them.
1074 * Each entry is valid if & only if the corresponding entry in "flags" is
1077 char * string[ACTION_STRING_COUNT];
1079 /** Lists of strings for multi-string actions. */
1080 struct list multi[ACTION_MULTI_COUNT][1];
1085 * This structure contains a set of changes to actions.
1086 * It can contain both positive and negative instructions.
1087 * It is used to store an entry in the actions list.
1091 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1092 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1095 * Paramaters for those actions that require them.
1096 * Each entry is valid if & only if the corresponding entry in "flags" is
1099 char * string[ACTION_STRING_COUNT];
1101 /** Lists of strings to remove, for multi-string actions. */
1102 struct list multi_remove[ACTION_MULTI_COUNT][1];
1104 /** If nonzero, remove *all* strings from the multi-string action. */
1105 int multi_remove_all[ACTION_MULTI_COUNT];
1107 /** Lists of strings to add, for multi-string actions. */
1108 struct list multi_add[ACTION_MULTI_COUNT][1];
1113 * This structure is used to store the actions list.
1115 * It contains a URL pattern, and the chages to the actions.
1116 * It is a linked list.
1120 struct url_spec url[1]; /**< URL pattern. */
1122 struct action_spec action[1]; /**< Actions. */
1124 struct url_actions * next; /**< Next action in file, or NULL. */
1129 * Flags for use in csp->flags
1133 * Flag for csp->flags: Set if this client is processing data.
1134 * Cleared when the thread associated with this structure dies.
1136 #define CSP_FLAG_ACTIVE 0x01
1139 * Flag for csp->flags: Set if the server's reply is in "chunked"
1142 #define CSP_FLAG_CHUNKED 0x02
1145 * Flag for csp->flags: Set if this request was enforced, although it would
1146 * normally have been blocked.
1148 #define CSP_FLAG_FORCED 0x04
1151 * Flag for csp->flags: Set if any modification to the body was done.
1153 #define CSP_FLAG_MODIFIED 0x08
1156 * Flag for csp->flags: Set if request was blocked.
1158 #define CSP_FLAG_REJECTED 0x10
1161 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1163 #define CSP_FLAG_TOGGLED_ON 0x20
1166 * Flag for csp->flags: Set if adding the 'Connection: close' header
1167 * for the client isn't necessary.
1169 #define CSP_FLAG_CLIENT_CONNECTION_CLOSE_SET 0x00000040UL
1172 * Flag for csp->flags: Set if adding the 'Connection: close' header
1173 * for the server isn't necessary.
1175 #define CSP_FLAG_SERVER_CONNECTION_CLOSE_SET 0x00000080UL
1178 * Flag for csp->flags: Signals header parsers whether they
1179 * are parsing server or client headers.
1181 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100UL
1184 * Flag for csp->flags: Set if adding the Host: header
1187 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200UL
1191 * Flags for use in return codes of child processes
1195 * Flag for process return code: Set if exiting porcess has been toggled
1196 * during its lifetime.
1198 #define RC_FLAG_TOGGLED 0x10
1201 * Flag for process return code: Set if exiting porcess has blocked its
1204 #define RC_FLAG_BLOCKED 0x20
1207 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1210 #define MAX_AF_FILES 10
1213 * The state of a Privoxy processing thread.
1217 /** The proxy's configuration */
1218 struct configuration_spec * config;
1220 /** The actions to perform on the current request */
1221 struct current_action_spec action[1];
1223 /** socket to talk to client (web browser) */
1226 /** socket to talk to server (web server or proxy) */
1229 /** Multi-purpose flag container, see CSP_FLAG_* above */
1232 /** Client PC's IP address, as reported by the accept() function.
1235 /** Client PC's IP address, as reported by the accept() function.
1239 /** Our IP address. I.e. the IP address that the client used to reach us,
1241 char *my_ip_addr_str;
1243 /** Our hostname. I.e. the reverse DNS of the IP address that the client
1244 used to reach us, as a string. */
1247 /** The URL that was requested */
1248 struct http_request http[1];
1250 /** An I/O buffer used for buffering data read from the network */
1253 /** List of all headers for this request */
1254 struct list headers[1];
1256 /** List of all cookies for this request */
1257 struct list cookie_list[1];
1259 /** MIME-Type key, see CT_* above */
1260 unsigned int content_type;
1262 /** The "X-Forwarded-For:" header sent by the client */
1265 /** Actions files associated with this client */
1266 struct file_list *actions_list[MAX_AF_FILES];
1268 /** pcrs job files. */
1269 struct file_list *rlist[MAX_AF_FILES];
1271 /** Length after content modification. */
1272 size_t content_length;
1274 #ifdef FEATURE_TRUST
1277 struct file_list *tlist;
1279 #endif /* def FEATURE_TRUST */
1282 * Failure reason to embedded in the CGI error page,
1283 * or NULL. Currently only used for socks errors.
1285 char *error_message;
1287 /** Next thread in linked list. Only read or modify from the main thread! */
1288 struct client_state *next;
1293 * A function to add a header
1295 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1298 * A function to process a header
1300 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1304 * List of functions to run on a list of headers
1308 /** The header prefix to match */
1311 /** The length of the prefix to match */
1314 /** The function to apply to this line */
1315 parser_func_ptr parser;
1320 * List of available CGI functions.
1322 struct cgi_dispatcher
1324 /** The URL of the CGI, relative to the CGI root. */
1325 const char * const name;
1327 /** The handler function for the CGI */
1328 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1330 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1331 const char * const description;
1333 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1339 * A data file used by Privoxy. Kept in a linked list.
1344 * This is a pointer to the data structures associated with the file.
1345 * Read-only once the structure has been created.
1350 * The unloader function.
1351 * Normally NULL. When we are finished with file (i.e. when we have
1352 * loaded a new one), set to a pointer to an unloader function.
1353 * Unloader will be called by sweep() (called from main loop) when
1354 * all clients using this file are done. This prevents threading
1357 void (*unloader)(void *);
1360 * Used internally by sweep(). Do not access from elsewhere.
1365 * File last-modified time, so we can check if file has been changed.
1366 * Read-only once the structure has been created.
1368 time_t lastmodified;
1371 * The full filename.
1376 * Pointer to next entry in the linked list of all "file_list"s.
1377 * This linked list is so that sweep() can navigate it.
1378 * Since sweep() can remove items from the list, we must be careful
1379 * to only access this value from main thread (when we know sweep
1380 * won't be running).
1382 struct file_list *next;
1386 #ifdef FEATURE_TRUST
1389 * The format of a trust file when loaded into memory.
1393 struct url_spec url[1]; /**< The URL pattern */
1394 int reject; /**< FIXME: Please document this! */
1395 struct block_spec *next; /**< Next entry in linked list */
1399 * Arbitrary limit for the number of trusted referrers.
1401 #define MAX_TRUSTED_REFERRERS 512
1403 #endif /* def FEATURE_TRUST */
1406 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1407 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1408 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1412 * How to forward a connection to a parent proxy.
1416 /** URL pattern that this forward_spec is for. */
1417 struct url_spec url[1];
1419 /** Connection type. Must be SOCKS_NONE, SOCKS_4, or SOCKS_4A. */
1422 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1425 /** SOCKS server port. */
1428 /** Parent HTTP proxy hostname, or NULL for none. */
1431 /** Parent HTTP proxy port. */
1434 /** Next entry in the linked list. */
1435 struct forward_spec *next;
1440 * Initializer for a static struct forward_spec.
1442 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1446 * This struct represents one filter (one block) from
1447 * the re_filterfile. If there is more than one filter
1448 * in the file, the file will be represented by a
1449 * chained list of re_filterfile specs.
1451 struct re_filterfile_spec
1453 char *name; /**< Name from FILTER: statement in re_filterfile. */
1454 char *description; /**< Description from FILTER: statement in re_filterfile. */
1455 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1456 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1457 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1463 #define ACL_PERMIT 1 /**< Accept connection request */
1464 #define ACL_DENY 2 /**< Reject connection request */
1467 * An IP address pattern. Used to specify networks in the ACL.
1469 struct access_control_addr
1471 unsigned long addr; /**< The IP address as an integer. */
1472 unsigned long mask; /**< The network mask as an integer. */
1473 unsigned long port; /**< The port number. */
1477 * An access control list (ACL) entry.
1479 * This is a linked list.
1481 struct access_control_list
1483 struct access_control_addr src[1]; /**< Client IP address */
1484 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1486 short action; /**< ACL_PERMIT or ACL_DENY */
1487 struct access_control_list *next; /**< The next entry in the ACL. */
1490 #endif /* def FEATURE_ACL */
1493 /** Maximum number of loaders (actions, re_filter, ...) */
1497 /** configuration_spec::feature_flags: CGI actions editor. */
1498 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1500 /** configuration_spec::feature_flags: Web-based toggle. */
1501 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1503 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1504 #define RUNTIME_FEATURE_HTTP_TOGGLE 4
1506 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1507 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8
1509 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1510 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16
1514 * Data loaded from the configuration file.
1516 * (Anomaly: toggle is still handled through a global, not this structure)
1518 struct configuration_spec
1523 /** Nonzero to enable multithreading. */
1527 * Bitmask of features that can be enabled/disabled through the config
1528 * file. Currently defined bits:
1530 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1531 * - RUNTIME_FEATURE_CGI_TOGGLE
1532 * - RUNTIME_FEATURE_HTTP_TOGGLE
1533 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1535 unsigned feature_flags;
1537 /** The log file name. */
1538 const char *logfile;
1540 /** The config file directory. */
1541 const char *confdir;
1543 /** The directory for customized CGI templates. */
1544 const char *templdir;
1546 /** The log file directory. */
1549 /** The full paths to the actions files. */
1550 const char *actions_file[MAX_AF_FILES];
1552 /** The short names of the actions files. */
1553 const char *actions_file_short[MAX_AF_FILES];
1555 /** The administrator's email address */
1556 char *admin_address;
1558 /** A URL with info on this proxy */
1559 char *proxy_info_url;
1561 /** URL to the user manual (on our website or local copy) */
1564 /** The file names of the pcre filter files. */
1565 const char *re_filterfile[MAX_AF_FILES];
1567 /** The short names of the pcre filter files. */
1568 const char *re_filterfile_short[MAX_AF_FILES];
1570 #ifdef FEATURE_COOKIE_JAR
1572 /** The file name of the cookie jar file */
1573 const char * jarfile;
1575 /** The handle to the cookie jar file */
1578 #endif /* def FEATURE_COOKIE_JAR */
1580 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1583 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1586 /** Size limit for IOB */
1587 size_t buffer_limit;
1589 #ifdef FEATURE_TRUST
1591 /** The file name of the trust file. */
1592 const char * trustfile;
1594 /** FIXME: DOCME: Document this. */
1595 struct list trust_info[1];
1597 /** FIXME: DOCME: Document this. */
1598 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1600 #endif /* def FEATURE_TRUST */
1604 /** The access control list (ACL). */
1605 struct access_control_list *acl;
1607 #endif /* def FEATURE_ACL */
1609 /** Information about parent proxies (forwarding). */
1610 struct forward_spec *forward;
1612 /** Number of retries in case a forwarded connection attempt fails */
1613 int forwarded_connect_retries;
1615 /** All options from the config file, HTML-formatted. */
1618 /** The configuration file object. */
1619 struct file_list *config_file_list;
1621 /** List of loaders */
1622 int (*loaders[NLOADERS])(struct client_state *);
1624 /** Nonzero if we need to bind() to the new port. */
1628 /** Calculates the number of elements in an array, using sizeof. */
1629 #define SZ(X) (sizeof(X) / sizeof(*X))
1631 #ifdef FEATURE_FORCE_LOAD
1632 /** The force load URL prefix. */
1633 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1634 #endif /* def FEATURE_FORCE_LOAD */
1636 #ifdef FEATURE_NO_GIFS
1637 /** The MIME type for images ("image/png" or "image/gif"). */
1638 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1640 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1641 #endif /* def FEATURE_NO_GIFS */
1648 /** URL for the Privoxy home page. */
1649 #define HOME_PAGE_URL "http://www.privoxy.org/"
1651 /** URL for the Privoxy user manual. */
1652 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1654 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1655 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1657 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1658 #define CONFIG_HELP_PREFIX "config.html#"
1661 * The "hosts" to intercept and display CGI pages.
1662 * First one is a hostname only, second one can specify host and path.
1665 * 1) Do not specify the http: prefix
1666 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1667 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1669 #define CGI_SITE_1_HOST "p.p"
1670 #define CGI_SITE_2_HOST "config.privoxy.org"
1671 #define CGI_SITE_2_PATH ""
1674 * The prefix for CGI pages. Written out in generated HTML.
1675 * INCLUDES the trailing slash.
1677 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1683 #endif /* ndef PROJECT_H_INCLUDED */