1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 #define PROJECT_H_VERSION "$Id: project.h,v 1.62 2002/03/26 22:48:49 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.62 2002/03/26 22:48:49 swa
42 * Revision 1.61 2002/03/26 22:29:55 swa
43 * we have a new homepage!
45 * Revision 1.60 2002/03/24 15:52:17 jongfoster
46 * Changing CGI URL prefixes for new name
48 * Revision 1.59 2002/03/24 15:23:33 jongfoster
51 * Revision 1.58 2002/03/24 13:25:43 swa
52 * name change related issues
54 * Revision 1.57 2002/03/16 20:28:34 oes
55 * Added descriptions to the filters so users will know what they select in the cgi editor
57 * Revision 1.56 2002/03/13 20:27:30 oes
58 * Fixing bug with CT_TABOO
60 * Revision 1.55 2002/03/12 01:42:50 oes
61 * Introduced modular filters
63 * Revision 1.54 2002/03/09 20:03:52 jongfoster
64 * - Making various functions return int rather than size_t.
65 * (Undoing a recent change). Since size_t is unsigned on
66 * Windows, functions like read_socket that return -1 on
67 * error cannot return a size_t.
69 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
70 * crashes, and also frequently caused JB to jump to 100%
71 * CPU and stay there. (Because it thought it had just
72 * read ((unsigned)-1) == 4Gb of data...)
74 * - The signature of write_socket has changed, it now simply
75 * returns success=0/failure=nonzero.
77 * - Trying to get rid of a few warnings --with-debug on
78 * Windows, I've introduced a new type "jb_socket". This is
79 * used for the socket file descriptors. On Windows, this
80 * is SOCKET (a typedef for unsigned). Everywhere else, it's
81 * an int. The error value can't be -1 any more, so it's
82 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
83 * Windows it maps to the #define INVALID_SOCKET.)
85 * - The signature of bind_port has changed.
87 * Revision 1.53 2002/03/08 16:48:55 oes
88 * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
90 * Revision 1.52 2002/03/07 03:46:17 oes
91 * Fixed compiler warnings
93 * Revision 1.51 2002/03/05 04:52:42 oes
94 * Deleted non-errlog debugging code
96 * Revision 1.50 2002/03/04 19:32:07 oes
97 * Changed default port to 8118
99 * Revision 1.49 2002/03/04 18:28:55 oes
100 * Deleted PID_FILE_NAME
102 * Revision 1.48 2002/03/03 14:50:40 oes
103 * Fixed CLF logging: Added ocmd member for client's request to struct http_request
105 * Revision 1.47 2002/02/20 23:15:13 jongfoster
106 * Parsing functions now handle out-of-memory gracefully by returning
109 * Revision 1.46 2002/01/17 21:06:09 jongfoster
110 * Now #defining the URLs of the config interface
112 * Minor changes to struct http_request and struct url_spec due to
113 * standardizing that struct http_request is used to represent a URL, and
114 * struct url_spec is used to represent a URL pattern. (Before, URLs were
115 * represented as seperate variables and a partially-filled-in url_spec).
117 * Revision 1.45 2002/01/09 14:33:27 oes
118 * Added HOSTENT_BUFFER_SIZE
120 * Revision 1.44 2001/12/30 14:07:32 steudten
121 * - Add signal handling (unix)
122 * - Add SIGHUP handler (unix)
123 * - Add creation of pidfile (unix)
124 * - Add action 'top' in rc file (RH)
125 * - Add entry 'SIGNALS' to manpage
126 * - Add exit message to logfile (unix)
128 * Revision 1.43 2001/11/22 21:57:51 jongfoster
129 * Making action_spec->flags into an unsigned long rather than just an
131 * Adding ACTION_NO_COOKIE_KEEP
133 * Revision 1.42 2001/11/05 21:42:41 steudten
134 * Include DBG() macro.
136 * Revision 1.41 2001/10/28 19:12:06 jongfoster
137 * Adding ijb_toupper()
139 * Revision 1.40 2001/10/26 17:40:47 oes
140 * Moved ijb_isspace and ijb_tolower to project.h
141 * Removed http->user_agent, csp->referrer and csp->accept_types
143 * Revision 1.39 2001/10/25 03:45:02 david__schmidt
144 * Adding a (void*) cast to freez() because Visual Age C++ won't expand the
145 * macro when called with a cast; so moving the cast to the macro def'n
146 * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
147 * doesn't make macro expansion complain. Hope this works for everyone else
150 * Revision 1.38 2001/10/23 21:19:04 jongfoster
151 * New error-handling support: jb_err type and JB_ERR_xxx constants
152 * CGI functions now return a jb_err, and their parameters map is const.
153 * Support for RUNTIME_FEATUREs to enable/disable config editor
154 * Adding a few comments
156 * Revision 1.37 2001/10/14 22:14:01 jongfoster
157 * Removing name_length field from struct cgi_dispatcher, as this is
158 * now calculated at runtime from the "name" field.
160 * Revision 1.36 2001/10/10 16:45:15 oes
161 * Added LIMIT_CONNECT action and string
162 * Fixed HTTP message line termination
163 * Added CFORBIDDEN HTTP message
165 * Revision 1.35 2001/10/07 18:06:43 oes
166 * Added status member to struct http_request
168 * Revision 1.34 2001/10/07 15:45:25 oes
169 * Added url member to struct http_request and commented all
174 * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
176 * Replaced struct client_state members rejected,
177 * force, active and toggled_on with "flags" bitmap.
179 * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
181 * Added buffer_limit to struct configuration_spec
183 * Revision 1.33 2001/09/20 13:30:08 steudten
185 * Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
186 * Last case will set z to NULL in free(z) and thats bad..
188 * Revision 1.32 2001/09/16 23:02:51 jongfoster
191 * Revision 1.31 2001/09/16 13:20:29 jongfoster
192 * Rewrite of list library. Now has seperate header and list_entry
193 * structures. Also added a large sprinking of assert()s to the list
196 * Revision 1.30 2001/09/13 23:52:00 jongfoster
197 * Support for both static and dynamically generated CGI pages
199 * Revision 1.29 2001/09/13 23:29:43 jongfoster
200 * Defining FORWARD_SPEC_INITIALIZER
202 * Revision 1.28 2001/09/13 23:05:50 jongfoster
203 * Changing the string paramater to the header parsers a "const".
205 * Revision 1.27 2001/08/05 16:06:20 jongfoster
206 * Modifiying "struct map" so that there are now separate header and
207 * "map_entry" structures. This means that functions which modify a
208 * map no longer need to return a pointer to the modified map.
209 * Also, it no longer reverses the order of the entries (which may be
210 * important with some advanced template substitutions).
212 * Revision 1.26 2001/07/30 22:08:36 jongfoster
213 * Tidying up #defines:
214 * - All feature #defines are now of the form FEATURE_xxx
215 * - Permanently turned off WIN_GUI_EDIT
216 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
218 * Revision 1.25 2001/07/29 18:43:08 jongfoster
219 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
222 * Revision 1.24 2001/07/25 17:20:27 oes
223 * Introduced http->user_agent
225 * Revision 1.23 2001/07/18 12:32:23 oes
226 * - Added ACTION_STRING_DEANIMATE
227 * - moved #define freez from jcc.h to project.h
229 * Revision 1.22 2001/07/15 17:51:41 jongfoster
230 * Renaming #define STATIC to STATIC_PCRE
232 * Revision 1.21 2001/07/13 14:03:19 oes
233 * - Reorganized regex header inclusion and #defines to
234 * comply to the scheme in configure.in
235 * - Added csp->content_type and its CT_* keys
236 * - Added ACTION_DEANIMATE
237 * - Removed all #ifdef PCRS
239 * Revision 1.20 2001/06/29 21:45:41 oes
240 * Indentation, CRLF->LF, Tab-> Space
242 * Revision 1.19 2001/06/29 13:33:36 oes
243 * - Improved comments
244 * - Introduced http_request.host_ip_addr_str
245 * - Introduced http_response.head_length
246 * - Introduced config.my_ip_addr_str, config.my_hostname,
247 * config.admin_address and config.proxy_info_url
248 * - Removed config.proxy_args_header and config.proxy_args_trailer,
249 * renamed config.proxy_args_invocation to config.proxy_args
250 * - Removed HTML snipplets and GIFs
251 * - Removed logentry from cancelled commit
253 * Revision 1.18 2001/06/09 10:57:39 jongfoster
254 * Adding definition of BUFFER_SIZE.
255 * Changing struct cgi_dispatcher to use "const" strings.
257 * Revision 1.17 2001/06/07 23:15:09 jongfoster
258 * Merging ACL and forward files into config file.
259 * Moving struct gateway members into struct forward_spec
260 * Removing config->proxy_args_gateways
261 * Cosmetic: Adding a few comments
263 * Revision 1.16 2001/06/04 18:31:58 swa
264 * files are now prefixed with either `confdir' or `logdir'.
265 * `make redhat-dist' replaces both entries confdir and logdir
268 * Revision 1.15 2001/06/04 11:28:53 swa
269 * redirect did not work due to missing /
271 * Revision 1.14 2001/06/03 11:03:48 oes
273 * added struct http_response,
274 * changed struct interceptors to struct cgi_dispatcher,
275 * moved HTML stuff to cgi.h
277 * Revision 1.13 2001/06/01 20:05:36 jongfoster
278 * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
279 * constant, and removed csp->tinygif.
281 * Revision 1.12 2001/06/01 18:49:17 jongfoster
282 * Replaced "list_share" with "list" - the tiny memory gain was not
283 * worth the extra complexity.
285 * Revision 1.11 2001/06/01 10:32:47 oes
286 * Added constants for anchoring selection bitmap
288 * Revision 1.10 2001/05/31 21:33:53 jongfoster
289 * Changes for new actions file, replacing permissionsfile
290 * and parts of the config file. Also added support for
293 * Revision 1.9 2001/05/31 17:32:31 oes
295 * - Enhanced domain part globbing with infix and prefix asterisk
296 * matching and optional unanchored operation
298 * Revision 1.8 2001/05/29 20:09:15 joergs
299 * HTTP_REDIRECT_TEMPLATE fixed.
301 * Revision 1.7 2001/05/29 09:50:24 jongfoster
302 * Unified blocklist/imagelist/actionslist.
303 * File format is still under discussion, but the internal changes
306 * Also modified interceptor behaviour:
307 * - We now intercept all URLs beginning with one of the following
308 * prefixes (and *only* these prefixes):
310 * * http://ijbswa.sf.net/config/
311 * * http://ijbswa.sourceforge.net/config/
312 * - New interceptors "home page" - go to http://i.j.b/ to see it.
313 * - Internal changes so that intercepted and fast redirect pages
314 * are not replaced with an image.
315 * - Interceptors now have the option to send a binary page direct
316 * to the client. (i.e. ijb-send-banner uses this)
317 * - Implemented show-url-info interceptor. (Which is why I needed
318 * the above interceptors changes - a typical URL is
319 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
320 * The previous mechanism would not have intercepted that, and
321 * if it had been intercepted then it then it would have replaced
324 * Revision 1.6 2001/05/27 22:17:04 oes
326 * - re_process_buffer no longer writes the modified buffer
327 * to the client, which was very ugly. It now returns the
328 * buffer, which it is then written by chat.
330 * - content_length now adjusts the Content-Length: header
331 * for modified documents rather than crunch()ing it.
332 * (Length info in csp->content_length, which is 0 for
333 * unmodified documents)
335 * - For this to work, sed() is called twice when filtering.
337 * Revision 1.5 2001/05/26 00:28:36 jongfoster
338 * Automatic reloading of config file.
339 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
340 * Most of the global variables have been moved to a new
341 * struct configuration_spec, accessed through csp->config->globalname
342 * Most of the globals remaining are used by the Win32 GUI.
344 * Revision 1.4 2001/05/22 18:46:04 oes
346 * - Enabled filtering banners by size rather than URL
347 * by adding patterns that replace all standard banner
348 * sizes with the "Junkbuster" gif to the re_filterfile
350 * - Enabled filtering WebBugs by providing a pattern
351 * which kills all 1x1 images
353 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
354 * which is selected by the (nonstandard and therefore
355 * capital) letter 'U' in the option string.
356 * It causes the quantifiers to be ungreedy by default.
357 * Appending a ? turns back to greedy (!).
359 * - Added a new interceptor ijb-send-banner, which
360 * sends back the "Junkbuster" gif. Without imagelist or
361 * MSIE detection support, or if tinygif = 1, or the
362 * URL isn't recognized as an imageurl, a lame HTML
363 * explanation is sent instead.
365 * - Added new feature, which permits blocking remote
366 * script redirects and firing back a local redirect
368 * The feature is conditionally compiled, i.e. it
369 * can be disabled with --disable-fast-redirects,
370 * plus it must be activated by a "fast-redirects"
371 * line in the config file, has its own log level
372 * and of course wants to be displayed by show-proxy-args
373 * Note: Boy, all the #ifdefs in 1001 locations and
374 * all the fumbling with configure.in and acconfig.h
375 * were *way* more work than the feature itself :-(
377 * - Because a generic redirect template was needed for
378 * this, tinygif = 3 now uses the same.
380 * - Moved GIFs, and other static HTTP response templates
385 * - Removed some >400 CRs again (Jon, you really worked
388 * Revision 1.3 2001/05/20 01:21:20 jongfoster
389 * Version 2.9.4 checkin.
390 * - Merged popupfile and cookiefile, and added control over PCRS
391 * filtering, in new "actionsfile".
392 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
393 * file error you now get a message box (in the Win32 GUI) rather
394 * than the program exiting with no explanation.
395 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
397 * - Removed tabs from "config"
398 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
399 * - Bumped up version number.
401 * Revision 1.2 2001/05/17 23:01:01 oes
402 * - Cleaned CRLF's from the sources and related files
404 * Revision 1.1.1.1 2001/05/15 13:59:03 oes
405 * Initial import of version 2.9.3 source tree
408 *********************************************************************/
411 /* Declare struct FILE for vars and funcs. */
414 /* Need time_t for file_list */
418 * Include appropriate regular expression libraries.
419 * Note that pcrs and pcre (native) are needed for cgi
420 * and are included anyway.
423 #if defined(REGEX_PCRE) || defined (REGEX_GNU)
425 #endif /* defined(REGEX_PCRE) || defined (REGEX_GNU) */
439 #if defined(REGEX_PCRE)
441 # include "pcreposix.h"
443 # include <pcreposix.h>
445 #endif /* defined(REGEX_PCRE) */
447 #if defined(REGEX_GNU)
448 # include "gnu_regex.h"
453 #endif /* def AMIGA */
457 * I don't want to have to #include all this just for the declaration
458 * of SOCKET. However, it looks like we have to...
472 * The type used by sockets. On UNIX it's an int. Microsoft decided to
473 * make it an unsigned.
476 typedef SOCKET jb_socket;
477 #define JB_INVALID_SOCKET INVALID_SOCKET
478 #else /* ndef _WIN32 */
479 typedef int jb_socket;
480 #define JB_INVALID_SOCKET (-1)
481 #endif /* ndef _WIN32 */
485 * Error codes. Functions returning these should return a jb_err
487 #define JB_ERR_OK 0 /* Success, no error */
488 #define JB_ERR_MEMORY 1 /* Out of memory */
489 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */
490 #define JB_ERR_FILE 3 /* Error opening, reading or writing a file */
491 #define JB_ERR_PARSE 4 /* Error parsing file */
492 #define JB_ERR_MODIFIED 5 /* File has been modified outside of the */
493 /* CGI actions editor. */
498 * This macro is used to free a pointer that may be NULL
500 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
503 /* Fix a problem with Solaris. There should be no effect on other
505 * Solaris's isspace() is a macro which uses it's argument directly
506 * as an array index. Therefore we need to make sure that high-bit
507 * characters generate +ve values, and ideally we also want to make
508 * the argument match the declared parameter type of "int".
510 * Note: Remember to #include <ctype.h> if you use these macros.
512 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
513 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
514 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
517 * Use for statically allocated buffers if you have no other choice.
518 * Remember to check the length of what you write into the buffer
519 * - we don't want any buffer overflows!
521 #define BUFFER_SIZE 5000
524 * Buffer size for capturing struct hostent data in the
525 * gethostby(name|addr)_r library calls. Since we don't
526 * loop over gethostbyname_r, the buffer must be sufficient
527 * to accomodate multiple IN A RRs, as used in DNS round robin
528 * load balancing. W3C's wwwlib uses 1K, so that should be
529 * good enough for us, too.
531 #define HOSTENT_BUFFER_SIZE 1024
534 * So you can say "while (FOREVER) { ...do something... }"
538 /* Default IP and port to listen on */
539 #define HADDR_DEFAULT "127.0.0.1"
540 #define HADDR_PORT 8118
542 /* Forward defs for various structures */
544 /* Need this for struct client_state */
545 struct configuration_spec;
548 /* Generic linked list of strings */
553 struct list_entry *next;
558 struct list_entry *first;
559 struct list_entry *last;
563 /* A map from a string to another string */
569 struct map_entry *next;
574 struct map_entry *first;
575 struct map_entry *last;
581 char *cmd; /* Whole command line: method, URL, Version */
582 char *ocmd; /* Backup of original cmd for CLF logging */
583 char *gpc; /* HTTP method: GET, POST, .. */
584 char *url; /* The URL */
585 char *ver; /* Protocol version */
586 int status; /* HTTP Status */
588 char *host; /* Host part of URL */
589 int port; /* Port of URL or 80 (default) */
590 char *path; /* Path of URL */
591 char *hostport; /* host[:port] */
592 int ssl; /* Flag if protocol is https */
594 char *host_ip_addr_str; /* String with dotted decimal representation
595 * of host's IP. NULL before connect_to() */
597 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
598 char **dvec; /* List of pointers to the strings in dbuffer. */
599 int dcount; /* How many parts to this domain? (length of dvec) */
603 * Response generated by CGI, blocker, or error handler
607 char *status; /* HTTP status (string) */
608 struct list headers[1]; /* List of header lines */
609 char *head; /* Formatted http response head */
610 size_t head_length; /* Length of http response head */
611 char *body; /* HTTP document body */
612 size_t content_length; /* Length of body, REQUIRED if binary body */
613 int is_static; /* Nonzero if the content will never change and
614 * should be cached by the brwoser (e.g. images) */
620 char *spec; /* The string which was parsed to produce this */
621 /* url_spec. Used for debugging or display only. */
623 /* Hostname matching, or dbuffer == NULL to match all hosts */
624 char *dbuffer; /* Buffer with '\0'-delimited domain name. */
625 char **dvec; /* List of pointers to the strings in dbuffer. */
626 int dcount; /* How many parts to this domain? (length of dvec) */
627 int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
630 int port; /* The port number, or 0 to match all ports. */
633 char *path; /* The path prefix (if not using regex), or source */
635 int pathlen; /* ==strlen(path). Needed for prefix matching. */
637 regex_t *preg; /* Regex for matching path part */
641 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
642 #else /* ifndef REGEX */
643 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0 }
644 #endif /* ndef REGEX */
646 /* Constants for host part matching in URLs */
647 #define ANCHOR_LEFT 1
648 #define ANCHOR_RIGHT 2
660 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
661 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
663 /* Bits for csp->content_type */
664 #define CT_TEXT 1 /* Suitable for pcrs filtering */
665 #define CT_GIF 2 /* Suitable for GIF filtering */
666 #define CT_TABOO 4 /* DONT filter */
668 #define ACTION_MASK_ALL (~0U)
670 #define ACTION_MOST_COMPATIBLE 0x00000000UL
672 #define ACTION_BLOCK 0x00000001UL
673 #define ACTION_DEANIMATE 0x00000002UL
674 #define ACTION_DOWNGRADE 0x00000004UL
675 #define ACTION_FAST_REDIRECTS 0x00000008UL
676 #define ACTION_HIDE_FORWARDED 0x00000010UL
677 #define ACTION_HIDE_FROM 0x00000020UL
678 #define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */
679 #define ACTION_HIDE_USER_AGENT 0x00000080UL
680 #define ACTION_IMAGE 0x00000100UL
681 #define ACTION_IMAGE_BLOCKER 0x00000200UL
682 #define ACTION_NO_COMPRESSION 0x00000400UL
683 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
684 #define ACTION_NO_COOKIE_READ 0x00001000UL
685 #define ACTION_NO_COOKIE_SET 0x00002000UL
686 #define ACTION_NO_POPUPS 0x00004000UL
687 #define ACTION_VANILLA_WAFER 0x00008000UL
688 #define ACTION_LIMIT_CONNECT 0x00010000UL
690 #define ACTION_STRING_DEANIMATE 0
691 #define ACTION_STRING_FROM 1
692 #define ACTION_STRING_IMAGE_BLOCKER 2
693 #define ACTION_STRING_REFERER 3
694 #define ACTION_STRING_USER_AGENT 4
695 #define ACTION_STRING_LIMIT_CONNECT 5
696 #define ACTION_STRING_COUNT 6
698 #define ACTION_MULTI_ADD_HEADER 0
699 #define ACTION_MULTI_WAFER 1
700 #define ACTION_MULTI_FILTER 2
701 #define ACTION_MULTI_COUNT 3
705 * This structure contains a list of actions to apply to a URL.
706 * It only contains positive instructions - no "-" options.
707 * It is not used to store the actions list itself, only for
708 * url_actions() to return the current values.
710 struct current_action_spec
712 unsigned long flags; /* a bit set to "1" = add action */
714 /* For those actions that require parameters: */
716 /* each entry is valid if & only if corresponding entry in "add" set. */
717 char * string[ACTION_STRING_COUNT];
720 struct list multi[ACTION_MULTI_COUNT][1];
725 * This structure contains a set of changes to actions.
726 * It can contain both positive and negative instructions.
727 * It is used to store an entry in the actions list.
731 unsigned long mask; /* a bit set to "0" = remove action */
732 unsigned long add; /* a bit set to "1" = add action */
734 /* For those actions that require parameters: */
736 /* each entry is valid if & only if corresponding entry in "add" set. */
737 char * string[ACTION_STRING_COUNT];
739 /* Strings to remove. */
740 struct list multi_remove[ACTION_MULTI_COUNT][1];
742 /* If nonzero, remove *all* strings. */
743 int multi_remove_all[ACTION_MULTI_COUNT];
746 struct list multi_add[ACTION_MULTI_COUNT][1];
750 * This structure is used to store the actions list.
752 * It contains a URL pattern, and the chages to the actions.
753 * It is a linked list.
757 struct url_spec url[1];
759 struct action_spec action[1];
761 struct url_actions * next;
766 * Flags for use in csp->flags
768 #define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data.
769 * Cleared when the thread associated with
770 * this structure dies. */
771 #define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked"
772 * transfer encoding */
773 #define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although
774 * it would normally have been blocked. */
775 #define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */
776 #define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */
777 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
780 * The state of a Privoxy processing thread.
784 /* The proxy's configuration */
785 struct configuration_spec * config;
787 /* The actions to perform on the current request */
788 struct current_action_spec action[1];
790 /* socket to talk to client (web browser) */
793 /* socket to talk to server (web server or proxy) */
796 /* Multi-purpose flag container, see CSP_FLAG_* above */
797 unsigned short int flags;
800 * Client PC's IP address, as reported by the accept()_ function.
801 * Both as string and number
807 /* Our IP address and hostname, i.e. the IP address that
808 the client used to reach us, and the associated hostname,
811 char *my_ip_addr_str;
814 /* The URL that was requested */
815 struct http_request http[1];
817 /* An I/O buffer used for buffering data read from the client */
820 /* List of all headers for this request */
821 struct list headers[1];
823 /* List of all cookies for this request */
824 struct list cookie_list[1];
826 /* MIME-Type key, see CT_* above */
827 unsigned short int content_type;
829 /* The "X-Forwarded-For:" header sent by the client */
832 /* files associated with this client */
833 struct file_list *actions_list;
835 struct file_list *rlist; /* pcrs job file */
836 size_t content_length; /* Length after content modification */
839 struct file_list *tlist; /* trustfile */
840 #endif /* def FEATURE_TRUST */
842 struct client_state *next;
847 * A function to add a header
849 typedef jb_err (*add_header_func_ptr)(struct client_state *);
852 * A function to process a header
854 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
857 * List of functions to run on a list of headers
863 parser_func_ptr parser;
868 * List of available CGI functions.
870 struct cgi_dispatcher
872 const char * const name;
873 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
874 const char * const description;
879 * A data file used by Privoxy. Kept in a linked list.
884 * this is a pointer to the data structures associated with the file.
885 * Read-only once the structure has been created.
889 /* Normally NULL. When we are finished with file (i.e. when we have
890 * loaded a new one), set to a pointer to an unloader function.
891 * Unloader will be called by sweep() (called from main loop) when
892 * all clients using this file are done. This prevents threading
895 void (*unloader)(void *);
897 /* Used internally by sweep(). Do not access from elsewhere. */
900 /* Following variables allow us to check if file has been changed.
901 * Read-only once the structure has been created.
906 /* Pointer to next entry in the linked list of all "file_list"s.
907 * This linked list is so that sweep() can navigate it.
908 * Since sweep() can remove items from the list, we must be careful
909 * to only access this value from main thread (when we know sweep
912 struct file_list *next;
919 struct url_spec url[1];
921 struct block_spec *next;
923 #endif /* def FEATURE_TRUST */
926 #define SOCKS_NONE 0 /* Don't use a SOCKS server */
927 #define SOCKS_4 40 /* original SOCKS 4 protocol */
928 #define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
932 struct url_spec url[1];
934 /* Connection type - must be a SOCKS_xxx constant */
941 /* Parent HTTP proxy */
945 /* For the linked list */
946 struct forward_spec *next;
948 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
952 * This struct represents one filter (one block) from
953 * the re_filterfile. If there is more than one filter
954 * in the file, the file will be represented by a
955 * chained list of re_filterfile specs.
957 struct re_filterfile_spec
959 char *name; /* Name from FILTER: statement in re_filterfile */
960 char *description; /* Description from FILTER: statement in re_filterfile */
961 struct list patterns[1]; /* The patterns from the re_filterfile */
962 pcrs_job *joblist; /* The resulting compiled pcrs_jobs */
963 struct re_filterfile_spec *next; /* The pointer for chaining */
967 #define ACL_PERMIT 1 /* accept connection request */
968 #define ACL_DENY 2 /* reject connection request */
970 struct access_control_addr
977 struct access_control_list
979 struct access_control_addr src[1];
980 struct access_control_addr dst[1];
983 struct access_control_list *next;
985 #endif /* def FEATURE_ACL */
988 /* Maximum number of loaders (actions, re_filter, ...) */
992 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
993 #define RUNTIME_FEATURE_CGI_TOGGLE 2
997 * Data loaded from the configuration file.
999 * (Anomaly: toggle is still handled through a global, not this structure)
1001 struct configuration_spec
1006 /* Features that can be enabled/disabled throuigh the config file */
1007 unsigned feature_flags;
1009 const char *logfile;
1011 const char *confdir;
1013 const char *actions_file;
1015 /* The administrator's email address */
1016 char *admin_address;
1018 /* A URL with info on this proxy */
1019 char *proxy_info_url;
1021 const char *re_filterfile;
1023 #ifdef FEATURE_COOKIE_JAR
1024 const char * jarfile;
1026 #endif /* def FEATURE_COOKIE_JAR */
1029 * Port and IP to bind to.
1030 * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1035 /* Size limit for IOB */
1036 size_t buffer_limit;
1038 #ifdef FEATURE_TRUST
1039 const char * trustfile;
1041 struct list trust_info[1];
1042 struct url_spec *trust_list[64];
1043 #endif /* def FEATURE_TRUST */
1046 struct access_control_list *acl;
1047 #endif /* def FEATURE_ACL */
1049 struct forward_spec *forward;
1051 /* All options from the config file, HTML-formatted */
1054 /* the configuration file object. */
1055 struct file_list *config_file_list;
1057 /* List of loaders */
1058 int (*loaders[NLOADERS])(struct client_state *);
1060 /* bool, nonzero if we need to bind() to the new port */
1065 #define SZ(X) (sizeof(X) / sizeof(*X))
1067 #ifdef FEATURE_FORCE_LOAD
1068 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1069 #endif /* def FEATURE_FORCE_LOAD */
1071 #ifdef FEATURE_NO_GIFS
1072 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1074 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1075 #endif /* def FEATURE_NO_GIFS */
1078 /* Hardwired URLs */
1079 #define HOME_PAGE_URL "http://www.privoxy.org"
1080 #define REDIRECT_URL HOME_PAGE_URL "/redirect.php?v=" VERSION "&to="
1083 * The "hosts" to intercept and display CGI pages.
1084 * First one is a hostname only, second one can specify host and path.
1087 * 1) Do not specify the http: prefix
1088 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1089 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1091 #define CGI_SITE_1_HOST "p.p"
1092 #define CGI_SITE_2_HOST "config.privoxy.org"
1093 #define CGI_SITE_2_PATH ""
1096 * The prefix for CGI pages. Written out in generated HTML.
1097 * INCLUDES the trailing slash.
1099 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1102 /* HTTP snipplets */
1103 static const char CSUCCEED[] =
1104 "HTTP/1.0 200 Connection established\n"
1105 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1107 static const char CHEADER[] =
1108 "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1110 static const char CFORBIDDEN[] =
1111 "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";
1117 #endif /* ndef PROJECT_H_INCLUDED */