1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 #define PROJECT_H_VERSION "$Id: project.h,v 1.58 2002/03/24 13:25:43 swa 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://ijbswa.sourceforge.net
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.58 2002/03/24 13:25:43 swa
40 * name change related issues
42 * Revision 1.57 2002/03/16 20:28:34 oes
43 * Added descriptions to the filters so users will know what they select in the cgi editor
45 * Revision 1.56 2002/03/13 20:27:30 oes
46 * Fixing bug with CT_TABOO
48 * Revision 1.55 2002/03/12 01:42:50 oes
49 * Introduced modular filters
51 * Revision 1.54 2002/03/09 20:03:52 jongfoster
52 * - Making various functions return int rather than size_t.
53 * (Undoing a recent change). Since size_t is unsigned on
54 * Windows, functions like read_socket that return -1 on
55 * error cannot return a size_t.
57 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
58 * crashes, and also frequently caused JB to jump to 100%
59 * CPU and stay there. (Because it thought it had just
60 * read ((unsigned)-1) == 4Gb of data...)
62 * - The signature of write_socket has changed, it now simply
63 * returns success=0/failure=nonzero.
65 * - Trying to get rid of a few warnings --with-debug on
66 * Windows, I've introduced a new type "jb_socket". This is
67 * used for the socket file descriptors. On Windows, this
68 * is SOCKET (a typedef for unsigned). Everywhere else, it's
69 * an int. The error value can't be -1 any more, so it's
70 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
71 * Windows it maps to the #define INVALID_SOCKET.)
73 * - The signature of bind_port has changed.
75 * Revision 1.53 2002/03/08 16:48:55 oes
76 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
78 * Revision 1.52 2002/03/07 03:46:17 oes
79 * Fixed compiler warnings
81 * Revision 1.51 2002/03/05 04:52:42 oes
82 * Deleted non-errlog debugging code
84 * Revision 1.50 2002/03/04 19:32:07 oes
85 * Changed default port to 8118
87 * Revision 1.49 2002/03/04 18:28:55 oes
88 * Deleted PID_FILE_NAME
90 * Revision 1.48 2002/03/03 14:50:40 oes
91 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
93 * Revision 1.47 2002/02/20 23:15:13 jongfoster
94 * Parsing functions now handle out-of-memory gracefully by returning
97 * Revision 1.46 2002/01/17 21:06:09 jongfoster
98 * Now #defining the URLs of the config interface
100 * Minor changes to struct http_request and struct url_spec due to
101 * standardizing that struct http_request is used to represent a URL, and
102 * struct url_spec is used to represent a URL pattern. (Before, URLs were
103 * represented as seperate variables and a partially-filled-in url_spec).
105 * Revision 1.45 2002/01/09 14:33:27 oes
106 * Added HOSTENT_BUFFER_SIZE
108 * Revision 1.44 2001/12/30 14:07:32 steudten
109 * - Add signal handling (unix)
110 * - Add SIGHUP handler (unix)
111 * - Add creation of pidfile (unix)
112 * - Add action 'top' in rc file (RH)
113 * - Add entry 'SIGNALS' to manpage
114 * - Add exit message to logfile (unix)
116 * Revision 1.43 2001/11/22 21:57:51 jongfoster
117 * Making action_spec->flags into an unsigned long rather than just an
119 * Adding ACTION_NO_COOKIE_KEEP
121 * Revision 1.42 2001/11/05 21:42:41 steudten
122 * Include DBG() macro.
124 * Revision 1.41 2001/10/28 19:12:06 jongfoster
125 * Adding ijb_toupper()
127 * Revision 1.40 2001/10/26 17:40:47 oes
128 * Moved ijb_isspace and ijb_tolower to project.h
129 * Removed http->user_agent, csp->referrer and csp->accept_types
131 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
132 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
133 * macro when called with a cast; so moving the cast to the macro def'n
134 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
135 * doesn't make macro expansion complain. Hope this works for everyone else
138 * Revision 1.38 2001/10/23 21:19:04 jongfoster
139 * New error-handling support: jb_err type and JB_ERR_xxx constants
140 * CGI functions now return a jb_err, and their parameters map is const.
141 * Support for RUNTIME_FEATUREs to enable/disable config editor
142 * Adding a few comments
144 * Revision 1.37 2001/10/14 22:14:01 jongfoster
145 * Removing name_length field from struct cgi_dispatcher, as this is
146 * now calculated at runtime from the "name" field.
148 * Revision 1.36 2001/10/10 16:45:15 oes
149 * Added LIMIT_CONNECT action and string
150 * Fixed HTTP message line termination
151 * Added CFORBIDDEN HTTP message
153 * Revision 1.35 2001/10/07 18:06:43 oes
154 * Added status member to struct http_request
156 * Revision 1.34 2001/10/07 15:45:25 oes
157 * Added url member to struct http_request and commented all
162 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
164 * Replaced struct client_state members rejected,
165 * force, active and toggled_on with "flags" bitmap.
167 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
169 * Added buffer_limit to struct configuration_spec
171 * Revision 1.33 2001/09/20 13:30:08 steudten
173 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
174 * Last case will set z to NULL in free(z) and thats bad..
176 * Revision 1.32 2001/09/16 23:02:51 jongfoster
179 * Revision 1.31 2001/09/16 13:20:29 jongfoster
180 * Rewrite of list library. Now has seperate header and list_entry
181 * structures. Also added a large sprinking of assert()s to the list
184 * Revision 1.30 2001/09/13 23:52:00 jongfoster
185 * Support for both static and dynamically generated CGI pages
187 * Revision 1.29 2001/09/13 23:29:43 jongfoster
188 * Defining FORWARD_SPEC_INITIALIZER
190 * Revision 1.28 2001/09/13 23:05:50 jongfoster
191 * Changing the string paramater to the header parsers a "const".
193 * Revision 1.27 2001/08/05 16:06:20 jongfoster
194 * Modifiying "struct map" so that there are now separate header and
195 * "map_entry" structures. This means that functions which modify a
196 * map no longer need to return a pointer to the modified map.
197 * Also, it no longer reverses the order of the entries (which may be
198 * important with some advanced template substitutions).
200 * Revision 1.26 2001/07/30 22:08:36 jongfoster
201 * Tidying up #defines:
202 * - All feature #defines are now of the form FEATURE_xxx
203 * - Permanently turned off WIN_GUI_EDIT
204 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
206 * Revision 1.25 2001/07/29 18:43:08 jongfoster
207 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
210 * Revision 1.24 2001/07/25 17:20:27 oes
211 * Introduced http->user_agent
213 * Revision 1.23 2001/07/18 12:32:23 oes
214 * - Added ACTION_STRING_DEANIMATE
215 * - moved #define freez from jcc.h to project.h
217 * Revision 1.22 2001/07/15 17:51:41 jongfoster
218 * Renaming #define STATIC to STATIC_PCRE
220 * Revision 1.21 2001/07/13 14:03:19 oes
221 * - Reorganized regex header inclusion and #defines to
222 * comply to the scheme in configure.in
223 * - Added csp->content_type and its CT_* keys
224 * - Added ACTION_DEANIMATE
225 * - Removed all #ifdef PCRS
227 * Revision 1.20 2001/06/29 21:45:41 oes
228 * Indentation, CRLF->LF, Tab-> Space
230 * Revision 1.19 2001/06/29 13:33:36 oes
231 * - Improved comments
232 * - Introduced http_request.host_ip_addr_str
233 * - Introduced http_response.head_length
234 * - Introduced config.my_ip_addr_str, config.my_hostname,
235 * config.admin_address and config.proxy_info_url
236 * - Removed config.proxy_args_header and config.proxy_args_trailer,
237 * renamed config.proxy_args_invocation to config.proxy_args
238 * - Removed HTML snipplets and GIFs
239 * - Removed logentry from cancelled commit
241 * Revision 1.18 2001/06/09 10:57:39 jongfoster
242 * Adding definition of BUFFER_SIZE.
243 * Changing struct cgi_dispatcher to use "const" strings.
245 * Revision 1.17 2001/06/07 23:15:09 jongfoster
246 * Merging ACL and forward files into config file.
247 * Moving struct gateway members into struct forward_spec
248 * Removing config->proxy_args_gateways
249 * Cosmetic: Adding a few comments
251 * Revision 1.16 2001/06/04 18:31:58 swa
252 * files are now prefixed with either `confdir' or `logdir'.
253 * `make redhat-dist' replaces both entries confdir and logdir
256 * Revision 1.15 2001/06/04 11:28:53 swa
257 * redirect did not work due to missing /
259 * Revision 1.14 2001/06/03 11:03:48 oes
261 * added struct http_response,
262 * changed struct interceptors to struct cgi_dispatcher,
263 * moved HTML stuff to cgi.h
265 * Revision 1.13 2001/06/01 20:05:36 jongfoster
266 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
267 * constant, and removed csp->tinygif.
269 * Revision 1.12 2001/06/01 18:49:17 jongfoster
270 * Replaced "list_share" with "list" - the tiny memory gain was not
271 * worth the extra complexity.
273 * Revision 1.11 2001/06/01 10:32:47 oes
274 * Added constants for anchoring selection bitmap
276 * Revision 1.10 2001/05/31 21:33:53 jongfoster
277 * Changes for new actions file, replacing permissionsfile
278 * and parts of the config file. Also added support for
281 * Revision 1.9 2001/05/31 17:32:31 oes
283 * - Enhanced domain part globbing with infix and prefix asterisk
284 * matching and optional unanchored operation
286 * Revision 1.8 2001/05/29 20:09:15 joergs
287 * HTTP_REDIRECT_TEMPLATE fixed.
289 * Revision 1.7 2001/05/29 09:50:24 jongfoster
290 * Unified blocklist/imagelist/actionslist.
291 * File format is still under discussion, but the internal changes
294 * Also modified interceptor behaviour:
295 * - We now intercept all URLs beginning with one of the following
296 * prefixes (and *only* these prefixes):
298 * * http://ijbswa.sf.net/config/
299 * * http://ijbswa.sourceforge.net/config/
300 * - New interceptors "home page" - go to http://i.j.b/ to see it.
301 * - Internal changes so that intercepted and fast redirect pages
302 * are not replaced with an image.
303 * - Interceptors now have the option to send a binary page direct
304 * to the client. (i.e. ijb-send-banner uses this)
305 * - Implemented show-url-info interceptor. (Which is why I needed
306 * the above interceptors changes - a typical URL is
307 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
308 * The previous mechanism would not have intercepted that, and
309 * if it had been intercepted then it then it would have replaced
312 * Revision 1.6 2001/05/27 22:17:04 oes
314 * - re_process_buffer no longer writes the modified buffer
315 * to the client, which was very ugly. It now returns the
316 * buffer, which it is then written by chat.
318 * - content_length now adjusts the Content-Length: header
319 * for modified documents rather than crunch()ing it.
320 * (Length info in csp->content_length, which is 0 for
321 * unmodified documents)
323 * - For this to work, sed() is called twice when filtering.
325 * Revision 1.5 2001/05/26 00:28:36 jongfoster
326 * Automatic reloading of config file.
327 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
328 * Most of the global variables have been moved to a new
329 * struct configuration_spec, accessed through csp->config->globalname
330 * Most of the globals remaining are used by the Win32 GUI.
332 * Revision 1.4 2001/05/22 18:46:04 oes
334 * - Enabled filtering banners by size rather than URL
335 * by adding patterns that replace all standard banner
336 * sizes with the "Junkbuster" gif to the re_filterfile
338 * - Enabled filtering WebBugs by providing a pattern
339 * which kills all 1x1 images
341 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
342 * which is selected by the (nonstandard and therefore
343 * capital) letter 'U' in the option string.
344 * It causes the quantifiers to be ungreedy by default.
345 * Appending a ? turns back to greedy (!).
347 * - Added a new interceptor ijb-send-banner, which
348 * sends back the "Junkbuster" gif. Without imagelist or
349 * MSIE detection support, or if tinygif = 1, or the
350 * URL isn't recognized as an imageurl, a lame HTML
351 * explanation is sent instead.
353 * - Added new feature, which permits blocking remote
354 * script redirects and firing back a local redirect
356 * The feature is conditionally compiled, i.e. it
357 * can be disabled with --disable-fast-redirects,
358 * plus it must be activated by a "fast-redirects"
359 * line in the config file, has its own log level
360 * and of course wants to be displayed by show-proxy-args
361 * Note: Boy, all the #ifdefs in 1001 locations and
362 * all the fumbling with configure.in and acconfig.h
363 * were *way* more work than the feature itself :-(
365 * - Because a generic redirect template was needed for
366 * this, tinygif = 3 now uses the same.
368 * - Moved GIFs, and other static HTTP response templates
373 * - Removed some >400 CRs again (Jon, you really worked
376 * Revision 1.3 2001/05/20 01:21:20 jongfoster
377 * Version 2.9.4 checkin.
378 * - Merged popupfile and cookiefile, and added control over PCRS
379 * filtering, in new "actionsfile".
380 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
381 * file error you now get a message box (in the Win32 GUI) rather
382 * than the program exiting with no explanation.
383 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
385 * - Removed tabs from "config"
386 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
387 * - Bumped up version number.
389 * Revision 1.2 2001/05/17 23:01:01 oes
390 * - Cleaned CRLF's from the sources and related files
392 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
393 * Initial import of version 2.9.3 source tree
396 *********************************************************************/
399 /* Declare struct FILE for vars and funcs. */
402 /* Need time_t for file_list */
406 * Include appropriate regular expression libraries.
407 * Note that pcrs and pcre (native) are needed for cgi
408 * and are included anyway.
411 #if defined(REGEX_PCRE) || defined (REGEX_GNU)
413 #endif /* defined(REGEX_PCRE) || defined (REGEX_GNU) */
427 #if defined(REGEX_PCRE)
429 # include "pcreposix.h"
431 # include <pcreposix.h>
433 #endif /* defined(REGEX_PCRE) */
435 #if defined(REGEX_GNU)
436 # include "gnu_regex.h"
441 #endif /* def AMIGA */
445 * I don't want to have to #include all this just for the declaration
446 * of SOCKET. However, it looks like we have to...
457 * The type used by sockets. On UNIX it's an int. Microsoft decided to
458 * make it an unsigned.
461 typedef SOCKET jb_socket;
462 #define JB_INVALID_SOCKET INVALID_SOCKET
463 #else /* ndef _WIN32 */
464 typedef int jb_socket;
465 #define JB_INVALID_SOCKET (-1)
466 #endif /* ndef _WIN32 */
470 * Error codes. Functions returning these should return a jb_err
472 #define JB_ERR_OK 0 /* Success, no error */
473 #define JB_ERR_MEMORY 1 /* Out of memory */
474 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
475 #define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
476 #define JB_ERR_PARSE 4 /* Error parsing file */
477 #define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
478 /* CGI actions editor. */
483 * This macro is used to free a pointer that may be NULL
485 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
488 /* Fix a problem with Solaris. There should be no effect on other
490 * Solaris's isspace() is a macro which uses it's argument directly
491 * as an array index. Therefore we need to make sure that high-bit
492 * characters generate +ve values, and ideally we also want to make
493 * the argument match the declared parameter type of "int".
495 * Note: Remember to #include <ctype.h> if you use these macros.
497 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
498 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
499 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
502 * Use for statically allocated buffers if you have no other choice.
503 * Remember to check the length of what you write into the buffer
504 * - we don't want any buffer overflows!
506 #define BUFFER_SIZE 5000
509 * Buffer size for capturing struct hostent data in the
510 * gethostby(name|addr)_r library calls. Since we don't
511 * loop over gethostbyname_r, the buffer must be sufficient
512 * to accomodate multiple IN A RRs, as used in DNS round robin
513 * load balancing. W3C's wwwlib uses 1K, so that should be
514 * good enough for us, too.
516 #define HOSTENT_BUFFER_SIZE 1024
519 * So you can say "while (FOREVER) { ...do something... }"
523 /* Default IP and port to listen on */
524 #define HADDR_DEFAULT "127.0.0.1"
525 #define HADDR_PORT 8118
527 /* Forward defs for various structures */
529 /* Need this for struct client_state */
530 struct configuration_spec;
533 /* Generic linked list of strings */
538 struct list_entry *next;
543 struct list_entry *first;
544 struct list_entry *last;
548 /* A map from a string to another string */
554 struct map_entry *next;
559 struct map_entry *first;
560 struct map_entry *last;
566 char *cmd; /* Whole command line: method, URL, Version */
567 char *ocmd; /* Backup of original cmd for CLF logging */
568 char *gpc; /* HTTP method: GET, POST, .. */
569 char *url; /* The URL */
570 char *ver; /* Protocol version */
571 int status; /* HTTP Status */
573 char *host; /* Host part of URL */
574 int port; /* Port of URL or 80 (default) */
575 char *path; /* Path of URL */
576 char *hostport; /* host[:port] */
577 int ssl; /* Flag if protocol is https */
579 char *host_ip_addr_str; /* String with dotted decimal representation
580 * of host's IP. NULL before connect_to() */
582 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
583 char **dvec; /* List of pointers to the strings in dbuffer. */
584 int dcount; /* How many parts to this domain? (length of dvec) */
588 * Response generated by CGI, blocker, or error handler
592 char *status; /* HTTP status (string) */
593 struct list headers[1]; /* List of header lines */
594 char *head; /* Formatted http response head */
595 size_t head_length; /* Length of http response head */
596 char *body; /* HTTP document body */
597 size_t content_length; /* Length of body, REQUIRED if binary body */
598 int is_static; /* Nonzero if the content will never change and
599 * should be cached by the brwoser (e.g. images) */
605 char *spec; /* The string which was parsed to produce this */
606 /* url_spec. Used for debugging or display only. */
608 /* Hostname matching, or dbuffer == NULL to match all hosts */
609 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
610 char **dvec; /* List of pointers to the strings in dbuffer. */
611 int dcount; /* How many parts to this domain? (length of dvec) */
612 int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
615 int port; /* The port number, or 0 to match all ports. */
618 char *path; /* The path prefix (if not using regex), or source */
620 int pathlen; /* ==strlen(path). Needed for prefix matching. */
622 regex_t *preg; /* Regex for matching path part */
626 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
627 #else /* ifndef REGEX */
628 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0 }
629 #endif /* ndef REGEX */
631 /* Constants for host part matching in URLs */
632 #define ANCHOR_LEFT 1
633 #define ANCHOR_RIGHT 2
645 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
646 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
648 /* Bits for csp->content_type */
649 #define CT_TEXT 1 /* Suitable for pcrs filtering */
650 #define CT_GIF 2 /* Suitable for GIF filtering */
651 #define CT_TABOO 4 /* DONT filter */
653 #define ACTION_MASK_ALL (~0U)
655 #define ACTION_MOST_COMPATIBLE 0x00000000UL
657 #define ACTION_BLOCK 0x00000001UL
658 #define ACTION_DEANIMATE 0x00000002UL
659 #define ACTION_DOWNGRADE 0x00000004UL
660 #define ACTION_FAST_REDIRECTS 0x00000008UL
661 #define ACTION_HIDE_FORWARDED 0x00000010UL
662 #define ACTION_HIDE_FROM 0x00000020UL
663 #define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */
664 #define ACTION_HIDE_USER_AGENT 0x00000080UL
665 #define ACTION_IMAGE 0x00000100UL
666 #define ACTION_IMAGE_BLOCKER 0x00000200UL
667 #define ACTION_NO_COMPRESSION 0x00000400UL
668 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
669 #define ACTION_NO_COOKIE_READ 0x00001000UL
670 #define ACTION_NO_COOKIE_SET 0x00002000UL
671 #define ACTION_NO_POPUPS 0x00004000UL
672 #define ACTION_VANILLA_WAFER 0x00008000UL
673 #define ACTION_LIMIT_CONNECT 0x00010000UL
675 #define ACTION_STRING_DEANIMATE 0
676 #define ACTION_STRING_FROM 1
677 #define ACTION_STRING_IMAGE_BLOCKER 2
678 #define ACTION_STRING_REFERER 3
679 #define ACTION_STRING_USER_AGENT 4
680 #define ACTION_STRING_LIMIT_CONNECT 5
681 #define ACTION_STRING_COUNT 6
683 #define ACTION_MULTI_ADD_HEADER 0
684 #define ACTION_MULTI_WAFER 1
685 #define ACTION_MULTI_FILTER 2
686 #define ACTION_MULTI_COUNT 3
690 * This structure contains a list of actions to apply to a URL.
691 * It only contains positive instructions - no "-" options.
692 * It is not used to store the actions list itself, only for
693 * url_actions() to return the current values.
695 struct current_action_spec
697 unsigned long flags; /* a bit set to "1" = add action */
699 /* For those actions that require parameters: */
701 /* each entry is valid if & only if corresponding entry in "add" set. */
702 char * string[ACTION_STRING_COUNT];
705 struct list multi[ACTION_MULTI_COUNT][1];
710 * This structure contains a set of changes to actions.
711 * It can contain both positive and negative instructions.
712 * It is used to store an entry in the actions list.
716 unsigned long mask; /* a bit set to "0" = remove action */
717 unsigned long add; /* a bit set to "1" = add action */
719 /* For those actions that require parameters: */
721 /* each entry is valid if & only if corresponding entry in "add" set. */
722 char * string[ACTION_STRING_COUNT];
724 /* Strings to remove. */
725 struct list multi_remove[ACTION_MULTI_COUNT][1];
727 /* If nonzero, remove *all* strings. */
728 int multi_remove_all[ACTION_MULTI_COUNT];
731 struct list multi_add[ACTION_MULTI_COUNT][1];
735 * This structure is used to store the actions list.
737 * It contains a URL pattern, and the chages to the actions.
738 * It is a linked list.
742 struct url_spec url[1];
744 struct action_spec action[1];
746 struct url_actions * next;
751 * Flags for use in csp->flags
753 #define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
754 * Cleared when the thread associated with
755 * this structure dies. */
756 #define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
757 * transfer encoding */
758 #define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
759 * it would normally have been blocked. */
760 #define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
761 #define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
762 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
765 * The state of a Privoxy processing thread.
769 /* The proxy's configuration */
770 struct configuration_spec * config;
772 /* The actions to perform on the current request */
773 struct current_action_spec action[1];
775 /* socket to talk to client (web browser) */
778 /* socket to talk to server (web server or proxy) */
781 /* Multi-purpose flag container, see CSP_FLAG_* above */
782 unsigned short int flags;
785 * Client PC's IP address, as reported by the accept()_ function.
786 * Both as string and number
792 /* Our IP address and hostname, i.e. the IP address that
793 the client used to reach us, and the associated hostname,
796 char *my_ip_addr_str;
799 /* The URL that was requested */
800 struct http_request http[1];
802 /* An I/O buffer used for buffering data read from the client */
805 /* List of all headers for this request */
806 struct list headers[1];
808 /* List of all cookies for this request */
809 struct list cookie_list[1];
811 /* MIME-Type key, see CT_* above */
812 unsigned short int content_type;
814 /* The "X-Forwarded-For:" header sent by the client */
817 /* files associated with this client */
818 struct file_list *actions_list;
820 struct file_list *rlist; /* pcrs job file */
821 size_t content_length; /* Length after content modification */
824 struct file_list *tlist; /* trustfile */
825 #endif /* def FEATURE_TRUST */
827 struct client_state *next;
832 * A function to add a header
834 typedef jb_err (*add_header_func_ptr)(struct client_state *);
837 * A function to process a header
839 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
842 * List of functions to run on a list of headers
848 parser_func_ptr parser;
853 * List of available CGI functions.
855 struct cgi_dispatcher
857 const char * const name;
858 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
859 const char * const description;
864 * A data file used by Privoxy. Kept in a linked list.
869 * this is a pointer to the data structures associated with the file.
870 * Read-only once the structure has been created.
874 /* Normally NULL. When we are finished with file (i.e. when we have
875 * loaded a new one), set to a pointer to an unloader function.
876 * Unloader will be called by sweep() (called from main loop) when
877 * all clients using this file are done. This prevents threading
880 void (*unloader)(void *);
882 /* Used internally by sweep(). Do not access from elsewhere. */
885 /* Following variables allow us to check if file has been changed.
886 * Read-only once the structure has been created.
891 /* Pointer to next entry in the linked list of all "file_list"s.
892 * This linked list is so that sweep() can navigate it.
893 * Since sweep() can remove items from the list, we must be careful
894 * to only access this value from main thread (when we know sweep
897 struct file_list *next;
904 struct url_spec url[1];
906 struct block_spec *next;
908 #endif /* def FEATURE_TRUST */
911 #define SOCKS_NONE 0 /* Don't use a SOCKS server */
912 #define SOCKS_4 40 /* original SOCKS 4 protocol */
913 #define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
917 struct url_spec url[1];
919 /* Connection type - must be a SOCKS_xxx constant */
926 /* Parent HTTP proxy */
930 /* For the linked list */
931 struct forward_spec *next;
933 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
937 * This struct represents one filter (one block) from
938 * the re_filterfile. If there is more than one filter
939 * in the file, the file will be represented by a
940 * chained list of re_filterfile specs.
942 struct re_filterfile_spec
944 char *name; /* Name from FILTER: statement in re_filterfile */
945 char *description; /* Description from FILTER: statement in re_filterfile */
946 struct list patterns[1]; /* The patterns from the re_filterfile */
947 pcrs_job *joblist; /* The resulting compiled pcrs_jobs */
948 struct re_filterfile_spec *next; /* The pointer for chaining */
952 #define ACL_PERMIT 1 /* accept connection request */
953 #define ACL_DENY 2 /* reject connection request */
955 struct access_control_addr
962 struct access_control_list
964 struct access_control_addr src[1];
965 struct access_control_addr dst[1];
968 struct access_control_list *next;
970 #endif /* def FEATURE_ACL */
973 /* Maximum number of loaders (actions, re_filter, ...) */
977 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
978 #define RUNTIME_FEATURE_CGI_TOGGLE 2
982 * Data loaded from the configuration file.
984 * (Anomaly: toggle is still handled through a global, not this structure)
986 struct configuration_spec
991 /* Features that can be enabled/disabled throuigh the config file */
992 unsigned feature_flags;
998 const char *actions_file;
1000 /* The administrator's email address */
1001 char *admin_address;
1003 /* A URL with info on this proxy */
1004 char *proxy_info_url;
1006 const char *re_filterfile;
1008 #ifdef FEATURE_COOKIE_JAR
1009 const char * jarfile;
1011 #endif /* def FEATURE_COOKIE_JAR */
1014 * Port and IP to bind to.
1015 * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1020 /* Size limit for IOB */
1021 size_t buffer_limit;
1023 #ifdef FEATURE_TRUST
1024 const char * trustfile;
1026 struct list trust_info[1];
1027 struct url_spec *trust_list[64];
1028 #endif /* def FEATURE_TRUST */
1031 struct access_control_list *acl;
1032 #endif /* def FEATURE_ACL */
1034 struct forward_spec *forward;
1036 /* All options from the config file, HTML-formatted */
1039 /* the configuration file object. */
1040 struct file_list *config_file_list;
1042 /* List of loaders */
1043 int (*loaders[NLOADERS])(struct client_state *);
1045 /* bool, nonzero if we need to bind() to the new port */
1050 #define SZ(X) (sizeof(X) / sizeof(*X))
1052 #ifdef FEATURE_FORCE_LOAD
1053 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1054 #endif /* def FEATURE_FORCE_LOAD */
1056 #ifdef FEATURE_NO_GIFS
1057 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1059 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1060 #endif /* def FEATURE_NO_GIFS */
1063 /* Hardwired URLs */
1064 #define HOME_PAGE_URL "http://ijbswa.sourceforge.net"
1065 #define REDIRECT_URL HOME_PAGE_URL "/redirect.php?v=" VERSION "&to="
1068 * The "hosts" to intercept and display CGI pages.
1069 * First one is a hostname only, second one can specify host and path.
1072 * 1) Do not specify the http: prefix
1073 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1074 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1076 #define CGI_SITE_1_HOST "i.j.b"
1077 #define CGI_SITE_2_HOST "ijbswa.sourceforge.net"
1078 #define CGI_SITE_2_PATH "/config"
1081 * The prefix for CGI pages. Written out in generated HTML.
1082 * INCLUDES the trailing slash.
1084 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1087 /* HTTP snipplets */
1088 static const char CSUCCEED[] =
1089 "HTTP/1.0 200 Connection established\n"
1090 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1092 static const char CHEADER[] =
1093 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1095 static const char CFORBIDDEN[] =
1096 "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";
1102 #endif /* ndef PROJECT_H_INCLUDED */