X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=project.h;h=c1770d4aa1aac0c799a06124f8a785f1b30dc618;hp=35e227421d4445abca2a81541ae97be72fdd50de;hb=622f8b00129cfb6abeb0d90f095b5ca5dd9d6c35;hpb=81d7f24ad32b07609902d0fbdf475ad5088ea7a5 diff --git a/project.h b/project.h index 35e22742..c1770d4a 100644 --- a/project.h +++ b/project.h @@ -1,6 +1,6 @@ -#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 +#define PROJECT_H_VERSION "$Id: project.h,v 1.29 2001/09/13 23:29:43 jongfoster Exp $" /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/project.h,v $ @@ -36,6 +36,64 @@ * * Revisions : * $Log: project.h,v $ + * Revision 1.29 2001/09/13 23:29:43 jongfoster + * Defining FORWARD_SPEC_INITIALIZER + * + * Revision 1.28 2001/09/13 23:05:50 jongfoster + * Changing the string paramater to the header parsers a "const". + * + * Revision 1.27 2001/08/05 16:06:20 jongfoster + * Modifiying "struct map" so that there are now separate header and + * "map_entry" structures. This means that functions which modify a + * map no longer need to return a pointer to the modified map. + * Also, it no longer reverses the order of the entries (which may be + * important with some advanced template substitutions). + * + * Revision 1.26 2001/07/30 22:08:36 jongfoster + * Tidying up #defines: + * - All feature #defines are now of the form FEATURE_xxx + * - Permanently turned off WIN_GUI_EDIT + * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS + * + * Revision 1.25 2001/07/29 18:43:08 jongfoster + * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to + * ANSI C rules. + * + * Revision 1.24 2001/07/25 17:20:27 oes + * Introduced http->user_agent + * + * Revision 1.23 2001/07/18 12:32:23 oes + * - Added ACTION_STRING_DEANIMATE + * - moved #define freez from jcc.h to project.h + * + * Revision 1.22 2001/07/15 17:51:41 jongfoster + * Renaming #define STATIC to STATIC_PCRE + * + * Revision 1.21 2001/07/13 14:03:19 oes + * - Reorganized regex header inclusion and #defines to + * comply to the scheme in configure.in + * - Added csp->content_type and its CT_* keys + * - Added ACTION_DEANIMATE + * - Removed all #ifdef PCRS + * + * Revision 1.20 2001/06/29 21:45:41 oes + * Indentation, CRLF->LF, Tab-> Space + * + * Revision 1.19 2001/06/29 13:33:36 oes + * - Improved comments + * - Introduced http_request.host_ip_addr_str + * - Introduced http_response.head_length + * - Introduced config.my_ip_addr_str, config.my_hostname, + * config.admin_address and config.proxy_info_url + * - Removed config.proxy_args_header and config.proxy_args_trailer, + * renamed config.proxy_args_invocation to config.proxy_args + * - Removed HTML snipplets and GIFs + * - Removed logentry from cancelled commit + * + * Revision 1.18 2001/06/09 10:57:39 jongfoster + * Adding definition of BUFFER_SIZE. + * Changing struct cgi_dispatcher to use "const" strings. + * * 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 @@ -51,59 +109,11 @@ * 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 + * Added struct map, + * added struct http_response, + * changed 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. @@ -246,39 +256,38 @@ /* * 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" -# else -# include -# endif -#endif /* (defined(REGEX) && defined(PCRE)) || defined(PCRS) */ -#if defined(REGEX) && defined(PCRE) -# ifdef STATIC +#if defined(REGEX_PCRE) || defined (REGEX_GNU) +# define REGEX +#endif /* defined(REGEX_PCRE) || defined (REGEX_GNU) */ + +#ifdef STATIC_PCRE +# include "pcre.h" +#else +# include +#endif + +#ifdef STATIC_PCRS +# include "pcrs.h" +#else +# include +#endif + +#if defined(REGEX_PCRE) +# ifdef STATIC_PCRE # include "pcreposix.h" # else # include # endif -#endif /* defined(REGEX) && defined(PCRE) */ +#endif /* defined(REGEX_PCRE) */ -#if defined(REGEX) && !defined(PCRE) +#if defined(REGEX_GNU) # include "gnu_regex.h" #endif -#ifdef PCRS -#include "pcrs.h" -#endif /* def PCRS */ - #ifdef AMIGA #include "amiga.h" #endif /* def AMIGA */ @@ -286,8 +295,10 @@ #ifdef __cplusplus extern "C" { #endif - -#define BUFFER_SIZE 5000 + +#define freez(X) if(X) free(X); X = NULL + +#define BUFFER_SIZE 5000 #define FOREVER 1 @@ -307,11 +318,17 @@ struct list /* FIXME: Why not separate entries and header? */ struct list *next; }; +struct map_entry +{ + const char *name; + const char *value; + struct map_entry *next; +}; + struct map { - char *name; - char *value; - struct map *next; + struct map_entry *first; + struct map_entry *last; }; struct http_request @@ -319,21 +336,26 @@ 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 */ }; -/* CGI or blocker generated response */ +/* Response generated by CGI, blocker, or error handler */ struct http_response { - char *status; /* HTTP status */ + char *status; /* HTTP status (string)*/ struct list headers[1]; /* List of header lines */ - int content_length; /* Length of body, REQUIRED if binary body*/ 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) */ }; /* A URL pattern */ @@ -345,8 +367,8 @@ struct url_spec /* Hostname matching: */ char *domain; /* Fully qalified domain name (FQDN) pattern. */ /* May contain "*". */ - char *dbuf; /* FIXME: Comment this */ - char **dvec; /* Domain ptr vector */ + 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 */ @@ -361,12 +383,17 @@ struct url_spec 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 */ +/* Constants for host part matching in URLs */ #define ANCHOR_LEFT 1 #define ANCHOR_RIGHT 2 - /* An I/O buffer */ struct iob { @@ -379,13 +406,16 @@ struct iob #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 @@ -399,11 +429,13 @@ struct iob #define ACTION_NO_POPUPS 0x0800U #define ACTION_VANILLA_WAFER 0x1000U -#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 +#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_MULTI_ADD_HEADER 0 #define ACTION_MULTI_WAFER 1 @@ -472,7 +504,7 @@ struct url_actions /* Constants defining bitmask for csp->accept_types */ -#ifdef DETECT_MSIE_IMAGES +#ifdef FEATURE_IMAGE_DETECT_MSIE /* MSIE detected by user-agent string */ #define ACCEPT_TYPE_IS_MSIE 0x0001 @@ -490,7 +522,7 @@ struct url_actions */ #define ACCEPT_TYPE_MSIE_HTML 0x0004 -#endif /* def DETECT_MSIE_IMAGES */ +#endif /* def FEATURE_IMAGE_DETECT_MSIE */ struct client_state @@ -498,11 +530,9 @@ 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) */ int cfd; @@ -510,20 +540,20 @@ struct client_state int sfd; -#ifdef STATISTICS +#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 STATISTICS */ +#endif /* def FEATURE_STATISTICS */ -#ifdef FORCE_LOAD +#ifdef FEATURE_FORCE_LOAD int force; -#endif /* def FORCE_LOAD */ +#endif /* def FEATURE_FORCE_LOAD */ -#ifdef TOGGLE +#ifdef FEATURE_TOGGLE int toggled_on; -#endif /* def TOGGLE */ +#endif /* def FEATURE_TOGGLE */ /* * Client PC's IP address, as reported by the accept()_ function. @@ -532,17 +562,25 @@ struct client_state char *ip_addr_str; long ip_addr_long; -#ifdef TRUST_FILES + + /* Our IP address and hostname, i.e. the IP address that + the client used to reach us, and the associated hostname, + both as strings + */ + char *my_ip_addr_str; + char *my_hostname; + +#ifdef FEATURE_TRUST /* The referer in this request, if one was specified. */ char *referrer; -#endif /* def TRUST_FILES */ +#endif /* def FEATURE_TRUST */ -#if defined(DETECT_MSIE_IMAGES) +#if defined(FEATURE_IMAGE_DETECT_MSIE) /* Types the client will accept. * Bitmask - see ACCEPT_TYPE_XXX constants. */ int accept_types; -#endif /* defined(DETECT_MSIE_IMAGES) */ +#endif /* defined(FEATURE_IMAGE_DETECT_MSIE) */ /* The URL that was requested */ struct http_request http[1]; @@ -556,10 +594,8 @@ struct client_state /* List of all cookies for this request */ struct list cookie_list[1]; -#if defined(PCRS) || defined(KILLPOPUPS) - /* Nonzero if this has a text MIME type */ - int is_text; -#endif /* defined(PCRS) || defined(KILLPOPUPS) */ + /* MIME-Type bitmap, see CT_* above */ + unsigned char content_type; /* The "X-Forwarded-For:" header sent by the client */ char *x_forwarded; @@ -573,14 +609,12 @@ struct client_state /* files associated with this client */ struct file_list *actions_list; -#ifdef PCRS - struct file_list *rlist; /* Perl re_filterfile */ - size_t content_length; /* Length after processing */ -#endif /* def PCRS */ + struct file_list *rlist; /* pcrs job file */ + size_t content_length; /* Length after content modification */ -#ifdef TRUST_FILES +#ifdef FEATURE_TRUST struct file_list *tlist; /* trustfile */ -#endif /* def TRUST_FILES */ +#endif /* def FEATURE_TRUST */ struct client_state *next; }; @@ -590,7 +624,7 @@ struct parsers { char *str; char len; - char *(*parser)(const struct parsers *, char *, struct client_state *); + char *(*parser)(const struct parsers *, const char *, struct client_state *); }; struct cgi_dispatcher @@ -620,13 +654,6 @@ struct file_list /* 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. - */ - char *proxy_args; -#endif /* ndef SPLIT_PROXY_ARGS */ - /* Following variables allow us to check if file has been changed. * Read-only once the structure has been created. */ @@ -643,14 +670,14 @@ struct file_list }; -#ifdef TRUST_FILES +#ifdef FEATURE_TRUST struct block_spec { struct url_spec url[1]; int reject; struct block_spec *next; }; -#endif /* def TRUST_FILES */ +#endif /* def FEATURE_TRUST */ #define SOCKS_NONE 0 /* Don't use a SOCKS server */ @@ -675,18 +702,18 @@ struct forward_spec /* For the linked list */ struct forward_spec *next; }; +#define FORWARD_SPEC_INITIALIZER { URL_SPEC_INITIALIZER, 0, NULL, 0, NULL, 0, NULL } -#ifdef PCRS struct re_filterfile_spec { + char *username; + char *filtername; struct list patterns[1]; pcrs_job *joblist; }; -#endif /* def PCRS */ - -#ifdef ACL_FILES +#ifdef FEATURE_ACL #define ACL_PERMIT 1 /* accept connection request */ #define ACL_DENY 2 /* reject connection request */ @@ -705,7 +732,7 @@ struct access_control_list short action; struct access_control_list *next; }; -#endif /* def ACL_FILES */ +#endif /* def FEATURE_ACL */ /* Maximum number of loaders (actions, re_filter, ...) */ @@ -727,14 +754,18 @@ struct configuration_spec const char *logdir; const char *actions_file; -#ifdef PCRS + /* The administrator's email address */ + char *admin_address; + + /* A URL with info on this proxy */ + char *proxy_info_url; + const char *re_filterfile; -#endif /* def PCRS */ -#ifdef JAR_FILES +#ifdef FEATURE_COOKIE_JAR const char * jarfile; FILE * jar; -#endif /* def JAR_FILES */ +#endif /* def FEATURE_COOKIE_JAR */ /* * Port and IP to bind to. @@ -743,32 +774,21 @@ struct configuration_spec const char *haddr; int hport; -#ifndef SPLIT_PROXY_ARGS - const char *suppress_message; -#endif /* ndef SPLIT_PROXY_ARGS */ - -#ifndef SPLIT_PROXY_ARGS - /* suppress listing config files */ - int suppress_blocklists; -#endif /* ndef SPLIT_PROXY_ARGS */ - -#ifdef TRUST_FILES +#ifdef FEATURE_TRUST const char * trustfile; struct list trust_info[1]; struct url_spec *trust_list[64]; -#endif /* def TRUST_FILES */ +#endif /* def FEATURE_TRUST */ -#ifdef ACL_FILES +#ifdef FEATURE_ACL struct access_control_list *acl; -#endif /* def ACL_FILES */ +#endif /* def FEATURE_ACL */ struct forward_spec *forward; - /* Various strings for show-proxy-args */ - char *proxy_args_header; - char *proxy_args_invocation; - char *proxy_args_trailer; + /* All options from the config file, HTML-formatted */ + char *proxy_args; /* the configuration file object. */ struct file_list *config_file_list; @@ -783,20 +803,16 @@ struct configuration_spec #define SZ(X) (sizeof(X) / sizeof(*X)) -#define WHITEBG "\n" -#define BODY "\n" -#define BANNER "Internet JUNKBUSTER" - -#ifdef FORCE_LOAD +#ifdef FEATURE_FORCE_LOAD #define FORCE_PREFIX "/IJB-FORCE-LOAD" -#endif /* def FORCE_LOAD */ +#endif /* def FEATURE_FORCE_LOAD */ -/* Shouldn't end with '/' */ +/* 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" +/* HTTP snipplets */ static const char CSUCCEED[] = "HTTP/1.0 200 Connection established\n" "Proxy-Agent: IJ/" VERSION "\n\n"; @@ -804,59 +820,11 @@ static const char CSUCCEED[] = static const char CHEADER[] = "HTTP/1.0 400 Invalid header received from browser\n\n"; -static const char SHEADER[] = - "HTTP/1.0 502 Invalid header received from server\n\n"; - -#ifdef IMAGE_BLOCKING - -/* - * 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) */ - #ifdef __cplusplus } /* extern "C" */ #endif -#endif /* ndef _PROJECT_H */ +#endif /* ndef PROJECT_H_INCLUDED */ /* Local Variables: