HTTP_REDIRECT_TEMPLATE fixed.
[privoxy.git] / project.h
index 5f4324a..281205b 100644 (file)
--- a/project.h
+++ b/project.h
@@ -1,9 +1,9 @@
 #ifndef _PROJECT_H
 #define _PROJECT_H
-#define PROJECT_H_VERSION "$Id: project.h,v 1.1 2001/05/13 21:57:07 administrator Exp $"
+#define PROJECT_H_VERSION "$Id: project.h,v 1.7 2001/05/29 09:50:24 jongfoster Exp $"
 /*********************************************************************
  *
- * File        :  $Source: /home/administrator/cvs/ijb/project.h,v $
+ * File        :  $Source: /cvsroot/ijbswa/current/project.h,v $
  *
  * Purpose     :  Defines data structures which are widely used in the
  *                project.  Does not define any variables or functions
  *
  * Revisions   :
  *    $Log: project.h,v $
+ *    Revision 1.7  2001/05/29 09:50:24  jongfoster
+ *    Unified blocklist/imagelist/permissionslist.
+ *    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
+ *      by adding patterns that replace all standard banner
+ *      sizes with the "Junkbuster" gif to the re_filterfile
+ *
+ *    - Enabled filtering WebBugs by providing a pattern
+ *      which kills all 1x1 images
+ *
+ *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
+ *      which is selected by the (nonstandard and therefore
+ *      capital) letter 'U' in the option string.
+ *      It causes the quantifiers to be ungreedy by default.
+ *      Appending a ? turns back to greedy (!).
+ *
+ *    - Added a new interceptor ijb-send-banner, which
+ *      sends back the "Junkbuster" gif. Without imagelist or
+ *      MSIE detection support, or if tinygif = 1, or the
+ *      URL isn't recognized as an imageurl, a lame HTML
+ *      explanation is sent instead.
+ *
+ *    - Added new feature, which permits blocking remote
+ *      script redirects and firing back a local redirect
+ *      to the browser.
+ *      The feature is conditionally compiled, i.e. it
+ *      can be disabled with --disable-fast-redirects,
+ *      plus it must be activated by a "fast-redirects"
+ *      line in the config file, has its own log level
+ *      and of course wants to be displayed by show-proxy-args
+ *      Note: Boy, all the #ifdefs in 1001 locations and
+ *      all the fumbling with configure.in and acconfig.h
+ *      were *way* more work than the feature itself :-(
+ *
+ *    - Because a generic redirect template was needed for
+ *      this, tinygif = 3 now uses the same.
+ *
+ *    - Moved GIFs, and other static HTTP response templates
+ *      to project.h
+ *
+ *    - Some minor fixes
+ *
+ *    - Removed some >400 CRs again (Jon, you really worked
+ *      a lot! ;-)
+ *
+ *    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".
+ *    - 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.
+ *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
+ *      skipping.
+ *    - Removed tabs from "config"
+ *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
+ *    - Bumped up version number.
+ *
+ *    Revision 1.2  2001/05/17 23:01:01  oes
+ *     - Cleaned CRLF's from the sources and related files
+ *
+ *    Revision 1.1.1.1  2001/05/15 13:59:03  oes
+ *    Initial import of version 2.9.3 source tree
+ *
  *
  *********************************************************************/
 \f
@@ -99,6 +205,9 @@ extern "C" {
 /* Need this for struct gateway */
 struct client_state;
 
+/* Need this for struct client_state */
+struct configuration_spec;
+
 
 struct http_request
 {
@@ -112,7 +221,6 @@ struct http_request
    int   ssl;
 };
 
-
 struct gateway
 {
    /* generic attributes */
@@ -129,15 +237,16 @@ struct gateway
 };
 
 
-struct proxy_args
+/* Generic linked list of strings */
+struct list
 {
-   char *header;
-   char *invocation;
-   char *gateways;
-   char *trailer;
+   char *str;
+   struct list *last;
+   struct list *next;
 };
 
 
+/* An I/O buffer */
 struct iob
 {
    char *buf;
@@ -146,13 +255,6 @@ struct iob
 };
 
 
-struct list
-{
-   char *str;
-   struct list *last;
-   struct list *next;
-};
-
 #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));
 
@@ -182,11 +284,21 @@ struct list
 
 struct client_state
 {
-   int  send_user_cookie;
-   int  accept_server_cookie;
+   /* The proxy's configuration */
+   struct configuration_spec * config;
+
+
+   /* The permissions that the current URL has */
+   int  permissions;
+
+
+   /* 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. 
@@ -199,17 +311,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.
@@ -218,40 +333,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];
-#ifdef PCRS
+
+#if defined(PCRS) || defined(KILLPOPUPS)
+   /* Nonzero if this has a text MIME type */
    int is_text;
-#endif /* def PCRS */
+#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 *clist;   /* cookiefile */
    struct file_list *flist;   /* forwardfile */
+   struct file_list *permissions_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 KILLPOPUPS
-   struct file_list *plist;   /* kill popup file */
-#endif /* def KILLPOPUPS */
-
 #ifdef PCRS
      struct file_list *rlist;   /* Perl re_filterfile */
+     size_t content_length;     /* Length after processing */ 
 #endif /* def PCRS */
 
 #ifdef TRUST_FILES
@@ -278,8 +397,7 @@ struct interceptors
 };
 
 
-/* this allows the proxy to permit/block access to any host and/or path */
-
+/* A URL pattern */
 struct url_spec
 {
    char  *spec;
@@ -340,27 +458,44 @@ struct file_list
 };
 
 
+#ifdef TRUST_FILES
 struct block_spec
 {
    struct url_spec url[1];
-   int   reject;
+   int    reject;
    struct block_spec *next;
 };
+#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)
 
-struct cookie_spec
+#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];
-   int   send_user_cookie;
-   int   accept_server_cookie;
-   struct cookie_spec *next;
+   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];
-   int   reject;
    struct gateway gw[1];
    struct forward_spec *next;
 };
@@ -376,22 +511,6 @@ struct re_filterfile_spec
 #endif /* def PCRS */
 
 
-#ifdef KILLPOPUPS
-/* Entries on popup blocklist */
-struct popup_blocklist
-{
-   char *host_name;
-   struct popup_blocklist *next;
-};
-
-/* Actual type used in file object */
-struct popup_settings
-{
-   struct popup_blocklist *blocked;
-   struct popup_blocklist *allowed;
-};
-#endif /* def KILLPOPUPS */
-
 #ifdef ACL_FILES
 #define ACL_PERMIT   1  /* accept connection request */
 #define ACL_DENY     2  /* reject connection request */
@@ -413,6 +532,97 @@ struct access_control_list
 };
 #endif /* def ACL_FILES */
 
+
+/* Maximum number of loaders (permissions, block, forward, acl...) */
+#define NLOADERS 8
+
+/*
+ * Data loaded from the configuration file.
+ *
+ * (Anomaly: toggle is still handled through a global, not this structure)
+ */
+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;
+
+#ifdef ACL_FILES
+   const char *aclfile;
+#endif /* def ACL_FILES */
+
+#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
+    */
+   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 */
+
+#ifdef TRUST_FILES
+   const char * trustfile;
+
+   struct list trust_info[1];
+   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;
+
+   /* the configuration file object. */
+   struct file_list *config_file_list;
+
+   /* List of loaders */
+   int (*loaders[NLOADERS])(struct client_state *);
+
+   /* bool, nonzero if we need to bind() to the new port */
+   int need_bind;
+};
+
+
 #define SZ(X)  (sizeof(X) / sizeof(*X))
 
 #define WHITEBG   "<body bgcolor=\"#ffffff\" link=\"#000078\" alink=\"#ff0022\" vlink=\"#787878\">\n"
@@ -420,20 +630,113 @@ struct access_control_list
 #define BANNER    "<strong>Internet J<small>UNK<i><font color=\"red\">BUSTER</font></i></small></strong>"
 
 #ifdef FORCE_LOAD
-/*\r
- * FIXME: Unfortunately, IE lowercases the domain name.  JunkBuster does\r
- * a case-sensitive compare.  JunkBuster should be modified to do a\r
- * case-insensitive compatison.  As a temporary workaround, I've lowercased\r
- * the FORCE_PREFIX.\r
- *\r
- * #define FORCE_PREFIX "IJB-FORCE-LOAD-"\r
- */\r
-#define FORCE_PREFIX "ijb-force-load-"\r
+#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"
+   "<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";
+
+static const char CSUCCEED[] =
+   "HTTP/1.0 200 Connection established\n"
+   "Proxy-Agent: IJ/" VERSION "\n\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)); }'
+ */
+
+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