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