Replaced "list_share" with "list" - the tiny memory gain was not
[privoxy.git] / project.h
index df218bd..acb0849 100644 (file)
--- 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.4 2001/05/22 18:46:04 oes Exp $"
+#define PROJECT_H_VERSION "$Id: project.h,v 1.11 2001/06/01 10:32:47 oes Exp $"
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/project.h,v $
  *
  * Revisions   :
  *    $Log: project.h,v $
+ *    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
  *    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.
@@ -194,15 +253,38 @@ struct gateway
 };
 
 
-struct proxy_args
+/* Generic linked list of strings */
+struct list /* FIXME: Why not separate entries and header? */
 {
-   char *header;
-   char *invocation;
-   char *gateways;
-   char *trailer;
+   char *       str;  /* valid in an entry */
+   struct list *last; /* valid in header */
+   struct list *next;
+};
+
+
+/* A URL pattern */
+struct url_spec
+{
+   char  *spec;
+   char  *domain;        /* fqdn */
+   char  *dbuf;
+   char **dvec;          /* Domain ptr vector */
+   int    dcnt;          /* How many domains in fqdn? */
+   int    unanchored;    /* bitmap 0: left, 1: right */
+
+   char *path;
+   int   pathlen;
+   int   port;
+#ifdef REGEX
+   regex_t *preg;
+#endif
 };
 
+#define ANCHOR_LEFT  1
+#define ANCHOR_RIGHT 2
 
+
+/* An I/O buffer */
 struct iob
 {
    char *buf;
@@ -211,15 +293,79 @@ struct iob
 };
 
 
-struct list
+#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)
+
+#define ACTION_MOST_COMPATIBLE 0U
+
+#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_NO_COOKIE_READ  0x0100U
+#define ACTION_NO_COOKIE_SET   0x0200U
+#define ACTION_NO_POPUPS       0x0400U
+#define ACTION_VANILLA_WAFER   0x0800U
+
+#define ACTION_STRING_FROM       0
+#define ACTION_STRING_REFERER    1
+#define ACTION_STRING_USER_AGENT 2
+#define ACTION_STRING_COUNT      3
+
+#define ACTION_MULTI_ADD_HEADER  0
+#define ACTION_MULTI_WAFER       1
+#define ACTION_MULTI_COUNT       2
+
+
+struct current_action_spec
 {
-   char *str;
-   struct list *last;
-   struct list *next;
+   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];
 };
 
-#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));
+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];
+};
+
+struct url_actions
+{
+   struct url_spec url[1];
+
+   struct action_spec action[1];
+
+   struct url_actions * next;
+};
 
 
 /* Constants defining bitmask for csp->accept_types */
@@ -247,13 +393,21 @@ struct list
 
 struct client_state
 {
+   /* The proxy's configuration */
    struct configuration_spec * config;
 
-   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;
+
+   /* socket to talk to server (web server or proxy) */
    int  sfd;
 
+
 #ifdef STATISTICS
    /* 1 if this URL was rejected, 0 otherwise. Allows actual stats inc to 
     * occur in main thread only for thread-safety. 
@@ -266,17 +420,20 @@ struct client_state
 #endif /* def FORCE_LOAD */
 
 #ifdef TOGGLE
-   /*
-    * by haroon - most of credit to srt19170
-    * We add an "on/off" toggle here that is used to effectively toggle
-    * the Junkbuster off or on
-    */
    int   toggled_on;
-#endif
+#endif /* def TOGGLE */
 
+   /*
+    * 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 TRUST_FILES
+   /* The referer in this request, if one was specified. */
    char *referrer;
+#endif /* def TRUST_FILES */
 
 #if defined(DETECT_MSIE_IMAGES)
    /* Types the client will accept.
@@ -285,37 +442,44 @@ struct client_state
    int accept_types;
 #endif /* defined(DETECT_MSIE_IMAGES) */
 
-   const struct gateway *gw;
+   /* The URL that was requested */
    struct http_request http[1];
 
+   /* An I/O buffer used for buffering data read from the client */
    struct iob iob[1];
 
+   /* List of all headers for this request */
    struct list headers[1];
+
+   /* 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) */
 
+   /* 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 *blist;   /* blockfile */
    struct file_list *flist;   /* forwardfile */
-   struct file_list *permissions_list;
+   struct file_list *actions_list;
 
 
 #ifdef ACL_FILES
    struct file_list *alist;   /* aclfile */
 #endif /* def ACL_FILES */
 
-#ifdef USE_IMAGE_LIST
-   struct file_list *ilist;   /* imagefile */
-#endif /* def USE_IMAGE_LIST */
-
 #ifdef PCRS
      struct file_list *rlist;   /* Perl re_filterfile */
+     size_t content_length;     /* Length after processing */ 
 #endif /* def PCRS */
 
 #ifdef TRUST_FILES
@@ -342,26 +506,6 @@ struct interceptors
 };
 
 
-/* this allows the proxy to permit/block access to any host and/or path */
-
-struct url_spec
-{
-   char  *spec;
-   char  *domain;
-   char  *dbuf;
-   char **dvec;
-   int    dcnt;
-   int    toplevel;
-
-   char *path;
-   int   pathlen;
-   int   port;
-#ifdef REGEX
-   regex_t *preg;
-#endif
-};
-
-
 struct file_list
 {
    /*
@@ -404,30 +548,19 @@ struct file_list
 };
 
 
+#ifdef TRUST_FILES
 struct block_spec
 {
    struct url_spec url[1];
    int    reject;
    struct block_spec *next;
 };
+#endif /* def TRUST_FILES */
 
 
-#define PERMIT_COOKIE_SET    0x0001
-#define PERMIT_COOKIE_READ   0x0002
-#define PERMIT_RE_FILTER     0x0004
-#define PERMIT_POPUPS        0x0008
-
-struct permissions_spec
-{
-   struct url_spec           url[1];
-   int                       permissions;
-   struct permissions_spec * next;
-};
-
 struct forward_spec
 {
    struct url_spec url[1];
-   int   reject;
    struct gateway gw[1];
    struct forward_spec *next;
 };
@@ -464,7 +597,8 @@ struct access_control_list
 };
 #endif /* def ACL_FILES */
 
-/* Maximum number of loaders (permissions, block, forward, acl...) */
+
+/* Maximum number of loaders (actions, block, forward, acl...) */
 #define NLOADERS 8
 
 /*
@@ -477,48 +611,29 @@ struct configuration_spec
    int debug;
    int multi_threaded;
 
-#if defined(DETECT_MSIE_IMAGES) || defined(USE_IMAGE_LIST)
-   int tinygif;
-   const char *tinygifurl;
-#endif /* defined(DETECT_MSIE_IMAGES) || defined(USE_IMAGE_LIST) */
+#ifdef IMAGE_BLOCKING
+   int tinygif;              /* FIXME Should be an action */
+   const char *tinygifurl;   /* FIXME Should be an action */
+#endif /* def IMAGE_BLOCKING */
 
    const char *logfile;
 
-   const char *blockfile;
-   const char *permissions_file;
+   const char *actions_file;
    const char *forwardfile;
 
 #ifdef ACL_FILES
    const char *aclfile;
 #endif /* def ACL_FILES */
 
-#ifdef USE_IMAGE_LIST
-   const char *imagefile;
-#endif /* def USE_IMAGE_LIST */
-
 #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
@@ -531,14 +646,10 @@ struct configuration_spec
 #endif /* ndef SPLIT_PROXY_ARGS */
 
 #ifndef SPLIT_PROXY_ARGS
-   /* suppress listing sblock and simage */
+   /* suppress listing config files */
    int suppress_blocklists;
 #endif /* ndef SPLIT_PROXY_ARGS */
 
-#ifdef FAST_REDIRECTS
-   int fast_redirects;
-#endif /* def FAST_REDIRECTS */
-
 #ifdef TRUST_FILES
    const char * trustfile;
 
@@ -546,13 +657,20 @@ struct configuration_spec
    struct url_spec *trust_list[64];
 #endif /* def TRUST_FILES */
 
-   struct proxy_args proxy_args[1];
+   /* Various strings for show-proxy-args */
+   char *proxy_args_header;
+   char *proxy_args_invocation;
+   char *proxy_args_gateways;
+   char *proxy_args_trailer;
 
+   /* the configuration file object. */
    struct file_list *config_file_list;
 
+   /* List of loaders */
    int (*loaders[NLOADERS])(struct client_state *);
 
-   int need_bind; /* bool, nonzero if we need to bind() to the new port */
+   /* bool, nonzero if we need to bind() to the new port */
+   int need_bind;
 };
 
 
@@ -625,7 +743,7 @@ static const char CHEADER[] =
 static const char SHEADER[] =
    "HTTP/1.0 502 Invalid header received from server\n\n";
 
-#if defined(DETECT_MSIE_IMAGES) || defined(USE_IMAGE_LIST)
+#ifdef IMAGE_BLOCKING
 
 /*
  * Hint: You can encode your own GIFs like that:
@@ -657,18 +775,18 @@ static const char JBGIF[] =
    "\372\003S\275\274k2\354\254z\347?\335\274x\306^9\374\276"
    "\037Q\000\000;";
 
-#endif /* defined(DETECT_MSIE_IMAGES) || defined(USE_IMAGE_LIST) */
+#endif /* def IMAGE_BLOCKING */
 
-#if defined(FAST_REDIRECTS) || defined(DETECT_MSIE_IMAGES) || defined(USE_IMAGE_LIST)
+#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";
+      "Location: %s\r\n\r\n";
 
-#endif /*  defined(DETECT_MSIE_IMAGES) || defined(USE_IMAGE_LIST) */
+#endif /*  defined(FAST_REDIRECTS) || defined(IMAGE_BLOCKING) */
 
 #ifdef __cplusplus
 } /* extern "C" */