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