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