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