1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 #define PROJECT_H_VERSION "$Id: project.h,v 1.68 2002/04/26 12:56:00 oes 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.68 2002/04/26 12:56:00 oes
40 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
42 * Revision 1.67 2002/04/24 02:12:43 oes
43 * - Jon's multiple AF patch:
44 * - Make csp->actions_list an array
45 * - #define MAX_ACTION_FILES
46 * - Moved CGI_PARAM_LEN_MAX (500) here
48 * Revision 1.66 2002/04/15 19:06:43 jongfoster
51 * Revision 1.65 2002/04/04 00:36:36 gliptak
52 * always use pcre for matching
54 * Revision 1.64 2002/04/03 22:28:03 gliptak
55 * Removed references to gnu_regex
57 * Revision 1.63 2002/03/31 17:19:00 jongfoster
58 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
60 * Revision 1.62 2002/03/26 22:48:49 swa
63 * Revision 1.61 2002/03/26 22:29:55 swa
64 * we have a new homepage!
66 * Revision 1.60 2002/03/24 15:52:17 jongfoster
67 * Changing CGI URL prefixes for new name
69 * Revision 1.59 2002/03/24 15:23:33 jongfoster
72 * Revision 1.58 2002/03/24 13:25:43 swa
73 * name change related issues
75 * Revision 1.57 2002/03/16 20:28:34 oes
76 * Added descriptions to the filters so users will know what they select in the cgi editor
78 * Revision 1.56 2002/03/13 20:27:30 oes
79 * Fixing bug with CT_TABOO
81 * Revision 1.55 2002/03/12 01:42:50 oes
82 * Introduced modular filters
84 * Revision 1.54 2002/03/09 20:03:52 jongfoster
85 * - Making various functions return int rather than size_t.
86 * (Undoing a recent change). Since size_t is unsigned on
87 * Windows, functions like read_socket that return -1 on
88 * error cannot return a size_t.
90 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
91 * crashes, and also frequently caused JB to jump to 100%
92 * CPU and stay there. (Because it thought it had just
93 * read ((unsigned)-1) == 4Gb of data...)
95 * - The signature of write_socket has changed, it now simply
96 * returns success=0/failure=nonzero.
98 * - Trying to get rid of a few warnings --with-debug on
99 * Windows, I've introduced a new type "jb_socket". This is
100 * used for the socket file descriptors. On Windows, this
101 * is SOCKET (a typedef for unsigned). Everywhere else, it's
102 * an int. The error value can't be -1 any more, so it's
103 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
104 * Windows it maps to the #define INVALID_SOCKET.)
106 * - The signature of bind_port has changed.
108 * Revision 1.53 2002/03/08 16:48:55 oes
109 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
111 * Revision 1.52 2002/03/07 03:46:17 oes
112 * Fixed compiler warnings
114 * Revision 1.51 2002/03/05 04:52:42 oes
115 * Deleted non-errlog debugging code
117 * Revision 1.50 2002/03/04 19:32:07 oes
118 * Changed default port to 8118
120 * Revision 1.49 2002/03/04 18:28:55 oes
121 * Deleted PID_FILE_NAME
123 * Revision 1.48 2002/03/03 14:50:40 oes
124 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
126 * Revision 1.47 2002/02/20 23:15:13 jongfoster
127 * Parsing functions now handle out-of-memory gracefully by returning
130 * Revision 1.46 2002/01/17 21:06:09 jongfoster
131 * Now #defining the URLs of the config interface
133 * Minor changes to struct http_request and struct url_spec due to
134 * standardizing that struct http_request is used to represent a URL, and
135 * struct url_spec is used to represent a URL pattern. (Before, URLs were
136 * represented as seperate variables and a partially-filled-in url_spec).
138 * Revision 1.45 2002/01/09 14:33:27 oes
139 * Added HOSTENT_BUFFER_SIZE
141 * Revision 1.44 2001/12/30 14:07:32 steudten
142 * - Add signal handling (unix)
143 * - Add SIGHUP handler (unix)
144 * - Add creation of pidfile (unix)
145 * - Add action 'top' in rc file (RH)
146 * - Add entry 'SIGNALS' to manpage
147 * - Add exit message to logfile (unix)
149 * Revision 1.43 2001/11/22 21:57:51 jongfoster
150 * Making action_spec->flags into an unsigned long rather than just an
152 * Adding ACTION_NO_COOKIE_KEEP
154 * Revision 1.42 2001/11/05 21:42:41 steudten
155 * Include DBG() macro.
157 * Revision 1.41 2001/10/28 19:12:06 jongfoster
158 * Adding ijb_toupper()
160 * Revision 1.40 2001/10/26 17:40:47 oes
161 * Moved ijb_isspace and ijb_tolower to project.h
162 * Removed http->user_agent, csp->referrer and csp->accept_types
164 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
165 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
166 * macro when called with a cast; so moving the cast to the macro def'n
167 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
168 * doesn't make macro expansion complain. Hope this works for everyone else
171 * Revision 1.38 2001/10/23 21:19:04 jongfoster
172 * New error-handling support: jb_err type and JB_ERR_xxx constants
173 * CGI functions now return a jb_err, and their parameters map is const.
174 * Support for RUNTIME_FEATUREs to enable/disable config editor
175 * Adding a few comments
177 * Revision 1.37 2001/10/14 22:14:01 jongfoster
178 * Removing name_length field from struct cgi_dispatcher, as this is
179 * now calculated at runtime from the "name" field.
181 * Revision 1.36 2001/10/10 16:45:15 oes
182 * Added LIMIT_CONNECT action and string
183 * Fixed HTTP message line termination
184 * Added CFORBIDDEN HTTP message
186 * Revision 1.35 2001/10/07 18:06:43 oes
187 * Added status member to struct http_request
189 * Revision 1.34 2001/10/07 15:45:25 oes
190 * Added url member to struct http_request and commented all
195 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
197 * Replaced struct client_state members rejected,
198 * force, active and toggled_on with "flags" bitmap.
200 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
202 * Added buffer_limit to struct configuration_spec
204 * Revision 1.33 2001/09/20 13:30:08 steudten
206 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
207 * Last case will set z to NULL in free(z) and thats bad..
209 * Revision 1.32 2001/09/16 23:02:51 jongfoster
212 * Revision 1.31 2001/09/16 13:20:29 jongfoster
213 * Rewrite of list library. Now has seperate header and list_entry
214 * structures. Also added a large sprinking of assert()s to the list
217 * Revision 1.30 2001/09/13 23:52:00 jongfoster
218 * Support for both static and dynamically generated CGI pages
220 * Revision 1.29 2001/09/13 23:29:43 jongfoster
221 * Defining FORWARD_SPEC_INITIALIZER
223 * Revision 1.28 2001/09/13 23:05:50 jongfoster
224 * Changing the string paramater to the header parsers a "const".
226 * Revision 1.27 2001/08/05 16:06:20 jongfoster
227 * Modifiying "struct map" so that there are now separate header and
228 * "map_entry" structures. This means that functions which modify a
229 * map no longer need to return a pointer to the modified map.
230 * Also, it no longer reverses the order of the entries (which may be
231 * important with some advanced template substitutions).
233 * Revision 1.26 2001/07/30 22:08:36 jongfoster
234 * Tidying up #defines:
235 * - All feature #defines are now of the form FEATURE_xxx
236 * - Permanently turned off WIN_GUI_EDIT
237 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
239 * Revision 1.25 2001/07/29 18:43:08 jongfoster
240 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
243 * Revision 1.24 2001/07/25 17:20:27 oes
244 * Introduced http->user_agent
246 * Revision 1.23 2001/07/18 12:32:23 oes
247 * - Added ACTION_STRING_DEANIMATE
248 * - moved #define freez from jcc.h to project.h
250 * Revision 1.22 2001/07/15 17:51:41 jongfoster
251 * Renaming #define STATIC to STATIC_PCRE
253 * Revision 1.21 2001/07/13 14:03:19 oes
254 * - Reorganized regex header inclusion and #defines to
255 * comply to the scheme in configure.in
256 * - Added csp->content_type and its CT_* keys
257 * - Added ACTION_DEANIMATE
258 * - Removed all #ifdef PCRS
260 * Revision 1.20 2001/06/29 21:45:41 oes
261 * Indentation, CRLF->LF, Tab-> Space
263 * Revision 1.19 2001/06/29 13:33:36 oes
264 * - Improved comments
265 * - Introduced http_request.host_ip_addr_str
266 * - Introduced http_response.head_length
267 * - Introduced config.my_ip_addr_str, config.my_hostname,
268 * config.admin_address and config.proxy_info_url
269 * - Removed config.proxy_args_header and config.proxy_args_trailer,
270 * renamed config.proxy_args_invocation to config.proxy_args
271 * - Removed HTML snipplets and GIFs
272 * - Removed logentry from cancelled commit
274 * Revision 1.18 2001/06/09 10:57:39 jongfoster
275 * Adding definition of BUFFER_SIZE.
276 * Changing struct cgi_dispatcher to use "const" strings.
278 * Revision 1.17 2001/06/07 23:15:09 jongfoster
279 * Merging ACL and forward files into config file.
280 * Moving struct gateway members into struct forward_spec
281 * Removing config->proxy_args_gateways
282 * Cosmetic: Adding a few comments
284 * Revision 1.16 2001/06/04 18:31:58 swa
285 * files are now prefixed with either `confdir' or `logdir'.
286 * `make redhat-dist' replaces both entries confdir and logdir
289 * Revision 1.15 2001/06/04 11:28:53 swa
290 * redirect did not work due to missing /
292 * Revision 1.14 2001/06/03 11:03:48 oes
294 * added struct http_response,
295 * changed struct interceptors to struct cgi_dispatcher,
296 * moved HTML stuff to cgi.h
298 * Revision 1.13 2001/06/01 20:05:36 jongfoster
299 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
300 * constant, and removed csp->tinygif.
302 * Revision 1.12 2001/06/01 18:49:17 jongfoster
303 * Replaced "list_share" with "list" - the tiny memory gain was not
304 * worth the extra complexity.
306 * Revision 1.11 2001/06/01 10:32:47 oes
307 * Added constants for anchoring selection bitmap
309 * Revision 1.10 2001/05/31 21:33:53 jongfoster
310 * Changes for new actions file, replacing permissionsfile
311 * and parts of the config file. Also added support for
314 * Revision 1.9 2001/05/31 17:32:31 oes
316 * - Enhanced domain part globbing with infix and prefix asterisk
317 * matching and optional unanchored operation
319 * Revision 1.8 2001/05/29 20:09:15 joergs
320 * HTTP_REDIRECT_TEMPLATE fixed.
322 * Revision 1.7 2001/05/29 09:50:24 jongfoster
323 * Unified blocklist/imagelist/actionslist.
324 * File format is still under discussion, but the internal changes
327 * Also modified interceptor behaviour:
328 * - We now intercept all URLs beginning with one of the following
329 * prefixes (and *only* these prefixes):
331 * * http://ijbswa.sf.net/config/
332 * * http://ijbswa.sourceforge.net/config/
333 * - New interceptors "home page" - go to http://i.j.b/ to see it.
334 * - Internal changes so that intercepted and fast redirect pages
335 * are not replaced with an image.
336 * - Interceptors now have the option to send a binary page direct
337 * to the client. (i.e. ijb-send-banner uses this)
338 * - Implemented show-url-info interceptor. (Which is why I needed
339 * the above interceptors changes - a typical URL is
340 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
341 * The previous mechanism would not have intercepted that, and
342 * if it had been intercepted then it then it would have replaced
345 * Revision 1.6 2001/05/27 22:17:04 oes
347 * - re_process_buffer no longer writes the modified buffer
348 * to the client, which was very ugly. It now returns the
349 * buffer, which it is then written by chat.
351 * - content_length now adjusts the Content-Length: header
352 * for modified documents rather than crunch()ing it.
353 * (Length info in csp->content_length, which is 0 for
354 * unmodified documents)
356 * - For this to work, sed() is called twice when filtering.
358 * Revision 1.5 2001/05/26 00:28:36 jongfoster
359 * Automatic reloading of config file.
360 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
361 * Most of the global variables have been moved to a new
362 * struct configuration_spec, accessed through csp->config->globalname
363 * Most of the globals remaining are used by the Win32 GUI.
365 * Revision 1.4 2001/05/22 18:46:04 oes
367 * - Enabled filtering banners by size rather than URL
368 * by adding patterns that replace all standard banner
369 * sizes with the "Junkbuster" gif to the re_filterfile
371 * - Enabled filtering WebBugs by providing a pattern
372 * which kills all 1x1 images
374 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
375 * which is selected by the (nonstandard and therefore
376 * capital) letter 'U' in the option string.
377 * It causes the quantifiers to be ungreedy by default.
378 * Appending a ? turns back to greedy (!).
380 * - Added a new interceptor ijb-send-banner, which
381 * sends back the "Junkbuster" gif. Without imagelist or
382 * MSIE detection support, or if tinygif = 1, or the
383 * URL isn't recognized as an imageurl, a lame HTML
384 * explanation is sent instead.
386 * - Added new feature, which permits blocking remote
387 * script redirects and firing back a local redirect
389 * The feature is conditionally compiled, i.e. it
390 * can be disabled with --disable-fast-redirects,
391 * plus it must be activated by a "fast-redirects"
392 * line in the config file, has its own log level
393 * and of course wants to be displayed by show-proxy-args
394 * Note: Boy, all the #ifdefs in 1001 locations and
395 * all the fumbling with configure.in and acconfig.h
396 * were *way* more work than the feature itself :-(
398 * - Because a generic redirect template was needed for
399 * this, tinygif = 3 now uses the same.
401 * - Moved GIFs, and other static HTTP response templates
406 * - Removed some >400 CRs again (Jon, you really worked
409 * Revision 1.3 2001/05/20 01:21:20 jongfoster
410 * Version 2.9.4 checkin.
411 * - Merged popupfile and cookiefile, and added control over PCRS
412 * filtering, in new "actionsfile".
413 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
414 * file error you now get a message box (in the Win32 GUI) rather
415 * than the program exiting with no explanation.
416 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
418 * - Removed tabs from "config"
419 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
420 * - Bumped up version number.
422 * Revision 1.2 2001/05/17 23:01:01 oes
423 * - Cleaned CRLF's from the sources and related files
425 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
426 * Initial import of version 2.9.3 source tree
429 *********************************************************************/
432 /* Declare struct FILE for vars and funcs. */
435 /* Need time_t for file_list */
439 * Include appropriate regular expression libraries.
440 * Note that pcrs and pcre (native) are needed for cgi
441 * and are included anyway.
457 # include "pcreposix.h"
459 # include <pcreposix.h>
464 #endif /* def AMIGA */
468 * I don't want to have to #include all this just for the declaration
469 * of SOCKET. However, it looks like we have to...
483 * The type used by sockets. On UNIX it's an int. Microsoft decided to
484 * make it an unsigned.
487 typedef SOCKET jb_socket;
488 #define JB_INVALID_SOCKET INVALID_SOCKET
489 #else /* ndef _WIN32 */
490 typedef int jb_socket;
491 #define JB_INVALID_SOCKET (-1)
492 #endif /* ndef _WIN32 */
496 * Error codes. Functions returning these should return a jb_err
498 #define JB_ERR_OK 0 /* Success, no error */
499 #define JB_ERR_MEMORY 1 /* Out of memory */
500 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
501 #define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
502 #define JB_ERR_PARSE 4 /* Error parsing file */
503 #define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
504 /* CGI actions editor. */
509 * This macro is used to free a pointer that may be NULL
511 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
514 /* Fix a problem with Solaris. There should be no effect on other
516 * Solaris's isspace() is a macro which uses it's argument directly
517 * as an array index. Therefore we need to make sure that high-bit
518 * characters generate +ve values, and ideally we also want to make
519 * the argument match the declared parameter type of "int".
521 * Note: Remember to #include <ctype.h> if you use these macros.
523 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
524 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
525 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
528 * Use for statically allocated buffers if you have no other choice.
529 * Remember to check the length of what you write into the buffer
530 * - we don't want any buffer overflows!
532 #define BUFFER_SIZE 5000
535 * Max length of CGI parameters (arbitrary limit)
537 #define CGI_PARAM_LEN_MAX 500
540 * Buffer size for capturing struct hostent data in the
541 * gethostby(name|addr)_r library calls. Since we don't
542 * loop over gethostbyname_r, the buffer must be sufficient
543 * to accomodate multiple IN A RRs, as used in DNS round robin
544 * load balancing. W3C's wwwlib uses 1K, so that should be
545 * good enough for us, too.
547 #define HOSTENT_BUFFER_SIZE 1024
550 * So you can say "while (FOREVER) { ...do something... }"
554 /* Default IP and port to listen on */
555 #define HADDR_DEFAULT "127.0.0.1"
556 #define HADDR_PORT 8118
558 /* Forward defs for various structures */
560 /* Need this for struct client_state */
561 struct configuration_spec;
564 /* Generic linked list of strings */
569 struct list_entry *next;
574 struct list_entry *first;
575 struct list_entry *last;
579 /* A map from a string to another string */
585 struct map_entry *next;
590 struct map_entry *first;
591 struct map_entry *last;
597 char *cmd; /* Whole command line: method, URL, Version */
598 char *ocmd; /* Backup of original cmd for CLF logging */
599 char *gpc; /* HTTP method: GET, POST, .. */
600 char *url; /* The URL */
601 char *ver; /* Protocol version */
602 int status; /* HTTP Status */
604 char *host; /* Host part of URL */
605 int port; /* Port of URL or 80 (default) */
606 char *path; /* Path of URL */
607 char *hostport; /* host[:port] */
608 int ssl; /* Flag if protocol is https */
610 char *host_ip_addr_str; /* String with dotted decimal representation
611 * of host's IP. NULL before connect_to() */
613 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
614 char **dvec; /* List of pointers to the strings in dbuffer. */
615 int dcount; /* How many parts to this domain? (length of dvec) */
619 * Response generated by CGI, blocker, or error handler
623 char *status; /* HTTP status (string) */
624 struct list headers[1]; /* List of header lines */
625 char *head; /* Formatted http response head */
626 size_t head_length; /* Length of http response head */
627 char *body; /* HTTP document body */
628 size_t content_length; /* Length of body, REQUIRED if binary body */
629 int is_static; /* Nonzero if the content will never change and
630 * should be cached by the brwoser (e.g. images) */
636 char *spec; /* The string which was parsed to produce this */
637 /* url_spec. Used for debugging or display only. */
639 /* Hostname matching, or dbuffer == NULL to match all hosts */
640 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
641 char **dvec; /* List of pointers to the strings in dbuffer. */
642 int dcount; /* How many parts to this domain? (length of dvec) */
643 int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
646 int port; /* The port number, or 0 to match all ports. */
649 char *path; /* The path prefix (if not using regex), or source */
651 int pathlen; /* ==strlen(path). Needed for prefix matching. */
652 regex_t *preg; /* Regex for matching path part */
654 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
656 /* Constants for host part matching in URLs */
657 #define ANCHOR_LEFT 1
658 #define ANCHOR_RIGHT 2
664 char *buf; /* Start of buffer */
665 char *cur; /* Start of relevant data */
666 char *eod; /* End of relevant data */
667 size_t size; /* Size as malloc()ed */
671 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
672 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
674 /* Bits for csp->content_type */
675 #define CT_TEXT 1 /* Suitable for pcrs filtering */
676 #define CT_GIF 2 /* Suitable for GIF filtering */
677 #define CT_TABOO 4 /* DONT filter */
679 #define ACTION_MASK_ALL (~0U)
681 #define ACTION_MOST_COMPATIBLE 0x00000000UL
683 #define ACTION_BLOCK 0x00000001UL
684 #define ACTION_DEANIMATE 0x00000002UL
685 #define ACTION_DOWNGRADE 0x00000004UL
686 #define ACTION_FAST_REDIRECTS 0x00000008UL
687 #define ACTION_HIDE_FORWARDED 0x00000010UL
688 #define ACTION_HIDE_FROM 0x00000020UL
689 #define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */
690 #define ACTION_HIDE_USER_AGENT 0x00000080UL
691 #define ACTION_IMAGE 0x00000100UL
692 #define ACTION_IMAGE_BLOCKER 0x00000200UL
693 #define ACTION_NO_COMPRESSION 0x00000400UL
694 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
695 #define ACTION_NO_COOKIE_READ 0x00001000UL
696 #define ACTION_NO_COOKIE_SET 0x00002000UL
697 #define ACTION_NO_POPUPS 0x00004000UL
698 #define ACTION_VANILLA_WAFER 0x00008000UL
699 #define ACTION_LIMIT_CONNECT 0x00010000UL
701 #define ACTION_STRING_DEANIMATE 0
702 #define ACTION_STRING_FROM 1
703 #define ACTION_STRING_IMAGE_BLOCKER 2
704 #define ACTION_STRING_REFERER 3
705 #define ACTION_STRING_USER_AGENT 4
706 #define ACTION_STRING_LIMIT_CONNECT 5
707 #define ACTION_STRING_COUNT 6
709 #define ACTION_MULTI_ADD_HEADER 0
710 #define ACTION_MULTI_WAFER 1
711 #define ACTION_MULTI_FILTER 2
712 #define ACTION_MULTI_COUNT 3
716 * This structure contains a list of actions to apply to a URL.
717 * It only contains positive instructions - no "-" options.
718 * It is not used to store the actions list itself, only for
719 * url_actions() to return the current values.
721 struct current_action_spec
723 unsigned long flags; /* a bit set to "1" = add action */
725 /* For those actions that require parameters: */
727 /* each entry is valid if & only if corresponding entry in "add" set. */
728 char * string[ACTION_STRING_COUNT];
731 struct list multi[ACTION_MULTI_COUNT][1];
736 * This structure contains a set of changes to actions.
737 * It can contain both positive and negative instructions.
738 * It is used to store an entry in the actions list.
742 unsigned long mask; /* a bit set to "0" = remove action */
743 unsigned long add; /* a bit set to "1" = add action */
745 /* For those actions that require parameters: */
747 /* each entry is valid if & only if corresponding entry in "add" set. */
748 char * string[ACTION_STRING_COUNT];
750 /* Strings to remove. */
751 struct list multi_remove[ACTION_MULTI_COUNT][1];
753 /* If nonzero, remove *all* strings. */
754 int multi_remove_all[ACTION_MULTI_COUNT];
757 struct list multi_add[ACTION_MULTI_COUNT][1];
761 * This structure is used to store the actions list.
763 * It contains a URL pattern, and the chages to the actions.
764 * It is a linked list.
768 struct url_spec url[1];
770 struct action_spec action[1];
772 struct url_actions * next;
777 * Flags for use in csp->flags
779 #define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
780 * Cleared when the thread associated with
781 * this structure dies. */
782 #define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
783 * transfer encoding */
784 #define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
785 * it would normally have been blocked. */
786 #define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
787 #define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
788 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
791 * Maximum number of actions files. This limit is arbitrary - it's just used
794 #define MAX_ACTION_FILES 10
797 * The state of a Privoxy processing thread.
801 /* The proxy's configuration */
802 struct configuration_spec * config;
804 /* The actions to perform on the current request */
805 struct current_action_spec action[1];
807 /* socket to talk to client (web browser) */
810 /* socket to talk to server (web server or proxy) */
813 /* Multi-purpose flag container, see CSP_FLAG_* above */
814 unsigned short int flags;
817 * Client PC's IP address, as reported by the accept()_ function.
818 * Both as string and number
824 /* Our IP address and hostname, i.e. the IP address that
825 the client used to reach us, and the associated hostname,
828 char *my_ip_addr_str;
831 /* The URL that was requested */
832 struct http_request http[1];
834 /* An I/O buffer used for buffering data read from the client */
837 /* List of all headers for this request */
838 struct list headers[1];
840 /* List of all cookies for this request */
841 struct list cookie_list[1];
843 /* MIME-Type key, see CT_* above */
844 unsigned short int content_type;
846 /* The "X-Forwarded-For:" header sent by the client */
849 /* files associated with this client */
850 struct file_list *actions_list[MAX_ACTION_FILES];
852 struct file_list *rlist; /* pcrs job file */
853 size_t content_length; /* Length after content modification */
856 struct file_list *tlist; /* trustfile */
857 #endif /* def FEATURE_TRUST */
859 struct client_state *next;
864 * A function to add a header
866 typedef jb_err (*add_header_func_ptr)(struct client_state *);
869 * A function to process a header
871 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
874 * List of functions to run on a list of headers
880 parser_func_ptr parser;
885 * List of available CGI functions.
887 struct cgi_dispatcher
889 const char * const name;
890 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
891 const char * const description;
896 * A data file used by Privoxy. Kept in a linked list.
901 * this is a pointer to the data structures associated with the file.
902 * Read-only once the structure has been created.
906 /* Normally NULL. When we are finished with file (i.e. when we have
907 * loaded a new one), set to a pointer to an unloader function.
908 * Unloader will be called by sweep() (called from main loop) when
909 * all clients using this file are done. This prevents threading
912 void (*unloader)(void *);
914 /* Used internally by sweep(). Do not access from elsewhere. */
917 /* Following variables allow us to check if file has been changed.
918 * Read-only once the structure has been created.
923 /* Pointer to next entry in the linked list of all "file_list"s.
924 * This linked list is so that sweep() can navigate it.
925 * Since sweep() can remove items from the list, we must be careful
926 * to only access this value from main thread (when we know sweep
929 struct file_list *next;
936 struct url_spec url[1];
938 struct block_spec *next;
940 #endif /* def FEATURE_TRUST */
943 #define SOCKS_NONE 0 /* Don't use a SOCKS server */
944 #define SOCKS_4 40 /* original SOCKS 4 protocol */
945 #define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
949 struct url_spec url[1];
951 /* Connection type - must be a SOCKS_xxx constant */
958 /* Parent HTTP proxy */
962 /* For the linked list */
963 struct forward_spec *next;
965 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
969 * This struct represents one filter (one block) from
970 * the re_filterfile. If there is more than one filter
971 * in the file, the file will be represented by a
972 * chained list of re_filterfile specs.
974 struct re_filterfile_spec
976 char *name; /* Name from FILTER: statement in re_filterfile */
977 char *description; /* Description from FILTER: statement in re_filterfile */
978 struct list patterns[1]; /* The patterns from the re_filterfile */
979 pcrs_job *joblist; /* The resulting compiled pcrs_jobs */
980 struct re_filterfile_spec *next; /* The pointer for chaining */
984 #define ACL_PERMIT 1 /* accept connection request */
985 #define ACL_DENY 2 /* reject connection request */
987 struct access_control_addr
994 struct access_control_list
996 struct access_control_addr src[1];
997 struct access_control_addr dst[1];
1000 struct access_control_list *next;
1002 #endif /* def FEATURE_ACL */
1005 /* Maximum number of loaders (actions, re_filter, ...) */
1009 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1010 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1014 * Data loaded from the configuration file.
1016 * (Anomaly: toggle is still handled through a global, not this structure)
1018 struct configuration_spec
1023 /* Features that can be enabled/disabled through the config file */
1024 unsigned feature_flags;
1026 const char *logfile;
1028 const char *confdir;
1030 const char *actions_file[MAX_ACTION_FILES];
1031 const char *actions_file_short[MAX_ACTION_FILES];
1033 /* The administrator's email address */
1034 char *admin_address;
1036 /* A URL with info on this proxy */
1037 char *proxy_info_url;
1039 /* URL to the user manual (on our website or local copy) */
1042 const char *re_filterfile;
1044 #ifdef FEATURE_COOKIE_JAR
1045 const char * jarfile;
1047 #endif /* def FEATURE_COOKIE_JAR */
1050 * Port and IP to bind to.
1051 * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1056 /* Size limit for IOB */
1057 size_t buffer_limit;
1059 #ifdef FEATURE_TRUST
1060 const char * trustfile;
1062 struct list trust_info[1];
1063 struct url_spec *trust_list[64];
1064 #endif /* def FEATURE_TRUST */
1067 struct access_control_list *acl;
1068 #endif /* def FEATURE_ACL */
1070 struct forward_spec *forward;
1072 /* All options from the config file, HTML-formatted */
1075 /* the configuration file object. */
1076 struct file_list *config_file_list;
1078 /* List of loaders */
1079 int (*loaders[NLOADERS])(struct client_state *);
1081 /* bool, nonzero if we need to bind() to the new port */
1086 #define SZ(X) (sizeof(X) / sizeof(*X))
1088 #ifdef FEATURE_FORCE_LOAD
1089 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1090 #endif /* def FEATURE_FORCE_LOAD */
1092 #ifdef FEATURE_NO_GIFS
1093 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1095 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1096 #endif /* def FEATURE_NO_GIFS */
1099 /* Hardwired URLs */
1100 #define HOME_PAGE_URL "http://www.privoxy.org"
1101 #define USER_MANUAL_URL HOME_PAGE_URL "/" VERSION "/user-manual/"
1102 #define HELP_LINK_PREFIX "configuration.html#"
1105 * The "hosts" to intercept and display CGI pages.
1106 * First one is a hostname only, second one can specify host and path.
1109 * 1) Do not specify the http: prefix
1110 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1111 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1113 #define CGI_SITE_1_HOST "p.p"
1114 #define CGI_SITE_2_HOST "config.privoxy.org"
1115 #define CGI_SITE_2_PATH ""
1118 * The prefix for CGI pages. Written out in generated HTML.
1119 * INCLUDES the trailing slash.
1121 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1124 /* HTTP snipplets */
1125 static const char CSUCCEED[] =
1126 "HTTP/1.0 200 Connection established\n"
1127 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1129 static const char CHEADER[] =
1130 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1132 static const char CFORBIDDEN[] =
1133 "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";
1139 #endif /* ndef PROJECT_H_INCLUDED */