X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=project.h;h=b880241c53d902c523c4f02cc8085f5b48f83a2f;hp=4eb89089bc92163b2b7aea6ac85bc47826367583;hb=22a7b114a8f05d586fd5e0961ba8bc2f22b96f47;hpb=15ff718964896e6cad57701d340af891cad84e22 diff --git a/project.h b/project.h index 4eb89089..b880241c 100644 --- a/project.h +++ b/project.h @@ -1,7 +1,7 @@ #ifndef PROJECT_H_INCLUDED #define PROJECT_H_INCLUDED /** Version string. */ -#define PROJECT_H_VERSION "$Id: project.h,v 1.165 2011/06/23 14:01:01 fabiankeil Exp $" +#define PROJECT_H_VERSION "$Id: project.h,v 1.194 2012/12/07 12:43:55 fabiankeil Exp $" /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/project.h,v $ @@ -10,7 +10,7 @@ * project. Does not define any variables or functions * (though it does declare some macros). * - * Copyright : Written by and Copyright (C) 2001-2010 the + * Copyright : Written by and Copyright (C) 2001-2012 the * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written @@ -148,7 +148,7 @@ typedef int jb_err; #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 +#define JB_ERR_MODIFIED 5 /**< File has been modified outside of the CGI actions editor. */ #define JB_ERR_COMPRESS 6 /**< Error on decompression */ @@ -161,19 +161,17 @@ typedef int jb_err; /** - * 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". - * + * Macro definitions for platforms where isspace() and friends + * are macros that use their argument directly as an array index + * and thus better be positive. Supposedly that's the case on + * some unspecified Solaris versions. * 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)) +#define privoxy_isdigit(__X) isdigit((int)(unsigned char)(__X)) +#define privoxy_isupper(__X) isupper((int)(unsigned char)(__X)) +#define privoxy_toupper(__X) toupper((int)(unsigned char)(__X)) +#define privoxy_tolower(__X) tolower((int)(unsigned char)(__X)) +#define privoxy_isspace(__X) isspace((int)(unsigned char)(__X)) /** * Use for statically allocated buffers if you have no other choice. @@ -187,12 +185,6 @@ typedef int jb_err; */ #define CGI_PARAM_LEN_MAX 500U -/** - * Minimum length which a buffer has to reach before - * Privoxy bothers to (re-)compress it. Completely arbitrary. - */ -#define LOWER_LENGTH_LIMIT_FOR_COMPRESSION 1024U - /** * Buffer size for capturing struct hostent data in the * gethostby(name|addr)_r library calls. Since we don't @@ -239,7 +231,7 @@ struct list_entry * your own code. */ char *str; - + /** Next entry in the linked list, or NULL if no more. */ struct list_entry *next; }; @@ -420,17 +412,10 @@ struct iob /** * Return the number of bytes in the I/O buffer associated with the passed - * client_state pointer. - * May be zero. + * I/O buffer. May be zero. */ -#define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0) - +#define IOB_PEEK(IOB) ((IOB->cur > IOB->eod) ? (IOB->eod - IOB->cur) : 0) -/** - * 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)); /* Bits for csp->content_type bitmask: */ #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */ @@ -484,11 +469,11 @@ struct iob /** 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 +#define ACTION_SESSION_COOKIES_ONLY 0x00000800UL +/** Action bitmap: Block cookies coming from the client. */ +#define ACTION_CRUNCH_OUTGOING_COOKIES 0x00001000UL +/** Action bitmap: Block cookies coming from the server. */ +#define ACTION_CRUNCH_INCOMING_COOKIES 0x00002000UL /** Action bitmap: Override the forward settings in the config file */ #define ACTION_FORWARD_OVERRIDE 0x00004000UL /** Action bitmap: Block as empty document */ @@ -515,6 +500,8 @@ struct iob #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL /** Action bitmap: Replace or block Accept-Language header */ #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL +/** Action bitmap: Limit the cookie lifetime */ +#define ACTION_LIMIT_COOKIE_LIFETIME 0x08000000UL /** Action string index: How to deanimate GIFs */ @@ -553,8 +540,10 @@ struct iob #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 +/** Action string index: how many minutes cookies should be valid. */ +#define ACTION_STRING_LIMIT_COOKIE_LIFETIME 18 /** Number of string actions. */ -#define ACTION_STRING_COUNT 18 +#define ACTION_STRING_COUNT 19 /* To make the ugly hack in sed easier to understand */ @@ -647,6 +636,18 @@ struct url_actions struct url_actions *next; /**< Next action section in file, or NULL. */ }; +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, + /**< Like SOCKS5, but uses non-standard Tor extensions (currently only optimistic data) */ + SOCKS_5T, +}; /* * Structure to hold the server socket and the information @@ -667,10 +668,15 @@ struct reusable_connection * connection will no longer be reused. */ unsigned int keep_alive_timeout; + /* + * Number of requests that were sent to this connection. + * This is currently only for debugging purposes. + */ + unsigned int requests_sent_total; char *host; int port; - int forwarder_type; + enum forwarder_type forwarder_type; char *gateway_host; int gateway_port; char *forward_host; @@ -681,7 +687,7 @@ struct reusable_connection /* * 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. @@ -763,7 +769,6 @@ struct reusable_connection */ #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U -#ifdef FEATURE_CONNECTION_KEEP_ALIVE /** * Flag for csp->flags: Set if the server specified the * content length. @@ -797,11 +802,11 @@ struct reusable_connection */ #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. + * the server socket. XXX: It's also set after sabotaging + * pipelining attempts which is somewhat inconsistent with + * the name. */ #define CSP_FLAG_SERVER_SOCKET_TAINTED 0x00040000U @@ -826,6 +831,18 @@ struct reusable_connection */ #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED 0x00400000U +/** + * Flag for csp->flags: Set if we already read (parts of) + * a pipelined request in which case the client obviously + * isn't done talking. + */ +#define CSP_FLAG_PIPELINED_REQUEST_WAITING 0x00800000U + +/** + * Flag for csp->flags: Set if the client body is chunk-encoded + */ +#define CSP_FLAG_CHUNKED_CLIENT_BODY 0x01000000U + /* * Flags for use in return codes of child processes @@ -847,7 +864,13 @@ struct reusable_connection * Maximum number of actions/filter files. This limit is arbitrary - it's just used * to size an array. */ -#define MAX_AF_FILES 10 +#define MAX_AF_FILES 30 + +/** + * Maximum number of sockets to listen to. This limit is arbitrary - it's just used + * to size an array. + */ +#define MAX_LISTENING_SOCKETS 10 /** * The state of a Privoxy processing thread. @@ -863,6 +886,9 @@ struct client_state /** socket to talk to client (web browser) */ jb_socket cfd; + /** Number of requests received on the client socket. */ + unsigned int requests_received_total; + /** current connection to the server (may go through a proxy) */ struct reusable_connection server_connection; @@ -892,9 +918,13 @@ struct client_state */ struct forward_spec * fwd; - /** An I/O buffer used for buffering data read from the network */ + /** An I/O buffer used for buffering data read from the server */ + /* XXX: should be renamed to server_iob */ struct iob iob[1]; + /** An I/O buffer used for buffering data read from the client */ + struct iob client_iob[1]; + /** List of all headers for this request */ struct list headers[1]; @@ -913,7 +943,6 @@ struct client_state /** 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 @@ -925,7 +954,6 @@ struct client_state * should stop reading from the client socket. */ unsigned long long expected_client_content_length; -#endif /* def FEATURE_CONNECTION_KEEP_ALIVE */ #ifdef FEATURE_TRUST @@ -1012,7 +1040,7 @@ struct file_list * Read-only once the structure has been created. */ time_t lastmodified; - + /** * The full filename. */ @@ -1048,17 +1076,6 @@ struct block_spec #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. */ @@ -1100,6 +1117,7 @@ enum filter_type FT_SERVER_HEADER_FILTER = 2, FT_CLIENT_HEADER_TAGGER = 3, FT_SERVER_HEADER_TAGGER = 4, + FT_INVALID_FILTER = 42, }; #define MAX_FILTER_TYPES 5 @@ -1196,6 +1214,12 @@ struct access_control_list /** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */ #define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK 512U +/** configuration_spec::feature_flags: Buffered content is sent compressed if the client supports it. */ +#define RUNTIME_FEATURE_COMPRESSION 1024U + +/** configuration_spec::feature_flags: Pipelined requests are served instead of being discarded. */ +#define RUNTIME_FEATURE_TOLERATE_PIPELINING 2048U + /** * Data loaded from the configuration file. * @@ -1205,7 +1229,7 @@ struct configuration_spec { /** What to log */ int debug; - + /** Nonzero to enable multithreading. */ int multi_threaded; @@ -1259,14 +1283,17 @@ struct configuration_spec /** The short names of the pcre filter files. */ const char *re_filterfile_short[MAX_AF_FILES]; + /**< List of ordered client header names. */ + struct list ordered_client_headers[1]; + /** The hostname to show on CGI pages, or NULL to use the real one. */ const char *hostname; - /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */ - const char *haddr; + /** IP addresses to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */ + const char *haddr[MAX_LISTENING_SOCKETS]; - /** Port to bind to. Defaults to HADDR_PORT == 8118. */ - int hport; + /** Ports to bind to. Defaults to HADDR_PORT == 8118. */ + int hport[MAX_LISTENING_SOCKETS]; /** Size limit for IOB */ size_t buffer_limit; @@ -1311,6 +1338,10 @@ struct configuration_spec unsigned int default_server_timeout; #endif +#ifdef FEATURE_COMPRESSION + int compression_level; +#endif + /** All options from the config file, HTML-formatted. */ char *proxy_args; @@ -1340,7 +1371,7 @@ struct configuration_spec #endif /* def FEATURE_NO_GIFS */ -/* +/* * Hardwired URLs */