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