X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=project.h;h=811cf22a42b8b076bae639d32f28fb5756663d6f;hp=35e227421d4445abca2a81541ae97be72fdd50de;hb=3947ebff095737086603dadbf9f8443e3accf0e1;hpb=81d7f24ad32b07609902d0fbdf475ad5088ea7a5 diff --git a/project.h b/project.h index 35e22742..d524be0c 100644 --- a/project.h +++ b/project.h @@ -1,6 +1,7 @@ -#ifndef _PROJECT_H -#define _PROJECT_H -#define PROJECT_H_VERSION "$Id: project.h,v 1.17 2001/06/07 23:15:09 jongfoster Exp $" +#ifndef PROJECT_H_INCLUDED +#define PROJECT_H_INCLUDED +/** Version string. */ +#define PROJECT_H_VERSION "$Id: project.h,v 1.167 2011/07/03 17:55:23 fabiankeil Exp $" /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/project.h,v $ @@ -9,14 +10,14 @@ * project. Does not define any variables or functions * (though it does declare some macros). * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * IJBSWA team. http://ijbswa.sourceforge.net + * Copyright : Written by and Copyright (C) 2001-2010 the + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written - * by and Copyright (C) 1997 Anonymous Coders and + * by and Copyright (C) 1997 Anonymous Coders and * Junkbusters Corporation. http://www.junkbusters.com * - * This program is free software; you can redistribute it + * This program is free software; you can redistribute it * and/or modify it under the terms of the GNU General * Public License as published by the Free Software * Foundation; either version 2 of the License, or (at @@ -34,382 +35,543 @@ * or write to the Free Software Foundation, Inc., 59 * Temple Place - Suite 330, Boston, MA 02111-1307, USA. * - * Revisions : - * $Log: project.h,v $ - * Revision 1.17 2001/06/07 23:15:09 jongfoster - * Merging ACL and forward files into config file. - * Moving struct gateway members into struct forward_spec - * Removing config->proxy_args_gateways - * Cosmetic: Adding a few comments - * - * Revision 1.16 2001/06/04 18:31:58 swa - * files are now prefixed with either `confdir' or `logdir'. - * `make redhat-dist' replaces both entries confdir and logdir - * with redhat values - * - * Revision 1.15 2001/06/04 11:28:53 swa - * redirect did not work due to missing / - * - * Revision 1.14 2001/06/03 11:03:48 oes - * Makefile/in - * - * introduced cgi.c - * - * actions.c: - * - * adapted to new enlist_unique arg format - * - * conf loadcfg.c - * - * introduced confdir option - * - * filters.c filtrers.h - * - * extracted-CGI relevant stuff - * - * jbsockets.c - * - * filled comment - * - * jcc.c - * - * support for new cgi mechansim - * - * list.c list.h - * - * functions for new list type: "map" - * extended enlist_unique - * - * miscutil.c .h - * introduced bindup() - * - * parsers.c parsers.h - * - * deleted const struct interceptors - * - * pcrs.c - * added FIXME - * - * project.h - * - * added struct map - * added struct http_response - * changes struct interceptors to struct cgi_dispatcher - * moved HTML stuff to cgi.h - * - * re_filterfile: - * - * changed - * - * showargs.c - * NO TIME LEFT - * - * Revision 1.13 2001/06/01 20:05:36 jongfoster - * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER - * constant, and removed csp->tinygif. - * - * Revision 1.12 2001/06/01 18:49:17 jongfoster - * Replaced "list_share" with "list" - the tiny memory gain was not - * worth the extra complexity. - * - * Revision 1.11 2001/06/01 10:32:47 oes - * Added constants for anchoring selection bitmap - * - * Revision 1.10 2001/05/31 21:33:53 jongfoster - * Changes for new actions file, replacing permissionsfile - * and parts of the config file. Also added support for - * list_shared. - * - * Revision 1.9 2001/05/31 17:32:31 oes - * - * - Enhanced domain part globbing with infix and prefix asterisk - * matching and optional unanchored operation - * - * Revision 1.8 2001/05/29 20:09:15 joergs - * HTTP_REDIRECT_TEMPLATE fixed. - * - * Revision 1.7 2001/05/29 09:50:24 jongfoster - * Unified blocklist/imagelist/actionslist. - * File format is still under discussion, but the internal changes - * are (mostly) done. - * - * Also modified interceptor behaviour: - * - We now intercept all URLs beginning with one of the following - * prefixes (and *only* these prefixes): - * * http://i.j.b/ - * * http://ijbswa.sf.net/config/ - * * http://ijbswa.sourceforge.net/config/ - * - New interceptors "home page" - go to http://i.j.b/ to see it. - * - Internal changes so that intercepted and fast redirect pages - * are not replaced with an image. - * - Interceptors now have the option to send a binary page direct - * to the client. (i.e. ijb-send-banner uses this) - * - Implemented show-url-info interceptor. (Which is why I needed - * the above interceptors changes - a typical URL is - * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif". - * The previous mechanism would not have intercepted that, and - * if it had been intercepted then it then it would have replaced - * it with an image.) - * - * Revision 1.6 2001/05/27 22:17:04 oes - * - * - re_process_buffer no longer writes the modified buffer - * to the client, which was very ugly. It now returns the - * buffer, which it is then written by chat. - * - * - content_length now adjusts the Content-Length: header - * for modified documents rather than crunch()ing it. - * (Length info in csp->content_length, which is 0 for - * unmodified documents) - * - * - For this to work, sed() is called twice when filtering. - * - * Revision 1.5 2001/05/26 00:28:36 jongfoster - * Automatic reloading of config file. - * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32). - * Most of the global variables have been moved to a new - * struct configuration_spec, accessed through csp->config->globalname - * Most of the globals remaining are used by the Win32 GUI. - * - * Revision 1.4 2001/05/22 18:46:04 oes - * - * - Enabled filtering banners by size rather than URL - * by adding patterns that replace all standard banner - * sizes with the "Junkbuster" gif to the re_filterfile - * - * - Enabled filtering WebBugs by providing a pattern - * which kills all 1x1 images - * - * - Added support for PCRE_UNGREEDY behaviour to pcrs, - * which is selected by the (nonstandard and therefore - * capital) letter 'U' in the option string. - * It causes the quantifiers to be ungreedy by default. - * Appending a ? turns back to greedy (!). - * - * - Added a new interceptor ijb-send-banner, which - * sends back the "Junkbuster" gif. Without imagelist or - * MSIE detection support, or if tinygif = 1, or the - * URL isn't recognized as an imageurl, a lame HTML - * explanation is sent instead. - * - * - Added new feature, which permits blocking remote - * script redirects and firing back a local redirect - * to the browser. - * The feature is conditionally compiled, i.e. it - * can be disabled with --disable-fast-redirects, - * plus it must be activated by a "fast-redirects" - * line in the config file, has its own log level - * and of course wants to be displayed by show-proxy-args - * Note: Boy, all the #ifdefs in 1001 locations and - * all the fumbling with configure.in and acconfig.h - * were *way* more work than the feature itself :-( - * - * - Because a generic redirect template was needed for - * this, tinygif = 3 now uses the same. - * - * - Moved GIFs, and other static HTTP response templates - * to project.h - * - * - Some minor fixes - * - * - Removed some >400 CRs again (Jon, you really worked - * a lot! ;-) - * - * Revision 1.3 2001/05/20 01:21:20 jongfoster - * Version 2.9.4 checkin. - * - Merged popupfile and cookiefile, and added control over PCRS - * filtering, in new "actionsfile". - * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration - * file error you now get a message box (in the Win32 GUI) rather - * than the program exiting with no explanation. - * - Made killpopup use the PCRS MIME-type checking and HTTP-header - * skipping. - * - Removed tabs from "config" - * - Moved duplicated url parsing code in "loaders.c" to a new funcition. - * - Bumped up version number. - * - * Revision 1.2 2001/05/17 23:01:01 oes - * - Cleaned CRLF's from the sources and related files - * - * Revision 1.1.1.1 2001/05/15 13:59:03 oes - * Initial import of version 2.9.3 source tree - * - * *********************************************************************/ - + /* Declare struct FILE for vars and funcs. */ #include /* Need time_t for file_list */ #include +/* Needed for pcre choice */ +#include "config.h" + +/* Need for struct sockaddr_storage */ +#ifdef HAVE_RFC2553 +# ifndef _WIN32 +# include +# include +# else +# include +# include +# include + typedef unsigned short in_port_t; +# endif +#endif + /* * Include appropriate regular expression libraries. - * - * PCRS ==> Include pcre - * REGEX && PCRE ==> Include pcre and pcreposix - * REGEX && !PCRE ==> Include gnu_regex - * - * STATIC ==> Use #include "pcre.h" (compiling at same time) - * !STATIC ==> Use #include (System library) - * + * Note that pcrs and pcre (native) are needed for cgi + * and are included anyway. */ -#if (defined(REGEX) && defined(PCRE)) || defined(PCRS) -# ifdef STATIC -# include "pcre.h" + +#ifdef STATIC_PCRE +# include "pcre.h" +#else +# ifdef PCRE_H_IN_SUBDIR +# include # else # include # endif -#endif /* (defined(REGEX) && defined(PCRE)) || defined(PCRS) */ +#endif -#if defined(REGEX) && defined(PCRE) -# ifdef STATIC -# include "pcreposix.h" +#ifdef STATIC_PCRS +# include "pcrs.h" +#else +# include +#endif + +#ifdef STATIC_PCRE +# include "pcreposix.h" +#else +# ifdef PCRE_H_IN_SUBDIR +# include # else # include # endif -#endif /* defined(REGEX) && defined(PCRE) */ - -#if defined(REGEX) && !defined(PCRE) -# include "gnu_regex.h" #endif -#ifdef PCRS -#include "pcrs.h" -#endif /* def PCRS */ - -#ifdef AMIGA -#include "amiga.h" +#ifdef AMIGA +#include "amiga.h" #endif /* def AMIGA */ +#ifdef _WIN32 +/* + * I don't want to have to #include all this just for the declaration + * of SOCKET. However, it looks like we have to... + */ +#ifndef STRICT +#define STRICT +#endif +#include +#endif + + #ifdef __cplusplus extern "C" { #endif - -#define BUFFER_SIZE 5000 +#ifdef _WIN32 + +typedef SOCKET jb_socket; + +#define JB_INVALID_SOCKET INVALID_SOCKET + +#else /* ndef _WIN32 */ + +/** + * The type used by sockets. On UNIX it's an int. Microsoft decided to + * make it an unsigned. + */ +typedef int jb_socket; + +/** + * The error value used for variables of type jb_socket. On UNIX this + * is -1, however Microsoft decided to make socket handles unsigned, so + * they use a different value. + */ + +#define JB_INVALID_SOCKET (-1) + +#endif /* ndef _WIN32 */ + + +/** + * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx + * series of errors. + */ +typedef int jb_err; + +#define JB_ERR_OK 0 /**< Success, no error */ +#define JB_ERR_MEMORY 1 /**< Out of memory */ +#define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */ +#define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */ +#define JB_ERR_PARSE 4 /**< Error parsing file */ +#define JB_ERR_MODIFIED 5 /**< File has been modified outside of the + CGI actions editor. */ +#define JB_ERR_COMPRESS 6 /**< Error on decompression */ + +/** + * This macro is used to free a pointer that may be NULL. + * It also sets the variable to NULL after it's been freed. + * The paramater should be a simple variable without side effects. + */ +#define freez(X) { if(X) { free((void*)X); X = NULL ; } } + + +/** + * Fix a problem with Solaris. There should be no effect on other + * platforms. + * + * Solaris's isspace() is a macro which uses it's argument directly + * as an array index. Therefore we need to make sure that high-bit + * characters generate +ve values, and ideally we also want to make + * the argument match the declared parameter type of "int". + * + * Note: Remember to #include if you use these macros. + */ +#define ijb_toupper(__X) toupper((int)(unsigned char)(__X)) +#define ijb_tolower(__X) tolower((int)(unsigned char)(__X)) +#define ijb_isspace(__X) isspace((int)(unsigned char)(__X)) + +/** + * Use for statically allocated buffers if you have no other choice. + * Remember to check the length of what you write into the buffer + * - we don't want any buffer overflows! + */ +#define BUFFER_SIZE 5000 + +/** + * Max length of CGI parameters (arbitrary limit). + */ +#define CGI_PARAM_LEN_MAX 500U + +/** + * Buffer size for capturing struct hostent data in the + * gethostby(name|addr)_r library calls. Since we don't + * loop over gethostbyname_r, the buffer must be sufficient + * to accommodate multiple IN A RRs, as used in DNS round robin + * load balancing. W3C's wwwlib uses 1K, so that should be + * good enough for us, too. + */ +/** + * XXX: Temporary doubled, for some configurations + * 1K is still too small and we didn't get the + * real fix ready for inclusion. + */ +#define HOSTENT_BUFFER_SIZE 2048 + +/** + * Do not use. Originally this was so that you can + * say "while (FOREVER) { ...do something... }". + * However, this gives a warning with some compilers (e.g. VC++). + * Instead, use "for (;;) { ...do something... }". + */ #define FOREVER 1 -/* Default IP and port to listen on */ -#define HADDR_DEFAULT "127.0.0.1" -#define HADDR_PORT 8000 +/** + * Default TCP/IP address to listen on, as a string. + * Set to "127.0.0.1:8118". + */ +#define HADDR_DEFAULT "127.0.0.1:8118" -/* Need this for struct client_state */ +/* Forward def for struct client_state */ struct configuration_spec; -/* Generic linked list of strings */ -struct list /* FIXME: Why not separate entries and header? */ + +/** + * Entry in a linked list of strings. + */ +struct list_entry { - char * str; /* valid in an entry */ - struct list *last; /* valid in header */ - struct list *next; + /** + * The string pointer. It must point to a dynamically malloc()ed + * string or be NULL for the list functions to work. In the latter + * case, just be careful next time you iterate through the list in + * your own code. + */ + char *str; + + /** Next entry in the linked list, or NULL if no more. */ + struct list_entry *next; +}; + +/** + * A header for a linked list of strings. + */ +struct list +{ + /** First entry in the list, or NULL if the list is empty. */ + struct list_entry *first; + + /** Last entry in the list, or NULL if the list is empty. */ + struct list_entry *last; +}; + + +/** + * An entry in a map. This is a name=value pair. + */ +struct map_entry +{ + /** The key for the map. */ + const char *name; + /** The value associated with that key. */ + const char *value; + /** The next map entry, or NULL if none. */ + struct map_entry *next; }; +/** + * A map from a string to another string. + * This is used for the paramaters passed in a HTTP GET request, and + * to store the exports when the CGI interface is filling in a template. + */ struct map { - char *name; - char *value; - struct map *next; + /** The first map entry, or NULL if the map is empty. */ + struct map_entry *first; + /** The last map entry, or NULL if the map is empty. */ + struct map_entry *last; }; + +/** + * A HTTP request. This includes the method (GET, POST) and + * the parsed URL. + * + * This is also used whenever we want to match a URL against a + * URL pattern. This always contains the URL to match, and never + * a URL pattern. (See struct url_spec). + */ struct http_request { - char *cmd; - char *gpc; - char *host; - int port; - char *path; - char *ver; - char *hostport; /* "host[:port]" */ - int ssl; + char *cmd; /**< Whole command line: method, URL, Version */ + char *ocmd; /**< Backup of original cmd for CLF logging */ + char *gpc; /**< HTTP method: GET, POST, ... */ + char *url; /**< The URL */ + char *ver; /**< Protocol version */ + int status; /**< HTTP Status */ + + char *host; /**< Host part of URL */ + int port; /**< Port of URL or 80 (default) */ + char *path; /**< Path of URL */ + char *hostport; /**< host[:port] */ + int ssl; /**< Flag if protocol is https */ + + char *host_ip_addr_str; /**< String with dotted decimal representation + of host's IP. NULL before connect_to() */ + +#ifndef FEATURE_EXTENDED_HOST_PATTERNS + char *dbuffer; /**< Buffer with '\0'-delimited domain name. */ + char **dvec; /**< List of pointers to the strings in dbuffer. */ + int dcount; /**< How many parts to this domain? (length of dvec) */ +#endif /* ndef FEATURE_EXTENDED_HOST_PATTERNS */ +}; + +/** + * Reasons for generating a http_response instead of delivering + * the requested resource. Mostly ordered the way they are checked + * for in chat(). + */ +enum crunch_reason +{ + UNSUPPORTED, + BLOCKED, + UNTRUSTED, + REDIRECTED, + CGI_CALL, + NO_SUCH_DOMAIN, + FORWARDING_FAILED, + CONNECT_FAILED, + OUT_OF_MEMORY, + INTERNAL_ERROR, + CONNECTION_TIMEOUT, + NO_SERVER_DATA }; -/* CGI or blocker generated response */ +/** + * Response generated by CGI, blocker, or error handler + */ struct http_response { - char *status; /* HTTP status */ - struct list headers[1]; /* List of header lines */ - int content_length; /* Length of body, REQUIRED if binary body*/ - char *head; /* Formatted http response head */ - char *body; /* HTTP document body */ + enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */ + char *status; /**< HTTP status (string). */ + struct list headers[1]; /**< List of header lines. */ + char *head; /**< Formatted http response head. */ + size_t head_length; /**< Length of http response head. */ + char *body; /**< HTTP document body. */ + size_t content_length; /**< Length of body, REQUIRED if binary body. */ + int is_static; /**< Nonzero if the content will never change and + should be cached by the browser (e.g. images). */ }; -/* A URL pattern */ +/** + * A URL or a tag pattern. + */ struct url_spec { - char *spec; /* The string which was parsed to produce this */ - /* url_spec. Used for debugging or display only. */ - - /* Hostname matching: */ - char *domain; /* Fully qalified domain name (FQDN) pattern. */ - /* May contain "*". */ - char *dbuf; /* FIXME: Comment this */ - char **dvec; /* Domain ptr vector */ - int dcnt; /* How many domains in fqdn? */ - int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT */ - - /* Port matching: */ - int port; /* The port number, or 0 to match all ports. */ - - /* Path matching: */ - char *path; /* The path prefix (if not using regex), or source */ - /* for the regex. */ - int pathlen; /* ==strlen(path). Needed for prefix matching. */ -#ifdef REGEX - regex_t *preg; /* Regex for matching path part */ -#endif + /** The string which was parsed to produce this url_spec. + Used for debugging or display only. */ + char *spec; + +#ifdef FEATURE_EXTENDED_HOST_PATTERNS + regex_t *host_regex;/**< Regex for host matching */ +#else + char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */ + char **dvec; /**< List of pointers to the strings in dbuffer. */ + int dcount; /**< How many parts to this domain? (length of dvec) */ + int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */ +#endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */ + + char *port_list; /**< List of acceptable ports, or NULL to match all ports */ + + regex_t *preg; /**< Regex for matching path part */ + regex_t *tag_regex; /**< Regex for matching tags */ }; +/** + * If you declare a static url_spec, this is the value to initialize it to zero. + */ +#ifndef FEATURE_EXTENDED_HOST_PATTERNS +#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL } +#else +#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL } +#endif /* def FEATURE_EXTENDED_HOST_PATTERNS */ + +/** + * Constant for host part matching in URLs. If set, indicates that the start of + * the pattern must match the start of the URL. E.g. this is not set for the + * pattern ".example.com", so that it will match both "example.com" and + * "www.example.com". It is set for the pattern "example.com", which makes it + * match "example.com" only, not "www.example.com". + */ #define ANCHOR_LEFT 1 -#define ANCHOR_RIGHT 2 +/** + * Constant for host part matching in URLs. If set, indicates that the end of + * the pattern must match the end of the URL. E.g. this is not set for the + * pattern "ad.", so that it will match any host called "ad", irrespective + * of how many subdomains are in the fully-qualified domain name. + */ +#define ANCHOR_RIGHT 2 -/* An I/O buffer */ +/** + * An I/O buffer. Holds a string which can be appended to, and can have data + * removed from the beginning. + */ struct iob { - char *buf; - char *cur; - char *eod; + char *buf; /**< Start of buffer */ + char *cur; /**< Start of relevant data */ + char *eod; /**< End of relevant data */ + size_t size; /**< Size as malloc()ed */ }; +/** + * Return the number of bytes in the I/O buffer associated with the passed + * client_state pointer. + * May be zero. + */ #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0) -#define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob)); - -#define ACTION_MASK_ALL (~0U) +/** + * Remove any data in the I/O buffer associated with the passed + * client_state pointer. + */ +#define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob)); -#define ACTION_MOST_COMPATIBLE 0x0000U +/* Bits for csp->content_type bitmask: */ +#define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */ +#define CT_GIF 0x0002U /**< Suitable for GIF filtering. */ +#define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */ -#define ACTION_BLOCK 0x0001U -#define ACTION_FAST_REDIRECTS 0x0002U -#define ACTION_FILTER 0x0004U -#define ACTION_HIDE_FORWARDED 0x0008U -#define ACTION_HIDE_FROM 0x0010U -#define ACTION_HIDE_REFERER 0x0020U /* sic - follow HTTP, not English */ -#define ACTION_HIDE_USER_AGENT 0x0040U -#define ACTION_IMAGE 0x0080U -#define ACTION_IMAGE_BLOCKER 0x0100U -#define ACTION_NO_COOKIE_READ 0x0200U -#define ACTION_NO_COOKIE_SET 0x0400U -#define ACTION_NO_POPUPS 0x0800U -#define ACTION_VANILLA_WAFER 0x1000U +/* Although these are not, strictly speaking, content types + * (they are content encodings), it is simple to handle them + * as such. + */ +#define CT_GZIP 0x0010U /**< gzip-compressed data. */ +#define CT_DEFLATE 0x0020U /**< zlib-compressed data. */ -#define ACTION_STRING_FROM 0 -#define ACTION_STRING_IMAGE_BLOCKER 1 -#define ACTION_STRING_REFERER 2 -#define ACTION_STRING_USER_AGENT 3 -#define ACTION_STRING_COUNT 4 +/** + * Flag to signal that the server declared the content type, + * so we can differentiate between unknown and undeclared + * content types. + */ +#define CT_DECLARED 0x0040U -#define ACTION_MULTI_ADD_HEADER 0 -#define ACTION_MULTI_WAFER 1 -#define ACTION_MULTI_COUNT 2 +/** + * The mask which includes all actions. + */ +#define ACTION_MASK_ALL (~0UL) -/* +/** + * The most compatible set of actions - i.e. none. + */ +#define ACTION_MOST_COMPATIBLE 0x00000000UL + +/** Action bitmap: Block the request. */ +#define ACTION_BLOCK 0x00000001UL +/** Action bitmap: Deanimate if it's a GIF. */ +#define ACTION_DEANIMATE 0x00000002UL +/** Action bitmap: Downgrade HTTP/1.1 to 1.0. */ +#define ACTION_DOWNGRADE 0x00000004UL +/** Action bitmap: Fast redirects. */ +#define ACTION_FAST_REDIRECTS 0x00000008UL +/** Action bitmap: Remove or add "X-Forwarded-For" header. */ +#define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL +/** Action bitmap: Hide "From" header. */ +#define ACTION_HIDE_FROM 0x00000020UL +/** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */ +#define ACTION_HIDE_REFERER 0x00000040UL +/** Action bitmap: Hide "User-Agent" and similar headers. */ +#define ACTION_HIDE_USER_AGENT 0x00000080UL +/** Action bitmap: This is an image. */ +#define ACTION_IMAGE 0x00000100UL +/** Action bitmap: Sets the image blocker. */ +#define ACTION_IMAGE_BLOCKER 0x00000200UL +/** Action bitmap: Prevent compression. */ +#define ACTION_NO_COMPRESSION 0x00000400UL +/** Action bitmap: Change cookies to session only cookies. */ +#define ACTION_NO_COOKIE_KEEP 0x00000800UL +/** Action bitmap: Block rending cookies. */ +#define ACTION_NO_COOKIE_READ 0x00001000UL +/** Action bitmap: Block setting cookies. */ +#define ACTION_NO_COOKIE_SET 0x00002000UL +/** Action bitmap: Override the forward settings in the config file */ +#define ACTION_FORWARD_OVERRIDE 0x00004000UL +/** Action bitmap: Block as empty document */ +#define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL +/** Action bitmap: Limit CONNECT requests to safe ports. */ +#define ACTION_LIMIT_CONNECT 0x00010000UL +/** Action bitmap: Redirect request. */ +#define ACTION_REDIRECT 0x00020000UL +/** Action bitmap: Crunch or modify "if-modified-since" header. */ +#define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL +/** Action bitmap: Overwrite Content-Type header. */ +#define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL +/** Action bitmap: Crunch specified server header. */ +#define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL +/** Action bitmap: Crunch specified client header */ +#define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL +/** Action bitmap: Enable text mode by force */ +#define ACTION_FORCE_TEXT_MODE 0x00400000UL +/** Action bitmap: Enable text mode by force */ +#define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL +/** Action bitmap: Enable content-disposition crunching */ +#define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL +/** Action bitmap: Replace or block Last-Modified header */ +#define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL +/** Action bitmap: Replace or block Accept-Language header */ +#define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL + + +/** Action string index: How to deanimate GIFs */ +#define ACTION_STRING_DEANIMATE 0 +/** Action string index: Replacement for "From:" header */ +#define ACTION_STRING_FROM 1 +/** Action string index: How to block images */ +#define ACTION_STRING_IMAGE_BLOCKER 2 +/** Action string index: Replacement for "Referer:" header */ +#define ACTION_STRING_REFERER 3 +/** Action string index: Replacement for "User-Agent:" header */ +#define ACTION_STRING_USER_AGENT 4 +/** Action string index: Legal CONNECT ports. */ +#define ACTION_STRING_LIMIT_CONNECT 5 +/** Action string index: Server headers containing this pattern are crunched*/ +#define ACTION_STRING_SERVER_HEADER 6 +/** Action string index: Client headers containing this pattern are crunched*/ +#define ACTION_STRING_CLIENT_HEADER 7 +/** Action string index: Replacement for the "Accept-Language:" header*/ +#define ACTION_STRING_LANGUAGE 8 +/** Action string index: Replacement for the "Content-Type:" header*/ +#define ACTION_STRING_CONTENT_TYPE 9 +/** Action string index: Replacement for the "content-disposition:" header*/ +#define ACTION_STRING_CONTENT_DISPOSITION 10 +/** Action string index: Replacement for the "If-Modified-Since:" header*/ +#define ACTION_STRING_IF_MODIFIED_SINCE 11 +/** Action string index: Replacement for the "Last-Modified:" header. */ +#define ACTION_STRING_LAST_MODIFIED 12 +/** Action string index: Redirect URL */ +#define ACTION_STRING_REDIRECT 13 +/** Action string index: Decode before redirect? */ +#define ACTION_STRING_FAST_REDIRECTS 14 +/** Action string index: Overriding forward rule. */ +#define ACTION_STRING_FORWARD_OVERRIDE 15 +/** Action string index: Reason for the block. */ +#define ACTION_STRING_BLOCK 16 +/** Action string index: what to do with the "X-Forwarded-For" header. */ +#define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17 +/** Number of string actions. */ +#define ACTION_STRING_COUNT 18 + + +/* To make the ugly hack in sed easier to understand */ +#define CHECK_EVERY_HEADER_REMAINING 0 + + +/** Index into current_action_spec::multi[] for headers to add. */ +#define ACTION_MULTI_ADD_HEADER 0 +/** Index into current_action_spec::multi[] for content filters to apply. */ +#define ACTION_MULTI_FILTER 1 +/** Index into current_action_spec::multi[] for server-header filters to apply. */ +#define ACTION_MULTI_SERVER_HEADER_FILTER 2 +/** Index into current_action_spec::multi[] for client-header filters to apply. */ +#define ACTION_MULTI_CLIENT_HEADER_FILTER 3 +/** Index into current_action_spec::multi[] for client-header tags to apply. */ +#define ACTION_MULTI_CLIENT_HEADER_TAGGER 4 +/** Index into current_action_spec::multi[] for server-header tags to apply. */ +#define ACTION_MULTI_SERVER_HEADER_TAGGER 5 +/** Number of multi-string actions. */ +#define ACTION_MULTI_COUNT 6 + + +/** * This structure contains a list of actions to apply to a URL. * It only contains positive instructions - no "-" options. * It is not used to store the actions list itself, only for @@ -417,223 +579,441 @@ struct iob */ struct current_action_spec { - unsigned flags; /* a bit set to "1" = add action */ + /** Actions to apply. A bit set to "1" means perform the action. */ + unsigned long flags; - /* For those actions that require parameters: */ - - /* each entry is valid if & only if corresponding entry in "add" set. */ + /** + * Paramaters for those actions that require them. + * Each entry is valid if & only if the corresponding entry in "flags" is + * set. + */ char * string[ACTION_STRING_COUNT]; - /* Strings to add */ + /** Lists of strings for multi-string actions. */ struct list multi[ACTION_MULTI_COUNT][1]; }; -/* +/** * This structure contains a set of changes to actions. * It can contain both positive and negative instructions. * It is used to store an entry in the actions list. */ struct action_spec { - unsigned mask; /* a bit set to "0" = remove action */ - unsigned add; /* a bit set to "1" = add action */ + unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */ + unsigned long add; /**< Actions to add. A bit set to "1" means add action. */ - /* For those actions that require parameters: */ - - /* each entry is valid if & only if corresponding entry in "add" set. */ + /** + * Paramaters for those actions that require them. + * Each entry is valid if & only if the corresponding entry in "flags" is + * set. + */ char * string[ACTION_STRING_COUNT]; - /* Strings to remove. */ + /** Lists of strings to remove, for multi-string actions. */ struct list multi_remove[ACTION_MULTI_COUNT][1]; - /* If nonzero, remove *all* strings. */ + /** If nonzero, remove *all* strings from the multi-string action. */ int multi_remove_all[ACTION_MULTI_COUNT]; - /* Strings to add */ + /** Lists of strings to add, for multi-string actions. */ struct list multi_add[ACTION_MULTI_COUNT][1]; }; -/* - * This structure is used to store the actions list. + +/** + * This structure is used to store action files. * - * It contains a URL pattern, and the chages to the actions. - * It is a linked list. + * It contains an URL or tag pattern, and the changes to + * the actions. It's a linked list and should only be + * free'd through unload_actions_file() unless there's + * only a single entry. */ struct url_actions { - struct url_spec url[1]; + struct url_spec url[1]; /**< The URL or tag pattern. */ - struct action_spec action[1]; + struct action_spec *action; /**< Action settings that might be shared with + the list entry before or after the current + one and can't be free'd willy nilly. */ - struct url_actions * next; + struct url_actions *next; /**< Next action section in file, or NULL. */ }; -/* Constants defining bitmask for csp->accept_types */ +/* + * Structure to hold the server socket and the information + * required to make sure we only reuse the connection if + * the host and forwarding settings are the same. + */ +struct reusable_connection +{ + jb_socket sfd; + int in_use; + time_t timestamp; /* XXX: rename? */ + + time_t request_sent; + time_t response_received; + + /* + * Number of seconds after which this + * connection will no longer be reused. + */ + unsigned int keep_alive_timeout; -#ifdef DETECT_MSIE_IMAGES + char *host; + int port; + int forwarder_type; + char *gateway_host; + int gateway_port; + char *forward_host; + int forward_port; +}; -/* MSIE detected by user-agent string */ -#define ACCEPT_TYPE_IS_MSIE 0x0001 /* - * *If* this is MSIE, it wants an image. (Or this is a shift-reload, or - * it's got an image from this URL before... yuck!) - * Only meaningful if ACCEPT_TYPE_IS_MSIE set + * Flags for use in csp->flags + */ + +/** + * Flag for csp->flags: Set if this client is processing data. + * Cleared when the thread associated with this structure dies. */ -#define ACCEPT_TYPE_MSIE_IMAGE 0x0002 +#define CSP_FLAG_ACTIVE 0x01U -/* - * *If* this is MSIE, it wants a HTML document. - * Only meaningful if ACCEPT_TYPE_IS_MSIE set +/** + * Flag for csp->flags: Set if the server's reply is in "chunked" + * transfer encoding */ -#define ACCEPT_TYPE_MSIE_HTML 0x0004 +#define CSP_FLAG_CHUNKED 0x02U -#endif /* def DETECT_MSIE_IMAGES */ +/** + * Flag for csp->flags: Set if this request was enforced, although it would + * normally have been blocked. + */ +#define CSP_FLAG_FORCED 0x04U +/** + * Flag for csp->flags: Set if any modification to the body was done. + */ +#define CSP_FLAG_MODIFIED 0x08U -struct client_state -{ - /* The proxy's configuration */ - struct configuration_spec * config; +/** + * Flag for csp->flags: Set if request was blocked. + */ +#define CSP_FLAG_REJECTED 0x10U +/** + * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE). + */ +#define CSP_FLAG_TOGGLED_ON 0x20U - /* The actions to perform on the current request */ - struct current_action_spec action[1]; +/** + * Flag for csp->flags: Set if we answered the request ourselve. + */ +#define CSP_FLAG_CRUNCHED 0x40U +/** + * Flag for csp->flags: Set if an acceptable Connection header + * has already been set by the client. + */ +#define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040U - /* socket to talk to client (web browser) */ - int cfd; +/** + * Flag for csp->flags: Set if an acceptable Connection header + * has already been set by the server. + */ +#define CSP_FLAG_SERVER_CONNECTION_HEADER_SET 0x00000080U - /* socket to talk to server (web server or proxy) */ - int sfd; +/** + * Flag for csp->flags: Signals header parsers whether they + * are parsing server or client headers. + */ +#define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100U +/** + * Flag for csp->flags: Set if adding the Host: header + * isn't necessary. + */ +#define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200U -#ifdef STATISTICS - /* 1 if this URL was rejected, 0 otherwise. Allows actual stats inc to - * occur in main thread only for thread-safety. - */ - int rejected; -#endif /* def STATISTICS */ +/** + * Flag for csp->flags: Set if filtering is disabled by X-Filter: No + * XXX: As we now have tags we might as well ditch this. + */ +#define CSP_FLAG_NO_FILTERING 0x00000400U -#ifdef FORCE_LOAD - int force; -#endif /* def FORCE_LOAD */ +/** + * Flag for csp->flags: Set the client IP has appended to + * an already existing X-Forwarded-For header in which case + * no new header has to be generated. + */ +#define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800U -#ifdef TOGGLE - int toggled_on; -#endif /* def TOGGLE */ +/** + * Flag for csp->flags: Set if the server wants to keep + * the connection alive. + */ +#define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U - /* - * Client PC's IP address, as reported by the accept()_ function. - * Both as string and number - */ - char *ip_addr_str; - long ip_addr_long; +#ifdef FEATURE_CONNECTION_KEEP_ALIVE +/** + * Flag for csp->flags: Set if the server specified the + * content length. + */ +#define CSP_FLAG_SERVER_CONTENT_LENGTH_SET 0x00002000U -#ifdef TRUST_FILES - /* The referer in this request, if one was specified. */ - char *referrer; -#endif /* def TRUST_FILES */ +/** + * Flag for csp->flags: Set if we know the content length, + * either because the server set it, or we figured it out + * on our own. + */ +#define CSP_FLAG_CONTENT_LENGTH_SET 0x00004000U + +/** + * Flag for csp->flags: Set if the client wants to keep + * the connection alive. + */ +#define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE 0x00008000U + +/** + * Flag for csp->flags: Set if we think we got the whole + * client request and shouldn't read any additional data + * coming from the client until the current request has + * been dealt with. + */ +#define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U + +/** + * Flag for csp->flags: Set if the server promised us to + * keep the connection open for a known number of seconds. + */ +#define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET 0x00020000U + +#endif /* def FEATURE_CONNECTION_KEEP_ALIVE */ + +/** + * Flag for csp->flags: Set if we think we can't reuse + * the server socket. + */ +#define CSP_FLAG_SERVER_SOCKET_TAINTED 0x00040000U + +/** + * Flag for csp->flags: Set if the Proxy-Connection header + * is among the server headers. + */ +#define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U + +/** + * Flag for csp->flags: Set if the client reused its connection. + */ +#define CSP_FLAG_REUSED_CLIENT_CONNECTION 0x00100000U + +/** + * Flag for csp->flags: Set if the supports deflate compression. + */ +#define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE 0x00200000U + +/** + * Flag for csp->flags: Set if the content has been deflated by Privoxy + */ +#define CSP_FLAG_BUFFERED_CONTENT_DEFLATED 0x00400000U -#if defined(DETECT_MSIE_IMAGES) - /* Types the client will accept. - * Bitmask - see ACCEPT_TYPE_XXX constants. - */ - int accept_types; -#endif /* defined(DETECT_MSIE_IMAGES) */ - /* The URL that was requested */ +/* + * Flags for use in return codes of child processes + */ + +/** + * Flag for process return code: Set if exiting porcess has been toggled + * during its lifetime. + */ +#define RC_FLAG_TOGGLED 0x10 + +/** + * Flag for process return code: Set if exiting porcess has blocked its + * request. + */ +#define RC_FLAG_BLOCKED 0x20 + +/** + * Maximum number of actions/filter files. This limit is arbitrary - it's just used + * to size an array. + */ +#define MAX_AF_FILES 10 + +/** + * The state of a Privoxy processing thread. + */ +struct client_state +{ + /** The proxy's configuration */ + struct configuration_spec * config; + + /** The actions to perform on the current request */ + struct current_action_spec action[1]; + + /** socket to talk to client (web browser) */ + jb_socket cfd; + + /** current connection to the server (may go through a proxy) */ + struct reusable_connection server_connection; + + /** Multi-purpose flag container, see CSP_FLAG_* above */ + unsigned int flags; + + /** Client PC's IP address, as reported by the accept() function. + As a string. */ + char *ip_addr_str; +#ifdef HAVE_RFC2553 + /** Client PC's TCP address, as reported by the accept() function. + As a sockaddr. */ + struct sockaddr_storage tcp_addr; +#else + /** Client PC's IP address, as reported by the accept() function. + As a number. */ + unsigned long ip_addr_long; +#endif /* def HAVE_RFC2553 */ + + /** The URL that was requested */ struct http_request http[1]; - /* An I/O buffer used for buffering data read from the client */ + /* + * The final forwarding settings. + * XXX: Currently this is only used for forward-override, + * so we can free the space in sweep. + */ + struct forward_spec * fwd; + + /** An I/O buffer used for buffering data read from the network */ struct iob iob[1]; - /* List of all headers for this request */ + /** List of all headers for this request */ struct list headers[1]; - /* List of all cookies for this request */ - struct list cookie_list[1]; + /** List of all tags that apply to this request */ + struct list tags[1]; -#if defined(PCRS) || defined(KILLPOPUPS) - /* Nonzero if this has a text MIME type */ - int is_text; -#endif /* defined(PCRS) || defined(KILLPOPUPS) */ + /** MIME-Type key, see CT_* above */ + unsigned int content_type; - /* The "X-Forwarded-For:" header sent by the client */ - char *x_forwarded; + /** Actions files associated with this client */ + struct file_list *actions_list[MAX_AF_FILES]; - /* - * Nonzero if this client is processing data. - * Set to zero when the thread associated with this structure dies. + /** pcrs job files. */ + struct file_list *rlist[MAX_AF_FILES]; + + /** Length after content modification. */ + unsigned long long content_length; + +#ifdef FEATURE_CONNECTION_KEEP_ALIVE + /* XXX: is this the right location? */ + + /** Expected length of content after which we + * should stop reading from the server socket. */ - int active; + unsigned long long expected_content_length; - /* files associated with this client */ - struct file_list *actions_list; + /** Expected length of content after which we + * should stop reading from the client socket. + */ + unsigned long long expected_client_content_length; +#endif /* def FEATURE_CONNECTION_KEEP_ALIVE */ -#ifdef PCRS - struct file_list *rlist; /* Perl re_filterfile */ - size_t content_length; /* Length after processing */ -#endif /* def PCRS */ +#ifdef FEATURE_TRUST -#ifdef TRUST_FILES - struct file_list *tlist; /* trustfile */ -#endif /* def TRUST_FILES */ + /** Trust file. */ + struct file_list *tlist; - struct client_state *next; -}; +#endif /* def FEATURE_TRUST */ + /** + * Failure reason to embedded in the CGI error page, + * or NULL. Currently only used for socks errors. + */ + char *error_message; +}; -struct parsers +/** + * List of client states so the main thread can keep + * track of them and garbage collect their resources. + */ +struct client_states { - char *str; - char len; - char *(*parser)(const struct parsers *, char *, struct client_state *); + struct client_states *next; + struct client_state csp; }; +/** + * A function to add a header + */ +typedef jb_err (*add_header_func_ptr)(struct client_state *); + +/** + * A function to process a header + */ +typedef jb_err (*parser_func_ptr )(struct client_state *, char **); + + +/** + * List of available CGI functions. + */ struct cgi_dispatcher { - const char *name; - int name_length; - int (*handler)(struct client_state *csp, struct http_response *rsp, struct map *parameters); - const char *description; + /** The URL of the CGI, relative to the CGI root. */ + const char * const name; + + /** The handler function for the CGI */ + jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters); + + /** The description of the CGI, to appear on the main menu, or NULL to hide it. */ + const char * const description; + + /** A flag that indicates whether unintentional calls to this CGI can cause damage */ + int harmless; }; + +/** + * A data file used by Privoxy. Kept in a linked list. + */ struct file_list { - /* - * this is a pointer to the data structures associated with the file. + /** + * This is a pointer to the data structures associated with the file. * Read-only once the structure has been created. */ void *f; - - /* Normally NULL. When we are finished with file (i.e. when we have + + /** + * The unloader function. + * Normally NULL. When we are finished with file (i.e. when we have * loaded a new one), set to a pointer to an unloader function. * Unloader will be called by sweep() (called from main loop) when - * all clients using this file are done. This prevents threading + * all clients using this file are done. This prevents threading * problems. */ void (*unloader)(void *); - /* Used internally by sweep(). Do not access from elsewhere. */ - int active; - -#ifndef SPLIT_PROXY_ARGS - /* String to be displayed as part of show-proxy-args display. - * Read-only once the structure has been created. + /** + * Used internally by sweep(). Do not access from elsewhere. */ - char *proxy_args; -#endif /* ndef SPLIT_PROXY_ARGS */ + int active; - /* Following variables allow us to check if file has been changed. + /** + * File last-modified time, so we can check if file has been changed. * Read-only once the structure has been created. */ time_t lastmodified; + + /** + * The full filename. + */ char * filename; - /* Pointer to next entry in the linked list of all "file_list"s. + /** + * Pointer to next entry in the linked list of all "file_list"s. * This linked list is so that sweep() can navigate it. * Since sweep() can remove items from the list, we must be careful * to only access this value from main thread (when we know sweep @@ -643,220 +1023,361 @@ struct file_list }; -#ifdef TRUST_FILES +#ifdef FEATURE_TRUST + +/** + * The format of a trust file when loaded into memory. + */ struct block_spec { - struct url_spec url[1]; - int reject; - struct block_spec *next; + struct url_spec url[1]; /**< The URL pattern */ + int reject; /**< FIXME: Please document this! */ + struct block_spec *next; /**< Next entry in linked list */ }; -#endif /* def TRUST_FILES */ - -#define SOCKS_NONE 0 /* Don't use a SOCKS server */ -#define SOCKS_4 40 /* original SOCKS 4 protocol */ -#define SOCKS_4A 41 /* as modified for hosts w/o external DNS */ +/** + * Arbitrary limit for the number of trusted referrers. + */ +#define MAX_TRUSTED_REFERRERS 512 + +#endif /* def FEATURE_TRUST */ + +enum forwarder_type { + /**< Don't use a SOCKS server */ + SOCKS_NONE = 0, + /**< original SOCKS 4 protocol */ + SOCKS_4 = 40, + /**< SOCKS 4A, DNS resolution is done by the SOCKS server */ + SOCKS_4A = 41, + /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */ + SOCKS_5 = 50, +}; +/** + * How to forward a connection to a parent proxy. + */ struct forward_spec { + /** URL pattern that this forward_spec is for. */ struct url_spec url[1]; - /* Connection type - must be a SOCKS_xxx constant */ - int type; + /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */ + enum forwarder_type type; - /* SOCKS server */ + /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */ char *gateway_host; + + /** SOCKS server port. */ int gateway_port; - /* Parent HTTP proxy */ + /** Parent HTTP proxy hostname, or NULL for none. */ char *forward_host; + + /** Parent HTTP proxy port. */ int forward_port; - /* For the linked list */ + /** Next entry in the linked list. */ struct forward_spec *next; }; -#ifdef PCRS +/** + * Initializer for a static struct forward_spec. + */ +#define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL } + +/* Supported filter types */ +enum filter_type +{ + FT_CONTENT_FILTER = 0, + FT_CLIENT_HEADER_FILTER = 1, + FT_SERVER_HEADER_FILTER = 2, + FT_CLIENT_HEADER_TAGGER = 3, + FT_SERVER_HEADER_TAGGER = 4, +}; +#define MAX_FILTER_TYPES 5 + +/** + * This struct represents one filter (one block) from + * the re_filterfile. If there is more than one filter + * in the file, the file will be represented by a + * chained list of re_filterfile specs. + */ struct re_filterfile_spec { - struct list patterns[1]; - pcrs_job *joblist; + char *name; /**< Name from FILTER: statement in re_filterfile. */ + char *description; /**< Description from FILTER: statement in re_filterfile. */ + struct list patterns[1]; /**< The patterns from the re_filterfile. */ + pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */ + enum filter_type type; /**< Filter type (content, client-header, server-header). */ + int dynamic; /**< Set to one if the pattern might contain variables + and has to be recompiled for every request. */ + struct re_filterfile_spec *next; /**< The pointer for chaining. */ }; -#endif /* def PCRS */ -#ifdef ACL_FILES -#define ACL_PERMIT 1 /* accept connection request */ -#define ACL_DENY 2 /* reject connection request */ +#ifdef FEATURE_ACL + +#define ACL_PERMIT 1 /**< Accept connection request */ +#define ACL_DENY 2 /**< Reject connection request */ +/** + * An IP address pattern. Used to specify networks in the ACL. + */ struct access_control_addr { - unsigned long addr; - unsigned long mask; - unsigned long port; +#ifdef HAVE_RFC2553 + struct sockaddr_storage addr; /* \n" -#define BODY "\n" -#define BANNER "Internet JUNKBUSTER" +#ifdef FEATURE_FORCE_LOAD +/** The force load URL prefix. */ +#define FORCE_PREFIX "/PRIVOXY-FORCE" +#endif /* def FEATURE_FORCE_LOAD */ -#ifdef FORCE_LOAD -#define FORCE_PREFIX "/IJB-FORCE-LOAD" -#endif /* def FORCE_LOAD */ +#ifdef FEATURE_NO_GIFS +/** The MIME type for images ("image/png" or "image/gif"). */ +#define BUILTIN_IMAGE_MIMETYPE "image/png" +#else +#define BUILTIN_IMAGE_MIMETYPE "image/gif" +#endif /* def FEATURE_NO_GIFS */ -/* Shouldn't end with '/' */ -#define HOME_PAGE_URL "http://ijbswa.sourceforge.net" -#define REDIRECT_URL HOME_PAGE_URL "/redirect.php?v=" VERSION "&to=" -#define CGI_PREFIX_HOST "i.j.b" +/* + * Hardwired URLs + */ -static const char CSUCCEED[] = - "HTTP/1.0 200 Connection established\n" - "Proxy-Agent: IJ/" VERSION "\n\n"; +/** URL for the Privoxy home page. */ +#define HOME_PAGE_URL "http://www.privoxy.org/" -static const char CHEADER[] = - "HTTP/1.0 400 Invalid header received from browser\n\n"; +/** URL for the Privoxy user manual. */ +#define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/" -static const char SHEADER[] = - "HTTP/1.0 502 Invalid header received from server\n\n"; +/** Prefix for actions help links (append to USER_MANUAL_URL). */ +#define ACTIONS_HELP_PREFIX "actions-file.html#" -#ifdef IMAGE_BLOCKING +/** Prefix for config option help links (append to USER_MANUAL_URL). */ +#define CONFIG_HELP_PREFIX "config.html#" /* - * Hint: You can encode your own GIFs like that: - * perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o,", unpack("C", $c)); }' - */ - -static const char BLANKGIF[] = - "HTTP/1.0 200 OK\r\n" - "Pragma: no-cache\r\n" - "Last-Modified: Thu Jul 31, 1997 07:42:22 pm GMT\r\n" - "Expires: Thu Jul 31, 1997 07:42:22 pm GMT\r\n" - "Content-type: image/gif\r\n\r\n" - "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000" - "\000!\371\004\001\000\000\000\000,\000\000\000\000\001" - "\000\001\000\000\002\002D\001\000;"; - -static const char JBGIF[] = - "HTTP/1.0 200 OK\r\n" - "Pragma: no-cache\r\n" - "Last-Modified: Thu Jul 31, 1997 07:42:22 pm GMT\r\n" - "Expires: Thu Jul 31, 1997 07:42:22 pm GMT\r\n" - "Content-type: image/gif\r\n\r\n" - "GIF89aD\000\013\000\360\000\000\000\000\000\377\377\377!" - "\371\004\001\000\000\001\000,\000\000\000\000D\000\013\000" - "\000\002a\214\217\251\313\355\277\000\200G&K\025\316hC\037" - "\200\234\230Y\2309\235S\230\266\206\372J\253<\3131\253\271" - "\270\215\342\254\013\203\371\202\264\334P\207\332\020o\266" - "N\215I\332=\211\312\3513\266:\026AK)\364\370\365aobr\305" - "\372\003S\275\274k2\354\254z\347?\335\274x\306^9\374\276" - "\037Q\000\000;"; - -#endif /* def IMAGE_BLOCKING */ - -#if defined(FAST_REDIRECTS) || defined(IMAGE_BLOCKING) - -static const char HTTP_REDIRECT_TEMPLATE[] = - "HTTP/1.0 302 Local Redirect from Junkbuster\r\n" - "Pragma: no-cache\r\n" - "Last-Modified: Thu Jul 31, 1997 07:42:22 pm GMT\r\n" - "Expires: Thu Jul 31, 1997 07:42:22 pm GMT\r\n" - "Location: %s\r\n\r\n"; - -#endif /* defined(FAST_REDIRECTS) || defined(IMAGE_BLOCKING) */ + * The "hosts" to intercept and display CGI pages. + * First one is a hostname only, second one can specify host and path. + * + * Notes: + * 1) Do not specify the http: prefix + * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically. + * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string. + */ +#define CGI_SITE_1_HOST "p.p" +#define CGI_SITE_2_HOST "config.privoxy.org" +#define CGI_SITE_2_PATH "" + +/** + * The prefix for CGI pages. Written out in generated HTML. + * INCLUDES the trailing slash. + */ +#define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/" #ifdef __cplusplus } /* extern "C" */ #endif -#endif /* ndef _PROJECT_H */ +#endif /* ndef PROJECT_H_INCLUDED */ /* Local Variables: