src/project.h

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