1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 #define PROJECT_H_VERSION "$Id: project.h,v 1.67 2002/04/24 02:12:43 oes Exp $"
4 /*********************************************************************
6 * File : $Source: /cvsroot/ijbswa/current/project.h,v $
8 * Purpose : Defines data structures which are widely used in the
9 * project. Does not define any variables or functions
10 * (though it does declare some macros).
12 * Copyright : Written by and Copyright (C) 2001 the SourceForge
13 * Privoxy team. http://www.privoxy.org/
15 * Based on the Internet Junkbuster originally written
16 * by and Copyright (C) 1997 Anonymous Coders and
17 * Junkbusters Corporation. http://www.junkbusters.com
19 * This program is free software; you can redistribute it
20 * and/or modify it under the terms of the GNU General
21 * Public License as published by the Free Software
22 * Foundation; either version 2 of the License, or (at
23 * your option) any later version.
25 * This program is distributed in the hope that it will
26 * be useful, but WITHOUT ANY WARRANTY; without even the
27 * implied warranty of MERCHANTABILITY or FITNESS FOR A
28 * PARTICULAR PURPOSE. See the GNU General Public
29 * License for more details.
31 * The GNU General Public License should be included with
32 * this file. If not, you can view it at
33 * http://www.gnu.org/copyleft/gpl.html
34 * or write to the Free Software Foundation, Inc., 59
35 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
39 * Revision 1.67 2002/04/24 02:12:43 oes
40 * - Jon's multiple AF patch:
41 * - Make csp->actions_list an array
42 * - #define MAX_ACTION_FILES
43 * - Moved CGI_PARAM_LEN_MAX (500) here
45 * Revision 1.66 2002/04/15 19:06:43 jongfoster
48 * Revision 1.65 2002/04/04 00:36:36 gliptak
49 * always use pcre for matching
51 * Revision 1.64 2002/04/03 22:28:03 gliptak
52 * Removed references to gnu_regex
54 * Revision 1.63 2002/03/31 17:19:00 jongfoster
55 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
57 * Revision 1.62 2002/03/26 22:48:49 swa
60 * Revision 1.61 2002/03/26 22:29:55 swa
61 * we have a new homepage!
63 * Revision 1.60 2002/03/24 15:52:17 jongfoster
64 * Changing CGI URL prefixes for new name
66 * Revision 1.59 2002/03/24 15:23:33 jongfoster
69 * Revision 1.58 2002/03/24 13:25:43 swa
70 * name change related issues
72 * Revision 1.57 2002/03/16 20:28:34 oes
73 * Added descriptions to the filters so users will know what they select in the cgi editor
75 * Revision 1.56 2002/03/13 20:27:30 oes
76 * Fixing bug with CT_TABOO
78 * Revision 1.55 2002/03/12 01:42:50 oes
79 * Introduced modular filters
81 * Revision 1.54 2002/03/09 20:03:52 jongfoster
82 * - Making various functions return int rather than size_t.
83 * (Undoing a recent change). Since size_t is unsigned on
84 * Windows, functions like read_socket that return -1 on
85 * error cannot return a size_t.
87 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
88 * crashes, and also frequently caused JB to jump to 100%
89 * CPU and stay there. (Because it thought it had just
90 * read ((unsigned)-1) == 4Gb of data...)
92 * - The signature of write_socket has changed, it now simply
93 * returns success=0/failure=nonzero.
95 * - Trying to get rid of a few warnings --with-debug on
96 * Windows, I've introduced a new type "jb_socket". This is
97 * used for the socket file descriptors. On Windows, this
98 * is SOCKET (a typedef for unsigned). Everywhere else, it's
99 * an int. The error value can't be -1 any more, so it's
100 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
101 * Windows it maps to the #define INVALID_SOCKET.)
103 * - The signature of bind_port has changed.
105 * Revision 1.53 2002/03/08 16:48:55 oes
106 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
108 * Revision 1.52 2002/03/07 03:46:17 oes
109 * Fixed compiler warnings
111 * Revision 1.51 2002/03/05 04:52:42 oes
112 * Deleted non-errlog debugging code
114 * Revision 1.50 2002/03/04 19:32:07 oes
115 * Changed default port to 8118
117 * Revision 1.49 2002/03/04 18:28:55 oes
118 * Deleted PID_FILE_NAME
120 * Revision 1.48 2002/03/03 14:50:40 oes
121 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
123 * Revision 1.47 2002/02/20 23:15:13 jongfoster
124 * Parsing functions now handle out-of-memory gracefully by returning
127 * Revision 1.46 2002/01/17 21:06:09 jongfoster
128 * Now #defining the URLs of the config interface
130 * Minor changes to struct http_request and struct url_spec due to
131 * standardizing that struct http_request is used to represent a URL, and
132 * struct url_spec is used to represent a URL pattern. (Before, URLs were
133 * represented as seperate variables and a partially-filled-in url_spec).
135 * Revision 1.45 2002/01/09 14:33:27 oes
136 * Added HOSTENT_BUFFER_SIZE
138 * Revision 1.44 2001/12/30 14:07:32 steudten
139 * - Add signal handling (unix)
140 * - Add SIGHUP handler (unix)
141 * - Add creation of pidfile (unix)
142 * - Add action 'top' in rc file (RH)
143 * - Add entry 'SIGNALS' to manpage
144 * - Add exit message to logfile (unix)
146 * Revision 1.43 2001/11/22 21:57:51 jongfoster
147 * Making action_spec->flags into an unsigned long rather than just an
149 * Adding ACTION_NO_COOKIE_KEEP
151 * Revision 1.42 2001/11/05 21:42:41 steudten
152 * Include DBG() macro.
154 * Revision 1.41 2001/10/28 19:12:06 jongfoster
155 * Adding ijb_toupper()
157 * Revision 1.40 2001/10/26 17:40:47 oes
158 * Moved ijb_isspace and ijb_tolower to project.h
159 * Removed http->user_agent, csp->referrer and csp->accept_types
161 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
162 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
163 * macro when called with a cast; so moving the cast to the macro def'n
164 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
165 * doesn't make macro expansion complain. Hope this works for everyone else
168 * Revision 1.38 2001/10/23 21:19:04 jongfoster
169 * New error-handling support: jb_err type and JB_ERR_xxx constants
170 * CGI functions now return a jb_err, and their parameters map is const.
171 * Support for RUNTIME_FEATUREs to enable/disable config editor
172 * Adding a few comments
174 * Revision 1.37 2001/10/14 22:14:01 jongfoster
175 * Removing name_length field from struct cgi_dispatcher, as this is
176 * now calculated at runtime from the "name" field.
178 * Revision 1.36 2001/10/10 16:45:15 oes
179 * Added LIMIT_CONNECT action and string
180 * Fixed HTTP message line termination
181 * Added CFORBIDDEN HTTP message
183 * Revision 1.35 2001/10/07 18:06:43 oes
184 * Added status member to struct http_request
186 * Revision 1.34 2001/10/07 15:45:25 oes
187 * Added url member to struct http_request and commented all
192 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
194 * Replaced struct client_state members rejected,
195 * force, active and toggled_on with "flags" bitmap.
197 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
199 * Added buffer_limit to struct configuration_spec
201 * Revision 1.33 2001/09/20 13:30:08 steudten
203 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
204 * Last case will set z to NULL in free(z) and thats bad..
206 * Revision 1.32 2001/09/16 23:02:51 jongfoster
209 * Revision 1.31 2001/09/16 13:20:29 jongfoster
210 * Rewrite of list library. Now has seperate header and list_entry
211 * structures. Also added a large sprinking of assert()s to the list
214 * Revision 1.30 2001/09/13 23:52:00 jongfoster
215 * Support for both static and dynamically generated CGI pages
217 * Revision 1.29 2001/09/13 23:29:43 jongfoster
218 * Defining FORWARD_SPEC_INITIALIZER
220 * Revision 1.28 2001/09/13 23:05:50 jongfoster
221 * Changing the string paramater to the header parsers a "const".
223 * Revision 1.27 2001/08/05 16:06:20 jongfoster
224 * Modifiying "struct map" so that there are now separate header and
225 * "map_entry" structures. This means that functions which modify a
226 * map no longer need to return a pointer to the modified map.
227 * Also, it no longer reverses the order of the entries (which may be
228 * important with some advanced template substitutions).
230 * Revision 1.26 2001/07/30 22:08:36 jongfoster
231 * Tidying up #defines:
232 * - All feature #defines are now of the form FEATURE_xxx
233 * - Permanently turned off WIN_GUI_EDIT
234 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
236 * Revision 1.25 2001/07/29 18:43:08 jongfoster
237 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
240 * Revision 1.24 2001/07/25 17:20:27 oes
241 * Introduced http->user_agent
243 * Revision 1.23 2001/07/18 12:32:23 oes
244 * - Added ACTION_STRING_DEANIMATE
245 * - moved #define freez from jcc.h to project.h
247 * Revision 1.22 2001/07/15 17:51:41 jongfoster
248 * Renaming #define STATIC to STATIC_PCRE
250 * Revision 1.21 2001/07/13 14:03:19 oes
251 * - Reorganized regex header inclusion and #defines to
252 * comply to the scheme in configure.in
253 * - Added csp->content_type and its CT_* keys
254 * - Added ACTION_DEANIMATE
255 * - Removed all #ifdef PCRS
257 * Revision 1.20 2001/06/29 21:45:41 oes
258 * Indentation, CRLF->LF, Tab-> Space
260 * Revision 1.19 2001/06/29 13:33:36 oes
261 * - Improved comments
262 * - Introduced http_request.host_ip_addr_str
263 * - Introduced http_response.head_length
264 * - Introduced config.my_ip_addr_str, config.my_hostname,
265 * config.admin_address and config.proxy_info_url
266 * - Removed config.proxy_args_header and config.proxy_args_trailer,
267 * renamed config.proxy_args_invocation to config.proxy_args
268 * - Removed HTML snipplets and GIFs
269 * - Removed logentry from cancelled commit
271 * Revision 1.18 2001/06/09 10:57:39 jongfoster
272 * Adding definition of BUFFER_SIZE.
273 * Changing struct cgi_dispatcher to use "const" strings.
275 * Revision 1.17 2001/06/07 23:15:09 jongfoster
276 * Merging ACL and forward files into config file.
277 * Moving struct gateway members into struct forward_spec
278 * Removing config->proxy_args_gateways
279 * Cosmetic: Adding a few comments
281 * Revision 1.16 2001/06/04 18:31:58 swa
282 * files are now prefixed with either `confdir' or `logdir'.
283 * `make redhat-dist' replaces both entries confdir and logdir
286 * Revision 1.15 2001/06/04 11:28:53 swa
287 * redirect did not work due to missing /
289 * Revision 1.14 2001/06/03 11:03:48 oes
291 * added struct http_response,
292 * changed struct interceptors to struct cgi_dispatcher,
293 * moved HTML stuff to cgi.h
295 * Revision 1.13 2001/06/01 20:05:36 jongfoster
296 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
297 * constant, and removed csp->tinygif.
299 * Revision 1.12 2001/06/01 18:49:17 jongfoster
300 * Replaced "list_share" with "list" - the tiny memory gain was not
301 * worth the extra complexity.
303 * Revision 1.11 2001/06/01 10:32:47 oes
304 * Added constants for anchoring selection bitmap
306 * Revision 1.10 2001/05/31 21:33:53 jongfoster
307 * Changes for new actions file, replacing permissionsfile
308 * and parts of the config file. Also added support for
311 * Revision 1.9 2001/05/31 17:32:31 oes
313 * - Enhanced domain part globbing with infix and prefix asterisk
314 * matching and optional unanchored operation
316 * Revision 1.8 2001/05/29 20:09:15 joergs
317 * HTTP_REDIRECT_TEMPLATE fixed.
319 * Revision 1.7 2001/05/29 09:50:24 jongfoster
320 * Unified blocklist/imagelist/actionslist.
321 * File format is still under discussion, but the internal changes
324 * Also modified interceptor behaviour:
325 * - We now intercept all URLs beginning with one of the following
326 * prefixes (and *only* these prefixes):
328 * * http://ijbswa.sf.net/config/
329 * * http://ijbswa.sourceforge.net/config/
330 * - New interceptors "home page" - go to http://i.j.b/ to see it.
331 * - Internal changes so that intercepted and fast redirect pages
332 * are not replaced with an image.
333 * - Interceptors now have the option to send a binary page direct
334 * to the client. (i.e. ijb-send-banner uses this)
335 * - Implemented show-url-info interceptor. (Which is why I needed
336 * the above interceptors changes - a typical URL is
337 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
338 * The previous mechanism would not have intercepted that, and
339 * if it had been intercepted then it then it would have replaced
342 * Revision 1.6 2001/05/27 22:17:04 oes
344 * - re_process_buffer no longer writes the modified buffer
345 * to the client, which was very ugly. It now returns the
346 * buffer, which it is then written by chat.
348 * - content_length now adjusts the Content-Length: header
349 * for modified documents rather than crunch()ing it.
350 * (Length info in csp->content_length, which is 0 for
351 * unmodified documents)
353 * - For this to work, sed() is called twice when filtering.
355 * Revision 1.5 2001/05/26 00:28:36 jongfoster
356 * Automatic reloading of config file.
357 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
358 * Most of the global variables have been moved to a new
359 * struct configuration_spec, accessed through csp->config->globalname
360 * Most of the globals remaining are used by the Win32 GUI.
362 * Revision 1.4 2001/05/22 18:46:04 oes
364 * - Enabled filtering banners by size rather than URL
365 * by adding patterns that replace all standard banner
366 * sizes with the "Junkbuster" gif to the re_filterfile
368 * - Enabled filtering WebBugs by providing a pattern
369 * which kills all 1x1 images
371 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
372 * which is selected by the (nonstandard and therefore
373 * capital) letter 'U' in the option string.
374 * It causes the quantifiers to be ungreedy by default.
375 * Appending a ? turns back to greedy (!).
377 * - Added a new interceptor ijb-send-banner, which
378 * sends back the "Junkbuster" gif. Without imagelist or
379 * MSIE detection support, or if tinygif = 1, or the
380 * URL isn't recognized as an imageurl, a lame HTML
381 * explanation is sent instead.
383 * - Added new feature, which permits blocking remote
384 * script redirects and firing back a local redirect
386 * The feature is conditionally compiled, i.e. it
387 * can be disabled with --disable-fast-redirects,
388 * plus it must be activated by a "fast-redirects"
389 * line in the config file, has its own log level
390 * and of course wants to be displayed by show-proxy-args
391 * Note: Boy, all the #ifdefs in 1001 locations and
392 * all the fumbling with configure.in and acconfig.h
393 * were *way* more work than the feature itself :-(
395 * - Because a generic redirect template was needed for
396 * this, tinygif = 3 now uses the same.
398 * - Moved GIFs, and other static HTTP response templates
403 * - Removed some >400 CRs again (Jon, you really worked
406 * Revision 1.3 2001/05/20 01:21:20 jongfoster
407 * Version 2.9.4 checkin.
408 * - Merged popupfile and cookiefile, and added control over PCRS
409 * filtering, in new "actionsfile".
410 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
411 * file error you now get a message box (in the Win32 GUI) rather
412 * than the program exiting with no explanation.
413 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
415 * - Removed tabs from "config"
416 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
417 * - Bumped up version number.
419 * Revision 1.2 2001/05/17 23:01:01 oes
420 * - Cleaned CRLF's from the sources and related files
422 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
423 * Initial import of version 2.9.3 source tree
426 *********************************************************************/
429 /* Declare struct FILE for vars and funcs. */
432 /* Need time_t for file_list */
436 * Include appropriate regular expression libraries.
437 * Note that pcrs and pcre (native) are needed for cgi
438 * and are included anyway.
454 # include "pcreposix.h"
456 # include <pcreposix.h>
461 #endif /* def AMIGA */
465 * I don't want to have to #include all this just for the declaration
466 * of SOCKET. However, it looks like we have to...
480 * The type used by sockets. On UNIX it's an int. Microsoft decided to
481 * make it an unsigned.
484 typedef SOCKET jb_socket;
485 #define JB_INVALID_SOCKET INVALID_SOCKET
486 #else /* ndef _WIN32 */
487 typedef int jb_socket;
488 #define JB_INVALID_SOCKET (-1)
489 #endif /* ndef _WIN32 */
493 * Error codes. Functions returning these should return a jb_err
495 #define JB_ERR_OK 0 /* Success, no error */
496 #define JB_ERR_MEMORY 1 /* Out of memory */
497 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
498 #define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
499 #define JB_ERR_PARSE 4 /* Error parsing file */
500 #define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
501 /* CGI actions editor. */
506 * This macro is used to free a pointer that may be NULL
508 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
511 /* Fix a problem with Solaris. There should be no effect on other
513 * Solaris's isspace() is a macro which uses it's argument directly
514 * as an array index. Therefore we need to make sure that high-bit
515 * characters generate +ve values, and ideally we also want to make
516 * the argument match the declared parameter type of "int".
518 * Note: Remember to #include <ctype.h> if you use these macros.
520 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
521 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
522 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
525 * Use for statically allocated buffers if you have no other choice.
526 * Remember to check the length of what you write into the buffer
527 * - we don't want any buffer overflows!
529 #define BUFFER_SIZE 5000
532 * Max length of CGI parameters (arbitrary limit)
534 #define CGI_PARAM_LEN_MAX 500
537 * Buffer size for capturing struct hostent data in the
538 * gethostby(name|addr)_r library calls. Since we don't
539 * loop over gethostbyname_r, the buffer must be sufficient
540 * to accomodate multiple IN A RRs, as used in DNS round robin
541 * load balancing. W3C's wwwlib uses 1K, so that should be
542 * good enough for us, too.
544 #define HOSTENT_BUFFER_SIZE 1024
547 * So you can say "while (FOREVER) { ...do something... }"
551 /* Default IP and port to listen on */
552 #define HADDR_DEFAULT "127.0.0.1"
553 #define HADDR_PORT 8118
555 /* Forward defs for various structures */
557 /* Need this for struct client_state */
558 struct configuration_spec;
561 /* Generic linked list of strings */
566 struct list_entry *next;
571 struct list_entry *first;
572 struct list_entry *last;
576 /* A map from a string to another string */
582 struct map_entry *next;
587 struct map_entry *first;
588 struct map_entry *last;
594 char *cmd; /* Whole command line: method, URL, Version */
595 char *ocmd; /* Backup of original cmd for CLF logging */
596 char *gpc; /* HTTP method: GET, POST, .. */
597 char *url; /* The URL */
598 char *ver; /* Protocol version */
599 int status; /* HTTP Status */
601 char *host; /* Host part of URL */
602 int port; /* Port of URL or 80 (default) */
603 char *path; /* Path of URL */
604 char *hostport; /* host[:port] */
605 int ssl; /* Flag if protocol is https */
607 char *host_ip_addr_str; /* String with dotted decimal representation
608 * of host's IP. NULL before connect_to() */
610 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
611 char **dvec; /* List of pointers to the strings in dbuffer. */
612 int dcount; /* How many parts to this domain? (length of dvec) */
616 * Response generated by CGI, blocker, or error handler
620 char *status; /* HTTP status (string) */
621 struct list headers[1]; /* List of header lines */
622 char *head; /* Formatted http response head */
623 size_t head_length; /* Length of http response head */
624 char *body; /* HTTP document body */
625 size_t content_length; /* Length of body, REQUIRED if binary body */
626 int is_static; /* Nonzero if the content will never change and
627 * should be cached by the brwoser (e.g. images) */
633 char *spec; /* The string which was parsed to produce this */
634 /* url_spec. Used for debugging or display only. */
636 /* Hostname matching, or dbuffer == NULL to match all hosts */
637 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
638 char **dvec; /* List of pointers to the strings in dbuffer. */
639 int dcount; /* How many parts to this domain? (length of dvec) */
640 int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
643 int port; /* The port number, or 0 to match all ports. */
646 char *path; /* The path prefix (if not using regex), or source */
648 int pathlen; /* ==strlen(path). Needed for prefix matching. */
649 regex_t *preg; /* Regex for matching path part */
651 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
653 /* Constants for host part matching in URLs */
654 #define ANCHOR_LEFT 1
655 #define ANCHOR_RIGHT 2
667 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
668 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
670 /* Bits for csp->content_type */
671 #define CT_TEXT 1 /* Suitable for pcrs filtering */
672 #define CT_GIF 2 /* Suitable for GIF filtering */
673 #define CT_TABOO 4 /* DONT filter */
675 #define ACTION_MASK_ALL (~0U)
677 #define ACTION_MOST_COMPATIBLE 0x00000000UL
679 #define ACTION_BLOCK 0x00000001UL
680 #define ACTION_DEANIMATE 0x00000002UL
681 #define ACTION_DOWNGRADE 0x00000004UL
682 #define ACTION_FAST_REDIRECTS 0x00000008UL
683 #define ACTION_HIDE_FORWARDED 0x00000010UL
684 #define ACTION_HIDE_FROM 0x00000020UL
685 #define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */
686 #define ACTION_HIDE_USER_AGENT 0x00000080UL
687 #define ACTION_IMAGE 0x00000100UL
688 #define ACTION_IMAGE_BLOCKER 0x00000200UL
689 #define ACTION_NO_COMPRESSION 0x00000400UL
690 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
691 #define ACTION_NO_COOKIE_READ 0x00001000UL
692 #define ACTION_NO_COOKIE_SET 0x00002000UL
693 #define ACTION_NO_POPUPS 0x00004000UL
694 #define ACTION_VANILLA_WAFER 0x00008000UL
695 #define ACTION_LIMIT_CONNECT 0x00010000UL
697 #define ACTION_STRING_DEANIMATE 0
698 #define ACTION_STRING_FROM 1
699 #define ACTION_STRING_IMAGE_BLOCKER 2
700 #define ACTION_STRING_REFERER 3
701 #define ACTION_STRING_USER_AGENT 4
702 #define ACTION_STRING_LIMIT_CONNECT 5
703 #define ACTION_STRING_COUNT 6
705 #define ACTION_MULTI_ADD_HEADER 0
706 #define ACTION_MULTI_WAFER 1
707 #define ACTION_MULTI_FILTER 2
708 #define ACTION_MULTI_COUNT 3
712 * This structure contains a list of actions to apply to a URL.
713 * It only contains positive instructions - no "-" options.
714 * It is not used to store the actions list itself, only for
715 * url_actions() to return the current values.
717 struct current_action_spec
719 unsigned long flags; /* a bit set to "1" = add action */
721 /* For those actions that require parameters: */
723 /* each entry is valid if & only if corresponding entry in "add" set. */
724 char * string[ACTION_STRING_COUNT];
727 struct list multi[ACTION_MULTI_COUNT][1];
732 * This structure contains a set of changes to actions.
733 * It can contain both positive and negative instructions.
734 * It is used to store an entry in the actions list.
738 unsigned long mask; /* a bit set to "0" = remove action */
739 unsigned long add; /* a bit set to "1" = add action */
741 /* For those actions that require parameters: */
743 /* each entry is valid if & only if corresponding entry in "add" set. */
744 char * string[ACTION_STRING_COUNT];
746 /* Strings to remove. */
747 struct list multi_remove[ACTION_MULTI_COUNT][1];
749 /* If nonzero, remove *all* strings. */
750 int multi_remove_all[ACTION_MULTI_COUNT];
753 struct list multi_add[ACTION_MULTI_COUNT][1];
757 * This structure is used to store the actions list.
759 * It contains a URL pattern, and the chages to the actions.
760 * It is a linked list.
764 struct url_spec url[1];
766 struct action_spec action[1];
768 struct url_actions * next;
773 * Flags for use in csp->flags
775 #define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
776 * Cleared when the thread associated with
777 * this structure dies. */
778 #define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
779 * transfer encoding */
780 #define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
781 * it would normally have been blocked. */
782 #define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
783 #define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
784 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
787 * Maximum number of actions files. This limit is arbitrary - it's just used
790 #define MAX_ACTION_FILES 10
793 * The state of a Privoxy processing thread.
797 /* The proxy's configuration */
798 struct configuration_spec * config;
800 /* The actions to perform on the current request */
801 struct current_action_spec action[1];
803 /* socket to talk to client (web browser) */
806 /* socket to talk to server (web server or proxy) */
809 /* Multi-purpose flag container, see CSP_FLAG_* above */
810 unsigned short int flags;
813 * Client PC's IP address, as reported by the accept()_ function.
814 * Both as string and number
820 /* Our IP address and hostname, i.e. the IP address that
821 the client used to reach us, and the associated hostname,
824 char *my_ip_addr_str;
827 /* The URL that was requested */
828 struct http_request http[1];
830 /* An I/O buffer used for buffering data read from the client */
833 /* List of all headers for this request */
834 struct list headers[1];
836 /* List of all cookies for this request */
837 struct list cookie_list[1];
839 /* MIME-Type key, see CT_* above */
840 unsigned short int content_type;
842 /* The "X-Forwarded-For:" header sent by the client */
845 /* files associated with this client */
846 struct file_list *actions_list[MAX_ACTION_FILES];
848 struct file_list *rlist; /* pcrs job file */
849 size_t content_length; /* Length after content modification */
852 struct file_list *tlist; /* trustfile */
853 #endif /* def FEATURE_TRUST */
855 struct client_state *next;
860 * A function to add a header
862 typedef jb_err (*add_header_func_ptr)(struct client_state *);
865 * A function to process a header
867 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
870 * List of functions to run on a list of headers
876 parser_func_ptr parser;
881 * List of available CGI functions.
883 struct cgi_dispatcher
885 const char * const name;
886 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
887 const char * const description;
892 * A data file used by Privoxy. Kept in a linked list.
897 * this is a pointer to the data structures associated with the file.
898 * Read-only once the structure has been created.
902 /* Normally NULL. When we are finished with file (i.e. when we have
903 * loaded a new one), set to a pointer to an unloader function.
904 * Unloader will be called by sweep() (called from main loop) when
905 * all clients using this file are done. This prevents threading
908 void (*unloader)(void *);
910 /* Used internally by sweep(). Do not access from elsewhere. */
913 /* Following variables allow us to check if file has been changed.
914 * Read-only once the structure has been created.
919 /* Pointer to next entry in the linked list of all "file_list"s.
920 * This linked list is so that sweep() can navigate it.
921 * Since sweep() can remove items from the list, we must be careful
922 * to only access this value from main thread (when we know sweep
925 struct file_list *next;
932 struct url_spec url[1];
934 struct block_spec *next;
936 #endif /* def FEATURE_TRUST */
939 #define SOCKS_NONE 0 /* Don't use a SOCKS server */
940 #define SOCKS_4 40 /* original SOCKS 4 protocol */
941 #define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
945 struct url_spec url[1];
947 /* Connection type - must be a SOCKS_xxx constant */
954 /* Parent HTTP proxy */
958 /* For the linked list */
959 struct forward_spec *next;
961 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
965 * This struct represents one filter (one block) from
966 * the re_filterfile. If there is more than one filter
967 * in the file, the file will be represented by a
968 * chained list of re_filterfile specs.
970 struct re_filterfile_spec
972 char *name; /* Name from FILTER: statement in re_filterfile */
973 char *description; /* Description from FILTER: statement in re_filterfile */
974 struct list patterns[1]; /* The patterns from the re_filterfile */
975 pcrs_job *joblist; /* The resulting compiled pcrs_jobs */
976 struct re_filterfile_spec *next; /* The pointer for chaining */
980 #define ACL_PERMIT 1 /* accept connection request */
981 #define ACL_DENY 2 /* reject connection request */
983 struct access_control_addr
990 struct access_control_list
992 struct access_control_addr src[1];
993 struct access_control_addr dst[1];
996 struct access_control_list *next;
998 #endif /* def FEATURE_ACL */
1001 /* Maximum number of loaders (actions, re_filter, ...) */
1005 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1006 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1010 * Data loaded from the configuration file.
1012 * (Anomaly: toggle is still handled through a global, not this structure)
1014 struct configuration_spec
1019 /* Features that can be enabled/disabled through the config file */
1020 unsigned feature_flags;
1022 const char *logfile;
1024 const char *confdir;
1026 const char *actions_file[MAX_ACTION_FILES];
1027 const char *actions_file_short[MAX_ACTION_FILES];
1029 /* The administrator's email address */
1030 char *admin_address;
1032 /* A URL with info on this proxy */
1033 char *proxy_info_url;
1035 /* URL to the user manual (on our website or local copy) */
1038 const char *re_filterfile;
1040 #ifdef FEATURE_COOKIE_JAR
1041 const char * jarfile;
1043 #endif /* def FEATURE_COOKIE_JAR */
1046 * Port and IP to bind to.
1047 * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1052 /* Size limit for IOB */
1053 size_t buffer_limit;
1055 #ifdef FEATURE_TRUST
1056 const char * trustfile;
1058 struct list trust_info[1];
1059 struct url_spec *trust_list[64];
1060 #endif /* def FEATURE_TRUST */
1063 struct access_control_list *acl;
1064 #endif /* def FEATURE_ACL */
1066 struct forward_spec *forward;
1068 /* All options from the config file, HTML-formatted */
1071 /* the configuration file object. */
1072 struct file_list *config_file_list;
1074 /* List of loaders */
1075 int (*loaders[NLOADERS])(struct client_state *);
1077 /* bool, nonzero if we need to bind() to the new port */
1082 #define SZ(X) (sizeof(X) / sizeof(*X))
1084 #ifdef FEATURE_FORCE_LOAD
1085 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1086 #endif /* def FEATURE_FORCE_LOAD */
1088 #ifdef FEATURE_NO_GIFS
1089 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1091 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1092 #endif /* def FEATURE_NO_GIFS */
1095 /* Hardwired URLs */
1096 #define HOME_PAGE_URL "http://www.privoxy.org"
1097 #define USER_MANUAL_URL HOME_PAGE_URL "/" VERSION "/user-manual/"
1098 #define HELP_LINK_PREFIX "configuration.html#"
1101 * The "hosts" to intercept and display CGI pages.
1102 * First one is a hostname only, second one can specify host and path.
1105 * 1) Do not specify the http: prefix
1106 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1107 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1109 #define CGI_SITE_1_HOST "p.p"
1110 #define CGI_SITE_2_HOST "config.privoxy.org"
1111 #define CGI_SITE_2_PATH ""
1114 * The prefix for CGI pages. Written out in generated HTML.
1115 * INCLUDES the trailing slash.
1117 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1120 /* HTTP snipplets */
1121 static const char CSUCCEED[] =
1122 "HTTP/1.0 200 Connection established\n"
1123 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1125 static const char CHEADER[] =
1126 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1128 static const char CFORBIDDEN[] =
1129 "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";
1135 #endif /* ndef PROJECT_H_INCLUDED */