1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 #define PROJECT_H_VERSION "$Id: project.h,v 1.60 2002/03/24 15:52:17 jongfoster 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.60 2002/03/24 15:52:17 jongfoster
40 * Changing CGI URL prefixes for new name
42 * Revision 1.59 2002/03/24 15:23:33 jongfoster
45 * Revision 1.58 2002/03/24 13:25:43 swa
46 * name change related issues
48 * Revision 1.57 2002/03/16 20:28:34 oes
49 * Added descriptions to the filters so users will know what they select in the cgi editor
51 * Revision 1.56 2002/03/13 20:27:30 oes
52 * Fixing bug with CT_TABOO
54 * Revision 1.55 2002/03/12 01:42:50 oes
55 * Introduced modular filters
57 * Revision 1.54 2002/03/09 20:03:52 jongfoster
58 * - Making various functions return int rather than size_t.
59 * (Undoing a recent change). Since size_t is unsigned on
60 * Windows, functions like read_socket that return -1 on
61 * error cannot return a size_t.
63 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
64 * crashes, and also frequently caused JB to jump to 100%
65 * CPU and stay there. (Because it thought it had just
66 * read ((unsigned)-1) == 4Gb of data...)
68 * - The signature of write_socket has changed, it now simply
69 * returns success=0/failure=nonzero.
71 * - Trying to get rid of a few warnings --with-debug on
72 * Windows, I've introduced a new type "jb_socket". This is
73 * used for the socket file descriptors. On Windows, this
74 * is SOCKET (a typedef for unsigned). Everywhere else, it's
75 * an int. The error value can't be -1 any more, so it's
76 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
77 * Windows it maps to the #define INVALID_SOCKET.)
79 * - The signature of bind_port has changed.
81 * Revision 1.53 2002/03/08 16:48:55 oes
82 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
84 * Revision 1.52 2002/03/07 03:46:17 oes
85 * Fixed compiler warnings
87 * Revision 1.51 2002/03/05 04:52:42 oes
88 * Deleted non-errlog debugging code
90 * Revision 1.50 2002/03/04 19:32:07 oes
91 * Changed default port to 8118
93 * Revision 1.49 2002/03/04 18:28:55 oes
94 * Deleted PID_FILE_NAME
96 * Revision 1.48 2002/03/03 14:50:40 oes
97 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
99 * Revision 1.47 2002/02/20 23:15:13 jongfoster
100 * Parsing functions now handle out-of-memory gracefully by returning
103 * Revision 1.46 2002/01/17 21:06:09 jongfoster
104 * Now #defining the URLs of the config interface
106 * Minor changes to struct http_request and struct url_spec due to
107 * standardizing that struct http_request is used to represent a URL, and
108 * struct url_spec is used to represent a URL pattern. (Before, URLs were
109 * represented as seperate variables and a partially-filled-in url_spec).
111 * Revision 1.45 2002/01/09 14:33:27 oes
112 * Added HOSTENT_BUFFER_SIZE
114 * Revision 1.44 2001/12/30 14:07:32 steudten
115 * - Add signal handling (unix)
116 * - Add SIGHUP handler (unix)
117 * - Add creation of pidfile (unix)
118 * - Add action 'top' in rc file (RH)
119 * - Add entry 'SIGNALS' to manpage
120 * - Add exit message to logfile (unix)
122 * Revision 1.43 2001/11/22 21:57:51 jongfoster
123 * Making action_spec->flags into an unsigned long rather than just an
125 * Adding ACTION_NO_COOKIE_KEEP
127 * Revision 1.42 2001/11/05 21:42:41 steudten
128 * Include DBG() macro.
130 * Revision 1.41 2001/10/28 19:12:06 jongfoster
131 * Adding ijb_toupper()
133 * Revision 1.40 2001/10/26 17:40:47 oes
134 * Moved ijb_isspace and ijb_tolower to project.h
135 * Removed http->user_agent, csp->referrer and csp->accept_types
137 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
138 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
139 * macro when called with a cast; so moving the cast to the macro def'n
140 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
141 * doesn't make macro expansion complain. Hope this works for everyone else
144 * Revision 1.38 2001/10/23 21:19:04 jongfoster
145 * New error-handling support: jb_err type and JB_ERR_xxx constants
146 * CGI functions now return a jb_err, and their parameters map is const.
147 * Support for RUNTIME_FEATUREs to enable/disable config editor
148 * Adding a few comments
150 * Revision 1.37 2001/10/14 22:14:01 jongfoster
151 * Removing name_length field from struct cgi_dispatcher, as this is
152 * now calculated at runtime from the "name" field.
154 * Revision 1.36 2001/10/10 16:45:15 oes
155 * Added LIMIT_CONNECT action and string
156 * Fixed HTTP message line termination
157 * Added CFORBIDDEN HTTP message
159 * Revision 1.35 2001/10/07 18:06:43 oes
160 * Added status member to struct http_request
162 * Revision 1.34 2001/10/07 15:45:25 oes
163 * Added url member to struct http_request and commented all
168 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
170 * Replaced struct client_state members rejected,
171 * force, active and toggled_on with "flags" bitmap.
173 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
175 * Added buffer_limit to struct configuration_spec
177 * Revision 1.33 2001/09/20 13:30:08 steudten
179 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
180 * Last case will set z to NULL in free(z) and thats bad..
182 * Revision 1.32 2001/09/16 23:02:51 jongfoster
185 * Revision 1.31 2001/09/16 13:20:29 jongfoster
186 * Rewrite of list library. Now has seperate header and list_entry
187 * structures. Also added a large sprinking of assert()s to the list
190 * Revision 1.30 2001/09/13 23:52:00 jongfoster
191 * Support for both static and dynamically generated CGI pages
193 * Revision 1.29 2001/09/13 23:29:43 jongfoster
194 * Defining FORWARD_SPEC_INITIALIZER
196 * Revision 1.28 2001/09/13 23:05:50 jongfoster
197 * Changing the string paramater to the header parsers a "const".
199 * Revision 1.27 2001/08/05 16:06:20 jongfoster
200 * Modifiying "struct map" so that there are now separate header and
201 * "map_entry" structures. This means that functions which modify a
202 * map no longer need to return a pointer to the modified map.
203 * Also, it no longer reverses the order of the entries (which may be
204 * important with some advanced template substitutions).
206 * Revision 1.26 2001/07/30 22:08:36 jongfoster
207 * Tidying up #defines:
208 * - All feature #defines are now of the form FEATURE_xxx
209 * - Permanently turned off WIN_GUI_EDIT
210 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
212 * Revision 1.25 2001/07/29 18:43:08 jongfoster
213 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
216 * Revision 1.24 2001/07/25 17:20:27 oes
217 * Introduced http->user_agent
219 * Revision 1.23 2001/07/18 12:32:23 oes
220 * - Added ACTION_STRING_DEANIMATE
221 * - moved #define freez from jcc.h to project.h
223 * Revision 1.22 2001/07/15 17:51:41 jongfoster
224 * Renaming #define STATIC to STATIC_PCRE
226 * Revision 1.21 2001/07/13 14:03:19 oes
227 * - Reorganized regex header inclusion and #defines to
228 * comply to the scheme in configure.in
229 * - Added csp->content_type and its CT_* keys
230 * - Added ACTION_DEANIMATE
231 * - Removed all #ifdef PCRS
233 * Revision 1.20 2001/06/29 21:45:41 oes
234 * Indentation, CRLF->LF, Tab-> Space
236 * Revision 1.19 2001/06/29 13:33:36 oes
237 * - Improved comments
238 * - Introduced http_request.host_ip_addr_str
239 * - Introduced http_response.head_length
240 * - Introduced config.my_ip_addr_str, config.my_hostname,
241 * config.admin_address and config.proxy_info_url
242 * - Removed config.proxy_args_header and config.proxy_args_trailer,
243 * renamed config.proxy_args_invocation to config.proxy_args
244 * - Removed HTML snipplets and GIFs
245 * - Removed logentry from cancelled commit
247 * Revision 1.18 2001/06/09 10:57:39 jongfoster
248 * Adding definition of BUFFER_SIZE.
249 * Changing struct cgi_dispatcher to use "const" strings.
251 * Revision 1.17 2001/06/07 23:15:09 jongfoster
252 * Merging ACL and forward files into config file.
253 * Moving struct gateway members into struct forward_spec
254 * Removing config->proxy_args_gateways
255 * Cosmetic: Adding a few comments
257 * Revision 1.16 2001/06/04 18:31:58 swa
258 * files are now prefixed with either `confdir' or `logdir'.
259 * `make redhat-dist' replaces both entries confdir and logdir
262 * Revision 1.15 2001/06/04 11:28:53 swa
263 * redirect did not work due to missing /
265 * Revision 1.14 2001/06/03 11:03:48 oes
267 * added struct http_response,
268 * changed struct interceptors to struct cgi_dispatcher,
269 * moved HTML stuff to cgi.h
271 * Revision 1.13 2001/06/01 20:05:36 jongfoster
272 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
273 * constant, and removed csp->tinygif.
275 * Revision 1.12 2001/06/01 18:49:17 jongfoster
276 * Replaced "list_share" with "list" - the tiny memory gain was not
277 * worth the extra complexity.
279 * Revision 1.11 2001/06/01 10:32:47 oes
280 * Added constants for anchoring selection bitmap
282 * Revision 1.10 2001/05/31 21:33:53 jongfoster
283 * Changes for new actions file, replacing permissionsfile
284 * and parts of the config file. Also added support for
287 * Revision 1.9 2001/05/31 17:32:31 oes
289 * - Enhanced domain part globbing with infix and prefix asterisk
290 * matching and optional unanchored operation
292 * Revision 1.8 2001/05/29 20:09:15 joergs
293 * HTTP_REDIRECT_TEMPLATE fixed.
295 * Revision 1.7 2001/05/29 09:50:24 jongfoster
296 * Unified blocklist/imagelist/actionslist.
297 * File format is still under discussion, but the internal changes
300 * Also modified interceptor behaviour:
301 * - We now intercept all URLs beginning with one of the following
302 * prefixes (and *only* these prefixes):
304 * * http://ijbswa.sf.net/config/
305 * * http://ijbswa.sourceforge.net/config/
306 * - New interceptors "home page" - go to http://i.j.b/ to see it.
307 * - Internal changes so that intercepted and fast redirect pages
308 * are not replaced with an image.
309 * - Interceptors now have the option to send a binary page direct
310 * to the client. (i.e. ijb-send-banner uses this)
311 * - Implemented show-url-info interceptor. (Which is why I needed
312 * the above interceptors changes - a typical URL is
313 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
314 * The previous mechanism would not have intercepted that, and
315 * if it had been intercepted then it then it would have replaced
318 * Revision 1.6 2001/05/27 22:17:04 oes
320 * - re_process_buffer no longer writes the modified buffer
321 * to the client, which was very ugly. It now returns the
322 * buffer, which it is then written by chat.
324 * - content_length now adjusts the Content-Length: header
325 * for modified documents rather than crunch()ing it.
326 * (Length info in csp->content_length, which is 0 for
327 * unmodified documents)
329 * - For this to work, sed() is called twice when filtering.
331 * Revision 1.5 2001/05/26 00:28:36 jongfoster
332 * Automatic reloading of config file.
333 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
334 * Most of the global variables have been moved to a new
335 * struct configuration_spec, accessed through csp->config->globalname
336 * Most of the globals remaining are used by the Win32 GUI.
338 * Revision 1.4 2001/05/22 18:46:04 oes
340 * - Enabled filtering banners by size rather than URL
341 * by adding patterns that replace all standard banner
342 * sizes with the "Junkbuster" gif to the re_filterfile
344 * - Enabled filtering WebBugs by providing a pattern
345 * which kills all 1x1 images
347 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
348 * which is selected by the (nonstandard and therefore
349 * capital) letter 'U' in the option string.
350 * It causes the quantifiers to be ungreedy by default.
351 * Appending a ? turns back to greedy (!).
353 * - Added a new interceptor ijb-send-banner, which
354 * sends back the "Junkbuster" gif. Without imagelist or
355 * MSIE detection support, or if tinygif = 1, or the
356 * URL isn't recognized as an imageurl, a lame HTML
357 * explanation is sent instead.
359 * - Added new feature, which permits blocking remote
360 * script redirects and firing back a local redirect
362 * The feature is conditionally compiled, i.e. it
363 * can be disabled with --disable-fast-redirects,
364 * plus it must be activated by a "fast-redirects"
365 * line in the config file, has its own log level
366 * and of course wants to be displayed by show-proxy-args
367 * Note: Boy, all the #ifdefs in 1001 locations and
368 * all the fumbling with configure.in and acconfig.h
369 * were *way* more work than the feature itself :-(
371 * - Because a generic redirect template was needed for
372 * this, tinygif = 3 now uses the same.
374 * - Moved GIFs, and other static HTTP response templates
379 * - Removed some >400 CRs again (Jon, you really worked
382 * Revision 1.3 2001/05/20 01:21:20 jongfoster
383 * Version 2.9.4 checkin.
384 * - Merged popupfile and cookiefile, and added control over PCRS
385 * filtering, in new "actionsfile".
386 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
387 * file error you now get a message box (in the Win32 GUI) rather
388 * than the program exiting with no explanation.
389 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
391 * - Removed tabs from "config"
392 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
393 * - Bumped up version number.
395 * Revision 1.2 2001/05/17 23:01:01 oes
396 * - Cleaned CRLF's from the sources and related files
398 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
399 * Initial import of version 2.9.3 source tree
402 *********************************************************************/
405 /* Declare struct FILE for vars and funcs. */
408 /* Need time_t for file_list */
412 * Include appropriate regular expression libraries.
413 * Note that pcrs and pcre (native) are needed for cgi
414 * and are included anyway.
417 #if defined(REGEX_PCRE) || defined (REGEX_GNU)
419 #endif /* defined(REGEX_PCRE) || defined (REGEX_GNU) */
433 #if defined(REGEX_PCRE)
435 # include "pcreposix.h"
437 # include <pcreposix.h>
439 #endif /* defined(REGEX_PCRE) */
441 #if defined(REGEX_GNU)
442 # include "gnu_regex.h"
447 #endif /* def AMIGA */
451 * I don't want to have to #include all this just for the declaration
452 * of SOCKET. However, it looks like we have to...
463 * The type used by sockets. On UNIX it's an int. Microsoft decided to
464 * make it an unsigned.
467 typedef SOCKET jb_socket;
468 #define JB_INVALID_SOCKET INVALID_SOCKET
469 #else /* ndef _WIN32 */
470 typedef int jb_socket;
471 #define JB_INVALID_SOCKET (-1)
472 #endif /* ndef _WIN32 */
476 * Error codes. Functions returning these should return a jb_err
478 #define JB_ERR_OK 0 /* Success, no error */
479 #define JB_ERR_MEMORY 1 /* Out of memory */
480 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
481 #define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
482 #define JB_ERR_PARSE 4 /* Error parsing file */
483 #define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
484 /* CGI actions editor. */
489 * This macro is used to free a pointer that may be NULL
491 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
494 /* Fix a problem with Solaris. There should be no effect on other
496 * Solaris's isspace() is a macro which uses it's argument directly
497 * as an array index. Therefore we need to make sure that high-bit
498 * characters generate +ve values, and ideally we also want to make
499 * the argument match the declared parameter type of "int".
501 * Note: Remember to #include <ctype.h> if you use these macros.
503 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
504 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
505 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
508 * Use for statically allocated buffers if you have no other choice.
509 * Remember to check the length of what you write into the buffer
510 * - we don't want any buffer overflows!
512 #define BUFFER_SIZE 5000
515 * Buffer size for capturing struct hostent data in the
516 * gethostby(name|addr)_r library calls. Since we don't
517 * loop over gethostbyname_r, the buffer must be sufficient
518 * to accomodate multiple IN A RRs, as used in DNS round robin
519 * load balancing. W3C's wwwlib uses 1K, so that should be
520 * good enough for us, too.
522 #define HOSTENT_BUFFER_SIZE 1024
525 * So you can say "while (FOREVER) { ...do something... }"
529 /* Default IP and port to listen on */
530 #define HADDR_DEFAULT "127.0.0.1"
531 #define HADDR_PORT 8118
533 /* Forward defs for various structures */
535 /* Need this for struct client_state */
536 struct configuration_spec;
539 /* Generic linked list of strings */
544 struct list_entry *next;
549 struct list_entry *first;
550 struct list_entry *last;
554 /* A map from a string to another string */
560 struct map_entry *next;
565 struct map_entry *first;
566 struct map_entry *last;
572 char *cmd; /* Whole command line: method, URL, Version */
573 char *ocmd; /* Backup of original cmd for CLF logging */
574 char *gpc; /* HTTP method: GET, POST, .. */
575 char *url; /* The URL */
576 char *ver; /* Protocol version */
577 int status; /* HTTP Status */
579 char *host; /* Host part of URL */
580 int port; /* Port of URL or 80 (default) */
581 char *path; /* Path of URL */
582 char *hostport; /* host[:port] */
583 int ssl; /* Flag if protocol is https */
585 char *host_ip_addr_str; /* String with dotted decimal representation
586 * of host's IP. NULL before connect_to() */
588 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
589 char **dvec; /* List of pointers to the strings in dbuffer. */
590 int dcount; /* How many parts to this domain? (length of dvec) */
594 * Response generated by CGI, blocker, or error handler
598 char *status; /* HTTP status (string) */
599 struct list headers[1]; /* List of header lines */
600 char *head; /* Formatted http response head */
601 size_t head_length; /* Length of http response head */
602 char *body; /* HTTP document body */
603 size_t content_length; /* Length of body, REQUIRED if binary body */
604 int is_static; /* Nonzero if the content will never change and
605 * should be cached by the brwoser (e.g. images) */
611 char *spec; /* The string which was parsed to produce this */
612 /* url_spec. Used for debugging or display only. */
614 /* Hostname matching, or dbuffer == NULL to match all hosts */
615 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
616 char **dvec; /* List of pointers to the strings in dbuffer. */
617 int dcount; /* How many parts to this domain? (length of dvec) */
618 int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
621 int port; /* The port number, or 0 to match all ports. */
624 char *path; /* The path prefix (if not using regex), or source */
626 int pathlen; /* ==strlen(path). Needed for prefix matching. */
628 regex_t *preg; /* Regex for matching path part */
632 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
633 #else /* ifndef REGEX */
634 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0 }
635 #endif /* ndef REGEX */
637 /* Constants for host part matching in URLs */
638 #define ANCHOR_LEFT 1
639 #define ANCHOR_RIGHT 2
651 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
652 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
654 /* Bits for csp->content_type */
655 #define CT_TEXT 1 /* Suitable for pcrs filtering */
656 #define CT_GIF 2 /* Suitable for GIF filtering */
657 #define CT_TABOO 4 /* DONT filter */
659 #define ACTION_MASK_ALL (~0U)
661 #define ACTION_MOST_COMPATIBLE 0x00000000UL
663 #define ACTION_BLOCK 0x00000001UL
664 #define ACTION_DEANIMATE 0x00000002UL
665 #define ACTION_DOWNGRADE 0x00000004UL
666 #define ACTION_FAST_REDIRECTS 0x00000008UL
667 #define ACTION_HIDE_FORWARDED 0x00000010UL
668 #define ACTION_HIDE_FROM 0x00000020UL
669 #define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */
670 #define ACTION_HIDE_USER_AGENT 0x00000080UL
671 #define ACTION_IMAGE 0x00000100UL
672 #define ACTION_IMAGE_BLOCKER 0x00000200UL
673 #define ACTION_NO_COMPRESSION 0x00000400UL
674 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
675 #define ACTION_NO_COOKIE_READ 0x00001000UL
676 #define ACTION_NO_COOKIE_SET 0x00002000UL
677 #define ACTION_NO_POPUPS 0x00004000UL
678 #define ACTION_VANILLA_WAFER 0x00008000UL
679 #define ACTION_LIMIT_CONNECT 0x00010000UL
681 #define ACTION_STRING_DEANIMATE 0
682 #define ACTION_STRING_FROM 1
683 #define ACTION_STRING_IMAGE_BLOCKER 2
684 #define ACTION_STRING_REFERER 3
685 #define ACTION_STRING_USER_AGENT 4
686 #define ACTION_STRING_LIMIT_CONNECT 5
687 #define ACTION_STRING_COUNT 6
689 #define ACTION_MULTI_ADD_HEADER 0
690 #define ACTION_MULTI_WAFER 1
691 #define ACTION_MULTI_FILTER 2
692 #define ACTION_MULTI_COUNT 3
696 * This structure contains a list of actions to apply to a URL.
697 * It only contains positive instructions - no "-" options.
698 * It is not used to store the actions list itself, only for
699 * url_actions() to return the current values.
701 struct current_action_spec
703 unsigned long flags; /* a bit set to "1" = add action */
705 /* For those actions that require parameters: */
707 /* each entry is valid if & only if corresponding entry in "add" set. */
708 char * string[ACTION_STRING_COUNT];
711 struct list multi[ACTION_MULTI_COUNT][1];
716 * This structure contains a set of changes to actions.
717 * It can contain both positive and negative instructions.
718 * It is used to store an entry in the actions list.
722 unsigned long mask; /* a bit set to "0" = remove action */
723 unsigned long add; /* a bit set to "1" = add action */
725 /* For those actions that require parameters: */
727 /* each entry is valid if & only if corresponding entry in "add" set. */
728 char * string[ACTION_STRING_COUNT];
730 /* Strings to remove. */
731 struct list multi_remove[ACTION_MULTI_COUNT][1];
733 /* If nonzero, remove *all* strings. */
734 int multi_remove_all[ACTION_MULTI_COUNT];
737 struct list multi_add[ACTION_MULTI_COUNT][1];
741 * This structure is used to store the actions list.
743 * It contains a URL pattern, and the chages to the actions.
744 * It is a linked list.
748 struct url_spec url[1];
750 struct action_spec action[1];
752 struct url_actions * next;
757 * Flags for use in csp->flags
759 #define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
760 * Cleared when the thread associated with
761 * this structure dies. */
762 #define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
763 * transfer encoding */
764 #define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
765 * it would normally have been blocked. */
766 #define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
767 #define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
768 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
771 * The state of a Privoxy processing thread.
775 /* The proxy's configuration */
776 struct configuration_spec * config;
778 /* The actions to perform on the current request */
779 struct current_action_spec action[1];
781 /* socket to talk to client (web browser) */
784 /* socket to talk to server (web server or proxy) */
787 /* Multi-purpose flag container, see CSP_FLAG_* above */
788 unsigned short int flags;
791 * Client PC's IP address, as reported by the accept()_ function.
792 * Both as string and number
798 /* Our IP address and hostname, i.e. the IP address that
799 the client used to reach us, and the associated hostname,
802 char *my_ip_addr_str;
805 /* The URL that was requested */
806 struct http_request http[1];
808 /* An I/O buffer used for buffering data read from the client */
811 /* List of all headers for this request */
812 struct list headers[1];
814 /* List of all cookies for this request */
815 struct list cookie_list[1];
817 /* MIME-Type key, see CT_* above */
818 unsigned short int content_type;
820 /* The "X-Forwarded-For:" header sent by the client */
823 /* files associated with this client */
824 struct file_list *actions_list;
826 struct file_list *rlist; /* pcrs job file */
827 size_t content_length; /* Length after content modification */
830 struct file_list *tlist; /* trustfile */
831 #endif /* def FEATURE_TRUST */
833 struct client_state *next;
838 * A function to add a header
840 typedef jb_err (*add_header_func_ptr)(struct client_state *);
843 * A function to process a header
845 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
848 * List of functions to run on a list of headers
854 parser_func_ptr parser;
859 * List of available CGI functions.
861 struct cgi_dispatcher
863 const char * const name;
864 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
865 const char * const description;
870 * A data file used by Privoxy. Kept in a linked list.
875 * this is a pointer to the data structures associated with the file.
876 * Read-only once the structure has been created.
880 /* Normally NULL. When we are finished with file (i.e. when we have
881 * loaded a new one), set to a pointer to an unloader function.
882 * Unloader will be called by sweep() (called from main loop) when
883 * all clients using this file are done. This prevents threading
886 void (*unloader)(void *);
888 /* Used internally by sweep(). Do not access from elsewhere. */
891 /* Following variables allow us to check if file has been changed.
892 * Read-only once the structure has been created.
897 /* Pointer to next entry in the linked list of all "file_list"s.
898 * This linked list is so that sweep() can navigate it.
899 * Since sweep() can remove items from the list, we must be careful
900 * to only access this value from main thread (when we know sweep
903 struct file_list *next;
910 struct url_spec url[1];
912 struct block_spec *next;
914 #endif /* def FEATURE_TRUST */
917 #define SOCKS_NONE 0 /* Don't use a SOCKS server */
918 #define SOCKS_4 40 /* original SOCKS 4 protocol */
919 #define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
923 struct url_spec url[1];
925 /* Connection type - must be a SOCKS_xxx constant */
932 /* Parent HTTP proxy */
936 /* For the linked list */
937 struct forward_spec *next;
939 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
943 * This struct represents one filter (one block) from
944 * the re_filterfile. If there is more than one filter
945 * in the file, the file will be represented by a
946 * chained list of re_filterfile specs.
948 struct re_filterfile_spec
950 char *name; /* Name from FILTER: statement in re_filterfile */
951 char *description; /* Description from FILTER: statement in re_filterfile */
952 struct list patterns[1]; /* The patterns from the re_filterfile */
953 pcrs_job *joblist; /* The resulting compiled pcrs_jobs */
954 struct re_filterfile_spec *next; /* The pointer for chaining */
958 #define ACL_PERMIT 1 /* accept connection request */
959 #define ACL_DENY 2 /* reject connection request */
961 struct access_control_addr
968 struct access_control_list
970 struct access_control_addr src[1];
971 struct access_control_addr dst[1];
974 struct access_control_list *next;
976 #endif /* def FEATURE_ACL */
979 /* Maximum number of loaders (actions, re_filter, ...) */
983 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
984 #define RUNTIME_FEATURE_CGI_TOGGLE 2
988 * Data loaded from the configuration file.
990 * (Anomaly: toggle is still handled through a global, not this structure)
992 struct configuration_spec
997 /* Features that can be enabled/disabled throuigh the config file */
998 unsigned feature_flags;
1000 const char *logfile;
1002 const char *confdir;
1004 const char *actions_file;
1006 /* The administrator's email address */
1007 char *admin_address;
1009 /* A URL with info on this proxy */
1010 char *proxy_info_url;
1012 const char *re_filterfile;
1014 #ifdef FEATURE_COOKIE_JAR
1015 const char * jarfile;
1017 #endif /* def FEATURE_COOKIE_JAR */
1020 * Port and IP to bind to.
1021 * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1026 /* Size limit for IOB */
1027 size_t buffer_limit;
1029 #ifdef FEATURE_TRUST
1030 const char * trustfile;
1032 struct list trust_info[1];
1033 struct url_spec *trust_list[64];
1034 #endif /* def FEATURE_TRUST */
1037 struct access_control_list *acl;
1038 #endif /* def FEATURE_ACL */
1040 struct forward_spec *forward;
1042 /* All options from the config file, HTML-formatted */
1045 /* the configuration file object. */
1046 struct file_list *config_file_list;
1048 /* List of loaders */
1049 int (*loaders[NLOADERS])(struct client_state *);
1051 /* bool, nonzero if we need to bind() to the new port */
1056 #define SZ(X) (sizeof(X) / sizeof(*X))
1058 #ifdef FEATURE_FORCE_LOAD
1059 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1060 #endif /* def FEATURE_FORCE_LOAD */
1062 #ifdef FEATURE_NO_GIFS
1063 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1065 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1066 #endif /* def FEATURE_NO_GIFS */
1069 /* Hardwired URLs */
1070 #define HOME_PAGE_URL "http://ijbswa.sourceforge.net"
1071 #define REDIRECT_URL HOME_PAGE_URL "/redirect.php?v=" VERSION "&to="
1074 * The "hosts" to intercept and display CGI pages.
1075 * First one is a hostname only, second one can specify host and path.
1078 * 1) Do not specify the http: prefix
1079 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1080 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1082 #define CGI_SITE_1_HOST "p.p"
1083 #define CGI_SITE_2_HOST "config.privoxy.org"
1084 #define CGI_SITE_2_PATH ""
1087 * The prefix for CGI pages. Written out in generated HTML.
1088 * INCLUDES the trailing slash.
1090 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1093 /* HTTP snipplets */
1094 static const char CSUCCEED[] =
1095 "HTTP/1.0 200 Connection established\n"
1096 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1098 static const char CHEADER[] =
1099 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1101 static const char CFORBIDDEN[] =
1102 "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";
1108 #endif /* ndef PROJECT_H_INCLUDED */