project.h

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