Renaming #define STATIC to STATIC_PCRE
[privoxy.git] / project.h
index 9020d92..22f6011 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.14 2001/06/03 11:03:48 oes Exp $"
+#define PROJECT_H_VERSION "$Id: project.h,v 1.21 2001/07/13 14:03:19 oes Exp $"
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/project.h,v $
  *
  * Revisions   :
  *    $Log: project.h,v $
- *    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
+ *    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
+ *    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 /
  *
- *    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
+ *    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
  *
- *    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.
 
 /*
  * 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 <pcre.h>  (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 <pcre.h>
-#  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 <pcre.h>
+#endif
+
+#ifdef STATIC_PCRS
+#  include "pcrs.h" 
+#else
+#  include <pcrs.h> 
+#endif
+
+#if defined(REGEX_PCRE)
+#  ifdef STATIC_PCRE
 #    include "pcreposix.h"
 #  else
 #    include <pcreposix.h>
 #  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 */
 extern "C" {
 #endif
 
+#define BUFFER_SIZE 5000
+
 #define FOREVER 1
 
 /* Default IP and port to listen on */
@@ -280,9 +272,6 @@ extern "C" {
 #define HADDR_PORT      8000
 
 
-/* Need this for struct gateway */
-struct client_state;
-
 /* Need this for struct client_state */
 struct configuration_spec;
 
@@ -301,20 +290,12 @@ struct map
   struct map *next;
 };
 
-
-/* Generic linked list of strings */
-struct list_share /* FIXME: Why not separate entries and header? */
-{
-   const char *       str;  /* valid in an entry */
-   struct list_share *last; /* valid in header */
-   struct list_share *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;
@@ -322,47 +303,40 @@ struct http_request
    int   ssl;
 };
 
-/* 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*/
 };
-  
-struct gateway
-{
-   /* 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;
-};
-
 
 /* 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;
+   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_t *preg;      /* Regex for matching path part                      */
 #endif
 };
 
@@ -383,13 +357,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 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
@@ -413,7 +390,12 @@ struct iob
 #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    */
@@ -427,6 +409,12 @@ struct current_action_spec
    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 */
@@ -447,6 +435,12 @@ struct action_spec
    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];
@@ -485,11 +479,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;
 
@@ -519,6 +511,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;
@@ -543,10 +543,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;
@@ -558,18 +556,10 @@ struct client_state
    int active;
 
    /* files associated with this client */
-   struct file_list *flist;   /* forwardfile */
    struct file_list *actions_list;
 
-
-#ifdef ACL_FILES
-   struct file_list *alist;   /* aclfile */
-#endif /* def ACL_FILES */
-
-#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
    struct file_list *tlist;   /* trustfile */
@@ -588,10 +578,10 @@ struct parsers
 
 struct cgi_dispatcher
 {
-   char *name;
-   int   name_length;
-   int   (*handler)(struct client_state *csp, struct http_response *rsp, struct map *parameters);
-   char *description;
+   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
@@ -646,22 +636,34 @@ struct block_spec
 #endif /* def TRUST_FILES */
 
 
+#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 forward_spec
 {
    struct url_spec url[1];
-   struct gateway gw[1];
+
+   /* Connection type - must be a SOCKS_xxx constant */
+   int   type;
+
+   /* 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;
 };
 
-
-#ifdef PCRS
 struct re_filterfile_spec
 {
    struct list patterns[1];
    pcrs_job *joblist;
 };
-#endif /* def PCRS */
-
 
 #ifdef ACL_FILES
 #define ACL_PERMIT   1  /* accept connection request */
@@ -685,7 +687,7 @@ struct access_control_list
 #endif /* def ACL_FILES */
 
 
-/* Maximum number of loaders (actions, block, forward, acl...) */
+/* Maximum number of loaders (actions, re_filter, ...) */
 #define NLOADERS 8
 
 /*
@@ -701,16 +703,16 @@ struct configuration_spec
    const char *logfile;
 
    const char *confdir;
+   const char *logdir;
    const char *actions_file;
-   const char *forwardfile;
 
-#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 */
 
 #ifdef JAR_FILES
    const char * jarfile;
@@ -740,11 +742,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;
@@ -759,20 +764,16 @@ struct configuration_spec
 
 #define SZ(X)  (sizeof(X) / sizeof(*X))
 
-#define WHITEBG   "<body bgcolor=\"#ffffff\" link=\"#000078\" alink=\"#ff0022\" vlink=\"#787878\">\n"
-#define BODY      "<body bgcolor=\"#f8f8f0\" link=\"#000078\" alink=\"#ff0022\" vlink=\"#787878\">\n"
-#define BANNER    "<strong>Internet J<small>UNK<i><font color=\"red\">BUSTER</font></i></small></strong>"
-
 #ifdef FORCE_LOAD
 #define FORCE_PREFIX "/IJB-FORCE-LOAD"
 #endif /* def 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";
@@ -780,54 +781,6 @@ 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