1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.78 2006/08/31 16:25:06 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.78 2006/08/31 16:25:06 fabiankeil
41 * Work around a buffer overflow that caused Privoxy to
42 * segfault if too many trusted referrers were used. Good
43 * enough for now, but should be replaced with a real
44 * solution after the next release.
46 * Revision 1.77 2006/08/21 12:50:51 david__schmidt
49 * Revision 1.76 2006/08/14 08:25:19 fabiankeil
50 * Split filter-headers{} into filter-client-headers{}
51 * and filter-server-headers{}.
52 * Added parse_header_time() to share some code.
53 * Replaced timegm() with mktime().
55 * Revision 1.75 2006/08/03 02:46:41 david__schmidt
56 * Incorporate Fabian Keil's patch work:
\r * http://www.fabiankeil.de/sourcecode/privoxy/
58 * Revision 1.74 2006/07/18 14:48:47 david__schmidt
59 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
60 * with what was really the latest development (the v_3_0_branch branch)
62 * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
63 * Multiple filter file support
65 * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
66 * Add the ability to check jpeg images for invalid
67 * lengths of comment blocks. Defensive strategy
68 * against the exploit:
69 * Microsoft Security Bulletin MS04-028
70 * Buffer Overrun in JPEG Processing (GDI+) Could
71 * Allow Code Execution (833987)
72 * Enabled with +inspect-jpegs in actions files.
74 * Revision 1.72.2.5 2004/01/30 15:29:29 oes
75 * Updated the copyright note
77 * Revision 1.72.2.4 2004/01/13 16:12:14 oes
78 * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
80 * Revision 1.72.2.3 2003/03/11 11:54:37 oes
81 * Introduced RC_FLAG_* flags for use in child process return code
83 * Revision 1.72.2.2 2002/11/28 18:15:44 oes
84 * Added flag to each cgi_dispatcher that allows or denies
85 * external linking and removed const qualifier from
86 * struct list_entry.str.
88 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
89 * - Include config.h for access to config data
90 * - Include <pcre*.h> depending on where they are
92 * Revision 1.72 2002/05/14 21:35:49 oes
93 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
94 * because of split in user-manual
96 * Revision 1.71 2002/05/12 21:39:36 jongfoster
97 * - Adding Doxygen-style comments to structures and #defines.
99 * Revision 1.70 2002/05/12 16:05:50 jongfoster
100 * Fixing ACTION_MASK_ALL to be unsigned long rather than
101 * just unsigned int. I don't know if anyone is porting
102 * Privoxy to 16-bit platforms, but if so, +limit-connect
103 * wouldn't have worked because of this bug.
105 * Revision 1.69 2002/05/08 16:00:16 oes
106 * Added size member to struct iob, so it can
107 * be alloced larger than needed.
109 * Revision 1.68 2002/04/26 12:56:00 oes
110 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
112 * Revision 1.67 2002/04/24 02:12:43 oes
113 * - Jon's multiple AF patch:
114 * - Make csp->actions_list an array
115 * - #define MAX_AF_FILES
116 * - Moved CGI_PARAM_LEN_MAX (500) here
118 * Revision 1.66 2002/04/15 19:06:43 jongfoster
121 * Revision 1.65 2002/04/04 00:36:36 gliptak
122 * always use pcre for matching
124 * Revision 1.64 2002/04/03 22:28:03 gliptak
125 * Removed references to gnu_regex
127 * Revision 1.63 2002/03/31 17:19:00 jongfoster
128 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
130 * Revision 1.62 2002/03/26 22:48:49 swa
133 * Revision 1.61 2002/03/26 22:29:55 swa
134 * we have a new homepage!
136 * Revision 1.60 2002/03/24 15:52:17 jongfoster
137 * Changing CGI URL prefixes for new name
139 * Revision 1.59 2002/03/24 15:23:33 jongfoster
142 * Revision 1.58 2002/03/24 13:25:43 swa
143 * name change related issues
145 * Revision 1.57 2002/03/16 20:28:34 oes
146 * Added descriptions to the filters so users will know what they select in the cgi editor
148 * Revision 1.56 2002/03/13 20:27:30 oes
149 * Fixing bug with CT_TABOO
151 * Revision 1.55 2002/03/12 01:42:50 oes
152 * Introduced modular filters
154 * Revision 1.54 2002/03/09 20:03:52 jongfoster
155 * - Making various functions return int rather than size_t.
156 * (Undoing a recent change). Since size_t is unsigned on
157 * Windows, functions like read_socket that return -1 on
158 * error cannot return a size_t.
160 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
161 * crashes, and also frequently caused JB to jump to 100%
162 * CPU and stay there. (Because it thought it had just
163 * read ((unsigned)-1) == 4Gb of data...)
165 * - The signature of write_socket has changed, it now simply
166 * returns success=0/failure=nonzero.
168 * - Trying to get rid of a few warnings --with-debug on
169 * Windows, I've introduced a new type "jb_socket". This is
170 * used for the socket file descriptors. On Windows, this
171 * is SOCKET (a typedef for unsigned). Everywhere else, it's
172 * an int. The error value can't be -1 any more, so it's
173 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
174 * Windows it maps to the #define INVALID_SOCKET.)
176 * - The signature of bind_port has changed.
178 * Revision 1.53 2002/03/08 16:48:55 oes
179 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
181 * Revision 1.52 2002/03/07 03:46:17 oes
182 * Fixed compiler warnings
184 * Revision 1.51 2002/03/05 04:52:42 oes
185 * Deleted non-errlog debugging code
187 * Revision 1.50 2002/03/04 19:32:07 oes
188 * Changed default port to 8118
190 * Revision 1.49 2002/03/04 18:28:55 oes
191 * Deleted PID_FILE_NAME
193 * Revision 1.48 2002/03/03 14:50:40 oes
194 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
196 * Revision 1.47 2002/02/20 23:15:13 jongfoster
197 * Parsing functions now handle out-of-memory gracefully by returning
200 * Revision 1.46 2002/01/17 21:06:09 jongfoster
201 * Now #defining the URLs of the config interface
203 * Minor changes to struct http_request and struct url_spec due to
204 * standardizing that struct http_request is used to represent a URL, and
205 * struct url_spec is used to represent a URL pattern. (Before, URLs were
206 * represented as seperate variables and a partially-filled-in url_spec).
208 * Revision 1.45 2002/01/09 14:33:27 oes
209 * Added HOSTENT_BUFFER_SIZE
211 * Revision 1.44 2001/12/30 14:07:32 steudten
212 * - Add signal handling (unix)
213 * - Add SIGHUP handler (unix)
214 * - Add creation of pidfile (unix)
215 * - Add action 'top' in rc file (RH)
216 * - Add entry 'SIGNALS' to manpage
217 * - Add exit message to logfile (unix)
219 * Revision 1.43 2001/11/22 21:57:51 jongfoster
220 * Making action_spec->flags into an unsigned long rather than just an
222 * Adding ACTION_NO_COOKIE_KEEP
224 * Revision 1.42 2001/11/05 21:42:41 steudten
225 * Include DBG() macro.
227 * Revision 1.41 2001/10/28 19:12:06 jongfoster
228 * Adding ijb_toupper()
230 * Revision 1.40 2001/10/26 17:40:47 oes
231 * Moved ijb_isspace and ijb_tolower to project.h
232 * Removed http->user_agent, csp->referrer and csp->accept_types
234 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
235 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
236 * macro when called with a cast; so moving the cast to the macro def'n
237 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
238 * doesn't make macro expansion complain. Hope this works for everyone else
241 * Revision 1.38 2001/10/23 21:19:04 jongfoster
242 * New error-handling support: jb_err type and JB_ERR_xxx constants
243 * CGI functions now return a jb_err, and their parameters map is const.
244 * Support for RUNTIME_FEATUREs to enable/disable config editor
245 * Adding a few comments
247 * Revision 1.37 2001/10/14 22:14:01 jongfoster
248 * Removing name_length field from struct cgi_dispatcher, as this is
249 * now calculated at runtime from the "name" field.
251 * Revision 1.36 2001/10/10 16:45:15 oes
252 * Added LIMIT_CONNECT action and string
253 * Fixed HTTP message line termination
254 * Added CFORBIDDEN HTTP message
256 * Revision 1.35 2001/10/07 18:06:43 oes
257 * Added status member to struct http_request
259 * Revision 1.34 2001/10/07 15:45:25 oes
260 * Added url member to struct http_request and commented all
265 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
267 * Replaced struct client_state members rejected,
268 * force, active and toggled_on with "flags" bitmap.
270 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
272 * Added buffer_limit to struct configuration_spec
274 * Revision 1.33 2001/09/20 13:30:08 steudten
276 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
277 * Last case will set z to NULL in free(z) and thats bad..
279 * Revision 1.32 2001/09/16 23:02:51 jongfoster
282 * Revision 1.31 2001/09/16 13:20:29 jongfoster
283 * Rewrite of list library. Now has seperate header and list_entry
284 * structures. Also added a large sprinking of assert()s to the list
287 * Revision 1.30 2001/09/13 23:52:00 jongfoster
288 * Support for both static and dynamically generated CGI pages
290 * Revision 1.29 2001/09/13 23:29:43 jongfoster
291 * Defining FORWARD_SPEC_INITIALIZER
293 * Revision 1.28 2001/09/13 23:05:50 jongfoster
294 * Changing the string paramater to the header parsers a "const".
296 * Revision 1.27 2001/08/05 16:06:20 jongfoster
297 * Modifiying "struct map" so that there are now separate header and
298 * "map_entry" structures. This means that functions which modify a
299 * map no longer need to return a pointer to the modified map.
300 * Also, it no longer reverses the order of the entries (which may be
301 * important with some advanced template substitutions).
303 * Revision 1.26 2001/07/30 22:08:36 jongfoster
304 * Tidying up #defines:
305 * - All feature #defines are now of the form FEATURE_xxx
306 * - Permanently turned off WIN_GUI_EDIT
307 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
309 * Revision 1.25 2001/07/29 18:43:08 jongfoster
310 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
313 * Revision 1.24 2001/07/25 17:20:27 oes
314 * Introduced http->user_agent
316 * Revision 1.23 2001/07/18 12:32:23 oes
317 * - Added ACTION_STRING_DEANIMATE
318 * - moved #define freez from jcc.h to project.h
320 * Revision 1.22 2001/07/15 17:51:41 jongfoster
321 * Renaming #define STATIC to STATIC_PCRE
323 * Revision 1.21 2001/07/13 14:03:19 oes
324 * - Reorganized regex header inclusion and #defines to
325 * comply to the scheme in configure.in
326 * - Added csp->content_type and its CT_* keys
327 * - Added ACTION_DEANIMATE
328 * - Removed all #ifdef PCRS
330 * Revision 1.20 2001/06/29 21:45:41 oes
331 * Indentation, CRLF->LF, Tab-> Space
333 * Revision 1.19 2001/06/29 13:33:36 oes
334 * - Improved comments
335 * - Introduced http_request.host_ip_addr_str
336 * - Introduced http_response.head_length
337 * - Introduced config.my_ip_addr_str, config.my_hostname,
338 * config.admin_address and config.proxy_info_url
339 * - Removed config.proxy_args_header and config.proxy_args_trailer,
340 * renamed config.proxy_args_invocation to config.proxy_args
341 * - Removed HTML snipplets and GIFs
342 * - Removed logentry from cancelled commit
344 * Revision 1.18 2001/06/09 10:57:39 jongfoster
345 * Adding definition of BUFFER_SIZE.
346 * Changing struct cgi_dispatcher to use "const" strings.
348 * Revision 1.17 2001/06/07 23:15:09 jongfoster
349 * Merging ACL and forward files into config file.
350 * Moving struct gateway members into struct forward_spec
351 * Removing config->proxy_args_gateways
352 * Cosmetic: Adding a few comments
354 * Revision 1.16 2001/06/04 18:31:58 swa
355 * files are now prefixed with either `confdir' or `logdir'.
356 * `make redhat-dist' replaces both entries confdir and logdir
359 * Revision 1.15 2001/06/04 11:28:53 swa
360 * redirect did not work due to missing /
362 * Revision 1.14 2001/06/03 11:03:48 oes
364 * added struct http_response,
365 * changed struct interceptors to struct cgi_dispatcher,
366 * moved HTML stuff to cgi.h
368 * Revision 1.13 2001/06/01 20:05:36 jongfoster
369 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
370 * constant, and removed csp->tinygif.
372 * Revision 1.12 2001/06/01 18:49:17 jongfoster
373 * Replaced "list_share" with "list" - the tiny memory gain was not
374 * worth the extra complexity.
376 * Revision 1.11 2001/06/01 10:32:47 oes
377 * Added constants for anchoring selection bitmap
379 * Revision 1.10 2001/05/31 21:33:53 jongfoster
380 * Changes for new actions file, replacing permissionsfile
381 * and parts of the config file. Also added support for
384 * Revision 1.9 2001/05/31 17:32:31 oes
386 * - Enhanced domain part globbing with infix and prefix asterisk
387 * matching and optional unanchored operation
389 * Revision 1.8 2001/05/29 20:09:15 joergs
390 * HTTP_REDIRECT_TEMPLATE fixed.
392 * Revision 1.7 2001/05/29 09:50:24 jongfoster
393 * Unified blocklist/imagelist/actionslist.
394 * File format is still under discussion, but the internal changes
397 * Also modified interceptor behaviour:
398 * - We now intercept all URLs beginning with one of the following
399 * prefixes (and *only* these prefixes):
401 * * http://ijbswa.sf.net/config/
402 * * http://ijbswa.sourceforge.net/config/
403 * - New interceptors "home page" - go to http://i.j.b/ to see it.
404 * - Internal changes so that intercepted and fast redirect pages
405 * are not replaced with an image.
406 * - Interceptors now have the option to send a binary page direct
407 * to the client. (i.e. ijb-send-banner uses this)
408 * - Implemented show-url-info interceptor. (Which is why I needed
409 * the above interceptors changes - a typical URL is
410 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
411 * The previous mechanism would not have intercepted that, and
412 * if it had been intercepted then it then it would have replaced
415 * Revision 1.6 2001/05/27 22:17:04 oes
417 * - re_process_buffer no longer writes the modified buffer
418 * to the client, which was very ugly. It now returns the
419 * buffer, which it is then written by chat.
421 * - content_length now adjusts the Content-Length: header
422 * for modified documents rather than crunch()ing it.
423 * (Length info in csp->content_length, which is 0 for
424 * unmodified documents)
426 * - For this to work, sed() is called twice when filtering.
428 * Revision 1.5 2001/05/26 00:28:36 jongfoster
429 * Automatic reloading of config file.
430 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
431 * Most of the global variables have been moved to a new
432 * struct configuration_spec, accessed through csp->config->globalname
433 * Most of the globals remaining are used by the Win32 GUI.
435 * Revision 1.4 2001/05/22 18:46:04 oes
437 * - Enabled filtering banners by size rather than URL
438 * by adding patterns that replace all standard banner
439 * sizes with the "Junkbuster" gif to the re_filterfile
441 * - Enabled filtering WebBugs by providing a pattern
442 * which kills all 1x1 images
444 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
445 * which is selected by the (nonstandard and therefore
446 * capital) letter 'U' in the option string.
447 * It causes the quantifiers to be ungreedy by default.
448 * Appending a ? turns back to greedy (!).
450 * - Added a new interceptor ijb-send-banner, which
451 * sends back the "Junkbuster" gif. Without imagelist or
452 * MSIE detection support, or if tinygif = 1, or the
453 * URL isn't recognized as an imageurl, a lame HTML
454 * explanation is sent instead.
456 * - Added new feature, which permits blocking remote
457 * script redirects and firing back a local redirect
459 * The feature is conditionally compiled, i.e. it
460 * can be disabled with --disable-fast-redirects,
461 * plus it must be activated by a "fast-redirects"
462 * line in the config file, has its own log level
463 * and of course wants to be displayed by show-proxy-args
464 * Note: Boy, all the #ifdefs in 1001 locations and
465 * all the fumbling with configure.in and acconfig.h
466 * were *way* more work than the feature itself :-(
468 * - Because a generic redirect template was needed for
469 * this, tinygif = 3 now uses the same.
471 * - Moved GIFs, and other static HTTP response templates
476 * - Removed some >400 CRs again (Jon, you really worked
479 * Revision 1.3 2001/05/20 01:21:20 jongfoster
480 * Version 2.9.4 checkin.
481 * - Merged popupfile and cookiefile, and added control over PCRS
482 * filtering, in new "actionsfile".
483 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
484 * file error you now get a message box (in the Win32 GUI) rather
485 * than the program exiting with no explanation.
486 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
488 * - Removed tabs from "config"
489 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
490 * - Bumped up version number.
492 * Revision 1.2 2001/05/17 23:01:01 oes
493 * - Cleaned CRLF's from the sources and related files
495 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
496 * Initial import of version 2.9.3 source tree
499 *********************************************************************/
502 /* Declare struct FILE for vars and funcs. */
505 /* Need time_t for file_list */
507 /* Needed for pcre choice */
511 * Include appropriate regular expression libraries.
512 * Note that pcrs and pcre (native) are needed for cgi
513 * and are included anyway.
519 # ifdef PCRE_H_IN_SUBDIR
520 # include <pcre/pcre.h>
533 # include "pcreposix.h"
535 # ifdef PCRE_H_IN_SUBDIR
536 # include <pcre/pcreposix.h>
538 # include <pcreposix.h>
544 #endif /* def AMIGA */
548 * I don't want to have to #include all this just for the declaration
549 * of SOCKET. However, it looks like we have to...
564 typedef SOCKET jb_socket;
566 #define JB_INVALID_SOCKET INVALID_SOCKET
568 #else /* ndef _WIN32 */
571 * The type used by sockets. On UNIX it's an int. Microsoft decided to
572 * make it an unsigned.
574 typedef int jb_socket;
577 * The error value used for variables of type jb_socket. On UNIX this
578 * is -1, however Microsoft decided to make socket handles unsigned, so
579 * they use a different value.
582 #define JB_INVALID_SOCKET (-1)
584 #endif /* ndef _WIN32 */
588 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
593 #define JB_ERR_OK 0 /**< Success, no error */
594 #define JB_ERR_MEMORY 1 /**< Out of memory */
595 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
596 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
597 #define JB_ERR_PARSE 4 /**< Error parsing file */
598 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
599 CGI actions editor. */
603 * This macro is used to free a pointer that may be NULL.
604 * It also sets the variable to NULL after it's been freed.
605 * The paramater should be a simple variable without side effects.
607 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
611 * Fix a problem with Solaris. There should be no effect on other
614 * Solaris's isspace() is a macro which uses it's argument directly
615 * as an array index. Therefore we need to make sure that high-bit
616 * characters generate +ve values, and ideally we also want to make
617 * the argument match the declared parameter type of "int".
619 * Note: Remember to #include <ctype.h> if you use these macros.
621 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
622 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
623 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
626 * Use for statically allocated buffers if you have no other choice.
627 * Remember to check the length of what you write into the buffer
628 * - we don't want any buffer overflows!
630 #define BUFFER_SIZE 5000
633 * Max length of CGI parameters (arbitrary limit).
635 #define CGI_PARAM_LEN_MAX 500
638 * Buffer size for capturing struct hostent data in the
639 * gethostby(name|addr)_r library calls. Since we don't
640 * loop over gethostbyname_r, the buffer must be sufficient
641 * to accomodate multiple IN A RRs, as used in DNS round robin
642 * load balancing. W3C's wwwlib uses 1K, so that should be
643 * good enough for us, too.
645 #define HOSTENT_BUFFER_SIZE 1024
648 * Do not use. Originally this was so that you can
649 * say "while (FOREVER) { ...do something... }".
650 * However, this gives a warning with some compilers (e.g. VC++).
651 * Instead, use "for (;;) { ...do something... }".
656 * Default IP address to listen on, as a string.
657 * Set to "127.0.0.1".
659 #define HADDR_DEFAULT "127.0.0.1"
662 * Default port to listen on, as a number.
665 #define HADDR_PORT 8118
668 /* Forward def for struct client_state */
669 struct configuration_spec;
673 * Entry in a linked list of strings.
678 * The string pointer. It must point to a dynamically malloc()ed
679 * string or be NULL for the list functions to work. In the latter
680 * case, just be careful next time you iterate through the list in
685 /** Next entry in the linked list, or NULL if no more. */
686 struct list_entry *next;
690 * A header for a linked list of strings.
694 /** First entry in the list, or NULL if the list is empty. */
695 struct list_entry *first;
697 /** Last entry in the list, or NULL if the list is empty. */
698 struct list_entry *last;
703 * An entry in a map. This is a name=value pair.
707 /** The key for the map. */
709 /** The value associated with that key. */
711 /** The next map entry, or NULL if none. */
712 struct map_entry *next;
716 * A map from a string to another string.
717 * This is used for the paramaters passed in a HTTP GET request, and
718 * to store the exports when the CGI interface is filling in a template.
722 /** The first map entry, or NULL if the map is empty. */
723 struct map_entry *first;
724 /** The last map entry, or NULL if the map is empty. */
725 struct map_entry *last;
730 * A HTTP request. This includes the method (GET, POST) and
733 * This is also used whenever we want to match a URL against a
734 * URL pattern. This always contains the URL to match, and never
735 * a URL pattern. (See struct url_spec).
739 char *cmd; /**< Whole command line: method, URL, Version */
740 char *ocmd; /**< Backup of original cmd for CLF logging */
741 char *gpc; /**< HTTP method: GET, POST, ... */
742 char *url; /**< The URL */
743 char *ver; /**< Protocol version */
744 int status; /**< HTTP Status */
746 char *host; /**< Host part of URL */
747 int port; /**< Port of URL or 80 (default) */
748 char *path; /**< Path of URL */
749 char *hostport; /**< host[:port] */
750 int ssl; /**< Flag if protocol is https */
752 char *host_ip_addr_str; /**< String with dotted decimal representation
753 of host's IP. NULL before connect_to() */
755 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
756 char **dvec; /**< List of pointers to the strings in dbuffer. */
757 int dcount; /**< How many parts to this domain? (length of dvec) */
762 * Response generated by CGI, blocker, or error handler
766 char *status; /**< HTTP status (string). */
767 struct list headers[1]; /**< List of header lines. */
768 char *head; /**< Formatted http response head. */
769 size_t head_length; /**< Length of http response head. */
770 char *body; /**< HTTP document body. */
771 size_t content_length; /**< Length of body, REQUIRED if binary body. */
772 int is_static; /**< Nonzero if the content will never change and
773 should be cached by the browser (e.g. images). */
781 /** The string which was parsed to produce this url_spec.
782 Used for debugging or display only. */
785 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
786 char **dvec; /**< List of pointers to the strings in dbuffer. */
787 int dcount; /**< How many parts to this domain? (length of dvec) */
788 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
790 int port; /**< The port number, or 0 to match all ports. */
792 char *path; /**< The source for the regex. */
793 int pathlen; /**< ==strlen(path). Needed for prefix matching. FIXME: Now obsolete? */
794 regex_t *preg; /**< Regex for matching path part */
798 * If you declare a static url_spec, this is the value to initialize it to zero.
800 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
803 * Constant for host part matching in URLs. If set, indicates that the start of
804 * the pattern must match the start of the URL. E.g. this is not set for the
805 * pattern ".example.com", so that it will match both "example.com" and
806 * "www.example.com". It is set for the pattern "example.com", which makes it
807 * match "example.com" only, not "www.example.com".
809 #define ANCHOR_LEFT 1
812 * Constant for host part matching in URLs. If set, indicates that the end of
813 * the pattern must match the end of the URL. E.g. this is not set for the
814 * pattern "ad.", so that it will match any host called "ad", irrespective
815 * of how many subdomains are in the fully-qualified domain name.
817 #define ANCHOR_RIGHT 2
821 * An I/O buffer. Holds a string which can be appended to, and can have data
822 * removed from the beginning.
826 char *buf; /**< Start of buffer */
827 char *cur; /**< Start of relevant data */
828 char *eod; /**< End of relevant data */
829 size_t size; /**< Size as malloc()ed */
834 * Return the number of bytes in the I/O buffer associated with the passed
835 * client_state pointer.
838 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
842 * Remove any data in the I/O buffer associated with the passed
843 * client_state pointer.
845 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
847 /* Bits for csp->content_type */
848 #define CT_TEXT 1 /**< csp->content_type bitmask:
849 Suitable for pcrs filtering. */
850 #define CT_GIF 2 /**< csp->content_type bitmask:
851 Suitable for GIF filtering. */
852 #define CT_TABOO 4 /**< csp->content_type bitmask:
853 DO NOT filter, irrespective of other flags. */
854 #define CT_JPEG 8 /**< csp->content_type bitmask:
855 Suitable for JPEG filtering. */
858 * The mask which includes all actions.
860 #define ACTION_MASK_ALL (~0UL)
863 * The most compatible set of actions - i.e. none.
865 #define ACTION_MOST_COMPATIBLE 0x00000000UL
867 /** Action bitmap: Block the request. */
868 #define ACTION_BLOCK 0x00000001UL
869 /** Action bitmap: Deanimate if it's a GIF. */
870 #define ACTION_DEANIMATE 0x00000002UL
871 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
872 #define ACTION_DOWNGRADE 0x00000004UL
873 /** Action bitmap: Fast redirects. */
874 #define ACTION_FAST_REDIRECTS 0x00000008UL
875 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
876 #define ACTION_HIDE_FORWARDED 0x00000010UL
877 /** Action bitmap: Hide "From" header. */
878 #define ACTION_HIDE_FROM 0x00000020UL
879 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
880 #define ACTION_HIDE_REFERER 0x00000040UL
881 /** Action bitmap: Hide "User-Agent" and similar headers. */
882 #define ACTION_HIDE_USER_AGENT 0x00000080UL
883 /** Action bitmap: This is an image. */
884 #define ACTION_IMAGE 0x00000100UL
885 /** Action bitmap: Sets the image blocker. */
886 #define ACTION_IMAGE_BLOCKER 0x00000200UL
887 /** Action bitmap: Prevent compression. */
888 #define ACTION_NO_COMPRESSION 0x00000400UL
889 /** Action bitmap: Change cookies to session only cookies. */
890 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
891 /** Action bitmap: Block rending cookies. */
892 #define ACTION_NO_COOKIE_READ 0x00001000UL
893 /** Action bitmap: Block setting cookies. */
894 #define ACTION_NO_COOKIE_SET 0x00002000UL
895 /** Action bitmap: Filter out popups. */
896 #define ACTION_NO_POPUPS 0x00004000UL
897 /** Action bitmap: Send a vanilla wafer. */
898 #define ACTION_VANILLA_WAFER 0x00008000UL
899 /** Action bitmap: Limit CONNECT requests to safe ports. */
900 #define ACTION_LIMIT_CONNECT 0x00010000UL
901 /** Action bitmap: Inspect if it's a JPEG. */
902 #define ACTION_JPEG_INSPECT 0x00020000UL
903 /** Action bitmap: Crunch or modify "if-modified-since" header. */
904 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
905 /** Action bitmap: Overwrite Content-Type header. */
906 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
907 /** Action bitmap: Crunch specified server header. */
908 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
909 /** Action bitmap: Crunch specified client header */
910 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
911 /** Action bitmap: Enable text mode by force */
912 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
913 /** Action bitmap: Enable text mode by force */
914 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
915 /** Action bitmap: Enable content-dispostion crunching */
916 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
917 /** Action bitmap: Replace or block Last-Modified header */
918 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
919 /** Action bitmap: Replace or block Accept-Language header */
920 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
921 /** Action bitmap: Block as empty document */
922 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x08000000UL
923 /** Action bitmap: Redirect request. */
924 #define ACTION_REDIRECT 0x10000000UL
925 /** Action bitmap: Answer blocked Connects verbosely */
926 #define ACTION_TREAT_FORBIDDEN_CONNECTS_LIKE_BLOCKS 0x20000000UL
927 /** Action bitmap: Filter server headers with pcre */
928 #define ACTION_FILTER_SERVER_HEADERS 0x40000000UL
929 /** Action bitmap: Filter client headers with pcre */
930 #define ACTION_FILTER_CLIENT_HEADERS 0x80000000UL
933 /** Action string index: How to deanimate GIFs */
934 #define ACTION_STRING_DEANIMATE 0
935 /** Action string index: Replacement for "From:" header */
936 #define ACTION_STRING_FROM 1
937 /** Action string index: How to block images */
938 #define ACTION_STRING_IMAGE_BLOCKER 2
939 /** Action string index: Replacement for "Referer:" header */
940 #define ACTION_STRING_REFERER 3
941 /** Action string index: Replacement for "User-Agent:" header */
942 #define ACTION_STRING_USER_AGENT 4
943 /** Action string index: Legal CONNECT ports. */
944 #define ACTION_STRING_LIMIT_CONNECT 5
945 /** Action string index: Server headers containing this pattern are crunched*/
946 #define ACTION_STRING_SERVER_HEADER 6
947 /** Action string index: Client headers containing this pattern are crunched*/
948 #define ACTION_STRING_CLIENT_HEADER 7
949 /** Action string index: Replacement for the "Accept-Language:" header*/
950 #define ACTION_STRING_LANGUAGE 8
951 /** Action string index: Replacement for the "Content-Type:" header*/
952 #define ACTION_STRING_CONTENT_TYPE 9
953 /** Action string index: Replacement for the "content-dispostion:" header*/
954 #define ACTION_STRING_CONTENT_DISPOSITION 10
955 /** Action string index: Replacement for the "If-Modified-Since:" header*/
956 #define ACTION_STRING_IF_MODIFIED_SINCE 11
957 /** Action string index: Replacement for the "Last-Modified:" header. */
958 #define ACTION_STRING_LAST_MODIFIED 12
959 /** Action string index: Redirect URL */
960 #define ACTION_STRING_REDIRECT 13
961 /** Action string index: Decode before redirect? */
962 #define ACTION_STRING_FAST_REDIRECTS 14
963 /** Number of string actions. */
964 #define ACTION_STRING_COUNT 15
967 /*To make the ugly hack in sed easier to understand*/
968 #define CHECK_EVERY_HEADER_REMAINING 0
971 /** Index into current_action_spec::multi[] for headers to add. */
972 #define ACTION_MULTI_ADD_HEADER 0
973 /** Index into current_action_spec::multi[] for headers to add. */
974 #define ACTION_MULTI_WAFER 1
975 /** Index into current_action_spec::multi[] for filters to apply. */
976 #define ACTION_MULTI_FILTER 2
977 /** Number of multi-string actions. */
978 #define ACTION_MULTI_COUNT 3
982 * This structure contains a list of actions to apply to a URL.
983 * It only contains positive instructions - no "-" options.
984 * It is not used to store the actions list itself, only for
985 * url_actions() to return the current values.
987 struct current_action_spec
989 /** Actions to apply. A bit set to "1" means perform the action. */
993 * Paramaters for those actions that require them.
994 * Each entry is valid if & only if the corresponding entry in "flags" is
997 char * string[ACTION_STRING_COUNT];
999 /** Lists of strings for multi-string actions. */
1000 struct list multi[ACTION_MULTI_COUNT][1];
1005 * This structure contains a set of changes to actions.
1006 * It can contain both positive and negative instructions.
1007 * It is used to store an entry in the actions list.
1011 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1012 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
1015 * Paramaters for those actions that require them.
1016 * Each entry is valid if & only if the corresponding entry in "flags" is
1019 char * string[ACTION_STRING_COUNT];
1021 /** Lists of strings to remove, for multi-string actions. */
1022 struct list multi_remove[ACTION_MULTI_COUNT][1];
1024 /** If nonzero, remove *all* strings from the multi-string action. */
1025 int multi_remove_all[ACTION_MULTI_COUNT];
1027 /** Lists of strings to add, for multi-string actions. */
1028 struct list multi_add[ACTION_MULTI_COUNT][1];
1033 * This structure is used to store the actions list.
1035 * It contains a URL pattern, and the chages to the actions.
1036 * It is a linked list.
1040 struct url_spec url[1]; /**< URL pattern. */
1042 struct action_spec action[1]; /**< Actions. */
1044 struct url_actions * next; /**< Next action in file, or NULL. */
1049 * Flags for use in csp->flags
1053 * Flag for csp->flags: Set if this client is processing data.
1054 * Cleared when the thread associated with this structure dies.
1056 #define CSP_FLAG_ACTIVE 0x01
1059 * Flag for csp->flags: Set if the server's reply is in "chunked"
1062 #define CSP_FLAG_CHUNKED 0x02
1065 * Flag for csp->flags: Set if this request was enforced, although it would
1066 * normally have been blocked.
1068 #define CSP_FLAG_FORCED 0x04
1071 * Flag for csp->flags: Set if any modification to the body was done.
1073 #define CSP_FLAG_MODIFIED 0x08
1076 * Flag for csp->flags: Set if request was blocked.
1078 #define CSP_FLAG_REJECTED 0x10
1081 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1083 #define CSP_FLAG_TOGGLED_ON 0x20
1087 * Flags for use in return codes of child processes
1091 * Flag for process return code: Set if exiting porcess has been toggled
1092 * during its lifetime.
1094 #define RC_FLAG_TOGGLED 0x10
1097 * Flag for process return code: Set if exiting porcess has blocked its
1100 #define RC_FLAG_BLOCKED 0x20
1103 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1106 #define MAX_AF_FILES 10
1109 * The state of a Privoxy processing thread.
1113 /** The proxy's configuration */
1114 struct configuration_spec * config;
1116 /** The actions to perform on the current request */
1117 struct current_action_spec action[1];
1119 /** socket to talk to client (web browser) */
1122 /** socket to talk to server (web server or proxy) */
1125 /** Multi-purpose flag container, see CSP_FLAG_* above */
1126 unsigned short int flags;
1128 /** Client PC's IP address, as reported by the accept() function.
1131 /** Client PC's IP address, as reported by the accept() function.
1135 /** Our IP address. I.e. the IP address that the client used to reach us,
1137 char *my_ip_addr_str;
1139 /** Our hostname. I.e. the reverse DNS of the IP address that the client
1140 used to reach us, as a string. */
1143 /** The URL that was requested */
1144 struct http_request http[1];
1146 /** An I/O buffer used for buffering data read from the network */
1149 /** List of all headers for this request */
1150 struct list headers[1];
1152 /** List of all cookies for this request */
1153 struct list cookie_list[1];
1155 /** MIME-Type key, see CT_* above */
1156 unsigned short int content_type;
1158 /** The "X-Forwarded-For:" header sent by the client */
1161 /** Actions files associated with this client */
1162 struct file_list *actions_list[MAX_AF_FILES];
1164 /** pcrs job files. */
1165 struct file_list *rlist[MAX_AF_FILES];
1167 /** Length after content modification. */
1168 size_t content_length;
1170 #ifdef FEATURE_TRUST
1173 struct file_list *tlist;
1175 #endif /* def FEATURE_TRUST */
1177 /** Next thread in linked list. Only read or modify from the main thread! */
1178 struct client_state *next;
1183 * A function to add a header
1185 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1188 * A function to process a header
1190 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1194 * List of functions to run on a list of headers
1198 /** The header prefix to match */
1201 /** The length of the prefix to match */
1204 /** The function to apply to this line */
1205 parser_func_ptr parser;
1210 * List of available CGI functions.
1212 struct cgi_dispatcher
1214 /** The URL of the CGI, relative to the CGI root. */
1215 const char * const name;
1217 /** The handler function for the CGI */
1218 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1220 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1221 const char * const description;
1223 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1229 * A data file used by Privoxy. Kept in a linked list.
1234 * This is a pointer to the data structures associated with the file.
1235 * Read-only once the structure has been created.
1240 * The unloader function.
1241 * Normally NULL. When we are finished with file (i.e. when we have
1242 * loaded a new one), set to a pointer to an unloader function.
1243 * Unloader will be called by sweep() (called from main loop) when
1244 * all clients using this file are done. This prevents threading
1247 void (*unloader)(void *);
1250 * Used internally by sweep(). Do not access from elsewhere.
1255 * File last-modified time, so we can check if file has been changed.
1256 * Read-only once the structure has been created.
1258 time_t lastmodified;
1261 * The full filename.
1266 * Pointer to next entry in the linked list of all "file_list"s.
1267 * This linked list is so that sweep() can navigate it.
1268 * Since sweep() can remove items from the list, we must be careful
1269 * to only access this value from main thread (when we know sweep
1270 * won't be running).
1272 struct file_list *next;
1276 #ifdef FEATURE_TRUST
1279 * The format of a trust file when loaded into memory.
1283 struct url_spec url[1]; /**< The URL pattern */
1284 int reject; /**< FIXME: Please document this! */
1285 struct block_spec *next; /**< Next entry in linked list */
1289 * Arbitrary limit for the number of trusted referrers
1290 * Privoxy can print in its blocking message.
1292 #define MAX_TRUSTED_REFERRERS 64
1294 #endif /* def FEATURE_TRUST */
1297 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1298 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1299 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1303 * How to forward a connection to a parent proxy.
1307 /** URL pattern that this forward_spec is for. */
1308 struct url_spec url[1];
1310 /** Connection type. Must be SOCKS_NONE, SOCKS_4, or SOCKS_4A. */
1313 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1316 /** SOCKS server port. */
1319 /** Parent HTTP proxy hostname, or NULL for none. */
1322 /** Parent HTTP proxy port. */
1325 /** Next entry in the linked list. */
1326 struct forward_spec *next;
1331 * Initializer for a static struct forward_spec.
1333 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1337 * This struct represents one filter (one block) from
1338 * the re_filterfile. If there is more than one filter
1339 * in the file, the file will be represented by a
1340 * chained list of re_filterfile specs.
1342 struct re_filterfile_spec
1344 char *name; /**< Name from FILTER: statement in re_filterfile. */
1345 char *description; /**< Description from FILTER: statement in re_filterfile. */
1346 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1347 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1348 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1354 #define ACL_PERMIT 1 /**< Accept connection request */
1355 #define ACL_DENY 2 /**< Reject connection request */
1358 * An IP address pattern. Used to specify networks in the ACL.
1360 struct access_control_addr
1362 unsigned long addr; /**< The IP address as an integer. */
1363 unsigned long mask; /**< The network mask as an integer. */
1364 unsigned long port; /**< The port number. */
1368 * An access control list (ACL) entry.
1370 * This is a linked list.
1372 struct access_control_list
1374 struct access_control_addr src[1]; /**< Client IP address */
1375 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1377 short action; /**< ACL_PERMIT or ACL_DENY */
1378 struct access_control_list *next; /**< The next entry in the ACL. */
1381 #endif /* def FEATURE_ACL */
1384 /** Maximum number of loaders (actions, re_filter, ...) */
1388 /** configuration_spec::feature_flags: CGI actions editor. */
1389 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1391 /** configuration_spec::feature_flags: Web-based toggle. */
1392 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1396 * Data loaded from the configuration file.
1398 * (Anomaly: toggle is still handled through a global, not this structure)
1400 struct configuration_spec
1405 /** Nonzero to enable multithreading. */
1408 /** Number of retries in case a forwarded connection attempt fails */
1409 int forwarded_connect_retries;
1412 * Bitmask of features that can be enabled/disabled through the config
1413 * file. Currently defined bits:
1415 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1416 * - RUNTIME_FEATURE_CGI_TOGGLE
1418 unsigned feature_flags;
1420 /** The log file name. */
1421 const char *logfile;
1423 /** The config file directory. */
1424 const char *confdir;
1426 /** The log file directory. */
1429 /** The full paths to the actions files. */
1430 const char *actions_file[MAX_AF_FILES];
1432 /** The short names of the actions files. */
1433 const char *actions_file_short[MAX_AF_FILES];
1435 /** The administrator's email address */
1436 char *admin_address;
1438 /** A URL with info on this proxy */
1439 char *proxy_info_url;
1441 /** URL to the user manual (on our website or local copy) */
1444 /** The file names of the pcre filter files. */
1445 const char *re_filterfile[MAX_AF_FILES];
1447 /** The short names of the pcre filter files. */
1448 const char *re_filterfile_short[MAX_AF_FILES];
1450 #ifdef FEATURE_COOKIE_JAR
1452 /** The file name of the cookie jar file */
1453 const char * jarfile;
1455 /** The handle to the cookie jar file */
1458 #endif /* def FEATURE_COOKIE_JAR */
1460 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1463 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1466 /** Size limit for IOB */
1467 size_t buffer_limit;
1469 #ifdef FEATURE_TRUST
1471 /** The file name of the trust file. */
1472 const char * trustfile;
1474 /** FIXME: DOCME: Document this. */
1475 struct list trust_info[1];
1477 /** FIXME: DOCME: Document this. */
1478 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1480 #endif /* def FEATURE_TRUST */
1484 /** The access control list (ACL). */
1485 struct access_control_list *acl;
1487 #endif /* def FEATURE_ACL */
1489 /** Information about parent proxies (forwarding). */
1490 struct forward_spec *forward;
1492 /** All options from the config file, HTML-formatted. */
1495 /** The configuration file object. */
1496 struct file_list *config_file_list;
1498 /** List of loaders */
1499 int (*loaders[NLOADERS])(struct client_state *);
1501 /** Nonzero if we need to bind() to the new port. */
1505 /** Calculates the number of elements in an array, using sizeof. */
1506 #define SZ(X) (sizeof(X) / sizeof(*X))
1508 #ifdef FEATURE_FORCE_LOAD
1509 /** The force load URL prefix. */
1510 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1511 #endif /* def FEATURE_FORCE_LOAD */
1513 #ifdef FEATURE_NO_GIFS
1514 /** The MIME type for images ("image/png" or "image/gif"). */
1515 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1517 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1518 #endif /* def FEATURE_NO_GIFS */
1525 /** URL for the Privoxy home page. */
1526 #define HOME_PAGE_URL "http://www.privoxy.org/"
1528 /** URL for the Privoxy user manual. */
1529 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1531 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1532 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1534 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1535 #define CONFIG_HELP_PREFIX "config.html#"
1538 * The "hosts" to intercept and display CGI pages.
1539 * First one is a hostname only, second one can specify host and path.
1542 * 1) Do not specify the http: prefix
1543 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1544 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1546 #define CGI_SITE_1_HOST "p.p"
1547 #define CGI_SITE_2_HOST "config.privoxy.org"
1548 #define CGI_SITE_2_PATH ""
1551 * The prefix for CGI pages. Written out in generated HTML.
1552 * INCLUDES the trailing slash.
1554 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1559 * FIXME: This is very inefficient. There could be one copy of these strings
1560 * for each .c file!! They should be "extern", not "static".
1562 static const char CSUCCEED[] =
1563 "HTTP/1.0 200 Connection established\n"
1564 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1566 static const char CHEADER[] =
1567 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1569 static const char CFORBIDDEN[] =
1570 "HTTP/1.0 403 Connection not allowable\r\nX-Hint: If you read this message interactively, then you know why this happens ,-)\r\n\r\n";
1576 #endif /* ndef PROJECT_H_INCLUDED */