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