1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 #define PROJECT_H_VERSION "$Id: project.h,v 1.59 2002/03/24 15:23:33 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://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.59 2002/03/24 15:23:33 jongfoster
42 * Revision 1.58 2002/03/24 13:25:43 swa
43 * name change related issues
45 * Revision 1.57 2002/03/16 20:28:34 oes
46 * Added descriptions to the filters so users will know what they select in the cgi editor
48 * Revision 1.56 2002/03/13 20:27:30 oes
49 * Fixing bug with CT_TABOO
51 * Revision 1.55 2002/03/12 01:42:50 oes
52 * Introduced modular filters
54 * Revision 1.54 2002/03/09 20:03:52 jongfoster
55 * - Making various functions return int rather than size_t.
56 * (Undoing a recent change). Since size_t is unsigned on
57 * Windows, functions like read_socket that return -1 on
58 * error cannot return a size_t.
60 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
61 * crashes, and also frequently caused JB to jump to 100%
62 * CPU and stay there. (Because it thought it had just
63 * read ((unsigned)-1) == 4Gb of data...)
65 * - The signature of write_socket has changed, it now simply
66 * returns success=0/failure=nonzero.
68 * - Trying to get rid of a few warnings --with-debug on
69 * Windows, I've introduced a new type "jb_socket". This is
70 * used for the socket file descriptors. On Windows, this
71 * is SOCKET (a typedef for unsigned). Everywhere else, it's
72 * an int. The error value can't be -1 any more, so it's
73 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
74 * Windows it maps to the #define INVALID_SOCKET.)
76 * - The signature of bind_port has changed.
78 * Revision 1.53 2002/03/08 16:48:55 oes
79 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
81 * Revision 1.52 2002/03/07 03:46:17 oes
82 * Fixed compiler warnings
84 * Revision 1.51 2002/03/05 04:52:42 oes
85 * Deleted non-errlog debugging code
87 * Revision 1.50 2002/03/04 19:32:07 oes
88 * Changed default port to 8118
90 * Revision 1.49 2002/03/04 18:28:55 oes
91 * Deleted PID_FILE_NAME
93 * Revision 1.48 2002/03/03 14:50:40 oes
94 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
96 * Revision 1.47 2002/02/20 23:15:13 jongfoster
97 * Parsing functions now handle out-of-memory gracefully by returning
100 * Revision 1.46 2002/01/17 21:06:09 jongfoster
101 * Now #defining the URLs of the config interface
103 * Minor changes to struct http_request and struct url_spec due to
104 * standardizing that struct http_request is used to represent a URL, and
105 * struct url_spec is used to represent a URL pattern. (Before, URLs were
106 * represented as seperate variables and a partially-filled-in url_spec).
108 * Revision 1.45 2002/01/09 14:33:27 oes
109 * Added HOSTENT_BUFFER_SIZE
111 * Revision 1.44 2001/12/30 14:07:32 steudten
112 * - Add signal handling (unix)
113 * - Add SIGHUP handler (unix)
114 * - Add creation of pidfile (unix)
115 * - Add action 'top' in rc file (RH)
116 * - Add entry 'SIGNALS' to manpage
117 * - Add exit message to logfile (unix)
119 * Revision 1.43 2001/11/22 21:57:51 jongfoster
120 * Making action_spec->flags into an unsigned long rather than just an
122 * Adding ACTION_NO_COOKIE_KEEP
124 * Revision 1.42 2001/11/05 21:42:41 steudten
125 * Include DBG() macro.
127 * Revision 1.41 2001/10/28 19:12:06 jongfoster
128 * Adding ijb_toupper()
130 * Revision 1.40 2001/10/26 17:40:47 oes
131 * Moved ijb_isspace and ijb_tolower to project.h
132 * Removed http->user_agent, csp->referrer and csp->accept_types
134 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
135 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
136 * macro when called with a cast; so moving the cast to the macro def'n
137 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
138 * doesn't make macro expansion complain. Hope this works for everyone else
141 * Revision 1.38 2001/10/23 21:19:04 jongfoster
142 * New error-handling support: jb_err type and JB_ERR_xxx constants
143 * CGI functions now return a jb_err, and their parameters map is const.
144 * Support for RUNTIME_FEATUREs to enable/disable config editor
145 * Adding a few comments
147 * Revision 1.37 2001/10/14 22:14:01 jongfoster
148 * Removing name_length field from struct cgi_dispatcher, as this is
149 * now calculated at runtime from the "name" field.
151 * Revision 1.36 2001/10/10 16:45:15 oes
152 * Added LIMIT_CONNECT action and string
153 * Fixed HTTP message line termination
154 * Added CFORBIDDEN HTTP message
156 * Revision 1.35 2001/10/07 18:06:43 oes
157 * Added status member to struct http_request
159 * Revision 1.34 2001/10/07 15:45:25 oes
160 * Added url member to struct http_request and commented all
165 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
167 * Replaced struct client_state members rejected,
168 * force, active and toggled_on with "flags" bitmap.
170 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
172 * Added buffer_limit to struct configuration_spec
174 * Revision 1.33 2001/09/20 13:30:08 steudten
176 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
177 * Last case will set z to NULL in free(z) and thats bad..
179 * Revision 1.32 2001/09/16 23:02:51 jongfoster
182 * Revision 1.31 2001/09/16 13:20:29 jongfoster
183 * Rewrite of list library. Now has seperate header and list_entry
184 * structures. Also added a large sprinking of assert()s to the list
187 * Revision 1.30 2001/09/13 23:52:00 jongfoster
188 * Support for both static and dynamically generated CGI pages
190 * Revision 1.29 2001/09/13 23:29:43 jongfoster
191 * Defining FORWARD_SPEC_INITIALIZER
193 * Revision 1.28 2001/09/13 23:05:50 jongfoster
194 * Changing the string paramater to the header parsers a "const".
196 * Revision 1.27 2001/08/05 16:06:20 jongfoster
197 * Modifiying "struct map" so that there are now separate header and
198 * "map_entry" structures. This means that functions which modify a
199 * map no longer need to return a pointer to the modified map.
200 * Also, it no longer reverses the order of the entries (which may be
201 * important with some advanced template substitutions).
203 * Revision 1.26 2001/07/30 22:08:36 jongfoster
204 * Tidying up #defines:
205 * - All feature #defines are now of the form FEATURE_xxx
206 * - Permanently turned off WIN_GUI_EDIT
207 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
209 * Revision 1.25 2001/07/29 18:43:08 jongfoster
210 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
213 * Revision 1.24 2001/07/25 17:20:27 oes
214 * Introduced http->user_agent
216 * Revision 1.23 2001/07/18 12:32:23 oes
217 * - Added ACTION_STRING_DEANIMATE
218 * - moved #define freez from jcc.h to project.h
220 * Revision 1.22 2001/07/15 17:51:41 jongfoster
221 * Renaming #define STATIC to STATIC_PCRE
223 * Revision 1.21 2001/07/13 14:03:19 oes
224 * - Reorganized regex header inclusion and #defines to
225 * comply to the scheme in configure.in
226 * - Added csp->content_type and its CT_* keys
227 * - Added ACTION_DEANIMATE
228 * - Removed all #ifdef PCRS
230 * Revision 1.20 2001/06/29 21:45:41 oes
231 * Indentation, CRLF->LF, Tab-> Space
233 * Revision 1.19 2001/06/29 13:33:36 oes
234 * - Improved comments
235 * - Introduced http_request.host_ip_addr_str
236 * - Introduced http_response.head_length
237 * - Introduced config.my_ip_addr_str, config.my_hostname,
238 * config.admin_address and config.proxy_info_url
239 * - Removed config.proxy_args_header and config.proxy_args_trailer,
240 * renamed config.proxy_args_invocation to config.proxy_args
241 * - Removed HTML snipplets and GIFs
242 * - Removed logentry from cancelled commit
244 * Revision 1.18 2001/06/09 10:57:39 jongfoster
245 * Adding definition of BUFFER_SIZE.
246 * Changing struct cgi_dispatcher to use "const" strings.
248 * Revision 1.17 2001/06/07 23:15:09 jongfoster
249 * Merging ACL and forward files into config file.
250 * Moving struct gateway members into struct forward_spec
251 * Removing config->proxy_args_gateways
252 * Cosmetic: Adding a few comments
254 * Revision 1.16 2001/06/04 18:31:58 swa
255 * files are now prefixed with either `confdir' or `logdir'.
256 * `make redhat-dist' replaces both entries confdir and logdir
259 * Revision 1.15 2001/06/04 11:28:53 swa
260 * redirect did not work due to missing /
262 * Revision 1.14 2001/06/03 11:03:48 oes
264 * added struct http_response,
265 * changed struct interceptors to struct cgi_dispatcher,
266 * moved HTML stuff to cgi.h
268 * Revision 1.13 2001/06/01 20:05:36 jongfoster
269 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
270 * constant, and removed csp->tinygif.
272 * Revision 1.12 2001/06/01 18:49:17 jongfoster
273 * Replaced "list_share" with "list" - the tiny memory gain was not
274 * worth the extra complexity.
276 * Revision 1.11 2001/06/01 10:32:47 oes
277 * Added constants for anchoring selection bitmap
279 * Revision 1.10 2001/05/31 21:33:53 jongfoster
280 * Changes for new actions file, replacing permissionsfile
281 * and parts of the config file. Also added support for
284 * Revision 1.9 2001/05/31 17:32:31 oes
286 * - Enhanced domain part globbing with infix and prefix asterisk
287 * matching and optional unanchored operation
289 * Revision 1.8 2001/05/29 20:09:15 joergs
290 * HTTP_REDIRECT_TEMPLATE fixed.
292 * Revision 1.7 2001/05/29 09:50:24 jongfoster
293 * Unified blocklist/imagelist/actionslist.
294 * File format is still under discussion, but the internal changes
297 * Also modified interceptor behaviour:
298 * - We now intercept all URLs beginning with one of the following
299 * prefixes (and *only* these prefixes):
301 * * http://ijbswa.sf.net/config/
302 * * http://ijbswa.sourceforge.net/config/
303 * - New interceptors "home page" - go to http://i.j.b/ to see it.
304 * - Internal changes so that intercepted and fast redirect pages
305 * are not replaced with an image.
306 * - Interceptors now have the option to send a binary page direct
307 * to the client. (i.e. ijb-send-banner uses this)
308 * - Implemented show-url-info interceptor. (Which is why I needed
309 * the above interceptors changes - a typical URL is
310 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
311 * The previous mechanism would not have intercepted that, and
312 * if it had been intercepted then it then it would have replaced
315 * Revision 1.6 2001/05/27 22:17:04 oes
317 * - re_process_buffer no longer writes the modified buffer
318 * to the client, which was very ugly. It now returns the
319 * buffer, which it is then written by chat.
321 * - content_length now adjusts the Content-Length: header
322 * for modified documents rather than crunch()ing it.
323 * (Length info in csp->content_length, which is 0 for
324 * unmodified documents)
326 * - For this to work, sed() is called twice when filtering.
328 * Revision 1.5 2001/05/26 00:28:36 jongfoster
329 * Automatic reloading of config file.
330 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
331 * Most of the global variables have been moved to a new
332 * struct configuration_spec, accessed through csp->config->globalname
333 * Most of the globals remaining are used by the Win32 GUI.
335 * Revision 1.4 2001/05/22 18:46:04 oes
337 * - Enabled filtering banners by size rather than URL
338 * by adding patterns that replace all standard banner
339 * sizes with the "Junkbuster" gif to the re_filterfile
341 * - Enabled filtering WebBugs by providing a pattern
342 * which kills all 1x1 images
344 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
345 * which is selected by the (nonstandard and therefore
346 * capital) letter 'U' in the option string.
347 * It causes the quantifiers to be ungreedy by default.
348 * Appending a ? turns back to greedy (!).
350 * - Added a new interceptor ijb-send-banner, which
351 * sends back the "Junkbuster" gif. Without imagelist or
352 * MSIE detection support, or if tinygif = 1, or the
353 * URL isn't recognized as an imageurl, a lame HTML
354 * explanation is sent instead.
356 * - Added new feature, which permits blocking remote
357 * script redirects and firing back a local redirect
359 * The feature is conditionally compiled, i.e. it
360 * can be disabled with --disable-fast-redirects,
361 * plus it must be activated by a "fast-redirects"
362 * line in the config file, has its own log level
363 * and of course wants to be displayed by show-proxy-args
364 * Note: Boy, all the #ifdefs in 1001 locations and
365 * all the fumbling with configure.in and acconfig.h
366 * were *way* more work than the feature itself :-(
368 * - Because a generic redirect template was needed for
369 * this, tinygif = 3 now uses the same.
371 * - Moved GIFs, and other static HTTP response templates
376 * - Removed some >400 CRs again (Jon, you really worked
379 * Revision 1.3 2001/05/20 01:21:20 jongfoster
380 * Version 2.9.4 checkin.
381 * - Merged popupfile and cookiefile, and added control over PCRS
382 * filtering, in new "actionsfile".
383 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
384 * file error you now get a message box (in the Win32 GUI) rather
385 * than the program exiting with no explanation.
386 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
388 * - Removed tabs from "config"
389 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
390 * - Bumped up version number.
392 * Revision 1.2 2001/05/17 23:01:01 oes
393 * - Cleaned CRLF's from the sources and related files
395 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
396 * Initial import of version 2.9.3 source tree
399 *********************************************************************/
402 /* Declare struct FILE for vars and funcs. */
405 /* Need time_t for file_list */
409 * Include appropriate regular expression libraries.
410 * Note that pcrs and pcre (native) are needed for cgi
411 * and are included anyway.
414 #if defined(REGEX_PCRE) || defined (REGEX_GNU)
416 #endif /* defined(REGEX_PCRE) || defined (REGEX_GNU) */
430 #if defined(REGEX_PCRE)
432 # include "pcreposix.h"
434 # include <pcreposix.h>
436 #endif /* defined(REGEX_PCRE) */
438 #if defined(REGEX_GNU)
439 # include "gnu_regex.h"
444 #endif /* def AMIGA */
448 * I don't want to have to #include all this just for the declaration
449 * of SOCKET. However, it looks like we have to...
460 * The type used by sockets. On UNIX it's an int. Microsoft decided to
461 * make it an unsigned.
464 typedef SOCKET jb_socket;
465 #define JB_INVALID_SOCKET INVALID_SOCKET
466 #else /* ndef _WIN32 */
467 typedef int jb_socket;
468 #define JB_INVALID_SOCKET (-1)
469 #endif /* ndef _WIN32 */
473 * Error codes. Functions returning these should return a jb_err
475 #define JB_ERR_OK 0 /* Success, no error */
476 #define JB_ERR_MEMORY 1 /* Out of memory */
477 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
478 #define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
479 #define JB_ERR_PARSE 4 /* Error parsing file */
480 #define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
481 /* CGI actions editor. */
486 * This macro is used to free a pointer that may be NULL
488 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
491 /* Fix a problem with Solaris. There should be no effect on other
493 * Solaris's isspace() is a macro which uses it's argument directly
494 * as an array index. Therefore we need to make sure that high-bit
495 * characters generate +ve values, and ideally we also want to make
496 * the argument match the declared parameter type of "int".
498 * Note: Remember to #include <ctype.h> if you use these macros.
500 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
501 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
502 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
505 * Use for statically allocated buffers if you have no other choice.
506 * Remember to check the length of what you write into the buffer
507 * - we don't want any buffer overflows!
509 #define BUFFER_SIZE 5000
512 * Buffer size for capturing struct hostent data in the
513 * gethostby(name|addr)_r library calls. Since we don't
514 * loop over gethostbyname_r, the buffer must be sufficient
515 * to accomodate multiple IN A RRs, as used in DNS round robin
516 * load balancing. W3C's wwwlib uses 1K, so that should be
517 * good enough for us, too.
519 #define HOSTENT_BUFFER_SIZE 1024
522 * So you can say "while (FOREVER) { ...do something... }"
526 /* Default IP and port to listen on */
527 #define HADDR_DEFAULT "127.0.0.1"
528 #define HADDR_PORT 8118
530 /* Forward defs for various structures */
532 /* Need this for struct client_state */
533 struct configuration_spec;
536 /* Generic linked list of strings */
541 struct list_entry *next;
546 struct list_entry *first;
547 struct list_entry *last;
551 /* A map from a string to another string */
557 struct map_entry *next;
562 struct map_entry *first;
563 struct map_entry *last;
569 char *cmd; /* Whole command line: method, URL, Version */
570 char *ocmd; /* Backup of original cmd for CLF logging */
571 char *gpc; /* HTTP method: GET, POST, .. */
572 char *url; /* The URL */
573 char *ver; /* Protocol version */
574 int status; /* HTTP Status */
576 char *host; /* Host part of URL */
577 int port; /* Port of URL or 80 (default) */
578 char *path; /* Path of URL */
579 char *hostport; /* host[:port] */
580 int ssl; /* Flag if protocol is https */
582 char *host_ip_addr_str; /* String with dotted decimal representation
583 * of host's IP. NULL before connect_to() */
585 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
586 char **dvec; /* List of pointers to the strings in dbuffer. */
587 int dcount; /* How many parts to this domain? (length of dvec) */
591 * Response generated by CGI, blocker, or error handler
595 char *status; /* HTTP status (string) */
596 struct list headers[1]; /* List of header lines */
597 char *head; /* Formatted http response head */
598 size_t head_length; /* Length of http response head */
599 char *body; /* HTTP document body */
600 size_t content_length; /* Length of body, REQUIRED if binary body */
601 int is_static; /* Nonzero if the content will never change and
602 * should be cached by the brwoser (e.g. images) */
608 char *spec; /* The string which was parsed to produce this */
609 /* url_spec. Used for debugging or display only. */
611 /* Hostname matching, or dbuffer == NULL to match all hosts */
612 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
613 char **dvec; /* List of pointers to the strings in dbuffer. */
614 int dcount; /* How many parts to this domain? (length of dvec) */
615 int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
618 int port; /* The port number, or 0 to match all ports. */
621 char *path; /* The path prefix (if not using regex), or source */
623 int pathlen; /* ==strlen(path). Needed for prefix matching. */
625 regex_t *preg; /* Regex for matching path part */
629 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
630 #else /* ifndef REGEX */
631 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0 }
632 #endif /* ndef REGEX */
634 /* Constants for host part matching in URLs */
635 #define ANCHOR_LEFT 1
636 #define ANCHOR_RIGHT 2
648 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
649 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
651 /* Bits for csp->content_type */
652 #define CT_TEXT 1 /* Suitable for pcrs filtering */
653 #define CT_GIF 2 /* Suitable for GIF filtering */
654 #define CT_TABOO 4 /* DONT filter */
656 #define ACTION_MASK_ALL (~0U)
658 #define ACTION_MOST_COMPATIBLE 0x00000000UL
660 #define ACTION_BLOCK 0x00000001UL
661 #define ACTION_DEANIMATE 0x00000002UL
662 #define ACTION_DOWNGRADE 0x00000004UL
663 #define ACTION_FAST_REDIRECTS 0x00000008UL
664 #define ACTION_HIDE_FORWARDED 0x00000010UL
665 #define ACTION_HIDE_FROM 0x00000020UL
666 #define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */
667 #define ACTION_HIDE_USER_AGENT 0x00000080UL
668 #define ACTION_IMAGE 0x00000100UL
669 #define ACTION_IMAGE_BLOCKER 0x00000200UL
670 #define ACTION_NO_COMPRESSION 0x00000400UL
671 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
672 #define ACTION_NO_COOKIE_READ 0x00001000UL
673 #define ACTION_NO_COOKIE_SET 0x00002000UL
674 #define ACTION_NO_POPUPS 0x00004000UL
675 #define ACTION_VANILLA_WAFER 0x00008000UL
676 #define ACTION_LIMIT_CONNECT 0x00010000UL
678 #define ACTION_STRING_DEANIMATE 0
679 #define ACTION_STRING_FROM 1
680 #define ACTION_STRING_IMAGE_BLOCKER 2
681 #define ACTION_STRING_REFERER 3
682 #define ACTION_STRING_USER_AGENT 4
683 #define ACTION_STRING_LIMIT_CONNECT 5
684 #define ACTION_STRING_COUNT 6
686 #define ACTION_MULTI_ADD_HEADER 0
687 #define ACTION_MULTI_WAFER 1
688 #define ACTION_MULTI_FILTER 2
689 #define ACTION_MULTI_COUNT 3
693 * This structure contains a list of actions to apply to a URL.
694 * It only contains positive instructions - no "-" options.
695 * It is not used to store the actions list itself, only for
696 * url_actions() to return the current values.
698 struct current_action_spec
700 unsigned long flags; /* a bit set to "1" = add action */
702 /* For those actions that require parameters: */
704 /* each entry is valid if & only if corresponding entry in "add" set. */
705 char * string[ACTION_STRING_COUNT];
708 struct list multi[ACTION_MULTI_COUNT][1];
713 * This structure contains a set of changes to actions.
714 * It can contain both positive and negative instructions.
715 * It is used to store an entry in the actions list.
719 unsigned long mask; /* a bit set to "0" = remove action */
720 unsigned long add; /* a bit set to "1" = add action */
722 /* For those actions that require parameters: */
724 /* each entry is valid if & only if corresponding entry in "add" set. */
725 char * string[ACTION_STRING_COUNT];
727 /* Strings to remove. */
728 struct list multi_remove[ACTION_MULTI_COUNT][1];
730 /* If nonzero, remove *all* strings. */
731 int multi_remove_all[ACTION_MULTI_COUNT];
734 struct list multi_add[ACTION_MULTI_COUNT][1];
738 * This structure is used to store the actions list.
740 * It contains a URL pattern, and the chages to the actions.
741 * It is a linked list.
745 struct url_spec url[1];
747 struct action_spec action[1];
749 struct url_actions * next;
754 * Flags for use in csp->flags
756 #define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
757 * Cleared when the thread associated with
758 * this structure dies. */
759 #define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
760 * transfer encoding */
761 #define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
762 * it would normally have been blocked. */
763 #define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
764 #define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
765 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
768 * The state of a Privoxy processing thread.
772 /* The proxy's configuration */
773 struct configuration_spec * config;
775 /* The actions to perform on the current request */
776 struct current_action_spec action[1];
778 /* socket to talk to client (web browser) */
781 /* socket to talk to server (web server or proxy) */
784 /* Multi-purpose flag container, see CSP_FLAG_* above */
785 unsigned short int flags;
788 * Client PC's IP address, as reported by the accept()_ function.
789 * Both as string and number
795 /* Our IP address and hostname, i.e. the IP address that
796 the client used to reach us, and the associated hostname,
799 char *my_ip_addr_str;
802 /* The URL that was requested */
803 struct http_request http[1];
805 /* An I/O buffer used for buffering data read from the client */
808 /* List of all headers for this request */
809 struct list headers[1];
811 /* List of all cookies for this request */
812 struct list cookie_list[1];
814 /* MIME-Type key, see CT_* above */
815 unsigned short int content_type;
817 /* The "X-Forwarded-For:" header sent by the client */
820 /* files associated with this client */
821 struct file_list *actions_list;
823 struct file_list *rlist; /* pcrs job file */
824 size_t content_length; /* Length after content modification */
827 struct file_list *tlist; /* trustfile */
828 #endif /* def FEATURE_TRUST */
830 struct client_state *next;
835 * A function to add a header
837 typedef jb_err (*add_header_func_ptr)(struct client_state *);
840 * A function to process a header
842 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
845 * List of functions to run on a list of headers
851 parser_func_ptr parser;
856 * List of available CGI functions.
858 struct cgi_dispatcher
860 const char * const name;
861 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
862 const char * const description;
867 * A data file used by Privoxy. Kept in a linked list.
872 * this is a pointer to the data structures associated with the file.
873 * Read-only once the structure has been created.
877 /* Normally NULL. When we are finished with file (i.e. when we have
878 * loaded a new one), set to a pointer to an unloader function.
879 * Unloader will be called by sweep() (called from main loop) when
880 * all clients using this file are done. This prevents threading
883 void (*unloader)(void *);
885 /* Used internally by sweep(). Do not access from elsewhere. */
888 /* Following variables allow us to check if file has been changed.
889 * Read-only once the structure has been created.
894 /* Pointer to next entry in the linked list of all "file_list"s.
895 * This linked list is so that sweep() can navigate it.
896 * Since sweep() can remove items from the list, we must be careful
897 * to only access this value from main thread (when we know sweep
900 struct file_list *next;
907 struct url_spec url[1];
909 struct block_spec *next;
911 #endif /* def FEATURE_TRUST */
914 #define SOCKS_NONE 0 /* Don't use a SOCKS server */
915 #define SOCKS_4 40 /* original SOCKS 4 protocol */
916 #define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
920 struct url_spec url[1];
922 /* Connection type - must be a SOCKS_xxx constant */
929 /* Parent HTTP proxy */
933 /* For the linked list */
934 struct forward_spec *next;
936 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
940 * This struct represents one filter (one block) from
941 * the re_filterfile. If there is more than one filter
942 * in the file, the file will be represented by a
943 * chained list of re_filterfile specs.
945 struct re_filterfile_spec
947 char *name; /* Name from FILTER: statement in re_filterfile */
948 char *description; /* Description from FILTER: statement in re_filterfile */
949 struct list patterns[1]; /* The patterns from the re_filterfile */
950 pcrs_job *joblist; /* The resulting compiled pcrs_jobs */
951 struct re_filterfile_spec *next; /* The pointer for chaining */
955 #define ACL_PERMIT 1 /* accept connection request */
956 #define ACL_DENY 2 /* reject connection request */
958 struct access_control_addr
965 struct access_control_list
967 struct access_control_addr src[1];
968 struct access_control_addr dst[1];
971 struct access_control_list *next;
973 #endif /* def FEATURE_ACL */
976 /* Maximum number of loaders (actions, re_filter, ...) */
980 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
981 #define RUNTIME_FEATURE_CGI_TOGGLE 2
985 * Data loaded from the configuration file.
987 * (Anomaly: toggle is still handled through a global, not this structure)
989 struct configuration_spec
994 /* Features that can be enabled/disabled throuigh the config file */
995 unsigned feature_flags;
1001 const char *actions_file;
1003 /* The administrator's email address */
1004 char *admin_address;
1006 /* A URL with info on this proxy */
1007 char *proxy_info_url;
1009 const char *re_filterfile;
1011 #ifdef FEATURE_COOKIE_JAR
1012 const char * jarfile;
1014 #endif /* def FEATURE_COOKIE_JAR */
1017 * Port and IP to bind to.
1018 * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1023 /* Size limit for IOB */
1024 size_t buffer_limit;
1026 #ifdef FEATURE_TRUST
1027 const char * trustfile;
1029 struct list trust_info[1];
1030 struct url_spec *trust_list[64];
1031 #endif /* def FEATURE_TRUST */
1034 struct access_control_list *acl;
1035 #endif /* def FEATURE_ACL */
1037 struct forward_spec *forward;
1039 /* All options from the config file, HTML-formatted */
1042 /* the configuration file object. */
1043 struct file_list *config_file_list;
1045 /* List of loaders */
1046 int (*loaders[NLOADERS])(struct client_state *);
1048 /* bool, nonzero if we need to bind() to the new port */
1053 #define SZ(X) (sizeof(X) / sizeof(*X))
1055 #ifdef FEATURE_FORCE_LOAD
1056 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1057 #endif /* def FEATURE_FORCE_LOAD */
1059 #ifdef FEATURE_NO_GIFS
1060 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1062 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1063 #endif /* def FEATURE_NO_GIFS */
1066 /* Hardwired URLs */
1067 #define HOME_PAGE_URL "http://ijbswa.sourceforge.net"
1068 #define REDIRECT_URL HOME_PAGE_URL "/redirect.php?v=" VERSION "&to="
1071 * The "hosts" to intercept and display CGI pages.
1072 * First one is a hostname only, second one can specify host and path.
1075 * 1) Do not specify the http: prefix
1076 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1077 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1079 #define CGI_SITE_1_HOST "p.p"
1080 #define CGI_SITE_2_HOST "config.privoxy.org"
1081 #define CGI_SITE_2_PATH ""
1084 * The prefix for CGI pages. Written out in generated HTML.
1085 * INCLUDES the trailing slash.
1087 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1090 /* HTTP snipplets */
1091 static const char CSUCCEED[] =
1092 "HTTP/1.0 200 Connection established\n"
1093 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1095 static const char CHEADER[] =
1096 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1098 static const char CFORBIDDEN[] =
1099 "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";
1105 #endif /* ndef PROJECT_H_INCLUDED */