1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.83 2006/12/06 19:26:29 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 - 2004 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.83 2006/12/06 19:26:29 fabiankeil
41 * Moved HTTP snipplets into jcc.c. They aren't
44 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
45 * Doubled size of HOSTENT_BUFFER_SIZE to mask
46 * problems with gethostbyname_r and some
47 * /etc/hosts configurations. Only a workaround
48 * until we get the real fix ready.
49 * Thanks FĂ©lix Rauch for reporting.
51 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
53 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
54 * Respond with 400 and a short text message
55 * if the client tries to use Privoxy as FTP proxy.
57 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
58 * Added config option enable-remote-http-toggle
59 * to specify if Privoxy should recognize special
60 * headers (currently only X-Filter) to change its
61 * behaviour. Disabled by default.
63 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
64 * Make number of retries in case of forwarded-connect problems
65 * a config file option (forwarded-connect-retries) and use 0 as
68 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
69 * Work around a buffer overflow that caused Privoxy to
70 * segfault if too many trusted referrers were used. Good
71 * enough for now, but should be replaced with a real
72 * solution after the next release.
74 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
77 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
78 * Split filter-headers{} into filter-client-headers{}
79 * and filter-server-headers{}.
80 * Added parse_header_time() to share some code.
81 * Replaced timegm() with mktime().
83 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
84 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
86 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
87 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
88 * with what was really the latest development (the v_3_0_branch branch)
90 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
91 * Multiple filter file support
93 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
94 * Add the ability to check jpeg images for invalid
95 * lengths of comment blocks. Defensive strategy
96 * against the exploit:
97 * Microsoft Security Bulletin MS04-028
98 * Buffer Overrun in JPEG Processing (GDI+) Could
99 * Allow Code Execution (833987)
100 * Enabled with +inspect-jpegs in actions files.
102 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
103 * Updated the copyright note
105 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
106 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
108 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
109 * Introduced RC_FLAG_* flags for use in child process return code
111 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
112 * Added flag to each cgi_dispatcher that allows or denies
113 * external linking and removed const qualifier from
114 * struct list_entry.str.
116 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
117 * - Include config.h for access to config data
118 * - Include <pcre*.h> depending on where they are
120 * Revision 1.72 2002/05/14 21:35:49 oes
121 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
122 * because of split in user-manual
124 * Revision 1.71 2002/05/12 21:39:36 jongfoster
125 * - Adding Doxygen-style comments to structures and #defines.
127 * Revision 1.70 2002/05/12 16:05:50 jongfoster
128 * Fixing ACTION_MASK_ALL to be unsigned long rather than
129 * just unsigned int. I don't know if anyone is porting
130 * Privoxy to 16-bit platforms, but if so, +limit-connect
131 * wouldn't have worked because of this bug.
133 * Revision 1.69 2002/05/08 16:00:16 oes
134 * Added size member to struct iob, so it can
135 * be alloced larger than needed.
137 * Revision 1.68 2002/04/26 12:56:00 oes
138 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
140 * Revision 1.67 2002/04/24 02:12:43 oes
141 * - Jon's multiple AF patch:
142 * - Make csp->actions_list an array
143 * - #define MAX_AF_FILES
144 * - Moved CGI_PARAM_LEN_MAX (500) here
146 * Revision 1.66 2002/04/15 19:06:43 jongfoster
149 * Revision 1.65 2002/04/04 00:36:36 gliptak
150 * always use pcre for matching
152 * Revision 1.64 2002/04/03 22:28:03 gliptak
153 * Removed references to gnu_regex
155 * Revision 1.63 2002/03/31 17:19:00 jongfoster
156 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
158 * Revision 1.62 2002/03/26 22:48:49 swa
161 * Revision 1.61 2002/03/26 22:29:55 swa
162 * we have a new homepage!
164 * Revision 1.60 2002/03/24 15:52:17 jongfoster
165 * Changing CGI URL prefixes for new name
167 * Revision 1.59 2002/03/24 15:23:33 jongfoster
170 * Revision 1.58 2002/03/24 13:25:43 swa
171 * name change related issues
173 * Revision 1.57 2002/03/16 20:28:34 oes
174 * Added descriptions to the filters so users will know what they select in the cgi editor
176 * Revision 1.56 2002/03/13 20:27:30 oes
177 * Fixing bug with CT_TABOO
179 * Revision 1.55 2002/03/12 01:42:50 oes
180 * Introduced modular filters
182 * Revision 1.54 2002/03/09 20:03:52 jongfoster
183 * - Making various functions return int rather than size_t.
184 * (Undoing a recent change). Since size_t is unsigned on
185 * Windows, functions like read_socket that return -1 on
186 * error cannot return a size_t.
188 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
189 * crashes, and also frequently caused JB to jump to 100%
190 * CPU and stay there. (Because it thought it had just
191 * read ((unsigned)-1) == 4Gb of data...)
193 * - The signature of write_socket has changed, it now simply
194 * returns success=0/failure=nonzero.
196 * - Trying to get rid of a few warnings --with-debug on
197 * Windows, I've introduced a new type "jb_socket". This is
198 * used for the socket file descriptors. On Windows, this
199 * is SOCKET (a typedef for unsigned). Everywhere else, it's
200 * an int. The error value can't be -1 any more, so it's
201 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
202 * Windows it maps to the #define INVALID_SOCKET.)
204 * - The signature of bind_port has changed.
206 * Revision 1.53 2002/03/08 16:48:55 oes
207 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
209 * Revision 1.52 2002/03/07 03:46:17 oes
210 * Fixed compiler warnings
212 * Revision 1.51 2002/03/05 04:52:42 oes
213 * Deleted non-errlog debugging code
215 * Revision 1.50 2002/03/04 19:32:07 oes
216 * Changed default port to 8118
218 * Revision 1.49 2002/03/04 18:28:55 oes
219 * Deleted PID_FILE_NAME
221 * Revision 1.48 2002/03/03 14:50:40 oes
222 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
224 * Revision 1.47 2002/02/20 23:15:13 jongfoster
225 * Parsing functions now handle out-of-memory gracefully by returning
228 * Revision 1.46 2002/01/17 21:06:09 jongfoster
229 * Now #defining the URLs of the config interface
231 * Minor changes to struct http_request and struct url_spec due to
232 * standardizing that struct http_request is used to represent a URL, and
233 * struct url_spec is used to represent a URL pattern. (Before, URLs were
234 * represented as seperate variables and a partially-filled-in url_spec).
236 * Revision 1.45 2002/01/09 14:33:27 oes
237 * Added HOSTENT_BUFFER_SIZE
239 * Revision 1.44 2001/12/30 14:07:32 steudten
240 * - Add signal handling (unix)
241 * - Add SIGHUP handler (unix)
242 * - Add creation of pidfile (unix)
243 * - Add action 'top' in rc file (RH)
244 * - Add entry 'SIGNALS' to manpage
245 * - Add exit message to logfile (unix)
247 * Revision 1.43 2001/11/22 21:57:51 jongfoster
248 * Making action_spec->flags into an unsigned long rather than just an
250 * Adding ACTION_NO_COOKIE_KEEP
252 * Revision 1.42 2001/11/05 21:42:41 steudten
253 * Include DBG() macro.
255 * Revision 1.41 2001/10/28 19:12:06 jongfoster
256 * Adding ijb_toupper()
258 * Revision 1.40 2001/10/26 17:40:47 oes
259 * Moved ijb_isspace and ijb_tolower to project.h
260 * Removed http->user_agent, csp->referrer and csp->accept_types
262 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
263 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
264 * macro when called with a cast; so moving the cast to the macro def'n
265 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
266 * doesn't make macro expansion complain. Hope this works for everyone else
269 * Revision 1.38 2001/10/23 21:19:04 jongfoster
270 * New error-handling support: jb_err type and JB_ERR_xxx constants
271 * CGI functions now return a jb_err, and their parameters map is const.
272 * Support for RUNTIME_FEATUREs to enable/disable config editor
273 * Adding a few comments
275 * Revision 1.37 2001/10/14 22:14:01 jongfoster
276 * Removing name_length field from struct cgi_dispatcher, as this is
277 * now calculated at runtime from the "name" field.
279 * Revision 1.36 2001/10/10 16:45:15 oes
280 * Added LIMIT_CONNECT action and string
281 * Fixed HTTP message line termination
282 * Added CFORBIDDEN HTTP message
284 * Revision 1.35 2001/10/07 18:06:43 oes
285 * Added status member to struct http_request
287 * Revision 1.34 2001/10/07 15:45:25 oes
288 * Added url member to struct http_request and commented all
293 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
295 * Replaced struct client_state members rejected,
296 * force, active and toggled_on with "flags" bitmap.
298 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
300 * Added buffer_limit to struct configuration_spec
302 * Revision 1.33 2001/09/20 13:30:08 steudten
304 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
305 * Last case will set z to NULL in free(z) and thats bad..
307 * Revision 1.32 2001/09/16 23:02:51 jongfoster
310 * Revision 1.31 2001/09/16 13:20:29 jongfoster
311 * Rewrite of list library. Now has seperate header and list_entry
312 * structures. Also added a large sprinking of assert()s to the list
315 * Revision 1.30 2001/09/13 23:52:00 jongfoster
316 * Support for both static and dynamically generated CGI pages
318 * Revision 1.29 2001/09/13 23:29:43 jongfoster
319 * Defining FORWARD_SPEC_INITIALIZER
321 * Revision 1.28 2001/09/13 23:05:50 jongfoster
322 * Changing the string paramater to the header parsers a "const".
324 * Revision 1.27 2001/08/05 16:06:20 jongfoster
325 * Modifiying "struct map" so that there are now separate header and
326 * "map_entry" structures. This means that functions which modify a
327 * map no longer need to return a pointer to the modified map.
328 * Also, it no longer reverses the order of the entries (which may be
329 * important with some advanced template substitutions).
331 * Revision 1.26 2001/07/30 22:08:36 jongfoster
332 * Tidying up #defines:
333 * - All feature #defines are now of the form FEATURE_xxx
334 * - Permanently turned off WIN_GUI_EDIT
335 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
337 * Revision 1.25 2001/07/29 18:43:08 jongfoster
338 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
341 * Revision 1.24 2001/07/25 17:20:27 oes
342 * Introduced http->user_agent
344 * Revision 1.23 2001/07/18 12:32:23 oes
345 * - Added ACTION_STRING_DEANIMATE
346 * - moved #define freez from jcc.h to project.h
348 * Revision 1.22 2001/07/15 17:51:41 jongfoster
349 * Renaming #define STATIC to STATIC_PCRE
351 * Revision 1.21 2001/07/13 14:03:19 oes
352 * - Reorganized regex header inclusion and #defines to
353 * comply to the scheme in configure.in
354 * - Added csp->content_type and its CT_* keys
355 * - Added ACTION_DEANIMATE
356 * - Removed all #ifdef PCRS
358 * Revision 1.20 2001/06/29 21:45:41 oes
359 * Indentation, CRLF->LF, Tab-> Space
361 * Revision 1.19 2001/06/29 13:33:36 oes
362 * - Improved comments
363 * - Introduced http_request.host_ip_addr_str
364 * - Introduced http_response.head_length
365 * - Introduced config.my_ip_addr_str, config.my_hostname,
366 * config.admin_address and config.proxy_info_url
367 * - Removed config.proxy_args_header and config.proxy_args_trailer,
368 * renamed config.proxy_args_invocation to config.proxy_args
369 * - Removed HTML snipplets and GIFs
370 * - Removed logentry from cancelled commit
372 * Revision 1.18 2001/06/09 10:57:39 jongfoster
373 * Adding definition of BUFFER_SIZE.
374 * Changing struct cgi_dispatcher to use "const" strings.
376 * Revision 1.17 2001/06/07 23:15:09 jongfoster
377 * Merging ACL and forward files into config file.
378 * Moving struct gateway members into struct forward_spec
379 * Removing config->proxy_args_gateways
380 * Cosmetic: Adding a few comments
382 * Revision 1.16 2001/06/04 18:31:58 swa
383 * files are now prefixed with either `confdir' or `logdir'.
384 * `make redhat-dist' replaces both entries confdir and logdir
387 * Revision 1.15 2001/06/04 11:28:53 swa
388 * redirect did not work due to missing /
390 * Revision 1.14 2001/06/03 11:03:48 oes
392 * added struct http_response,
393 * changed struct interceptors to struct cgi_dispatcher,
394 * moved HTML stuff to cgi.h
396 * Revision 1.13 2001/06/01 20:05:36 jongfoster
397 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
398 * constant, and removed csp->tinygif.
400 * Revision 1.12 2001/06/01 18:49:17 jongfoster
401 * Replaced "list_share" with "list" - the tiny memory gain was not
402 * worth the extra complexity.
404 * Revision 1.11 2001/06/01 10:32:47 oes
405 * Added constants for anchoring selection bitmap
407 * Revision 1.10 2001/05/31 21:33:53 jongfoster
408 * Changes for new actions file, replacing permissionsfile
409 * and parts of the config file. Also added support for
412 * Revision 1.9 2001/05/31 17:32:31 oes
414 * - Enhanced domain part globbing with infix and prefix asterisk
415 * matching and optional unanchored operation
417 * Revision 1.8 2001/05/29 20:09:15 joergs
418 * HTTP_REDIRECT_TEMPLATE fixed.
420 * Revision 1.7 2001/05/29 09:50:24 jongfoster
421 * Unified blocklist/imagelist/actionslist.
422 * File format is still under discussion, but the internal changes
425 * Also modified interceptor behaviour:
426 * - We now intercept all URLs beginning with one of the following
427 * prefixes (and *only* these prefixes):
429 * * http://ijbswa.sf.net/config/
430 * * http://ijbswa.sourceforge.net/config/
431 * - New interceptors "home page" - go to http://i.j.b/ to see it.
432 * - Internal changes so that intercepted and fast redirect pages
433 * are not replaced with an image.
434 * - Interceptors now have the option to send a binary page direct
435 * to the client. (i.e. ijb-send-banner uses this)
436 * - Implemented show-url-info interceptor. (Which is why I needed
437 * the above interceptors changes - a typical URL is
438 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
439 * The previous mechanism would not have intercepted that, and
440 * if it had been intercepted then it then it would have replaced
443 * Revision 1.6 2001/05/27 22:17:04 oes
445 * - re_process_buffer no longer writes the modified buffer
446 * to the client, which was very ugly. It now returns the
447 * buffer, which it is then written by chat.
449 * - content_length now adjusts the Content-Length: header
450 * for modified documents rather than crunch()ing it.
451 * (Length info in csp->content_length, which is 0 for
452 * unmodified documents)
454 * - For this to work, sed() is called twice when filtering.
456 * Revision 1.5 2001/05/26 00:28:36 jongfoster
457 * Automatic reloading of config file.
458 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
459 * Most of the global variables have been moved to a new
460 * struct configuration_spec, accessed through csp->config->globalname
461 * Most of the globals remaining are used by the Win32 GUI.
463 * Revision 1.4 2001/05/22 18:46:04 oes
465 * - Enabled filtering banners by size rather than URL
466 * by adding patterns that replace all standard banner
467 * sizes with the "Junkbuster" gif to the re_filterfile
469 * - Enabled filtering WebBugs by providing a pattern
470 * which kills all 1x1 images
472 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
473 * which is selected by the (nonstandard and therefore
474 * capital) letter 'U' in the option string.
475 * It causes the quantifiers to be ungreedy by default.
476 * Appending a ? turns back to greedy (!).
478 * - Added a new interceptor ijb-send-banner, which
479 * sends back the "Junkbuster" gif. Without imagelist or
480 * MSIE detection support, or if tinygif = 1, or the
481 * URL isn't recognized as an imageurl, a lame HTML
482 * explanation is sent instead.
484 * - Added new feature, which permits blocking remote
485 * script redirects and firing back a local redirect
487 * The feature is conditionally compiled, i.e. it
488 * can be disabled with --disable-fast-redirects,
489 * plus it must be activated by a "fast-redirects"
490 * line in the config file, has its own log level
491 * and of course wants to be displayed by show-proxy-args
492 * Note: Boy, all the #ifdefs in 1001 locations and
493 * all the fumbling with configure.in and acconfig.h
494 * were *way* more work than the feature itself :-(
496 * - Because a generic redirect template was needed for
497 * this, tinygif = 3 now uses the same.
499 * - Moved GIFs, and other static HTTP response templates
504 * - Removed some >400 CRs again (Jon, you really worked
507 * Revision 1.3 2001/05/20 01:21:20 jongfoster
508 * Version 2.9.4 checkin.
509 * - Merged popupfile and cookiefile, and added control over PCRS
510 * filtering, in new "actionsfile".
511 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
512 * file error you now get a message box (in the Win32 GUI) rather
513 * than the program exiting with no explanation.
514 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
516 * - Removed tabs from "config"
517 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
518 * - Bumped up version number.
520 * Revision 1.2 2001/05/17 23:01:01 oes
521 * - Cleaned CRLF's from the sources and related files
523 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
524 * Initial import of version 2.9.3 source tree
527 *********************************************************************/
530 /* Declare struct FILE for vars and funcs. */
533 /* Need time_t for file_list */
535 /* Needed for pcre choice */
539 * Include appropriate regular expression libraries.
540 * Note that pcrs and pcre (native) are needed for cgi
541 * and are included anyway.
547 # ifdef PCRE_H_IN_SUBDIR
548 # include <pcre/pcre.h>
561 # include "pcreposix.h"
563 # ifdef PCRE_H_IN_SUBDIR
564 # include <pcre/pcreposix.h>
566 # include <pcreposix.h>
572 #endif /* def AMIGA */
576 * I don't want to have to #include all this just for the declaration
577 * of SOCKET. However, it looks like we have to...
592 typedef SOCKET jb_socket;
594 #define JB_INVALID_SOCKET INVALID_SOCKET
596 #else /* ndef _WIN32 */
599 * The type used by sockets. On UNIX it's an int. Microsoft decided to
600 * make it an unsigned.
602 typedef int jb_socket;
605 * The error value used for variables of type jb_socket. On UNIX this
606 * is -1, however Microsoft decided to make socket handles unsigned, so
607 * they use a different value.
610 #define JB_INVALID_SOCKET (-1)
612 #endif /* ndef _WIN32 */
616 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
621 #define JB_ERR_OK 0 /**< Success, no error */
622 #define JB_ERR_MEMORY 1 /**< Out of memory */
623 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
624 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
625 #define JB_ERR_PARSE 4 /**< Error parsing file */
626 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
627 CGI actions editor. */
631 * This macro is used to free a pointer that may be NULL.
632 * It also sets the variable to NULL after it's been freed.
633 * The paramater should be a simple variable without side effects.
635 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
639 * Fix a problem with Solaris. There should be no effect on other
642 * Solaris's isspace() is a macro which uses it's argument directly
643 * as an array index. Therefore we need to make sure that high-bit
644 * characters generate +ve values, and ideally we also want to make
645 * the argument match the declared parameter type of "int".
647 * Note: Remember to #include <ctype.h> if you use these macros.
649 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
650 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
651 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
654 * Use for statically allocated buffers if you have no other choice.
655 * Remember to check the length of what you write into the buffer
656 * - we don't want any buffer overflows!
658 #define BUFFER_SIZE 5000
661 * Max length of CGI parameters (arbitrary limit).
663 #define CGI_PARAM_LEN_MAX 500
666 * Buffer size for capturing struct hostent data in the
667 * gethostby(name|addr)_r library calls. Since we don't
668 * loop over gethostbyname_r, the buffer must be sufficient
669 * to accomodate multiple IN A RRs, as used in DNS round robin
670 * load balancing. W3C's wwwlib uses 1K, so that should be
671 * good enough for us, too.
674 * XXX: Temporary doubled, for some configurations
675 * 1K is still too small and we didn't get the
676 * real fix ready for inclusion.
678 #define HOSTENT_BUFFER_SIZE 2048
681 * Do not use. Originally this was so that you can
682 * say "while (FOREVER) { ...do something... }".
683 * However, this gives a warning with some compilers (e.g. VC++).
684 * Instead, use "for (;;) { ...do something... }".
689 * Default IP address to listen on, as a string.
690 * Set to "127.0.0.1".
692 #define HADDR_DEFAULT "127.0.0.1"
695 * Default port to listen on, as a number.
698 #define HADDR_PORT 8118
701 /* Forward def for struct client_state */
702 struct configuration_spec;
706 * Entry in a linked list of strings.
711 * The string pointer. It must point to a dynamically malloc()ed
712 * string or be NULL for the list functions to work. In the latter
713 * case, just be careful next time you iterate through the list in
718 /** Next entry in the linked list, or NULL if no more. */
719 struct list_entry *next;
723 * A header for a linked list of strings.
727 /** First entry in the list, or NULL if the list is empty. */
728 struct list_entry *first;
730 /** Last entry in the list, or NULL if the list is empty. */
731 struct list_entry *last;
736 * An entry in a map. This is a name=value pair.
740 /** The key for the map. */
742 /** The value associated with that key. */
744 /** The next map entry, or NULL if none. */
745 struct map_entry *next;
749 * A map from a string to another string.
750 * This is used for the paramaters passed in a HTTP GET request, and
751 * to store the exports when the CGI interface is filling in a template.
755 /** The first map entry, or NULL if the map is empty. */
756 struct map_entry *first;
757 /** The last map entry, or NULL if the map is empty. */
758 struct map_entry *last;
763 * A HTTP request. This includes the method (GET, POST) and
766 * This is also used whenever we want to match a URL against a
767 * URL pattern. This always contains the URL to match, and never
768 * a URL pattern. (See struct url_spec).
772 char *cmd; /**< Whole command line: method, URL, Version */
773 char *ocmd; /**< Backup of original cmd for CLF logging */
774 char *gpc; /**< HTTP method: GET, POST, ... */
775 char *url; /**< The URL */
776 char *ver; /**< Protocol version */
777 int status; /**< HTTP Status */
779 char *host; /**< Host part of URL */
780 int port; /**< Port of URL or 80 (default) */
781 char *path; /**< Path of URL */
782 char *hostport; /**< host[:port] */
783 int ssl; /**< Flag if protocol is https */
785 char *host_ip_addr_str; /**< String with dotted decimal representation
786 of host's IP. NULL before connect_to() */
788 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
789 char **dvec; /**< List of pointers to the strings in dbuffer. */
790 int dcount; /**< How many parts to this domain? (length of dvec) */
795 * Response generated by CGI, blocker, or error handler
799 char *status; /**< HTTP status (string). */
800 struct list headers[1]; /**< List of header lines. */
801 char *head; /**< Formatted http response head. */
802 size_t head_length; /**< Length of http response head. */
803 char *body; /**< HTTP document body. */
804 size_t content_length; /**< Length of body, REQUIRED if binary body. */
805 int is_static; /**< Nonzero if the content will never change and
806 should be cached by the browser (e.g. images). */
814 /** The string which was parsed to produce this url_spec.
815 Used for debugging or display only. */
818 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
819 char **dvec; /**< List of pointers to the strings in dbuffer. */
820 int dcount; /**< How many parts to this domain? (length of dvec) */
821 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
823 int port; /**< The port number, or 0 to match all ports. */
825 char *path; /**< The source for the regex. */
826 int pathlen; /**< ==strlen(path). Needed for prefix matching. FIXME: Now obsolete? */
827 regex_t *preg; /**< Regex for matching path part */
831 * If you declare a static url_spec, this is the value to initialize it to zero.
833 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
836 * Constant for host part matching in URLs. If set, indicates that the start of
837 * the pattern must match the start of the URL. E.g. this is not set for the
838 * pattern ".example.com", so that it will match both "example.com" and
839 * "www.example.com". It is set for the pattern "example.com", which makes it
840 * match "example.com" only, not "www.example.com".
842 #define ANCHOR_LEFT 1
845 * Constant for host part matching in URLs. If set, indicates that the end of
846 * the pattern must match the end of the URL. E.g. this is not set for the
847 * pattern "ad.", so that it will match any host called "ad", irrespective
848 * of how many subdomains are in the fully-qualified domain name.
850 #define ANCHOR_RIGHT 2
854 * An I/O buffer. Holds a string which can be appended to, and can have data
855 * removed from the beginning.
859 char *buf; /**< Start of buffer */
860 char *cur; /**< Start of relevant data */
861 char *eod; /**< End of relevant data */
862 size_t size; /**< Size as malloc()ed */
867 * Return the number of bytes in the I/O buffer associated with the passed
868 * client_state pointer.
871 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
875 * Remove any data in the I/O buffer associated with the passed
876 * client_state pointer.
878 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
880 /* Bits for csp->content_type */
881 #define CT_TEXT 1 /**< csp->content_type bitmask:
882 Suitable for pcrs filtering. */
883 #define CT_GIF 2 /**< csp->content_type bitmask:
884 Suitable for GIF filtering. */
885 #define CT_TABOO 4 /**< csp->content_type bitmask:
886 DO NOT filter, irrespective of other flags. */
887 #define CT_JPEG 8 /**< csp->content_type bitmask:
888 Suitable for JPEG filtering. */
891 * The mask which includes all actions.
893 #define ACTION_MASK_ALL (~0UL)
896 * The most compatible set of actions - i.e. none.
898 #define ACTION_MOST_COMPATIBLE 0x00000000UL
900 /** Action bitmap: Block the request. */
901 #define ACTION_BLOCK 0x00000001UL
902 /** Action bitmap: Deanimate if it's a GIF. */
903 #define ACTION_DEANIMATE 0x00000002UL
904 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
905 #define ACTION_DOWNGRADE 0x00000004UL
906 /** Action bitmap: Fast redirects. */
907 #define ACTION_FAST_REDIRECTS 0x00000008UL
908 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
909 #define ACTION_HIDE_FORWARDED 0x00000010UL
910 /** Action bitmap: Hide "From" header. */
911 #define ACTION_HIDE_FROM 0x00000020UL
912 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
913 #define ACTION_HIDE_REFERER 0x00000040UL
914 /** Action bitmap: Hide "User-Agent" and similar headers. */
915 #define ACTION_HIDE_USER_AGENT 0x00000080UL
916 /** Action bitmap: This is an image. */
917 #define ACTION_IMAGE 0x00000100UL
918 /** Action bitmap: Sets the image blocker. */
919 #define ACTION_IMAGE_BLOCKER 0x00000200UL
920 /** Action bitmap: Prevent compression. */
921 #define ACTION_NO_COMPRESSION 0x00000400UL
922 /** Action bitmap: Change cookies to session only cookies. */
923 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
924 /** Action bitmap: Block rending cookies. */
925 #define ACTION_NO_COOKIE_READ 0x00001000UL
926 /** Action bitmap: Block setting cookies. */
927 #define ACTION_NO_COOKIE_SET 0x00002000UL
928 /** Action bitmap: Filter out popups. */
929 #define ACTION_NO_POPUPS 0x00004000UL
930 /** Action bitmap: Send a vanilla wafer. */
931 #define ACTION_VANILLA_WAFER 0x00008000UL
932 /** Action bitmap: Limit CONNECT requests to safe ports. */
933 #define ACTION_LIMIT_CONNECT 0x00010000UL
934 /** Action bitmap: Inspect if it's a JPEG. */
935 #define ACTION_JPEG_INSPECT 0x00020000UL
936 /** Action bitmap: Crunch or modify "if-modified-since" header. */
937 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
938 /** Action bitmap: Overwrite Content-Type header. */
939 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
940 /** Action bitmap: Crunch specified server header. */
941 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
942 /** Action bitmap: Crunch specified client header */
943 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
944 /** Action bitmap: Enable text mode by force */
945 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
946 /** Action bitmap: Enable text mode by force */
947 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
948 /** Action bitmap: Enable content-dispostion crunching */
949 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
950 /** Action bitmap: Replace or block Last-Modified header */
951 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
952 /** Action bitmap: Replace or block Accept-Language header */
953 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
954 /** Action bitmap: Block as empty document */
955 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x08000000UL
956 /** Action bitmap: Redirect request. */
957 #define ACTION_REDIRECT 0x10000000UL
958 /** Action bitmap: Answer blocked Connects verbosely */
959 #define ACTION_TREAT_FORBIDDEN_CONNECTS_LIKE_BLOCKS 0x20000000UL
960 /** Action bitmap: Filter server headers with pcre */
961 #define ACTION_FILTER_SERVER_HEADERS 0x40000000UL
962 /** Action bitmap: Filter client headers with pcre */
963 #define ACTION_FILTER_CLIENT_HEADERS 0x80000000UL
966 /** Action string index: How to deanimate GIFs */
967 #define ACTION_STRING_DEANIMATE 0
968 /** Action string index: Replacement for "From:" header */
969 #define ACTION_STRING_FROM 1
970 /** Action string index: How to block images */
971 #define ACTION_STRING_IMAGE_BLOCKER 2
972 /** Action string index: Replacement for "Referer:" header */
973 #define ACTION_STRING_REFERER 3
974 /** Action string index: Replacement for "User-Agent:" header */
975 #define ACTION_STRING_USER_AGENT 4
976 /** Action string index: Legal CONNECT ports. */
977 #define ACTION_STRING_LIMIT_CONNECT 5
978 /** Action string index: Server headers containing this pattern are crunched*/
979 #define ACTION_STRING_SERVER_HEADER 6
980 /** Action string index: Client headers containing this pattern are crunched*/
981 #define ACTION_STRING_CLIENT_HEADER 7
982 /** Action string index: Replacement for the "Accept-Language:" header*/
983 #define ACTION_STRING_LANGUAGE 8
984 /** Action string index: Replacement for the "Content-Type:" header*/
985 #define ACTION_STRING_CONTENT_TYPE 9
986 /** Action string index: Replacement for the "content-dispostion:" header*/
987 #define ACTION_STRING_CONTENT_DISPOSITION 10
988 /** Action string index: Replacement for the "If-Modified-Since:" header*/
989 #define ACTION_STRING_IF_MODIFIED_SINCE 11
990 /** Action string index: Replacement for the "Last-Modified:" header. */
991 #define ACTION_STRING_LAST_MODIFIED 12
992 /** Action string index: Redirect URL */
993 #define ACTION_STRING_REDIRECT 13
994 /** Action string index: Decode before redirect? */
995 #define ACTION_STRING_FAST_REDIRECTS 14
996 /** Number of string actions. */
997 #define ACTION_STRING_COUNT 15
1000 /*To make the ugly hack in sed easier to understand*/
1001 #define CHECK_EVERY_HEADER_REMAINING 0
1004 /** Index into current_action_spec::multi[] for headers to add. */
1005 #define ACTION_MULTI_ADD_HEADER 0
1006 /** Index into current_action_spec::multi[] for headers to add. */
1007 #define ACTION_MULTI_WAFER 1
1008 /** Index into current_action_spec::multi[] for filters to apply. */
1009 #define ACTION_MULTI_FILTER 2
1010 /** Number of multi-string actions. */
1011 #define ACTION_MULTI_COUNT 3
1015 * This structure contains a list of actions to apply to a URL.
1016 * It only contains positive instructions - no "-" options.
1017 * It is not used to store the actions list itself, only for
1018 * url_actions() to return the current values.
1020 struct current_action_spec
1022 /** Actions to apply. A bit set to "1" means perform the action. */
1023 unsigned long flags;
1026 * Paramaters for those actions that require them.
1027 * Each entry is valid if & only if the corresponding entry in "flags" is
1030 char * string[ACTION_STRING_COUNT];
1032 /** Lists of strings for multi-string actions. */
1033 struct list multi[ACTION_MULTI_COUNT][1];
1038 * This structure contains a set of changes to actions.
1039 * It can contain both positive and negative instructions.
1040 * It is used to store an entry in the actions list.
1044 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1045 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1048 * Paramaters for those actions that require them.
1049 * Each entry is valid if & only if the corresponding entry in "flags" is
1052 char * string[ACTION_STRING_COUNT];
1054 /** Lists of strings to remove, for multi-string actions. */
1055 struct list multi_remove[ACTION_MULTI_COUNT][1];
1057 /** If nonzero, remove *all* strings from the multi-string action. */
1058 int multi_remove_all[ACTION_MULTI_COUNT];
1060 /** Lists of strings to add, for multi-string actions. */
1061 struct list multi_add[ACTION_MULTI_COUNT][1];
1066 * This structure is used to store the actions list.
1068 * It contains a URL pattern, and the chages to the actions.
1069 * It is a linked list.
1073 struct url_spec url[1]; /**< URL pattern. */
1075 struct action_spec action[1]; /**< Actions. */
1077 struct url_actions * next; /**< Next action in file, or NULL. */
1082 * Flags for use in csp->flags
1086 * Flag for csp->flags: Set if this client is processing data.
1087 * Cleared when the thread associated with this structure dies.
1089 #define CSP_FLAG_ACTIVE 0x01
1092 * Flag for csp->flags: Set if the server's reply is in "chunked"
1095 #define CSP_FLAG_CHUNKED 0x02
1098 * Flag for csp->flags: Set if this request was enforced, although it would
1099 * normally have been blocked.
1101 #define CSP_FLAG_FORCED 0x04
1104 * Flag for csp->flags: Set if any modification to the body was done.
1106 #define CSP_FLAG_MODIFIED 0x08
1109 * Flag for csp->flags: Set if request was blocked.
1111 #define CSP_FLAG_REJECTED 0x10
1114 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1116 #define CSP_FLAG_TOGGLED_ON 0x20
1120 * Flags for use in return codes of child processes
1124 * Flag for process return code: Set if exiting porcess has been toggled
1125 * during its lifetime.
1127 #define RC_FLAG_TOGGLED 0x10
1130 * Flag for process return code: Set if exiting porcess has blocked its
1133 #define RC_FLAG_BLOCKED 0x20
1136 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1139 #define MAX_AF_FILES 10
1142 * The state of a Privoxy processing thread.
1146 /** The proxy's configuration */
1147 struct configuration_spec * config;
1149 /** The actions to perform on the current request */
1150 struct current_action_spec action[1];
1152 /** socket to talk to client (web browser) */
1155 /** socket to talk to server (web server or proxy) */
1158 /** Multi-purpose flag container, see CSP_FLAG_* above */
1159 unsigned short int flags;
1161 /** Client PC's IP address, as reported by the accept() function.
1164 /** Client PC's IP address, as reported by the accept() function.
1168 /** Our IP address. I.e. the IP address that the client used to reach us,
1170 char *my_ip_addr_str;
1172 /** Our hostname. I.e. the reverse DNS of the IP address that the client
1173 used to reach us, as a string. */
1176 /** The URL that was requested */
1177 struct http_request http[1];
1179 /** An I/O buffer used for buffering data read from the network */
1182 /** List of all headers for this request */
1183 struct list headers[1];
1185 /** List of all cookies for this request */
1186 struct list cookie_list[1];
1188 /** MIME-Type key, see CT_* above */
1189 unsigned short int content_type;
1191 /** The "X-Forwarded-For:" header sent by the client */
1194 /** Actions files associated with this client */
1195 struct file_list *actions_list[MAX_AF_FILES];
1197 /** pcrs job files. */
1198 struct file_list *rlist[MAX_AF_FILES];
1200 /** Length after content modification. */
1201 size_t content_length;
1203 #ifdef FEATURE_TRUST
1206 struct file_list *tlist;
1208 #endif /* def FEATURE_TRUST */
1210 /** Next thread in linked list. Only read or modify from the main thread! */
1211 struct client_state *next;
1216 * A function to add a header
1218 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1221 * A function to process a header
1223 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1227 * List of functions to run on a list of headers
1231 /** The header prefix to match */
1234 /** The length of the prefix to match */
1237 /** The function to apply to this line */
1238 parser_func_ptr parser;
1243 * List of available CGI functions.
1245 struct cgi_dispatcher
1247 /** The URL of the CGI, relative to the CGI root. */
1248 const char * const name;
1250 /** The handler function for the CGI */
1251 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1253 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1254 const char * const description;
1256 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1262 * A data file used by Privoxy. Kept in a linked list.
1267 * This is a pointer to the data structures associated with the file.
1268 * Read-only once the structure has been created.
1273 * The unloader function.
1274 * Normally NULL. When we are finished with file (i.e. when we have
1275 * loaded a new one), set to a pointer to an unloader function.
1276 * Unloader will be called by sweep() (called from main loop) when
1277 * all clients using this file are done. This prevents threading
1280 void (*unloader)(void *);
1283 * Used internally by sweep(). Do not access from elsewhere.
1288 * File last-modified time, so we can check if file has been changed.
1289 * Read-only once the structure has been created.
1291 time_t lastmodified;
1294 * The full filename.
1299 * Pointer to next entry in the linked list of all "file_list"s.
1300 * This linked list is so that sweep() can navigate it.
1301 * Since sweep() can remove items from the list, we must be careful
1302 * to only access this value from main thread (when we know sweep
1303 * won't be running).
1305 struct file_list *next;
1309 #ifdef FEATURE_TRUST
1312 * The format of a trust file when loaded into memory.
1316 struct url_spec url[1]; /**< The URL pattern */
1317 int reject; /**< FIXME: Please document this! */
1318 struct block_spec *next; /**< Next entry in linked list */
1322 * Arbitrary limit for the number of trusted referrers
1323 * Privoxy can print in its blocking message.
1325 #define MAX_TRUSTED_REFERRERS 512
1327 #endif /* def FEATURE_TRUST */
1330 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1331 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1332 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1336 * How to forward a connection to a parent proxy.
1340 /** URL pattern that this forward_spec is for. */
1341 struct url_spec url[1];
1343 /** Connection type. Must be SOCKS_NONE, SOCKS_4, or SOCKS_4A. */
1346 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1349 /** SOCKS server port. */
1352 /** Parent HTTP proxy hostname, or NULL for none. */
1355 /** Parent HTTP proxy port. */
1358 /** Next entry in the linked list. */
1359 struct forward_spec *next;
1364 * Initializer for a static struct forward_spec.
1366 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1370 * This struct represents one filter (one block) from
1371 * the re_filterfile. If there is more than one filter
1372 * in the file, the file will be represented by a
1373 * chained list of re_filterfile specs.
1375 struct re_filterfile_spec
1377 char *name; /**< Name from FILTER: statement in re_filterfile. */
1378 char *description; /**< Description from FILTER: statement in re_filterfile. */
1379 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1380 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1381 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1387 #define ACL_PERMIT 1 /**< Accept connection request */
1388 #define ACL_DENY 2 /**< Reject connection request */
1391 * An IP address pattern. Used to specify networks in the ACL.
1393 struct access_control_addr
1395 unsigned long addr; /**< The IP address as an integer. */
1396 unsigned long mask; /**< The network mask as an integer. */
1397 unsigned long port; /**< The port number. */
1401 * An access control list (ACL) entry.
1403 * This is a linked list.
1405 struct access_control_list
1407 struct access_control_addr src[1]; /**< Client IP address */
1408 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1410 short action; /**< ACL_PERMIT or ACL_DENY */
1411 struct access_control_list *next; /**< The next entry in the ACL. */
1414 #endif /* def FEATURE_ACL */
1417 /** Maximum number of loaders (actions, re_filter, ...) */
1421 /** configuration_spec::feature_flags: CGI actions editor. */
1422 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1424 /** configuration_spec::feature_flags: Web-based toggle. */
1425 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1427 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1428 #define RUNTIME_FEATURE_HTTP_TOGGLE 4
1430 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1431 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8
1434 * Data loaded from the configuration file.
1436 * (Anomaly: toggle is still handled through a global, not this structure)
1438 struct configuration_spec
1443 /** Nonzero to enable multithreading. */
1447 * Bitmask of features that can be enabled/disabled through the config
1448 * file. Currently defined bits:
1450 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1451 * - RUNTIME_FEATURE_CGI_TOGGLE
1452 * - RUNTIME_FEATURE_HTTP_TOGGLE
1453 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1455 unsigned feature_flags;
1457 /** The log file name. */
1458 const char *logfile;
1460 /** The config file directory. */
1461 const char *confdir;
1463 /** The log file directory. */
1466 /** The full paths to the actions files. */
1467 const char *actions_file[MAX_AF_FILES];
1469 /** The short names of the actions files. */
1470 const char *actions_file_short[MAX_AF_FILES];
1472 /** The administrator's email address */
1473 char *admin_address;
1475 /** A URL with info on this proxy */
1476 char *proxy_info_url;
1478 /** URL to the user manual (on our website or local copy) */
1481 /** The file names of the pcre filter files. */
1482 const char *re_filterfile[MAX_AF_FILES];
1484 /** The short names of the pcre filter files. */
1485 const char *re_filterfile_short[MAX_AF_FILES];
1487 #ifdef FEATURE_COOKIE_JAR
1489 /** The file name of the cookie jar file */
1490 const char * jarfile;
1492 /** The handle to the cookie jar file */
1495 #endif /* def FEATURE_COOKIE_JAR */
1497 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1500 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1503 /** Size limit for IOB */
1504 size_t buffer_limit;
1506 #ifdef FEATURE_TRUST
1508 /** The file name of the trust file. */
1509 const char * trustfile;
1511 /** FIXME: DOCME: Document this. */
1512 struct list trust_info[1];
1514 /** FIXME: DOCME: Document this. */
1515 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1517 #endif /* def FEATURE_TRUST */
1521 /** The access control list (ACL). */
1522 struct access_control_list *acl;
1524 #endif /* def FEATURE_ACL */
1526 /** Information about parent proxies (forwarding). */
1527 struct forward_spec *forward;
1529 /** Number of retries in case a forwarded connection attempt fails */
1530 int forwarded_connect_retries;
1532 /** All options from the config file, HTML-formatted. */
1535 /** The configuration file object. */
1536 struct file_list *config_file_list;
1538 /** List of loaders */
1539 int (*loaders[NLOADERS])(struct client_state *);
1541 /** Nonzero if we need to bind() to the new port. */
1545 /** Calculates the number of elements in an array, using sizeof. */
1546 #define SZ(X) (sizeof(X) / sizeof(*X))
1548 #ifdef FEATURE_FORCE_LOAD
1549 /** The force load URL prefix. */
1550 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1551 #endif /* def FEATURE_FORCE_LOAD */
1553 #ifdef FEATURE_NO_GIFS
1554 /** The MIME type for images ("image/png" or "image/gif"). */
1555 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1557 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1558 #endif /* def FEATURE_NO_GIFS */
1565 /** URL for the Privoxy home page. */
1566 #define HOME_PAGE_URL "http://www.privoxy.org/"
1568 /** URL for the Privoxy user manual. */
1569 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1571 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1572 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1574 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1575 #define CONFIG_HELP_PREFIX "config.html#"
1578 * The "hosts" to intercept and display CGI pages.
1579 * First one is a hostname only, second one can specify host and path.
1582 * 1) Do not specify the http: prefix
1583 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1584 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1586 #define CGI_SITE_1_HOST "p.p"
1587 #define CGI_SITE_2_HOST "config.privoxy.org"
1588 #define CGI_SITE_2_PATH ""
1591 * The prefix for CGI pages. Written out in generated HTML.
1592 * INCLUDES the trailing slash.
1594 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1600 #endif /* ndef PROJECT_H_INCLUDED */