project.h

   1 #ifndef PROJECT_H_INCLUDED
   2 #define PROJECT_H_INCLUDED
   3 #define PROJECT_H_VERSION "$Id: project.h,v 1.63 2002/03/31 17:19:00 jongfoster Exp $"
   4 /*********************************************************************
   5  *
   6  * File        :  $Source: /cvsroot/ijbswa/current/project.h,v $
   7  *
   8  * Purpose     :  Defines data structures which are widely used in the
   9  *                project.  Does not define any variables or functions
  10  *                (though it does declare some macros).
  11  *
  12  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
  13  *                Privoxy team. http://www.privoxy.org/
  14  *
  15  *                Based on the Internet Junkbuster originally written
  16  *                by and Copyright (C) 1997 Anonymous Coders and
  17  *                Junkbusters Corporation.  http://www.junkbusters.com
  18  *
  19  *                This program is free software; you can redistribute it
  20  *                and/or modify it under the terms of the GNU General
  21  *                Public License as published by the Free Software
  22  *                Foundation; either version 2 of the License, or (at
  23  *                your option) any later version.
  24  *
  25  *                This program is distributed in the hope that it will
  26  *                be useful, but WITHOUT ANY WARRANTY; without even the
  27  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  28  *                PARTICULAR PURPOSE.  See the GNU General Public
  29  *                License for more details.
  30  *
  31  *                The GNU General Public License should be included with
  32  *                this file.  If not, you can view it at
  33  *                http://www.gnu.org/copyleft/gpl.html
  34  *                or write to the Free Software Foundation, Inc., 59
  35  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  36  *
  37  * Revisions   :
  38  *    $Log: project.h,v $
  39  *    Revision 1.63  2002/03/31 17:19:00  jongfoster
  40  *    Win32 only: Enabling STRICT to fix a VC++ compile warning.
  41  *
  42  *    Revision 1.62  2002/03/26 22:48:49  swa
  43  *    new homepage url
  44  *
  45  *    Revision 1.61  2002/03/26 22:29:55  swa
  46  *    we have a new homepage!
  47  *
  48  *    Revision 1.60  2002/03/24 15:52:17  jongfoster
  49  *    Changing CGI URL prefixes for new name
  50  *
  51  *    Revision 1.59  2002/03/24 15:23:33  jongfoster
  52  *    Name changes
  53  *
  54  *    Revision 1.58  2002/03/24 13:25:43  swa
  55  *    name change related issues
  56  *
  57  *    Revision 1.57  2002/03/16 20:28:34  oes
  58  *    Added descriptions to the filters so users will know what they select in the cgi editor
  59  *
  60  *    Revision 1.56  2002/03/13 20:27:30  oes
  61  *    Fixing bug with CT_TABOO
  62  *
  63  *    Revision 1.55  2002/03/12 01:42:50  oes
  64  *    Introduced modular filters
  65  *
  66  *    Revision 1.54  2002/03/09 20:03:52  jongfoster
  67  *    - Making various functions return int rather than size_t.
  68  *      (Undoing a recent change).  Since size_t is unsigned on
  69  *      Windows, functions like read_socket that return -1 on
  70  *      error cannot return a size_t.
  71  *
  72  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
  73  *      crashes, and also frequently caused JB to jump to 100%
  74  *      CPU and stay there.  (Because it thought it had just
  75  *      read ((unsigned)-1) == 4Gb of data...)
  76  *
  77  *    - The signature of write_socket has changed, it now simply
  78  *      returns success=0/failure=nonzero.
  79  *
  80  *    - Trying to get rid of a few warnings --with-debug on
  81  *      Windows, I've introduced a new type "jb_socket".  This is
  82  *      used for the socket file descriptors.  On Windows, this
  83  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
  84  *      an int.  The error value can't be -1 any more, so it's
  85  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
  86  *      Windows it maps to the #define INVALID_SOCKET.)
  87  *
  88  *    - The signature of bind_port has changed.
  89  *
  90  *    Revision 1.53  2002/03/08 16:48:55  oes
  91  *    Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
  92  *
  93  *    Revision 1.52  2002/03/07 03:46:17  oes
  94  *    Fixed compiler warnings
  95  *
  96  *    Revision 1.51  2002/03/05 04:52:42  oes
  97  *    Deleted non-errlog debugging code
  98  *
  99  *    Revision 1.50  2002/03/04 19:32:07  oes
 100  *    Changed default port to 8118
 101  *
 102  *    Revision 1.49  2002/03/04 18:28:55  oes
 103  *    Deleted PID_FILE_NAME
 104  *
 105  *    Revision 1.48  2002/03/03 14:50:40  oes
 106  *    Fixed CLF logging: Added ocmd member for client's request to struct http_request
 107  *
 108  *    Revision 1.47  2002/02/20 23:15:13  jongfoster
 109  *    Parsing functions now handle out-of-memory gracefully by returning
 110  *    an error code.
 111  *
 112  *    Revision 1.46  2002/01/17 21:06:09  jongfoster
 113  *    Now #defining the URLs of the config interface
 114  *
 115  *    Minor changes to struct http_request and struct url_spec due to
 116  *    standardizing that struct http_request is used to represent a URL, and
 117  *    struct url_spec is used to represent a URL pattern.  (Before, URLs were
 118  *    represented as seperate variables and a partially-filled-in url_spec).
 119  *
 120  *    Revision 1.45  2002/01/09 14:33:27  oes
 121  *    Added HOSTENT_BUFFER_SIZE
 122  *
 123  *    Revision 1.44  2001/12/30 14:07:32  steudten
 124  *    - Add signal handling (unix)
 125  *    - Add SIGHUP handler (unix)
 126  *    - Add creation of pidfile (unix)
 127  *    - Add action 'top' in rc file (RH)
 128  *    - Add entry 'SIGNALS' to manpage
 129  *    - Add exit message to logfile (unix)
 130  *
 131  *    Revision 1.43  2001/11/22 21:57:51  jongfoster
 132  *    Making action_spec->flags into an unsigned long rather than just an
 133  *    unsigned int.
 134  *    Adding ACTION_NO_COOKIE_KEEP
 135  *
 136  *    Revision 1.42  2001/11/05 21:42:41  steudten
 137  *    Include DBG() macro.
 138  *
 139  *    Revision 1.41  2001/10/28 19:12:06  jongfoster
 140  *    Adding ijb_toupper()
 141  *
 142  *    Revision 1.40  2001/10/26 17:40:47  oes
 143  *    Moved ijb_isspace and ijb_tolower to project.h
 144  *    Removed http->user_agent, csp->referrer and csp->accept_types
 145  *
 146  *    Revision 1.39  2001/10/25 03:45:02  david__schmidt
 147  *    Adding a (void*) cast to freez() because Visual Age C++ won't expand the
 148  *    macro when called with a cast; so moving the cast to the macro def'n
 149  *    seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
 150  *    doesn't make macro expansion complain.  Hope this works for everyone else
 151  *    too...
 152  *
 153  *    Revision 1.38  2001/10/23 21:19:04  jongfoster
 154  *    New error-handling support: jb_err type and JB_ERR_xxx constants
 155  *    CGI functions now return a jb_err, and their parameters map is const.
 156  *    Support for RUNTIME_FEATUREs to enable/disable config editor
 157  *    Adding a few comments
 158  *
 159  *    Revision 1.37  2001/10/14 22:14:01  jongfoster
 160  *    Removing name_length field from struct cgi_dispatcher, as this is
 161  *    now calculated at runtime from the "name" field.
 162  *
 163  *    Revision 1.36  2001/10/10 16:45:15  oes
 164  *    Added LIMIT_CONNECT action and string
 165  *    Fixed HTTP message line termination
 166  *    Added CFORBIDDEN HTTP message
 167  *
 168  *    Revision 1.35  2001/10/07 18:06:43  oes
 169  *    Added status member to struct http_request
 170  *
 171  *    Revision 1.34  2001/10/07 15:45:25  oes
 172  *    Added url member to struct http_request and commented all
 173  *      members
 174  *
 175  *    Added CT_TABOO
 176  *
 177  *    Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
 178  *
 179  *    Replaced struct client_state members rejected,
 180  *      force, active and toggled_on with "flags" bitmap.
 181  *
 182  *    Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
 183  *
 184  *    Added buffer_limit to struct configuration_spec
 185  *
 186  *    Revision 1.33  2001/09/20 13:30:08  steudten
 187  *
 188  *    Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
 189  *    Last case will set z to NULL in free(z) and thats bad..
 190  *
 191  *    Revision 1.32  2001/09/16 23:02:51  jongfoster
 192  *    Fixing warning
 193  *
 194  *    Revision 1.31  2001/09/16 13:20:29  jongfoster
 195  *    Rewrite of list library.  Now has seperate header and list_entry
 196  *    structures.  Also added a large sprinking of assert()s to the list
 197  *    code.
 198  *
 199  *    Revision 1.30  2001/09/13 23:52:00  jongfoster
 200  *    Support for both static and dynamically generated CGI pages
 201  *
 202  *    Revision 1.29  2001/09/13 23:29:43  jongfoster
 203  *    Defining FORWARD_SPEC_INITIALIZER
 204  *
 205  *    Revision 1.28  2001/09/13 23:05:50  jongfoster
 206  *    Changing the string paramater to the header parsers a "const".
 207  *
 208  *    Revision 1.27  2001/08/05 16:06:20  jongfoster
 209  *    Modifiying "struct map" so that there are now separate header and
 210  *    "map_entry" structures.  This means that functions which modify a
 211  *    map no longer need to return a pointer to the modified map.
 212  *    Also, it no longer reverses the order of the entries (which may be
 213  *    important with some advanced template substitutions).
 214  *
 215  *    Revision 1.26  2001/07/30 22:08:36  jongfoster
 216  *    Tidying up #defines:
 217  *    - All feature #defines are now of the form FEATURE_xxx
 218  *    - Permanently turned off WIN_GUI_EDIT
 219  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
 220  *
 221  *    Revision 1.25  2001/07/29 18:43:08  jongfoster
 222  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
 223  *    ANSI C rules.
 224  *
 225  *    Revision 1.24  2001/07/25 17:20:27  oes
 226  *    Introduced http->user_agent
 227  *
 228  *    Revision 1.23  2001/07/18 12:32:23  oes
 229  *    - Added ACTION_STRING_DEANIMATE
 230  *    - moved #define freez from jcc.h to project.h
 231  *
 232  *    Revision 1.22  2001/07/15 17:51:41  jongfoster
 233  *    Renaming #define STATIC to STATIC_PCRE
 234  *
 235  *    Revision 1.21  2001/07/13 14:03:19  oes
 236  *     - Reorganized regex header inclusion and #defines to
 237  *       comply to the scheme in configure.in
 238  *     - Added csp->content_type and its CT_* keys
 239  *     - Added ACTION_DEANIMATE
 240  *     - Removed all #ifdef PCRS
 241  *
 242  *    Revision 1.20  2001/06/29 21:45:41  oes
 243  *    Indentation, CRLF->LF, Tab-> Space
 244  *
 245  *    Revision 1.19  2001/06/29 13:33:36  oes
 246  *    - Improved comments
 247  *    - Introduced http_request.host_ip_addr_str
 248  *    - Introduced http_response.head_length
 249  *    - Introduced config.my_ip_addr_str, config.my_hostname,
 250  *      config.admin_address and config.proxy_info_url
 251  *    - Removed config.proxy_args_header and config.proxy_args_trailer,
 252  *      renamed config.proxy_args_invocation to config.proxy_args
 253  *    - Removed HTML snipplets and GIFs
 254  *    - Removed logentry from cancelled commit
 255  *
 256  *    Revision 1.18  2001/06/09 10:57:39  jongfoster
 257  *    Adding definition of BUFFER_SIZE.
 258  *    Changing struct cgi_dispatcher to use "const" strings.
 259  *
 260  *    Revision 1.17  2001/06/07 23:15:09  jongfoster
 261  *    Merging ACL and forward files into config file.
 262  *    Moving struct gateway members into struct forward_spec
 263  *    Removing config->proxy_args_gateways
 264  *    Cosmetic: Adding a few comments
 265  *
 266  *    Revision 1.16  2001/06/04 18:31:58  swa
 267  *    files are now prefixed with either `confdir' or `logdir'.
 268  *    `make redhat-dist' replaces both entries confdir and logdir
 269  *    with redhat values
 270  *
 271  *    Revision 1.15  2001/06/04 11:28:53  swa
 272  *    redirect did not work due to missing /
 273  *
 274  *    Revision 1.14  2001/06/03 11:03:48  oes
 275  *    Added struct map,
 276  *    added struct http_response,
 277  *    changed struct interceptors to struct cgi_dispatcher,
 278  *    moved HTML stuff to cgi.h
 279  *
 280  *    Revision 1.13  2001/06/01 20:05:36  jongfoster
 281  *    Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
 282  *    constant, and removed csp->tinygif.
 283  *
 284  *    Revision 1.12  2001/06/01 18:49:17  jongfoster
 285  *    Replaced "list_share" with "list" - the tiny memory gain was not
 286  *    worth the extra complexity.
 287  *
 288  *    Revision 1.11  2001/06/01 10:32:47  oes
 289  *    Added constants for anchoring selection bitmap
 290  *
 291  *    Revision 1.10  2001/05/31 21:33:53  jongfoster
 292  *    Changes for new actions file, replacing permissionsfile
 293  *    and parts of the config file.  Also added support for
 294  *    list_shared.
 295  *
 296  *    Revision 1.9  2001/05/31 17:32:31  oes
 297  *
 298  *     - Enhanced domain part globbing with infix and prefix asterisk
 299  *       matching and optional unanchored operation
 300  *
 301  *    Revision 1.8  2001/05/29 20:09:15  joergs
 302  *    HTTP_REDIRECT_TEMPLATE fixed.
 303  *
 304  *    Revision 1.7  2001/05/29 09:50:24  jongfoster
 305  *    Unified blocklist/imagelist/actionslist.
 306  *    File format is still under discussion, but the internal changes
 307  *    are (mostly) done.
 308  *
 309  *    Also modified interceptor behaviour:
 310  *    - We now intercept all URLs beginning with one of the following
 311  *      prefixes (and *only* these prefixes):
 312  *        * http://i.j.b/
 313  *        * http://ijbswa.sf.net/config/
 314  *        * http://ijbswa.sourceforge.net/config/
 315  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
 316  *    - Internal changes so that intercepted and fast redirect pages
 317  *      are not replaced with an image.
 318  *    - Interceptors now have the option to send a binary page direct
 319  *      to the client. (i.e. ijb-send-banner uses this)
 320  *    - Implemented show-url-info interceptor.  (Which is why I needed
 321  *      the above interceptors changes - a typical URL is
 322  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
 323  *      The previous mechanism would not have intercepted that, and
 324  *      if it had been intercepted then it then it would have replaced
 325  *      it with an image.)
 326  *
 327  *    Revision 1.6  2001/05/27 22:17:04  oes
 328  *
 329  *    - re_process_buffer no longer writes the modified buffer
 330  *      to the client, which was very ugly. It now returns the
 331  *      buffer, which it is then written by chat.
 332  *
 333  *    - content_length now adjusts the Content-Length: header
 334  *      for modified documents rather than crunch()ing it.
 335  *      (Length info in csp->content_length, which is 0 for
 336  *      unmodified documents)
 337  *
 338  *    - For this to work, sed() is called twice when filtering.
 339  *
 340  *    Revision 1.5  2001/05/26 00:28:36  jongfoster
 341  *    Automatic reloading of config file.
 342  *    Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
 343  *    Most of the global variables have been moved to a new
 344  *    struct configuration_spec, accessed through csp->config->globalname
 345  *    Most of the globals remaining are used by the Win32 GUI.
 346  *
 347  *    Revision 1.4  2001/05/22 18:46:04  oes
 348  *
 349  *    - Enabled filtering banners by size rather than URL
 350  *      by adding patterns that replace all standard banner
 351  *      sizes with the "Junkbuster" gif to the re_filterfile
 352  *
 353  *    - Enabled filtering WebBugs by providing a pattern
 354  *      which kills all 1x1 images
 355  *
 356  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
 357  *      which is selected by the (nonstandard and therefore
 358  *      capital) letter 'U' in the option string.
 359  *      It causes the quantifiers to be ungreedy by default.
 360  *      Appending a ? turns back to greedy (!).
 361  *
 362  *    - Added a new interceptor ijb-send-banner, which
 363  *      sends back the "Junkbuster" gif. Without imagelist or
 364  *      MSIE detection support, or if tinygif = 1, or the
 365  *      URL isn't recognized as an imageurl, a lame HTML
 366  *      explanation is sent instead.
 367  *
 368  *    - Added new feature, which permits blocking remote
 369  *      script redirects and firing back a local redirect
 370  *      to the browser.
 371  *      The feature is conditionally compiled, i.e. it
 372  *      can be disabled with --disable-fast-redirects,
 373  *      plus it must be activated by a "fast-redirects"
 374  *      line in the config file, has its own log level
 375  *      and of course wants to be displayed by show-proxy-args
 376  *      Note: Boy, all the #ifdefs in 1001 locations and
 377  *      all the fumbling with configure.in and acconfig.h
 378  *      were *way* more work than the feature itself :-(
 379  *
 380  *    - Because a generic redirect template was needed for
 381  *      this, tinygif = 3 now uses the same.
 382  *
 383  *    - Moved GIFs, and other static HTTP response templates
 384  *      to project.h
 385  *
 386  *    - Some minor fixes
 387  *
 388  *    - Removed some >400 CRs again (Jon, you really worked
 389  *      a lot! ;-)
 390  *
 391  *    Revision 1.3  2001/05/20 01:21:20  jongfoster
 392  *    Version 2.9.4 checkin.
 393  *    - Merged popupfile and cookiefile, and added control over PCRS
 394  *      filtering, in new "actionsfile".
 395  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
 396  *      file error you now get a message box (in the Win32 GUI) rather
 397  *      than the program exiting with no explanation.
 398  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
 399  *      skipping.
 400  *    - Removed tabs from "config"
 401  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
 402  *    - Bumped up version number.
 403  *
 404  *    Revision 1.2  2001/05/17 23:01:01  oes
 405  *     - Cleaned CRLF's from the sources and related files
 406  *
 407  *    Revision 1.1.1.1  2001/05/15 13:59:03  oes
 408  *    Initial import of version 2.9.3 source tree
 409  *
 410  *
 411  *********************************************************************/
 412 \f
 413
 414 /* Declare struct FILE for vars and funcs. */
 415 #include <stdio.h>
 416
 417 /* Need time_t for file_list */
 418 #include <time.h>
 419
 420 /*
 421  * Include appropriate regular expression libraries.
 422  * Note that pcrs and pcre (native) are needed for cgi
 423  * and are included anyway.
 424  */
 425
 426 #if defined(REGEX_PCRE)
 427 # define REGEX
 428 #endif /* defined(REGEX_PCRE) */
 429
 430 #ifdef STATIC_PCRE
 431 #  include "pcre.h"
 432 #else
 433 #  include <pcre.h>
 434 #endif
 435
 436 #ifdef STATIC_PCRS
 437 #  include "pcrs.h"
 438 #else
 439 #  include <pcrs.h>
 440 #endif
 441
 442 #if defined(REGEX_PCRE)
 443 #  ifdef STATIC_PCRE
 444 #    include "pcreposix.h"
 445 #  else
 446 #    include <pcreposix.h>
 447 #  endif
 448 #endif /* defined(REGEX_PCRE) */
 449
 450 #ifdef AMIGA
 451 #include "amiga.h"
 452 #endif /* def AMIGA */
 453
 454 #ifdef _WIN32
 455 /*
 456  * I don't want to have to #include all this just for the declaration
 457  * of SOCKET.  However, it looks like we have to...
 458  */
 459 #ifndef STRICT
 460 #define STRICT
 461 #endif
 462 #include <windows.h>
 463 #endif
 464
 465
 466 #ifdef __cplusplus
 467 extern "C" {
 468 #endif
 469
 470 /*
 471  * The type used by sockets.  On UNIX it's an int.  Microsoft decided to
 472  * make it an unsigned.
 473  */
 474 #ifdef _WIN32
 475 typedef SOCKET jb_socket;
 476 #define JB_INVALID_SOCKET INVALID_SOCKET
 477 #else /* ndef _WIN32 */
 478 typedef int jb_socket;
 479 #define JB_INVALID_SOCKET (-1)
 480 #endif /* ndef _WIN32 */
 481
 482
 483 /*
 484  * Error codes.  Functions returning these should return a jb_err
 485  */
 486 #define JB_ERR_OK         0 /* Success, no error                        */
 487 #define JB_ERR_MEMORY     1 /* Out of memory                            */
 488 #define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters        */
 489 #define JB_ERR_FILE       3 /* Error opening, reading or writing a file */
 490 #define JB_ERR_PARSE      4 /* Error parsing file                       */
 491 #define JB_ERR_MODIFIED   5 /* File has been modified outside of the    */
 492                             /* CGI actions editor.                      */
 493 typedef int jb_err;
 494
 495
 496 /*
 497  * This macro is used to free a pointer that may be NULL
 498  */
 499 #define freez(X)  { if(X) { free((void*)X); X = NULL ; } }
 500
 501
 502 /* Fix a problem with Solaris.  There should be no effect on other
 503  * platforms.
 504  * Solaris's isspace() is a macro which uses it's argument directly
 505  * as an array index.  Therefore we need to make sure that high-bit
 506  * characters generate +ve values, and ideally we also want to make
 507  * the argument match the declared parameter type of "int".
 508  *
 509  * Note: Remember to #include <ctype.h> if you use these macros.
 510  */
 511 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
 512 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
 513 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
 514
 515 /*
 516  * Use for statically allocated buffers if you have no other choice.
 517  * Remember to check the length of what you write into the buffer
 518  * - we don't want any buffer overflows!
 519  */
 520 #define BUFFER_SIZE 5000
 521
 522 /*
 523  * Buffer size for capturing struct hostent data in the
 524  * gethostby(name|addr)_r library calls. Since we don't
 525  * loop over gethostbyname_r, the buffer must be sufficient
 526  * to accomodate multiple IN A RRs, as used in DNS round robin
 527  * load balancing. W3C's wwwlib uses 1K, so that should be
 528  * good enough for us, too.
 529  */
 530 #define HOSTENT_BUFFER_SIZE 1024
 531
 532 /*
 533  * So you can say "while (FOREVER) { ...do something... }"
 534  */
 535 #define FOREVER 1
 536
 537 /* Default IP and port to listen on */
 538 #define HADDR_DEFAULT   "127.0.0.1"
 539 #define HADDR_PORT      8118
 540
 541 /* Forward defs for various structures */
 542
 543 /* Need this for struct client_state */
 544 struct configuration_spec;
 545
 546
 547 /* Generic linked list of strings */
 548
 549 struct list_entry
 550 {
 551    const char *str;
 552    struct list_entry *next;
 553 };
 554
 555 struct list
 556 {
 557    struct list_entry *first;
 558    struct list_entry *last;
 559 };
 560
 561
 562 /* A map from a string to another string */
 563
 564 struct map_entry
 565 {
 566    const char *name;
 567    const char *value;
 568    struct map_entry *next;
 569 };
 570
 571 struct map
 572 {
 573    struct map_entry *first;
 574    struct map_entry *last;
 575 };
 576
 577
 578 struct http_request
 579 {
 580    char *cmd;      /* Whole command line: method, URL, Version */
 581    char *ocmd;     /* Backup of original cmd for CLF logging */
 582    char *gpc;      /* HTTP method: GET, POST, .. */
 583    char *url;      /* The URL */
 584    char *ver;      /* Protocol version */
 585    int status;     /* HTTP Status */
 586
 587    char *host;     /* Host part of URL */
 588    int   port;     /* Port of URL or 80 (default) */
 589    char *path;     /* Path of URL */
 590    char *hostport; /* host[:port] */
 591    int   ssl;      /* Flag if protocol is https */
 592
 593    char *host_ip_addr_str; /* String with dotted decimal representation
 594                             * of host's IP. NULL before connect_to() */
 595
 596    char  *dbuffer;     /* Buffer with '\0'-delimited domain name.           */
 597    char **dvec;        /* List of pointers to the strings in dbuffer.       */
 598    int    dcount;      /* How many parts to this domain? (length of dvec)   */
 599 };
 600
 601 /*
 602  * Response generated by CGI, blocker, or error handler
 603  */
 604 struct http_response
 605 {
 606   char  *status;          /* HTTP status (string) */
 607   struct list headers[1]; /* List of header lines */
 608   char  *head;            /* Formatted http response head */
 609   size_t head_length;     /* Length of http response head */
 610   char  *body;            /* HTTP document body */
 611   size_t content_length;  /* Length of body, REQUIRED if binary body */
 612   int    is_static;       /* Nonzero if the content will never change and
 613                            * should be cached by the brwoser (e.g. images) */
 614 };
 615
 616 /* A URL pattern */
 617 struct url_spec
 618 {
 619    char  *spec;        /* The string which was parsed to produce this       */
 620                        /* url_spec.  Used for debugging or display only.    */
 621
 622    /* Hostname matching, or dbuffer == NULL to match all hosts */
 623    char  *dbuffer;     /* Buffer with '\0'-delimited domain name.           */
 624    char **dvec;        /* List of pointers to the strings in dbuffer.       */
 625    int    dcount;      /* How many parts to this domain? (length of dvec)   */
 626    int    unanchored;  /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT.  */
 627
 628    /* Port matching: */
 629    int   port;         /* The port number, or 0 to match all ports.         */
 630
 631    /* Path matching: */
 632    char *path;         /* The path prefix (if not using regex), or source   */
 633                        /* for the regex.                                    */
 634    int   pathlen;      /* ==strlen(path).  Needed for prefix matching.      */
 635 #ifdef REGEX
 636    regex_t *preg;      /* Regex for matching path part                      */
 637 #endif
 638 };
 639 #ifdef REGEX
 640 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
 641 #else /* ifndef REGEX */
 642 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0 }
 643 #endif /* ndef REGEX */
 644
 645 /* Constants for host part matching in URLs */
 646 #define ANCHOR_LEFT  1
 647 #define ANCHOR_RIGHT 2
 648
 649
 650 /* An I/O buffer */
 651 struct iob
 652 {
 653    char *buf;
 654    char *cur;
 655    char *eod;
 656 };
 657
 658
 659 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
 660 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
 661
 662 /* Bits for csp->content_type */
 663 #define CT_TEXT   1 /* Suitable for pcrs filtering */
 664 #define CT_GIF    2 /* Suitable for GIF filtering */
 665 #define CT_TABOO  4 /* DONT filter */
 666
 667 #define ACTION_MASK_ALL        (~0U)
 668
 669 #define ACTION_MOST_COMPATIBLE 0x00000000UL
 670
 671 #define ACTION_BLOCK           0x00000001UL
 672 #define ACTION_DEANIMATE       0x00000002UL
 673 #define ACTION_DOWNGRADE       0x00000004UL
 674 #define ACTION_FAST_REDIRECTS  0x00000008UL
 675 #define ACTION_HIDE_FORWARDED  0x00000010UL
 676 #define ACTION_HIDE_FROM       0x00000020UL
 677 #define ACTION_HIDE_REFERER    0x00000040UL /* sic - follow HTTP, not English */
 678 #define ACTION_HIDE_USER_AGENT 0x00000080UL
 679 #define ACTION_IMAGE           0x00000100UL
 680 #define ACTION_IMAGE_BLOCKER   0x00000200UL
 681 #define ACTION_NO_COMPRESSION  0x00000400UL
 682 #define ACTION_NO_COOKIE_KEEP  0x00000800UL
 683 #define ACTION_NO_COOKIE_READ  0x00001000UL
 684 #define ACTION_NO_COOKIE_SET   0x00002000UL
 685 #define ACTION_NO_POPUPS       0x00004000UL
 686 #define ACTION_VANILLA_WAFER   0x00008000UL
 687 #define ACTION_LIMIT_CONNECT   0x00010000UL
 688
 689 #define ACTION_STRING_DEANIMATE     0
 690 #define ACTION_STRING_FROM          1
 691 #define ACTION_STRING_IMAGE_BLOCKER 2
 692 #define ACTION_STRING_REFERER       3
 693 #define ACTION_STRING_USER_AGENT    4
 694 #define ACTION_STRING_LIMIT_CONNECT 5
 695 #define ACTION_STRING_COUNT         6
 696
 697 #define ACTION_MULTI_ADD_HEADER     0
 698 #define ACTION_MULTI_WAFER          1
 699 #define ACTION_MULTI_FILTER         2
 700 #define ACTION_MULTI_COUNT          3
 701
 702
 703 /*
 704  * This structure contains a list of actions to apply to a URL.
 705  * It only contains positive instructions - no "-" options.
 706  * It is not used to store the actions list itself, only for
 707  * url_actions() to return the current values.
 708  */
 709 struct current_action_spec
 710 {
 711    unsigned long flags;    /* a bit set to "1" = add action    */
 712
 713    /* For those actions that require parameters: */
 714
 715    /* each entry is valid if & only if corresponding entry in "add" set. */
 716    char * string[ACTION_STRING_COUNT];
 717
 718    /* Strings to add */
 719    struct list multi[ACTION_MULTI_COUNT][1];
 720 };
 721
 722
 723 /*
 724  * This structure contains a set of changes to actions.
 725  * It can contain both positive and negative instructions.
 726  * It is used to store an entry in the actions list.
 727  */
 728 struct action_spec
 729 {
 730    unsigned long mask;   /* a bit set to "0" = remove action */
 731    unsigned long add;    /* a bit set to "1" = add action    */
 732
 733    /* For those actions that require parameters: */
 734
 735    /* each entry is valid if & only if corresponding entry in "add" set. */
 736    char * string[ACTION_STRING_COUNT];
 737
 738    /* Strings to remove. */
 739    struct list multi_remove[ACTION_MULTI_COUNT][1];
 740
 741    /* If nonzero, remove *all* strings. */
 742    int         multi_remove_all[ACTION_MULTI_COUNT];
 743
 744    /* Strings to add */
 745    struct list multi_add[ACTION_MULTI_COUNT][1];
 746 };
 747
 748 /*
 749  * This structure is used to store the actions list.
 750  *
 751  * It contains a URL pattern, and the chages to the actions.
 752  * It is a linked list.
 753  */
 754 struct url_actions
 755 {
 756    struct url_spec url[1];
 757
 758    struct action_spec action[1];
 759
 760    struct url_actions * next;
 761 };
 762
 763
 764 /*
 765  * Flags for use in csp->flags
 766  */
 767 #define CSP_FLAG_ACTIVE     0x01 /* Set if this client is processing data.
 768                                   * Cleared when the thread associated with
 769                                   * this structure dies. */
 770 #define CSP_FLAG_CHUNKED    0x02 /* Set if the server's reply is in "chunked"
 771                                   * transfer encoding */
 772 #define CSP_FLAG_FORCED     0x04 /* Set if this request was enforced, although
 773                                   * it would normally have been blocked. */
 774 #define CSP_FLAG_MODIFIED   0x08 /* Set if any modification to the body was done */
 775 #define CSP_FLAG_REJECTED   0x10 /* Set if request was blocked.  */
 776 #define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */
 777
 778 /*
 779  * The state of a Privoxy processing thread.
 780  */
 781 struct client_state
 782 {
 783    /* The proxy's configuration */
 784    struct configuration_spec * config;
 785
 786    /* The actions to perform on the current request */
 787    struct current_action_spec  action[1];
 788
 789    /* socket to talk to client (web browser) */
 790    jb_socket cfd;
 791
 792    /* socket to talk to server (web server or proxy) */
 793    jb_socket sfd;
 794
 795    /* Multi-purpose flag container, see CSP_FLAG_* above */
 796    unsigned short int flags;
 797
 798    /*
 799     * Client PC's IP address, as reported by the accept()_ function.
 800     * Both as string and number
 801     */
 802    char *ip_addr_str;
 803    long  ip_addr_long;
 804
 805
 806    /* Our IP address and hostname, i.e. the IP address that
 807       the client used to reach us, and the associated hostname,
 808       both as strings
 809     */
 810    char *my_ip_addr_str;
 811    char *my_hostname;
 812
 813    /* The URL that was requested */
 814    struct http_request http[1];
 815
 816    /* An I/O buffer used for buffering data read from the client */
 817    struct iob iob[1];
 818
 819    /* List of all headers for this request */
 820    struct list headers[1];
 821
 822    /* List of all cookies for this request */
 823    struct list cookie_list[1];
 824
 825    /* MIME-Type key, see CT_* above */
 826    unsigned short int content_type;
 827
 828    /* The "X-Forwarded-For:" header sent by the client */
 829    char   *x_forwarded;
 830
 831    /* files associated with this client */
 832    struct file_list *actions_list;
 833
 834    struct file_list *rlist;   /* pcrs job file */
 835    size_t content_length;     /* Length after content modification */
 836
 837 #ifdef FEATURE_TRUST
 838    struct file_list *tlist;   /* trustfile */
 839 #endif /* def FEATURE_TRUST */
 840
 841    struct client_state *next;
 842 };
 843
 844
 845 /*
 846  * A function to add a header
 847  */
 848 typedef jb_err (*add_header_func_ptr)(struct client_state *);
 849
 850 /*
 851  * A function to process a header
 852  */
 853 typedef jb_err (*parser_func_ptr    )(struct client_state *, char **);
 854
 855 /*
 856  * List of functions to run on a list of headers
 857  */
 858 struct parsers
 859 {
 860    char   *str;
 861    size_t len;
 862    parser_func_ptr parser;
 863 };
 864
 865
 866 /*
 867  * List of available CGI functions.
 868  */
 869 struct cgi_dispatcher
 870 {
 871    const char * const name;
 872    jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
 873    const char * const description;
 874 };
 875
 876
 877 /*
 878  * A data file used by Privoxy.  Kept in a linked list.
 879  */
 880 struct file_list
 881 {
 882    /*
 883     * this is a pointer to the data structures associated with the file.
 884     * Read-only once the structure has been created.
 885     */
 886    void *f;
 887
 888    /* Normally NULL.  When we are finished with file (i.e. when we have
 889     * loaded a new one), set to a pointer to an unloader function.
 890     * Unloader will be called by sweep() (called from main loop) when
 891     * all clients using this file are done.  This prevents threading
 892     * problems.
 893     */
 894    void (*unloader)(void *);
 895
 896    /* Used internally by sweep().  Do not access from elsewhere. */
 897    int active;
 898
 899    /* Following variables allow us to check if file has been changed.
 900     * Read-only once the structure has been created.
 901     */
 902    time_t lastmodified;
 903    char * filename;
 904
 905    /* Pointer to next entry in the linked list of all "file_list"s.
 906     * This linked list is so that sweep() can navigate it.
 907     * Since sweep() can remove items from the list, we must be careful
 908     * to only access this value from main thread (when we know sweep
 909     * won't be running).
 910     */
 911    struct file_list *next;
 912 };
 913
 914
 915 #ifdef FEATURE_TRUST
 916 struct block_spec
 917 {
 918    struct url_spec url[1];
 919    int    reject;
 920    struct block_spec *next;
 921 };
 922 #endif /* def FEATURE_TRUST */
 923
 924
 925 #define SOCKS_NONE    0    /* Don't use a SOCKS server */
 926 #define SOCKS_4      40    /* original SOCKS 4 protocol */
 927 #define SOCKS_4A     41    /* as modified for hosts w/o external DNS */
 928
 929 struct forward_spec
 930 {
 931    struct url_spec url[1];
 932
 933    /* Connection type - must be a SOCKS_xxx constant */
 934    int   type;
 935
 936    /* SOCKS server */
 937    char *gateway_host;
 938    int   gateway_port;
 939
 940    /* Parent HTTP proxy */
 941    char *forward_host;
 942    int   forward_port;
 943
 944    /* For the linked list */
 945    struct forward_spec *next;
 946 };
 947 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
 948
 949
 950 /*
 951  * This struct represents one filter (one block) from
 952  * the re_filterfile. If there is more than one filter
 953  * in the file, the file will be represented by a
 954  * chained list of re_filterfile specs.
 955  */
 956 struct re_filterfile_spec
 957 {
 958    char *name;                      /* Name from FILTER: statement in re_filterfile */
 959    char *description;               /* Description from FILTER: statement in re_filterfile */
 960    struct list patterns[1];         /* The patterns from the re_filterfile */
 961    pcrs_job *joblist;               /* The resulting compiled pcrs_jobs */
 962    struct re_filterfile_spec *next; /* The pointer for chaining */
 963 };
 964
 965 #ifdef FEATURE_ACL
 966 #define ACL_PERMIT   1  /* accept connection request */
 967 #define ACL_DENY     2  /* reject connection request */
 968
 969 struct access_control_addr
 970 {
 971    unsigned long addr;
 972    unsigned long mask;
 973    unsigned long port;
 974 };
 975
 976 struct access_control_list
 977 {
 978    struct access_control_addr src[1];
 979    struct access_control_addr dst[1];
 980
 981    short action;
 982    struct access_control_list *next;
 983 };
 984 #endif /* def FEATURE_ACL */
 985
 986
 987 /* Maximum number of loaders (actions, re_filter, ...) */
 988 #define NLOADERS 8
 989
 990
 991 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS  1
 992 #define RUNTIME_FEATURE_CGI_TOGGLE        2
 993
 994
 995 /*
 996  * Data loaded from the configuration file.
 997  *
 998  * (Anomaly: toggle is still handled through a global, not this structure)
 999  */
1000 struct configuration_spec
1001 {
1002    int debug;
1003    int multi_threaded;
1004
1005    /* Features that can be enabled/disabled throuigh the config file */
1006    unsigned feature_flags;
1007
1008    const char *logfile;
1009
1010    const char *confdir;
1011    const char *logdir;
1012    const char *actions_file;
1013
1014    /* The administrator's email address */
1015    char *admin_address;
1016
1017    /* A URL with info on this proxy */
1018    char *proxy_info_url;
1019
1020    const char *re_filterfile;
1021
1022 #ifdef FEATURE_COOKIE_JAR
1023    const char * jarfile;
1024    FILE * jar;
1025 #endif /* def FEATURE_COOKIE_JAR */
1026
1027    /*
1028     * Port and IP to bind to.
1029     * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118
1030     */
1031    const char *haddr;
1032    int         hport;
1033
1034    /* Size limit for IOB */
1035    size_t buffer_limit;
1036
1037 #ifdef FEATURE_TRUST
1038    const char * trustfile;
1039
1040    struct list trust_info[1];
1041    struct url_spec *trust_list[64];
1042 #endif /* def FEATURE_TRUST */
1043
1044 #ifdef FEATURE_ACL
1045    struct access_control_list *acl;
1046 #endif /* def FEATURE_ACL */
1047
1048    struct forward_spec *forward;
1049
1050    /* All options from the config file, HTML-formatted */
1051    char *proxy_args;
1052
1053    /* the configuration file object. */
1054    struct file_list *config_file_list;
1055
1056    /* List of loaders */
1057    int (*loaders[NLOADERS])(struct client_state *);
1058
1059    /* bool, nonzero if we need to bind() to the new port */
1060    int need_bind;
1061 };
1062
1063
1064 #define SZ(X)  (sizeof(X) / sizeof(*X))
1065
1066 #ifdef FEATURE_FORCE_LOAD
1067 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1068 #endif /* def FEATURE_FORCE_LOAD */
1069
1070 #ifdef FEATURE_NO_GIFS
1071 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1072 #else
1073 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1074 #endif /* def FEATURE_NO_GIFS */
1075
1076
1077 /* Hardwired URLs */
1078 #define HOME_PAGE_URL       "http://www.privoxy.org"
1079 #define REDIRECT_URL        HOME_PAGE_URL "/redirect.php?v=" VERSION "&to="
1080
1081 /*
1082  * The "hosts" to intercept and display CGI pages.
1083  * First one is a hostname only, second one can specify host and path.
1084  *
1085  * Notes:
1086  * 1) Do not specify the http: prefix
1087  * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1088  * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1089  */
1090 #define CGI_SITE_1_HOST "p.p"
1091 #define CGI_SITE_2_HOST "config.privoxy.org"
1092 #define CGI_SITE_2_PATH ""
1093
1094 /*
1095  * The prefix for CGI pages.  Written out in generated HTML.
1096  * INCLUDES the trailing slash.
1097  */
1098 #define CGI_PREFIX  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1099
1100
1101 /* HTTP snipplets */
1102 static const char CSUCCEED[] =
1103    "HTTP/1.0 200 Connection established\n"
1104    "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1105
1106 static const char CHEADER[] =
1107    "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1108
1109 static const char CFORBIDDEN[] =
1110    "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";
1111
1112 #ifdef __cplusplus
1113 } /* extern "C" */
1114 #endif
1115
1116 #endif /* ndef PROJECT_H_INCLUDED */
1117
1118 /*
1119   Local Variables:
1120   tab-width: 3
1121   end:
1122 */