project.h

   1 #ifndef PROJECT_H_INCLUDED
   2 #define PROJECT_H_INCLUDED
   3 /** Version string. */
   4 #define PROJECT_H_VERSION "$Id: project.h,v 1.77 2006/08/21 12:50:51 david__schmidt Exp $"
   5 /*********************************************************************
   6  *
   7  * File        :  $Source: /cvsroot/ijbswa/current/project.h,v $
   8  *
   9  * Purpose     :  Defines data structures which are widely used in the
  10  *                project.  Does not define any variables or functions
  11  *                (though it does declare some macros).
  12  *
  13  * Copyright   :  Written by and Copyright (C) 2001 - 2004 the SourceForge
  14  *                Privoxy team. http://www.privoxy.org/
  15  *
  16  *                Based on the Internet Junkbuster originally written
  17  *                by and Copyright (C) 1997 Anonymous Coders and
  18  *                Junkbusters Corporation.  http://www.junkbusters.com
  19  *
  20  *                This program is free software; you can redistribute it
  21  *                and/or modify it under the terms of the GNU General
  22  *                Public License as published by the Free Software
  23  *                Foundation; either version 2 of the License, or (at
  24  *                your option) any later version.
  25  *
  26  *                This program is distributed in the hope that it will
  27  *                be useful, but WITHOUT ANY WARRANTY; without even the
  28  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  29  *                PARTICULAR PURPOSE.  See the GNU General Public
  30  *                License for more details.
  31  *
  32  *                The GNU General Public License should be included with
  33  *                this file.  If not, you can view it at
  34  *                http://www.gnu.org/copyleft/gpl.html
  35  *                or write to the Free Software Foundation, Inc., 59
  36  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  37  *
  38  * Revisions   :
  39  *    $Log: project.h,v $
  40  *    Revision 1.77  2006/08/21 12:50:51  david__schmidt
  41  *    Formatting cleanup
  42  *
  43  *    Revision 1.76  2006/08/14 08:25:19  fabiankeil
  44  *    Split filter-headers{} into filter-client-headers{}
  45  *    and filter-server-headers{}.
  46  *    Added parse_header_time() to share some code.
  47  *    Replaced timegm() with mktime().
  48  *
  49  *    Revision 1.75  2006/08/03 02:46:41  david__schmidt
  50  *    Incorporate Fabian Keil's patch work:\r *    http://www.fabiankeil.de/sourcecode/privoxy/
  51  *
  52  *    Revision 1.74  2006/07/18 14:48:47  david__schmidt
  53  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
  54  *    with what was really the latest development (the v_3_0_branch branch)
  55  *
  56  *    Revision 1.72.2.7  2006/01/29 23:10:56  david__schmidt
  57  *    Multiple filter file support
  58  *
  59  *    Revision 1.72.2.6  2004/10/03 12:53:46  david__schmidt
  60  *    Add the ability to check jpeg images for invalid
  61  *    lengths of comment blocks.  Defensive strategy
  62  *    against the exploit:
  63  *       Microsoft Security Bulletin MS04-028
  64  *       Buffer Overrun in JPEG Processing (GDI+) Could
  65  *       Allow Code Execution (833987)
  66  *    Enabled with +inspect-jpegs in actions files.
  67  *
  68  *    Revision 1.72.2.5  2004/01/30 15:29:29  oes
  69  *    Updated the copyright note
  70  *
  71  *    Revision 1.72.2.4  2004/01/13 16:12:14  oes
  72  *    Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
  73  *
  74  *    Revision 1.72.2.3  2003/03/11 11:54:37  oes
  75  *    Introduced RC_FLAG_* flags for use in child process return code
  76  *
  77  *    Revision 1.72.2.2  2002/11/28 18:15:44  oes
  78  *    Added flag to each cgi_dispatcher that allows or denies
  79  *    external linking and removed const qualifier from
  80  *    struct list_entry.str.
  81  *
  82  *    Revision 1.72.2.1  2002/08/10 11:25:18  oes
  83  *    - Include config.h for access to config data
  84  *    - Include <pcre*.h> depending on where they are
  85  *
  86  *    Revision 1.72  2002/05/14 21:35:49  oes
  87  *    Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
  88  *    because of split in user-manual
  89  *
  90  *    Revision 1.71  2002/05/12 21:39:36  jongfoster
  91  *    - Adding Doxygen-style comments to structures and #defines.
  92  *
  93  *    Revision 1.70  2002/05/12 16:05:50  jongfoster
  94  *    Fixing ACTION_MASK_ALL to be unsigned long rather than
  95  *    just unsigned int.  I don't know if anyone is porting
  96  *    Privoxy to 16-bit platforms, but if so, +limit-connect
  97  *    wouldn't have worked because of this bug.
  98  *
  99  *    Revision 1.69  2002/05/08 16:00:16  oes
 100  *    Added size member to struct iob, so it can
 101  *    be alloced larger than needed.
 102  *
 103  *    Revision 1.68  2002/04/26 12:56:00  oes
 104  *    Killed REDIRECT_URL, added USER_MANUAL_URL and HELP_LINK_PREFIX
 105  *
 106  *    Revision 1.67  2002/04/24 02:12:43  oes
 107  *     - Jon's multiple AF patch:
 108  *       - Make csp->actions_list an array
 109  *       - #define MAX_AF_FILES
 110  *     - Moved CGI_PARAM_LEN_MAX (500) here
 111  *
 112  *    Revision 1.66  2002/04/15 19:06:43  jongfoster
 113  *    Typos
 114  *
 115  *    Revision 1.65  2002/04/04 00:36:36  gliptak
 116  *    always use pcre for matching
 117  *
 118  *    Revision 1.64  2002/04/03 22:28:03  gliptak
 119  *    Removed references to gnu_regex
 120  *
 121  *    Revision 1.63  2002/03/31 17:19:00  jongfoster
 122  *    Win32 only: Enabling STRICT to fix a VC++ compile warning.
 123  *
 124  *    Revision 1.62  2002/03/26 22:48:49  swa
 125  *    new homepage url
 126  *
 127  *    Revision 1.61  2002/03/26 22:29:55  swa
 128  *    we have a new homepage!
 129  *
 130  *    Revision 1.60  2002/03/24 15:52:17  jongfoster
 131  *    Changing CGI URL prefixes for new name
 132  *
 133  *    Revision 1.59  2002/03/24 15:23:33  jongfoster
 134  *    Name changes
 135  *
 136  *    Revision 1.58  2002/03/24 13:25:43  swa
 137  *    name change related issues
 138  *
 139  *    Revision 1.57  2002/03/16 20:28:34  oes
 140  *    Added descriptions to the filters so users will know what they select in the cgi editor
 141  *
 142  *    Revision 1.56  2002/03/13 20:27:30  oes
 143  *    Fixing bug with CT_TABOO
 144  *
 145  *    Revision 1.55  2002/03/12 01:42:50  oes
 146  *    Introduced modular filters
 147  *
 148  *    Revision 1.54  2002/03/09 20:03:52  jongfoster
 149  *    - Making various functions return int rather than size_t.
 150  *      (Undoing a recent change).  Since size_t is unsigned on
 151  *      Windows, functions like read_socket that return -1 on
 152  *      error cannot return a size_t.
 153  *
 154  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
 155  *      crashes, and also frequently caused JB to jump to 100%
 156  *      CPU and stay there.  (Because it thought it had just
 157  *      read ((unsigned)-1) == 4Gb of data...)
 158  *
 159  *    - The signature of write_socket has changed, it now simply
 160  *      returns success=0/failure=nonzero.
 161  *
 162  *    - Trying to get rid of a few warnings --with-debug on
 163  *      Windows, I've introduced a new type "jb_socket".  This is
 164  *      used for the socket file descriptors.  On Windows, this
 165  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
 166  *      an int.  The error value can't be -1 any more, so it's
 167  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
 168  *      Windows it maps to the #define INVALID_SOCKET.)
 169  *
 170  *    - The signature of bind_port has changed.
 171  *
 172  *    Revision 1.53  2002/03/08 16:48:55  oes
 173  *    Added FEATURE_NO_GIFS and BUILTIN_IMAGE_MIMETYPE
 174  *
 175  *    Revision 1.52  2002/03/07 03:46:17  oes
 176  *    Fixed compiler warnings
 177  *
 178  *    Revision 1.51  2002/03/05 04:52:42  oes
 179  *    Deleted non-errlog debugging code
 180  *
 181  *    Revision 1.50  2002/03/04 19:32:07  oes
 182  *    Changed default port to 8118
 183  *
 184  *    Revision 1.49  2002/03/04 18:28:55  oes
 185  *    Deleted PID_FILE_NAME
 186  *
 187  *    Revision 1.48  2002/03/03 14:50:40  oes
 188  *    Fixed CLF logging: Added ocmd member for client's request to struct http_request
 189  *
 190  *    Revision 1.47  2002/02/20 23:15:13  jongfoster
 191  *    Parsing functions now handle out-of-memory gracefully by returning
 192  *    an error code.
 193  *
 194  *    Revision 1.46  2002/01/17 21:06:09  jongfoster
 195  *    Now #defining the URLs of the config interface
 196  *
 197  *    Minor changes to struct http_request and struct url_spec due to
 198  *    standardizing that struct http_request is used to represent a URL, and
 199  *    struct url_spec is used to represent a URL pattern.  (Before, URLs were
 200  *    represented as seperate variables and a partially-filled-in url_spec).
 201  *
 202  *    Revision 1.45  2002/01/09 14:33:27  oes
 203  *    Added HOSTENT_BUFFER_SIZE
 204  *
 205  *    Revision 1.44  2001/12/30 14:07:32  steudten
 206  *    - Add signal handling (unix)
 207  *    - Add SIGHUP handler (unix)
 208  *    - Add creation of pidfile (unix)
 209  *    - Add action 'top' in rc file (RH)
 210  *    - Add entry 'SIGNALS' to manpage
 211  *    - Add exit message to logfile (unix)
 212  *
 213  *    Revision 1.43  2001/11/22 21:57:51  jongfoster
 214  *    Making action_spec->flags into an unsigned long rather than just an
 215  *    unsigned int.
 216  *    Adding ACTION_NO_COOKIE_KEEP
 217  *
 218  *    Revision 1.42  2001/11/05 21:42:41  steudten
 219  *    Include DBG() macro.
 220  *
 221  *    Revision 1.41  2001/10/28 19:12:06  jongfoster
 222  *    Adding ijb_toupper()
 223  *
 224  *    Revision 1.40  2001/10/26 17:40:47  oes
 225  *    Moved ijb_isspace and ijb_tolower to project.h
 226  *    Removed http->user_agent, csp->referrer and csp->accept_types
 227  *
 228  *    Revision 1.39  2001/10/25 03:45:02  david__schmidt
 229  *    Adding a (void*) cast to freez() because Visual Age C++ won't expand the
 230  *    macro when called with a cast; so moving the cast to the macro def'n
 231  *    seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and
 232  *    doesn't make macro expansion complain.  Hope this works for everyone else
 233  *    too...
 234  *
 235  *    Revision 1.38  2001/10/23 21:19:04  jongfoster
 236  *    New error-handling support: jb_err type and JB_ERR_xxx constants
 237  *    CGI functions now return a jb_err, and their parameters map is const.
 238  *    Support for RUNTIME_FEATUREs to enable/disable config editor
 239  *    Adding a few comments
 240  *
 241  *    Revision 1.37  2001/10/14 22:14:01  jongfoster
 242  *    Removing name_length field from struct cgi_dispatcher, as this is
 243  *    now calculated at runtime from the "name" field.
 244  *
 245  *    Revision 1.36  2001/10/10 16:45:15  oes
 246  *    Added LIMIT_CONNECT action and string
 247  *    Fixed HTTP message line termination
 248  *    Added CFORBIDDEN HTTP message
 249  *
 250  *    Revision 1.35  2001/10/07 18:06:43  oes
 251  *    Added status member to struct http_request
 252  *
 253  *    Revision 1.34  2001/10/07 15:45:25  oes
 254  *    Added url member to struct http_request and commented all
 255  *      members
 256  *
 257  *    Added CT_TABOO
 258  *
 259  *    Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION
 260  *
 261  *    Replaced struct client_state members rejected,
 262  *      force, active and toggled_on with "flags" bitmap.
 263  *
 264  *    Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED
 265  *
 266  *    Added buffer_limit to struct configuration_spec
 267  *
 268  *    Revision 1.33  2001/09/20 13:30:08  steudten
 269  *
 270  *    Make freez() more secure in case of: if (exp) { free(z) ; a=*z }
 271  *    Last case will set z to NULL in free(z) and thats bad..
 272  *
 273  *    Revision 1.32  2001/09/16 23:02:51  jongfoster
 274  *    Fixing warning
 275  *
 276  *    Revision 1.31  2001/09/16 13:20:29  jongfoster
 277  *    Rewrite of list library.  Now has seperate header and list_entry
 278  *    structures.  Also added a large sprinking of assert()s to the list
 279  *    code.
 280  *
 281  *    Revision 1.30  2001/09/13 23:52:00  jongfoster
 282  *    Support for both static and dynamically generated CGI pages
 283  *
 284  *    Revision 1.29  2001/09/13 23:29:43  jongfoster
 285  *    Defining FORWARD_SPEC_INITIALIZER
 286  *
 287  *    Revision 1.28  2001/09/13 23:05:50  jongfoster
 288  *    Changing the string paramater to the header parsers a "const".
 289  *
 290  *    Revision 1.27  2001/08/05 16:06:20  jongfoster
 291  *    Modifiying "struct map" so that there are now separate header and
 292  *    "map_entry" structures.  This means that functions which modify a
 293  *    map no longer need to return a pointer to the modified map.
 294  *    Also, it no longer reverses the order of the entries (which may be
 295  *    important with some advanced template substitutions).
 296  *
 297  *    Revision 1.26  2001/07/30 22:08:36  jongfoster
 298  *    Tidying up #defines:
 299  *    - All feature #defines are now of the form FEATURE_xxx
 300  *    - Permanently turned off WIN_GUI_EDIT
 301  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
 302  *
 303  *    Revision 1.25  2001/07/29 18:43:08  jongfoster
 304  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
 305  *    ANSI C rules.
 306  *
 307  *    Revision 1.24  2001/07/25 17:20:27  oes
 308  *    Introduced http->user_agent
 309  *
 310  *    Revision 1.23  2001/07/18 12:32:23  oes
 311  *    - Added ACTION_STRING_DEANIMATE
 312  *    - moved #define freez from jcc.h to project.h
 313  *
 314  *    Revision 1.22  2001/07/15 17:51:41  jongfoster
 315  *    Renaming #define STATIC to STATIC_PCRE
 316  *
 317  *    Revision 1.21  2001/07/13 14:03:19  oes
 318  *     - Reorganized regex header inclusion and #defines to
 319  *       comply to the scheme in configure.in
 320  *     - Added csp->content_type and its CT_* keys
 321  *     - Added ACTION_DEANIMATE
 322  *     - Removed all #ifdef PCRS
 323  *
 324  *    Revision 1.20  2001/06/29 21:45:41  oes
 325  *    Indentation, CRLF->LF, Tab-> Space
 326  *
 327  *    Revision 1.19  2001/06/29 13:33:36  oes
 328  *    - Improved comments
 329  *    - Introduced http_request.host_ip_addr_str
 330  *    - Introduced http_response.head_length
 331  *    - Introduced config.my_ip_addr_str, config.my_hostname,
 332  *      config.admin_address and config.proxy_info_url
 333  *    - Removed config.proxy_args_header and config.proxy_args_trailer,
 334  *      renamed config.proxy_args_invocation to config.proxy_args
 335  *    - Removed HTML snipplets and GIFs
 336  *    - Removed logentry from cancelled commit
 337  *
 338  *    Revision 1.18  2001/06/09 10:57:39  jongfoster
 339  *    Adding definition of BUFFER_SIZE.
 340  *    Changing struct cgi_dispatcher to use "const" strings.
 341  *
 342  *    Revision 1.17  2001/06/07 23:15:09  jongfoster
 343  *    Merging ACL and forward files into config file.
 344  *    Moving struct gateway members into struct forward_spec
 345  *    Removing config->proxy_args_gateways
 346  *    Cosmetic: Adding a few comments
 347  *
 348  *    Revision 1.16  2001/06/04 18:31:58  swa
 349  *    files are now prefixed with either `confdir' or `logdir'.
 350  *    `make redhat-dist' replaces both entries confdir and logdir
 351  *    with redhat values
 352  *
 353  *    Revision 1.15  2001/06/04 11:28:53  swa
 354  *    redirect did not work due to missing /
 355  *
 356  *    Revision 1.14  2001/06/03 11:03:48  oes
 357  *    Added struct map,
 358  *    added struct http_response,
 359  *    changed struct interceptors to struct cgi_dispatcher,
 360  *    moved HTML stuff to cgi.h
 361  *
 362  *    Revision 1.13  2001/06/01 20:05:36  jongfoster
 363  *    Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
 364  *    constant, and removed csp->tinygif.
 365  *
 366  *    Revision 1.12  2001/06/01 18:49:17  jongfoster
 367  *    Replaced "list_share" with "list" - the tiny memory gain was not
 368  *    worth the extra complexity.
 369  *
 370  *    Revision 1.11  2001/06/01 10:32:47  oes
 371  *    Added constants for anchoring selection bitmap
 372  *
 373  *    Revision 1.10  2001/05/31 21:33:53  jongfoster
 374  *    Changes for new actions file, replacing permissionsfile
 375  *    and parts of the config file.  Also added support for
 376  *    list_shared.
 377  *
 378  *    Revision 1.9  2001/05/31 17:32:31  oes
 379  *
 380  *     - Enhanced domain part globbing with infix and prefix asterisk
 381  *       matching and optional unanchored operation
 382  *
 383  *    Revision 1.8  2001/05/29 20:09:15  joergs
 384  *    HTTP_REDIRECT_TEMPLATE fixed.
 385  *
 386  *    Revision 1.7  2001/05/29 09:50:24  jongfoster
 387  *    Unified blocklist/imagelist/actionslist.
 388  *    File format is still under discussion, but the internal changes
 389  *    are (mostly) done.
 390  *
 391  *    Also modified interceptor behaviour:
 392  *    - We now intercept all URLs beginning with one of the following
 393  *      prefixes (and *only* these prefixes):
 394  *        * http://i.j.b/
 395  *        * http://ijbswa.sf.net/config/
 396  *        * http://ijbswa.sourceforge.net/config/
 397  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
 398  *    - Internal changes so that intercepted and fast redirect pages
 399  *      are not replaced with an image.
 400  *    - Interceptors now have the option to send a binary page direct
 401  *      to the client. (i.e. ijb-send-banner uses this)
 402  *    - Implemented show-url-info interceptor.  (Which is why I needed
 403  *      the above interceptors changes - a typical URL is
 404  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
 405  *      The previous mechanism would not have intercepted that, and
 406  *      if it had been intercepted then it then it would have replaced
 407  *      it with an image.)
 408  *
 409  *    Revision 1.6  2001/05/27 22:17:04  oes
 410  *
 411  *    - re_process_buffer no longer writes the modified buffer
 412  *      to the client, which was very ugly. It now returns the
 413  *      buffer, which it is then written by chat.
 414  *
 415  *    - content_length now adjusts the Content-Length: header
 416  *      for modified documents rather than crunch()ing it.
 417  *      (Length info in csp->content_length, which is 0 for
 418  *      unmodified documents)
 419  *
 420  *    - For this to work, sed() is called twice when filtering.
 421  *
 422  *    Revision 1.5  2001/05/26 00:28:36  jongfoster
 423  *    Automatic reloading of config file.
 424  *    Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
 425  *    Most of the global variables have been moved to a new
 426  *    struct configuration_spec, accessed through csp->config->globalname
 427  *    Most of the globals remaining are used by the Win32 GUI.
 428  *
 429  *    Revision 1.4  2001/05/22 18:46:04  oes
 430  *
 431  *    - Enabled filtering banners by size rather than URL
 432  *      by adding patterns that replace all standard banner
 433  *      sizes with the "Junkbuster" gif to the re_filterfile
 434  *
 435  *    - Enabled filtering WebBugs by providing a pattern
 436  *      which kills all 1x1 images
 437  *
 438  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
 439  *      which is selected by the (nonstandard and therefore
 440  *      capital) letter 'U' in the option string.
 441  *      It causes the quantifiers to be ungreedy by default.
 442  *      Appending a ? turns back to greedy (!).
 443  *
 444  *    - Added a new interceptor ijb-send-banner, which
 445  *      sends back the "Junkbuster" gif. Without imagelist or
 446  *      MSIE detection support, or if tinygif = 1, or the
 447  *      URL isn't recognized as an imageurl, a lame HTML
 448  *      explanation is sent instead.
 449  *
 450  *    - Added new feature, which permits blocking remote
 451  *      script redirects and firing back a local redirect
 452  *      to the browser.
 453  *      The feature is conditionally compiled, i.e. it
 454  *      can be disabled with --disable-fast-redirects,
 455  *      plus it must be activated by a "fast-redirects"
 456  *      line in the config file, has its own log level
 457  *      and of course wants to be displayed by show-proxy-args
 458  *      Note: Boy, all the #ifdefs in 1001 locations and
 459  *      all the fumbling with configure.in and acconfig.h
 460  *      were *way* more work than the feature itself :-(
 461  *
 462  *    - Because a generic redirect template was needed for
 463  *      this, tinygif = 3 now uses the same.
 464  *
 465  *    - Moved GIFs, and other static HTTP response templates
 466  *      to project.h
 467  *
 468  *    - Some minor fixes
 469  *
 470  *    - Removed some >400 CRs again (Jon, you really worked
 471  *      a lot! ;-)
 472  *
 473  *    Revision 1.3  2001/05/20 01:21:20  jongfoster
 474  *    Version 2.9.4 checkin.
 475  *    - Merged popupfile and cookiefile, and added control over PCRS
 476  *      filtering, in new "actionsfile".
 477  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
 478  *      file error you now get a message box (in the Win32 GUI) rather
 479  *      than the program exiting with no explanation.
 480  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
 481  *      skipping.
 482  *    - Removed tabs from "config"
 483  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
 484  *    - Bumped up version number.
 485  *
 486  *    Revision 1.2  2001/05/17 23:01:01  oes
 487  *     - Cleaned CRLF's from the sources and related files
 488  *
 489  *    Revision 1.1.1.1  2001/05/15 13:59:03  oes
 490  *    Initial import of version 2.9.3 source tree
 491  *
 492  *
 493  *********************************************************************/
 494 \f
 495
 496 /* Declare struct FILE for vars and funcs. */
 497 #include <stdio.h>
 498
 499 /* Need time_t for file_list */
 500 #include <time.h>
 501 /* Needed for pcre choice */
 502 #include "config.h"
 503
 504 /*
 505  * Include appropriate regular expression libraries.
 506  * Note that pcrs and pcre (native) are needed for cgi
 507  * and are included anyway.
 508  */
 509
 510 #ifdef STATIC_PCRE
 511 #  include "pcre.h"
 512 #else
 513 #  ifdef PCRE_H_IN_SUBDIR
 514 #    include <pcre/pcre.h>
 515 #  else
 516 #    include <pcre.h>
 517 #  endif
 518 #endif
 519
 520 #ifdef STATIC_PCRS
 521 #  include "pcrs.h"
 522 #else
 523 #  include <pcrs.h>
 524 #endif
 525
 526 #ifdef STATIC_PCRE
 527 #  include "pcreposix.h"
 528 #else
 529 #  ifdef PCRE_H_IN_SUBDIR
 530 #    include <pcre/pcreposix.h>
 531 #  else
 532 #    include <pcreposix.h>
 533 #  endif
 534 #endif
 535
 536 #ifdef AMIGA
 537 #include "amiga.h"
 538 #endif /* def AMIGA */
 539
 540 #ifdef _WIN32
 541 /*
 542  * I don't want to have to #include all this just for the declaration
 543  * of SOCKET.  However, it looks like we have to...
 544  */
 545 #ifndef STRICT
 546 #define STRICT
 547 #endif
 548 #include <windows.h>
 549 #endif
 550
 551
 552 #ifdef __cplusplus
 553 extern "C" {
 554 #endif
 555
 556 #ifdef _WIN32
 557
 558 typedef SOCKET jb_socket;
 559
 560 #define JB_INVALID_SOCKET INVALID_SOCKET
 561
 562 #else /* ndef _WIN32 */
 563
 564 /**
 565  * The type used by sockets.  On UNIX it's an int.  Microsoft decided to
 566  * make it an unsigned.
 567  */
 568 typedef int jb_socket;
 569
 570 /**
 571  * The error value used for variables of type jb_socket.  On UNIX this
 572  * is -1, however Microsoft decided to make socket handles unsigned, so
 573  * they use a different value.
 574  */
 575
 576 #define JB_INVALID_SOCKET (-1)
 577
 578 #endif /* ndef _WIN32 */
 579
 580
 581 /**
 582  * A standard error code.  This should be JB_ERR_OK or one of the JB_ERR_xxx
 583  * series of errors.
 584  */
 585 typedef int jb_err;
 586
 587 #define JB_ERR_OK         0 /**< Success, no error                        */
 588 #define JB_ERR_MEMORY     1 /**< Out of memory                            */
 589 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters        */
 590 #define JB_ERR_FILE       3 /**< Error opening, reading or writing a file */
 591 #define JB_ERR_PARSE      4 /**< Error parsing file                       */
 592 #define JB_ERR_MODIFIED   5 /**< File has been modified outside of the
 593                                  CGI actions editor.                      */
 594
 595
 596 /**
 597  * This macro is used to free a pointer that may be NULL.
 598  * It also sets the variable to NULL after it's been freed.
 599  * The paramater should be a simple variable without side effects.
 600  */
 601 #define freez(X)  { if(X) { free((void*)X); X = NULL ; } }
 602
 603
 604 /**
 605  * Fix a problem with Solaris.  There should be no effect on other
 606  * platforms.
 607  *
 608  * Solaris's isspace() is a macro which uses it's argument directly
 609  * as an array index.  Therefore we need to make sure that high-bit
 610  * characters generate +ve values, and ideally we also want to make
 611  * the argument match the declared parameter type of "int".
 612  *
 613  * Note: Remember to #include <ctype.h> if you use these macros.
 614  */
 615 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
 616 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
 617 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
 618
 619 /**
 620  * Use for statically allocated buffers if you have no other choice.
 621  * Remember to check the length of what you write into the buffer
 622  * - we don't want any buffer overflows!
 623  */
 624 #define BUFFER_SIZE 5000
 625
 626 /**
 627  * Max length of CGI parameters (arbitrary limit).
 628  */
 629 #define CGI_PARAM_LEN_MAX 500
 630
 631 /**
 632  * Buffer size for capturing struct hostent data in the
 633  * gethostby(name|addr)_r library calls. Since we don't
 634  * loop over gethostbyname_r, the buffer must be sufficient
 635  * to accomodate multiple IN A RRs, as used in DNS round robin
 636  * load balancing. W3C's wwwlib uses 1K, so that should be
 637  * good enough for us, too.
 638  */
 639 #define HOSTENT_BUFFER_SIZE 1024
 640
 641 /**
 642  * Do not use.  Originally this was so that you can
 643  * say "while (FOREVER) { ...do something... }".
 644  * However, this gives a warning with some compilers (e.g. VC++).
 645  * Instead, use "for (;;) { ...do something... }".
 646  */
 647 #define FOREVER 1
 648
 649 /**
 650  * Default IP address to listen on, as a string.
 651  * Set to "127.0.0.1".
 652  */
 653 #define HADDR_DEFAULT   "127.0.0.1"
 654
 655 /**
 656  * Default port to listen on, as a number.
 657  * Set to 8118.
 658  */
 659 #define HADDR_PORT      8118
 660
 661
 662 /* Forward def for struct client_state */
 663 struct configuration_spec;
 664
 665
 666 /**
 667  * Entry in a linked list of strings.
 668  */
 669 struct list_entry
 670 {
 671    /**
 672     * The string pointer. It must point to a dynamically malloc()ed
 673     * string or be NULL for the list functions to work. In the latter
 674     * case, just be careful next time you iterate through the list in
 675     * your own code.
 676     */
 677    char *str;
 678
 679    /** Next entry in the linked list, or NULL if no more. */
 680    struct list_entry *next;
 681 };
 682
 683 /**
 684  * A header for a linked list of strings.
 685  */
 686 struct list
 687 {
 688    /** First entry in the list, or NULL if the list is empty. */
 689    struct list_entry *first;
 690
 691    /** Last entry in the list, or NULL if the list is empty. */
 692    struct list_entry *last;
 693 };
 694
 695
 696 /**
 697  * An entry in a map.  This is a name=value pair.
 698  */
 699 struct map_entry
 700 {
 701    /** The key for the map. */
 702    const char *name;
 703    /** The value associated with that key. */
 704    const char *value;
 705    /** The next map entry, or NULL if none. */
 706    struct map_entry *next;
 707 };
 708
 709 /**
 710  * A map from a string to another string.
 711  * This is used for the paramaters passed in a HTTP GET request, and
 712  * to store the exports when the CGI interface is filling in a template.
 713  */
 714 struct map
 715 {
 716    /** The first map entry, or NULL if the map is empty. */
 717    struct map_entry *first;
 718    /** The last map entry, or NULL if the map is empty. */
 719    struct map_entry *last;
 720 };
 721
 722
 723 /**
 724  * A HTTP request.  This includes the method (GET, POST) and
 725  * the parsed URL.
 726  *
 727  * This is also used whenever we want to match a URL against a
 728  * URL pattern.  This always contains the URL to match, and never
 729  * a URL pattern.  (See struct url_spec).
 730  */
 731 struct http_request
 732 {
 733    char *cmd;      /**< Whole command line: method, URL, Version */
 734    char *ocmd;     /**< Backup of original cmd for CLF logging */
 735    char *gpc;      /**< HTTP method: GET, POST, ... */
 736    char *url;      /**< The URL */
 737    char *ver;      /**< Protocol version */
 738    int status;     /**< HTTP Status */
 739
 740    char *host;     /**< Host part of URL */
 741    int   port;     /**< Port of URL or 80 (default) */
 742    char *path;     /**< Path of URL */
 743    char *hostport; /**< host[:port] */
 744    int   ssl;      /**< Flag if protocol is https */
 745
 746    char *host_ip_addr_str; /**< String with dotted decimal representation
 747                                 of host's IP. NULL before connect_to() */
 748
 749    char  *dbuffer; /**< Buffer with '\0'-delimited domain name.           */
 750    char **dvec;    /**< List of pointers to the strings in dbuffer.       */
 751    int    dcount;  /**< How many parts to this domain? (length of dvec)   */
 752 };
 753
 754
 755 /**
 756  * Response generated by CGI, blocker, or error handler
 757  */
 758 struct http_response
 759 {
 760   char  *status;          /**< HTTP status (string). */
 761   struct list headers[1]; /**< List of header lines. */
 762   char  *head;            /**< Formatted http response head. */
 763   size_t head_length;     /**< Length of http response head. */
 764   char  *body;            /**< HTTP document body. */
 765   size_t content_length;  /**< Length of body, REQUIRED if binary body. */
 766   int    is_static;       /**< Nonzero if the content will never change and
 767                                should be cached by the browser (e.g. images). */
 768 };
 769
 770 /**
 771  * A URL pattern.
 772  */
 773 struct url_spec
 774 {
 775    /** The string which was parsed to produce this url_spec.
 776        Used for debugging or display only.  */
 777    char  *spec;
 778
 779    char  *dbuffer;     /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
 780    char **dvec;        /**< List of pointers to the strings in dbuffer.       */
 781    int    dcount;      /**< How many parts to this domain? (length of dvec)   */
 782    int    unanchored;  /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT.  */
 783
 784    int   port;         /**< The port number, or 0 to match all ports.         */
 785
 786    char *path;         /**< The source for the regex.                         */
 787    int   pathlen;      /**< ==strlen(path).  Needed for prefix matching.  FIXME: Now obsolete?     */
 788    regex_t *preg;      /**< Regex for matching path part                      */
 789 };
 790
 791 /**
 792  * If you declare a static url_spec, this is the value to initialize it to zero.
 793  */
 794 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
 795
 796 /**
 797  * Constant for host part matching in URLs.  If set, indicates that the start of
 798  * the pattern must match the start of the URL.  E.g. this is not set for the
 799  * pattern ".example.com", so that it will match both "example.com" and
 800  * "www.example.com".  It is set for the pattern "example.com", which makes it
 801  * match "example.com" only, not "www.example.com".
 802  */
 803 #define ANCHOR_LEFT  1
 804
 805 /**
 806  * Constant for host part matching in URLs.  If set, indicates that the end of
 807  * the pattern must match the end of the URL.  E.g. this is not set for the
 808  * pattern "ad.", so that it will match any host called "ad", irrespective
 809  * of how many subdomains are in the fully-qualified domain name.
 810  */
 811 #define ANCHOR_RIGHT 2
 812
 813
 814 /**
 815  * An I/O buffer.  Holds a string which can be appended to, and can have data
 816  * removed from the beginning.
 817  */
 818 struct iob
 819 {
 820    char *buf;    /**< Start of buffer        */
 821    char *cur;    /**< Start of relevant data */
 822    char *eod;    /**< End of relevant data   */
 823    size_t size;  /**< Size as malloc()ed     */
 824 };
 825
 826
 827 /**
 828  * Return the number of bytes in the I/O buffer associated with the passed
 829  * client_state pointer.
 830  * May be zero.
 831  */
 832 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
 833
 834
 835 /**
 836  * Remove any data in the I/O buffer associated with the passed
 837  * client_state pointer.
 838  */
 839 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
 840
 841 /* Bits for csp->content_type */
 842 #define CT_TEXT   1 /**< csp->content_type bitmask:
 843                          Suitable for pcrs filtering. */
 844 #define CT_GIF    2 /**< csp->content_type bitmask:
 845                          Suitable for GIF filtering.  */
 846 #define CT_TABOO  4 /**< csp->content_type bitmask:
 847                          DO NOT filter, irrespective of other flags. */
 848 #define CT_JPEG   8 /**< csp->content_type bitmask:
 849                          Suitable for JPEG filtering.  */
 850
 851 /**
 852  * The mask which includes all actions.
 853  */
 854 #define ACTION_MASK_ALL        (~0UL)
 855
 856 /**
 857  * The most compatible set of actions - i.e. none.
 858  */
 859 #define ACTION_MOST_COMPATIBLE                       0x00000000UL
 860
 861 /** Action bitmap: Block the request. */
 862 #define ACTION_BLOCK                                 0x00000001UL
 863 /** Action bitmap: Deanimate if it's a GIF. */
 864 #define ACTION_DEANIMATE                             0x00000002UL
 865 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
 866 #define ACTION_DOWNGRADE                             0x00000004UL
 867 /** Action bitmap: Fast redirects. */
 868 #define ACTION_FAST_REDIRECTS                        0x00000008UL
 869 /** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
 870 #define ACTION_HIDE_FORWARDED                        0x00000010UL
 871 /** Action bitmap: Hide "From" header. */
 872 #define ACTION_HIDE_FROM                             0x00000020UL
 873 /** Action bitmap: Hide "Referer" header.  (sic - follow HTTP, not English). */
 874 #define ACTION_HIDE_REFERER                          0x00000040UL
 875 /** Action bitmap: Hide "User-Agent" and similar headers. */
 876 #define ACTION_HIDE_USER_AGENT                       0x00000080UL
 877 /** Action bitmap: This is an image. */
 878 #define ACTION_IMAGE                                 0x00000100UL
 879 /** Action bitmap: Sets the image blocker. */
 880 #define ACTION_IMAGE_BLOCKER                         0x00000200UL
 881 /** Action bitmap: Prevent compression. */
 882 #define ACTION_NO_COMPRESSION                        0x00000400UL
 883 /** Action bitmap: Change cookies to session only cookies. */
 884 #define ACTION_NO_COOKIE_KEEP                        0x00000800UL
 885 /** Action bitmap: Block rending cookies. */
 886 #define ACTION_NO_COOKIE_READ                        0x00001000UL
 887 /** Action bitmap: Block setting cookies. */
 888 #define ACTION_NO_COOKIE_SET                         0x00002000UL
 889 /** Action bitmap: Filter out popups. */
 890 #define ACTION_NO_POPUPS                             0x00004000UL
 891 /** Action bitmap: Send a vanilla wafer. */
 892 #define ACTION_VANILLA_WAFER                         0x00008000UL
 893 /** Action bitmap: Limit CONNECT requests to safe ports. */
 894 #define ACTION_LIMIT_CONNECT                         0x00010000UL
 895 /** Action bitmap: Inspect if it's a JPEG. */
 896 #define ACTION_JPEG_INSPECT                          0x00020000UL
 897 /** Action bitmap: Crunch or modify "if-modified-since" header. */
 898 #define ACTION_HIDE_IF_MODIFIED_SINCE                0x00040000UL
 899 /** Action bitmap: Overwrite Content-Type header. */
 900 #define ACTION_CONTENT_TYPE_OVERWRITE                0x00080000UL
 901 /** Action bitmap: Crunch specified server header. */
 902 #define ACTION_CRUNCH_SERVER_HEADER                  0x00100000UL
 903 /** Action bitmap: Crunch specified client header */
 904 #define ACTION_CRUNCH_CLIENT_HEADER                  0x00200000UL
 905 /** Action bitmap: Enable text mode by force */
 906 #define ACTION_FORCE_TEXT_MODE                       0x00400000UL
 907 /** Action bitmap: Enable text mode by force */
 908 #define ACTION_CRUNCH_IF_NONE_MATCH                  0x00800000UL
 909 /** Action bitmap: Enable content-dispostion crunching */
 910 #define ACTION_HIDE_CONTENT_DISPOSITION              0x01000000UL
 911 /** Action bitmap: Replace or block Last-Modified header */
 912 #define ACTION_OVERWRITE_LAST_MODIFIED               0x02000000UL
 913 /** Action bitmap: Replace or block Accept-Language header */
 914 #define ACTION_HIDE_ACCEPT_LANGUAGE                  0x04000000UL
 915 /** Action bitmap: Block as empty document */
 916 #define  ACTION_HANDLE_AS_EMPTY_DOCUMENT             0x08000000UL
 917 /** Action bitmap: Redirect request. */
 918 #define  ACTION_REDIRECT                             0x10000000UL
 919 /** Action bitmap: Answer blocked Connects verbosely */
 920 #define ACTION_TREAT_FORBIDDEN_CONNECTS_LIKE_BLOCKS  0x20000000UL
 921 /** Action bitmap: Filter server headers with pcre */
 922 #define ACTION_FILTER_SERVER_HEADERS                 0x40000000UL
 923 /** Action bitmap: Filter client headers with pcre */
 924 #define ACTION_FILTER_CLIENT_HEADERS                 0x80000000UL
 925
 926
 927 /** Action string index: How to deanimate GIFs */
 928 #define ACTION_STRING_DEANIMATE             0
 929 /** Action string index: Replacement for "From:" header */
 930 #define ACTION_STRING_FROM                  1
 931 /** Action string index: How to block images */
 932 #define ACTION_STRING_IMAGE_BLOCKER         2
 933 /** Action string index: Replacement for "Referer:" header */
 934 #define ACTION_STRING_REFERER               3
 935 /** Action string index: Replacement for "User-Agent:" header */
 936 #define ACTION_STRING_USER_AGENT            4
 937 /** Action string index: Legal CONNECT ports. */
 938 #define ACTION_STRING_LIMIT_CONNECT         5
 939 /** Action string index: Server headers containing this pattern are crunched*/
 940 #define ACTION_STRING_SERVER_HEADER         6
 941 /** Action string index: Client headers containing this pattern are crunched*/
 942 #define ACTION_STRING_CLIENT_HEADER         7
 943 /** Action string index: Replacement for the "Accept-Language:" header*/
 944 #define ACTION_STRING_LANGUAGE              8
 945 /** Action string index: Replacement for the "Content-Type:" header*/
 946 #define ACTION_STRING_CONTENT_TYPE          9
 947 /** Action string index: Replacement for the "content-dispostion:" header*/
 948 #define ACTION_STRING_CONTENT_DISPOSITION  10
 949 /** Action string index: Replacement for the "If-Modified-Since:" header*/
 950 #define ACTION_STRING_IF_MODIFIED_SINCE    11
 951 /** Action string index: Replacement for the "Last-Modified:" header. */
 952 #define ACTION_STRING_LAST_MODIFIED        12
 953 /** Action string index: Redirect URL */
 954 #define ACTION_STRING_REDIRECT             13
 955 /** Action string index: Decode before redirect? */
 956 #define ACTION_STRING_FAST_REDIRECTS       14
 957 /** Number of string actions. */
 958 #define ACTION_STRING_COUNT                15
 959
 960
 961 /*To make the ugly hack in sed easier to understand*/
 962 #define CHECK_EVERY_HEADER_REMAINING 0
 963
 964
 965 /** Index into current_action_spec::multi[] for headers to add. */
 966 #define ACTION_MULTI_ADD_HEADER     0
 967 /** Index into current_action_spec::multi[] for headers to add. */
 968 #define ACTION_MULTI_WAFER          1
 969 /** Index into current_action_spec::multi[] for filters to apply. */
 970 #define ACTION_MULTI_FILTER         2
 971 /** Number of multi-string actions. */
 972 #define ACTION_MULTI_COUNT          3
 973
 974
 975 /**
 976  * This structure contains a list of actions to apply to a URL.
 977  * It only contains positive instructions - no "-" options.
 978  * It is not used to store the actions list itself, only for
 979  * url_actions() to return the current values.
 980  */
 981 struct current_action_spec
 982 {
 983    /** Actions to apply.  A bit set to "1" means perform the action. */
 984    unsigned long flags;
 985
 986    /**
 987     * Paramaters for those actions that require them.
 988     * Each entry is valid if & only if the corresponding entry in "flags" is
 989     * set.
 990     */
 991    char * string[ACTION_STRING_COUNT];
 992
 993    /** Lists of strings for multi-string actions. */
 994    struct list multi[ACTION_MULTI_COUNT][1];
 995 };
 996
 997
 998 /**
 999  * This structure contains a set of changes to actions.
1000  * It can contain both positive and negative instructions.
1001  * It is used to store an entry in the actions list.
1002  */
1003 struct action_spec
1004 {
1005    unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
1006    unsigned long add;  /**< Actions to add.  A bit set to "1" means add action.    */
1007
1008    /**
1009     * Paramaters for those actions that require them.
1010     * Each entry is valid if & only if the corresponding entry in "flags" is
1011     * set.
1012     */
1013    char * string[ACTION_STRING_COUNT];
1014
1015    /** Lists of strings to remove, for multi-string actions. */
1016    struct list multi_remove[ACTION_MULTI_COUNT][1];
1017
1018    /** If nonzero, remove *all* strings from the multi-string action. */
1019    int         multi_remove_all[ACTION_MULTI_COUNT];
1020
1021    /** Lists of strings to add, for multi-string actions. */
1022    struct list multi_add[ACTION_MULTI_COUNT][1];
1023 };
1024
1025
1026 /**
1027  * This structure is used to store the actions list.
1028  *
1029  * It contains a URL pattern, and the chages to the actions.
1030  * It is a linked list.
1031  */
1032 struct url_actions
1033 {
1034    struct url_spec url[1];        /**< URL pattern. */
1035
1036    struct action_spec action[1];  /**< Actions. */
1037
1038    struct url_actions * next;     /**< Next action in file, or NULL. */
1039 };
1040
1041
1042 /*
1043  * Flags for use in csp->flags
1044  */
1045
1046 /**
1047  * Flag for csp->flags: Set if this client is processing data.
1048  * Cleared when the thread associated with this structure dies.
1049  */
1050 #define CSP_FLAG_ACTIVE     0x01
1051
1052 /**
1053  * Flag for csp->flags: Set if the server's reply is in "chunked"
1054  * transfer encoding
1055  */
1056 #define CSP_FLAG_CHUNKED    0x02
1057
1058 /**
1059  * Flag for csp->flags: Set if this request was enforced, although it would
1060  * normally have been blocked.
1061  */
1062 #define CSP_FLAG_FORCED     0x04
1063
1064 /**
1065  * Flag for csp->flags: Set if any modification to the body was done.
1066  */
1067 #define CSP_FLAG_MODIFIED   0x08
1068
1069 /**
1070  * Flag for csp->flags: Set if request was blocked.
1071  */
1072 #define CSP_FLAG_REJECTED   0x10
1073
1074 /**
1075  * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
1076  */
1077 #define CSP_FLAG_TOGGLED_ON 0x20
1078
1079
1080 /*
1081  * Flags for use in return codes of child processes
1082  */
1083
1084 /**
1085  * Flag for process return code: Set if exiting porcess has been toggled
1086  * during its lifetime.
1087  */
1088 #define RC_FLAG_TOGGLED   0x10
1089
1090 /**
1091  * Flag for process return code: Set if exiting porcess has blocked its
1092  * request.
1093  */
1094 #define RC_FLAG_BLOCKED   0x20
1095
1096 /**
1097  * Maximum number of actions/filter files.  This limit is arbitrary - it's just used
1098  * to size an array.
1099  */
1100 #define MAX_AF_FILES 10
1101
1102 /**
1103  * The state of a Privoxy processing thread.
1104  */
1105 struct client_state
1106 {
1107    /** The proxy's configuration */
1108    struct configuration_spec * config;
1109
1110    /** The actions to perform on the current request */
1111    struct current_action_spec  action[1];
1112
1113    /** socket to talk to client (web browser) */
1114    jb_socket cfd;
1115
1116    /** socket to talk to server (web server or proxy) */
1117    jb_socket sfd;
1118
1119    /** Multi-purpose flag container, see CSP_FLAG_* above */
1120    unsigned short int flags;
1121
1122    /** Client PC's IP address, as reported by the accept() function.
1123        As a string. */
1124    char *ip_addr_str;
1125    /** Client PC's IP address, as reported by the accept() function.
1126        As a number. */
1127    long  ip_addr_long;
1128
1129    /** Our IP address. I.e. the IP address that the client used to reach us,
1130        as a string. */
1131    char *my_ip_addr_str;
1132
1133    /** Our hostname. I.e. the reverse DNS of the IP address that the client
1134        used to reach us, as a string. */
1135    char *my_hostname;
1136
1137    /** The URL that was requested */
1138    struct http_request http[1];
1139
1140    /** An I/O buffer used for buffering data read from the network */
1141    struct iob iob[1];
1142
1143    /** List of all headers for this request */
1144    struct list headers[1];
1145
1146    /** List of all cookies for this request */
1147    struct list cookie_list[1];
1148
1149    /** MIME-Type key, see CT_* above */
1150    unsigned short int content_type;
1151
1152    /** The "X-Forwarded-For:" header sent by the client */
1153    char   *x_forwarded;
1154
1155    /** Actions files associated with this client */
1156    struct file_list *actions_list[MAX_AF_FILES];
1157
1158    /** pcrs job files. */
1159    struct file_list *rlist[MAX_AF_FILES];
1160
1161    /** Length after content modification. */
1162    size_t content_length;
1163
1164 #ifdef FEATURE_TRUST
1165
1166    /** Trust file. */
1167    struct file_list *tlist;
1168
1169 #endif /* def FEATURE_TRUST */
1170
1171    /** Next thread in linked list. Only read or modify from the main thread! */
1172    struct client_state *next;
1173 };
1174
1175
1176 /**
1177  * A function to add a header
1178  */
1179 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1180
1181 /**
1182  * A function to process a header
1183  */
1184 typedef jb_err (*parser_func_ptr    )(struct client_state *, char **);
1185
1186
1187 /**
1188  * List of functions to run on a list of headers
1189  */
1190 struct parsers
1191 {
1192    /** The header prefix to match */
1193    char   *str;
1194
1195    /** The length of the prefix to match */
1196    size_t len;
1197
1198    /** The function to apply to this line */
1199    parser_func_ptr parser;
1200 };
1201
1202
1203 /**
1204  * List of available CGI functions.
1205  */
1206 struct cgi_dispatcher
1207 {
1208    /** The URL of the CGI, relative to the CGI root. */
1209    const char * const name;
1210
1211    /** The handler function for the CGI */
1212    jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1213
1214    /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1215    const char * const description;
1216
1217    /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1218    int harmless;
1219 };
1220
1221
1222 /**
1223  * A data file used by Privoxy.  Kept in a linked list.
1224  */
1225 struct file_list
1226 {
1227    /**
1228     * This is a pointer to the data structures associated with the file.
1229     * Read-only once the structure has been created.
1230     */
1231    void *f;
1232
1233    /**
1234     * The unloader function.
1235     * Normally NULL.  When we are finished with file (i.e. when we have
1236     * loaded a new one), set to a pointer to an unloader function.
1237     * Unloader will be called by sweep() (called from main loop) when
1238     * all clients using this file are done.  This prevents threading
1239     * problems.
1240     */
1241    void (*unloader)(void *);
1242
1243    /**
1244     * Used internally by sweep().  Do not access from elsewhere.
1245     */
1246    int active;
1247
1248    /**
1249     * File last-modified time, so we can check if file has been changed.
1250     * Read-only once the structure has been created.
1251     */
1252    time_t lastmodified;
1253
1254    /**
1255     * The full filename.
1256     */
1257    char * filename;
1258
1259    /**
1260     * Pointer to next entry in the linked list of all "file_list"s.
1261     * This linked list is so that sweep() can navigate it.
1262     * Since sweep() can remove items from the list, we must be careful
1263     * to only access this value from main thread (when we know sweep
1264     * won't be running).
1265     */
1266    struct file_list *next;
1267 };
1268
1269
1270 #ifdef FEATURE_TRUST
1271
1272 /**
1273  * The format of a trust file when loaded into memory.
1274  */
1275 struct block_spec
1276 {
1277    struct url_spec url[1];   /**< The URL pattern              */
1278    int    reject;            /**< FIXME: Please document this! */
1279    struct block_spec *next;  /**< Next entry in linked list    */
1280 };
1281
1282 /**
1283  * Arbitrary limit for the number of trusted referrers
1284  * Privoxy can print in its blocking message.
1285  */
1286 #define MAX_TRUSTED_REFERRERS 64
1287
1288 #endif /* def FEATURE_TRUST */
1289
1290
1291 #define SOCKS_NONE    0    /**< Don't use a SOCKS server               */
1292 #define SOCKS_4      40    /**< original SOCKS 4 protocol              */
1293 #define SOCKS_4A     41    /**< as modified for hosts w/o external DNS */
1294
1295
1296 /**
1297  * How to forward a connection to a parent proxy.
1298  */
1299 struct forward_spec
1300 {
1301    /** URL pattern that this forward_spec is for. */
1302    struct url_spec url[1];
1303
1304    /** Connection type.  Must be SOCKS_NONE, SOCKS_4, or SOCKS_4A. */
1305    int   type;
1306
1307    /** SOCKS server hostname.  Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1308    char *gateway_host;
1309
1310    /** SOCKS server port. */
1311    int   gateway_port;
1312
1313    /** Parent HTTP proxy hostname, or NULL for none. */
1314    char *forward_host;
1315
1316    /** Parent HTTP proxy port. */
1317    int   forward_port;
1318
1319    /** Next entry in the linked list. */
1320    struct forward_spec *next;
1321 };
1322
1323
1324 /**
1325  * Initializer for a static struct forward_spec.
1326  */
1327 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1328
1329
1330 /**
1331  * This struct represents one filter (one block) from
1332  * the re_filterfile. If there is more than one filter
1333  * in the file, the file will be represented by a
1334  * chained list of re_filterfile specs.
1335  */
1336 struct re_filterfile_spec
1337 {
1338    char *name;                      /**< Name from FILTER: statement in re_filterfile. */
1339    char *description;               /**< Description from FILTER: statement in re_filterfile. */
1340    struct list patterns[1];         /**< The patterns from the re_filterfile. */
1341    pcrs_job *joblist;               /**< The resulting compiled pcrs_jobs. */
1342    struct re_filterfile_spec *next; /**< The pointer for chaining. */
1343 };
1344
1345
1346 #ifdef FEATURE_ACL
1347
1348 #define ACL_PERMIT   1  /**< Accept connection request */
1349 #define ACL_DENY     2  /**< Reject connection request */
1350
1351 /**
1352  * An IP address pattern.  Used to specify networks in the ACL.
1353  */
1354 struct access_control_addr
1355 {
1356    unsigned long addr;  /**< The IP address as an integer. */
1357    unsigned long mask;  /**< The network mask as an integer. */
1358    unsigned long port;  /**< The port number. */
1359 };
1360
1361 /**
1362  * An access control list (ACL) entry.
1363  *
1364  * This is a linked list.
1365  */
1366 struct access_control_list
1367 {
1368    struct access_control_addr src[1];  /**< Client IP address */
1369    struct access_control_addr dst[1];  /**< Website or parent proxy IP address */
1370
1371    short action;                       /**< ACL_PERMIT or ACL_DENY */
1372    struct access_control_list *next;   /**< The next entry in the ACL. */
1373 };
1374
1375 #endif /* def FEATURE_ACL */
1376
1377
1378 /** Maximum number of loaders (actions, re_filter, ...) */
1379 #define NLOADERS 8
1380
1381
1382 /** configuration_spec::feature_flags: CGI actions editor. */
1383 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS  1
1384
1385 /** configuration_spec::feature_flags: Web-based toggle. */
1386 #define RUNTIME_FEATURE_CGI_TOGGLE        2
1387
1388
1389 /**
1390  * Data loaded from the configuration file.
1391  *
1392  * (Anomaly: toggle is still handled through a global, not this structure)
1393  */
1394 struct configuration_spec
1395 {
1396    /** What to log */
1397    int debug;
1398
1399    /** Nonzero to enable multithreading. */
1400    int multi_threaded;
1401
1402    /**
1403     * Bitmask of features that can be enabled/disabled through the config
1404     * file.  Currently defined bits:
1405     *
1406     * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1407     * - RUNTIME_FEATURE_CGI_TOGGLE
1408     */
1409    unsigned feature_flags;
1410
1411    /** The log file name. */
1412    const char *logfile;
1413
1414    /** The config file directory. */
1415    const char *confdir;
1416
1417    /** The log file directory. */
1418    const char *logdir;
1419
1420    /** The full paths to the actions files. */
1421    const char *actions_file[MAX_AF_FILES];
1422
1423    /** The short names of the actions files. */
1424    const char *actions_file_short[MAX_AF_FILES];
1425
1426    /** The administrator's email address */
1427    char *admin_address;
1428
1429    /** A URL with info on this proxy */
1430    char *proxy_info_url;
1431
1432    /** URL to the user manual (on our website or local copy) */
1433    char *usermanual;
1434
1435    /** The file names of the pcre filter files. */
1436    const char *re_filterfile[MAX_AF_FILES];
1437
1438    /** The short names of the pcre filter files. */
1439    const char *re_filterfile_short[MAX_AF_FILES];
1440
1441 #ifdef FEATURE_COOKIE_JAR
1442
1443    /** The file name of the cookie jar file */
1444    const char * jarfile;
1445
1446    /** The handle to the cookie jar file */
1447    FILE * jar;
1448
1449 #endif /* def FEATURE_COOKIE_JAR */
1450
1451    /** IP address to bind to.  Defaults to HADDR_DEFAULT == 127.0.0.1. */
1452    const char *haddr;
1453
1454    /** Port to bind to.  Defaults to HADDR_PORT == 8118. */
1455    int         hport;
1456
1457    /** Size limit for IOB */
1458    size_t buffer_limit;
1459
1460 #ifdef FEATURE_TRUST
1461
1462    /** The file name of the trust file. */
1463    const char * trustfile;
1464
1465    /** FIXME: DOCME: Document this. */
1466    struct list trust_info[1];
1467
1468    /** FIXME: DOCME: Document this. */
1469    struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1470
1471 #endif /* def FEATURE_TRUST */
1472
1473 #ifdef FEATURE_ACL
1474
1475    /** The access control list (ACL). */
1476    struct access_control_list *acl;
1477
1478 #endif /* def FEATURE_ACL */
1479
1480    /** Information about parent proxies (forwarding). */
1481    struct forward_spec *forward;
1482
1483    /** All options from the config file, HTML-formatted. */
1484    char *proxy_args;
1485
1486    /** The configuration file object. */
1487    struct file_list *config_file_list;
1488
1489    /** List of loaders */
1490    int (*loaders[NLOADERS])(struct client_state *);
1491
1492    /** Nonzero if we need to bind() to the new port. */
1493    int need_bind;
1494 };
1495
1496 /** Calculates the number of elements in an array, using sizeof. */
1497 #define SZ(X)  (sizeof(X) / sizeof(*X))
1498
1499 #ifdef FEATURE_FORCE_LOAD
1500 /** The force load URL prefix. */
1501 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1502 #endif /* def FEATURE_FORCE_LOAD */
1503
1504 #ifdef FEATURE_NO_GIFS
1505 /** The MIME type for images ("image/png" or "image/gif"). */
1506 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1507 #else
1508 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1509 #endif /* def FEATURE_NO_GIFS */
1510
1511
1512 /*
1513  * Hardwired URLs
1514  */
1515
1516 /** URL for the Privoxy home page. */
1517 #define HOME_PAGE_URL     "http://www.privoxy.org/"
1518
1519 /** URL for the Privoxy user manual. */
1520 #define USER_MANUAL_URL   HOME_PAGE_URL VERSION "/user-manual/"
1521
1522 /** Prefix for actions help links  (append to USER_MANUAL_URL). */
1523 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1524
1525 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1526 #define CONFIG_HELP_PREFIX  "config.html#"
1527
1528 /*
1529  * The "hosts" to intercept and display CGI pages.
1530  * First one is a hostname only, second one can specify host and path.
1531  *
1532  * Notes:
1533  * 1) Do not specify the http: prefix
1534  * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1535  * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1536  */
1537 #define CGI_SITE_1_HOST "p.p"
1538 #define CGI_SITE_2_HOST "config.privoxy.org"
1539 #define CGI_SITE_2_PATH ""
1540
1541 /**
1542  * The prefix for CGI pages.  Written out in generated HTML.
1543  * INCLUDES the trailing slash.
1544  */
1545 #define CGI_PREFIX  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1546
1547
1548 /* HTTP snipplets.
1549  *
1550  * FIXME: This is very inefficient.  There could be one copy of these strings
1551  * for each .c file!!  They should be "extern", not "static".
1552  */
1553 static const char CSUCCEED[] =
1554    "HTTP/1.0 200 Connection established\n"
1555    "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
1556
1557 static const char CHEADER[] =
1558    "HTTP/1.0 400 Invalid header received from browser\r\n\r\n";
1559
1560 static const char CFORBIDDEN[] =
1561    "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";
1562
1563 #ifdef __cplusplus
1564 } /* extern "C" */
1565 #endif
1566
1567 #endif /* ndef PROJECT_H_INCLUDED */
1568
1569 /*
1570   Local Variables:
1571   tab-width: 3
1572   end:
1573 */