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