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