1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 #define PROJECT_H_VERSION "$Id: project.h,v 1.61 2002/03/26 22:29:55 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://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.61 2002/03/26 22:29:55 swa
40 * we have a new homepage!
42 * Revision 1.60 2002/03/24 15:52:17 jongfoster
43 * Changing CGI URL prefixes for new name
45 * Revision 1.59 2002/03/24 15:23:33 jongfoster
48 * Revision 1.58 2002/03/24 13:25:43 swa
49 * name change related issues
51 * Revision 1.57 2002/03/16 20:28:34 oes
52 * Added descriptions to the filters so users will know what they select in the cgi editor
54 * Revision 1.56 2002/03/13 20:27:30 oes
55 * Fixing bug with CT_TABOO
57 * Revision 1.55 2002/03/12 01:42:50 oes
58 * Introduced modular filters
60 * Revision 1.54 2002/03/09 20:03:52 jongfoster
61 * - Making various functions return int rather than size_t.
62 * (Undoing a recent change). Since size_t is unsigned on
63 * Windows, functions like read_socket that return -1 on
64 * error cannot return a size_t.
66 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
67 * crashes, and also frequently caused JB to jump to 100%
68 * CPU and stay there. (Because it thought it had just
69 * read ((unsigned)-1) == 4Gb of data...)
71 * - The signature of write_socket has changed, it now simply
72 * returns success=0/failure=nonzero.
74 * - Trying to get rid of a few warnings --with-debug on
75 * Windows, I've introduced a new type "jb_socket". This is
76 * used for the socket file descriptors. On Windows, this
77 * is SOCKET (a typedef for unsigned). Everywhere else, it's
78 * an int. The error value can't be -1 any more, so it's
79 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
80 * Windows it maps to the #define INVALID_SOCKET.)
82 * - The signature of bind_port has changed.
84 * Revision 1.53 2002/03/08 16:48:55 oes
85 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
87 * Revision 1.52 2002/03/07 03:46:17 oes
88 * Fixed compiler warnings
90 * Revision 1.51 2002/03/05 04:52:42 oes
91 * Deleted non-errlog debugging code
93 * Revision 1.50 2002/03/04 19:32:07 oes
94 * Changed default port to 8118
96 * Revision 1.49 2002/03/04 18:28:55 oes
97 * Deleted PID_FILE_NAME
99 * Revision 1.48 2002/03/03 14:50:40 oes
100 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
102 * Revision 1.47 2002/02/20 23:15:13 jongfoster
103 * Parsing functions now handle out-of-memory gracefully by returning
106 * Revision 1.46 2002/01/17 21:06:09 jongfoster
107 * Now #defining the URLs of the config interface
109 * Minor changes to struct http_request and struct url_spec due to
110 * standardizing that struct http_request is used to represent a URL, and
111 * struct url_spec is used to represent a URL pattern. (Before, URLs were
112 * represented as seperate variables and a partially-filled-in url_spec).
114 * Revision 1.45 2002/01/09 14:33:27 oes
115 * Added HOSTENT_BUFFER_SIZE
117 * Revision 1.44 2001/12/30 14:07:32 steudten
118 * - Add signal handling (unix)
119 * - Add SIGHUP handler (unix)
120 * - Add creation of pidfile (unix)
121 * - Add action 'top' in rc file (RH)
122 * - Add entry 'SIGNALS' to manpage
123 * - Add exit message to logfile (unix)
125 * Revision 1.43 2001/11/22 21:57:51 jongfoster
126 * Making action_spec->flags into an unsigned long rather than just an
128 * Adding ACTION_NO_COOKIE_KEEP
130 * Revision 1.42 2001/11/05 21:42:41 steudten
131 * Include DBG() macro.
133 * Revision 1.41 2001/10/28 19:12:06 jongfoster
134 * Adding ijb_toupper()
136 * Revision 1.40 2001/10/26 17:40:47 oes
137 * Moved ijb_isspace and ijb_tolower to project.h
138 * Removed http->user_agent, csp->referrer and csp->accept_types
140 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
141 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
142 * macro when called with a cast; so moving the cast to the macro def'n
143 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
144 * doesn't make macro expansion complain. Hope this works for everyone else
147 * Revision 1.38 2001/10/23 21:19:04 jongfoster
148 * New error-handling support: jb_err type and JB_ERR_xxx constants
149 * CGI functions now return a jb_err, and their parameters map is const.
150 * Support for RUNTIME_FEATUREs to enable/disable config editor
151 * Adding a few comments
153 * Revision 1.37 2001/10/14 22:14:01 jongfoster
154 * Removing name_length field from struct cgi_dispatcher, as this is
155 * now calculated at runtime from the "name" field.
157 * Revision 1.36 2001/10/10 16:45:15 oes
158 * Added LIMIT_CONNECT action and string
159 * Fixed HTTP message line termination
160 * Added CFORBIDDEN HTTP message
162 * Revision 1.35 2001/10/07 18:06:43 oes
163 * Added status member to struct http_request
165 * Revision 1.34 2001/10/07 15:45:25 oes
166 * Added url member to struct http_request and commented all
171 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
173 * Replaced struct client_state members rejected,
174 * force, active and toggled_on with "flags" bitmap.
176 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
178 * Added buffer_limit to struct configuration_spec
180 * Revision 1.33 2001/09/20 13:30:08 steudten
182 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
183 * Last case will set z to NULL in free(z) and thats bad..
185 * Revision 1.32 2001/09/16 23:02:51 jongfoster
188 * Revision 1.31 2001/09/16 13:20:29 jongfoster
189 * Rewrite of list library. Now has seperate header and list_entry
190 * structures. Also added a large sprinking of assert()s to the list
193 * Revision 1.30 2001/09/13 23:52:00 jongfoster
194 * Support for both static and dynamically generated CGI pages
196 * Revision 1.29 2001/09/13 23:29:43 jongfoster
197 * Defining FORWARD_SPEC_INITIALIZER
199 * Revision 1.28 2001/09/13 23:05:50 jongfoster
200 * Changing the string paramater to the header parsers a "const".
202 * Revision 1.27 2001/08/05 16:06:20 jongfoster
203 * Modifiying "struct map" so that there are now separate header and
204 * "map_entry" structures. This means that functions which modify a
205 * map no longer need to return a pointer to the modified map.
206 * Also, it no longer reverses the order of the entries (which may be
207 * important with some advanced template substitutions).
209 * Revision 1.26 2001/07/30 22:08:36 jongfoster
210 * Tidying up #defines:
211 * - All feature #defines are now of the form FEATURE_xxx
212 * - Permanently turned off WIN_GUI_EDIT
213 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
215 * Revision 1.25 2001/07/29 18:43:08 jongfoster
216 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
219 * Revision 1.24 2001/07/25 17:20:27 oes
220 * Introduced http->user_agent
222 * Revision 1.23 2001/07/18 12:32:23 oes
223 * - Added ACTION_STRING_DEANIMATE
224 * - moved #define freez from jcc.h to project.h
226 * Revision 1.22 2001/07/15 17:51:41 jongfoster
227 * Renaming #define STATIC to STATIC_PCRE
229 * Revision 1.21 2001/07/13 14:03:19 oes
230 * - Reorganized regex header inclusion and #defines to
231 * comply to the scheme in configure.in
232 * - Added csp->content_type and its CT_* keys
233 * - Added ACTION_DEANIMATE
234 * - Removed all #ifdef PCRS
236 * Revision 1.20 2001/06/29 21:45:41 oes
237 * Indentation, CRLF->LF, Tab-> Space
239 * Revision 1.19 2001/06/29 13:33:36 oes
240 * - Improved comments
241 * - Introduced http_request.host_ip_addr_str
242 * - Introduced http_response.head_length
243 * - Introduced config.my_ip_addr_str, config.my_hostname,
244 * config.admin_address and config.proxy_info_url
245 * - Removed config.proxy_args_header and config.proxy_args_trailer,
246 * renamed config.proxy_args_invocation to config.proxy_args
247 * - Removed HTML snipplets and GIFs
248 * - Removed logentry from cancelled commit
250 * Revision 1.18 2001/06/09 10:57:39 jongfoster
251 * Adding definition of BUFFER_SIZE.
252 * Changing struct cgi_dispatcher to use "const" strings.
254 * Revision 1.17 2001/06/07 23:15:09 jongfoster
255 * Merging ACL and forward files into config file.
256 * Moving struct gateway members into struct forward_spec
257 * Removing config->proxy_args_gateways
258 * Cosmetic: Adding a few comments
260 * Revision 1.16 2001/06/04 18:31:58 swa
261 * files are now prefixed with either `confdir' or `logdir'.
262 * `make redhat-dist' replaces both entries confdir and logdir
265 * Revision 1.15 2001/06/04 11:28:53 swa
266 * redirect did not work due to missing /
268 * Revision 1.14 2001/06/03 11:03:48 oes
270 * added struct http_response,
271 * changed struct interceptors to struct cgi_dispatcher,
272 * moved HTML stuff to cgi.h
274 * Revision 1.13 2001/06/01 20:05:36 jongfoster
275 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
276 * constant, and removed csp->tinygif.
278 * Revision 1.12 2001/06/01 18:49:17 jongfoster
279 * Replaced "list_share" with "list" - the tiny memory gain was not
280 * worth the extra complexity.
282 * Revision 1.11 2001/06/01 10:32:47 oes
283 * Added constants for anchoring selection bitmap
285 * Revision 1.10 2001/05/31 21:33:53 jongfoster
286 * Changes for new actions file, replacing permissionsfile
287 * and parts of the config file. Also added support for
290 * Revision 1.9 2001/05/31 17:32:31 oes
292 * - Enhanced domain part globbing with infix and prefix asterisk
293 * matching and optional unanchored operation
295 * Revision 1.8 2001/05/29 20:09:15 joergs
296 * HTTP_REDIRECT_TEMPLATE fixed.
298 * Revision 1.7 2001/05/29 09:50:24 jongfoster
299 * Unified blocklist/imagelist/actionslist.
300 * File format is still under discussion, but the internal changes
303 * Also modified interceptor behaviour:
304 * - We now intercept all URLs beginning with one of the following
305 * prefixes (and *only* these prefixes):
307 * * http://ijbswa.sf.net/config/
308 * * http://ijbswa.sourceforge.net/config/
309 * - New interceptors "home page" - go to http://i.j.b/ to see it.
310 * - Internal changes so that intercepted and fast redirect pages
311 * are not replaced with an image.
312 * - Interceptors now have the option to send a binary page direct
313 * to the client. (i.e. ijb-send-banner uses this)
314 * - Implemented show-url-info interceptor. (Which is why I needed
315 * the above interceptors changes - a typical URL is
316 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
317 * The previous mechanism would not have intercepted that, and
318 * if it had been intercepted then it then it would have replaced
321 * Revision 1.6 2001/05/27 22:17:04 oes
323 * - re_process_buffer no longer writes the modified buffer
324 * to the client, which was very ugly. It now returns the
325 * buffer, which it is then written by chat.
327 * - content_length now adjusts the Content-Length: header
328 * for modified documents rather than crunch()ing it.
329 * (Length info in csp->content_length, which is 0 for
330 * unmodified documents)
332 * - For this to work, sed() is called twice when filtering.
334 * Revision 1.5 2001/05/26 00:28:36 jongfoster
335 * Automatic reloading of config file.
336 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
337 * Most of the global variables have been moved to a new
338 * struct configuration_spec, accessed through csp->config->globalname
339 * Most of the globals remaining are used by the Win32 GUI.
341 * Revision 1.4 2001/05/22 18:46:04 oes
343 * - Enabled filtering banners by size rather than URL
344 * by adding patterns that replace all standard banner
345 * sizes with the "Junkbuster" gif to the re_filterfile
347 * - Enabled filtering WebBugs by providing a pattern
348 * which kills all 1x1 images
350 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
351 * which is selected by the (nonstandard and therefore
352 * capital) letter 'U' in the option string.
353 * It causes the quantifiers to be ungreedy by default.
354 * Appending a ? turns back to greedy (!).
356 * - Added a new interceptor ijb-send-banner, which
357 * sends back the "Junkbuster" gif. Without imagelist or
358 * MSIE detection support, or if tinygif = 1, or the
359 * URL isn't recognized as an imageurl, a lame HTML
360 * explanation is sent instead.
362 * - Added new feature, which permits blocking remote
363 * script redirects and firing back a local redirect
365 * The feature is conditionally compiled, i.e. it
366 * can be disabled with --disable-fast-redirects,
367 * plus it must be activated by a "fast-redirects"
368 * line in the config file, has its own log level
369 * and of course wants to be displayed by show-proxy-args
370 * Note: Boy, all the #ifdefs in 1001 locations and
371 * all the fumbling with configure.in and acconfig.h
372 * were *way* more work than the feature itself :-(
374 * - Because a generic redirect template was needed for
375 * this, tinygif = 3 now uses the same.
377 * - Moved GIFs, and other static HTTP response templates
382 * - Removed some >400 CRs again (Jon, you really worked
385 * Revision 1.3 2001/05/20 01:21:20 jongfoster
386 * Version 2.9.4 checkin.
387 * - Merged popupfile and cookiefile, and added control over PCRS
388 * filtering, in new "actionsfile".
389 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
390 * file error you now get a message box (in the Win32 GUI) rather
391 * than the program exiting with no explanation.
392 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
394 * - Removed tabs from "config"
395 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
396 * - Bumped up version number.
398 * Revision 1.2 2001/05/17 23:01:01 oes
399 * - Cleaned CRLF's from the sources and related files
401 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
402 * Initial import of version 2.9.3 source tree
405 *********************************************************************/
408 /* Declare struct FILE for vars and funcs. */
411 /* Need time_t for file_list */
415 * Include appropriate regular expression libraries.
416 * Note that pcrs and pcre (native) are needed for cgi
417 * and are included anyway.
420 #if defined(REGEX_PCRE) || defined (REGEX_GNU)
422 #endif /* defined(REGEX_PCRE) || defined (REGEX_GNU) */
436 #if defined(REGEX_PCRE)
438 # include "pcreposix.h"
440 # include <pcreposix.h>
442 #endif /* defined(REGEX_PCRE) */
444 #if defined(REGEX_GNU)
445 # include "gnu_regex.h"
450 #endif /* def AMIGA */
454 * I don't want to have to #include all this just for the declaration
455 * of SOCKET. However, it looks like we have to...
466 * The type used by sockets. On UNIX it's an int. Microsoft decided to
467 * make it an unsigned.
470 typedef SOCKET jb_socket;
471 #define JB_INVALID_SOCKET INVALID_SOCKET
472 #else /* ndef _WIN32 */
473 typedef int jb_socket;
474 #define JB_INVALID_SOCKET (-1)
475 #endif /* ndef _WIN32 */
479 * Error codes. Functions returning these should return a jb_err
481 #define JB_ERR_OK 0 /* Success, no error */
482 #define JB_ERR_MEMORY 1 /* Out of memory */
483 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
484 #define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
485 #define JB_ERR_PARSE 4 /* Error parsing file */
486 #define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
487 /* CGI actions editor. */
492 * This macro is used to free a pointer that may be NULL
494 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
497 /* Fix a problem with Solaris. There should be no effect on other
499 * Solaris's isspace() is a macro which uses it's argument directly
500 * as an array index. Therefore we need to make sure that high-bit
501 * characters generate +ve values, and ideally we also want to make
502 * the argument match the declared parameter type of "int".
504 * Note: Remember to #include <ctype.h> if you use these macros.
506 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
507 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
508 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
511 * Use for statically allocated buffers if you have no other choice.
512 * Remember to check the length of what you write into the buffer
513 * - we don't want any buffer overflows!
515 #define BUFFER_SIZE 5000
518 * Buffer size for capturing struct hostent data in the
519 * gethostby(name|addr)_r library calls. Since we don't
520 * loop over gethostbyname_r, the buffer must be sufficient
521 * to accomodate multiple IN A RRs, as used in DNS round robin
522 * load balancing. W3C's wwwlib uses 1K, so that should be
523 * good enough for us, too.
525 #define HOSTENT_BUFFER_SIZE 1024
528 * So you can say "while (FOREVER) { ...do something... }"
532 /* Default IP and port to listen on */
533 #define HADDR_DEFAULT "127.0.0.1"
534 #define HADDR_PORT 8118
536 /* Forward defs for various structures */
538 /* Need this for struct client_state */
539 struct configuration_spec;
542 /* Generic linked list of strings */
547 struct list_entry *next;
552 struct list_entry *first;
553 struct list_entry *last;
557 /* A map from a string to another string */
563 struct map_entry *next;
568 struct map_entry *first;
569 struct map_entry *last;
575 char *cmd; /* Whole command line: method, URL, Version */
576 char *ocmd; /* Backup of original cmd for CLF logging */
577 char *gpc; /* HTTP method: GET, POST, .. */
578 char *url; /* The URL */
579 char *ver; /* Protocol version */
580 int status; /* HTTP Status */
582 char *host; /* Host part of URL */
583 int port; /* Port of URL or 80 (default) */
584 char *path; /* Path of URL */
585 char *hostport; /* host[:port] */
586 int ssl; /* Flag if protocol is https */
588 char *host_ip_addr_str; /* String with dotted decimal representation
589 * of host's IP. NULL before connect_to() */
591 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
592 char **dvec; /* List of pointers to the strings in dbuffer. */
593 int dcount; /* How many parts to this domain? (length of dvec) */
597 * Response generated by CGI, blocker, or error handler
601 char *status; /* HTTP status (string) */
602 struct list headers[1]; /* List of header lines */
603 char *head; /* Formatted http response head */
604 size_t head_length; /* Length of http response head */
605 char *body; /* HTTP document body */
606 size_t content_length; /* Length of body, REQUIRED if binary body */
607 int is_static; /* Nonzero if the content will never change and
608 * should be cached by the brwoser (e.g. images) */
614 char *spec; /* The string which was parsed to produce this */
615 /* url_spec. Used for debugging or display only. */
617 /* Hostname matching, or dbuffer == NULL to match all hosts */
618 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
619 char **dvec; /* List of pointers to the strings in dbuffer. */
620 int dcount; /* How many parts to this domain? (length of dvec) */
621 int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
624 int port; /* The port number, or 0 to match all ports. */
627 char *path; /* The path prefix (if not using regex), or source */
629 int pathlen; /* ==strlen(path). Needed for prefix matching. */
631 regex_t *preg; /* Regex for matching path part */
635 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
636 #else /* ifndef REGEX */
637 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0 }
638 #endif /* ndef REGEX */
640 /* Constants for host part matching in URLs */
641 #define ANCHOR_LEFT 1
642 #define ANCHOR_RIGHT 2
654 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
655 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
657 /* Bits for csp->content_type */
658 #define CT_TEXT 1 /* Suitable for pcrs filtering */
659 #define CT_GIF 2 /* Suitable for GIF filtering */
660 #define CT_TABOO 4 /* DONT filter */
662 #define ACTION_MASK_ALL (~0U)
664 #define ACTION_MOST_COMPATIBLE 0x00000000UL
666 #define ACTION_BLOCK 0x00000001UL
667 #define ACTION_DEANIMATE 0x00000002UL
668 #define ACTION_DOWNGRADE 0x00000004UL
669 #define ACTION_FAST_REDIRECTS 0x00000008UL
670 #define ACTION_HIDE_FORWARDED 0x00000010UL
671 #define ACTION_HIDE_FROM 0x00000020UL
672 #define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */
673 #define ACTION_HIDE_USER_AGENT 0x00000080UL
674 #define ACTION_IMAGE 0x00000100UL
675 #define ACTION_IMAGE_BLOCKER 0x00000200UL
676 #define ACTION_NO_COMPRESSION 0x00000400UL
677 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
678 #define ACTION_NO_COOKIE_READ 0x00001000UL
679 #define ACTION_NO_COOKIE_SET 0x00002000UL
680 #define ACTION_NO_POPUPS 0x00004000UL
681 #define ACTION_VANILLA_WAFER 0x00008000UL
682 #define ACTION_LIMIT_CONNECT 0x00010000UL
684 #define ACTION_STRING_DEANIMATE 0
685 #define ACTION_STRING_FROM 1
686 #define ACTION_STRING_IMAGE_BLOCKER 2
687 #define ACTION_STRING_REFERER 3
688 #define ACTION_STRING_USER_AGENT 4
689 #define ACTION_STRING_LIMIT_CONNECT 5
690 #define ACTION_STRING_COUNT 6
692 #define ACTION_MULTI_ADD_HEADER 0
693 #define ACTION_MULTI_WAFER 1
694 #define ACTION_MULTI_FILTER 2
695 #define ACTION_MULTI_COUNT 3
699 * This structure contains a list of actions to apply to a URL.
700 * It only contains positive instructions - no "-" options.
701 * It is not used to store the actions list itself, only for
702 * url_actions() to return the current values.
704 struct current_action_spec
706 unsigned long flags; /* a bit set to "1" = add action */
708 /* For those actions that require parameters: */
710 /* each entry is valid if & only if corresponding entry in "add" set. */
711 char * string[ACTION_STRING_COUNT];
714 struct list multi[ACTION_MULTI_COUNT][1];
719 * This structure contains a set of changes to actions.
720 * It can contain both positive and negative instructions.
721 * It is used to store an entry in the actions list.
725 unsigned long mask; /* a bit set to "0" = remove action */
726 unsigned long add; /* a bit set to "1" = add action */
728 /* For those actions that require parameters: */
730 /* each entry is valid if & only if corresponding entry in "add" set. */
731 char * string[ACTION_STRING_COUNT];
733 /* Strings to remove. */
734 struct list multi_remove[ACTION_MULTI_COUNT][1];
736 /* If nonzero, remove *all* strings. */
737 int multi_remove_all[ACTION_MULTI_COUNT];
740 struct list multi_add[ACTION_MULTI_COUNT][1];
744 * This structure is used to store the actions list.
746 * It contains a URL pattern, and the chages to the actions.
747 * It is a linked list.
751 struct url_spec url[1];
753 struct action_spec action[1];
755 struct url_actions * next;
760 * Flags for use in csp->flags
762 #define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
763 * Cleared when the thread associated with
764 * this structure dies. */
765 #define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
766 * transfer encoding */
767 #define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
768 * it would normally have been blocked. */
769 #define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
770 #define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
771 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
774 * The state of a Privoxy processing thread.
778 /* The proxy's configuration */
779 struct configuration_spec * config;
781 /* The actions to perform on the current request */
782 struct current_action_spec action[1];
784 /* socket to talk to client (web browser) */
787 /* socket to talk to server (web server or proxy) */
790 /* Multi-purpose flag container, see CSP_FLAG_* above */
791 unsigned short int flags;
794 * Client PC's IP address, as reported by the accept()_ function.
795 * Both as string and number
801 /* Our IP address and hostname, i.e. the IP address that
802 the client used to reach us, and the associated hostname,
805 char *my_ip_addr_str;
808 /* The URL that was requested */
809 struct http_request http[1];
811 /* An I/O buffer used for buffering data read from the client */
814 /* List of all headers for this request */
815 struct list headers[1];
817 /* List of all cookies for this request */
818 struct list cookie_list[1];
820 /* MIME-Type key, see CT_* above */
821 unsigned short int content_type;
823 /* The "X-Forwarded-For:" header sent by the client */
826 /* files associated with this client */
827 struct file_list *actions_list;
829 struct file_list *rlist; /* pcrs job file */
830 size_t content_length; /* Length after content modification */
833 struct file_list *tlist; /* trustfile */
834 #endif /* def FEATURE_TRUST */
836 struct client_state *next;
841 * A function to add a header
843 typedef jb_err (*add_header_func_ptr)(struct client_state *);
846 * A function to process a header
848 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
851 * List of functions to run on a list of headers
857 parser_func_ptr parser;
862 * List of available CGI functions.
864 struct cgi_dispatcher
866 const char * const name;
867 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
868 const char * const description;
873 * A data file used by Privoxy. Kept in a linked list.
878 * this is a pointer to the data structures associated with the file.
879 * Read-only once the structure has been created.
883 /* Normally NULL. When we are finished with file (i.e. when we have
884 * loaded a new one), set to a pointer to an unloader function.
885 * Unloader will be called by sweep() (called from main loop) when
886 * all clients using this file are done. This prevents threading
889 void (*unloader)(void *);
891 /* Used internally by sweep(). Do not access from elsewhere. */
894 /* Following variables allow us to check if file has been changed.
895 * Read-only once the structure has been created.
900 /* Pointer to next entry in the linked list of all "file_list"s.
901 * This linked list is so that sweep() can navigate it.
902 * Since sweep() can remove items from the list, we must be careful
903 * to only access this value from main thread (when we know sweep
906 struct file_list *next;
913 struct url_spec url[1];
915 struct block_spec *next;
917 #endif /* def FEATURE_TRUST */
920 #define SOCKS_NONE 0 /* Don't use a SOCKS server */
921 #define SOCKS_4 40 /* original SOCKS 4 protocol */
922 #define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
926 struct url_spec url[1];
928 /* Connection type - must be a SOCKS_xxx constant */
935 /* Parent HTTP proxy */
939 /* For the linked list */
940 struct forward_spec *next;
942 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
946 * This struct represents one filter (one block) from
947 * the re_filterfile. If there is more than one filter
948 * in the file, the file will be represented by a
949 * chained list of re_filterfile specs.
951 struct re_filterfile_spec
953 char *name; /* Name from FILTER: statement in re_filterfile */
954 char *description; /* Description from FILTER: statement in re_filterfile */
955 struct list patterns[1]; /* The patterns from the re_filterfile */
956 pcrs_job *joblist; /* The resulting compiled pcrs_jobs */
957 struct re_filterfile_spec *next; /* The pointer for chaining */
961 #define ACL_PERMIT 1 /* accept connection request */
962 #define ACL_DENY 2 /* reject connection request */
964 struct access_control_addr
971 struct access_control_list
973 struct access_control_addr src[1];
974 struct access_control_addr dst[1];
977 struct access_control_list *next;
979 #endif /* def FEATURE_ACL */
982 /* Maximum number of loaders (actions, re_filter, ...) */
986 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
987 #define RUNTIME_FEATURE_CGI_TOGGLE 2
991 * Data loaded from the configuration file.
993 * (Anomaly: toggle is still handled through a global, not this structure)
995 struct configuration_spec
1000 /* Features that can be enabled/disabled throuigh the config file */
1001 unsigned feature_flags;
1003 const char *logfile;
1005 const char *confdir;
1007 const char *actions_file;
1009 /* The administrator's email address */
1010 char *admin_address;
1012 /* A URL with info on this proxy */
1013 char *proxy_info_url;
1015 const char *re_filterfile;
1017 #ifdef FEATURE_COOKIE_JAR
1018 const char * jarfile;
1020 #endif /* def FEATURE_COOKIE_JAR */
1023 * Port and IP to bind to.
1024 * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1029 /* Size limit for IOB */
1030 size_t buffer_limit;
1032 #ifdef FEATURE_TRUST
1033 const char * trustfile;
1035 struct list trust_info[1];
1036 struct url_spec *trust_list[64];
1037 #endif /* def FEATURE_TRUST */
1040 struct access_control_list *acl;
1041 #endif /* def FEATURE_ACL */
1043 struct forward_spec *forward;
1045 /* All options from the config file, HTML-formatted */
1048 /* the configuration file object. */
1049 struct file_list *config_file_list;
1051 /* List of loaders */
1052 int (*loaders[NLOADERS])(struct client_state *);
1054 /* bool, nonzero if we need to bind() to the new port */
1059 #define SZ(X) (sizeof(X) / sizeof(*X))
1061 #ifdef FEATURE_FORCE_LOAD
1062 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1063 #endif /* def FEATURE_FORCE_LOAD */
1065 #ifdef FEATURE_NO_GIFS
1066 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1068 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1069 #endif /* def FEATURE_NO_GIFS */
1072 /* Hardwired URLs */
1073 #define HOME_PAGE_URL "http://www.privoxy.org"
1074 #define REDIRECT_URL HOME_PAGE_URL "/redirect.php?v=" VERSION "&to="
1077 * The "hosts" to intercept and display CGI pages.
1078 * First one is a hostname only, second one can specify host and path.
1081 * 1) Do not specify the http: prefix
1082 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1083 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1085 #define CGI_SITE_1_HOST "p.p"
1086 #define CGI_SITE_2_HOST "config.privoxy.org"
1087 #define CGI_SITE_2_PATH ""
1090 * The prefix for CGI pages. Written out in generated HTML.
1091 * INCLUDES the trailing slash.
1093 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1096 /* HTTP snipplets */
1097 static const char CSUCCEED[] =
1098 "HTTP/1.0 200 Connection established\n"
1099 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1101 static const char CHEADER[] =
1102 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1104 static const char CFORBIDDEN[] =
1105 "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";
1111 #endif /* ndef PROJECT_H_INCLUDED */