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