1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.86 2006/12/31 17:56:37 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.86 2006/12/31 17:56:37 fabiankeil
41 * Added config option accept-intercepted-requests
42 * and disabled it by default.
44 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
45 * Fix gcc43 compiler warnings and a comment.
47 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
48 * Add config option "split-large-forms"
49 * to work around the browser bug reported
52 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
53 * Moved HTTP snipplets into jcc.c. They aren't
56 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
57 * Doubled size of HOSTENT_BUFFER_SIZE to mask
58 * problems with gethostbyname_r and some
59 * /etc/hosts configurations. Only a workaround
60 * until we get the real fix ready.
61 * Thanks FĂ©lix Rauch for reporting.
63 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
65 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
66 * Respond with 400 and a short text message
67 * if the client tries to use Privoxy as FTP proxy.
69 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
70 * Added config option enable-remote-http-toggle
71 * to specify if Privoxy should recognize special
72 * headers (currently only X-Filter) to change its
73 * behaviour. Disabled by default.
75 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
76 * Make number of retries in case of forwarded-connect problems
77 * a config file option (forwarded-connect-retries) and use 0 as
80 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
81 * Work around a buffer overflow that caused Privoxy to
82 * segfault if too many trusted referrers were used. Good
83 * enough for now, but should be replaced with a real
84 * solution after the next release.
86 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
89 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
90 * Split filter-headers{} into filter-client-headers{}
91 * and filter-server-headers{}.
92 * Added parse_header_time() to share some code.
93 * Replaced timegm() with mktime().
95 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
96 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
98 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
99 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
100 * with what was really the latest development (the v_3_0_branch branch)
102 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
103 * Multiple filter file support
105 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
106 * Add the ability to check jpeg images for invalid
107 * lengths of comment blocks. Defensive strategy
108 * against the exploit:
109 * Microsoft Security Bulletin MS04-028
110 * Buffer Overrun in JPEG Processing (GDI+) Could
111 * Allow Code Execution (833987)
112 * Enabled with +inspect-jpegs in actions files.
114 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
115 * Updated the copyright note
117 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
118 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
120 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
121 * Introduced RC_FLAG_* flags for use in child process return code
123 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
124 * Added flag to each cgi_dispatcher that allows or denies
125 * external linking and removed const qualifier from
126 * struct list_entry.str.
128 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
129 * - Include config.h for access to config data
130 * - Include <pcre*.h> depending on where they are
132 * Revision 1.72 2002/05/14 21:35:49 oes
133 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
134 * because of split in user-manual
136 * Revision 1.71 2002/05/12 21:39:36 jongfoster
137 * - Adding Doxygen-style comments to structures and #defines.
139 * Revision 1.70 2002/05/12 16:05:50 jongfoster
140 * Fixing ACTION_MASK_ALL to be unsigned long rather than
141 * just unsigned int. I don't know if anyone is porting
142 * Privoxy to 16-bit platforms, but if so, +limit-connect
143 * wouldn't have worked because of this bug.
145 * Revision 1.69 2002/05/08 16:00:16 oes
146 * Added size member to struct iob, so it can
147 * be alloced larger than needed.
149 * Revision 1.68 2002/04/26 12:56:00 oes
150 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
152 * Revision 1.67 2002/04/24 02:12:43 oes
153 * - Jon's multiple AF patch:
154 * - Make csp->actions_list an array
155 * - #define MAX_AF_FILES
156 * - Moved CGI_PARAM_LEN_MAX (500) here
158 * Revision 1.66 2002/04/15 19:06:43 jongfoster
161 * Revision 1.65 2002/04/04 00:36:36 gliptak
162 * always use pcre for matching
164 * Revision 1.64 2002/04/03 22:28:03 gliptak
165 * Removed references to gnu_regex
167 * Revision 1.63 2002/03/31 17:19:00 jongfoster
168 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
170 * Revision 1.62 2002/03/26 22:48:49 swa
173 * Revision 1.61 2002/03/26 22:29:55 swa
174 * we have a new homepage!
176 * Revision 1.60 2002/03/24 15:52:17 jongfoster
177 * Changing CGI URL prefixes for new name
179 * Revision 1.59 2002/03/24 15:23:33 jongfoster
182 * Revision 1.58 2002/03/24 13:25:43 swa
183 * name change related issues
185 * Revision 1.57 2002/03/16 20:28:34 oes
186 * Added descriptions to the filters so users will know what they select in the cgi editor
188 * Revision 1.56 2002/03/13 20:27:30 oes
189 * Fixing bug with CT_TABOO
191 * Revision 1.55 2002/03/12 01:42:50 oes
192 * Introduced modular filters
194 * Revision 1.54 2002/03/09 20:03:52 jongfoster
195 * - Making various functions return int rather than size_t.
196 * (Undoing a recent change). Since size_t is unsigned on
197 * Windows, functions like read_socket that return -1 on
198 * error cannot return a size_t.
200 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
201 * crashes, and also frequently caused JB to jump to 100%
202 * CPU and stay there. (Because it thought it had just
203 * read ((unsigned)-1) == 4Gb of data...)
205 * - The signature of write_socket has changed, it now simply
206 * returns success=0/failure=nonzero.
208 * - Trying to get rid of a few warnings --with-debug on
209 * Windows, I've introduced a new type "jb_socket". This is
210 * used for the socket file descriptors. On Windows, this
211 * is SOCKET (a typedef for unsigned). Everywhere else, it's
212 * an int. The error value can't be -1 any more, so it's
213 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
214 * Windows it maps to the #define INVALID_SOCKET.)
216 * - The signature of bind_port has changed.
218 * Revision 1.53 2002/03/08 16:48:55 oes
219 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
221 * Revision 1.52 2002/03/07 03:46:17 oes
222 * Fixed compiler warnings
224 * Revision 1.51 2002/03/05 04:52:42 oes
225 * Deleted non-errlog debugging code
227 * Revision 1.50 2002/03/04 19:32:07 oes
228 * Changed default port to 8118
230 * Revision 1.49 2002/03/04 18:28:55 oes
231 * Deleted PID_FILE_NAME
233 * Revision 1.48 2002/03/03 14:50:40 oes
234 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
236 * Revision 1.47 2002/02/20 23:15:13 jongfoster
237 * Parsing functions now handle out-of-memory gracefully by returning
240 * Revision 1.46 2002/01/17 21:06:09 jongfoster
241 * Now #defining the URLs of the config interface
243 * Minor changes to struct http_request and struct url_spec due to
244 * standardizing that struct http_request is used to represent a URL, and
245 * struct url_spec is used to represent a URL pattern. (Before, URLs were
246 * represented as seperate variables and a partially-filled-in url_spec).
248 * Revision 1.45 2002/01/09 14:33:27 oes
249 * Added HOSTENT_BUFFER_SIZE
251 * Revision 1.44 2001/12/30 14:07:32 steudten
252 * - Add signal handling (unix)
253 * - Add SIGHUP handler (unix)
254 * - Add creation of pidfile (unix)
255 * - Add action 'top' in rc file (RH)
256 * - Add entry 'SIGNALS' to manpage
257 * - Add exit message to logfile (unix)
259 * Revision 1.43 2001/11/22 21:57:51 jongfoster
260 * Making action_spec->flags into an unsigned long rather than just an
262 * Adding ACTION_NO_COOKIE_KEEP
264 * Revision 1.42 2001/11/05 21:42:41 steudten
265 * Include DBG() macro.
267 * Revision 1.41 2001/10/28 19:12:06 jongfoster
268 * Adding ijb_toupper()
270 * Revision 1.40 2001/10/26 17:40:47 oes
271 * Moved ijb_isspace and ijb_tolower to project.h
272 * Removed http->user_agent, csp->referrer and csp->accept_types
274 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
275 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
276 * macro when called with a cast; so moving the cast to the macro def'n
277 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
278 * doesn't make macro expansion complain. Hope this works for everyone else
281 * Revision 1.38 2001/10/23 21:19:04 jongfoster
282 * New error-handling support: jb_err type and JB_ERR_xxx constants
283 * CGI functions now return a jb_err, and their parameters map is const.
284 * Support for RUNTIME_FEATUREs to enable/disable config editor
285 * Adding a few comments
287 * Revision 1.37 2001/10/14 22:14:01 jongfoster
288 * Removing name_length field from struct cgi_dispatcher, as this is
289 * now calculated at runtime from the "name" field.
291 * Revision 1.36 2001/10/10 16:45:15 oes
292 * Added LIMIT_CONNECT action and string
293 * Fixed HTTP message line termination
294 * Added CFORBIDDEN HTTP message
296 * Revision 1.35 2001/10/07 18:06:43 oes
297 * Added status member to struct http_request
299 * Revision 1.34 2001/10/07 15:45:25 oes
300 * Added url member to struct http_request and commented all
305 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
307 * Replaced struct client_state members rejected,
308 * force, active and toggled_on with "flags" bitmap.
310 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
312 * Added buffer_limit to struct configuration_spec
314 * Revision 1.33 2001/09/20 13:30:08 steudten
316 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
317 * Last case will set z to NULL in free(z) and thats bad..
319 * Revision 1.32 2001/09/16 23:02:51 jongfoster
322 * Revision 1.31 2001/09/16 13:20:29 jongfoster
323 * Rewrite of list library. Now has seperate header and list_entry
324 * structures. Also added a large sprinking of assert()s to the list
327 * Revision 1.30 2001/09/13 23:52:00 jongfoster
328 * Support for both static and dynamically generated CGI pages
330 * Revision 1.29 2001/09/13 23:29:43 jongfoster
331 * Defining FORWARD_SPEC_INITIALIZER
333 * Revision 1.28 2001/09/13 23:05:50 jongfoster
334 * Changing the string paramater to the header parsers a "const".
336 * Revision 1.27 2001/08/05 16:06:20 jongfoster
337 * Modifiying "struct map" so that there are now separate header and
338 * "map_entry" structures. This means that functions which modify a
339 * map no longer need to return a pointer to the modified map.
340 * Also, it no longer reverses the order of the entries (which may be
341 * important with some advanced template substitutions).
343 * Revision 1.26 2001/07/30 22:08:36 jongfoster
344 * Tidying up #defines:
345 * - All feature #defines are now of the form FEATURE_xxx
346 * - Permanently turned off WIN_GUI_EDIT
347 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
349 * Revision 1.25 2001/07/29 18:43:08 jongfoster
350 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
353 * Revision 1.24 2001/07/25 17:20:27 oes
354 * Introduced http->user_agent
356 * Revision 1.23 2001/07/18 12:32:23 oes
357 * - Added ACTION_STRING_DEANIMATE
358 * - moved #define freez from jcc.h to project.h
360 * Revision 1.22 2001/07/15 17:51:41 jongfoster
361 * Renaming #define STATIC to STATIC_PCRE
363 * Revision 1.21 2001/07/13 14:03:19 oes
364 * - Reorganized regex header inclusion and #defines to
365 * comply to the scheme in configure.in
366 * - Added csp->content_type and its CT_* keys
367 * - Added ACTION_DEANIMATE
368 * - Removed all #ifdef PCRS
370 * Revision 1.20 2001/06/29 21:45:41 oes
371 * Indentation, CRLF->LF, Tab-> Space
373 * Revision 1.19 2001/06/29 13:33:36 oes
374 * - Improved comments
375 * - Introduced http_request.host_ip_addr_str
376 * - Introduced http_response.head_length
377 * - Introduced config.my_ip_addr_str, config.my_hostname,
378 * config.admin_address and config.proxy_info_url
379 * - Removed config.proxy_args_header and config.proxy_args_trailer,
380 * renamed config.proxy_args_invocation to config.proxy_args
381 * - Removed HTML snipplets and GIFs
382 * - Removed logentry from cancelled commit
384 * Revision 1.18 2001/06/09 10:57:39 jongfoster
385 * Adding definition of BUFFER_SIZE.
386 * Changing struct cgi_dispatcher to use "const" strings.
388 * Revision 1.17 2001/06/07 23:15:09 jongfoster
389 * Merging ACL and forward files into config file.
390 * Moving struct gateway members into struct forward_spec
391 * Removing config->proxy_args_gateways
392 * Cosmetic: Adding a few comments
394 * Revision 1.16 2001/06/04 18:31:58 swa
395 * files are now prefixed with either `confdir' or `logdir'.
396 * `make redhat-dist' replaces both entries confdir and logdir
399 * Revision 1.15 2001/06/04 11:28:53 swa
400 * redirect did not work due to missing /
402 * Revision 1.14 2001/06/03 11:03:48 oes
404 * added struct http_response,
405 * changed struct interceptors to struct cgi_dispatcher,
406 * moved HTML stuff to cgi.h
408 * Revision 1.13 2001/06/01 20:05:36 jongfoster
409 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
410 * constant, and removed csp->tinygif.
412 * Revision 1.12 2001/06/01 18:49:17 jongfoster
413 * Replaced "list_share" with "list" - the tiny memory gain was not
414 * worth the extra complexity.
416 * Revision 1.11 2001/06/01 10:32:47 oes
417 * Added constants for anchoring selection bitmap
419 * Revision 1.10 2001/05/31 21:33:53 jongfoster
420 * Changes for new actions file, replacing permissionsfile
421 * and parts of the config file. Also added support for
424 * Revision 1.9 2001/05/31 17:32:31 oes
426 * - Enhanced domain part globbing with infix and prefix asterisk
427 * matching and optional unanchored operation
429 * Revision 1.8 2001/05/29 20:09:15 joergs
430 * HTTP_REDIRECT_TEMPLATE fixed.
432 * Revision 1.7 2001/05/29 09:50:24 jongfoster
433 * Unified blocklist/imagelist/actionslist.
434 * File format is still under discussion, but the internal changes
437 * Also modified interceptor behaviour:
438 * - We now intercept all URLs beginning with one of the following
439 * prefixes (and *only* these prefixes):
441 * * http://ijbswa.sf.net/config/
442 * * http://ijbswa.sourceforge.net/config/
443 * - New interceptors "home page" - go to http://i.j.b/ to see it.
444 * - Internal changes so that intercepted and fast redirect pages
445 * are not replaced with an image.
446 * - Interceptors now have the option to send a binary page direct
447 * to the client. (i.e. ijb-send-banner uses this)
448 * - Implemented show-url-info interceptor. (Which is why I needed
449 * the above interceptors changes - a typical URL is
450 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
451 * The previous mechanism would not have intercepted that, and
452 * if it had been intercepted then it then it would have replaced
455 * Revision 1.6 2001/05/27 22:17:04 oes
457 * - re_process_buffer no longer writes the modified buffer
458 * to the client, which was very ugly. It now returns the
459 * buffer, which it is then written by chat.
461 * - content_length now adjusts the Content-Length: header
462 * for modified documents rather than crunch()ing it.
463 * (Length info in csp->content_length, which is 0 for
464 * unmodified documents)
466 * - For this to work, sed() is called twice when filtering.
468 * Revision 1.5 2001/05/26 00:28:36 jongfoster
469 * Automatic reloading of config file.
470 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
471 * Most of the global variables have been moved to a new
472 * struct configuration_spec, accessed through csp->config->globalname
473 * Most of the globals remaining are used by the Win32 GUI.
475 * Revision 1.4 2001/05/22 18:46:04 oes
477 * - Enabled filtering banners by size rather than URL
478 * by adding patterns that replace all standard banner
479 * sizes with the "Junkbuster" gif to the re_filterfile
481 * - Enabled filtering WebBugs by providing a pattern
482 * which kills all 1x1 images
484 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
485 * which is selected by the (nonstandard and therefore
486 * capital) letter 'U' in the option string.
487 * It causes the quantifiers to be ungreedy by default.
488 * Appending a ? turns back to greedy (!).
490 * - Added a new interceptor ijb-send-banner, which
491 * sends back the "Junkbuster" gif. Without imagelist or
492 * MSIE detection support, or if tinygif = 1, or the
493 * URL isn't recognized as an imageurl, a lame HTML
494 * explanation is sent instead.
496 * - Added new feature, which permits blocking remote
497 * script redirects and firing back a local redirect
499 * The feature is conditionally compiled, i.e. it
500 * can be disabled with --disable-fast-redirects,
501 * plus it must be activated by a "fast-redirects"
502 * line in the config file, has its own log level
503 * and of course wants to be displayed by show-proxy-args
504 * Note: Boy, all the #ifdefs in 1001 locations and
505 * all the fumbling with configure.in and acconfig.h
506 * were *way* more work than the feature itself :-(
508 * - Because a generic redirect template was needed for
509 * this, tinygif = 3 now uses the same.
511 * - Moved GIFs, and other static HTTP response templates
516 * - Removed some >400 CRs again (Jon, you really worked
519 * Revision 1.3 2001/05/20 01:21:20 jongfoster
520 * Version 2.9.4 checkin.
521 * - Merged popupfile and cookiefile, and added control over PCRS
522 * filtering, in new "actionsfile".
523 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
524 * file error you now get a message box (in the Win32 GUI) rather
525 * than the program exiting with no explanation.
526 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
528 * - Removed tabs from "config"
529 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
530 * - Bumped up version number.
532 * Revision 1.2 2001/05/17 23:01:01 oes
533 * - Cleaned CRLF's from the sources and related files
535 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
536 * Initial import of version 2.9.3 source tree
539 *********************************************************************/
542 /* Declare struct FILE for vars and funcs. */
545 /* Need time_t for file_list */
547 /* Needed for pcre choice */
551 * Include appropriate regular expression libraries.
552 * Note that pcrs and pcre (native) are needed for cgi
553 * and are included anyway.
559 # ifdef PCRE_H_IN_SUBDIR
560 # include <pcre/pcre.h>
573 # include "pcreposix.h"
575 # ifdef PCRE_H_IN_SUBDIR
576 # include <pcre/pcreposix.h>
578 # include <pcreposix.h>
584 #endif /* def AMIGA */
588 * I don't want to have to #include all this just for the declaration
589 * of SOCKET. However, it looks like we have to...
604 typedef SOCKET jb_socket;
606 #define JB_INVALID_SOCKET INVALID_SOCKET
608 #else /* ndef _WIN32 */
611 * The type used by sockets. On UNIX it's an int. Microsoft decided to
612 * make it an unsigned.
614 typedef int jb_socket;
617 * The error value used for variables of type jb_socket. On UNIX this
618 * is -1, however Microsoft decided to make socket handles unsigned, so
619 * they use a different value.
622 #define JB_INVALID_SOCKET (-1)
624 #endif /* ndef _WIN32 */
628 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
633 #define JB_ERR_OK 0 /**< Success, no error */
634 #define JB_ERR_MEMORY 1 /**< Out of memory */
635 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
636 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
637 #define JB_ERR_PARSE 4 /**< Error parsing file */
638 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
639 CGI actions editor. */
640 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
643 * This macro is used to free a pointer that may be NULL.
644 * It also sets the variable to NULL after it's been freed.
645 * The paramater should be a simple variable without side effects.
647 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
651 * Fix a problem with Solaris. There should be no effect on other
654 * Solaris's isspace() is a macro which uses it's argument directly
655 * as an array index. Therefore we need to make sure that high-bit
656 * characters generate +ve values, and ideally we also want to make
657 * the argument match the declared parameter type of "int".
659 * Note: Remember to #include <ctype.h> if you use these macros.
661 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
662 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
663 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
666 * Use for statically allocated buffers if you have no other choice.
667 * Remember to check the length of what you write into the buffer
668 * - we don't want any buffer overflows!
670 #define BUFFER_SIZE 5000
673 * Max length of CGI parameters (arbitrary limit).
675 #define CGI_PARAM_LEN_MAX 500
678 * Buffer size for capturing struct hostent data in the
679 * gethostby(name|addr)_r library calls. Since we don't
680 * loop over gethostbyname_r, the buffer must be sufficient
681 * to accomodate multiple IN A RRs, as used in DNS round robin
682 * load balancing. W3C's wwwlib uses 1K, so that should be
683 * good enough for us, too.
686 * XXX: Temporary doubled, for some configurations
687 * 1K is still too small and we didn't get the
688 * real fix ready for inclusion.
690 #define HOSTENT_BUFFER_SIZE 2048
693 * Do not use. Originally this was so that you can
694 * say "while (FOREVER) { ...do something... }".
695 * However, this gives a warning with some compilers (e.g. VC++).
696 * Instead, use "for (;;) { ...do something... }".
701 * Default IP address to listen on, as a string.
702 * Set to "127.0.0.1".
704 #define HADDR_DEFAULT "127.0.0.1"
707 * Default port to listen on, as a number.
710 #define HADDR_PORT 8118
713 /* Forward def for struct client_state */
714 struct configuration_spec;
718 * Entry in a linked list of strings.
723 * The string pointer. It must point to a dynamically malloc()ed
724 * string or be NULL for the list functions to work. In the latter
725 * case, just be careful next time you iterate through the list in
730 /** Next entry in the linked list, or NULL if no more. */
731 struct list_entry *next;
735 * A header for a linked list of strings.
739 /** First entry in the list, or NULL if the list is empty. */
740 struct list_entry *first;
742 /** Last entry in the list, or NULL if the list is empty. */
743 struct list_entry *last;
748 * An entry in a map. This is a name=value pair.
752 /** The key for the map. */
754 /** The value associated with that key. */
756 /** The next map entry, or NULL if none. */
757 struct map_entry *next;
761 * A map from a string to another string.
762 * This is used for the paramaters passed in a HTTP GET request, and
763 * to store the exports when the CGI interface is filling in a template.
767 /** The first map entry, or NULL if the map is empty. */
768 struct map_entry *first;
769 /** The last map entry, or NULL if the map is empty. */
770 struct map_entry *last;
775 * A HTTP request. This includes the method (GET, POST) and
778 * This is also used whenever we want to match a URL against a
779 * URL pattern. This always contains the URL to match, and never
780 * a URL pattern. (See struct url_spec).
784 char *cmd; /**< Whole command line: method, URL, Version */
785 char *ocmd; /**< Backup of original cmd for CLF logging */
786 char *gpc; /**< HTTP method: GET, POST, ... */
787 char *url; /**< The URL */
788 char *ver; /**< Protocol version */
789 int status; /**< HTTP Status */
791 char *host; /**< Host part of URL */
792 int port; /**< Port of URL or 80 (default) */
793 char *path; /**< Path of URL */
794 char *hostport; /**< host[:port] */
795 int ssl; /**< Flag if protocol is https */
797 char *host_ip_addr_str; /**< String with dotted decimal representation
798 of host's IP. NULL before connect_to() */
800 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
801 char **dvec; /**< List of pointers to the strings in dbuffer. */
802 int dcount; /**< How many parts to this domain? (length of dvec) */
807 * Response generated by CGI, blocker, or error handler
811 char *status; /**< HTTP status (string). */
812 struct list headers[1]; /**< List of header lines. */
813 char *head; /**< Formatted http response head. */
814 size_t head_length; /**< Length of http response head. */
815 char *body; /**< HTTP document body. */
816 size_t content_length; /**< Length of body, REQUIRED if binary body. */
817 int is_static; /**< Nonzero if the content will never change and
818 should be cached by the browser (e.g. images). */
826 /** The string which was parsed to produce this url_spec.
827 Used for debugging or display only. */
830 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
831 char **dvec; /**< List of pointers to the strings in dbuffer. */
832 int dcount; /**< How many parts to this domain? (length of dvec) */
833 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
835 int port; /**< The port number, or 0 to match all ports. */
837 char *path; /**< The source for the regex. */
838 size_t pathlen; /**< ==strlen(path). Needed for prefix matching. FIXME: Now obsolete? */
839 regex_t *preg; /**< Regex for matching path part */
843 * If you declare a static url_spec, this is the value to initialize it to zero.
845 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
848 * Constant for host part matching in URLs. If set, indicates that the start of
849 * the pattern must match the start of the URL. E.g. this is not set for the
850 * pattern ".example.com", so that it will match both "example.com" and
851 * "www.example.com". It is set for the pattern "example.com", which makes it
852 * match "example.com" only, not "www.example.com".
854 #define ANCHOR_LEFT 1
857 * Constant for host part matching in URLs. If set, indicates that the end of
858 * the pattern must match the end of the URL. E.g. this is not set for the
859 * pattern "ad.", so that it will match any host called "ad", irrespective
860 * of how many subdomains are in the fully-qualified domain name.
862 #define ANCHOR_RIGHT 2
866 * An I/O buffer. Holds a string which can be appended to, and can have data
867 * removed from the beginning.
871 char *buf; /**< Start of buffer */
872 char *cur; /**< Start of relevant data */
873 char *eod; /**< End of relevant data */
874 size_t size; /**< Size as malloc()ed */
879 * Return the number of bytes in the I/O buffer associated with the passed
880 * client_state pointer.
883 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
887 * Remove any data in the I/O buffer associated with the passed
888 * client_state pointer.
890 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
892 /* Bits for csp->content_type bitmask: */
893 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
894 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
895 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
896 #define CT_JPEG 0x0008U /**< Suitable for JPEG filtering. */
898 /* Although these are not, strictly speaking, content types
899 * (they are content encodings), it is simple to handle them
902 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
903 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
906 * The mask which includes all actions.
908 #define ACTION_MASK_ALL (~0UL)
911 * The most compatible set of actions - i.e. none.
913 #define ACTION_MOST_COMPATIBLE 0x00000000UL
915 /** Action bitmap: Block the request. */
916 #define ACTION_BLOCK 0x00000001UL
917 /** Action bitmap: Deanimate if it's a GIF. */
918 #define ACTION_DEANIMATE 0x00000002UL
919 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
920 #define ACTION_DOWNGRADE 0x00000004UL
921 /** Action bitmap: Fast redirects. */
922 #define ACTION_FAST_REDIRECTS 0x00000008UL
923 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
924 #define ACTION_HIDE_FORWARDED 0x00000010UL
925 /** Action bitmap: Hide "From" header. */
926 #define ACTION_HIDE_FROM 0x00000020UL
927 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
928 #define ACTION_HIDE_REFERER 0x00000040UL
929 /** Action bitmap: Hide "User-Agent" and similar headers. */
930 #define ACTION_HIDE_USER_AGENT 0x00000080UL
931 /** Action bitmap: This is an image. */
932 #define ACTION_IMAGE 0x00000100UL
933 /** Action bitmap: Sets the image blocker. */
934 #define ACTION_IMAGE_BLOCKER 0x00000200UL
935 /** Action bitmap: Prevent compression. */
936 #define ACTION_NO_COMPRESSION 0x00000400UL
937 /** Action bitmap: Change cookies to session only cookies. */
938 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
939 /** Action bitmap: Block rending cookies. */
940 #define ACTION_NO_COOKIE_READ 0x00001000UL
941 /** Action bitmap: Block setting cookies. */
942 #define ACTION_NO_COOKIE_SET 0x00002000UL
943 /** Action bitmap: Filter out popups. */
944 #define ACTION_NO_POPUPS 0x00004000UL
945 /** Action bitmap: Send a vanilla wafer. */
946 #define ACTION_VANILLA_WAFER 0x00008000UL
947 /** Action bitmap: Limit CONNECT requests to safe ports. */
948 #define ACTION_LIMIT_CONNECT 0x00010000UL
949 /** Action bitmap: Inspect if it's a JPEG. */
950 #define ACTION_JPEG_INSPECT 0x00020000UL
951 /** Action bitmap: Crunch or modify "if-modified-since" header. */
952 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
953 /** Action bitmap: Overwrite Content-Type header. */
954 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
955 /** Action bitmap: Crunch specified server header. */
956 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
957 /** Action bitmap: Crunch specified client header */
958 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
959 /** Action bitmap: Enable text mode by force */
960 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
961 /** Action bitmap: Enable text mode by force */
962 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
963 /** Action bitmap: Enable content-dispostion crunching */
964 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
965 /** Action bitmap: Replace or block Last-Modified header */
966 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
967 /** Action bitmap: Replace or block Accept-Language header */
968 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
969 /** Action bitmap: Block as empty document */
970 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x08000000UL
971 /** Action bitmap: Redirect request. */
972 #define ACTION_REDIRECT 0x10000000UL
973 /** Action bitmap: Answer blocked Connects verbosely */
974 #define ACTION_TREAT_FORBIDDEN_CONNECTS_LIKE_BLOCKS 0x20000000UL
975 /** Action bitmap: Filter server headers with pcre */
976 #define ACTION_FILTER_SERVER_HEADERS 0x40000000UL
977 /** Action bitmap: Filter client headers with pcre */
978 #define ACTION_FILTER_CLIENT_HEADERS 0x80000000UL
981 /** Action string index: How to deanimate GIFs */
982 #define ACTION_STRING_DEANIMATE 0
983 /** Action string index: Replacement for "From:" header */
984 #define ACTION_STRING_FROM 1
985 /** Action string index: How to block images */
986 #define ACTION_STRING_IMAGE_BLOCKER 2
987 /** Action string index: Replacement for "Referer:" header */
988 #define ACTION_STRING_REFERER 3
989 /** Action string index: Replacement for "User-Agent:" header */
990 #define ACTION_STRING_USER_AGENT 4
991 /** Action string index: Legal CONNECT ports. */
992 #define ACTION_STRING_LIMIT_CONNECT 5
993 /** Action string index: Server headers containing this pattern are crunched*/
994 #define ACTION_STRING_SERVER_HEADER 6
995 /** Action string index: Client headers containing this pattern are crunched*/
996 #define ACTION_STRING_CLIENT_HEADER 7
997 /** Action string index: Replacement for the "Accept-Language:" header*/
998 #define ACTION_STRING_LANGUAGE 8
999 /** Action string index: Replacement for the "Content-Type:" header*/
1000 #define ACTION_STRING_CONTENT_TYPE 9
1001 /** Action string index: Replacement for the "content-dispostion:" header*/
1002 #define ACTION_STRING_CONTENT_DISPOSITION 10
1003 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1004 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1005 /** Action string index: Replacement for the "Last-Modified:" header. */
1006 #define ACTION_STRING_LAST_MODIFIED 12
1007 /** Action string index: Redirect URL */
1008 #define ACTION_STRING_REDIRECT 13
1009 /** Action string index: Decode before redirect? */
1010 #define ACTION_STRING_FAST_REDIRECTS 14
1011 /** Number of string actions. */
1012 #define ACTION_STRING_COUNT 15
1015 /*To make the ugly hack in sed easier to understand*/
1016 #define CHECK_EVERY_HEADER_REMAINING 0
1019 /** Index into current_action_spec::multi[] for headers to add. */
1020 #define ACTION_MULTI_ADD_HEADER 0
1021 /** Index into current_action_spec::multi[] for headers to add. */
1022 #define ACTION_MULTI_WAFER 1
1023 /** Index into current_action_spec::multi[] for filters to apply. */
1024 #define ACTION_MULTI_FILTER 2
1025 /** Number of multi-string actions. */
1026 #define ACTION_MULTI_COUNT 3
1030 * This structure contains a list of actions to apply to a URL.
1031 * It only contains positive instructions - no "-" options.
1032 * It is not used to store the actions list itself, only for
1033 * url_actions() to return the current values.
1035 struct current_action_spec
1037 /** Actions to apply. A bit set to "1" means perform the action. */
1038 unsigned long flags;
1041 * Paramaters for those actions that require them.
1042 * Each entry is valid if & only if the corresponding entry in "flags" is
1045 char * string[ACTION_STRING_COUNT];
1047 /** Lists of strings for multi-string actions. */
1048 struct list multi[ACTION_MULTI_COUNT][1];
1053 * This structure contains a set of changes to actions.
1054 * It can contain both positive and negative instructions.
1055 * It is used to store an entry in the actions list.
1059 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1060 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1063 * Paramaters for those actions that require them.
1064 * Each entry is valid if & only if the corresponding entry in "flags" is
1067 char * string[ACTION_STRING_COUNT];
1069 /** Lists of strings to remove, for multi-string actions. */
1070 struct list multi_remove[ACTION_MULTI_COUNT][1];
1072 /** If nonzero, remove *all* strings from the multi-string action. */
1073 int multi_remove_all[ACTION_MULTI_COUNT];
1075 /** Lists of strings to add, for multi-string actions. */
1076 struct list multi_add[ACTION_MULTI_COUNT][1];
1081 * This structure is used to store the actions list.
1083 * It contains a URL pattern, and the chages to the actions.
1084 * It is a linked list.
1088 struct url_spec url[1]; /**< URL pattern. */
1090 struct action_spec action[1]; /**< Actions. */
1092 struct url_actions * next; /**< Next action in file, or NULL. */
1097 * Flags for use in csp->flags
1101 * Flag for csp->flags: Set if this client is processing data.
1102 * Cleared when the thread associated with this structure dies.
1104 #define CSP_FLAG_ACTIVE 0x01
1107 * Flag for csp->flags: Set if the server's reply is in "chunked"
1110 #define CSP_FLAG_CHUNKED 0x02
1113 * Flag for csp->flags: Set if this request was enforced, although it would
1114 * normally have been blocked.
1116 #define CSP_FLAG_FORCED 0x04
1119 * Flag for csp->flags: Set if any modification to the body was done.
1121 #define CSP_FLAG_MODIFIED 0x08
1124 * Flag for csp->flags: Set if request was blocked.
1126 #define CSP_FLAG_REJECTED 0x10
1129 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1131 #define CSP_FLAG_TOGGLED_ON 0x20
1135 * Flags for use in return codes of child processes
1139 * Flag for process return code: Set if exiting porcess has been toggled
1140 * during its lifetime.
1142 #define RC_FLAG_TOGGLED 0x10
1145 * Flag for process return code: Set if exiting porcess has blocked its
1148 #define RC_FLAG_BLOCKED 0x20
1151 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1154 #define MAX_AF_FILES 10
1157 * The state of a Privoxy processing thread.
1161 /** The proxy's configuration */
1162 struct configuration_spec * config;
1164 /** The actions to perform on the current request */
1165 struct current_action_spec action[1];
1167 /** socket to talk to client (web browser) */
1170 /** socket to talk to server (web server or proxy) */
1173 /** Multi-purpose flag container, see CSP_FLAG_* above */
1176 /** Client PC's IP address, as reported by the accept() function.
1179 /** Client PC's IP address, as reported by the accept() function.
1183 /** Our IP address. I.e. the IP address that the client used to reach us,
1185 char *my_ip_addr_str;
1187 /** Our hostname. I.e. the reverse DNS of the IP address that the client
1188 used to reach us, as a string. */
1191 /** The URL that was requested */
1192 struct http_request http[1];
1194 /** An I/O buffer used for buffering data read from the network */
1197 /** List of all headers for this request */
1198 struct list headers[1];
1200 /** List of all cookies for this request */
1201 struct list cookie_list[1];
1203 /** MIME-Type key, see CT_* above */
1204 unsigned int content_type;
1206 /** The "X-Forwarded-For:" header sent by the client */
1209 /** Actions files associated with this client */
1210 struct file_list *actions_list[MAX_AF_FILES];
1212 /** pcrs job files. */
1213 struct file_list *rlist[MAX_AF_FILES];
1215 /** Length after content modification. */
1216 size_t content_length;
1218 #ifdef FEATURE_TRUST
1221 struct file_list *tlist;
1223 #endif /* def FEATURE_TRUST */
1225 /** Next thread in linked list. Only read or modify from the main thread! */
1226 struct client_state *next;
1231 * A function to add a header
1233 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1236 * A function to process a header
1238 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1242 * List of functions to run on a list of headers
1246 /** The header prefix to match */
1249 /** The length of the prefix to match */
1252 /** The function to apply to this line */
1253 parser_func_ptr parser;
1258 * List of available CGI functions.
1260 struct cgi_dispatcher
1262 /** The URL of the CGI, relative to the CGI root. */
1263 const char * const name;
1265 /** The handler function for the CGI */
1266 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1268 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1269 const char * const description;
1271 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1277 * A data file used by Privoxy. Kept in a linked list.
1282 * This is a pointer to the data structures associated with the file.
1283 * Read-only once the structure has been created.
1288 * The unloader function.
1289 * Normally NULL. When we are finished with file (i.e. when we have
1290 * loaded a new one), set to a pointer to an unloader function.
1291 * Unloader will be called by sweep() (called from main loop) when
1292 * all clients using this file are done. This prevents threading
1295 void (*unloader)(void *);
1298 * Used internally by sweep(). Do not access from elsewhere.
1303 * File last-modified time, so we can check if file has been changed.
1304 * Read-only once the structure has been created.
1306 time_t lastmodified;
1309 * The full filename.
1314 * Pointer to next entry in the linked list of all "file_list"s.
1315 * This linked list is so that sweep() can navigate it.
1316 * Since sweep() can remove items from the list, we must be careful
1317 * to only access this value from main thread (when we know sweep
1318 * won't be running).
1320 struct file_list *next;
1324 #ifdef FEATURE_TRUST
1327 * The format of a trust file when loaded into memory.
1331 struct url_spec url[1]; /**< The URL pattern */
1332 int reject; /**< FIXME: Please document this! */
1333 struct block_spec *next; /**< Next entry in linked list */
1337 * Arbitrary limit for the number of trusted referrers.
1339 #define MAX_TRUSTED_REFERRERS 512
1341 #endif /* def FEATURE_TRUST */
1344 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1345 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1346 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1350 * How to forward a connection to a parent proxy.
1354 /** URL pattern that this forward_spec is for. */
1355 struct url_spec url[1];
1357 /** Connection type. Must be SOCKS_NONE, SOCKS_4, or SOCKS_4A. */
1360 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1363 /** SOCKS server port. */
1366 /** Parent HTTP proxy hostname, or NULL for none. */
1369 /** Parent HTTP proxy port. */
1372 /** Next entry in the linked list. */
1373 struct forward_spec *next;
1378 * Initializer for a static struct forward_spec.
1380 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1384 * This struct represents one filter (one block) from
1385 * the re_filterfile. If there is more than one filter
1386 * in the file, the file will be represented by a
1387 * chained list of re_filterfile specs.
1389 struct re_filterfile_spec
1391 char *name; /**< Name from FILTER: statement in re_filterfile. */
1392 char *description; /**< Description from FILTER: statement in re_filterfile. */
1393 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1394 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1395 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1401 #define ACL_PERMIT 1 /**< Accept connection request */
1402 #define ACL_DENY 2 /**< Reject connection request */
1405 * An IP address pattern. Used to specify networks in the ACL.
1407 struct access_control_addr
1409 unsigned long addr; /**< The IP address as an integer. */
1410 unsigned long mask; /**< The network mask as an integer. */
1411 unsigned long port; /**< The port number. */
1415 * An access control list (ACL) entry.
1417 * This is a linked list.
1419 struct access_control_list
1421 struct access_control_addr src[1]; /**< Client IP address */
1422 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1424 short action; /**< ACL_PERMIT or ACL_DENY */
1425 struct access_control_list *next; /**< The next entry in the ACL. */
1428 #endif /* def FEATURE_ACL */
1431 /** Maximum number of loaders (actions, re_filter, ...) */
1435 /** configuration_spec::feature_flags: CGI actions editor. */
1436 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1438 /** configuration_spec::feature_flags: Web-based toggle. */
1439 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1441 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1442 #define RUNTIME_FEATURE_HTTP_TOGGLE 4
1444 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1445 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8
1447 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1448 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16
1452 * Data loaded from the configuration file.
1454 * (Anomaly: toggle is still handled through a global, not this structure)
1456 struct configuration_spec
1461 /** Nonzero to enable multithreading. */
1465 * Bitmask of features that can be enabled/disabled through the config
1466 * file. Currently defined bits:
1468 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1469 * - RUNTIME_FEATURE_CGI_TOGGLE
1470 * - RUNTIME_FEATURE_HTTP_TOGGLE
1471 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1473 unsigned feature_flags;
1475 /** The log file name. */
1476 const char *logfile;
1478 /** The config file directory. */
1479 const char *confdir;
1481 /** The log file directory. */
1484 /** The full paths to the actions files. */
1485 const char *actions_file[MAX_AF_FILES];
1487 /** The short names of the actions files. */
1488 const char *actions_file_short[MAX_AF_FILES];
1490 /** The administrator's email address */
1491 char *admin_address;
1493 /** A URL with info on this proxy */
1494 char *proxy_info_url;
1496 /** URL to the user manual (on our website or local copy) */
1499 /** The file names of the pcre filter files. */
1500 const char *re_filterfile[MAX_AF_FILES];
1502 /** The short names of the pcre filter files. */
1503 const char *re_filterfile_short[MAX_AF_FILES];
1505 #ifdef FEATURE_COOKIE_JAR
1507 /** The file name of the cookie jar file */
1508 const char * jarfile;
1510 /** The handle to the cookie jar file */
1513 #endif /* def FEATURE_COOKIE_JAR */
1515 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1518 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1521 /** Size limit for IOB */
1522 size_t buffer_limit;
1524 #ifdef FEATURE_TRUST
1526 /** The file name of the trust file. */
1527 const char * trustfile;
1529 /** FIXME: DOCME: Document this. */
1530 struct list trust_info[1];
1532 /** FIXME: DOCME: Document this. */
1533 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1535 #endif /* def FEATURE_TRUST */
1539 /** The access control list (ACL). */
1540 struct access_control_list *acl;
1542 #endif /* def FEATURE_ACL */
1544 /** Information about parent proxies (forwarding). */
1545 struct forward_spec *forward;
1547 /** Number of retries in case a forwarded connection attempt fails */
1548 int forwarded_connect_retries;
1550 /** All options from the config file, HTML-formatted. */
1553 /** The configuration file object. */
1554 struct file_list *config_file_list;
1556 /** List of loaders */
1557 int (*loaders[NLOADERS])(struct client_state *);
1559 /** Nonzero if we need to bind() to the new port. */
1563 /** Calculates the number of elements in an array, using sizeof. */
1564 #define SZ(X) (sizeof(X) / sizeof(*X))
1566 #ifdef FEATURE_FORCE_LOAD
1567 /** The force load URL prefix. */
1568 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1569 #endif /* def FEATURE_FORCE_LOAD */
1571 #ifdef FEATURE_NO_GIFS
1572 /** The MIME type for images ("image/png" or "image/gif"). */
1573 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1575 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1576 #endif /* def FEATURE_NO_GIFS */
1583 /** URL for the Privoxy home page. */
1584 #define HOME_PAGE_URL "http://www.privoxy.org/"
1586 /** URL for the Privoxy user manual. */
1587 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1589 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1590 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1592 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1593 #define CONFIG_HELP_PREFIX "config.html#"
1596 * The "hosts" to intercept and display CGI pages.
1597 * First one is a hostname only, second one can specify host and path.
1600 * 1) Do not specify the http: prefix
1601 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1602 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1604 #define CGI_SITE_1_HOST "p.p"
1605 #define CGI_SITE_2_HOST "config.privoxy.org"
1606 #define CGI_SITE_2_PATH ""
1609 * The prefix for CGI pages. Written out in generated HTML.
1610 * INCLUDES the trailing slash.
1612 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1618 #endif /* ndef PROJECT_H_INCLUDED */