1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 #define PROJECT_H_VERSION "$Id: project.h,v 1.69 2002/05/08 16:00:16 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.69 2002/05/08 16:00:16 oes
40 * Added size member to struct iob, so it can
41 * be alloced larger than needed.
43 * Revision 1.68 2002/04/26 12:56:00 oes
44 * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
46 * Revision 1.67 2002/04/24 02:12:43 oes
47 * - Jon's multiple AF patch:
48 * - Make csp->actions_list an array
49 * - #define MAX_ACTION_FILES
50 * - Moved CGI_PARAM_LEN_MAX (500) here
52 * Revision 1.66 2002/04/15 19:06:43 jongfoster
55 * Revision 1.65 2002/04/04 00:36:36 gliptak
56 * always use pcre for matching
58 * Revision 1.64 2002/04/03 22:28:03 gliptak
59 * Removed references to gnu_regex
61 * Revision 1.63 2002/03/31 17:19:00 jongfoster
62 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
64 * Revision 1.62 2002/03/26 22:48:49 swa
67 * Revision 1.61 2002/03/26 22:29:55 swa
68 * we have a new homepage!
70 * Revision 1.60 2002/03/24 15:52:17 jongfoster
71 * Changing CGI URL prefixes for new name
73 * Revision 1.59 2002/03/24 15:23:33 jongfoster
76 * Revision 1.58 2002/03/24 13:25:43 swa
77 * name change related issues
79 * Revision 1.57 2002/03/16 20:28:34 oes
80 * Added descriptions to the filters so users will know what they select in the cgi editor
82 * Revision 1.56 2002/03/13 20:27:30 oes
83 * Fixing bug with CT_TABOO
85 * Revision 1.55 2002/03/12 01:42:50 oes
86 * Introduced modular filters
88 * Revision 1.54 2002/03/09 20:03:52 jongfoster
89 * - Making various functions return int rather than size_t.
90 * (Undoing a recent change). Since size_t is unsigned on
91 * Windows, functions like read_socket that return -1 on
92 * error cannot return a size_t.
94 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
95 * crashes, and also frequently caused JB to jump to 100%
96 * CPU and stay there. (Because it thought it had just
97 * read ((unsigned)-1) == 4Gb of data...)
99 * - The signature of write_socket has changed, it now simply
100 * returns success=0/failure=nonzero.
102 * - Trying to get rid of a few warnings --with-debug on
103 * Windows, I've introduced a new type "jb_socket". This is
104 * used for the socket file descriptors. On Windows, this
105 * is SOCKET (a typedef for unsigned). Everywhere else, it's
106 * an int. The error value can't be -1 any more, so it's
107 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
108 * Windows it maps to the #define INVALID_SOCKET.)
110 * - The signature of bind_port has changed.
112 * Revision 1.53 2002/03/08 16:48:55 oes
113 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
115 * Revision 1.52 2002/03/07 03:46:17 oes
116 * Fixed compiler warnings
118 * Revision 1.51 2002/03/05 04:52:42 oes
119 * Deleted non-errlog debugging code
121 * Revision 1.50 2002/03/04 19:32:07 oes
122 * Changed default port to 8118
124 * Revision 1.49 2002/03/04 18:28:55 oes
125 * Deleted PID_FILE_NAME
127 * Revision 1.48 2002/03/03 14:50:40 oes
128 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
130 * Revision 1.47 2002/02/20 23:15:13 jongfoster
131 * Parsing functions now handle out-of-memory gracefully by returning
134 * Revision 1.46 2002/01/17 21:06:09 jongfoster
135 * Now #defining the URLs of the config interface
137 * Minor changes to struct http_request and struct url_spec due to
138 * standardizing that struct http_request is used to represent a URL, and
139 * struct url_spec is used to represent a URL pattern. (Before, URLs were
140 * represented as seperate variables and a partially-filled-in url_spec).
142 * Revision 1.45 2002/01/09 14:33:27 oes
143 * Added HOSTENT_BUFFER_SIZE
145 * Revision 1.44 2001/12/30 14:07:32 steudten
146 * - Add signal handling (unix)
147 * - Add SIGHUP handler (unix)
148 * - Add creation of pidfile (unix)
149 * - Add action 'top' in rc file (RH)
150 * - Add entry 'SIGNALS' to manpage
151 * - Add exit message to logfile (unix)
153 * Revision 1.43 2001/11/22 21:57:51 jongfoster
154 * Making action_spec->flags into an unsigned long rather than just an
156 * Adding ACTION_NO_COOKIE_KEEP
158 * Revision 1.42 2001/11/05 21:42:41 steudten
159 * Include DBG() macro.
161 * Revision 1.41 2001/10/28 19:12:06 jongfoster
162 * Adding ijb_toupper()
164 * Revision 1.40 2001/10/26 17:40:47 oes
165 * Moved ijb_isspace and ijb_tolower to project.h
166 * Removed http->user_agent, csp->referrer and csp->accept_types
168 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
169 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
170 * macro when called with a cast; so moving the cast to the macro def'n
171 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
172 * doesn't make macro expansion complain. Hope this works for everyone else
175 * Revision 1.38 2001/10/23 21:19:04 jongfoster
176 * New error-handling support: jb_err type and JB_ERR_xxx constants
177 * CGI functions now return a jb_err, and their parameters map is const.
178 * Support for RUNTIME_FEATUREs to enable/disable config editor
179 * Adding a few comments
181 * Revision 1.37 2001/10/14 22:14:01 jongfoster
182 * Removing name_length field from struct cgi_dispatcher, as this is
183 * now calculated at runtime from the "name" field.
185 * Revision 1.36 2001/10/10 16:45:15 oes
186 * Added LIMIT_CONNECT action and string
187 * Fixed HTTP message line termination
188 * Added CFORBIDDEN HTTP message
190 * Revision 1.35 2001/10/07 18:06:43 oes
191 * Added status member to struct http_request
193 * Revision 1.34 2001/10/07 15:45:25 oes
194 * Added url member to struct http_request and commented all
199 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
201 * Replaced struct client_state members rejected,
202 * force, active and toggled_on with "flags" bitmap.
204 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
206 * Added buffer_limit to struct configuration_spec
208 * Revision 1.33 2001/09/20 13:30:08 steudten
210 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
211 * Last case will set z to NULL in free(z) and thats bad..
213 * Revision 1.32 2001/09/16 23:02:51 jongfoster
216 * Revision 1.31 2001/09/16 13:20:29 jongfoster
217 * Rewrite of list library. Now has seperate header and list_entry
218 * structures. Also added a large sprinking of assert()s to the list
221 * Revision 1.30 2001/09/13 23:52:00 jongfoster
222 * Support for both static and dynamically generated CGI pages
224 * Revision 1.29 2001/09/13 23:29:43 jongfoster
225 * Defining FORWARD_SPEC_INITIALIZER
227 * Revision 1.28 2001/09/13 23:05:50 jongfoster
228 * Changing the string paramater to the header parsers a "const".
230 * Revision 1.27 2001/08/05 16:06:20 jongfoster
231 * Modifiying "struct map" so that there are now separate header and
232 * "map_entry" structures. This means that functions which modify a
233 * map no longer need to return a pointer to the modified map.
234 * Also, it no longer reverses the order of the entries (which may be
235 * important with some advanced template substitutions).
237 * Revision 1.26 2001/07/30 22:08:36 jongfoster
238 * Tidying up #defines:
239 * - All feature #defines are now of the form FEATURE_xxx
240 * - Permanently turned off WIN_GUI_EDIT
241 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
243 * Revision 1.25 2001/07/29 18:43:08 jongfoster
244 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
247 * Revision 1.24 2001/07/25 17:20:27 oes
248 * Introduced http->user_agent
250 * Revision 1.23 2001/07/18 12:32:23 oes
251 * - Added ACTION_STRING_DEANIMATE
252 * - moved #define freez from jcc.h to project.h
254 * Revision 1.22 2001/07/15 17:51:41 jongfoster
255 * Renaming #define STATIC to STATIC_PCRE
257 * Revision 1.21 2001/07/13 14:03:19 oes
258 * - Reorganized regex header inclusion and #defines to
259 * comply to the scheme in configure.in
260 * - Added csp->content_type and its CT_* keys
261 * - Added ACTION_DEANIMATE
262 * - Removed all #ifdef PCRS
264 * Revision 1.20 2001/06/29 21:45:41 oes
265 * Indentation, CRLF->LF, Tab-> Space
267 * Revision 1.19 2001/06/29 13:33:36 oes
268 * - Improved comments
269 * - Introduced http_request.host_ip_addr_str
270 * - Introduced http_response.head_length
271 * - Introduced config.my_ip_addr_str, config.my_hostname,
272 * config.admin_address and config.proxy_info_url
273 * - Removed config.proxy_args_header and config.proxy_args_trailer,
274 * renamed config.proxy_args_invocation to config.proxy_args
275 * - Removed HTML snipplets and GIFs
276 * - Removed logentry from cancelled commit
278 * Revision 1.18 2001/06/09 10:57:39 jongfoster
279 * Adding definition of BUFFER_SIZE.
280 * Changing struct cgi_dispatcher to use "const" strings.
282 * Revision 1.17 2001/06/07 23:15:09 jongfoster
283 * Merging ACL and forward files into config file.
284 * Moving struct gateway members into struct forward_spec
285 * Removing config->proxy_args_gateways
286 * Cosmetic: Adding a few comments
288 * Revision 1.16 2001/06/04 18:31:58 swa
289 * files are now prefixed with either `confdir' or `logdir'.
290 * `make redhat-dist' replaces both entries confdir and logdir
293 * Revision 1.15 2001/06/04 11:28:53 swa
294 * redirect did not work due to missing /
296 * Revision 1.14 2001/06/03 11:03:48 oes
298 * added struct http_response,
299 * changed struct interceptors to struct cgi_dispatcher,
300 * moved HTML stuff to cgi.h
302 * Revision 1.13 2001/06/01 20:05:36 jongfoster
303 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
304 * constant, and removed csp->tinygif.
306 * Revision 1.12 2001/06/01 18:49:17 jongfoster
307 * Replaced "list_share" with "list" - the tiny memory gain was not
308 * worth the extra complexity.
310 * Revision 1.11 2001/06/01 10:32:47 oes
311 * Added constants for anchoring selection bitmap
313 * Revision 1.10 2001/05/31 21:33:53 jongfoster
314 * Changes for new actions file, replacing permissionsfile
315 * and parts of the config file. Also added support for
318 * Revision 1.9 2001/05/31 17:32:31 oes
320 * - Enhanced domain part globbing with infix and prefix asterisk
321 * matching and optional unanchored operation
323 * Revision 1.8 2001/05/29 20:09:15 joergs
324 * HTTP_REDIRECT_TEMPLATE fixed.
326 * Revision 1.7 2001/05/29 09:50:24 jongfoster
327 * Unified blocklist/imagelist/actionslist.
328 * File format is still under discussion, but the internal changes
331 * Also modified interceptor behaviour:
332 * - We now intercept all URLs beginning with one of the following
333 * prefixes (and *only* these prefixes):
335 * * http://ijbswa.sf.net/config/
336 * * http://ijbswa.sourceforge.net/config/
337 * - New interceptors "home page" - go to http://i.j.b/ to see it.
338 * - Internal changes so that intercepted and fast redirect pages
339 * are not replaced with an image.
340 * - Interceptors now have the option to send a binary page direct
341 * to the client. (i.e. ijb-send-banner uses this)
342 * - Implemented show-url-info interceptor. (Which is why I needed
343 * the above interceptors changes - a typical URL is
344 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
345 * The previous mechanism would not have intercepted that, and
346 * if it had been intercepted then it then it would have replaced
349 * Revision 1.6 2001/05/27 22:17:04 oes
351 * - re_process_buffer no longer writes the modified buffer
352 * to the client, which was very ugly. It now returns the
353 * buffer, which it is then written by chat.
355 * - content_length now adjusts the Content-Length: header
356 * for modified documents rather than crunch()ing it.
357 * (Length info in csp->content_length, which is 0 for
358 * unmodified documents)
360 * - For this to work, sed() is called twice when filtering.
362 * Revision 1.5 2001/05/26 00:28:36 jongfoster
363 * Automatic reloading of config file.
364 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
365 * Most of the global variables have been moved to a new
366 * struct configuration_spec, accessed through csp->config->globalname
367 * Most of the globals remaining are used by the Win32 GUI.
369 * Revision 1.4 2001/05/22 18:46:04 oes
371 * - Enabled filtering banners by size rather than URL
372 * by adding patterns that replace all standard banner
373 * sizes with the "Junkbuster" gif to the re_filterfile
375 * - Enabled filtering WebBugs by providing a pattern
376 * which kills all 1x1 images
378 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
379 * which is selected by the (nonstandard and therefore
380 * capital) letter 'U' in the option string.
381 * It causes the quantifiers to be ungreedy by default.
382 * Appending a ? turns back to greedy (!).
384 * - Added a new interceptor ijb-send-banner, which
385 * sends back the "Junkbuster" gif. Without imagelist or
386 * MSIE detection support, or if tinygif = 1, or the
387 * URL isn't recognized as an imageurl, a lame HTML
388 * explanation is sent instead.
390 * - Added new feature, which permits blocking remote
391 * script redirects and firing back a local redirect
393 * The feature is conditionally compiled, i.e. it
394 * can be disabled with --disable-fast-redirects,
395 * plus it must be activated by a "fast-redirects"
396 * line in the config file, has its own log level
397 * and of course wants to be displayed by show-proxy-args
398 * Note: Boy, all the #ifdefs in 1001 locations and
399 * all the fumbling with configure.in and acconfig.h
400 * were *way* more work than the feature itself :-(
402 * - Because a generic redirect template was needed for
403 * this, tinygif = 3 now uses the same.
405 * - Moved GIFs, and other static HTTP response templates
410 * - Removed some >400 CRs again (Jon, you really worked
413 * Revision 1.3 2001/05/20 01:21:20 jongfoster
414 * Version 2.9.4 checkin.
415 * - Merged popupfile and cookiefile, and added control over PCRS
416 * filtering, in new "actionsfile".
417 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
418 * file error you now get a message box (in the Win32 GUI) rather
419 * than the program exiting with no explanation.
420 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
422 * - Removed tabs from "config"
423 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
424 * - Bumped up version number.
426 * Revision 1.2 2001/05/17 23:01:01 oes
427 * - Cleaned CRLF's from the sources and related files
429 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
430 * Initial import of version 2.9.3 source tree
433 *********************************************************************/
436 /* Declare struct FILE for vars and funcs. */
439 /* Need time_t for file_list */
443 * Include appropriate regular expression libraries.
444 * Note that pcrs and pcre (native) are needed for cgi
445 * and are included anyway.
461 # include "pcreposix.h"
463 # include <pcreposix.h>
468 #endif /* def AMIGA */
472 * I don't want to have to #include all this just for the declaration
473 * of SOCKET. However, it looks like we have to...
487 * The type used by sockets. On UNIX it's an int. Microsoft decided to
488 * make it an unsigned.
491 typedef SOCKET jb_socket;
492 #define JB_INVALID_SOCKET INVALID_SOCKET
493 #else /* ndef _WIN32 */
494 typedef int jb_socket;
495 #define JB_INVALID_SOCKET (-1)
496 #endif /* ndef _WIN32 */
500 * Error codes. Functions returning these should return a jb_err
502 #define JB_ERR_OK 0 /* Success, no error */
503 #define JB_ERR_MEMORY 1 /* Out of memory */
504 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
505 #define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
506 #define JB_ERR_PARSE 4 /* Error parsing file */
507 #define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
508 /* CGI actions editor. */
513 * This macro is used to free a pointer that may be NULL
515 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
518 /* Fix a problem with Solaris. There should be no effect on other
520 * Solaris's isspace() is a macro which uses it's argument directly
521 * as an array index. Therefore we need to make sure that high-bit
522 * characters generate +ve values, and ideally we also want to make
523 * the argument match the declared parameter type of "int".
525 * Note: Remember to #include <ctype.h> if you use these macros.
527 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
528 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
529 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
532 * Use for statically allocated buffers if you have no other choice.
533 * Remember to check the length of what you write into the buffer
534 * - we don't want any buffer overflows!
536 #define BUFFER_SIZE 5000
539 * Max length of CGI parameters (arbitrary limit)
541 #define CGI_PARAM_LEN_MAX 500
544 * Buffer size for capturing struct hostent data in the
545 * gethostby(name|addr)_r library calls. Since we don't
546 * loop over gethostbyname_r, the buffer must be sufficient
547 * to accomodate multiple IN A RRs, as used in DNS round robin
548 * load balancing. W3C's wwwlib uses 1K, so that should be
549 * good enough for us, too.
551 #define HOSTENT_BUFFER_SIZE 1024
554 * So you can say "while (FOREVER) { ...do something... }"
558 /* Default IP and port to listen on */
559 #define HADDR_DEFAULT "127.0.0.1"
560 #define HADDR_PORT 8118
562 /* Forward defs for various structures */
564 /* Need this for struct client_state */
565 struct configuration_spec;
568 /* Generic linked list of strings */
573 struct list_entry *next;
578 struct list_entry *first;
579 struct list_entry *last;
583 /* A map from a string to another string */
589 struct map_entry *next;
594 struct map_entry *first;
595 struct map_entry *last;
601 char *cmd; /* Whole command line: method, URL, Version */
602 char *ocmd; /* Backup of original cmd for CLF logging */
603 char *gpc; /* HTTP method: GET, POST, .. */
604 char *url; /* The URL */
605 char *ver; /* Protocol version */
606 int status; /* HTTP Status */
608 char *host; /* Host part of URL */
609 int port; /* Port of URL or 80 (default) */
610 char *path; /* Path of URL */
611 char *hostport; /* host[:port] */
612 int ssl; /* Flag if protocol is https */
614 char *host_ip_addr_str; /* String with dotted decimal representation
615 * of host's IP. NULL before connect_to() */
617 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
618 char **dvec; /* List of pointers to the strings in dbuffer. */
619 int dcount; /* How many parts to this domain? (length of dvec) */
623 * Response generated by CGI, blocker, or error handler
627 char *status; /* HTTP status (string) */
628 struct list headers[1]; /* List of header lines */
629 char *head; /* Formatted http response head */
630 size_t head_length; /* Length of http response head */
631 char *body; /* HTTP document body */
632 size_t content_length; /* Length of body, REQUIRED if binary body */
633 int is_static; /* Nonzero if the content will never change and
634 * should be cached by the brwoser (e.g. images) */
640 char *spec; /* The string which was parsed to produce this */
641 /* url_spec. Used for debugging or display only. */
643 /* Hostname matching, or dbuffer == NULL to match all hosts */
644 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
645 char **dvec; /* List of pointers to the strings in dbuffer. */
646 int dcount; /* How many parts to this domain? (length of dvec) */
647 int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
650 int port; /* The port number, or 0 to match all ports. */
653 char *path; /* The path prefix (if not using regex), or source */
655 int pathlen; /* ==strlen(path). Needed for prefix matching. */
656 regex_t *preg; /* Regex for matching path part */
658 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
660 /* Constants for host part matching in URLs */
661 #define ANCHOR_LEFT 1
662 #define ANCHOR_RIGHT 2
668 char *buf; /* Start of buffer */
669 char *cur; /* Start of relevant data */
670 char *eod; /* End of relevant data */
671 size_t size; /* Size as malloc()ed */
675 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
676 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
678 /* Bits for csp->content_type */
679 #define CT_TEXT 1 /* Suitable for pcrs filtering */
680 #define CT_GIF 2 /* Suitable for GIF filtering */
681 #define CT_TABOO 4 /* DONT filter */
683 #define ACTION_MASK_ALL (~0UL)
685 #define ACTION_MOST_COMPATIBLE 0x00000000UL
687 #define ACTION_BLOCK 0x00000001UL
688 #define ACTION_DEANIMATE 0x00000002UL
689 #define ACTION_DOWNGRADE 0x00000004UL
690 #define ACTION_FAST_REDIRECTS 0x00000008UL
691 #define ACTION_HIDE_FORWARDED 0x00000010UL
692 #define ACTION_HIDE_FROM 0x00000020UL
693 #define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */
694 #define ACTION_HIDE_USER_AGENT 0x00000080UL
695 #define ACTION_IMAGE 0x00000100UL
696 #define ACTION_IMAGE_BLOCKER 0x00000200UL
697 #define ACTION_NO_COMPRESSION 0x00000400UL
698 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
699 #define ACTION_NO_COOKIE_READ 0x00001000UL
700 #define ACTION_NO_COOKIE_SET 0x00002000UL
701 #define ACTION_NO_POPUPS 0x00004000UL
702 #define ACTION_VANILLA_WAFER 0x00008000UL
703 #define ACTION_LIMIT_CONNECT 0x00010000UL
705 #define ACTION_STRING_DEANIMATE 0
706 #define ACTION_STRING_FROM 1
707 #define ACTION_STRING_IMAGE_BLOCKER 2
708 #define ACTION_STRING_REFERER 3
709 #define ACTION_STRING_USER_AGENT 4
710 #define ACTION_STRING_LIMIT_CONNECT 5
711 #define ACTION_STRING_COUNT 6
713 #define ACTION_MULTI_ADD_HEADER 0
714 #define ACTION_MULTI_WAFER 1
715 #define ACTION_MULTI_FILTER 2
716 #define ACTION_MULTI_COUNT 3
720 * This structure contains a list of actions to apply to a URL.
721 * It only contains positive instructions - no "-" options.
722 * It is not used to store the actions list itself, only for
723 * url_actions() to return the current values.
725 struct current_action_spec
727 unsigned long flags; /* a bit set to "1" = add action */
729 /* For those actions that require parameters: */
731 /* each entry is valid if & only if corresponding entry in "add" set. */
732 char * string[ACTION_STRING_COUNT];
735 struct list multi[ACTION_MULTI_COUNT][1];
740 * This structure contains a set of changes to actions.
741 * It can contain both positive and negative instructions.
742 * It is used to store an entry in the actions list.
746 unsigned long mask; /* a bit set to "0" = remove action */
747 unsigned long add; /* a bit set to "1" = add action */
749 /* For those actions that require parameters: */
751 /* each entry is valid if & only if corresponding entry in "add" set. */
752 char * string[ACTION_STRING_COUNT];
754 /* Strings to remove. */
755 struct list multi_remove[ACTION_MULTI_COUNT][1];
757 /* If nonzero, remove *all* strings. */
758 int multi_remove_all[ACTION_MULTI_COUNT];
761 struct list multi_add[ACTION_MULTI_COUNT][1];
765 * This structure is used to store the actions list.
767 * It contains a URL pattern, and the chages to the actions.
768 * It is a linked list.
772 struct url_spec url[1];
774 struct action_spec action[1];
776 struct url_actions * next;
781 * Flags for use in csp->flags
783 #define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
784 * Cleared when the thread associated with
785 * this structure dies. */
786 #define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
787 * transfer encoding */
788 #define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
789 * it would normally have been blocked. */
790 #define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
791 #define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
792 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
795 * Maximum number of actions files. This limit is arbitrary - it's just used
798 #define MAX_ACTION_FILES 10
801 * The state of a Privoxy processing thread.
805 /* The proxy's configuration */
806 struct configuration_spec * config;
808 /* The actions to perform on the current request */
809 struct current_action_spec action[1];
811 /* socket to talk to client (web browser) */
814 /* socket to talk to server (web server or proxy) */
817 /* Multi-purpose flag container, see CSP_FLAG_* above */
818 unsigned short int flags;
821 * Client PC's IP address, as reported by the accept()_ function.
822 * Both as string and number
828 /* Our IP address and hostname, i.e. the IP address that
829 the client used to reach us, and the associated hostname,
832 char *my_ip_addr_str;
835 /* The URL that was requested */
836 struct http_request http[1];
838 /* An I/O buffer used for buffering data read from the client */
841 /* List of all headers for this request */
842 struct list headers[1];
844 /* List of all cookies for this request */
845 struct list cookie_list[1];
847 /* MIME-Type key, see CT_* above */
848 unsigned short int content_type;
850 /* The "X-Forwarded-For:" header sent by the client */
853 /* files associated with this client */
854 struct file_list *actions_list[MAX_ACTION_FILES];
856 struct file_list *rlist; /* pcrs job file */
857 size_t content_length; /* Length after content modification */
860 struct file_list *tlist; /* trustfile */
861 #endif /* def FEATURE_TRUST */
863 struct client_state *next;
868 * A function to add a header
870 typedef jb_err (*add_header_func_ptr)(struct client_state *);
873 * A function to process a header
875 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
878 * List of functions to run on a list of headers
884 parser_func_ptr parser;
889 * List of available CGI functions.
891 struct cgi_dispatcher
893 const char * const name;
894 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
895 const char * const description;
900 * A data file used by Privoxy. Kept in a linked list.
905 * this is a pointer to the data structures associated with the file.
906 * Read-only once the structure has been created.
910 /* Normally NULL. When we are finished with file (i.e. when we have
911 * loaded a new one), set to a pointer to an unloader function.
912 * Unloader will be called by sweep() (called from main loop) when
913 * all clients using this file are done. This prevents threading
916 void (*unloader)(void *);
918 /* Used internally by sweep(). Do not access from elsewhere. */
921 /* Following variables allow us to check if file has been changed.
922 * Read-only once the structure has been created.
927 /* Pointer to next entry in the linked list of all "file_list"s.
928 * This linked list is so that sweep() can navigate it.
929 * Since sweep() can remove items from the list, we must be careful
930 * to only access this value from main thread (when we know sweep
933 struct file_list *next;
940 struct url_spec url[1];
942 struct block_spec *next;
944 #endif /* def FEATURE_TRUST */
947 #define SOCKS_NONE 0 /* Don't use a SOCKS server */
948 #define SOCKS_4 40 /* original SOCKS 4 protocol */
949 #define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
953 struct url_spec url[1];
955 /* Connection type - must be a SOCKS_xxx constant */
962 /* Parent HTTP proxy */
966 /* For the linked list */
967 struct forward_spec *next;
969 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
973 * This struct represents one filter (one block) from
974 * the re_filterfile. If there is more than one filter
975 * in the file, the file will be represented by a
976 * chained list of re_filterfile specs.
978 struct re_filterfile_spec
980 char *name; /* Name from FILTER: statement in re_filterfile */
981 char *description; /* Description from FILTER: statement in re_filterfile */
982 struct list patterns[1]; /* The patterns from the re_filterfile */
983 pcrs_job *joblist; /* The resulting compiled pcrs_jobs */
984 struct re_filterfile_spec *next; /* The pointer for chaining */
988 #define ACL_PERMIT 1 /* accept connection request */
989 #define ACL_DENY 2 /* reject connection request */
991 struct access_control_addr
998 struct access_control_list
1000 struct access_control_addr src[1];
1001 struct access_control_addr dst[1];
1004 struct access_control_list *next;
1006 #endif /* def FEATURE_ACL */
1009 /* Maximum number of loaders (actions, re_filter, ...) */
1013 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
1014 #define RUNTIME_FEATURE_CGI_TOGGLE 2
1018 * Data loaded from the configuration file.
1020 * (Anomaly: toggle is still handled through a global, not this structure)
1022 struct configuration_spec
1027 /* Features that can be enabled/disabled through the config file */
1028 unsigned feature_flags;
1030 const char *logfile;
1032 const char *confdir;
1034 const char *actions_file[MAX_ACTION_FILES];
1035 const char *actions_file_short[MAX_ACTION_FILES];
1037 /* The administrator's email address */
1038 char *admin_address;
1040 /* A URL with info on this proxy */
1041 char *proxy_info_url;
1043 /* URL to the user manual (on our website or local copy) */
1046 const char *re_filterfile;
1048 #ifdef FEATURE_COOKIE_JAR
1049 const char * jarfile;
1051 #endif /* def FEATURE_COOKIE_JAR */
1054 * Port and IP to bind to.
1055 * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1060 /* Size limit for IOB */
1061 size_t buffer_limit;
1063 #ifdef FEATURE_TRUST
1064 const char * trustfile;
1066 struct list trust_info[1];
1067 struct url_spec *trust_list[64];
1068 #endif /* def FEATURE_TRUST */
1071 struct access_control_list *acl;
1072 #endif /* def FEATURE_ACL */
1074 struct forward_spec *forward;
1076 /* All options from the config file, HTML-formatted */
1079 /* the configuration file object. */
1080 struct file_list *config_file_list;
1082 /* List of loaders */
1083 int (*loaders[NLOADERS])(struct client_state *);
1085 /* bool, nonzero if we need to bind() to the new port */
1090 #define SZ(X) (sizeof(X) / sizeof(*X))
1092 #ifdef FEATURE_FORCE_LOAD
1093 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1094 #endif /* def FEATURE_FORCE_LOAD */
1096 #ifdef FEATURE_NO_GIFS
1097 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1099 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1100 #endif /* def FEATURE_NO_GIFS */
1103 /* Hardwired URLs */
1104 #define HOME_PAGE_URL "http://www.privoxy.org"
1105 #define USER_MANUAL_URL HOME_PAGE_URL "/" VERSION "/user-manual/"
1106 #define HELP_LINK_PREFIX "configuration.html#"
1109 * The "hosts" to intercept and display CGI pages.
1110 * First one is a hostname only, second one can specify host and path.
1113 * 1) Do not specify the http: prefix
1114 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1115 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1117 #define CGI_SITE_1_HOST "p.p"
1118 #define CGI_SITE_2_HOST "config.privoxy.org"
1119 #define CGI_SITE_2_PATH ""
1122 * The prefix for CGI pages. Written out in generated HTML.
1123 * INCLUDES the trailing slash.
1125 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1128 /* HTTP snipplets */
1129 static const char CSUCCEED[] =
1130 "HTTP/1.0 200 Connection established\n"
1131 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1133 static const char CHEADER[] =
1134 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1136 static const char CFORBIDDEN[] =
1137 "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";
1143 #endif /* ndef PROJECT_H_INCLUDED */