X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=project.h;h=7830259aec621e43a905e1e8a2ba75f877f29df1;hp=2263285cf0ca02789b492948de5f5c2baa6109af;hb=5511418f4b6874b99a6b3d57e46aea61c507bd9e;hpb=12f52e6af55d51d4b268af7956d97c772eebbb5c
diff --git a/project.h b/project.h
index 2263285c..7830259a 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.6 2001/05/27 22:17:04 oes Exp $"
+#define PROJECT_H_VERSION "$Id: project.h,v 1.19 2001/06/29 13:33:36 oes Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/project.h,v $
@@ -36,6 +36,88 @@
*
* Revisions :
* $Log: project.h,v $
+ * 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
+ * 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
+ * Added struct map,
+ * added struct http_response,
+ * changed struct interceptors to struct cgi_dispatcher,
+ * moved HTML stuff to cgi.h
+ *
+ * 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
@@ -103,7 +185,7 @@
* 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 "permissionsfile".
+ * 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.
@@ -172,6 +254,8 @@
extern "C" {
#endif
+#define BUFFER_SIZE 5000
+
#define FOREVER 1
/* Default IP and port to listen on */
@@ -179,18 +263,30 @@ extern "C" {
#define HADDR_PORT 8000
-/* Need this for struct gateway */
-struct client_state;
-
/* Need this for struct client_state */
struct configuration_spec;
+/* Generic linked list of strings */
+struct list /* FIXME: Why not separate entries and header? */
+{
+ char * str; /* valid in an entry */
+ struct list *last; /* valid in header */
+ struct list *next;
+};
+
+struct map
+{
+ char *name;
+ char *value;
+ struct map *next;
+};
struct http_request
{
char *cmd;
char *gpc;
char *host;
+ char *host_ip_addr_str; /* NULL before connect_to() */
int port;
char *path;
char *ver;
@@ -198,30 +294,47 @@ struct http_request
int ssl;
};
-struct gateway
+/* Response generated by CGI, blocker, or error handler */
+struct http_response
{
- /* generic attributes */
- char *name;
- int (*conn)(const struct gateway *, struct http_request *, struct client_state *);
- int type;
-
- /* domain specific attributes */
- char *gateway_host;
- int gateway_port;
-
- char *forward_host;
- int forward_port;
+ 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*/
};
-
-/* Generic linked list of strings */
-struct list
+/* A URL pattern */
+struct url_spec
{
- char *str;
- struct list *last;
- struct list *next;
+ 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 */
+
+ /* 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
};
+#define ANCHOR_LEFT 1
+#define ANCHOR_RIGHT 2
+
+
/* An I/O buffer */
struct iob
@@ -236,6 +349,96 @@ struct iob
#define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
+
+#define ACTION_MASK_ALL (~0U)
+
+#define ACTION_MOST_COMPATIBLE 0x0000U
+
+#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
+
+#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_MULTI_ADD_HEADER 0
+#define ACTION_MULTI_WAFER 1
+#define ACTION_MULTI_COUNT 2
+
+/*
+ * 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
+ * url_actions() to return the current values.
+ */
+struct current_action_spec
+{
+ unsigned flags; /* a bit set to "1" = add action */
+
+ /* For those actions that require parameters: */
+
+ /* each entry is valid if & only if corresponding entry in "add" set. */
+ char * string[ACTION_STRING_COUNT];
+
+ /* Strings to add */
+ 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 */
+
+ /* For those actions that require parameters: */
+
+ /* each entry is valid if & only if corresponding entry in "add" set. */
+ char * string[ACTION_STRING_COUNT];
+
+ /* Strings to remove. */
+ struct list multi_remove[ACTION_MULTI_COUNT][1];
+
+ /* If nonzero, remove *all* strings. */
+ int multi_remove_all[ACTION_MULTI_COUNT];
+
+ /* Strings to add */
+ struct list multi_add[ACTION_MULTI_COUNT][1];
+};
+
+/*
+ * This structure is used to store the actions list.
+ *
+ * It contains a URL pattern, and the chages to the actions.
+ * It is a linked list.
+ */
+struct url_actions
+{
+ struct url_spec url[1];
+
+ struct action_spec action[1];
+
+ struct url_actions * next;
+};
+
+
/* Constants defining bitmask for csp->accept_types */
#ifdef DETECT_MSIE_IMAGES
@@ -264,10 +467,8 @@ struct client_state
/* The proxy's configuration */
struct configuration_spec * config;
-
- /* The permissions that the current URL has */
- int permissions;
-
+ /* The actions to perform on the current request */
+ struct current_action_spec action[1];
/* socket to talk to client (web browser) */
int cfd;
@@ -298,6 +499,14 @@ struct client_state
char *ip_addr_str;
long ip_addr_long;
+
+ /* 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 TRUST_FILES
/* The referer in this request, if one was specified. */
char *referrer;
@@ -337,13 +546,7 @@ struct client_state
int active;
/* files associated with this client */
- struct file_list *flist; /* forwardfile */
- struct file_list *permissions_list;
-
-
-#ifdef ACL_FILES
- struct file_list *alist; /* aclfile */
-#endif /* def ACL_FILES */
+ struct file_list *actions_list;
#ifdef PCRS
struct file_list *rlist; /* Perl re_filterfile */
@@ -365,34 +568,14 @@ struct parsers
char *(*parser)(const struct parsers *, char *, struct client_state *);
};
-
-struct interceptors
-{
- char *str;
- char len;
- char *(*interceptor)(struct http_request *http, struct client_state *csp);
-};
-
-
-/* A URL pattern */
-struct url_spec
+struct cgi_dispatcher
{
- char *spec;
- char *domain;
- char *dbuf;
- char **dvec;
- int dcnt;
- int toplevel;
-
- char *path;
- int pathlen;
- int port;
-#ifdef REGEX
- regex_t *preg;
-#endif
+ const char *name;
+ int name_length;
+ int (*handler)(struct client_state *csp, struct http_response *rsp, struct map *parameters);
+ const char *description;
};
-
struct file_list
{
/*
@@ -445,35 +628,26 @@ struct block_spec
#endif /* def TRUST_FILES */
-#define PERMIT_COOKIE_SET 0x0001U
-#define PERMIT_COOKIE_READ 0x0002U
-#define PERMIT_RE_FILTER 0x0004U
-#define PERMIT_POPUPS 0x0008U
-#define PERMIT_REFERER 0x0010U /* sic - follow HTTP, not English */
-#define PERMIT_FAST_REDIRECTS 0x0020U
-#define PERMIT_BLOCK 0x0040U
-#define PERMIT_IMAGE 0x0080U
-
-#define PERMIT_USER_AGENT PERMIT_COOKIE_SET /* FIXME Alias this for now */
-
-#define PERMIT_MASK_ALL (~0U)
-
-#define PERMIT_MOST_COMPATIBLE (PERMIT_COOKIE_SET | PERMIT_COOKIE_READ | \
- PERMIT_REFERER | PERMIT_POPUPS | PERMIT_USER_AGENT)
+#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 */
-struct permissions_spec
+struct forward_spec
{
struct url_spec url[1];
- unsigned mask; /* a bit set to "0" = remove permission */
- unsigned add; /* a bit set to "1" = add permission */
- struct permissions_spec * next;
-};
+ /* Connection type - must be a SOCKS_xxx constant */
+ int type;
-struct forward_spec
-{
- struct url_spec url[1];
- struct gateway gw[1];
+ /* SOCKS server */
+ char *gateway_host;
+ int gateway_port;
+
+ /* Parent HTTP proxy */
+ char *forward_host;
+ int forward_port;
+
+ /* For the linked list */
struct forward_spec *next;
};
@@ -482,7 +656,6 @@ struct forward_spec
struct re_filterfile_spec
{
struct list patterns[1];
- /* See README.re_filter */
pcrs_job *joblist;
};
#endif /* def PCRS */
@@ -510,7 +683,7 @@ struct access_control_list
#endif /* def ACL_FILES */
-/* Maximum number of loaders (permissions, block, forward, acl...) */
+/* Maximum number of loaders (actions, re_filter, ...) */
#define NLOADERS 8
/*
@@ -523,43 +696,27 @@ struct configuration_spec
int debug;
int multi_threaded;
-#ifdef IMAGE_BLOCKING
- int tinygif;
- const char *tinygifurl;
-#endif /* def IMAGE_BLOCKING */
-
const char *logfile;
- const char *permissions_file;
- const char *forwardfile;
+ const char *confdir;
+ const char *logdir;
+ const char *actions_file;
-#ifdef ACL_FILES
- const char *aclfile;
-#endif /* def ACL_FILES */
+ /* The administrator's email address */
+ char *admin_address;
+
+ /* A URL with info on this proxy */
+ char *proxy_info_url;
#ifdef PCRS
const char *re_filterfile;
#endif /* def PCRS */
- /*
- * Permissions to use for URLs not in the permissions list.
- */
- int default_permissions;
-
#ifdef JAR_FILES
const char * jarfile;
FILE * jar;
#endif /* def JAR_FILES */
- const char *referrer;
- const char *uagent;
- const char *from;
-
- int add_forwarded;
-
- struct list wafer_list[1];
- struct list xtra_list[1];
-
/*
* Port and IP to bind to.
* Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8000
@@ -583,11 +740,14 @@ struct configuration_spec
struct url_spec *trust_list[64];
#endif /* def TRUST_FILES */
- /* Various strings for show-proxy-args */
- char *proxy_args_header;
- char *proxy_args_invocation;
- char *proxy_args_gateways;
- char *proxy_args_trailer;
+#ifdef ACL_FILES
+ struct access_control_list *acl;
+#endif /* def ACL_FILES */
+
+ struct forward_spec *forward;
+
+ /* All options from the config file, HTML-formatted */
+ char *proxy_args;
/* the configuration file object. */
struct file_list *config_file_list;
@@ -602,63 +762,16 @@ struct configuration_spec
#define SZ(X) (sizeof(X) / sizeof(*X))
-#define WHITEBG "\n"
-#define BODY "\n"
-#define BANNER "Internet JUNKBUSTER"
-
#ifdef FORCE_LOAD
#define FORCE_PREFIX "/IJB-FORCE-LOAD"
#endif /* def FORCE_LOAD */
-#define HOME_PAGE_URL "http://ijbswa.sourceforge.net/"
-#define REDIRECT_URL HOME_PAGE_URL "redirect.php?v=" VERSION "&to="
-
-static const char CFAIL[] =
- "HTTP/1.0 503 Connect failed\n"
- "Content-Type: text/html\n\n"
- "\n"
- "\n"
- "Internet Junkbuster: Connect failed\n"
- "\n"
- BODY
- ""
- BANNER
- "
"
- "TCP connection to '%s' failed: %s.\n
"
- "\n"
- "\n";
-
-static const char CNXDOM[] =
- "HTTP/1.0 404 Non-existent domain\n"
- "Content-Type: text/html\n\n"
- "\n"
- "\n"
- "Internet Junkbuster: Non-existent domain\n"
- "\n"
- BODY
- ""
- BANNER
- "
"
- "No such domain: %s\n"
- "\n"
- "\n";
-
-static const char CNOBANNER[] =
- "HTTP/1.0 200 No Banner\n"
- "Content-Type: text/html\n\n"
- "\n"
- "\n"
- "Internet Junkbuster: No Banner\n"
- "\n"
- BODY
- ""
- BANNER
- "
"
- "You asked for a banner that this proxy can't produce because either configuration does not permit.\n
"
- "or the URL didn't end with .gif\n"
- "\n"
- "