X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=project.h;h=890eecc177f32d0d75be09582d6911a8482fa415;hp=c1770d4aa1aac0c799a06124f8a785f1b30dc618;hb=1b4d4f3ab4ec936d30c27fac8eb90ebba51a7412;hpb=e97ab93c25bbff1a08279c35fc4c77855d909585 diff --git a/project.h b/project.h index c1770d4a..890eecc1 100644 --- a/project.h +++ b/project.h @@ -1,6 +1,6 @@ #ifndef PROJECT_H_INCLUDED #define PROJECT_H_INCLUDED -#define PROJECT_H_VERSION "$Id: project.h,v 1.29 2001/09/13 23:29:43 jongfoster Exp $" +#define PROJECT_H_VERSION "$Id: project.h,v 1.69 2002/05/08 16:00:16 oes Exp $" /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/project.h,v $ @@ -10,13 +10,13 @@ * (though it does declare some macros). * * Copyright : Written by and Copyright (C) 2001 the SourceForge - * IJBSWA team. http://ijbswa.sourceforge.net + * 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 @@ -36,6 +36,191 @@ * * Revisions : * $Log: project.h,v $ + * Revision 1.69 2002/05/08 16:00:16 oes + * Added size member to struct iob, so it can + * be alloced larger than needed. + * + * Revision 1.68 2002/04/26 12:56:00 oes + * Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX + * + * Revision 1.67 2002/04/24 02:12:43 oes + * - Jon's multiple AF patch: + * - Make csp->actions_list an array + * - #define MAX_ACTION_FILES + * - Moved CGI_PARAM_LEN_MAX (500) here + * + * Revision 1.66 2002/04/15 19:06:43 jongfoster + * Typos + * + * Revision 1.65 2002/04/04 00:36:36 gliptak + * always use pcre for matching + * + * Revision 1.64 2002/04/03 22:28:03 gliptak + * Removed references to gnu_regex + * + * Revision 1.63 2002/03/31 17:19:00 jongfoster + * Win32 only: Enabling STRICT to fix a VC++ compile warning. + * + * Revision 1.62 2002/03/26 22:48:49 swa + * new homepage url + * + * Revision 1.61 2002/03/26 22:29:55 swa + * we have a new homepage! + * + * Revision 1.60 2002/03/24 15:52:17 jongfoster + * Changing CGI URL prefixes for new name + * + * Revision 1.59 2002/03/24 15:23:33 jongfoster + * Name changes + * + * Revision 1.58 2002/03/24 13:25:43 swa + * name change related issues + * + * Revision 1.57 2002/03/16 20:28:34 oes + * Added descriptions to the filters so users will know what they select in the cgi editor + * + * Revision 1.56 2002/03/13 20:27:30 oes + * Fixing bug with CT_TABOO + * + * Revision 1.55 2002/03/12 01:42:50 oes + * Introduced modular filters + * + * Revision 1.54 2002/03/09 20:03:52 jongfoster + * - Making various functions return int rather than size_t. + * (Undoing a recent change). Since size_t is unsigned on + * Windows, functions like read_socket that return -1 on + * error cannot return a size_t. + * + * THIS WAS A MAJOR BUG - it caused frequent, unpredictable + * crashes, and also frequently caused JB to jump to 100% + * CPU and stay there. (Because it thought it had just + * read ((unsigned)-1) == 4Gb of data...) + * + * - The signature of write_socket has changed, it now simply + * returns success=0/failure=nonzero. + * + * - Trying to get rid of a few warnings --with-debug on + * Windows, I've introduced a new type "jb_socket". This is + * used for the socket file descriptors. On Windows, this + * is SOCKET (a typedef for unsigned). Everywhere else, it's + * an int. The error value can't be -1 any more, so it's + * now JB_INVALID_SOCKET (which is -1 on UNIX, and in + * Windows it maps to the #define INVALID_SOCKET.) + * + * - The signature of bind_port has changed. + * + * Revision 1.53 2002/03/08 16:48:55 oes + * Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE + * + * Revision 1.52 2002/03/07 03:46:17 oes + * Fixed compiler warnings + * + * Revision 1.51 2002/03/05 04:52:42 oes + * Deleted non-errlog debugging code + * + * Revision 1.50 2002/03/04 19:32:07 oes + * Changed default port to 8118 + * + * Revision 1.49 2002/03/04 18:28:55 oes + * Deleted PID_FILE_NAME + * + * Revision 1.48 2002/03/03 14:50:40 oes + * Fixed CLF logging: Added ocmd member for client's request to struct http_request + * + * Revision 1.47 2002/02/20 23:15:13 jongfoster + * Parsing functions now handle out-of-memory gracefully by returning + * an error code. + * + * Revision 1.46 2002/01/17 21:06:09 jongfoster + * Now #defining the URLs of the config interface + * + * Minor changes to struct http_request and struct url_spec due to + * standardizing that struct http_request is used to represent a URL, and + * struct url_spec is used to represent a URL pattern. (Before, URLs were + * represented as seperate variables and a partially-filled-in url_spec). + * + * Revision 1.45 2002/01/09 14:33:27 oes + * Added HOSTENT_BUFFER_SIZE + * + * Revision 1.44 2001/12/30 14:07:32 steudten + * - Add signal handling (unix) + * - Add SIGHUP handler (unix) + * - Add creation of pidfile (unix) + * - Add action 'top' in rc file (RH) + * - Add entry 'SIGNALS' to manpage + * - Add exit message to logfile (unix) + * + * Revision 1.43 2001/11/22 21:57:51 jongfoster + * Making action_spec->flags into an unsigned long rather than just an + * unsigned int. + * Adding ACTION_NO_COOKIE_KEEP + * + * Revision 1.42 2001/11/05 21:42:41 steudten + * Include DBG() macro. + * + * Revision 1.41 2001/10/28 19:12:06 jongfoster + * Adding ijb_toupper() + * + * Revision 1.40 2001/10/26 17:40:47 oes + * Moved ijb_isspace and ijb_tolower to project.h + * Removed http->user_agent, csp->referrer and csp->accept_types + * + * Revision 1.39 2001/10/25 03:45:02 david__schmidt + * Adding a (void*) cast to freez() because Visual Age C++ won't expand the + * macro when called with a cast; so moving the cast to the macro def'n + * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and + * doesn't make macro expansion complain. Hope this works for everyone else + * too... + * + * Revision 1.38 2001/10/23 21:19:04 jongfoster + * New error-handling support: jb_err type and JB_ERR_xxx constants + * CGI functions now return a jb_err, and their parameters map is const. + * Support for RUNTIME_FEATUREs to enable/disable config editor + * Adding a few comments + * + * Revision 1.37 2001/10/14 22:14:01 jongfoster + * Removing name_length field from struct cgi_dispatcher, as this is + * now calculated at runtime from the "name" field. + * + * Revision 1.36 2001/10/10 16:45:15 oes + * Added LIMIT_CONNECT action and string + * Fixed HTTP message line termination + * Added CFORBIDDEN HTTP message + * + * Revision 1.35 2001/10/07 18:06:43 oes + * Added status member to struct http_request + * + * Revision 1.34 2001/10/07 15:45:25 oes + * Added url member to struct http_request and commented all + * members + * + * Added CT_TABOO + * + * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION + * + * Replaced struct client_state members rejected, + * force, active and toggled_on with "flags" bitmap. + * + * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED + * + * Added buffer_limit to struct configuration_spec + * + * Revision 1.33 2001/09/20 13:30:08 steudten + * + * Make freez() more secure in case of: if (exp) { free(z) ; a=*z } + * Last case will set z to NULL in free(z) and thats bad.. + * + * Revision 1.32 2001/09/16 23:02:51 jongfoster + * Fixing warning + * + * Revision 1.31 2001/09/16 13:20:29 jongfoster + * Rewrite of list library. Now has seperate header and list_entry + * structures. Also added a large sprinking of assert()s to the list + * code. + * + * Revision 1.30 2001/09/13 23:52:00 jongfoster + * Support for both static and dynamically generated CGI pages + * * Revision 1.29 2001/09/13 23:29:43 jongfoster * Defining FORWARD_SPEC_INITIALIZER * @@ -260,10 +445,6 @@ * and are included anyway. */ -#if defined(REGEX_PCRE) || defined (REGEX_GNU) -# define REGEX -#endif /* defined(REGEX_PCRE) || defined (REGEX_GNU) */ - #ifdef STATIC_PCRE # include "pcre.h" #else @@ -271,53 +452,136 @@ #endif #ifdef STATIC_PCRS -# include "pcrs.h" +# include "pcrs.h" #else -# include +# include #endif -#if defined(REGEX_PCRE) -# ifdef STATIC_PCRE -# include "pcreposix.h" -# else -# include -# endif -#endif /* defined(REGEX_PCRE) */ - -#if defined(REGEX_GNU) -# include "gnu_regex.h" +#ifdef STATIC_PCRE +# include "pcreposix.h" +#else +# include #endif -#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 freez(X) if(X) free(X); X = NULL +/* + * The type used by sockets. On UNIX it's an int. Microsoft decided to + * make it an unsigned. + */ +#ifdef _WIN32 +typedef SOCKET jb_socket; +#define JB_INVALID_SOCKET INVALID_SOCKET +#else /* ndef _WIN32 */ +typedef int jb_socket; +#define JB_INVALID_SOCKET (-1) +#endif /* ndef _WIN32 */ + +/* + * Error codes. Functions returning these should return a 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. */ +typedef int jb_err; + + +/* + * This macro is used to free a pointer that may be NULL + */ +#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 500 + +/* + * 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 accomodate 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. + */ +#define HOSTENT_BUFFER_SIZE 1024 + +/* + * So you can say "while (FOREVER) { ...do something... }" + */ #define FOREVER 1 /* Default IP and port to listen on */ #define HADDR_DEFAULT "127.0.0.1" -#define HADDR_PORT 8000 +#define HADDR_PORT 8118 +/* Forward defs for various structures */ /* Need this for struct client_state */ struct configuration_spec; + /* Generic linked list of strings */ -struct list /* FIXME: Why not separate entries and header? */ + +struct list_entry +{ + const char *str; + struct list_entry *next; +}; + +struct list { - char * str; /* valid in an entry */ - struct list *last; /* valid in header */ - struct list *next; + struct list_entry *first; + struct list_entry *last; }; + +/* A map from a string to another string */ + struct map_entry { const char *name; @@ -331,31 +595,43 @@ struct map struct map_entry *last; }; + struct http_request { - char *cmd; - char *gpc; - char *host; - char *host_ip_addr_str; /* NULL before connect_to() */ - int port; - char *path; - char *ver; - char *hostport; /* "host[:port]" */ - int ssl; - char *user_agent; /* Client's User-Agent: header value */ + 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() */ + + 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) */ }; -/* Response generated by CGI, blocker, or error handler */ +/* + * Response generated by CGI, blocker, or error handler + */ struct http_response { - char *status; /* HTTP status (string)*/ + char *status; /* HTTP status (string) */ struct list headers[1]; /* List of header lines */ - char *head; /* Formatted http response head */ - int head_length; /* Length of http response head */ - char *body; /* HTTP document body */ - int 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 broser (e.g. images) */ + 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 brwoser (e.g. images) */ }; /* A URL pattern */ @@ -364,13 +640,11 @@ 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; /* Buffer with '\0'-delimited fqdn */ - char **dvec; /* Domain ptr vector into dbuf */ - int dcnt; /* How many domains in fqdn? */ - int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT */ + /* Hostname matching, or dbuffer == NULL to match all hosts */ + 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) */ + int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */ /* Port matching: */ int port; /* The port number, or 0 to match all ports. */ @@ -379,15 +653,9 @@ struct url_spec 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 }; -#ifdef REGEX -#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL } -#else /* ifndef REGEX */ -#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, 0, 0, 0, NULL, 0 } -#endif /* ndef REGEX */ +#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL } /* Constants for host part matching in URLs */ #define ANCHOR_LEFT 1 @@ -397,49 +665,56 @@ struct url_spec /* An I/O buffer */ 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 */ }; #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)); -/* Keys for csp->content_type */ -#define CT_TEXT 0x01U -#define CT_GIF 0x02U - -#define ACTION_MASK_ALL (~0U) - -#define ACTION_MOST_COMPATIBLE 0x0000U - -#define ACTION_BLOCK 0x0001U -#define ACTION_DEANIMATE 0x2000U -#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 +/* Bits for csp->content_type */ +#define CT_TEXT 1 /* Suitable for pcrs filtering */ +#define CT_GIF 2 /* Suitable for GIF filtering */ +#define CT_TABOO 4 /* DONT filter */ + +#define ACTION_MASK_ALL (~0UL) + +#define ACTION_MOST_COMPATIBLE 0x00000000UL + +#define ACTION_BLOCK 0x00000001UL +#define ACTION_DEANIMATE 0x00000002UL +#define ACTION_DOWNGRADE 0x00000004UL +#define ACTION_FAST_REDIRECTS 0x00000008UL +#define ACTION_HIDE_FORWARDED 0x00000010UL +#define ACTION_HIDE_FROM 0x00000020UL +#define ACTION_HIDE_REFERER 0x00000040UL /* sic - follow HTTP, not English */ +#define ACTION_HIDE_USER_AGENT 0x00000080UL +#define ACTION_IMAGE 0x00000100UL +#define ACTION_IMAGE_BLOCKER 0x00000200UL +#define ACTION_NO_COMPRESSION 0x00000400UL +#define ACTION_NO_COOKIE_KEEP 0x00000800UL +#define ACTION_NO_COOKIE_READ 0x00001000UL +#define ACTION_NO_COOKIE_SET 0x00002000UL +#define ACTION_NO_POPUPS 0x00004000UL +#define ACTION_VANILLA_WAFER 0x00008000UL +#define ACTION_LIMIT_CONNECT 0x00010000UL #define ACTION_STRING_DEANIMATE 0 #define ACTION_STRING_FROM 1 #define ACTION_STRING_IMAGE_BLOCKER 2 #define ACTION_STRING_REFERER 3 #define ACTION_STRING_USER_AGENT 4 -#define ACTION_STRING_COUNT 5 - +#define ACTION_STRING_LIMIT_CONNECT 5 +#define ACTION_STRING_COUNT 6 #define ACTION_MULTI_ADD_HEADER 0 #define ACTION_MULTI_WAFER 1 -#define ACTION_MULTI_COUNT 2 +#define ACTION_MULTI_FILTER 2 +#define ACTION_MULTI_COUNT 3 + /* * This structure contains a list of actions to apply to a URL. @@ -449,7 +724,7 @@ struct iob */ struct current_action_spec { - unsigned flags; /* a bit set to "1" = add action */ + unsigned long flags; /* a bit set to "1" = add action */ /* For those actions that require parameters: */ @@ -468,8 +743,8 @@ struct current_action_spec */ struct action_spec { - unsigned mask; /* a bit set to "0" = remove action */ - unsigned add; /* a bit set to "1" = add action */ + unsigned long mask; /* a bit set to "0" = remove action */ + unsigned long add; /* a bit set to "1" = add action */ /* For those actions that require parameters: */ @@ -502,29 +777,29 @@ struct url_actions }; -/* Constants defining bitmask for csp->accept_types */ - -#ifdef FEATURE_IMAGE_DETECT_MSIE - -/* 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 */ -#define ACCEPT_TYPE_MSIE_IMAGE 0x0002 +#define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data. + * Cleared when the thread associated with + * this structure dies. */ +#define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked" + * transfer encoding */ +#define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although + * it would normally have been blocked. */ +#define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */ +#define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */ +#define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */ /* - * *If* this is MSIE, it wants a HTML document. - * Only meaningful if ACCEPT_TYPE_IS_MSIE set + * Maximum number of actions files. This limit is arbitrary - it's just used + * to size an array. */ -#define ACCEPT_TYPE_MSIE_HTML 0x0004 - -#endif /* def FEATURE_IMAGE_DETECT_MSIE */ - +#define MAX_ACTION_FILES 10 +/* + * The state of a Privoxy processing thread. + */ struct client_state { /* The proxy's configuration */ @@ -534,26 +809,13 @@ struct client_state struct current_action_spec action[1]; /* socket to talk to client (web browser) */ - int cfd; + jb_socket cfd; /* socket to talk to server (web server or proxy) */ - int sfd; - + jb_socket sfd; -#ifdef FEATURE_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 FEATURE_STATISTICS */ - -#ifdef FEATURE_FORCE_LOAD - int force; -#endif /* def FEATURE_FORCE_LOAD */ - -#ifdef FEATURE_TOGGLE - int toggled_on; -#endif /* def FEATURE_TOGGLE */ + /* Multi-purpose flag container, see CSP_FLAG_* above */ + unsigned short int flags; /* * Client PC's IP address, as reported by the accept()_ function. @@ -570,18 +832,6 @@ struct client_state char *my_ip_addr_str; char *my_hostname; -#ifdef FEATURE_TRUST - /* The referer in this request, if one was specified. */ - char *referrer; -#endif /* def FEATURE_TRUST */ - -#if defined(FEATURE_IMAGE_DETECT_MSIE) - /* Types the client will accept. - * Bitmask - see ACCEPT_TYPE_XXX constants. - */ - int accept_types; -#endif /* defined(FEATURE_IMAGE_DETECT_MSIE) */ - /* The URL that was requested */ struct http_request http[1]; @@ -594,23 +844,17 @@ struct client_state /* List of all cookies for this request */ struct list cookie_list[1]; - /* MIME-Type bitmap, see CT_* above */ - unsigned char content_type; + /* MIME-Type key, see CT_* above */ + unsigned short int content_type; /* The "X-Forwarded-For:" header sent by the client */ char *x_forwarded; - /* - * Nonzero if this client is processing data. - * Set to zero when the thread associated with this structure dies. - */ - int active; - /* files associated with this client */ - struct file_list *actions_list; + struct file_list *actions_list[MAX_ACTION_FILES]; struct file_list *rlist; /* pcrs job file */ - size_t content_length; /* Length after content modification */ + size_t content_length; /* Length after content modification */ #ifdef FEATURE_TRUST struct file_list *tlist; /* trustfile */ @@ -620,21 +864,41 @@ struct client_state }; +/* + * 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 functions to run on a list of headers + */ struct parsers { - char *str; - char len; - char *(*parser)(const struct parsers *, const char *, struct client_state *); + char *str; + size_t len; + parser_func_ptr parser; }; + +/* + * 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; + const char * const name; + jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters); + const char * const description; }; + +/* + * A data file used by Privoxy. Kept in a linked list. + */ struct file_list { /* @@ -642,11 +906,11 @@ struct file_list * Read-only once the structure has been created. */ void *f; - + /* 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 *); @@ -702,15 +966,22 @@ struct forward_spec /* For the linked list */ struct forward_spec *next; }; -#define FORWARD_SPEC_INITIALIZER { URL_SPEC_INITIALIZER, 0, NULL, 0, NULL, 0, NULL } +#define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL } +/* + * 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 { - char *username; - char *filtername; - 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 */ + struct re_filterfile_spec *next; /* The pointer for chaining */ }; #ifdef FEATURE_ACL @@ -738,6 +1009,11 @@ struct access_control_list /* Maximum number of loaders (actions, re_filter, ...) */ #define NLOADERS 8 + +#define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1 +#define RUNTIME_FEATURE_CGI_TOGGLE 2 + + /* * Data loaded from the configuration file. * @@ -748,11 +1024,15 @@ struct configuration_spec int debug; int multi_threaded; + /* Features that can be enabled/disabled through the config file */ + unsigned feature_flags; + const char *logfile; const char *confdir; const char *logdir; - const char *actions_file; + const char *actions_file[MAX_ACTION_FILES]; + const char *actions_file_short[MAX_ACTION_FILES]; /* The administrator's email address */ char *admin_address; @@ -760,6 +1040,9 @@ struct configuration_spec /* A URL with info on this proxy */ char *proxy_info_url; + /* URL to the user manual (on our website or local copy) */ + char *usermanual; + const char *re_filterfile; #ifdef FEATURE_COOKIE_JAR @@ -769,11 +1052,14 @@ struct configuration_spec /* * Port and IP to bind to. - * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8000 + * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118 */ const char *haddr; int hport; + /* Size limit for IOB */ + size_t buffer_limit; + #ifdef FEATURE_TRUST const char * trustfile; @@ -804,21 +1090,51 @@ struct configuration_spec #define SZ(X) (sizeof(X) / sizeof(*X)) #ifdef FEATURE_FORCE_LOAD -#define FORCE_PREFIX "/IJB-FORCE-LOAD" +#define FORCE_PREFIX "/PRIVOXY-FORCE" #endif /* def FEATURE_FORCE_LOAD */ +#ifdef FEATURE_NO_GIFS +#define BUILTIN_IMAGE_MIMETYPE "image/png" +#else +#define BUILTIN_IMAGE_MIMETYPE "image/gif" +#endif /* def FEATURE_NO_GIFS */ + + /* Hardwired URLs */ -#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" +#define HOME_PAGE_URL "http://www.privoxy.org" +#define USER_MANUAL_URL HOME_PAGE_URL "/" VERSION "/user-manual/" +#define HELP_LINK_PREFIX "configuration.html#" + +/* + * 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 "/" + /* HTTP snipplets */ static const char CSUCCEED[] = "HTTP/1.0 200 Connection established\n" - "Proxy-Agent: IJ/" VERSION "\n\n"; + "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n"; static const char CHEADER[] = - "HTTP/1.0 400 Invalid header received from browser\n\n"; + "HTTP/1.0 400 Invalid header received from browser\r\n\r\n"; + +static const char CFORBIDDEN[] = + "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"; #ifdef __cplusplus } /* extern "C" */