1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 #define PROJECT_H_VERSION "$Id: project.h,v 1.66 2002/04/15 19:06:43 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.66 2002/04/15 19:06:43 jongfoster
42 * Revision 1.65 2002/04/04 00:36:36 gliptak
43 * always use pcre for matching
45 * Revision 1.64 2002/04/03 22:28:03 gliptak
46 * Removed references to gnu_regex
48 * Revision 1.63 2002/03/31 17:19:00 jongfoster
49 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
51 * Revision 1.62 2002/03/26 22:48:49 swa
54 * Revision 1.61 2002/03/26 22:29:55 swa
55 * we have a new homepage!
57 * Revision 1.60 2002/03/24 15:52:17 jongfoster
58 * Changing CGI URL prefixes for new name
60 * Revision 1.59 2002/03/24 15:23:33 jongfoster
63 * Revision 1.58 2002/03/24 13:25:43 swa
64 * name change related issues
66 * Revision 1.57 2002/03/16 20:28:34 oes
67 * Added descriptions to the filters so users will know what they select in the cgi editor
69 * Revision 1.56 2002/03/13 20:27:30 oes
70 * Fixing bug with CT_TABOO
72 * Revision 1.55 2002/03/12 01:42:50 oes
73 * Introduced modular filters
75 * Revision 1.54 2002/03/09 20:03:52 jongfoster
76 * - Making various functions return int rather than size_t.
77 * (Undoing a recent change). Since size_t is unsigned on
78 * Windows, functions like read_socket that return -1 on
79 * error cannot return a size_t.
81 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
82 * crashes, and also frequently caused JB to jump to 100%
83 * CPU and stay there. (Because it thought it had just
84 * read ((unsigned)-1) == 4Gb of data...)
86 * - The signature of write_socket has changed, it now simply
87 * returns success=0/failure=nonzero.
89 * - Trying to get rid of a few warnings --with-debug on
90 * Windows, I've introduced a new type "jb_socket". This is
91 * used for the socket file descriptors. On Windows, this
92 * is SOCKET (a typedef for unsigned). Everywhere else, it's
93 * an int. The error value can't be -1 any more, so it's
94 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
95 * Windows it maps to the #define INVALID_SOCKET.)
97 * - The signature of bind_port has changed.
99 * Revision 1.53 2002/03/08 16:48:55 oes
100 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
102 * Revision 1.52 2002/03/07 03:46:17 oes
103 * Fixed compiler warnings
105 * Revision 1.51 2002/03/05 04:52:42 oes
106 * Deleted non-errlog debugging code
108 * Revision 1.50 2002/03/04 19:32:07 oes
109 * Changed default port to 8118
111 * Revision 1.49 2002/03/04 18:28:55 oes
112 * Deleted PID_FILE_NAME
114 * Revision 1.48 2002/03/03 14:50:40 oes
115 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
117 * Revision 1.47 2002/02/20 23:15:13 jongfoster
118 * Parsing functions now handle out-of-memory gracefully by returning
121 * Revision 1.46 2002/01/17 21:06:09 jongfoster
122 * Now #defining the URLs of the config interface
124 * Minor changes to struct http_request and struct url_spec due to
125 * standardizing that struct http_request is used to represent a URL, and
126 * struct url_spec is used to represent a URL pattern. (Before, URLs were
127 * represented as seperate variables and a partially-filled-in url_spec).
129 * Revision 1.45 2002/01/09 14:33:27 oes
130 * Added HOSTENT_BUFFER_SIZE
132 * Revision 1.44 2001/12/30 14:07:32 steudten
133 * - Add signal handling (unix)
134 * - Add SIGHUP handler (unix)
135 * - Add creation of pidfile (unix)
136 * - Add action 'top' in rc file (RH)
137 * - Add entry 'SIGNALS' to manpage
138 * - Add exit message to logfile (unix)
140 * Revision 1.43 2001/11/22 21:57:51 jongfoster
141 * Making action_spec->flags into an unsigned long rather than just an
143 * Adding ACTION_NO_COOKIE_KEEP
145 * Revision 1.42 2001/11/05 21:42:41 steudten
146 * Include DBG() macro.
148 * Revision 1.41 2001/10/28 19:12:06 jongfoster
149 * Adding ijb_toupper()
151 * Revision 1.40 2001/10/26 17:40:47 oes
152 * Moved ijb_isspace and ijb_tolower to project.h
153 * Removed http->user_agent, csp->referrer and csp->accept_types
155 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
156 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
157 * macro when called with a cast; so moving the cast to the macro def'n
158 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
159 * doesn't make macro expansion complain. Hope this works for everyone else
162 * Revision 1.38 2001/10/23 21:19:04 jongfoster
163 * New error-handling support: jb_err type and JB_ERR_xxx constants
164 * CGI functions now return a jb_err, and their parameters map is const.
165 * Support for RUNTIME_FEATUREs to enable/disable config editor
166 * Adding a few comments
168 * Revision 1.37 2001/10/14 22:14:01 jongfoster
169 * Removing name_length field from struct cgi_dispatcher, as this is
170 * now calculated at runtime from the "name" field.
172 * Revision 1.36 2001/10/10 16:45:15 oes
173 * Added LIMIT_CONNECT action and string
174 * Fixed HTTP message line termination
175 * Added CFORBIDDEN HTTP message
177 * Revision 1.35 2001/10/07 18:06:43 oes
178 * Added status member to struct http_request
180 * Revision 1.34 2001/10/07 15:45:25 oes
181 * Added url member to struct http_request and commented all
186 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
188 * Replaced struct client_state members rejected,
189 * force, active and toggled_on with "flags" bitmap.
191 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
193 * Added buffer_limit to struct configuration_spec
195 * Revision 1.33 2001/09/20 13:30:08 steudten
197 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
198 * Last case will set z to NULL in free(z) and thats bad..
200 * Revision 1.32 2001/09/16 23:02:51 jongfoster
203 * Revision 1.31 2001/09/16 13:20:29 jongfoster
204 * Rewrite of list library. Now has seperate header and list_entry
205 * structures. Also added a large sprinking of assert()s to the list
208 * Revision 1.30 2001/09/13 23:52:00 jongfoster
209 * Support for both static and dynamically generated CGI pages
211 * Revision 1.29 2001/09/13 23:29:43 jongfoster
212 * Defining FORWARD_SPEC_INITIALIZER
214 * Revision 1.28 2001/09/13 23:05:50 jongfoster
215 * Changing the string paramater to the header parsers a "const".
217 * Revision 1.27 2001/08/05 16:06:20 jongfoster
218 * Modifiying "struct map" so that there are now separate header and
219 * "map_entry" structures. This means that functions which modify a
220 * map no longer need to return a pointer to the modified map.
221 * Also, it no longer reverses the order of the entries (which may be
222 * important with some advanced template substitutions).
224 * Revision 1.26 2001/07/30 22:08:36 jongfoster
225 * Tidying up #defines:
226 * - All feature #defines are now of the form FEATURE_xxx
227 * - Permanently turned off WIN_GUI_EDIT
228 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
230 * Revision 1.25 2001/07/29 18:43:08 jongfoster
231 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
234 * Revision 1.24 2001/07/25 17:20:27 oes
235 * Introduced http->user_agent
237 * Revision 1.23 2001/07/18 12:32:23 oes
238 * - Added ACTION_STRING_DEANIMATE
239 * - moved #define freez from jcc.h to project.h
241 * Revision 1.22 2001/07/15 17:51:41 jongfoster
242 * Renaming #define STATIC to STATIC_PCRE
244 * Revision 1.21 2001/07/13 14:03:19 oes
245 * - Reorganized regex header inclusion and #defines to
246 * comply to the scheme in configure.in
247 * - Added csp->content_type and its CT_* keys
248 * - Added ACTION_DEANIMATE
249 * - Removed all #ifdef PCRS
251 * Revision 1.20 2001/06/29 21:45:41 oes
252 * Indentation, CRLF->LF, Tab-> Space
254 * Revision 1.19 2001/06/29 13:33:36 oes
255 * - Improved comments
256 * - Introduced http_request.host_ip_addr_str
257 * - Introduced http_response.head_length
258 * - Introduced config.my_ip_addr_str, config.my_hostname,
259 * config.admin_address and config.proxy_info_url
260 * - Removed config.proxy_args_header and config.proxy_args_trailer,
261 * renamed config.proxy_args_invocation to config.proxy_args
262 * - Removed HTML snipplets and GIFs
263 * - Removed logentry from cancelled commit
265 * Revision 1.18 2001/06/09 10:57:39 jongfoster
266 * Adding definition of BUFFER_SIZE.
267 * Changing struct cgi_dispatcher to use "const" strings.
269 * Revision 1.17 2001/06/07 23:15:09 jongfoster
270 * Merging ACL and forward files into config file.
271 * Moving struct gateway members into struct forward_spec
272 * Removing config->proxy_args_gateways
273 * Cosmetic: Adding a few comments
275 * Revision 1.16 2001/06/04 18:31:58 swa
276 * files are now prefixed with either `confdir' or `logdir'.
277 * `make redhat-dist' replaces both entries confdir and logdir
280 * Revision 1.15 2001/06/04 11:28:53 swa
281 * redirect did not work due to missing /
283 * Revision 1.14 2001/06/03 11:03:48 oes
285 * added struct http_response,
286 * changed struct interceptors to struct cgi_dispatcher,
287 * moved HTML stuff to cgi.h
289 * Revision 1.13 2001/06/01 20:05:36 jongfoster
290 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
291 * constant, and removed csp->tinygif.
293 * Revision 1.12 2001/06/01 18:49:17 jongfoster
294 * Replaced "list_share" with "list" - the tiny memory gain was not
295 * worth the extra complexity.
297 * Revision 1.11 2001/06/01 10:32:47 oes
298 * Added constants for anchoring selection bitmap
300 * Revision 1.10 2001/05/31 21:33:53 jongfoster
301 * Changes for new actions file, replacing permissionsfile
302 * and parts of the config file. Also added support for
305 * Revision 1.9 2001/05/31 17:32:31 oes
307 * - Enhanced domain part globbing with infix and prefix asterisk
308 * matching and optional unanchored operation
310 * Revision 1.8 2001/05/29 20:09:15 joergs
311 * HTTP_REDIRECT_TEMPLATE fixed.
313 * Revision 1.7 2001/05/29 09:50:24 jongfoster
314 * Unified blocklist/imagelist/actionslist.
315 * File format is still under discussion, but the internal changes
318 * Also modified interceptor behaviour:
319 * - We now intercept all URLs beginning with one of the following
320 * prefixes (and *only* these prefixes):
322 * * http://ijbswa.sf.net/config/
323 * * http://ijbswa.sourceforge.net/config/
324 * - New interceptors "home page" - go to http://i.j.b/ to see it.
325 * - Internal changes so that intercepted and fast redirect pages
326 * are not replaced with an image.
327 * - Interceptors now have the option to send a binary page direct
328 * to the client. (i.e. ijb-send-banner uses this)
329 * - Implemented show-url-info interceptor. (Which is why I needed
330 * the above interceptors changes - a typical URL is
331 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
332 * The previous mechanism would not have intercepted that, and
333 * if it had been intercepted then it then it would have replaced
336 * Revision 1.6 2001/05/27 22:17:04 oes
338 * - re_process_buffer no longer writes the modified buffer
339 * to the client, which was very ugly. It now returns the
340 * buffer, which it is then written by chat.
342 * - content_length now adjusts the Content-Length: header
343 * for modified documents rather than crunch()ing it.
344 * (Length info in csp->content_length, which is 0 for
345 * unmodified documents)
347 * - For this to work, sed() is called twice when filtering.
349 * Revision 1.5 2001/05/26 00:28:36 jongfoster
350 * Automatic reloading of config file.
351 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
352 * Most of the global variables have been moved to a new
353 * struct configuration_spec, accessed through csp->config->globalname
354 * Most of the globals remaining are used by the Win32 GUI.
356 * Revision 1.4 2001/05/22 18:46:04 oes
358 * - Enabled filtering banners by size rather than URL
359 * by adding patterns that replace all standard banner
360 * sizes with the "Junkbuster" gif to the re_filterfile
362 * - Enabled filtering WebBugs by providing a pattern
363 * which kills all 1x1 images
365 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
366 * which is selected by the (nonstandard and therefore
367 * capital) letter 'U' in the option string.
368 * It causes the quantifiers to be ungreedy by default.
369 * Appending a ? turns back to greedy (!).
371 * - Added a new interceptor ijb-send-banner, which
372 * sends back the "Junkbuster" gif. Without imagelist or
373 * MSIE detection support, or if tinygif = 1, or the
374 * URL isn't recognized as an imageurl, a lame HTML
375 * explanation is sent instead.
377 * - Added new feature, which permits blocking remote
378 * script redirects and firing back a local redirect
380 * The feature is conditionally compiled, i.e. it
381 * can be disabled with --disable-fast-redirects,
382 * plus it must be activated by a "fast-redirects"
383 * line in the config file, has its own log level
384 * and of course wants to be displayed by show-proxy-args
385 * Note: Boy, all the #ifdefs in 1001 locations and
386 * all the fumbling with configure.in and acconfig.h
387 * were *way* more work than the feature itself :-(
389 * - Because a generic redirect template was needed for
390 * this, tinygif = 3 now uses the same.
392 * - Moved GIFs, and other static HTTP response templates
397 * - Removed some >400 CRs again (Jon, you really worked
400 * Revision 1.3 2001/05/20 01:21:20 jongfoster
401 * Version 2.9.4 checkin.
402 * - Merged popupfile and cookiefile, and added control over PCRS
403 * filtering, in new "actionsfile".
404 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
405 * file error you now get a message box (in the Win32 GUI) rather
406 * than the program exiting with no explanation.
407 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
409 * - Removed tabs from "config"
410 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
411 * - Bumped up version number.
413 * Revision 1.2 2001/05/17 23:01:01 oes
414 * - Cleaned CRLF's from the sources and related files
416 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
417 * Initial import of version 2.9.3 source tree
420 *********************************************************************/
423 /* Declare struct FILE for vars and funcs. */
426 /* Need time_t for file_list */
430 * Include appropriate regular expression libraries.
431 * Note that pcrs and pcre (native) are needed for cgi
432 * and are included anyway.
448 # include "pcreposix.h"
450 # include <pcreposix.h>
455 #endif /* def AMIGA */
459 * I don't want to have to #include all this just for the declaration
460 * of SOCKET. However, it looks like we have to...
474 * The type used by sockets. On UNIX it's an int. Microsoft decided to
475 * make it an unsigned.
478 typedef SOCKET jb_socket;
479 #define JB_INVALID_SOCKET INVALID_SOCKET
480 #else /* ndef _WIN32 */
481 typedef int jb_socket;
482 #define JB_INVALID_SOCKET (-1)
483 #endif /* ndef _WIN32 */
487 * Error codes. Functions returning these should return a jb_err
489 #define JB_ERR_OK 0 /* Success, no error */
490 #define JB_ERR_MEMORY 1 /* Out of memory */
491 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
492 #define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
493 #define JB_ERR_PARSE 4 /* Error parsing file */
494 #define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
495 /* CGI actions editor. */
500 * This macro is used to free a pointer that may be NULL
502 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
505 /* Fix a problem with Solaris. There should be no effect on other
507 * Solaris's isspace() is a macro which uses it's argument directly
508 * as an array index. Therefore we need to make sure that high-bit
509 * characters generate +ve values, and ideally we also want to make
510 * the argument match the declared parameter type of "int".
512 * Note: Remember to #include <ctype.h> if you use these macros.
514 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
515 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
516 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
519 * Use for statically allocated buffers if you have no other choice.
520 * Remember to check the length of what you write into the buffer
521 * - we don't want any buffer overflows!
523 #define BUFFER_SIZE 5000
526 * Max length of CGI parameters (arbitrary limit)
528 #define CGI_PARAM_LEN_MAX 500
531 * Buffer size for capturing struct hostent data in the
532 * gethostby(name|addr)_r library calls. Since we don't
533 * loop over gethostbyname_r, the buffer must be sufficient
534 * to accomodate multiple IN A RRs, as used in DNS round robin
535 * load balancing. W3C's wwwlib uses 1K, so that should be
536 * good enough for us, too.
538 #define HOSTENT_BUFFER_SIZE 1024
541 * So you can say "while (FOREVER) { ...do something... }"
545 /* Default IP and port to listen on */
546 #define HADDR_DEFAULT "127.0.0.1"
547 #define HADDR_PORT 8118
549 /* Forward defs for various structures */
551 /* Need this for struct client_state */
552 struct configuration_spec;
555 /* Generic linked list of strings */
560 struct list_entry *next;
565 struct list_entry *first;
566 struct list_entry *last;
570 /* A map from a string to another string */
576 struct map_entry *next;
581 struct map_entry *first;
582 struct map_entry *last;
588 char *cmd; /* Whole command line: method, URL, Version */
589 char *ocmd; /* Backup of original cmd for CLF logging */
590 char *gpc; /* HTTP method: GET, POST, .. */
591 char *url; /* The URL */
592 char *ver; /* Protocol version */
593 int status; /* HTTP Status */
595 char *host; /* Host part of URL */
596 int port; /* Port of URL or 80 (default) */
597 char *path; /* Path of URL */
598 char *hostport; /* host[:port] */
599 int ssl; /* Flag if protocol is https */
601 char *host_ip_addr_str; /* String with dotted decimal representation
602 * of host's IP. NULL before connect_to() */
604 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
605 char **dvec; /* List of pointers to the strings in dbuffer. */
606 int dcount; /* How many parts to this domain? (length of dvec) */
610 * Response generated by CGI, blocker, or error handler
614 char *status; /* HTTP status (string) */
615 struct list headers[1]; /* List of header lines */
616 char *head; /* Formatted http response head */
617 size_t head_length; /* Length of http response head */
618 char *body; /* HTTP document body */
619 size_t content_length; /* Length of body, REQUIRED if binary body */
620 int is_static; /* Nonzero if the content will never change and
621 * should be cached by the brwoser (e.g. images) */
627 char *spec; /* The string which was parsed to produce this */
628 /* url_spec. Used for debugging or display only. */
630 /* Hostname matching, or dbuffer == NULL to match all hosts */
631 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
632 char **dvec; /* List of pointers to the strings in dbuffer. */
633 int dcount; /* How many parts to this domain? (length of dvec) */
634 int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
637 int port; /* The port number, or 0 to match all ports. */
640 char *path; /* The path prefix (if not using regex), or source */
642 int pathlen; /* ==strlen(path). Needed for prefix matching. */
643 regex_t *preg; /* Regex for matching path part */
645 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
647 /* Constants for host part matching in URLs */
648 #define ANCHOR_LEFT 1
649 #define ANCHOR_RIGHT 2
661 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
662 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
664 /* Bits for csp->content_type */
665 #define CT_TEXT 1 /* Suitable for pcrs filtering */
666 #define CT_GIF 2 /* Suitable for GIF filtering */
667 #define CT_TABOO 4 /* DONT filter */
669 #define ACTION_MASK_ALL (~0U)
671 #define ACTION_MOST_COMPATIBLE 0x00000000UL
673 #define ACTION_BLOCK 0x00000001UL
674 #define ACTION_DEANIMATE 0x00000002UL
675 #define ACTION_DOWNGRADE 0x00000004UL
676 #define ACTION_FAST_REDIRECTS 0x00000008UL
677 #define ACTION_HIDE_FORWARDED 0x00000010UL
678 #define ACTION_HIDE_FROM 0x00000020UL
679 #define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */
680 #define ACTION_HIDE_USER_AGENT 0x00000080UL
681 #define ACTION_IMAGE 0x00000100UL
682 #define ACTION_IMAGE_BLOCKER 0x00000200UL
683 #define ACTION_NO_COMPRESSION 0x00000400UL
684 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
685 #define ACTION_NO_COOKIE_READ 0x00001000UL
686 #define ACTION_NO_COOKIE_SET 0x00002000UL
687 #define ACTION_NO_POPUPS 0x00004000UL
688 #define ACTION_VANILLA_WAFER 0x00008000UL
689 #define ACTION_LIMIT_CONNECT 0x00010000UL
691 #define ACTION_STRING_DEANIMATE 0
692 #define ACTION_STRING_FROM 1
693 #define ACTION_STRING_IMAGE_BLOCKER 2
694 #define ACTION_STRING_REFERER 3
695 #define ACTION_STRING_USER_AGENT 4
696 #define ACTION_STRING_LIMIT_CONNECT 5
697 #define ACTION_STRING_COUNT 6
699 #define ACTION_MULTI_ADD_HEADER 0
700 #define ACTION_MULTI_WAFER 1
701 #define ACTION_MULTI_FILTER 2
702 #define ACTION_MULTI_COUNT 3
706 * This structure contains a list of actions to apply to a URL.
707 * It only contains positive instructions - no "-" options.
708 * It is not used to store the actions list itself, only for
709 * url_actions() to return the current values.
711 struct current_action_spec
713 unsigned long flags; /* a bit set to "1" = add action */
715 /* For those actions that require parameters: */
717 /* each entry is valid if & only if corresponding entry in "add" set. */
718 char * string[ACTION_STRING_COUNT];
721 struct list multi[ACTION_MULTI_COUNT][1];
726 * This structure contains a set of changes to actions.
727 * It can contain both positive and negative instructions.
728 * It is used to store an entry in the actions list.
732 unsigned long mask; /* a bit set to "0" = remove action */
733 unsigned long add; /* a bit set to "1" = add action */
735 /* For those actions that require parameters: */
737 /* each entry is valid if & only if corresponding entry in "add" set. */
738 char * string[ACTION_STRING_COUNT];
740 /* Strings to remove. */
741 struct list multi_remove[ACTION_MULTI_COUNT][1];
743 /* If nonzero, remove *all* strings. */
744 int multi_remove_all[ACTION_MULTI_COUNT];
747 struct list multi_add[ACTION_MULTI_COUNT][1];
751 * This structure is used to store the actions list.
753 * It contains a URL pattern, and the chages to the actions.
754 * It is a linked list.
758 struct url_spec url[1];
760 struct action_spec action[1];
762 struct url_actions * next;
767 * Flags for use in csp->flags
769 #define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
770 * Cleared when the thread associated with
771 * this structure dies. */
772 #define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
773 * transfer encoding */
774 #define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
775 * it would normally have been blocked. */
776 #define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
777 #define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
778 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
781 * Maximum number of actions files. This limit is arbitrary - it's just used
784 #define MAX_ACTION_FILES 10
787 * The state of a Privoxy processing thread.
791 /* The proxy's configuration */
792 struct configuration_spec * config;
794 /* The actions to perform on the current request */
795 struct current_action_spec action[1];
797 /* socket to talk to client (web browser) */
800 /* socket to talk to server (web server or proxy) */
803 /* Multi-purpose flag container, see CSP_FLAG_* above */
804 unsigned short int flags;
807 * Client PC's IP address, as reported by the accept()_ function.
808 * Both as string and number
814 /* Our IP address and hostname, i.e. the IP address that
815 the client used to reach us, and the associated hostname,
818 char *my_ip_addr_str;
821 /* The URL that was requested */
822 struct http_request http[1];
824 /* An I/O buffer used for buffering data read from the client */
827 /* List of all headers for this request */
828 struct list headers[1];
830 /* List of all cookies for this request */
831 struct list cookie_list[1];
833 /* MIME-Type key, see CT_* above */
834 unsigned short int content_type;
836 /* The "X-Forwarded-For:" header sent by the client */
839 /* files associated with this client */
840 struct file_list *actions_list[MAX_ACTION_FILES];
842 struct file_list *rlist; /* pcrs job file */
843 size_t content_length; /* Length after content modification */
846 struct file_list *tlist; /* trustfile */
847 #endif /* def FEATURE_TRUST */
849 struct client_state *next;
854 * A function to add a header
856 typedef jb_err (*add_header_func_ptr)(struct client_state *);
859 * A function to process a header
861 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
864 * List of functions to run on a list of headers
870 parser_func_ptr parser;
875 * List of available CGI functions.
877 struct cgi_dispatcher
879 const char * const name;
880 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
881 const char * const description;
886 * A data file used by Privoxy. Kept in a linked list.
891 * this is a pointer to the data structures associated with the file.
892 * Read-only once the structure has been created.
896 /* Normally NULL. When we are finished with file (i.e. when we have
897 * loaded a new one), set to a pointer to an unloader function.
898 * Unloader will be called by sweep() (called from main loop) when
899 * all clients using this file are done. This prevents threading
902 void (*unloader)(void *);
904 /* Used internally by sweep(). Do not access from elsewhere. */
907 /* Following variables allow us to check if file has been changed.
908 * Read-only once the structure has been created.
913 /* Pointer to next entry in the linked list of all "file_list"s.
914 * This linked list is so that sweep() can navigate it.
915 * Since sweep() can remove items from the list, we must be careful
916 * to only access this value from main thread (when we know sweep
919 struct file_list *next;
926 struct url_spec url[1];
928 struct block_spec *next;
930 #endif /* def FEATURE_TRUST */
933 #define SOCKS_NONE 0 /* Don't use a SOCKS server */
934 #define SOCKS_4 40 /* original SOCKS 4 protocol */
935 #define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
939 struct url_spec url[1];
941 /* Connection type - must be a SOCKS_xxx constant */
948 /* Parent HTTP proxy */
952 /* For the linked list */
953 struct forward_spec *next;
955 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
959 * This struct represents one filter (one block) from
960 * the re_filterfile. If there is more than one filter
961 * in the file, the file will be represented by a
962 * chained list of re_filterfile specs.
964 struct re_filterfile_spec
966 char *name; /* Name from FILTER: statement in re_filterfile */
967 char *description; /* Description from FILTER: statement in re_filterfile */
968 struct list patterns[1]; /* The patterns from the re_filterfile */
969 pcrs_job *joblist; /* The resulting compiled pcrs_jobs */
970 struct re_filterfile_spec *next; /* The pointer for chaining */
974 #define ACL_PERMIT 1 /* accept connection request */
975 #define ACL_DENY 2 /* reject connection request */
977 struct access_control_addr
984 struct access_control_list
986 struct access_control_addr src[1];
987 struct access_control_addr dst[1];
990 struct access_control_list *next;
992 #endif /* def FEATURE_ACL */
995 /* Maximum number of loaders (actions, re_filter, ...) */
999 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1000 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1004 * Data loaded from the configuration file.
1006 * (Anomaly: toggle is still handled through a global, not this structure)
1008 struct configuration_spec
1013 /* Features that can be enabled/disabled through the config file */
1014 unsigned feature_flags;
1016 const char *logfile;
1018 const char *confdir;
1020 const char *actions_file[MAX_ACTION_FILES];
1021 const char *actions_file_short[MAX_ACTION_FILES];
1023 /* The administrator's email address */
1024 char *admin_address;
1026 /* A URL with info on this proxy */
1027 char *proxy_info_url;
1029 const char *re_filterfile;
1031 #ifdef FEATURE_COOKIE_JAR
1032 const char * jarfile;
1034 #endif /* def FEATURE_COOKIE_JAR */
1037 * Port and IP to bind to.
1038 * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1043 /* Size limit for IOB */
1044 size_t buffer_limit;
1046 #ifdef FEATURE_TRUST
1047 const char * trustfile;
1049 struct list trust_info[1];
1050 struct url_spec *trust_list[64];
1051 #endif /* def FEATURE_TRUST */
1054 struct access_control_list *acl;
1055 #endif /* def FEATURE_ACL */
1057 struct forward_spec *forward;
1059 /* All options from the config file, HTML-formatted */
1062 /* the configuration file object. */
1063 struct file_list *config_file_list;
1065 /* List of loaders */
1066 int (*loaders[NLOADERS])(struct client_state *);
1068 /* bool, nonzero if we need to bind() to the new port */
1073 #define SZ(X) (sizeof(X) / sizeof(*X))
1075 #ifdef FEATURE_FORCE_LOAD
1076 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1077 #endif /* def FEATURE_FORCE_LOAD */
1079 #ifdef FEATURE_NO_GIFS
1080 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1082 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1083 #endif /* def FEATURE_NO_GIFS */
1086 /* Hardwired URLs */
1087 #define HOME_PAGE_URL "http://www.privoxy.org"
1088 #define REDIRECT_URL HOME_PAGE_URL "/redirect.php?v=" VERSION "&to="
1091 * The "hosts" to intercept and display CGI pages.
1092 * First one is a hostname only, second one can specify host and path.
1095 * 1) Do not specify the http: prefix
1096 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1097 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1099 #define CGI_SITE_1_HOST "p.p"
1100 #define CGI_SITE_2_HOST "config.privoxy.org"
1101 #define CGI_SITE_2_PATH ""
1104 * The prefix for CGI pages. Written out in generated HTML.
1105 * INCLUDES the trailing slash.
1107 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1110 /* HTTP snipplets */
1111 static const char CSUCCEED[] =
1112 "HTTP/1.0 200 Connection established\n"
1113 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1115 static const char CHEADER[] =
1116 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1118 static const char CFORBIDDEN[] =
1119 "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";
1125 #endif /* ndef PROJECT_H_INCLUDED */