project.h

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