Adding code to handle +no-cookies-keep
[privoxy.git] / project.h
index fc058ad..fbb871f 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.15 2001/06/04 11:28:53 swa Exp $"
+#ifndef PROJECT_H_INCLUDED
+#define PROJECT_H_INCLUDED
+#define PROJECT_H_VERSION "$Id: project.h,v 1.42 2001/11/05 21:42:41 steudten Exp $"
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/project.h,v $
  *                IJBSWA team.  http://ijbswa.sourceforge.net
  *
  *                Based on the Internet Junkbuster originally written
- *                by and Copyright (C) 1997 Anonymous Coders and 
+ *                by and Copyright (C) 1997 Anonymous Coders and
  *                Junkbusters Corporation.  http://www.junkbusters.com
  *
- *                This program is free software; you can redistribute it 
+ *                This program is free software; you can redistribute it
  *                and/or modify it under the terms of the GNU General
  *                Public License as published by the Free Software
  *                Foundation; either version 2 of the License, or (at
  *
  * Revisions   :
  *    $Log: project.h,v $
- *    Revision 1.15  2001/06/04 11:28:53  swa
- *    redirect did not work due to missing /
+ *    Revision 1.42  2001/11/05 21:42:41  steudten
+ *    Include DBG() macro.
  *
- *    Revision 1.14  2001/06/03 11:03:48  oes
- *    Makefile/in
+ *    Revision 1.41  2001/10/28 19:12:06  jongfoster
+ *    Adding ijb_toupper()
  *
- *    introduced cgi.c
+ *    Revision 1.40  2001/10/26 17:40:47  oes
+ *    Moved ijb_isspace and ijb_tolower to project.h
+ *    Removed http->user_agent, csp->referrer and csp->accept_types
  *
- *    actions.c:
+ *    Revision 1.39  2001/10/25 03:45:02  david__schmidt
+ *    Adding a (void*) cast to freez() because Visual Age C++ won't expand the
+ *    macro when called with a cast; so moving the cast to the macro def'n
+ *    seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
+ *    doesn't make macro expansion complain.  Hope this works for everyone else
+ *    too...
  *
- *    adapted to new enlist_unique arg format
+ *    Revision 1.38  2001/10/23 21:19:04  jongfoster
+ *    New error-handling support: jb_err type and JB_ERR_xxx constants
+ *    CGI functions now return a jb_err, and their parameters map is const.
+ *    Support for RUNTIME_FEATUREs to enable/disable config editor
+ *    Adding a few comments
  *
- *    conf loadcfg.c
+ *    Revision 1.37  2001/10/14 22:14:01  jongfoster
+ *    Removing name_length field from struct cgi_dispatcher, as this is
+ *    now calculated at runtime from the "name" field.
  *
- *    introduced confdir option
+ *    Revision 1.36  2001/10/10 16:45:15  oes
+ *    Added LIMIT_CONNECT action and string
+ *    Fixed HTTP message line termination
+ *    Added CFORBIDDEN HTTP message
+ *
+ *    Revision 1.35  2001/10/07 18:06:43  oes
+ *    Added status member to struct http_request
  *
- *    filters.c filtrers.h
+ *    Revision 1.34  2001/10/07 15:45:25  oes
+ *    Added url member to struct http_request and commented all
+ *      members
  *
- *     extracted-CGI relevant stuff
+ *    Added CT_TABOO
  *
- *    jbsockets.c
+ *    Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
  *
- *     filled comment
+ *    Replaced struct client_state members rejected,
+ *      force, active and toggled_on with "flags" bitmap.
  *
- *    jcc.c
+ *    Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
  *
- *     support for new cgi mechansim
+ *    Added buffer_limit to struct configuration_spec
  *
- *    list.c list.h
+ *    Revision 1.33  2001/09/20 13:30:08  steudten
  *
- *    functions for new list type: "map"
- *    extended enlist_unique
+ *    Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
+ *    Last case will set z to NULL in free(z) and thats bad..
  *
- *    miscutil.c .h
- *    introduced bindup()
+ *    Revision 1.32  2001/09/16 23:02:51  jongfoster
+ *    Fixing warning
  *
- *    parsers.c parsers.h
+ *    Revision 1.31  2001/09/16 13:20:29  jongfoster
+ *    Rewrite of list library.  Now has seperate header and list_entry
+ *    structures.  Also added a large sprinking of assert()s to the list
+ *    code.
  *
- *    deleted const struct interceptors
+ *    Revision 1.30  2001/09/13 23:52:00  jongfoster
+ *    Support for both static and dynamically generated CGI pages
  *
- *    pcrs.c
- *    added FIXME
+ *    Revision 1.29  2001/09/13 23:29:43  jongfoster
+ *    Defining FORWARD_SPEC_INITIALIZER
  *
- *    project.h
+ *    Revision 1.28  2001/09/13 23:05:50  jongfoster
+ *    Changing the string paramater to the header parsers a "const".
  *
- *    added struct map
- *    added struct http_response
- *    changes struct interceptors to struct cgi_dispatcher
- *    moved HTML stuff to cgi.h
+ *    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
  *
- *    re_filterfile:
+ *    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
  *
- *    changed
+ *    Revision 1.20  2001/06/29 21:45:41  oes
+ *    Indentation, CRLF->LF, Tab-> Space
  *
- *    showargs.c
- *    NO TIME LEFT
+ *    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
 
 /*
  * 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" 
+#ifdef AMIGA
+#include "amiga.h"
 #endif /* def AMIGA */
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+#ifdef _DEBUG
+extern int ldebug;
+#define DBG(a,b)        { if ( ldebug >= a ) { printf b ; }}
+#else
+#define DBG(a,b)
+#endif /* _DEBUG */
+
+
+
+/*
+ * Error codes.  Functions returning these should return a jb_err
+ */
+#define JB_ERR_OK         0 /* Success, no error                        */
+#define JB_ERR_MEMORY     1 /* Out of memory                            */
+#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    */
+                            /* CGI actions editor.                      */
+typedef int jb_err;
+
+
+/*
+ * This macro is used to free a pointer that may be NULL
+ */
+#define freez(X)  { if(X) { free((void*)X); X = NULL ; } }
+
+
+/* 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".
+ *
+ * Note: Remember to #include <ctype.h> 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))  
+
+/*
+ * Use for statically allocated buffers if you have no other choice.
+ * Remember to check the length of what you write into the buffer
+ * - we don't want any buffer overflows!
+ */
+#define BUFFER_SIZE 5000
+
+/*
+ * So you can say "while (FOREVER) { ...do something... }"
+ */
 #define FOREVER 1
 
 /* Default IP and port to listen on */
@@ -283,97 +420,110 @@ extern "C" {
 #define HADDR_PORT      8000
 
 
-/* Need this for struct gateway */
-struct client_state;
+/* Forward defs for various structures */
 
 /* Need this for struct client_state */
 struct configuration_spec;
 
+
 /* Generic linked list of strings */
-struct list /* FIXME: Why not separate entries and header? */
+
+struct list_entry
 {
-   char *       str;  /* valid in an entry */
-   struct list *last; /* valid in header */
-   struct list *next;
+   const char *str;
+   struct list_entry *next;
 };
 
-struct map
+struct list
 {
-  char *name;
-  char *value;
-  struct map *next;
+   struct list_entry *first;
+   struct list_entry *last;
 };
 
 
-/* Generic linked list of strings */
-struct list_share /* FIXME: Why not separate entries and header? */
+/* A map from a string to another string */
+
+struct map_entry
+{
+   const char *name;
+   const char *value;
+   struct map_entry *next;
+};
+
+struct map
 {
-   const char *       str;  /* valid in an entry */
-   struct list_share *last; /* valid in header */
-   struct list_share *next;
+   struct map_entry *first;
+   struct map_entry *last;
 };
 
+
 struct http_request
 {
-   char *cmd;
-   char *gpc;
-   char *host;
-   int   port;
-   char *path;
-   char *ver;
-   char *hostport; /* "host[:port]" */
-   int   ssl;
+   char *cmd;      /* Whole command line: method, URL, Version */
+   char *gpc;      /* HTTP method: GET, POST, .. */
+   char *url;      /* The URL */
+   char *ver;      /* Protocol version */
+   int status;     /* HTTP Status */
+
+   char *host;     /* Host part of URL */
+   int   port;     /* Port of URL or 80 (default) */
+   char *path;     /* Path of URL */
+   char *hostport; /* host[:port] */
+   int   ssl;      /* Flag if protocol is https */
+
+   char *host_ip_addr_str; /* String with dotted decimal representation
+                            * of host's IP. NULL before connect_to() */
 };
 
-/* 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) */
 };
-  
-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
 };
+#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
 {
@@ -386,40 +536,55 @@ 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   1 /* Suitable for pcrs filtering */
+#define CT_GIF    2 /* Suitable for GIF filtering */
+#define CT_TABOO  3 /* DONT filter */
 
 #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_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_MOST_COMPATIBLE 0x00000000UL
+
+#define ACTION_BLOCK           0x00000001UL
+#define ACTION_DEANIMATE       0x00000002UL
+#define ACTION_DOWNGRADE       0x00000004UL
+#define ACTION_FAST_REDIRECTS  0x00000008UL
+#define ACTION_FILTER          0x00000010UL
+#define ACTION_HIDE_FORWARDED  0x00000020UL
+#define ACTION_HIDE_FROM       0x00000040UL
+#define ACTION_HIDE_REFERER    0x00000080UL /* sic - follow HTTP, not English */
+#define ACTION_HIDE_USER_AGENT 0x00000100UL
+#define ACTION_IMAGE           0x00000200UL
+#define ACTION_IMAGE_BLOCKER   0x00000400UL
+#define ACTION_NO_COMPRESSION  0x00000800UL
+#define ACTION_NO_COOKIE_KEEP  0x00001000UL
+#define ACTION_NO_COOKIE_READ  0x00002000UL
+#define ACTION_NO_COOKIE_SET   0x00004000UL
+#define ACTION_NO_POPUPS       0x00008000UL
+#define ACTION_VANILLA_WAFER   0x00010000UL
+#define ACTION_LIMIT_CONNECT   0x00020000UL
+
+#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_LIMIT_CONNECT 5
+#define ACTION_STRING_COUNT         6
 
 #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    */
+   unsigned long flags;    /* a bit set to "1" = add action    */
 
    /* For those actions that require parameters: */
 
@@ -430,10 +595,16 @@ 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 */
-   unsigned add;    /* a bit set to "1" = add action    */
+   unsigned long mask;   /* a bit set to "0" = remove action */
+   unsigned long add;    /* a bit set to "1" = add action    */
 
    /* For those actions that require parameters: */
 
@@ -450,6 +621,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];
@@ -460,60 +637,39 @@ struct url_actions
 };
 
 
-/* Constants defining bitmask for csp->accept_types */
-
-#ifdef DETECT_MSIE_IMAGES
-
-/* MSIE detected by user-agent string */
-#define ACCEPT_TYPE_IS_MSIE     0x0001
-
 /*
- * *If* this is MSIE, it wants an image.  (Or this is a shift-reload, or
- * it's got an image from this URL before...  yuck!)
- * Only meaningful if ACCEPT_TYPE_IS_MSIE set 
+ * Flags for use in csp->flags
  */
-#define ACCEPT_TYPE_MSIE_IMAGE  0x0002
+#define CSP_FLAG_ACTIVE     0x01 /* Set if this client is processing data.
+                                  * Cleared when the thread associated with
+                                  * this structure dies. */
+#define CSP_FLAG_CHUNKED    0x02 /* Set if the server's reply is in "chunked"
+                                  * transfer encoding */
+#define CSP_FLAG_FORCED     0x04 /* Set if this request was enforced, although
+                                  * it would normally have been blocked. */
+#define CSP_FLAG_MODIFIED   0x08 /* Set if any modification to the body was done */
+#define CSP_FLAG_REJECTED   0x10 /* Set if request was blocked.  */
+#define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
 
 /*
- * *If* this is MSIE, it wants a HTML document.
- * Only meaningful if ACCEPT_TYPE_IS_MSIE set
+ * The state of a JunkBuster processing thread.
  */
-#define ACCEPT_TYPE_MSIE_HTML   0x0004
-
-#endif /* def DETECT_MSIE_IMAGES */
-
-
 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;
 
    /* 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. 
-    */
-   int  rejected;
-#endif /* def STATISTICS */
-
-#ifdef FORCE_LOAD
-   int force;
-#endif /* def FORCE_LOAD */
-
-#ifdef TOGGLE
-   int   toggled_on;
-#endif /* def TOGGLE */
+   /* Multi-purpose flag container, see CSP_FLAG_* above */
+   unsigned short int flags;
 
    /*
     * Client PC's IP address, as reported by the accept()_ function.
@@ -522,17 +678,13 @@ struct client_state
    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.
-    * Bitmask - see ACCEPT_TYPE_XXX constants.
+   /* Our IP address and hostname, i.e. the IP address that
+      the client used to reach us, and the associated hostname,
+      both as strings
     */
-   int accept_types;
-#endif /* defined(DETECT_MSIE_IMAGES) */
+   char *my_ip_addr_str;
+   char *my_hostname;
 
    /* The URL that was requested */
    struct http_request http[1];
@@ -546,57 +698,51 @@ 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 key, see CT_* above */
+   unsigned short int content_type;
 
    /* 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 *flist;   /* forwardfile */
    struct file_list *actions_list;
 
+   struct file_list *rlist;   /* pcrs job file */
+   size_t content_length;     /* Length after content modification */
 
-#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 */
-
-#ifdef TRUST_FILES
+#ifdef FEATURE_TRUST
    struct file_list *tlist;   /* trustfile */
-#endif /* def TRUST_FILES */
+#endif /* def FEATURE_TRUST */
 
    struct client_state *next;
 };
 
 
+/*
+ * List of functions to run on a list of headers
+ */
 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 *);
 };
 
+
+/*
+ * List of available CGI functions.
+ */
 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 * const name;
+   jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
+   const char * const description;
 };
 
+
+/*
+ * A data file used by JunkBuster.  Kept in a linked list.
+ */
 struct file_list
 {
    /*
@@ -604,11 +750,11 @@ struct file_list
     * Read-only once the structure has been created.
     */
    void *f;
-   
+
    /* Normally NULL.  When we are finished with file (i.e. when we have
     * loaded a new one), set to a pointer to an unloader function.
     * Unloader will be called by sweep() (called from main loop) when
-    * all clients using this file are done.  This prevents threading 
+    * all clients using this file are done.  This prevents threading
     * problems.
     */
    void (*unloader)(void *);
@@ -616,13 +762,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.
     */
@@ -639,34 +778,50 @@ 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 */
+#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;
 };
+#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 */
 
@@ -685,12 +840,17 @@ struct access_control_list
    short action;
    struct access_control_list *next;
 };
-#endif /* def ACL_FILES */
+#endif /* def FEATURE_ACL */
 
 
-/* Maximum number of loaders (actions, block, forward, acl...) */
+/* Maximum number of loaders (actions, re_filter, ...) */
 #define NLOADERS 8
 
+
+#define RUNTIME_FEATURE_CGI_EDIT_ACTIONS  1
+#define RUNTIME_FEATURE_CGI_TOGGLE        2
+
+
 /*
  * Data loaded from the configuration file.
  *
@@ -701,25 +861,27 @@ struct configuration_spec
    int debug;
    int multi_threaded;
 
+   /* Features that can be enabled/disabled throuigh the config file */
+   unsigned feature_flags;
+
    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
+#ifdef FEATURE_COOKIE_JAR
    const char * jarfile;
    FILE * jar;
-#endif /* def JAR_FILES */
+#endif /* def FEATURE_COOKIE_JAR */
 
    /*
     * Port and IP to bind to.
@@ -728,27 +890,24 @@ 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 */
+   /* Size limit for IOB */
+   size_t buffer_limit;
 
-#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 */
 
-   /* Various strings for show-proxy-args */
-   char *proxy_args_header;
-   char *proxy_args_invocation;
-   char *proxy_args_gateways;
-   char *proxy_args_trailer;
+#ifdef FEATURE_ACL
+   struct access_control_list *acl;
+#endif /* def FEATURE_ACL */
+
+   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;
@@ -763,80 +922,31 @@ 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
+#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";
+   "Proxy-Agent: IJ/" VERSION "\r\n\r\n";
 
 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)); }'
- */
+   "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
 
-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) */
+static const char CFORBIDDEN[] =
+   "HTTP/1.0 403 Connection not allowable\r\nX-Hint: If you read this message interactively, then you know why this happens ,-)\r\n\r\n";
 
 #ifdef __cplusplus
 } /* extern "C" */
 #endif
 
-#endif /* ndef _PROJECT_H */
+#endif /* ndef PROJECT_H_INCLUDED */
 
 /*
   Local Variables: