1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.87 2007/01/01 19:36: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 - 2007 the SourceForge
14 * Privoxy team. http://www.privoxy.org/
16 * Based on the Internet Junkbuster originally written
17 * by and Copyright (C) 1997 Anonymous Coders and
18 * Junkbusters Corporation. http://www.junkbusters.com
20 * This program is free software; you can redistribute it
21 * and/or modify it under the terms of the GNU General
22 * Public License as published by the Free Software
23 * Foundation; either version 2 of the License, or (at
24 * your option) any later version.
26 * This program is distributed in the hope that it will
27 * be useful, but WITHOUT ANY WARRANTY; without even the
28 * implied warranty of MERCHANTABILITY or FITNESS FOR A
29 * PARTICULAR PURPOSE. See the GNU General Public
30 * License for more details.
32 * The GNU General Public License should be included with
33 * this file. If not, you can view it at
34 * http://www.gnu.org/copyleft/gpl.html
35 * or write to the Free Software Foundation, Inc., 59
36 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
40 * Revision 1.87 2007/01/01 19:36:37 fabiankeil
41 * Integrate a modified version of Wil Mahan's
42 * zlib patch (PR #895531).
44 * Revision 1.86 2006/12/31 17:56:37 fabiankeil
45 * Added config option accept-intercepted-requests
46 * and disabled it by default.
48 * Revision 1.85 2006/12/31 15:03:31 fabiankeil
49 * Fix gcc43 compiler warnings and a comment.
51 * Revision 1.84 2006/12/21 12:57:48 fabiankeil
52 * Add config option "split-large-forms"
53 * to work around the browser bug reported
56 * Revision 1.83 2006/12/06 19:26:29 fabiankeil
57 * Moved HTTP snipplets into jcc.c. They aren't
60 * Revision 1.82 2006/09/20 15:50:31 fabiankeil
61 * Doubled size of HOSTENT_BUFFER_SIZE to mask
62 * problems with gethostbyname_r and some
63 * /etc/hosts configurations. Only a workaround
64 * until we get the real fix ready.
65 * Thanks FĂ©lix Rauch for reporting.
67 * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
69 * Revision 1.81 2006/09/06 13:03:04 fabiankeil
70 * Respond with 400 and a short text message
71 * if the client tries to use Privoxy as FTP proxy.
73 * Revision 1.80 2006/09/06 10:43:32 fabiankeil
74 * Added config option enable-remote-http-toggle
75 * to specify if Privoxy should recognize special
76 * headers (currently only X-Filter) to change its
77 * behaviour. Disabled by default.
79 * Revision 1.79 2006/09/06 09:23:37 fabiankeil
80 * Make number of retries in case of forwarded-connect problems
81 * a config file option (forwarded-connect-retries) and use 0 as
84 * Revision 1.78 2006/08/31 16:25:06 fabiankeil
85 * Work around a buffer overflow that caused Privoxy to
86 * segfault if too many trusted referrers were used. Good
87 * enough for now, but should be replaced with a real
88 * solution after the next release.
90 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
93 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
94 * Split filter-headers{} into filter-client-headers{}
95 * and filter-server-headers{}.
96 * Added parse_header_time() to share some code.
97 * Replaced timegm() with mktime().
99 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
100 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
102 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
103 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
104 * with what was really the latest development (the v_3_0_branch branch)
106 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
107 * Multiple filter file support
109 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
110 * Add the ability to check jpeg images for invalid
111 * lengths of comment blocks. Defensive strategy
112 * against the exploit:
113 * Microsoft Security Bulletin MS04-028
114 * Buffer Overrun in JPEG Processing (GDI+) Could
115 * Allow Code Execution (833987)
116 * Enabled with +inspect-jpegs in actions files.
118 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
119 * Updated the copyright note
121 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
122 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
124 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
125 * Introduced RC_FLAG_* flags for use in child process return code
127 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
128 * Added flag to each cgi_dispatcher that allows or denies
129 * external linking and removed const qualifier from
130 * struct list_entry.str.
132 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
133 * - Include config.h for access to config data
134 * - Include <pcre*.h> depending on where they are
136 * Revision 1.72 2002/05/14 21:35:49 oes
137 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
138 * because of split in user-manual
140 * Revision 1.71 2002/05/12 21:39:36 jongfoster
141 * - Adding Doxygen-style comments to structures and #defines.
143 * Revision 1.70 2002/05/12 16:05:50 jongfoster
144 * Fixing ACTION_MASK_ALL to be unsigned long rather than
145 * just unsigned int. I don't know if anyone is porting
146 * Privoxy to 16-bit platforms, but if so, +limit-connect
147 * wouldn't have worked because of this bug.
149 * Revision 1.69 2002/05/08 16:00:16 oes
150 * Added size member to struct iob, so it can
151 * be alloced larger than needed.
153 * Revision 1.68 2002/04/26 12:56:00 oes
154 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
156 * Revision 1.67 2002/04/24 02:12:43 oes
157 * - Jon's multiple AF patch:
158 * - Make csp->actions_list an array
159 * - #define MAX_AF_FILES
160 * - Moved CGI_PARAM_LEN_MAX (500) here
162 * Revision 1.66 2002/04/15 19:06:43 jongfoster
165 * Revision 1.65 2002/04/04 00:36:36 gliptak
166 * always use pcre for matching
168 * Revision 1.64 2002/04/03 22:28:03 gliptak
169 * Removed references to gnu_regex
171 * Revision 1.63 2002/03/31 17:19:00 jongfoster
172 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
174 * Revision 1.62 2002/03/26 22:48:49 swa
177 * Revision 1.61 2002/03/26 22:29:55 swa
178 * we have a new homepage!
180 * Revision 1.60 2002/03/24 15:52:17 jongfoster
181 * Changing CGI URL prefixes for new name
183 * Revision 1.59 2002/03/24 15:23:33 jongfoster
186 * Revision 1.58 2002/03/24 13:25:43 swa
187 * name change related issues
189 * Revision 1.57 2002/03/16 20:28:34 oes
190 * Added descriptions to the filters so users will know what they select in the cgi editor
192 * Revision 1.56 2002/03/13 20:27:30 oes
193 * Fixing bug with CT_TABOO
195 * Revision 1.55 2002/03/12 01:42:50 oes
196 * Introduced modular filters
198 * Revision 1.54 2002/03/09 20:03:52 jongfoster
199 * - Making various functions return int rather than size_t.
200 * (Undoing a recent change). Since size_t is unsigned on
201 * Windows, functions like read_socket that return -1 on
202 * error cannot return a size_t.
204 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
205 * crashes, and also frequently caused JB to jump to 100%
206 * CPU and stay there. (Because it thought it had just
207 * read ((unsigned)-1) == 4Gb of data...)
209 * - The signature of write_socket has changed, it now simply
210 * returns success=0/failure=nonzero.
212 * - Trying to get rid of a few warnings --with-debug on
213 * Windows, I've introduced a new type "jb_socket". This is
214 * used for the socket file descriptors. On Windows, this
215 * is SOCKET (a typedef for unsigned). Everywhere else, it's
216 * an int. The error value can't be -1 any more, so it's
217 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
218 * Windows it maps to the #define INVALID_SOCKET.)
220 * - The signature of bind_port has changed.
222 * Revision 1.53 2002/03/08 16:48:55 oes
223 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
225 * Revision 1.52 2002/03/07 03:46:17 oes
226 * Fixed compiler warnings
228 * Revision 1.51 2002/03/05 04:52:42 oes
229 * Deleted non-errlog debugging code
231 * Revision 1.50 2002/03/04 19:32:07 oes
232 * Changed default port to 8118
234 * Revision 1.49 2002/03/04 18:28:55 oes
235 * Deleted PID_FILE_NAME
237 * Revision 1.48 2002/03/03 14:50:40 oes
238 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
240 * Revision 1.47 2002/02/20 23:15:13 jongfoster
241 * Parsing functions now handle out-of-memory gracefully by returning
244 * Revision 1.46 2002/01/17 21:06:09 jongfoster
245 * Now #defining the URLs of the config interface
247 * Minor changes to struct http_request and struct url_spec due to
248 * standardizing that struct http_request is used to represent a URL, and
249 * struct url_spec is used to represent a URL pattern. (Before, URLs were
250 * represented as seperate variables and a partially-filled-in url_spec).
252 * Revision 1.45 2002/01/09 14:33:27 oes
253 * Added HOSTENT_BUFFER_SIZE
255 * Revision 1.44 2001/12/30 14:07:32 steudten
256 * - Add signal handling (unix)
257 * - Add SIGHUP handler (unix)
258 * - Add creation of pidfile (unix)
259 * - Add action 'top' in rc file (RH)
260 * - Add entry 'SIGNALS' to manpage
261 * - Add exit message to logfile (unix)
263 * Revision 1.43 2001/11/22 21:57:51 jongfoster
264 * Making action_spec->flags into an unsigned long rather than just an
266 * Adding ACTION_NO_COOKIE_KEEP
268 * Revision 1.42 2001/11/05 21:42:41 steudten
269 * Include DBG() macro.
271 * Revision 1.41 2001/10/28 19:12:06 jongfoster
272 * Adding ijb_toupper()
274 * Revision 1.40 2001/10/26 17:40:47 oes
275 * Moved ijb_isspace and ijb_tolower to project.h
276 * Removed http->user_agent, csp->referrer and csp->accept_types
278 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
279 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
280 * macro when called with a cast; so moving the cast to the macro def'n
281 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
282 * doesn't make macro expansion complain. Hope this works for everyone else
285 * Revision 1.38 2001/10/23 21:19:04 jongfoster
286 * New error-handling support: jb_err type and JB_ERR_xxx constants
287 * CGI functions now return a jb_err, and their parameters map is const.
288 * Support for RUNTIME_FEATUREs to enable/disable config editor
289 * Adding a few comments
291 * Revision 1.37 2001/10/14 22:14:01 jongfoster
292 * Removing name_length field from struct cgi_dispatcher, as this is
293 * now calculated at runtime from the "name" field.
295 * Revision 1.36 2001/10/10 16:45:15 oes
296 * Added LIMIT_CONNECT action and string
297 * Fixed HTTP message line termination
298 * Added CFORBIDDEN HTTP message
300 * Revision 1.35 2001/10/07 18:06:43 oes
301 * Added status member to struct http_request
303 * Revision 1.34 2001/10/07 15:45:25 oes
304 * Added url member to struct http_request and commented all
309 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
311 * Replaced struct client_state members rejected,
312 * force, active and toggled_on with "flags" bitmap.
314 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
316 * Added buffer_limit to struct configuration_spec
318 * Revision 1.33 2001/09/20 13:30:08 steudten
320 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
321 * Last case will set z to NULL in free(z) and thats bad..
323 * Revision 1.32 2001/09/16 23:02:51 jongfoster
326 * Revision 1.31 2001/09/16 13:20:29 jongfoster
327 * Rewrite of list library. Now has seperate header and list_entry
328 * structures. Also added a large sprinking of assert()s to the list
331 * Revision 1.30 2001/09/13 23:52:00 jongfoster
332 * Support for both static and dynamically generated CGI pages
334 * Revision 1.29 2001/09/13 23:29:43 jongfoster
335 * Defining FORWARD_SPEC_INITIALIZER
337 * Revision 1.28 2001/09/13 23:05:50 jongfoster
338 * Changing the string paramater to the header parsers a "const".
340 * Revision 1.27 2001/08/05 16:06:20 jongfoster
341 * Modifiying "struct map" so that there are now separate header and
342 * "map_entry" structures. This means that functions which modify a
343 * map no longer need to return a pointer to the modified map.
344 * Also, it no longer reverses the order of the entries (which may be
345 * important with some advanced template substitutions).
347 * Revision 1.26 2001/07/30 22:08:36 jongfoster
348 * Tidying up #defines:
349 * - All feature #defines are now of the form FEATURE_xxx
350 * - Permanently turned off WIN_GUI_EDIT
351 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
353 * Revision 1.25 2001/07/29 18:43:08 jongfoster
354 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
357 * Revision 1.24 2001/07/25 17:20:27 oes
358 * Introduced http->user_agent
360 * Revision 1.23 2001/07/18 12:32:23 oes
361 * - Added ACTION_STRING_DEANIMATE
362 * - moved #define freez from jcc.h to project.h
364 * Revision 1.22 2001/07/15 17:51:41 jongfoster
365 * Renaming #define STATIC to STATIC_PCRE
367 * Revision 1.21 2001/07/13 14:03:19 oes
368 * - Reorganized regex header inclusion and #defines to
369 * comply to the scheme in configure.in
370 * - Added csp->content_type and its CT_* keys
371 * - Added ACTION_DEANIMATE
372 * - Removed all #ifdef PCRS
374 * Revision 1.20 2001/06/29 21:45:41 oes
375 * Indentation, CRLF->LF, Tab-> Space
377 * Revision 1.19 2001/06/29 13:33:36 oes
378 * - Improved comments
379 * - Introduced http_request.host_ip_addr_str
380 * - Introduced http_response.head_length
381 * - Introduced config.my_ip_addr_str, config.my_hostname,
382 * config.admin_address and config.proxy_info_url
383 * - Removed config.proxy_args_header and config.proxy_args_trailer,
384 * renamed config.proxy_args_invocation to config.proxy_args
385 * - Removed HTML snipplets and GIFs
386 * - Removed logentry from cancelled commit
388 * Revision 1.18 2001/06/09 10:57:39 jongfoster
389 * Adding definition of BUFFER_SIZE.
390 * Changing struct cgi_dispatcher to use "const" strings.
392 * Revision 1.17 2001/06/07 23:15:09 jongfoster
393 * Merging ACL and forward files into config file.
394 * Moving struct gateway members into struct forward_spec
395 * Removing config->proxy_args_gateways
396 * Cosmetic: Adding a few comments
398 * Revision 1.16 2001/06/04 18:31:58 swa
399 * files are now prefixed with either `confdir' or `logdir'.
400 * `make redhat-dist' replaces both entries confdir and logdir
403 * Revision 1.15 2001/06/04 11:28:53 swa
404 * redirect did not work due to missing /
406 * Revision 1.14 2001/06/03 11:03:48 oes
408 * added struct http_response,
409 * changed struct interceptors to struct cgi_dispatcher,
410 * moved HTML stuff to cgi.h
412 * Revision 1.13 2001/06/01 20:05:36 jongfoster
413 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
414 * constant, and removed csp->tinygif.
416 * Revision 1.12 2001/06/01 18:49:17 jongfoster
417 * Replaced "list_share" with "list" - the tiny memory gain was not
418 * worth the extra complexity.
420 * Revision 1.11 2001/06/01 10:32:47 oes
421 * Added constants for anchoring selection bitmap
423 * Revision 1.10 2001/05/31 21:33:53 jongfoster
424 * Changes for new actions file, replacing permissionsfile
425 * and parts of the config file. Also added support for
428 * Revision 1.9 2001/05/31 17:32:31 oes
430 * - Enhanced domain part globbing with infix and prefix asterisk
431 * matching and optional unanchored operation
433 * Revision 1.8 2001/05/29 20:09:15 joergs
434 * HTTP_REDIRECT_TEMPLATE fixed.
436 * Revision 1.7 2001/05/29 09:50:24 jongfoster
437 * Unified blocklist/imagelist/actionslist.
438 * File format is still under discussion, but the internal changes
441 * Also modified interceptor behaviour:
442 * - We now intercept all URLs beginning with one of the following
443 * prefixes (and *only* these prefixes):
445 * * http://ijbswa.sf.net/config/
446 * * http://ijbswa.sourceforge.net/config/
447 * - New interceptors "home page" - go to http://i.j.b/ to see it.
448 * - Internal changes so that intercepted and fast redirect pages
449 * are not replaced with an image.
450 * - Interceptors now have the option to send a binary page direct
451 * to the client. (i.e. ijb-send-banner uses this)
452 * - Implemented show-url-info interceptor. (Which is why I needed
453 * the above interceptors changes - a typical URL is
454 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
455 * The previous mechanism would not have intercepted that, and
456 * if it had been intercepted then it then it would have replaced
459 * Revision 1.6 2001/05/27 22:17:04 oes
461 * - re_process_buffer no longer writes the modified buffer
462 * to the client, which was very ugly. It now returns the
463 * buffer, which it is then written by chat.
465 * - content_length now adjusts the Content-Length: header
466 * for modified documents rather than crunch()ing it.
467 * (Length info in csp->content_length, which is 0 for
468 * unmodified documents)
470 * - For this to work, sed() is called twice when filtering.
472 * Revision 1.5 2001/05/26 00:28:36 jongfoster
473 * Automatic reloading of config file.
474 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
475 * Most of the global variables have been moved to a new
476 * struct configuration_spec, accessed through csp->config->globalname
477 * Most of the globals remaining are used by the Win32 GUI.
479 * Revision 1.4 2001/05/22 18:46:04 oes
481 * - Enabled filtering banners by size rather than URL
482 * by adding patterns that replace all standard banner
483 * sizes with the "Junkbuster" gif to the re_filterfile
485 * - Enabled filtering WebBugs by providing a pattern
486 * which kills all 1x1 images
488 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
489 * which is selected by the (nonstandard and therefore
490 * capital) letter 'U' in the option string.
491 * It causes the quantifiers to be ungreedy by default.
492 * Appending a ? turns back to greedy (!).
494 * - Added a new interceptor ijb-send-banner, which
495 * sends back the "Junkbuster" gif. Without imagelist or
496 * MSIE detection support, or if tinygif = 1, or the
497 * URL isn't recognized as an imageurl, a lame HTML
498 * explanation is sent instead.
500 * - Added new feature, which permits blocking remote
501 * script redirects and firing back a local redirect
503 * The feature is conditionally compiled, i.e. it
504 * can be disabled with --disable-fast-redirects,
505 * plus it must be activated by a "fast-redirects"
506 * line in the config file, has its own log level
507 * and of course wants to be displayed by show-proxy-args
508 * Note: Boy, all the #ifdefs in 1001 locations and
509 * all the fumbling with configure.in and acconfig.h
510 * were *way* more work than the feature itself :-(
512 * - Because a generic redirect template was needed for
513 * this, tinygif = 3 now uses the same.
515 * - Moved GIFs, and other static HTTP response templates
520 * - Removed some >400 CRs again (Jon, you really worked
523 * Revision 1.3 2001/05/20 01:21:20 jongfoster
524 * Version 2.9.4 checkin.
525 * - Merged popupfile and cookiefile, and added control over PCRS
526 * filtering, in new "actionsfile".
527 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
528 * file error you now get a message box (in the Win32 GUI) rather
529 * than the program exiting with no explanation.
530 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
532 * - Removed tabs from "config"
533 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
534 * - Bumped up version number.
536 * Revision 1.2 2001/05/17 23:01:01 oes
537 * - Cleaned CRLF's from the sources and related files
539 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
540 * Initial import of version 2.9.3 source tree
543 *********************************************************************/
546 /* Declare struct FILE for vars and funcs. */
549 /* Need time_t for file_list */
551 /* Needed for pcre choice */
555 * Include appropriate regular expression libraries.
556 * Note that pcrs and pcre (native) are needed for cgi
557 * and are included anyway.
563 # ifdef PCRE_H_IN_SUBDIR
564 # include <pcre/pcre.h>
577 # include "pcreposix.h"
579 # ifdef PCRE_H_IN_SUBDIR
580 # include <pcre/pcreposix.h>
582 # include <pcreposix.h>
588 #endif /* def AMIGA */
592 * I don't want to have to #include all this just for the declaration
593 * of SOCKET. However, it looks like we have to...
608 typedef SOCKET jb_socket;
610 #define JB_INVALID_SOCKET INVALID_SOCKET
612 #else /* ndef _WIN32 */
615 * The type used by sockets. On UNIX it's an int. Microsoft decided to
616 * make it an unsigned.
618 typedef int jb_socket;
621 * The error value used for variables of type jb_socket. On UNIX this
622 * is -1, however Microsoft decided to make socket handles unsigned, so
623 * they use a different value.
626 #define JB_INVALID_SOCKET (-1)
628 #endif /* ndef _WIN32 */
632 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
637 #define JB_ERR_OK 0 /**< Success, no error */
638 #define JB_ERR_MEMORY 1 /**< Out of memory */
639 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
640 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
641 #define JB_ERR_PARSE 4 /**< Error parsing file */
642 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
643 CGI actions editor. */
644 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
647 * This macro is used to free a pointer that may be NULL.
648 * It also sets the variable to NULL after it's been freed.
649 * The paramater should be a simple variable without side effects.
651 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
655 * Fix a problem with Solaris. There should be no effect on other
658 * Solaris's isspace() is a macro which uses it's argument directly
659 * as an array index. Therefore we need to make sure that high-bit
660 * characters generate +ve values, and ideally we also want to make
661 * the argument match the declared parameter type of "int".
663 * Note: Remember to #include <ctype.h> if you use these macros.
665 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
666 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
667 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
670 * Use for statically allocated buffers if you have no other choice.
671 * Remember to check the length of what you write into the buffer
672 * - we don't want any buffer overflows!
674 #define BUFFER_SIZE 5000
677 * Max length of CGI parameters (arbitrary limit).
679 #define CGI_PARAM_LEN_MAX 500
682 * Buffer size for capturing struct hostent data in the
683 * gethostby(name|addr)_r library calls. Since we don't
684 * loop over gethostbyname_r, the buffer must be sufficient
685 * to accomodate multiple IN A RRs, as used in DNS round robin
686 * load balancing. W3C's wwwlib uses 1K, so that should be
687 * good enough for us, too.
690 * XXX: Temporary doubled, for some configurations
691 * 1K is still too small and we didn't get the
692 * real fix ready for inclusion.
694 #define HOSTENT_BUFFER_SIZE 2048
697 * Do not use. Originally this was so that you can
698 * say "while (FOREVER) { ...do something... }".
699 * However, this gives a warning with some compilers (e.g. VC++).
700 * Instead, use "for (;;) { ...do something... }".
705 * Default IP address to listen on, as a string.
706 * Set to "127.0.0.1".
708 #define HADDR_DEFAULT "127.0.0.1"
711 * Default port to listen on, as a number.
714 #define HADDR_PORT 8118
717 /* Forward def for struct client_state */
718 struct configuration_spec;
722 * Entry in a linked list of strings.
727 * The string pointer. It must point to a dynamically malloc()ed
728 * string or be NULL for the list functions to work. In the latter
729 * case, just be careful next time you iterate through the list in
734 /** Next entry in the linked list, or NULL if no more. */
735 struct list_entry *next;
739 * A header for a linked list of strings.
743 /** First entry in the list, or NULL if the list is empty. */
744 struct list_entry *first;
746 /** Last entry in the list, or NULL if the list is empty. */
747 struct list_entry *last;
752 * An entry in a map. This is a name=value pair.
756 /** The key for the map. */
758 /** The value associated with that key. */
760 /** The next map entry, or NULL if none. */
761 struct map_entry *next;
765 * A map from a string to another string.
766 * This is used for the paramaters passed in a HTTP GET request, and
767 * to store the exports when the CGI interface is filling in a template.
771 /** The first map entry, or NULL if the map is empty. */
772 struct map_entry *first;
773 /** The last map entry, or NULL if the map is empty. */
774 struct map_entry *last;
779 * A HTTP request. This includes the method (GET, POST) and
782 * This is also used whenever we want to match a URL against a
783 * URL pattern. This always contains the URL to match, and never
784 * a URL pattern. (See struct url_spec).
788 char *cmd; /**< Whole command line: method, URL, Version */
789 char *ocmd; /**< Backup of original cmd for CLF logging */
790 char *gpc; /**< HTTP method: GET, POST, ... */
791 char *url; /**< The URL */
792 char *ver; /**< Protocol version */
793 int status; /**< HTTP Status */
795 char *host; /**< Host part of URL */
796 int port; /**< Port of URL or 80 (default) */
797 char *path; /**< Path of URL */
798 char *hostport; /**< host[:port] */
799 int ssl; /**< Flag if protocol is https */
801 char *host_ip_addr_str; /**< String with dotted decimal representation
802 of host's IP. NULL before connect_to() */
804 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
805 char **dvec; /**< List of pointers to the strings in dbuffer. */
806 int dcount; /**< How many parts to this domain? (length of dvec) */
811 * Response generated by CGI, blocker, or error handler
815 char *status; /**< HTTP status (string). */
816 struct list headers[1]; /**< List of header lines. */
817 char *head; /**< Formatted http response head. */
818 size_t head_length; /**< Length of http response head. */
819 char *body; /**< HTTP document body. */
820 size_t content_length; /**< Length of body, REQUIRED if binary body. */
821 int is_static; /**< Nonzero if the content will never change and
822 should be cached by the browser (e.g. images). */
830 /** The string which was parsed to produce this url_spec.
831 Used for debugging or display only. */
834 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
835 char **dvec; /**< List of pointers to the strings in dbuffer. */
836 int dcount; /**< How many parts to this domain? (length of dvec) */
837 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
839 int port; /**< The port number, or 0 to match all ports. */
841 char *path; /**< The source for the regex. */
842 size_t pathlen; /**< ==strlen(path). Needed for prefix matching. FIXME: Now obsolete? */
843 regex_t *preg; /**< Regex for matching path part */
847 * If you declare a static url_spec, this is the value to initialize it to zero.
849 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
852 * Constant for host part matching in URLs. If set, indicates that the start of
853 * the pattern must match the start of the URL. E.g. this is not set for the
854 * pattern ".example.com", so that it will match both "example.com" and
855 * "www.example.com". It is set for the pattern "example.com", which makes it
856 * match "example.com" only, not "www.example.com".
858 #define ANCHOR_LEFT 1
861 * Constant for host part matching in URLs. If set, indicates that the end of
862 * the pattern must match the end of the URL. E.g. this is not set for the
863 * pattern "ad.", so that it will match any host called "ad", irrespective
864 * of how many subdomains are in the fully-qualified domain name.
866 #define ANCHOR_RIGHT 2
870 * An I/O buffer. Holds a string which can be appended to, and can have data
871 * removed from the beginning.
875 char *buf; /**< Start of buffer */
876 char *cur; /**< Start of relevant data */
877 char *eod; /**< End of relevant data */
878 size_t size; /**< Size as malloc()ed */
883 * Return the number of bytes in the I/O buffer associated with the passed
884 * client_state pointer.
887 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
891 * Remove any data in the I/O buffer associated with the passed
892 * client_state pointer.
894 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
896 /* Bits for csp->content_type bitmask: */
897 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
898 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
899 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
900 #define CT_JPEG 0x0008U /**< Suitable for JPEG filtering. */
902 /* Although these are not, strictly speaking, content types
903 * (they are content encodings), it is simple to handle them
906 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
907 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
910 * The mask which includes all actions.
912 #define ACTION_MASK_ALL (~0UL)
915 * The most compatible set of actions - i.e. none.
917 #define ACTION_MOST_COMPATIBLE 0x00000000UL
919 /** Action bitmap: Block the request. */
920 #define ACTION_BLOCK 0x00000001UL
921 /** Action bitmap: Deanimate if it's a GIF. */
922 #define ACTION_DEANIMATE 0x00000002UL
923 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
924 #define ACTION_DOWNGRADE 0x00000004UL
925 /** Action bitmap: Fast redirects. */
926 #define ACTION_FAST_REDIRECTS 0x00000008UL
927 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
928 #define ACTION_HIDE_FORWARDED 0x00000010UL
929 /** Action bitmap: Hide "From" header. */
930 #define ACTION_HIDE_FROM 0x00000020UL
931 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
932 #define ACTION_HIDE_REFERER 0x00000040UL
933 /** Action bitmap: Hide "User-Agent" and similar headers. */
934 #define ACTION_HIDE_USER_AGENT 0x00000080UL
935 /** Action bitmap: This is an image. */
936 #define ACTION_IMAGE 0x00000100UL
937 /** Action bitmap: Sets the image blocker. */
938 #define ACTION_IMAGE_BLOCKER 0x00000200UL
939 /** Action bitmap: Prevent compression. */
940 #define ACTION_NO_COMPRESSION 0x00000400UL
941 /** Action bitmap: Change cookies to session only cookies. */
942 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
943 /** Action bitmap: Block rending cookies. */
944 #define ACTION_NO_COOKIE_READ 0x00001000UL
945 /** Action bitmap: Block setting cookies. */
946 #define ACTION_NO_COOKIE_SET 0x00002000UL
947 /** Action bitmap: Filter out popups. */
948 #define ACTION_NO_POPUPS 0x00004000UL
949 /** Action bitmap: Send a vanilla wafer. */
950 #define ACTION_VANILLA_WAFER 0x00008000UL
951 /** Action bitmap: Limit CONNECT requests to safe ports. */
952 #define ACTION_LIMIT_CONNECT 0x00010000UL
953 /** Action bitmap: Inspect if it's a JPEG. */
954 #define ACTION_JPEG_INSPECT 0x00020000UL
955 /** Action bitmap: Crunch or modify "if-modified-since" header. */
956 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
957 /** Action bitmap: Overwrite Content-Type header. */
958 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
959 /** Action bitmap: Crunch specified server header. */
960 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
961 /** Action bitmap: Crunch specified client header */
962 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
963 /** Action bitmap: Enable text mode by force */
964 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
965 /** Action bitmap: Enable text mode by force */
966 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
967 /** Action bitmap: Enable content-dispostion crunching */
968 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
969 /** Action bitmap: Replace or block Last-Modified header */
970 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
971 /** Action bitmap: Replace or block Accept-Language header */
972 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
973 /** Action bitmap: Block as empty document */
974 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x08000000UL
975 /** Action bitmap: Redirect request. */
976 #define ACTION_REDIRECT 0x10000000UL
977 /** Action bitmap: Answer blocked Connects verbosely */
978 #define ACTION_TREAT_FORBIDDEN_CONNECTS_LIKE_BLOCKS 0x20000000UL
979 /** Action bitmap: Filter server headers with pcre */
980 #define ACTION_FILTER_SERVER_HEADERS 0x40000000UL
981 /** Action bitmap: Filter client headers with pcre */
982 #define ACTION_FILTER_CLIENT_HEADERS 0x80000000UL
985 /** Action string index: How to deanimate GIFs */
986 #define ACTION_STRING_DEANIMATE 0
987 /** Action string index: Replacement for "From:" header */
988 #define ACTION_STRING_FROM 1
989 /** Action string index: How to block images */
990 #define ACTION_STRING_IMAGE_BLOCKER 2
991 /** Action string index: Replacement for "Referer:" header */
992 #define ACTION_STRING_REFERER 3
993 /** Action string index: Replacement for "User-Agent:" header */
994 #define ACTION_STRING_USER_AGENT 4
995 /** Action string index: Legal CONNECT ports. */
996 #define ACTION_STRING_LIMIT_CONNECT 5
997 /** Action string index: Server headers containing this pattern are crunched*/
998 #define ACTION_STRING_SERVER_HEADER 6
999 /** Action string index: Client headers containing this pattern are crunched*/
1000 #define ACTION_STRING_CLIENT_HEADER 7
1001 /** Action string index: Replacement for the "Accept-Language:" header*/
1002 #define ACTION_STRING_LANGUAGE 8
1003 /** Action string index: Replacement for the "Content-Type:" header*/
1004 #define ACTION_STRING_CONTENT_TYPE 9
1005 /** Action string index: Replacement for the "content-dispostion:" header*/
1006 #define ACTION_STRING_CONTENT_DISPOSITION 10
1007 /** Action string index: Replacement for the "If-Modified-Since:" header*/
1008 #define ACTION_STRING_IF_MODIFIED_SINCE 11
1009 /** Action string index: Replacement for the "Last-Modified:" header. */
1010 #define ACTION_STRING_LAST_MODIFIED 12
1011 /** Action string index: Redirect URL */
1012 #define ACTION_STRING_REDIRECT 13
1013 /** Action string index: Decode before redirect? */
1014 #define ACTION_STRING_FAST_REDIRECTS 14
1015 /** Number of string actions. */
1016 #define ACTION_STRING_COUNT 15
1019 /*To make the ugly hack in sed easier to understand*/
1020 #define CHECK_EVERY_HEADER_REMAINING 0
1023 /** Index into current_action_spec::multi[] for headers to add. */
1024 #define ACTION_MULTI_ADD_HEADER 0
1025 /** Index into current_action_spec::multi[] for headers to add. */
1026 #define ACTION_MULTI_WAFER 1
1027 /** Index into current_action_spec::multi[] for filters to apply. */
1028 #define ACTION_MULTI_FILTER 2
1029 /** Number of multi-string actions. */
1030 #define ACTION_MULTI_COUNT 3
1034 * This structure contains a list of actions to apply to a URL.
1035 * It only contains positive instructions - no "-" options.
1036 * It is not used to store the actions list itself, only for
1037 * url_actions() to return the current values.
1039 struct current_action_spec
1041 /** Actions to apply. A bit set to "1" means perform the action. */
1042 unsigned long flags;
1045 * Paramaters for those actions that require them.
1046 * Each entry is valid if & only if the corresponding entry in "flags" is
1049 char * string[ACTION_STRING_COUNT];
1051 /** Lists of strings for multi-string actions. */
1052 struct list multi[ACTION_MULTI_COUNT][1];
1057 * This structure contains a set of changes to actions.
1058 * It can contain both positive and negative instructions.
1059 * It is used to store an entry in the actions list.
1063 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1064 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1067 * Paramaters for those actions that require them.
1068 * Each entry is valid if & only if the corresponding entry in "flags" is
1071 char * string[ACTION_STRING_COUNT];
1073 /** Lists of strings to remove, for multi-string actions. */
1074 struct list multi_remove[ACTION_MULTI_COUNT][1];
1076 /** If nonzero, remove *all* strings from the multi-string action. */
1077 int multi_remove_all[ACTION_MULTI_COUNT];
1079 /** Lists of strings to add, for multi-string actions. */
1080 struct list multi_add[ACTION_MULTI_COUNT][1];
1085 * This structure is used to store the actions list.
1087 * It contains a URL pattern, and the chages to the actions.
1088 * It is a linked list.
1092 struct url_spec url[1]; /**< URL pattern. */
1094 struct action_spec action[1]; /**< Actions. */
1096 struct url_actions * next; /**< Next action in file, or NULL. */
1101 * Flags for use in csp->flags
1105 * Flag for csp->flags: Set if this client is processing data.
1106 * Cleared when the thread associated with this structure dies.
1108 #define CSP_FLAG_ACTIVE 0x01
1111 * Flag for csp->flags: Set if the server's reply is in "chunked"
1114 #define CSP_FLAG_CHUNKED 0x02
1117 * Flag for csp->flags: Set if this request was enforced, although it would
1118 * normally have been blocked.
1120 #define CSP_FLAG_FORCED 0x04
1123 * Flag for csp->flags: Set if any modification to the body was done.
1125 #define CSP_FLAG_MODIFIED 0x08
1128 * Flag for csp->flags: Set if request was blocked.
1130 #define CSP_FLAG_REJECTED 0x10
1133 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1135 #define CSP_FLAG_TOGGLED_ON 0x20
1139 * Flags for use in return codes of child processes
1143 * Flag for process return code: Set if exiting porcess has been toggled
1144 * during its lifetime.
1146 #define RC_FLAG_TOGGLED 0x10
1149 * Flag for process return code: Set if exiting porcess has blocked its
1152 #define RC_FLAG_BLOCKED 0x20
1155 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1158 #define MAX_AF_FILES 10
1161 * The state of a Privoxy processing thread.
1165 /** The proxy's configuration */
1166 struct configuration_spec * config;
1168 /** The actions to perform on the current request */
1169 struct current_action_spec action[1];
1171 /** socket to talk to client (web browser) */
1174 /** socket to talk to server (web server or proxy) */
1177 /** Multi-purpose flag container, see CSP_FLAG_* above */
1180 /** Client PC's IP address, as reported by the accept() function.
1183 /** Client PC's IP address, as reported by the accept() function.
1187 /** Our IP address. I.e. the IP address that the client used to reach us,
1189 char *my_ip_addr_str;
1191 /** Our hostname. I.e. the reverse DNS of the IP address that the client
1192 used to reach us, as a string. */
1195 /** The URL that was requested */
1196 struct http_request http[1];
1198 /** An I/O buffer used for buffering data read from the network */
1201 /** List of all headers for this request */
1202 struct list headers[1];
1204 /** List of all cookies for this request */
1205 struct list cookie_list[1];
1207 /** MIME-Type key, see CT_* above */
1208 unsigned int content_type;
1210 /** The "X-Forwarded-For:" header sent by the client */
1213 /** Actions files associated with this client */
1214 struct file_list *actions_list[MAX_AF_FILES];
1216 /** pcrs job files. */
1217 struct file_list *rlist[MAX_AF_FILES];
1219 /** Length after content modification. */
1220 size_t content_length;
1222 #ifdef FEATURE_TRUST
1225 struct file_list *tlist;
1227 #endif /* def FEATURE_TRUST */
1230 * Failure reason to embedded in the CGI error page,
1231 * or NULL. Currently only used for socks errors.
1233 char *error_message;
1235 /** Next thread in linked list. Only read or modify from the main thread! */
1236 struct client_state *next;
1241 * A function to add a header
1243 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1246 * A function to process a header
1248 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1252 * List of functions to run on a list of headers
1256 /** The header prefix to match */
1259 /** The length of the prefix to match */
1262 /** The function to apply to this line */
1263 parser_func_ptr parser;
1268 * List of available CGI functions.
1270 struct cgi_dispatcher
1272 /** The URL of the CGI, relative to the CGI root. */
1273 const char * const name;
1275 /** The handler function for the CGI */
1276 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1278 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1279 const char * const description;
1281 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1287 * A data file used by Privoxy. Kept in a linked list.
1292 * This is a pointer to the data structures associated with the file.
1293 * Read-only once the structure has been created.
1298 * The unloader function.
1299 * Normally NULL. When we are finished with file (i.e. when we have
1300 * loaded a new one), set to a pointer to an unloader function.
1301 * Unloader will be called by sweep() (called from main loop) when
1302 * all clients using this file are done. This prevents threading
1305 void (*unloader)(void *);
1308 * Used internally by sweep(). Do not access from elsewhere.
1313 * File last-modified time, so we can check if file has been changed.
1314 * Read-only once the structure has been created.
1316 time_t lastmodified;
1319 * The full filename.
1324 * Pointer to next entry in the linked list of all "file_list"s.
1325 * This linked list is so that sweep() can navigate it.
1326 * Since sweep() can remove items from the list, we must be careful
1327 * to only access this value from main thread (when we know sweep
1328 * won't be running).
1330 struct file_list *next;
1334 #ifdef FEATURE_TRUST
1337 * The format of a trust file when loaded into memory.
1341 struct url_spec url[1]; /**< The URL pattern */
1342 int reject; /**< FIXME: Please document this! */
1343 struct block_spec *next; /**< Next entry in linked list */
1347 * Arbitrary limit for the number of trusted referrers.
1349 #define MAX_TRUSTED_REFERRERS 512
1351 #endif /* def FEATURE_TRUST */
1354 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1355 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1356 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1360 * How to forward a connection to a parent proxy.
1364 /** URL pattern that this forward_spec is for. */
1365 struct url_spec url[1];
1367 /** Connection type. Must be SOCKS_NONE, SOCKS_4, or SOCKS_4A. */
1370 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1373 /** SOCKS server port. */
1376 /** Parent HTTP proxy hostname, or NULL for none. */
1379 /** Parent HTTP proxy port. */
1382 /** Next entry in the linked list. */
1383 struct forward_spec *next;
1388 * Initializer for a static struct forward_spec.
1390 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1394 * This struct represents one filter (one block) from
1395 * the re_filterfile. If there is more than one filter
1396 * in the file, the file will be represented by a
1397 * chained list of re_filterfile specs.
1399 struct re_filterfile_spec
1401 char *name; /**< Name from FILTER: statement in re_filterfile. */
1402 char *description; /**< Description from FILTER: statement in re_filterfile. */
1403 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1404 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1405 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1411 #define ACL_PERMIT 1 /**< Accept connection request */
1412 #define ACL_DENY 2 /**< Reject connection request */
1415 * An IP address pattern. Used to specify networks in the ACL.
1417 struct access_control_addr
1419 unsigned long addr; /**< The IP address as an integer. */
1420 unsigned long mask; /**< The network mask as an integer. */
1421 unsigned long port; /**< The port number. */
1425 * An access control list (ACL) entry.
1427 * This is a linked list.
1429 struct access_control_list
1431 struct access_control_addr src[1]; /**< Client IP address */
1432 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1434 short action; /**< ACL_PERMIT or ACL_DENY */
1435 struct access_control_list *next; /**< The next entry in the ACL. */
1438 #endif /* def FEATURE_ACL */
1441 /** Maximum number of loaders (actions, re_filter, ...) */
1445 /** configuration_spec::feature_flags: CGI actions editor. */
1446 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1448 /** configuration_spec::feature_flags: Web-based toggle. */
1449 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1451 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1452 #define RUNTIME_FEATURE_HTTP_TOGGLE 4
1454 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1455 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8
1457 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1458 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16
1462 * Data loaded from the configuration file.
1464 * (Anomaly: toggle is still handled through a global, not this structure)
1466 struct configuration_spec
1471 /** Nonzero to enable multithreading. */
1475 * Bitmask of features that can be enabled/disabled through the config
1476 * file. Currently defined bits:
1478 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1479 * - RUNTIME_FEATURE_CGI_TOGGLE
1480 * - RUNTIME_FEATURE_HTTP_TOGGLE
1481 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1483 unsigned feature_flags;
1485 /** The log file name. */
1486 const char *logfile;
1488 /** The config file directory. */
1489 const char *confdir;
1491 /** The log file directory. */
1494 /** The full paths to the actions files. */
1495 const char *actions_file[MAX_AF_FILES];
1497 /** The short names of the actions files. */
1498 const char *actions_file_short[MAX_AF_FILES];
1500 /** The administrator's email address */
1501 char *admin_address;
1503 /** A URL with info on this proxy */
1504 char *proxy_info_url;
1506 /** URL to the user manual (on our website or local copy) */
1509 /** The file names of the pcre filter files. */
1510 const char *re_filterfile[MAX_AF_FILES];
1512 /** The short names of the pcre filter files. */
1513 const char *re_filterfile_short[MAX_AF_FILES];
1515 #ifdef FEATURE_COOKIE_JAR
1517 /** The file name of the cookie jar file */
1518 const char * jarfile;
1520 /** The handle to the cookie jar file */
1523 #endif /* def FEATURE_COOKIE_JAR */
1525 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1528 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1531 /** Size limit for IOB */
1532 size_t buffer_limit;
1534 #ifdef FEATURE_TRUST
1536 /** The file name of the trust file. */
1537 const char * trustfile;
1539 /** FIXME: DOCME: Document this. */
1540 struct list trust_info[1];
1542 /** FIXME: DOCME: Document this. */
1543 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1545 #endif /* def FEATURE_TRUST */
1549 /** The access control list (ACL). */
1550 struct access_control_list *acl;
1552 #endif /* def FEATURE_ACL */
1554 /** Information about parent proxies (forwarding). */
1555 struct forward_spec *forward;
1557 /** Number of retries in case a forwarded connection attempt fails */
1558 int forwarded_connect_retries;
1560 /** All options from the config file, HTML-formatted. */
1563 /** The configuration file object. */
1564 struct file_list *config_file_list;
1566 /** List of loaders */
1567 int (*loaders[NLOADERS])(struct client_state *);
1569 /** Nonzero if we need to bind() to the new port. */
1573 /** Calculates the number of elements in an array, using sizeof. */
1574 #define SZ(X) (sizeof(X) / sizeof(*X))
1576 #ifdef FEATURE_FORCE_LOAD
1577 /** The force load URL prefix. */
1578 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1579 #endif /* def FEATURE_FORCE_LOAD */
1581 #ifdef FEATURE_NO_GIFS
1582 /** The MIME type for images ("image/png" or "image/gif"). */
1583 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1585 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1586 #endif /* def FEATURE_NO_GIFS */
1593 /** URL for the Privoxy home page. */
1594 #define HOME_PAGE_URL "http://www.privoxy.org/"
1596 /** URL for the Privoxy user manual. */
1597 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1599 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1600 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1602 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1603 #define CONFIG_HELP_PREFIX "config.html#"
1606 * The "hosts" to intercept and display CGI pages.
1607 * First one is a hostname only, second one can specify host and path.
1610 * 1) Do not specify the http: prefix
1611 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1612 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1614 #define CGI_SITE_1_HOST "p.p"
1615 #define CGI_SITE_2_HOST "config.privoxy.org"
1616 #define CGI_SITE_2_PATH ""
1619 * The prefix for CGI pages. Written out in generated HTML.
1620 * INCLUDES the trailing slash.
1622 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1628 #endif /* ndef PROJECT_H_INCLUDED */