1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 2.3 2002/09/05 08:00:23 oes Exp $"
5 /*********************************************************************
7 * File : $Source: /cvsroot/ijbswa/current/src/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 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 2.3 2002/09/05 08:00:23 oes
41 * Synced with the stable branch:
42 * Revision 1.72.2.1 2002/08/10 11:25:18 oes
43 * - Include config.h for access to config data
44 * - Include <pcre*.h> depending on where they are
46 * Revision 2.2 2002/07/12 04:26:17 agotneja
47 * Re-factored 'chat()' to become understandable and maintainable as
48 * a first step in adding Transparent Proxy functionality.
50 * Added several new static functions in jcc.c, and moved some data
51 * parameters up into project.h to allow them to be passed between
54 * Revision 2.1 2002/06/04 16:35:56 jongfoster
55 * Moving three variable declarations to jcc.c from project.h
57 * Revision 2.0 2002/06/04 14:34:21 jongfoster
58 * Moving source files to src/
60 * Revision 1.72 2002/05/14 21:35:49 oes
61 * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
62 * because of split in user-manual
64 * Revision 1.71 2002/05/12 21:39:36 jongfoster
65 * - Adding Doxygen-style comments to structures and #defines.
67 * Revision 1.70 2002/05/12 16:05:50 jongfoster
68 * Fixing ACTION_MASK_ALL to be unsigned long rather than
69 * just unsigned int. I don't know if anyone is porting
70 * Privoxy to 16-bit platforms, but if so, +limit-connect
71 * wouldn't have worked because of this bug.
73 * Revision 1.69 2002/05/08 16:00:16 oes
74 * Added size member to struct iob, so it can
75 * be alloced larger than needed.
77 * Revision 1.68 2002/04/26 12:56:00 oes
78 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
80 * Revision 1.67 2002/04/24 02:12:43 oes
81 * - Jon's multiple AF patch:
82 * - Make csp->actions_list an array
83 * - #define MAX_ACTION_FILES
84 * - Moved CGI_PARAM_LEN_MAX (500) here
86 * Revision 1.66 2002/04/15 19:06:43 jongfoster
89 * Revision 1.65 2002/04/04 00:36:36 gliptak
90 * always use pcre for matching
92 * Revision 1.64 2002/04/03 22:28:03 gliptak
93 * Removed references to gnu_regex
95 * Revision 1.63 2002/03/31 17:19:00 jongfoster
96 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
98 * Revision 1.62 2002/03/26 22:48:49 swa
101 * Revision 1.61 2002/03/26 22:29:55 swa
102 * we have a new homepage!
104 * Revision 1.60 2002/03/24 15:52:17 jongfoster
105 * Changing CGI URL prefixes for new name
107 * Revision 1.59 2002/03/24 15:23:33 jongfoster
110 * Revision 1.58 2002/03/24 13:25:43 swa
111 * name change related issues
113 * Revision 1.57 2002/03/16 20:28:34 oes
114 * Added descriptions to the filters so users will know what they select in the cgi editor
116 * Revision 1.56 2002/03/13 20:27:30 oes
117 * Fixing bug with CT_TABOO
119 * Revision 1.55 2002/03/12 01:42:50 oes
120 * Introduced modular filters
122 * Revision 1.54 2002/03/09 20:03:52 jongfoster
123 * - Making various functions return int rather than size_t.
124 * (Undoing a recent change). Since size_t is unsigned on
125 * Windows, functions like read_socket that return -1 on
126 * error cannot return a size_t.
128 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
129 * crashes, and also frequently caused JB to jump to 100%
130 * CPU and stay there. (Because it thought it had just
131 * read ((unsigned)-1) == 4Gb of data...)
133 * - The signature of write_socket has changed, it now simply
134 * returns success=0/failure=nonzero.
136 * - Trying to get rid of a few warnings --with-debug on
137 * Windows, I've introduced a new type "jb_socket". This is
138 * used for the socket file descriptors. On Windows, this
139 * is SOCKET (a typedef for unsigned). Everywhere else, it's
140 * an int. The error value can't be -1 any more, so it's
141 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
142 * Windows it maps to the #define INVALID_SOCKET.)
144 * - The signature of bind_port has changed.
146 * Revision 1.53 2002/03/08 16:48:55 oes
147 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
149 * Revision 1.52 2002/03/07 03:46:17 oes
150 * Fixed compiler warnings
152 * Revision 1.51 2002/03/05 04:52:42 oes
153 * Deleted non-errlog debugging code
155 * Revision 1.50 2002/03/04 19:32:07 oes
156 * Changed default port to 8118
158 * Revision 1.49 2002/03/04 18:28:55 oes
159 * Deleted PID_FILE_NAME
161 * Revision 1.48 2002/03/03 14:50:40 oes
162 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
164 * Revision 1.47 2002/02/20 23:15:13 jongfoster
165 * Parsing functions now handle out-of-memory gracefully by returning
168 * Revision 1.46 2002/01/17 21:06:09 jongfoster
169 * Now #defining the URLs of the config interface
171 * Minor changes to struct http_request and struct url_spec due to
172 * standardizing that struct http_request is used to represent a URL, and
173 * struct url_spec is used to represent a URL pattern. (Before, URLs were
174 * represented as seperate variables and a partially-filled-in url_spec).
176 * Revision 1.45 2002/01/09 14:33:27 oes
177 * Added HOSTENT_BUFFER_SIZE
179 * Revision 1.44 2001/12/30 14:07:32 steudten
180 * - Add signal handling (unix)
181 * - Add SIGHUP handler (unix)
182 * - Add creation of pidfile (unix)
183 * - Add action 'top' in rc file (RH)
184 * - Add entry 'SIGNALS' to manpage
185 * - Add exit message to logfile (unix)
187 * Revision 1.43 2001/11/22 21:57:51 jongfoster
188 * Making action_spec->flags into an unsigned long rather than just an
190 * Adding ACTION_NO_COOKIE_KEEP
192 * Revision 1.42 2001/11/05 21:42:41 steudten
193 * Include DBG() macro.
195 * Revision 1.41 2001/10/28 19:12:06 jongfoster
196 * Adding ijb_toupper()
198 * Revision 1.40 2001/10/26 17:40:47 oes
199 * Moved ijb_isspace and ijb_tolower to project.h
200 * Removed http->user_agent, csp->referrer and csp->accept_types
202 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
203 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
204 * macro when called with a cast; so moving the cast to the macro def'n
205 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
206 * doesn't make macro expansion complain. Hope this works for everyone else
209 * Revision 1.38 2001/10/23 21:19:04 jongfoster
210 * New error-handling support: jb_err type and JB_ERR_xxx constants
211 * CGI functions now return a jb_err, and their parameters map is const.
212 * Support for RUNTIME_FEATUREs to enable/disable config editor
213 * Adding a few comments
215 * Revision 1.37 2001/10/14 22:14:01 jongfoster
216 * Removing name_length field from struct cgi_dispatcher, as this is
217 * now calculated at runtime from the "name" field.
219 * Revision 1.36 2001/10/10 16:45:15 oes
220 * Added LIMIT_CONNECT action and string
221 * Fixed HTTP message line termination
222 * Added CFORBIDDEN HTTP message
224 * Revision 1.35 2001/10/07 18:06:43 oes
225 * Added status member to struct http_request
227 * Revision 1.34 2001/10/07 15:45:25 oes
228 * Added url member to struct http_request and commented all
233 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
235 * Replaced struct client_state members rejected,
236 * force, active and toggled_on with "flags" bitmap.
238 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
240 * Added buffer_limit to struct configuration_spec
242 * Revision 1.33 2001/09/20 13:30:08 steudten
244 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
245 * Last case will set z to NULL in free(z) and thats bad..
247 * Revision 1.32 2001/09/16 23:02:51 jongfoster
250 * Revision 1.31 2001/09/16 13:20:29 jongfoster
251 * Rewrite of list library. Now has seperate header and list_entry
252 * structures. Also added a large sprinking of assert()s to the list
255 * Revision 1.30 2001/09/13 23:52:00 jongfoster
256 * Support for both static and dynamically generated CGI pages
258 * Revision 1.29 2001/09/13 23:29:43 jongfoster
259 * Defining FORWARD_SPEC_INITIALIZER
261 * Revision 1.28 2001/09/13 23:05:50 jongfoster
262 * Changing the string paramater to the header parsers a "const".
264 * Revision 1.27 2001/08/05 16:06:20 jongfoster
265 * Modifiying "struct map" so that there are now separate header and
266 * "map_entry" structures. This means that functions which modify a
267 * map no longer need to return a pointer to the modified map.
268 * Also, it no longer reverses the order of the entries (which may be
269 * important with some advanced template substitutions).
271 * Revision 1.26 2001/07/30 22:08:36 jongfoster
272 * Tidying up #defines:
273 * - All feature #defines are now of the form FEATURE_xxx
274 * - Permanently turned off WIN_GUI_EDIT
275 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
277 * Revision 1.25 2001/07/29 18:43:08 jongfoster
278 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
281 * Revision 1.24 2001/07/25 17:20:27 oes
282 * Introduced http->user_agent
284 * Revision 1.23 2001/07/18 12:32:23 oes
285 * - Added ACTION_STRING_DEANIMATE
286 * - moved #define freez from jcc.h to project.h
288 * Revision 1.22 2001/07/15 17:51:41 jongfoster
289 * Renaming #define STATIC to STATIC_PCRE
291 * Revision 1.21 2001/07/13 14:03:19 oes
292 * - Reorganized regex header inclusion and #defines to
293 * comply to the scheme in configure.in
294 * - Added csp->content_type and its CT_* keys
295 * - Added ACTION_DEANIMATE
296 * - Removed all #ifdef PCRS
298 * Revision 1.20 2001/06/29 21:45:41 oes
299 * Indentation, CRLF->LF, Tab-> Space
301 * Revision 1.19 2001/06/29 13:33:36 oes
302 * - Improved comments
303 * - Introduced http_request.host_ip_addr_str
304 * - Introduced http_response.head_length
305 * - Introduced config.my_ip_addr_str, config.my_hostname,
306 * config.admin_address and config.proxy_info_url
307 * - Removed config.proxy_args_header and config.proxy_args_trailer,
308 * renamed config.proxy_args_invocation to config.proxy_args
309 * - Removed HTML snipplets and GIFs
310 * - Removed logentry from cancelled commit
312 * Revision 1.18 2001/06/09 10:57:39 jongfoster
313 * Adding definition of BUFFER_SIZE.
314 * Changing struct cgi_dispatcher to use "const" strings.
316 * Revision 1.17 2001/06/07 23:15:09 jongfoster
317 * Merging ACL and forward files into config file.
318 * Moving struct gateway members into struct forward_spec
319 * Removing config->proxy_args_gateways
320 * Cosmetic: Adding a few comments
322 * Revision 1.16 2001/06/04 18:31:58 swa
323 * files are now prefixed with either `confdir' or `logdir'.
324 * `make redhat-dist' replaces both entries confdir and logdir
327 * Revision 1.15 2001/06/04 11:28:53 swa
328 * redirect did not work due to missing /
330 * Revision 1.14 2001/06/03 11:03:48 oes
332 * added struct http_response,
333 * changed struct interceptors to struct cgi_dispatcher,
334 * moved HTML stuff to cgi.h
336 * Revision 1.13 2001/06/01 20:05:36 jongfoster
337 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
338 * constant, and removed csp->tinygif.
340 * Revision 1.12 2001/06/01 18:49:17 jongfoster
341 * Replaced "list_share" with "list" - the tiny memory gain was not
342 * worth the extra complexity.
344 * Revision 1.11 2001/06/01 10:32:47 oes
345 * Added constants for anchoring selection bitmap
347 * Revision 1.10 2001/05/31 21:33:53 jongfoster
348 * Changes for new actions file, replacing permissionsfile
349 * and parts of the config file. Also added support for
352 * Revision 1.9 2001/05/31 17:32:31 oes
354 * - Enhanced domain part globbing with infix and prefix asterisk
355 * matching and optional unanchored operation
357 * Revision 1.8 2001/05/29 20:09:15 joergs
358 * HTTP_REDIRECT_TEMPLATE fixed.
360 * Revision 1.7 2001/05/29 09:50:24 jongfoster
361 * Unified blocklist/imagelist/actionslist.
362 * File format is still under discussion, but the internal changes
365 * Also modified interceptor behaviour:
366 * - We now intercept all URLs beginning with one of the following
367 * prefixes (and *only* these prefixes):
369 * * http://ijbswa.sf.net/config/
370 * * http://ijbswa.sourceforge.net/config/
371 * - New interceptors "home page" - go to http://i.j.b/ to see it.
372 * - Internal changes so that intercepted and fast redirect pages
373 * are not replaced with an image.
374 * - Interceptors now have the option to send a binary page direct
375 * to the client. (i.e. ijb-send-banner uses this)
376 * - Implemented show-url-info interceptor. (Which is why I needed
377 * the above interceptors changes - a typical URL is
378 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
379 * The previous mechanism would not have intercepted that, and
380 * if it had been intercepted then it then it would have replaced
383 * Revision 1.6 2001/05/27 22:17:04 oes
385 * - re_process_buffer no longer writes the modified buffer
386 * to the client, which was very ugly. It now returns the
387 * buffer, which it is then written by chat.
389 * - content_length now adjusts the Content-Length: header
390 * for modified documents rather than crunch()ing it.
391 * (Length info in csp->content_length, which is 0 for
392 * unmodified documents)
394 * - For this to work, sed() is called twice when filtering.
396 * Revision 1.5 2001/05/26 00:28:36 jongfoster
397 * Automatic reloading of config file.
398 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
399 * Most of the global variables have been moved to a new
400 * struct configuration_spec, accessed through csp->config->globalname
401 * Most of the globals remaining are used by the Win32 GUI.
403 * Revision 1.4 2001/05/22 18:46:04 oes
405 * - Enabled filtering banners by size rather than URL
406 * by adding patterns that replace all standard banner
407 * sizes with the "Junkbuster" gif to the re_filterfile
409 * - Enabled filtering WebBugs by providing a pattern
410 * which kills all 1x1 images
412 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
413 * which is selected by the (nonstandard and therefore
414 * capital) letter 'U' in the option string.
415 * It causes the quantifiers to be ungreedy by default.
416 * Appending a ? turns back to greedy (!).
418 * - Added a new interceptor ijb-send-banner, which
419 * sends back the "Junkbuster" gif. Without imagelist or
420 * MSIE detection support, or if tinygif = 1, or the
421 * URL isn't recognized as an imageurl, a lame HTML
422 * explanation is sent instead.
424 * - Added new feature, which permits blocking remote
425 * script redirects and firing back a local redirect
427 * The feature is conditionally compiled, i.e. it
428 * can be disabled with --disable-fast-redirects,
429 * plus it must be activated by a "fast-redirects"
430 * line in the config file, has its own log level
431 * and of course wants to be displayed by show-proxy-args
432 * Note: Boy, all the #ifdefs in 1001 locations and
433 * all the fumbling with configure.in and acconfig.h
434 * were *way* more work than the feature itself :-(
436 * - Because a generic redirect template was needed for
437 * this, tinygif = 3 now uses the same.
439 * - Moved GIFs, and other static HTTP response templates
444 * - Removed some >400 CRs again (Jon, you really worked
447 * Revision 1.3 2001/05/20 01:21:20 jongfoster
448 * Version 2.9.4 checkin.
449 * - Merged popupfile and cookiefile, and added control over PCRS
450 * filtering, in new "actionsfile".
451 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
452 * file error you now get a message box (in the Win32 GUI) rather
453 * than the program exiting with no explanation.
454 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
456 * - Removed tabs from "config"
457 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
458 * - Bumped up version number.
460 * Revision 1.2 2001/05/17 23:01:01 oes
461 * - Cleaned CRLF's from the sources and related files
463 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
464 * Initial import of version 2.9.3 source tree
467 *********************************************************************/
470 /* Declare struct FILE for vars and funcs. */
473 /* Need time_t for file_list */
475 /* Needed for pcre choice */
479 * Include appropriate regular expression libraries.
480 * Note that pcrs and pcre (native) are needed for cgi
481 * and are included anyway.
487 # ifdef PCRE_H_IN_SUBDIR
488 # include <pcre/pcre.h>
501 # include "pcreposix.h"
503 # ifdef PCRE_H_IN_SUBDIR
504 # include <pcre/pcreposix.h>
506 # include <pcreposix.h>
512 #endif /* def AMIGA */
516 * I don't want to have to #include all this just for the declaration
517 * of SOCKET. However, it looks like we have to...
532 typedef SOCKET jb_socket;
534 #define JB_INVALID_SOCKET INVALID_SOCKET
536 #else /* ndef _WIN32 */
539 * The type used by sockets. On UNIX it's an int. Microsoft decided to
540 * make it an unsigned.
542 typedef int jb_socket;
545 * The error value used for variables of type jb_socket. On UNIX this
546 * is -1, however Microsoft decided to make socket handles unsigned, so
547 * they use a different value.
550 #define JB_INVALID_SOCKET (-1)
552 #endif /* ndef _WIN32 */
556 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
561 #define JB_ERR_GENERIC -1 /* General error return value */
562 #define JB_ERR_OK 0 /**< Success, no error */
563 #define JB_ERR_MEMORY 1 /**< Out of memory */
564 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
565 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
566 #define JB_ERR_PARSE 4 /**< Error parsing file */
567 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
568 CGI actions editor. */
569 #define JB_ERR_INTERCEPT 6 /* This page should be intercepted */
572 * This macro is used to free a pointer that may be NULL.
573 * It also sets the variable to NULL after it's been freed.
574 * The paramater should be a simple variable without side effects.
576 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
580 * Fix a problem with Solaris. There should be no effect on other
583 * Solaris's isspace() is a macro which uses it's argument directly
584 * as an array index. Therefore we need to make sure that high-bit
585 * characters generate +ve values, and ideally we also want to make
586 * the argument match the declared parameter type of "int".
588 * Note: Remember to #include <ctype.h> if you use these macros.
590 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
591 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
592 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
595 * Use for statically allocated buffers if you have no other choice.
596 * Remember to check the length of what you write into the buffer
597 * - we don't want any buffer overflows!
599 #define BUFFER_SIZE 5000
602 * Max length of CGI parameters (arbitrary limit).
604 #define CGI_PARAM_LEN_MAX 500
607 * Buffer size for capturing struct hostent data in the
608 * gethostby(name|addr)_r library calls. Since we don't
609 * loop over gethostbyname_r, the buffer must be sufficient
610 * to accomodate multiple IN A RRs, as used in DNS round robin
611 * load balancing. W3C's wwwlib uses 1K, so that should be
612 * good enough for us, too.
614 #define HOSTENT_BUFFER_SIZE 1024
617 * Do not use. Originally this was so that you can
618 * say "while (FOREVER) { ...do something... }".
619 * However, this gives a warning with some compilers (e.g. VC++).
620 * Instead, use "for (;;) { ...do something... }".
625 * Default IP address to listen on, as a string.
626 * Set to "127.0.0.1".
628 #define HADDR_DEFAULT "127.0.0.1"
631 * Default port to listen on, as a number.
634 #define HADDR_PORT 8118
637 /* Forward def for struct client_state */
638 struct configuration_spec;
642 * Entry in a linked list of strings.
647 * The string. The "const" is only to discourage modification,
648 * you can actually change it if you *really* want to.
649 * You can even freez() it and replace it with another
650 * malloc()d string. If you replace it with NULL, the list
651 * functions will work, just be careful next time you iterate
652 * through the list in your own code.
654 * FIXME: Should we remove the "const"?
658 /** Next entry in the linked list, or NULL if no more. */
659 struct list_entry *next;
663 * A header for a linked list of strings.
667 /** First entry in the list, or NULL if the list is empty. */
668 struct list_entry *first;
670 /** Last entry in the list, or NULL if the list is empty. */
671 struct list_entry *last;
676 * An entry in a map. This is a name=value pair.
680 /** The key for the map. */
682 /** The value associated with that key. */
684 /** The next map entry, or NULL if none. */
685 struct map_entry *next;
689 * A map from a string to another string.
690 * This is used for the paramaters passed in a HTTP GET request, and
691 * to store the exports when the CGI interface is filling in a template.
695 /** The first map entry, or NULL if the map is empty. */
696 struct map_entry *first;
697 /** The last map entry, or NULL if the map is empty. */
698 struct map_entry *last;
703 * A HTTP request. This includes the method (GET, POST) and
706 * This is also used whenever we want to match a URL against a
707 * URL pattern. This always contains the URL to match, and never
708 * a URL pattern. (See struct url_spec).
712 char *cmd; /**< Whole command line: method, URL, Version */
713 char *ocmd; /**< Backup of original cmd for CLF logging */
714 char *gpc; /**< HTTP method: GET, POST, ... */
715 char *url; /**< The URL */
716 char *ver; /**< Protocol version */
717 int status; /**< HTTP Status */
719 char *host; /**< Host part of URL */
720 int port; /**< Port of URL or 80 (default) */
721 char *path; /**< Path of URL */
722 char *hostport; /**< host[:port] */
723 int ssl; /**< Flag if protocol is https */
725 char *host_ip_addr_str; /**< String with dotted decimal representation
726 of host's IP. NULL before connect_to() */
728 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
729 char **dvec; /**< List of pointers to the strings in dbuffer. */
730 int dcount; /**< How many parts to this domain? (length of dvec) */
732 const struct forward_spec *fwd ;
738 * Response generated by CGI, blocker, or error handler
742 char *status; /**< HTTP status (string). */
743 struct list headers[1]; /**< List of header lines. */
744 char *head; /**< Formatted http response head. */
745 size_t head_length; /**< Length of http response head. */
746 char *body; /**< HTTP document body. */
747 size_t content_length; /**< Length of body, REQUIRED if binary body. */
748 int is_static; /**< Nonzero if the content will never change and
749 should be cached by the browser (e.g. images). */
757 /** The string which was parsed to produce this url_spec.
758 Used for debugging or display only. */
761 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
762 char **dvec; /**< List of pointers to the strings in dbuffer. */
763 int dcount; /**< How many parts to this domain? (length of dvec) */
764 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
766 int port; /**< The port number, or 0 to match all ports. */
768 char *path; /**< The source for the regex. */
769 int pathlen; /**< ==strlen(path). Needed for prefix matching. FIXME: Now obsolete? */
770 regex_t *preg; /**< Regex for matching path part */
774 * If you declare a static url_spec, this is the value to initialize it to zero.
776 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
779 * Constant for host part matching in URLs. If set, indicates that the start of
780 * the pattern must match the start of the URL. E.g. this is not set for the
781 * pattern ".example.com", so that it will match both "example.com" and
782 * "www.example.com". It is set for the pattern "example.com", which makes it
783 * match "example.com" only, not "www.example.com".
785 #define ANCHOR_LEFT 1
788 * Constant for host part matching in URLs. If set, indicates that the end of
789 * the pattern must match the end of the URL. E.g. this is not set for the
790 * pattern "ad.", so that it will match any host called "ad", irrespective
791 * of how many subdomains are in the fully-qualified domain name.
793 #define ANCHOR_RIGHT 2
797 * An I/O buffer. Holds a string which can be appended to, and can have data
798 * removed from the beginning.
802 char *buf; /**< Start of buffer */
803 char *cur; /**< Start of relevant data */
804 char *eod; /**< End of relevant data */
805 size_t size; /**< Size as malloc()ed */
810 * Return the number of bytes in the I/O buffer associated with the passed
811 * client_state pointer.
814 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
818 * Remove any data in the I/O buffer associated with the passed
819 * client_state pointer.
821 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
823 /* Bits for csp->content_type */
824 #define CT_TEXT 1 /**< csp->content_type bitmask:
825 Suitable for pcrs filtering. */
826 #define CT_GIF 2 /**< csp->content_type bitmask:
827 Suitable for GIF filtering. */
828 #define CT_TABOO 4 /**< csp->content_type bitmask:
829 DO NOT filter, irrespective of other flags. */
832 * The mask which includes all actions.
834 #define ACTION_MASK_ALL (~0UL)
837 * The most compatible set of actions - i.e. none.
839 #define ACTION_MOST_COMPATIBLE 0x00000000UL
841 /** Action bitmap: Block the request. */
842 #define ACTION_BLOCK 0x00000001UL
843 /** Action bitmap: Deanimate if it's a GIF. */
844 #define ACTION_DEANIMATE 0x00000002UL
845 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
846 #define ACTION_DOWNGRADE 0x00000004UL
847 /** Action bitmap: Fast redirects. */
848 #define ACTION_FAST_REDIRECTS 0x00000008UL
849 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
850 #define ACTION_HIDE_FORWARDED 0x00000010UL
851 /** Action bitmap: Hide "From" header. */
852 #define ACTION_HIDE_FROM 0x00000020UL
853 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
854 #define ACTION_HIDE_REFERER 0x00000040UL
855 /** Action bitmap: Hide "User-Agent" and similar headers. */
856 #define ACTION_HIDE_USER_AGENT 0x00000080UL
857 /** Action bitmap: This is an image. */
858 #define ACTION_IMAGE 0x00000100UL
859 /** Action bitmap: Sets the image blocker. */
860 #define ACTION_IMAGE_BLOCKER 0x00000200UL
861 /** Action bitmap: Prevent compression. */
862 #define ACTION_NO_COMPRESSION 0x00000400UL
863 /** Action bitmap: Change cookies to session only cookies. */
864 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
865 /** Action bitmap: Block rending cookies. */
866 #define ACTION_NO_COOKIE_READ 0x00001000UL
867 /** Action bitmap: Block setting cookies. */
868 #define ACTION_NO_COOKIE_SET 0x00002000UL
869 /** Action bitmap: Filter out popups. */
870 #define ACTION_NO_POPUPS 0x00004000UL
871 /** Action bitmap: Send a vanilla wafer. */
872 #define ACTION_VANILLA_WAFER 0x00008000UL
873 /** Action bitmap: Limit CONNECT requests to safe ports. */
874 #define ACTION_LIMIT_CONNECT 0x00010000UL
876 /** Action string index: How to deanimate GIFs */
877 #define ACTION_STRING_DEANIMATE 0
878 /** Action string index: Replacement for "From:" header */
879 #define ACTION_STRING_FROM 1
880 /** Action string index: How to block images */
881 #define ACTION_STRING_IMAGE_BLOCKER 2
882 /** Action string index: Replacement for "Referer:" header */
883 #define ACTION_STRING_REFERER 3
884 /** Action string index: Replacement for "User-Agent:" header */
885 #define ACTION_STRING_USER_AGENT 4
886 /** Action string index: Legal CONNECT ports. */
887 #define ACTION_STRING_LIMIT_CONNECT 5
888 /** Number of string actions. */
889 #define ACTION_STRING_COUNT 6
891 /** Index into current_action_spec::multi[] for headers to add. */
892 #define ACTION_MULTI_ADD_HEADER 0
893 /** Index into current_action_spec::multi[] for headers to add. */
894 #define ACTION_MULTI_WAFER 1
895 /** Index into current_action_spec::multi[] for filters to apply. */
896 #define ACTION_MULTI_FILTER 2
897 /** Number of multi-string actions. */
898 #define ACTION_MULTI_COUNT 3
902 * This structure contains a list of actions to apply to a URL.
903 * It only contains positive instructions - no "-" options.
904 * It is not used to store the actions list itself, only for
905 * url_actions() to return the current values.
907 struct current_action_spec
909 /** Actions to apply. A bit set to "1" means perform the action. */
913 * Paramaters for those actions that require them.
914 * Each entry is valid if & only if the corresponding entry in "flags" is
917 char * string[ACTION_STRING_COUNT];
919 /** Lists of strings for multi-string actions. */
920 struct list multi[ACTION_MULTI_COUNT][1];
925 * This structure contains a set of changes to actions.
926 * It can contain both positive and negative instructions.
927 * It is used to store an entry in the actions list.
931 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
932 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
935 * Paramaters for those actions that require them.
936 * Each entry is valid if & only if the corresponding entry in "flags" is
939 char * string[ACTION_STRING_COUNT];
941 /** Lists of strings to remove, for multi-string actions. */
942 struct list multi_remove[ACTION_MULTI_COUNT][1];
944 /** If nonzero, remove *all* strings from the multi-string action. */
945 int multi_remove_all[ACTION_MULTI_COUNT];
947 /** Lists of strings to add, for multi-string actions. */
948 struct list multi_add[ACTION_MULTI_COUNT][1];
953 * This structure is used to store the actions list.
955 * It contains a URL pattern, and the chages to the actions.
956 * It is a linked list.
960 struct url_spec url[1]; /**< URL pattern. */
962 struct action_spec action[1]; /**< Actions. */
964 struct url_actions * next; /**< Next action in file, or NULL. */
969 * Flags for use in csp->flags
973 * Flag for csp->flags: Set if this client is processing data.
974 * Cleared when the thread associated with this structure dies.
976 #define CSP_FLAG_ACTIVE 0x01
979 * Flag for csp->flags: Set if the server's reply is in "chunked"
982 #define CSP_FLAG_CHUNKED 0x02
985 * Flag for csp->flags: Set if this request was enforced, although it would
986 * normally have been blocked.
988 #define CSP_FLAG_FORCED 0x04
991 * Flag for csp->flags: Set if any modification to the body was done.
993 #define CSP_FLAG_MODIFIED 0x08
996 * Flag for csp->flags: Set if request was blocked.
998 #define CSP_FLAG_REJECTED 0x10
1001 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1003 #define CSP_FLAG_TOGGLED_ON 0x20
1007 * Maximum number of actions files. This limit is arbitrary - it's just used
1010 #define MAX_ACTION_FILES 10
1013 * The state of a Privoxy processing thread.
1017 /** The proxy's configuration */
1018 struct configuration_spec * config;
1020 /** The actions to perform on the current request */
1021 struct current_action_spec action[1];
1023 /** socket to talk to client (web browser) */
1026 /** socket to talk to server (web server or proxy) */
1029 /** Multi-purpose flag container, see CSP_FLAG_* above */
1030 unsigned short int flags;
1032 /** Client PC's IP address, as reported by the accept() function.
1035 /** Client PC's IP address, as reported by the accept() function.
1039 /** Our IP address. I.e. the IP address that the client used to reach us,
1041 char *my_ip_addr_str;
1043 /** Our hostname. I.e. the reverse DNS of the IP address that the client
1044 used to reach us, as a string. */
1047 /** The URL that was requested */
1048 struct http_request http[1];
1050 /** An I/O buffer used for buffering data read from the network */
1053 /** List of all headers for this request */
1054 struct list headers[1];
1056 /** List of all cookies for this request */
1057 struct list cookie_list[1];
1059 /** MIME-Type key, see CT_* above */
1060 unsigned short int content_type;
1062 /** The "X-Forwarded-For:" header sent by the client */
1065 /** Actions files associated with this client */
1066 struct file_list *actions_list[MAX_ACTION_FILES];
1068 /** pcrs job file. */
1069 struct file_list *rlist;
1071 /** Length after content modification. */
1072 size_t content_length;
1074 #ifdef FEATURE_TRUST
1077 struct file_list *tlist;
1079 #endif /* def FEATURE_TRUST */
1081 /** Next thread in linked list. Only read or modify from the main thread! */
1082 struct client_state *next;
1084 char *(*content_filter)() ;
1085 int all_headers_read ;
1091 * A function to add a header
1093 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1096 * A function to process a header
1098 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1102 * List of functions to run on a list of headers
1106 /** The header prefix to match */
1109 /** The length of the prefix to match */
1112 /** The function to apply to this line */
1113 parser_func_ptr parser;
1118 * List of available CGI functions.
1120 struct cgi_dispatcher
1122 /** The URL of the CGI, relative to the CGI root. */
1123 const char * const name;
1125 /** The handler function for the CGI */
1126 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1128 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1129 const char * const description;
1134 * A data file used by Privoxy. Kept in a linked list.
1139 * This is a pointer to the data structures associated with the file.
1140 * Read-only once the structure has been created.
1145 * The unloader function.
1146 * Normally NULL. When we are finished with file (i.e. when we have
1147 * loaded a new one), set to a pointer to an unloader function.
1148 * Unloader will be called by sweep() (called from main loop) when
1149 * all clients using this file are done. This prevents threading
1152 void (*unloader)(void *);
1155 * Used internally by sweep(). Do not access from elsewhere.
1160 * File last-modified time, so we can check if file has been changed.
1161 * Read-only once the structure has been created.
1163 time_t lastmodified;
1166 * The full filename.
1171 * Pointer to next entry in the linked list of all "file_list"s.
1172 * This linked list is so that sweep() can navigate it.
1173 * Since sweep() can remove items from the list, we must be careful
1174 * to only access this value from main thread (when we know sweep
1175 * won't be running).
1177 struct file_list *next;
1181 #ifdef FEATURE_TRUST
1184 * The format of a trust file when loaded into memory.
1188 struct url_spec url[1]; /**< The URL pattern */
1189 int reject; /**< FIXME: Please document this! */
1190 struct block_spec *next; /**< Next entry in linked list */
1193 #endif /* def FEATURE_TRUST */
1196 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
1197 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
1198 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
1202 * How to forward a connection to a parent proxy.
1206 /** URL pattern that this forward_spec is for. */
1207 struct url_spec url[1];
1209 /** Connection type. Must be SOCKS_NONE, SOCKS_4, or SOCKS_4A. */
1212 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1215 /** SOCKS server port. */
1218 /** Parent HTTP proxy hostname, or NULL for none. */
1221 /** Parent HTTP proxy port. */
1224 /** Next entry in the linked list. */
1225 struct forward_spec *next;
1230 * Initializer for a static struct forward_spec.
1232 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1236 * This struct represents one filter (one block) from
1237 * the re_filterfile. If there is more than one filter
1238 * in the file, the file will be represented by a
1239 * chained list of re_filterfile specs.
1241 struct re_filterfile_spec
1243 char *name; /**< Name from FILTER: statement in re_filterfile. */
1244 char *description; /**< Description from FILTER: statement in re_filterfile. */
1245 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1246 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1247 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1253 #define ACL_PERMIT 1 /**< Accept connection request */
1254 #define ACL_DENY 2 /**< Reject connection request */
1257 * An IP address pattern. Used to specify networks in the ACL.
1259 struct access_control_addr
1261 unsigned long addr; /**< The IP address as an integer. */
1262 unsigned long mask; /**< The network mask as an integer. */
1263 unsigned long port; /**< The port number. */
1267 * An access control list (ACL) entry.
1269 * This is a linked list.
1271 struct access_control_list
1273 struct access_control_addr src[1]; /**< Client IP address */
1274 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1276 short action; /**< ACL_PERMIT or ACL_DENY */
1277 struct access_control_list *next; /**< The next entry in the ACL. */
1280 #endif /* def FEATURE_ACL */
1283 /** Maximum number of loaders (actions, re_filter, ...) */
1287 /** configuration_spec::feature_flags: CGI actions editor. */
1288 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1290 /** configuration_spec::feature_flags: Web-based toggle. */
1291 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1295 * Data loaded from the configuration file.
1297 * (Anomaly: toggle is still handled through a global, not this structure)
1299 struct configuration_spec
1304 /** Nonzero to enable multithreading. */
1308 * Bitmask of features that can be enabled/disabled through the config
1309 * file. Currently defined bits:
1311 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1312 * - RUNTIME_FEATURE_CGI_TOGGLE
1314 unsigned feature_flags;
1316 /** The log file name. */
1317 const char *logfile;
1319 /** The config file directory. */
1320 const char *confdir;
1322 /** The log file directory. */
1325 /** The full paths to the actions files. */
1326 const char *actions_file[MAX_ACTION_FILES];
1328 /** The short names of the actions files. */
1329 const char *actions_file_short[MAX_ACTION_FILES];
1331 /** The administrator's email address */
1332 char *admin_address;
1334 /** A URL with info on this proxy */
1335 char *proxy_info_url;
1337 /** URL to the user manual (on our website or local copy) */
1340 /** The file name of the pcre filter file */
1341 const char *re_filterfile;
1343 #ifdef FEATURE_COOKIE_JAR
1345 /** The file name of the cookie jar file */
1346 const char * jarfile;
1348 /** The handle to the cookie jar file */
1351 #endif /* def FEATURE_COOKIE_JAR */
1353 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1356 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1359 /** Size limit for IOB */
1360 size_t buffer_limit;
1362 #ifdef FEATURE_ACTIVITY_CONSOLE
1365 * Default IP address to send statistics to, as a string.
1366 * Set to "127.0.0.1".
1368 #define ACTIVTY_ADDR_DEFAULT "127.0.0.1"
1371 * Default port to listen on, as a number.
1374 #define ACTIVTY_ADDR_PORT 8119
1376 /** IP address to talk to for activity/statistics reporting. */
1377 const char *activity_address;
1379 /** Port to bind to. Defaults to ACTIVTY_ADDR_PORT == 8119. */
1382 /** Frequency, in seconds, of how often to update the stats console. */
1385 #endif /* def FEATURE_ACTIVITY_CONSOLE */
1387 #ifdef FEATURE_TRUST
1389 /** The file name of the trust file. */
1390 const char * trustfile;
1392 /** FIXME: DOCME: Document this. */
1393 struct list trust_info[1];
1395 /** FIXME: DOCME: Document this. */
1396 struct url_spec *trust_list[64];
1398 #endif /* def FEATURE_TRUST */
1402 /** The access control list (ACL). */
1403 struct access_control_list *acl;
1405 #endif /* def FEATURE_ACL */
1407 /** Information about parent proxies (forwarding). */
1408 struct forward_spec *forward;
1410 /** All options from the config file, HTML-formatted. */
1413 /** The configuration file object. */
1414 struct file_list *config_file_list;
1416 /** List of loaders */
1417 int (*loaders[NLOADERS])(struct client_state *);
1419 /** Nonzero if we need to bind() to the new port. */
1423 /** Calculates the number of elements in an array, using sizeof. */
1424 #define SZ(X) (sizeof(X) / sizeof(*X))
1426 #ifdef FEATURE_FORCE_LOAD
1427 /** The force load URL prefix. */
1428 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1429 #endif /* def FEATURE_FORCE_LOAD */
1431 #ifdef FEATURE_NO_GIFS
1432 /** The MIME type for images ("image/png" or "image/gif"). */
1433 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1435 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1436 #endif /* def FEATURE_NO_GIFS */
1443 /** URL for the Privoxy home page. */
1444 #define HOME_PAGE_URL "http://www.privoxy.org/"
1446 /** URL for the Privoxy user manual. */
1447 #define USER_MANUAL_URL HOME_PAGE_URL "/" VERSION "/user-manual/"
1449 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1450 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1452 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1453 #define CONFIG_HELP_PREFIX "config.html#"
1456 * The "hosts" to intercept and display CGI pages.
1457 * First one is a hostname only, second one can specify host and path.
1460 * 1) Do not specify the http: prefix
1461 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1462 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1464 #define CGI_SITE_1_HOST "p.p"
1465 #define CGI_SITE_2_HOST "config.privoxy.org"
1466 #define CGI_SITE_2_PATH ""
1469 * The prefix for CGI pages. Written out in generated HTML.
1470 * INCLUDES the trailing slash.
1472 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1479 #endif /* ndef PROJECT_H_INCLUDED */