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.197 2013/11/24 14:21:58 fabiankeil 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-2012 the
  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  *********************************************************************/
  39
  40
  41 /* Declare struct FILE for vars and funcs. */
  42 #include <stdio.h>
  43
  44 /* Need time_t for file_list */
  45 #include <time.h>
  46 /* Needed for pcre choice */
  47 #include "config.h"
  48
  49 /* Need for struct sockaddr_storage */
  50 #ifdef HAVE_RFC2553
  51 #  ifndef _WIN32
  52 #    include <netdb.h>
  53 #    include <sys/socket.h>
  54 #  else
  55 #    include <stdint.h>
  56 #    include <winsock2.h>
  57 #    include <ws2tcpip.h>
  58      typedef unsigned short in_port_t;
  59 #  endif
  60 #endif
  61
  62
  63 /*
  64  * Include appropriate regular expression libraries.
  65  * Note that pcrs and pcre (native) are needed for cgi
  66  * and are included anyway.
  67  */
  68
  69 #ifdef STATIC_PCRE
  70 #  include "pcre.h"
  71 #else
  72 #  ifdef PCRE_H_IN_SUBDIR
  73 #    include <pcre/pcre.h>
  74 #  else
  75 #    include <pcre.h>
  76 #  endif
  77 #endif
  78
  79 #ifdef STATIC_PCRS
  80 #  include "pcrs.h"
  81 #else
  82 #  include <pcrs.h>
  83 #endif
  84
  85 #ifdef STATIC_PCRE
  86 #  include "pcreposix.h"
  87 #else
  88 #  ifdef PCRE_H_IN_SUBDIR
  89 #    include <pcre/pcreposix.h>
  90 #  else
  91 #    include <pcreposix.h>
  92 #  endif
  93 #endif
  94
  95 #ifdef AMIGA
  96 #include "amiga.h"
  97 #endif /* def AMIGA */
  98
  99 #ifdef _WIN32
 100 /*
 101  * I don't want to have to #include all this just for the declaration
 102  * of SOCKET.  However, it looks like we have to...
 103  */
 104 #ifndef STRICT
 105 #define STRICT
 106 #endif
 107 #include <windows.h>
 108 #endif
 109
 110
 111 #ifdef __cplusplus
 112 extern "C" {
 113 #endif
 114
 115 #ifdef _WIN32
 116
 117 typedef SOCKET jb_socket;
 118
 119 #define JB_INVALID_SOCKET INVALID_SOCKET
 120
 121 #else /* ndef _WIN32 */
 122
 123 /**
 124  * The type used by sockets.  On UNIX it's an int.  Microsoft decided to
 125  * make it an unsigned.
 126  */
 127 typedef int jb_socket;
 128
 129 /**
 130  * The error value used for variables of type jb_socket.  On UNIX this
 131  * is -1, however Microsoft decided to make socket handles unsigned, so
 132  * they use a different value.
 133  */
 134
 135 #define JB_INVALID_SOCKET (-1)
 136
 137 #endif /* ndef _WIN32 */
 138
 139
 140 /**
 141  * A standard error code.  This should be JB_ERR_OK or one of the JB_ERR_xxx
 142  * series of errors.
 143  */
 144 typedef int jb_err;
 145
 146 #define JB_ERR_OK         0 /**< Success, no error                        */
 147 #define JB_ERR_MEMORY     1 /**< Out of memory                            */
 148 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters        */
 149 #define JB_ERR_FILE       3 /**< Error opening, reading or writing a file */
 150 #define JB_ERR_PARSE      4 /**< Error parsing file                       */
 151 #define JB_ERR_MODIFIED   5 /**< File has been modified outside of the
 152                                  CGI actions editor.                      */
 153 #define JB_ERR_COMPRESS   6 /**< Error on decompression                   */
 154
 155 /**
 156  * This macro is used to free a pointer that may be NULL.
 157  * It also sets the variable to NULL after it's been freed.
 158  * The paramater should be a simple variable without side effects.
 159  */
 160 #define freez(X)  { if(X) { free((void*)X); X = NULL ; } }
 161
 162
 163 /**
 164  * Macro definitions for platforms where isspace() and friends
 165  * are macros that use their argument directly as an array index
 166  * and thus better be positive. Supposedly that's the case on
 167  * some unspecified Solaris versions.
 168  * Note: Remember to #include <ctype.h> if you use these macros.
 169  */
 170 #define privoxy_isdigit(__X) isdigit((int)(unsigned char)(__X))
 171 #define privoxy_isupper(__X) isupper((int)(unsigned char)(__X))
 172 #define privoxy_toupper(__X) toupper((int)(unsigned char)(__X))
 173 #define privoxy_tolower(__X) tolower((int)(unsigned char)(__X))
 174 #define privoxy_isspace(__X) isspace((int)(unsigned char)(__X))
 175
 176 /**
 177  * Use for statically allocated buffers if you have no other choice.
 178  * Remember to check the length of what you write into the buffer
 179  * - we don't want any buffer overflows!
 180  */
 181 #define BUFFER_SIZE 5000
 182
 183 /**
 184  * Max length of CGI parameters (arbitrary limit).
 185  */
 186 #define CGI_PARAM_LEN_MAX 500U
 187
 188 /**
 189  * Buffer size for capturing struct hostent data in the
 190  * gethostby(name|addr)_r library calls. Since we don't
 191  * loop over gethostbyname_r, the buffer must be sufficient
 192  * to accommodate multiple IN A RRs, as used in DNS round robin
 193  * load balancing. W3C's wwwlib uses 1K, so that should be
 194  * good enough for us, too.
 195  */
 196 /**
 197  * XXX: Temporary doubled, for some configurations
 198  * 1K is still too small and we didn't get the
 199  * real fix ready for inclusion.
 200  */
 201 #define HOSTENT_BUFFER_SIZE 2048
 202
 203 /**
 204  * Do not use.  Originally this was so that you can
 205  * say "while (FOREVER) { ...do something... }".
 206  * However, this gives a warning with some compilers (e.g. VC++).
 207  * Instead, use "for (;;) { ...do something... }".
 208  */
 209 #define FOREVER 1
 210
 211 /**
 212  * Default TCP/IP address to listen on, as a string.
 213  * Set to "127.0.0.1:8118".
 214  */
 215 #define HADDR_DEFAULT   "127.0.0.1:8118"
 216
 217
 218 /* Forward def for struct client_state */
 219 struct configuration_spec;
 220
 221
 222 /**
 223  * Entry in a linked list of strings.
 224  */
 225 struct list_entry
 226 {
 227    /**
 228     * The string pointer. It must point to a dynamically malloc()ed
 229     * string or be NULL for the list functions to work. In the latter
 230     * case, just be careful next time you iterate through the list in
 231     * your own code.
 232     */
 233    char *str;
 234
 235    /** Next entry in the linked list, or NULL if no more. */
 236    struct list_entry *next;
 237 };
 238
 239 /**
 240  * A header for a linked list of strings.
 241  */
 242 struct list
 243 {
 244    /** First entry in the list, or NULL if the list is empty. */
 245    struct list_entry *first;
 246
 247    /** Last entry in the list, or NULL if the list is empty. */
 248    struct list_entry *last;
 249 };
 250
 251
 252 /**
 253  * An entry in a map.  This is a name=value pair.
 254  */
 255 struct map_entry
 256 {
 257    /** The key for the map. */
 258    const char *name;
 259    /** The value associated with that key. */
 260    const char *value;
 261    /** The next map entry, or NULL if none. */
 262    struct map_entry *next;
 263 };
 264
 265 /**
 266  * A map from a string to another string.
 267  * This is used for the paramaters passed in a HTTP GET request, and
 268  * to store the exports when the CGI interface is filling in a template.
 269  */
 270 struct map
 271 {
 272    /** The first map entry, or NULL if the map is empty. */
 273    struct map_entry *first;
 274    /** The last map entry, or NULL if the map is empty. */
 275    struct map_entry *last;
 276 };
 277
 278
 279 /**
 280  * A HTTP request.  This includes the method (GET, POST) and
 281  * the parsed URL.
 282  *
 283  * This is also used whenever we want to match a URL against a
 284  * URL pattern.  This always contains the URL to match, and never
 285  * a URL pattern.  (See struct url_spec).
 286  */
 287 struct http_request
 288 {
 289    char *cmd;      /**< Whole command line: method, URL, Version */
 290    char *ocmd;     /**< Backup of original cmd for CLF logging */
 291    char *gpc;      /**< HTTP method: GET, POST, ... */
 292    char *url;      /**< The URL */
 293    char *ver;      /**< Protocol version */
 294    int status;     /**< HTTP Status */
 295
 296    char *host;     /**< Host part of URL */
 297    int   port;     /**< Port of URL or 80 (default) */
 298    char *path;     /**< Path of URL */
 299    char *hostport; /**< host[:port] */
 300    int   ssl;      /**< Flag if protocol is https */
 301
 302    char *host_ip_addr_str; /**< String with dotted decimal representation
 303                                 of host's IP. NULL before connect_to() */
 304
 305 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
 306    char  *dbuffer; /**< Buffer with '\0'-delimited domain name.           */
 307    char **dvec;    /**< List of pointers to the strings in dbuffer.       */
 308    int    dcount;  /**< How many parts to this domain? (length of dvec)   */
 309 #endif /* ndef FEATURE_EXTENDED_HOST_PATTERNS */
 310 };
 311
 312 /**
 313  * Reasons for generating a http_response instead of delivering
 314  * the requested resource. Mostly ordered the way they are checked
 315  * for in chat().
 316  */
 317 enum crunch_reason
 318 {
 319    UNSUPPORTED,
 320    BLOCKED,
 321    UNTRUSTED,
 322    REDIRECTED,
 323    CGI_CALL,
 324    NO_SUCH_DOMAIN,
 325    FORWARDING_FAILED,
 326    CONNECT_FAILED,
 327    OUT_OF_MEMORY,
 328    INTERNAL_ERROR,
 329    CONNECTION_TIMEOUT,
 330    NO_SERVER_DATA
 331 };
 332
 333 /**
 334  * Response generated by CGI, blocker, or error handler
 335  */
 336 struct http_response
 337 {
 338   char  *status;                    /**< HTTP status (string). */
 339   struct list headers[1];           /**< List of header lines. */
 340   char  *head;                      /**< Formatted http response head. */
 341   size_t head_length;               /**< Length of http response head. */
 342   char  *body;                      /**< HTTP document body. */
 343   size_t content_length;            /**< Length of body, REQUIRED if binary body. */
 344   int    is_static;                 /**< Nonzero if the content will never change and
 345                                          should be cached by the browser (e.g. images). */
 346   enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
 347 };
 348
 349 struct url_spec
 350 {
 351 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
 352    regex_t *host_regex;/**< Regex for host matching                          */
 353 #else
 354    char  *dbuffer;     /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
 355    char **dvec;        /**< List of pointers to the strings in dbuffer.       */
 356    int    dcount;      /**< How many parts to this domain? (length of dvec)   */
 357    int    unanchored;  /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT.  */
 358 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
 359
 360    char  *port_list;   /**< List of acceptable ports, or NULL to match all ports */
 361
 362    regex_t *preg;      /**< Regex for matching path part                      */
 363 };
 364
 365 /**
 366  * A URL or a tag pattern.
 367  */
 368 struct pattern_spec
 369 {
 370    /** The string which was parsed to produce this pattern_spec.
 371        Used for debugging or display only.  */
 372    char  *spec;
 373
 374    union
 375    {
 376       struct url_spec url_spec;
 377       regex_t *tag_regex;
 378    } pattern;
 379
 380    unsigned int flags; /**< Bitmap with various pattern properties. */
 381 };
 382
 383 /**
 384  * Constant for host part matching in URLs.  If set, indicates that the start of
 385  * the pattern must match the start of the URL.  E.g. this is not set for the
 386  * pattern ".example.com", so that it will match both "example.com" and
 387  * "www.example.com".  It is set for the pattern "example.com", which makes it
 388  * match "example.com" only, not "www.example.com".
 389  */
 390 #define ANCHOR_LEFT  1
 391
 392 /**
 393  * Constant for host part matching in URLs.  If set, indicates that the end of
 394  * the pattern must match the end of the URL.  E.g. this is not set for the
 395  * pattern "ad.", so that it will match any host called "ad", irrespective
 396  * of how many subdomains are in the fully-qualified domain name.
 397  */
 398 #define ANCHOR_RIGHT 2
 399
 400
 401 /**
 402  * An I/O buffer.  Holds a string which can be appended to, and can have data
 403  * removed from the beginning.
 404  */
 405 struct iob
 406 {
 407    char *buf;    /**< Start of buffer        */
 408    char *cur;    /**< Start of relevant data */
 409    char *eod;    /**< End of relevant data   */
 410    size_t size;  /**< Size as malloc()ed     */
 411 };
 412
 413
 414 /**
 415  * Return the number of bytes in the I/O buffer associated with the passed
 416  * I/O buffer. May be zero.
 417  */
 418 #define IOB_PEEK(IOB) ((IOB->cur > IOB->eod) ? (IOB->eod - IOB->cur) : 0)
 419
 420
 421 /* Bits for csp->content_type bitmask: */
 422 #define CT_TEXT    0x0001U /**< Suitable for pcrs filtering. */
 423 #define CT_GIF     0x0002U /**< Suitable for GIF filtering.  */
 424 #define CT_TABOO   0x0004U /**< DO NOT filter, irrespective of other flags. */
 425
 426 /* Although these are not, strictly speaking, content types
 427  * (they are content encodings), it is simple to handle them
 428  * as such.
 429  */
 430 #define CT_GZIP    0x0010U /**< gzip-compressed data. */
 431 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
 432
 433 /**
 434  * Flag to signal that the server declared the content type,
 435  * so we can differentiate between unknown and undeclared
 436  * content types.
 437  */
 438 #define CT_DECLARED 0x0040U
 439
 440 /**
 441  * The mask which includes all actions.
 442  */
 443 #define ACTION_MASK_ALL        (~0UL)
 444
 445 /**
 446  * The most compatible set of actions - i.e. none.
 447  */
 448 #define ACTION_MOST_COMPATIBLE                       0x00000000UL
 449
 450 /** Action bitmap: Block the request. */
 451 #define ACTION_BLOCK                                 0x00000001UL
 452 /** Action bitmap: Deanimate if it's a GIF. */
 453 #define ACTION_DEANIMATE                             0x00000002UL
 454 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
 455 #define ACTION_DOWNGRADE                             0x00000004UL
 456 /** Action bitmap: Fast redirects. */
 457 #define ACTION_FAST_REDIRECTS                        0x00000008UL
 458 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
 459 #define ACTION_CHANGE_X_FORWARDED_FOR                0x00000010UL
 460 /** Action bitmap: Hide "From" header. */
 461 #define ACTION_HIDE_FROM                             0x00000020UL
 462 /** Action bitmap: Hide "Referer" header.  (sic - follow HTTP, not English). */
 463 #define ACTION_HIDE_REFERER                          0x00000040UL
 464 /** Action bitmap: Hide "User-Agent" and similar headers. */
 465 #define ACTION_HIDE_USER_AGENT                       0x00000080UL
 466 /** Action bitmap: This is an image. */
 467 #define ACTION_IMAGE                                 0x00000100UL
 468 /** Action bitmap: Sets the image blocker. */
 469 #define ACTION_IMAGE_BLOCKER                         0x00000200UL
 470 /** Action bitmap: Prevent compression. */
 471 #define ACTION_NO_COMPRESSION                        0x00000400UL
 472 /** Action bitmap: Change cookies to session only cookies. */
 473 #define ACTION_SESSION_COOKIES_ONLY                  0x00000800UL
 474 /** Action bitmap: Block cookies coming from the client. */
 475 #define ACTION_CRUNCH_OUTGOING_COOKIES               0x00001000UL
 476 /** Action bitmap: Block cookies coming from the server. */
 477 #define ACTION_CRUNCH_INCOMING_COOKIES               0x00002000UL
 478 /** Action bitmap: Override the forward settings in the config file */
 479 #define ACTION_FORWARD_OVERRIDE                      0x00004000UL
 480 /** Action bitmap: Block as empty document */
 481 #define  ACTION_HANDLE_AS_EMPTY_DOCUMENT             0x00008000UL
 482 /** Action bitmap: Limit CONNECT requests to safe ports. */
 483 #define ACTION_LIMIT_CONNECT                         0x00010000UL
 484 /** Action bitmap: Redirect request. */
 485 #define  ACTION_REDIRECT                             0x00020000UL
 486 /** Action bitmap: Crunch or modify "if-modified-since" header. */
 487 #define ACTION_HIDE_IF_MODIFIED_SINCE                0x00040000UL
 488 /** Action bitmap: Overwrite Content-Type header. */
 489 #define ACTION_CONTENT_TYPE_OVERWRITE                0x00080000UL
 490 /** Action bitmap: Crunch specified server header. */
 491 #define ACTION_CRUNCH_SERVER_HEADER                  0x00100000UL
 492 /** Action bitmap: Crunch specified client header */
 493 #define ACTION_CRUNCH_CLIENT_HEADER                  0x00200000UL
 494 /** Action bitmap: Enable text mode by force */
 495 #define ACTION_FORCE_TEXT_MODE                       0x00400000UL
 496 /** Action bitmap: Enable text mode by force */
 497 #define ACTION_CRUNCH_IF_NONE_MATCH                  0x00800000UL
 498 /** Action bitmap: Enable content-disposition crunching */
 499 #define ACTION_HIDE_CONTENT_DISPOSITION              0x01000000UL
 500 /** Action bitmap: Replace or block Last-Modified header */
 501 #define ACTION_OVERWRITE_LAST_MODIFIED               0x02000000UL
 502 /** Action bitmap: Replace or block Accept-Language header */
 503 #define ACTION_HIDE_ACCEPT_LANGUAGE                  0x04000000UL
 504 /** Action bitmap: Limit the cookie lifetime */
 505 #define ACTION_LIMIT_COOKIE_LIFETIME                 0x08000000UL
 506
 507
 508 /** Action string index: How to deanimate GIFs */
 509 #define ACTION_STRING_DEANIMATE             0
 510 /** Action string index: Replacement for "From:" header */
 511 #define ACTION_STRING_FROM                  1
 512 /** Action string index: How to block images */
 513 #define ACTION_STRING_IMAGE_BLOCKER         2
 514 /** Action string index: Replacement for "Referer:" header */
 515 #define ACTION_STRING_REFERER               3
 516 /** Action string index: Replacement for "User-Agent:" header */
 517 #define ACTION_STRING_USER_AGENT            4
 518 /** Action string index: Legal CONNECT ports. */
 519 #define ACTION_STRING_LIMIT_CONNECT         5
 520 /** Action string index: Server headers containing this pattern are crunched*/
 521 #define ACTION_STRING_SERVER_HEADER         6
 522 /** Action string index: Client headers containing this pattern are crunched*/
 523 #define ACTION_STRING_CLIENT_HEADER         7
 524 /** Action string index: Replacement for the "Accept-Language:" header*/
 525 #define ACTION_STRING_LANGUAGE              8
 526 /** Action string index: Replacement for the "Content-Type:" header*/
 527 #define ACTION_STRING_CONTENT_TYPE          9
 528 /** Action string index: Replacement for the "content-disposition:" header*/
 529 #define ACTION_STRING_CONTENT_DISPOSITION  10
 530 /** Action string index: Replacement for the "If-Modified-Since:" header*/
 531 #define ACTION_STRING_IF_MODIFIED_SINCE    11
 532 /** Action string index: Replacement for the "Last-Modified:" header. */
 533 #define ACTION_STRING_LAST_MODIFIED        12
 534 /** Action string index: Redirect URL */
 535 #define ACTION_STRING_REDIRECT             13
 536 /** Action string index: Decode before redirect? */
 537 #define ACTION_STRING_FAST_REDIRECTS       14
 538 /** Action string index: Overriding forward rule. */
 539 #define ACTION_STRING_FORWARD_OVERRIDE     15
 540 /** Action string index: Reason for the block. */
 541 #define ACTION_STRING_BLOCK                16
 542 /** Action string index: what to do with the "X-Forwarded-For" header. */
 543 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
 544 /** Action string index: how many minutes cookies should be valid. */
 545 #define ACTION_STRING_LIMIT_COOKIE_LIFETIME 18
 546 /** Number of string actions. */
 547 #define ACTION_STRING_COUNT                19
 548
 549
 550 /* To make the ugly hack in sed easier to understand */
 551 #define CHECK_EVERY_HEADER_REMAINING 0
 552
 553
 554 /** Index into current_action_spec::multi[] for headers to add. */
 555 #define ACTION_MULTI_ADD_HEADER              0
 556 /** Index into current_action_spec::multi[] for content filters to apply. */
 557 #define ACTION_MULTI_FILTER                  1
 558 /** Index into current_action_spec::multi[] for server-header filters to apply. */
 559 #define ACTION_MULTI_SERVER_HEADER_FILTER    2
 560 /** Index into current_action_spec::multi[] for client-header filters to apply. */
 561 #define ACTION_MULTI_CLIENT_HEADER_FILTER    3
 562 /** Index into current_action_spec::multi[] for client-header tags to apply. */
 563 #define ACTION_MULTI_CLIENT_HEADER_TAGGER    4
 564 /** Index into current_action_spec::multi[] for server-header tags to apply. */
 565 #define ACTION_MULTI_SERVER_HEADER_TAGGER    5
 566 /** Number of multi-string actions. */
 567 #define ACTION_MULTI_COUNT                   6
 568
 569
 570 /**
 571  * This structure contains a list of actions to apply to a URL.
 572  * It only contains positive instructions - no "-" options.
 573  * It is not used to store the actions list itself, only for
 574  * url_actions() to return the current values.
 575  */
 576 struct current_action_spec
 577 {
 578    /** Actions to apply.  A bit set to "1" means perform the action. */
 579    unsigned long flags;
 580
 581    /**
 582     * Paramaters for those actions that require them.
 583     * Each entry is valid if & only if the corresponding entry in "flags" is
 584     * set.
 585     */
 586    char * string[ACTION_STRING_COUNT];
 587
 588    /** Lists of strings for multi-string actions. */
 589    struct list multi[ACTION_MULTI_COUNT][1];
 590 };
 591
 592
 593 /**
 594  * This structure contains a set of changes to actions.
 595  * It can contain both positive and negative instructions.
 596  * It is used to store an entry in the actions list.
 597  */
 598 struct action_spec
 599 {
 600    unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
 601    unsigned long add;  /**< Actions to add.  A bit set to "1" means add action.    */
 602
 603    /**
 604     * Paramaters for those actions that require them.
 605     * Each entry is valid if & only if the corresponding entry in "flags" is
 606     * set.
 607     */
 608    char * string[ACTION_STRING_COUNT];
 609
 610    /** Lists of strings to remove, for multi-string actions. */
 611    struct list multi_remove[ACTION_MULTI_COUNT][1];
 612
 613    /** If nonzero, remove *all* strings from the multi-string action. */
 614    int         multi_remove_all[ACTION_MULTI_COUNT];
 615
 616    /** Lists of strings to add, for multi-string actions. */
 617    struct list multi_add[ACTION_MULTI_COUNT][1];
 618 };
 619
 620
 621 /**
 622  * This structure is used to store action files.
 623  *
 624  * It contains an URL or tag pattern, and the changes to
 625  * the actions. It's a linked list and should only be
 626  * free'd through unload_actions_file() unless there's
 627  * only a single entry.
 628  */
 629 struct url_actions
 630 {
 631    struct pattern_spec url[1]; /**< The URL or tag pattern. */
 632
 633    struct action_spec *action; /**< Action settings that might be shared with
 634                                     the list entry before or after the current
 635                                     one and can't be free'd willy nilly. */
 636
 637    struct url_actions *next;   /**< Next action section in file, or NULL. */
 638 };
 639
 640 enum forwarder_type {
 641    /**< Don't use a SOCKS server               */
 642    SOCKS_NONE =  0,
 643    /**< original SOCKS 4 protocol              */
 644    SOCKS_4    = 40,
 645    /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
 646    SOCKS_4A   = 41,
 647    /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
 648    SOCKS_5    = 50,
 649    /**< Like SOCKS5, but uses non-standard Tor extensions (currently only optimistic data) */
 650    SOCKS_5T,
 651 };
 652
 653 /*
 654  * Structure to hold the server socket and the information
 655  * required to make sure we only reuse the connection if
 656  * the host and forwarding settings are the same.
 657  */
 658 struct reusable_connection
 659 {
 660    jb_socket sfd;
 661    int       in_use;
 662    time_t    timestamp; /* XXX: rename? */
 663
 664    time_t    request_sent;
 665    time_t    response_received;
 666
 667    /*
 668     * Number of seconds after which this
 669     * connection will no longer be reused.
 670     */
 671    unsigned int keep_alive_timeout;
 672    /*
 673     * Number of requests that were sent to this connection.
 674     * This is currently only for debugging purposes.
 675     */
 676    unsigned int requests_sent_total;
 677
 678    char *host;
 679    int  port;
 680    enum forwarder_type forwarder_type;
 681    char *gateway_host;
 682    int  gateway_port;
 683    char *forward_host;
 684    int  forward_port;
 685 };
 686
 687
 688 /*
 689  * Flags for use in csp->flags
 690  */
 691
 692 /**
 693  * Flag for csp->flags: Set if this client is processing data.
 694  * Cleared when the thread associated with this structure dies.
 695  */
 696 #define CSP_FLAG_ACTIVE     0x01U
 697
 698 /**
 699  * Flag for csp->flags: Set if the server's reply is in "chunked"
 700  * transfer encoding
 701  */
 702 #define CSP_FLAG_CHUNKED    0x02U
 703
 704 /**
 705  * Flag for csp->flags: Set if this request was enforced, although it would
 706  * normally have been blocked.
 707  */
 708 #define CSP_FLAG_FORCED     0x04U
 709
 710 /**
 711  * Flag for csp->flags: Set if any modification to the body was done.
 712  */
 713 #define CSP_FLAG_MODIFIED   0x08U
 714
 715 /**
 716  * Flag for csp->flags: Set if request was blocked.
 717  */
 718 #define CSP_FLAG_REJECTED   0x10U
 719
 720 /**
 721  * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
 722  */
 723 #define CSP_FLAG_TOGGLED_ON 0x20U
 724
 725 /**
 726  * Flag for csp->flags: Set if we answered the request ourselve.
 727  */
 728 #define CSP_FLAG_CRUNCHED   0x40U
 729
 730 /**
 731  * Flag for csp->flags: Set if an acceptable Connection header
 732  * has already been set by the client.
 733  */
 734 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET  0x00000040U
 735
 736 /**
 737  * Flag for csp->flags: Set if an acceptable Connection header
 738  * has already been set by the server.
 739  */
 740 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET  0x00000080U
 741
 742 /**
 743  * Flag for csp->flags: Signals header parsers whether they
 744  * are parsing server or client headers.
 745  */
 746 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE    0x00000100U
 747
 748 /**
 749  * Flag for csp->flags: Set if adding the Host: header
 750  * isn't necessary.
 751  */
 752 #define CSP_FLAG_HOST_HEADER_IS_SET            0x00000200U
 753
 754 /**
 755  * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
 756  * XXX: As we now have tags we might as well ditch this.
 757  */
 758 #define CSP_FLAG_NO_FILTERING                  0x00000400U
 759
 760 /**
 761  * Flag for csp->flags: Set the client IP has appended to
 762  * an already existing X-Forwarded-For header in which case
 763  * no new header has to be generated.
 764  */
 765 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED      0x00000800U
 766
 767 /**
 768  * Flag for csp->flags: Set if the server wants to keep
 769  * the connection alive.
 770  */
 771 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE  0x00001000U
 772
 773 /**
 774  * Flag for csp->flags: Set if the server specified the
 775  * content length.
 776  */
 777 #define CSP_FLAG_SERVER_CONTENT_LENGTH_SET     0x00002000U
 778
 779 /**
 780  * Flag for csp->flags: Set if we know the content length,
 781  * either because the server set it, or we figured it out
 782  * on our own.
 783  */
 784 #define CSP_FLAG_CONTENT_LENGTH_SET            0x00004000U
 785
 786 /**
 787  * Flag for csp->flags: Set if the client wants to keep
 788  * the connection alive.
 789  */
 790 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE  0x00008000U
 791
 792 /**
 793  * Flag for csp->flags: Set if we think we got the whole
 794  * client request and shouldn't read any additional data
 795  * coming from the client until the current request has
 796  * been dealt with.
 797  */
 798 #define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
 799
 800 /**
 801  * Flag for csp->flags: Set if the server promised us to
 802  * keep the connection open for a known number of seconds.
 803  */
 804 #define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET  0x00020000U
 805
 806 /**
 807  * Flag for csp->flags: Set if we think we can't reuse
 808  * the server socket. XXX: It's also set after sabotaging
 809  * pipelining attempts which is somewhat inconsistent with
 810  * the name.
 811  */
 812 #define CSP_FLAG_SERVER_SOCKET_TAINTED          0x00040000U
 813
 814 /**
 815  * Flag for csp->flags: Set if the Proxy-Connection header
 816  * is among the server headers.
 817  */
 818 #define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
 819
 820 /**
 821  * Flag for csp->flags: Set if the client reused its connection.
 822  */
 823 #define CSP_FLAG_REUSED_CLIENT_CONNECTION           0x00100000U
 824
 825 /**
 826  * Flag for csp->flags: Set if the supports deflate compression.
 827  */
 828 #define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE            0x00200000U
 829
 830 /**
 831  * Flag for csp->flags: Set if the content has been deflated by Privoxy
 832  */
 833 #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED          0x00400000U
 834
 835 /**
 836  * Flag for csp->flags: Set if we already read (parts of)
 837  * a pipelined request in which case the client obviously
 838  * isn't done talking.
 839  */
 840 #define CSP_FLAG_PIPELINED_REQUEST_WAITING          0x00800000U
 841
 842 /**
 843  * Flag for csp->flags: Set if the client body is chunk-encoded
 844  */
 845 #define CSP_FLAG_CHUNKED_CLIENT_BODY                0x01000000U
 846
 847
 848 /*
 849  * Flags for use in return codes of child processes
 850  */
 851
 852 /**
 853  * Flag for process return code: Set if exiting porcess has been toggled
 854  * during its lifetime.
 855  */
 856 #define RC_FLAG_TOGGLED   0x10
 857
 858 /**
 859  * Flag for process return code: Set if exiting porcess has blocked its
 860  * request.
 861  */
 862 #define RC_FLAG_BLOCKED   0x20
 863
 864 /**
 865  * Maximum number of actions/filter files.  This limit is arbitrary - it's just used
 866  * to size an array.
 867  */
 868 #define MAX_AF_FILES 30
 869
 870 /**
 871  * Maximum number of sockets to listen to.  This limit is arbitrary - it's just used
 872  * to size an array.
 873  */
 874 #define MAX_LISTENING_SOCKETS 10
 875
 876 /**
 877  * The state of a Privoxy processing thread.
 878  */
 879 struct client_state
 880 {
 881    /** The proxy's configuration */
 882    struct configuration_spec * config;
 883
 884    /** The actions to perform on the current request */
 885    struct current_action_spec  action[1];
 886
 887    /** socket to talk to client (web browser) */
 888    jb_socket cfd;
 889
 890    /** Number of requests received on the client socket. */
 891    unsigned int requests_received_total;
 892
 893    /** current connection to the server (may go through a proxy) */
 894    struct reusable_connection server_connection;
 895
 896    /** Multi-purpose flag container, see CSP_FLAG_* above */
 897    unsigned int flags;
 898
 899    /** Client PC's IP address, as reported by the accept() function.
 900        As a string. */
 901    char *ip_addr_str;
 902 #ifdef HAVE_RFC2553
 903    /** Client PC's TCP address, as reported by the accept() function.
 904        As a sockaddr. */
 905    struct sockaddr_storage tcp_addr;
 906 #else
 907    /** Client PC's IP address, as reported by the accept() function.
 908        As a number. */
 909    unsigned long ip_addr_long;
 910 #endif /* def HAVE_RFC2553 */
 911
 912    /** The URL that was requested */
 913    struct http_request http[1];
 914
 915    /*
 916     * The final forwarding settings.
 917     * XXX: Currently this is only used for forward-override,
 918     * so we can free the space in sweep.
 919     */
 920    struct forward_spec * fwd;
 921
 922    /** An I/O buffer used for buffering data read from the server */
 923    /* XXX: should be renamed to server_iob */
 924    struct iob iob[1];
 925
 926    /** An I/O buffer used for buffering data read from the client */
 927    struct iob client_iob[1];
 928
 929    /** List of all headers for this request */
 930    struct list headers[1];
 931
 932    /** List of all tags that apply to this request */
 933    struct list tags[1];
 934
 935    /** MIME-Type key, see CT_* above */
 936    unsigned int content_type;
 937
 938    /** Actions files associated with this client */
 939    struct file_list *actions_list[MAX_AF_FILES];
 940
 941    /** pcrs job files. */
 942    struct file_list *rlist[MAX_AF_FILES];
 943
 944    /** Length after content modification. */
 945    unsigned long long content_length;
 946
 947    /* XXX: is this the right location? */
 948
 949    /** Expected length of content after which we
 950     * should stop reading from the server socket.
 951     */
 952    unsigned long long expected_content_length;
 953
 954    /** Expected length of content after which we
 955     *  should stop reading from the client socket.
 956     */
 957    unsigned long long expected_client_content_length;
 958
 959 #ifdef FEATURE_TRUST
 960
 961    /** Trust file. */
 962    struct file_list *tlist;
 963
 964 #endif /* def FEATURE_TRUST */
 965
 966    /**
 967     * Failure reason to embedded in the CGI error page,
 968     * or NULL. Currently only used for socks errors.
 969     */
 970    char *error_message;
 971 };
 972
 973 /**
 974  * List of client states so the main thread can keep
 975  * track of them and garbage collect their resources.
 976  */
 977 struct client_states
 978 {
 979    struct client_states *next;
 980    struct client_state csp;
 981 };
 982
 983 /**
 984  * A function to add a header
 985  */
 986 typedef jb_err (*add_header_func_ptr)(struct client_state *);
 987
 988 /**
 989  * A function to process a header
 990  */
 991 typedef jb_err (*parser_func_ptr    )(struct client_state *, char **);
 992
 993
 994 /**
 995  * List of available CGI functions.
 996  */
 997 struct cgi_dispatcher
 998 {
 999    /** The URL of the CGI, relative to the CGI root. */
1000    const char * const name;
1001
1002    /** The handler function for the CGI */
1003    jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1004
1005    /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1006    const char * const description;
1007
1008    /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1009    int harmless;
1010 };
1011
1012
1013 /**
1014  * A data file used by Privoxy.  Kept in a linked list.
1015  */
1016 struct file_list
1017 {
1018    /**
1019     * This is a pointer to the data structures associated with the file.
1020     * Read-only once the structure has been created.
1021     */
1022    void *f;
1023
1024    /**
1025     * The unloader function.
1026     * Normally NULL.  When we are finished with file (i.e. when we have
1027     * loaded a new one), set to a pointer to an unloader function.
1028     * Unloader will be called by sweep() (called from main loop) when
1029     * all clients using this file are done.  This prevents threading
1030     * problems.
1031     */
1032    void (*unloader)(void *);
1033
1034    /**
1035     * Used internally by sweep().  Do not access from elsewhere.
1036     */
1037    int active;
1038
1039    /**
1040     * File last-modified time, so we can check if file has been changed.
1041     * Read-only once the structure has been created.
1042     */
1043    time_t lastmodified;
1044
1045    /**
1046     * The full filename.
1047     */
1048    char * filename;
1049
1050    /**
1051     * Pointer to next entry in the linked list of all "file_list"s.
1052     * This linked list is so that sweep() can navigate it.
1053     * Since sweep() can remove items from the list, we must be careful
1054     * to only access this value from main thread (when we know sweep
1055     * won't be running).
1056     */
1057    struct file_list *next;
1058 };
1059
1060
1061 #ifdef FEATURE_TRUST
1062
1063 /**
1064  * The format of a trust file when loaded into memory.
1065  */
1066 struct block_spec
1067 {
1068    struct pattern_spec url[1]; /**< The URL pattern              */
1069    int    reject;              /**< FIXME: Please document this! */
1070    struct block_spec *next;    /**< Next entry in linked list    */
1071 };
1072
1073 /**
1074  * Arbitrary limit for the number of trusted referrers.
1075  */
1076 #define MAX_TRUSTED_REFERRERS 512
1077
1078 #endif /* def FEATURE_TRUST */
1079
1080 /**
1081  * How to forward a connection to a parent proxy.
1082  */
1083 struct forward_spec
1084 {
1085    /** URL pattern that this forward_spec is for. */
1086    struct pattern_spec url[1];
1087
1088    /** Connection type.  Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1089    enum forwarder_type type;
1090
1091    /** SOCKS server hostname.  Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1092    char *gateway_host;
1093
1094    /** SOCKS server port. */
1095    int   gateway_port;
1096
1097    /** Parent HTTP proxy hostname, or NULL for none. */
1098    char *forward_host;
1099
1100    /** Parent HTTP proxy port. */
1101    int   forward_port;
1102
1103    /** Next entry in the linked list. */
1104    struct forward_spec *next;
1105 };
1106
1107
1108 /* Supported filter types */
1109 enum filter_type
1110 {
1111    FT_CONTENT_FILTER       = 0,
1112    FT_CLIENT_HEADER_FILTER = 1,
1113    FT_SERVER_HEADER_FILTER = 2,
1114    FT_CLIENT_HEADER_TAGGER = 3,
1115    FT_SERVER_HEADER_TAGGER = 4,
1116    FT_INVALID_FILTER       = 42,
1117 };
1118 #define MAX_FILTER_TYPES        5
1119
1120 /**
1121  * This struct represents one filter (one block) from
1122  * the re_filterfile. If there is more than one filter
1123  * in the file, the file will be represented by a
1124  * chained list of re_filterfile specs.
1125  */
1126 struct re_filterfile_spec
1127 {
1128    char *name;                      /**< Name from FILTER: statement in re_filterfile. */
1129    char *description;               /**< Description from FILTER: statement in re_filterfile. */
1130    struct list patterns[1];         /**< The patterns from the re_filterfile. */
1131    pcrs_job *joblist;               /**< The resulting compiled pcrs_jobs. */
1132    enum filter_type type;           /**< Filter type (content, client-header, server-header). */
1133    int dynamic;                     /**< Set to one if the pattern might contain variables
1134                                          and has to be recompiled for every request. */
1135    struct re_filterfile_spec *next; /**< The pointer for chaining. */
1136 };
1137
1138
1139 #ifdef FEATURE_ACL
1140
1141 #define ACL_PERMIT   1  /**< Accept connection request */
1142 #define ACL_DENY     2  /**< Reject connection request */
1143
1144 /**
1145  * An IP address pattern.  Used to specify networks in the ACL.
1146  */
1147 struct access_control_addr
1148 {
1149 #ifdef HAVE_RFC2553
1150    struct sockaddr_storage addr; /* <The TCP address in network order. */
1151    struct sockaddr_storage mask; /* <The TCP mask in network order. */
1152 #else
1153    unsigned long addr;  /**< The IP address as an integer. */
1154    unsigned long mask;  /**< The network mask as an integer. */
1155    unsigned long port;  /**< The port number. */
1156 #endif /* HAVE_RFC2553 */
1157 };
1158
1159 /**
1160  * An access control list (ACL) entry.
1161  *
1162  * This is a linked list.
1163  */
1164 struct access_control_list
1165 {
1166    struct access_control_addr src[1];  /**< Client IP address */
1167    struct access_control_addr dst[1];  /**< Website or parent proxy IP address */
1168 #ifdef HAVE_RFC2553
1169    int wildcard_dst;                   /** < dst address is wildcard */
1170 #endif
1171
1172    short action;                       /**< ACL_PERMIT or ACL_DENY */
1173    struct access_control_list *next;   /**< The next entry in the ACL. */
1174 };
1175
1176 #endif /* def FEATURE_ACL */
1177
1178
1179 /** Maximum number of loaders (actions, re_filter, ...) */
1180 #define NLOADERS 8
1181
1182
1183 /** configuration_spec::feature_flags: CGI actions editor. */
1184 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS             1U
1185
1186 /** configuration_spec::feature_flags: Web-based toggle. */
1187 #define RUNTIME_FEATURE_CGI_TOGGLE                   2U
1188
1189 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1190 #define RUNTIME_FEATURE_HTTP_TOGGLE                  4U
1191
1192 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1193 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS            8U
1194
1195 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1196 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1197
1198 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1199 #define RUNTIME_FEATURE_ENFORCE_BLOCKS              32U
1200
1201 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1202 #define RUNTIME_FEATURE_CGI_CRUNCHING               64U
1203
1204 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1205 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE      128U
1206
1207 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1208 #define RUNTIME_FEATURE_CONNECTION_SHARING         256U
1209
1210 /** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */
1211 #define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK       512U
1212
1213 /** configuration_spec::feature_flags: Buffered content is sent compressed if the client supports it. */
1214 #define RUNTIME_FEATURE_COMPRESSION               1024U
1215
1216 /** configuration_spec::feature_flags: Pipelined requests are served instead of being discarded. */
1217 #define RUNTIME_FEATURE_TOLERATE_PIPELINING       2048U
1218
1219 /** configuration_spec::feature_flags: Proxy authentication headers are forwarded instead of removed. */
1220 #define RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS      4096U
1221
1222 /**
1223  * Data loaded from the configuration file.
1224  *
1225  * (Anomaly: toggle is still handled through a global, not this structure)
1226  */
1227 struct configuration_spec
1228 {
1229    /** What to log */
1230    int debug;
1231
1232    /** Nonzero to enable multithreading. */
1233    int multi_threaded;
1234
1235    /**
1236     * Bitmask of features that can be enabled/disabled through the config
1237     * file.  Currently defined bits:
1238     *
1239     * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1240     * - RUNTIME_FEATURE_CGI_TOGGLE
1241     * - RUNTIME_FEATURE_HTTP_TOGGLE
1242     * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1243     * - RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS
1244     * - RUNTIME_FEATURE_ENFORCE_BLOCKS
1245     * - RUNTIME_FEATURE_CGI_CRUNCHING
1246     * - RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE
1247     * - RUNTIME_FEATURE_CONNECTION_SHARING
1248     * - RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK
1249     */
1250    unsigned feature_flags;
1251
1252    /** The log file name. */
1253    const char *logfile;
1254
1255    /** The config file directory. */
1256    const char *confdir;
1257
1258    /** The directory for customized CGI templates. */
1259    const char *templdir;
1260
1261    /** The log file directory. */
1262    const char *logdir;
1263
1264    /** The full paths to the actions files. */
1265    const char *actions_file[MAX_AF_FILES];
1266
1267    /** The short names of the actions files. */
1268    const char *actions_file_short[MAX_AF_FILES];
1269
1270    /** The administrator's email address */
1271    char *admin_address;
1272
1273    /** A URL with info on this proxy */
1274    char *proxy_info_url;
1275
1276    /** URL to the user manual (on our website or local copy) */
1277    char *usermanual;
1278
1279    /** The file names of the pcre filter files. */
1280    const char *re_filterfile[MAX_AF_FILES];
1281
1282    /** The short names of the pcre filter files. */
1283    const char *re_filterfile_short[MAX_AF_FILES];
1284
1285    /**< List of ordered client header names. */
1286    struct list ordered_client_headers[1];
1287
1288    /** The hostname to show on CGI pages, or NULL to use the real one. */
1289    const char *hostname;
1290
1291    /** IP addresses to bind to.  Defaults to HADDR_DEFAULT == 127.0.0.1. */
1292    const char *haddr[MAX_LISTENING_SOCKETS];
1293
1294    /** Ports to bind to.  Defaults to HADDR_PORT == 8118. */
1295    int         hport[MAX_LISTENING_SOCKETS];
1296
1297    /** Size limit for IOB */
1298    size_t buffer_limit;
1299
1300 #ifdef FEATURE_TRUST
1301
1302    /** The file name of the trust file. */
1303    const char * trustfile;
1304
1305    /** FIXME: DOCME: Document this. */
1306    struct list trust_info[1];
1307
1308    /** FIXME: DOCME: Document this. */
1309    struct pattern_spec *trust_list[MAX_TRUSTED_REFERRERS];
1310
1311 #endif /* def FEATURE_TRUST */
1312
1313 #ifdef FEATURE_ACL
1314
1315    /** The access control list (ACL). */
1316    struct access_control_list *acl;
1317
1318 #endif /* def FEATURE_ACL */
1319
1320    /** Information about parent proxies (forwarding). */
1321    struct forward_spec *forward;
1322
1323    /** Number of retries in case a forwarded connection attempt fails */
1324    int forwarded_connect_retries;
1325
1326    /** Maximum number of client connections. */
1327    int max_client_connections;
1328
1329    /* Timeout when waiting on sockets for data to become available. */
1330    int socket_timeout;
1331
1332 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1333    /* Maximum number of seconds after which an open connection will no longer be reused. */
1334    unsigned int keep_alive_timeout;
1335
1336    /* Assumed server-side keep alive timeout if none is specified. */
1337    unsigned int default_server_timeout;
1338 #endif
1339
1340 #ifdef FEATURE_COMPRESSION
1341    int compression_level;
1342 #endif
1343
1344    /** All options from the config file, HTML-formatted. */
1345    char *proxy_args;
1346
1347    /** The configuration file object. */
1348    struct file_list *config_file_list;
1349
1350    /** List of loaders */
1351    int (*loaders[NLOADERS])(struct client_state *);
1352
1353    /** Nonzero if we need to bind() to the new port. */
1354    int need_bind;
1355 };
1356
1357 /** Calculates the number of elements in an array, using sizeof. */
1358 #define SZ(X)  (sizeof(X) / sizeof(*X))
1359
1360 #ifdef FEATURE_FORCE_LOAD
1361 /** The force load URL prefix. */
1362 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1363 #endif /* def FEATURE_FORCE_LOAD */
1364
1365 #ifdef FEATURE_NO_GIFS
1366 /** The MIME type for images ("image/png" or "image/gif"). */
1367 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1368 #else
1369 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1370 #endif /* def FEATURE_NO_GIFS */
1371
1372
1373 /*
1374  * Hardwired URLs
1375  */
1376
1377 /** URL for the Privoxy home page. */
1378 #define HOME_PAGE_URL     "http://www.privoxy.org/"
1379
1380 /** URL for the Privoxy user manual. */
1381 #define USER_MANUAL_URL   HOME_PAGE_URL VERSION "/user-manual/"
1382
1383 /** Prefix for actions help links  (append to USER_MANUAL_URL). */
1384 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1385
1386 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1387 #define CONFIG_HELP_PREFIX  "config.html#"
1388
1389 /*
1390  * The "hosts" to intercept and display CGI pages.
1391  * First one is a hostname only, second one can specify host and path.
1392  *
1393  * Notes:
1394  * 1) Do not specify the http: prefix
1395  * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1396  * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1397  */
1398 #define CGI_SITE_1_HOST "p.p"
1399 #define CGI_SITE_2_HOST "config.privoxy.org"
1400 #define CGI_SITE_2_PATH ""
1401
1402 /**
1403  * The prefix for CGI pages.  Written out in generated HTML.
1404  * INCLUDES the trailing slash.
1405  */
1406 #define CGI_PREFIX  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1407
1408 #ifdef __cplusplus
1409 } /* extern "C" */
1410 #endif
1411
1412 #endif /* ndef PROJECT_H_INCLUDED */
1413
1414 /*
1415   Local Variables:
1416   tab-width: 3
1417   end:
1418 */