added struct map, added struct http_response, changed struct interceptors to struct...
[privoxy.git] / project.h
index 2263285..2eb1d00 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.6 2001/05/27 22:17:04 oes Exp $"
+#define PROJECT_H_VERSION "$Id: project.h,v 1.14 2001/06/03 11:03:48 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
+ *
+ *    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
+ *    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.
+ *
+ *    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
  *    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.
@@ -185,6 +286,29 @@ 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;
+};
+
+
+/* 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
 {
@@ -198,6 +322,16 @@ struct http_request
    int   ssl;
 };
 
+/* CGI or blocker generated response */
+struct http_response
+{
+  char *status;             /* HTTP status */
+  struct list headers[1]; /* List of header lines */
+  int content_length;     /* Length of body, REQUIRED if binary body*/
+  char *head;             /* Formatted http response head */
+  char *body;             /* HTTP document body */
+};
+  
 struct gateway
 {
    /* generic attributes */
@@ -214,14 +348,28 @@ struct gateway
 };
 
 
-/* Generic linked list of strings */
-struct list
+/* A URL pattern */
+struct url_spec
 {
-   char *str;
-   struct list *last;
-   struct list *next;
+   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
@@ -236,6 +384,79 @@ 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 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_MULTI_ADD_HEADER     0
+#define ACTION_MULTI_WAFER          1
+#define ACTION_MULTI_COUNT          2
+
+
+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];
+};
+
+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 */
 
 #ifdef DETECT_MSIE_IMAGES
@@ -265,8 +486,8 @@ struct client_state
    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) */
@@ -338,7 +559,7 @@ struct client_state
 
    /* files associated with this client */
    struct file_list *flist;   /* forwardfile */
-   struct file_list *permissions_list;
+   struct file_list *actions_list;
 
 
 #ifdef ACL_FILES
@@ -365,34 +586,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
+   char *name;
+   int   name_length;
+   int   (*handler)(struct client_state *csp, struct http_response *rsp, struct map *parameters);
+   char *description;
 };
 
-
 struct file_list
 {
    /*
@@ -445,31 +646,6 @@ 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)
-
-struct permissions_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;
-};
-
-
 struct forward_spec
 {
    struct url_spec url[1];
@@ -482,7 +658,6 @@ struct forward_spec
 struct re_filterfile_spec
 {
    struct list patterns[1];
-   /* See README.re_filter */
    pcrs_job *joblist;
 };
 #endif /* def PCRS */
@@ -510,7 +685,7 @@ 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
 
 /*
@@ -523,14 +698,10 @@ 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 *confdir;
+   const char *actions_file;
    const char *forwardfile;
 
 #ifdef ACL_FILES
@@ -541,25 +712,11 @@ struct configuration_spec
    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
@@ -610,54 +767,11 @@ struct configuration_spec
 #define FORCE_PREFIX "/IJB-FORCE-LOAD"
 #endif /* def FORCE_LOAD */
 
-#define HOME_PAGE_URL  "http://ijbswa.sourceforge.net/"
+/* Shouldn't end with '/' */
+#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"
-   "<html>\n"
-   "<head>\n"
-   "<title>Internet Junkbuster: Connect failed</title>\n"
-   "</head>\n"
-   BODY
-   "<h1><center>"
-   BANNER
-   "</center></h1>"
-   "TCP connection to '%s' failed: %s.\n<br>"
-   "</body>\n"
-   "</html>\n";
-
-static const char CNXDOM[] =
-   "HTTP/1.0 404 Non-existent domain\n"
-   "Content-Type: text/html\n\n"
-   "<html>\n"
-   "<head>\n"
-   "<title>Internet Junkbuster: Non-existent domain</title>\n"
-   "</head>\n"
-   BODY
-   "<h1><center>"
-   BANNER
-   "</center></h1>"
-   "No such domain: %s\n"
-   "</body>\n"
-   "</html>\n";
-
-static const char CNOBANNER[] =
-   "HTTP/1.0 200 No Banner\n"
-   "Content-Type: text/html\n\n"
-   "<html>\n"
-   "<head>\n"
-   "<title>Internet Junkbuster: No Banner</title>\n"
-   "</head>\n"
-   BODY
-   "<h1><center>"
-   BANNER
-   "</h1>"
-   "You asked for a banner that this proxy can't produce because either configuration does not permit.\n<br>"
-   "or the URL didn't end with .gif\n"
-   "</center></body>\n"
-   "</html>\n";
+#define CGI_PREFIX_HOST "i.j.b"
 
 static const char CSUCCEED[] =
    "HTTP/1.0 200 Connection established\n"
@@ -710,7 +824,7 @@ static const char HTTP_REDIRECT_TEMPLATE[] =
       "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(FAST_REDIRECTS) || defined(IMAGE_BLOCKING) */