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.178 2012/07/27 17:36:06 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   enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
 339   char  *status;                    /**< HTTP status (string). */
 340   struct list headers[1];           /**< List of header lines. */
 341   char  *head;                      /**< Formatted http response head. */
 342   size_t head_length;               /**< Length of http response head. */
 343   char  *body;                      /**< HTTP document body. */
 344   size_t content_length;            /**< Length of body, REQUIRED if binary body. */
 345   int    is_static;                 /**< Nonzero if the content will never change and
 346                                          should be cached by the browser (e.g. images). */
 347 };
 348
 349 /**
 350  * A URL or a tag pattern.
 351  */
 352 struct url_spec
 353 {
 354    /** The string which was parsed to produce this url_spec.
 355        Used for debugging or display only.  */
 356    char  *spec;
 357
 358 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
 359    regex_t *host_regex;/**< Regex for host matching                          */
 360 #else
 361    char  *dbuffer;     /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
 362    char **dvec;        /**< List of pointers to the strings in dbuffer.       */
 363    int    dcount;      /**< How many parts to this domain? (length of dvec)   */
 364    int    unanchored;  /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT.  */
 365 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
 366
 367    char  *port_list;   /**< List of acceptable ports, or NULL to match all ports */
 368
 369    regex_t *preg;      /**< Regex for matching path part                      */
 370    regex_t *tag_regex; /**< Regex for matching tags                           */
 371 };
 372
 373 /**
 374  * If you declare a static url_spec, this is the value to initialize it to zero.
 375  */
 376 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
 377 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
 378 #else
 379 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
 380 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
 381
 382 /**
 383  * Constant for host part matching in URLs.  If set, indicates that the start of
 384  * the pattern must match the start of the URL.  E.g. this is not set for the
 385  * pattern ".example.com", so that it will match both "example.com" and
 386  * "www.example.com".  It is set for the pattern "example.com", which makes it
 387  * match "example.com" only, not "www.example.com".
 388  */
 389 #define ANCHOR_LEFT  1
 390
 391 /**
 392  * Constant for host part matching in URLs.  If set, indicates that the end of
 393  * the pattern must match the end of the URL.  E.g. this is not set for the
 394  * pattern "ad.", so that it will match any host called "ad", irrespective
 395  * of how many subdomains are in the fully-qualified domain name.
 396  */
 397 #define ANCHOR_RIGHT 2
 398
 399
 400 /**
 401  * An I/O buffer.  Holds a string which can be appended to, and can have data
 402  * removed from the beginning.
 403  */
 404 struct iob
 405 {
 406    char *buf;    /**< Start of buffer        */
 407    char *cur;    /**< Start of relevant data */
 408    char *eod;    /**< End of relevant data   */
 409    size_t size;  /**< Size as malloc()ed     */
 410 };
 411
 412
 413 /**
 414  * Return the number of bytes in the I/O buffer associated with the passed
 415  * client_state pointer.
 416  * May be zero.
 417  */
 418 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
 419
 420
 421 /**
 422  * Remove any data in the I/O buffer associated with the passed
 423  * client_state pointer.
 424  */
 425 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
 426
 427 /* Bits for csp->content_type bitmask: */
 428 #define CT_TEXT    0x0001U /**< Suitable for pcrs filtering. */
 429 #define CT_GIF     0x0002U /**< Suitable for GIF filtering.  */
 430 #define CT_TABOO   0x0004U /**< DO NOT filter, irrespective of other flags. */
 431
 432 /* Although these are not, strictly speaking, content types
 433  * (they are content encodings), it is simple to handle them
 434  * as such.
 435  */
 436 #define CT_GZIP    0x0010U /**< gzip-compressed data. */
 437 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
 438
 439 /**
 440  * Flag to signal that the server declared the content type,
 441  * so we can differentiate between unknown and undeclared
 442  * content types.
 443  */
 444 #define CT_DECLARED 0x0040U
 445
 446 /**
 447  * The mask which includes all actions.
 448  */
 449 #define ACTION_MASK_ALL        (~0UL)
 450
 451 /**
 452  * The most compatible set of actions - i.e. none.
 453  */
 454 #define ACTION_MOST_COMPATIBLE                       0x00000000UL
 455
 456 /** Action bitmap: Block the request. */
 457 #define ACTION_BLOCK                                 0x00000001UL
 458 /** Action bitmap: Deanimate if it's a GIF. */
 459 #define ACTION_DEANIMATE                             0x00000002UL
 460 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
 461 #define ACTION_DOWNGRADE                             0x00000004UL
 462 /** Action bitmap: Fast redirects. */
 463 #define ACTION_FAST_REDIRECTS                        0x00000008UL
 464 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
 465 #define ACTION_CHANGE_X_FORWARDED_FOR                0x00000010UL
 466 /** Action bitmap: Hide "From" header. */
 467 #define ACTION_HIDE_FROM                             0x00000020UL
 468 /** Action bitmap: Hide "Referer" header.  (sic - follow HTTP, not English). */
 469 #define ACTION_HIDE_REFERER                          0x00000040UL
 470 /** Action bitmap: Hide "User-Agent" and similar headers. */
 471 #define ACTION_HIDE_USER_AGENT                       0x00000080UL
 472 /** Action bitmap: This is an image. */
 473 #define ACTION_IMAGE                                 0x00000100UL
 474 /** Action bitmap: Sets the image blocker. */
 475 #define ACTION_IMAGE_BLOCKER                         0x00000200UL
 476 /** Action bitmap: Prevent compression. */
 477 #define ACTION_NO_COMPRESSION                        0x00000400UL
 478 /** Action bitmap: Change cookies to session only cookies. */
 479 #define ACTION_NO_COOKIE_KEEP                        0x00000800UL
 480 /** Action bitmap: Block rending cookies. */
 481 #define ACTION_NO_COOKIE_READ                        0x00001000UL
 482 /** Action bitmap: Block setting cookies. */
 483 #define ACTION_NO_COOKIE_SET                         0x00002000UL
 484 /** Action bitmap: Override the forward settings in the config file */
 485 #define ACTION_FORWARD_OVERRIDE                      0x00004000UL
 486 /** Action bitmap: Block as empty document */
 487 #define  ACTION_HANDLE_AS_EMPTY_DOCUMENT             0x00008000UL
 488 /** Action bitmap: Limit CONNECT requests to safe ports. */
 489 #define ACTION_LIMIT_CONNECT                         0x00010000UL
 490 /** Action bitmap: Redirect request. */
 491 #define  ACTION_REDIRECT                             0x00020000UL
 492 /** Action bitmap: Crunch or modify "if-modified-since" header. */
 493 #define ACTION_HIDE_IF_MODIFIED_SINCE                0x00040000UL
 494 /** Action bitmap: Overwrite Content-Type header. */
 495 #define ACTION_CONTENT_TYPE_OVERWRITE                0x00080000UL
 496 /** Action bitmap: Crunch specified server header. */
 497 #define ACTION_CRUNCH_SERVER_HEADER                  0x00100000UL
 498 /** Action bitmap: Crunch specified client header */
 499 #define ACTION_CRUNCH_CLIENT_HEADER                  0x00200000UL
 500 /** Action bitmap: Enable text mode by force */
 501 #define ACTION_FORCE_TEXT_MODE                       0x00400000UL
 502 /** Action bitmap: Enable text mode by force */
 503 #define ACTION_CRUNCH_IF_NONE_MATCH                  0x00800000UL
 504 /** Action bitmap: Enable content-disposition crunching */
 505 #define ACTION_HIDE_CONTENT_DISPOSITION              0x01000000UL
 506 /** Action bitmap: Replace or block Last-Modified header */
 507 #define ACTION_OVERWRITE_LAST_MODIFIED               0x02000000UL
 508 /** Action bitmap: Replace or block Accept-Language header */
 509 #define ACTION_HIDE_ACCEPT_LANGUAGE                  0x04000000UL
 510
 511
 512 /** Action string index: How to deanimate GIFs */
 513 #define ACTION_STRING_DEANIMATE             0
 514 /** Action string index: Replacement for "From:" header */
 515 #define ACTION_STRING_FROM                  1
 516 /** Action string index: How to block images */
 517 #define ACTION_STRING_IMAGE_BLOCKER         2
 518 /** Action string index: Replacement for "Referer:" header */
 519 #define ACTION_STRING_REFERER               3
 520 /** Action string index: Replacement for "User-Agent:" header */
 521 #define ACTION_STRING_USER_AGENT            4
 522 /** Action string index: Legal CONNECT ports. */
 523 #define ACTION_STRING_LIMIT_CONNECT         5
 524 /** Action string index: Server headers containing this pattern are crunched*/
 525 #define ACTION_STRING_SERVER_HEADER         6
 526 /** Action string index: Client headers containing this pattern are crunched*/
 527 #define ACTION_STRING_CLIENT_HEADER         7
 528 /** Action string index: Replacement for the "Accept-Language:" header*/
 529 #define ACTION_STRING_LANGUAGE              8
 530 /** Action string index: Replacement for the "Content-Type:" header*/
 531 #define ACTION_STRING_CONTENT_TYPE          9
 532 /** Action string index: Replacement for the "content-disposition:" header*/
 533 #define ACTION_STRING_CONTENT_DISPOSITION  10
 534 /** Action string index: Replacement for the "If-Modified-Since:" header*/
 535 #define ACTION_STRING_IF_MODIFIED_SINCE    11
 536 /** Action string index: Replacement for the "Last-Modified:" header. */
 537 #define ACTION_STRING_LAST_MODIFIED        12
 538 /** Action string index: Redirect URL */
 539 #define ACTION_STRING_REDIRECT             13
 540 /** Action string index: Decode before redirect? */
 541 #define ACTION_STRING_FAST_REDIRECTS       14
 542 /** Action string index: Overriding forward rule. */
 543 #define ACTION_STRING_FORWARD_OVERRIDE     15
 544 /** Action string index: Reason for the block. */
 545 #define ACTION_STRING_BLOCK                16
 546 /** Action string index: what to do with the "X-Forwarded-For" header. */
 547 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
 548 /** Number of string actions. */
 549 #define ACTION_STRING_COUNT                18
 550
 551
 552 /* To make the ugly hack in sed easier to understand */
 553 #define CHECK_EVERY_HEADER_REMAINING 0
 554
 555
 556 /** Index into current_action_spec::multi[] for headers to add. */
 557 #define ACTION_MULTI_ADD_HEADER              0
 558 /** Index into current_action_spec::multi[] for content filters to apply. */
 559 #define ACTION_MULTI_FILTER                  1
 560 /** Index into current_action_spec::multi[] for server-header filters to apply. */
 561 #define ACTION_MULTI_SERVER_HEADER_FILTER    2
 562 /** Index into current_action_spec::multi[] for client-header filters to apply. */
 563 #define ACTION_MULTI_CLIENT_HEADER_FILTER    3
 564 /** Index into current_action_spec::multi[] for client-header tags to apply. */
 565 #define ACTION_MULTI_CLIENT_HEADER_TAGGER    4
 566 /** Index into current_action_spec::multi[] for server-header tags to apply. */
 567 #define ACTION_MULTI_SERVER_HEADER_TAGGER    5
 568 /** Number of multi-string actions. */
 569 #define ACTION_MULTI_COUNT                   6
 570
 571
 572 /**
 573  * This structure contains a list of actions to apply to a URL.
 574  * It only contains positive instructions - no "-" options.
 575  * It is not used to store the actions list itself, only for
 576  * url_actions() to return the current values.
 577  */
 578 struct current_action_spec
 579 {
 580    /** Actions to apply.  A bit set to "1" means perform the action. */
 581    unsigned long flags;
 582
 583    /**
 584     * Paramaters for those actions that require them.
 585     * Each entry is valid if & only if the corresponding entry in "flags" is
 586     * set.
 587     */
 588    char * string[ACTION_STRING_COUNT];
 589
 590    /** Lists of strings for multi-string actions. */
 591    struct list multi[ACTION_MULTI_COUNT][1];
 592 };
 593
 594
 595 /**
 596  * This structure contains a set of changes to actions.
 597  * It can contain both positive and negative instructions.
 598  * It is used to store an entry in the actions list.
 599  */
 600 struct action_spec
 601 {
 602    unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
 603    unsigned long add;  /**< Actions to add.  A bit set to "1" means add action.    */
 604
 605    /**
 606     * Paramaters for those actions that require them.
 607     * Each entry is valid if & only if the corresponding entry in "flags" is
 608     * set.
 609     */
 610    char * string[ACTION_STRING_COUNT];
 611
 612    /** Lists of strings to remove, for multi-string actions. */
 613    struct list multi_remove[ACTION_MULTI_COUNT][1];
 614
 615    /** If nonzero, remove *all* strings from the multi-string action. */
 616    int         multi_remove_all[ACTION_MULTI_COUNT];
 617
 618    /** Lists of strings to add, for multi-string actions. */
 619    struct list multi_add[ACTION_MULTI_COUNT][1];
 620 };
 621
 622
 623 /**
 624  * This structure is used to store action files.
 625  *
 626  * It contains an URL or tag pattern, and the changes to
 627  * the actions. It's a linked list and should only be
 628  * free'd through unload_actions_file() unless there's
 629  * only a single entry.
 630  */
 631 struct url_actions
 632 {
 633    struct url_spec url[1];     /**< The URL or tag pattern. */
 634
 635    struct action_spec *action; /**< Action settings that might be shared with
 636                                     the list entry before or after the current
 637                                     one and can't be free'd willy nilly. */
 638
 639    struct url_actions *next;   /**< Next action section in file, or NULL. */
 640 };
 641
 642
 643 /*
 644  * Structure to hold the server socket and the information
 645  * required to make sure we only reuse the connection if
 646  * the host and forwarding settings are the same.
 647  */
 648 struct reusable_connection
 649 {
 650    jb_socket sfd;
 651    int       in_use;
 652    time_t    timestamp; /* XXX: rename? */
 653
 654    time_t    request_sent;
 655    time_t    response_received;
 656
 657    /*
 658     * Number of seconds after which this
 659     * connection will no longer be reused.
 660     */
 661    unsigned int keep_alive_timeout;
 662
 663    char *host;
 664    int  port;
 665    int  forwarder_type;
 666    char *gateway_host;
 667    int  gateway_port;
 668    char *forward_host;
 669    int  forward_port;
 670 };
 671
 672
 673 /*
 674  * Flags for use in csp->flags
 675  */
 676
 677 /**
 678  * Flag for csp->flags: Set if this client is processing data.
 679  * Cleared when the thread associated with this structure dies.
 680  */
 681 #define CSP_FLAG_ACTIVE     0x01U
 682
 683 /**
 684  * Flag for csp->flags: Set if the server's reply is in "chunked"
 685  * transfer encoding
 686  */
 687 #define CSP_FLAG_CHUNKED    0x02U
 688
 689 /**
 690  * Flag for csp->flags: Set if this request was enforced, although it would
 691  * normally have been blocked.
 692  */
 693 #define CSP_FLAG_FORCED     0x04U
 694
 695 /**
 696  * Flag for csp->flags: Set if any modification to the body was done.
 697  */
 698 #define CSP_FLAG_MODIFIED   0x08U
 699
 700 /**
 701  * Flag for csp->flags: Set if request was blocked.
 702  */
 703 #define CSP_FLAG_REJECTED   0x10U
 704
 705 /**
 706  * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
 707  */
 708 #define CSP_FLAG_TOGGLED_ON 0x20U
 709
 710 /**
 711  * Flag for csp->flags: Set if we answered the request ourselve.
 712  */
 713 #define CSP_FLAG_CRUNCHED   0x40U
 714
 715 /**
 716  * Flag for csp->flags: Set if an acceptable Connection header
 717  * has already been set by the client.
 718  */
 719 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET  0x00000040U
 720
 721 /**
 722  * Flag for csp->flags: Set if an acceptable Connection header
 723  * has already been set by the server.
 724  */
 725 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET  0x00000080U
 726
 727 /**
 728  * Flag for csp->flags: Signals header parsers whether they
 729  * are parsing server or client headers.
 730  */
 731 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE    0x00000100U
 732
 733 /**
 734  * Flag for csp->flags: Set if adding the Host: header
 735  * isn't necessary.
 736  */
 737 #define CSP_FLAG_HOST_HEADER_IS_SET            0x00000200U
 738
 739 /**
 740  * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
 741  * XXX: As we now have tags we might as well ditch this.
 742  */
 743 #define CSP_FLAG_NO_FILTERING                  0x00000400U
 744
 745 /**
 746  * Flag for csp->flags: Set the client IP has appended to
 747  * an already existing X-Forwarded-For header in which case
 748  * no new header has to be generated.
 749  */
 750 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED      0x00000800U
 751
 752 /**
 753  * Flag for csp->flags: Set if the server wants to keep
 754  * the connection alive.
 755  */
 756 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE  0x00001000U
 757
 758 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 759 /**
 760  * Flag for csp->flags: Set if the server specified the
 761  * content length.
 762  */
 763 #define CSP_FLAG_SERVER_CONTENT_LENGTH_SET     0x00002000U
 764
 765 /**
 766  * Flag for csp->flags: Set if we know the content length,
 767  * either because the server set it, or we figured it out
 768  * on our own.
 769  */
 770 #define CSP_FLAG_CONTENT_LENGTH_SET            0x00004000U
 771
 772 /**
 773  * Flag for csp->flags: Set if the client wants to keep
 774  * the connection alive.
 775  */
 776 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE  0x00008000U
 777
 778 /**
 779  * Flag for csp->flags: Set if we think we got the whole
 780  * client request and shouldn't read any additional data
 781  * coming from the client until the current request has
 782  * been dealt with.
 783  */
 784 #define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
 785
 786 /**
 787  * Flag for csp->flags: Set if the server promised us to
 788  * keep the connection open for a known number of seconds.
 789  */
 790 #define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET  0x00020000U
 791
 792 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
 793
 794 /**
 795  * Flag for csp->flags: Set if we think we can't reuse
 796  * the server socket. XXX: It's also set after sabotaging
 797  * pipelining attempts which is somewhat inconsistent with
 798  * the name.
 799  */
 800 #define CSP_FLAG_SERVER_SOCKET_TAINTED          0x00040000U
 801
 802 /**
 803  * Flag for csp->flags: Set if the Proxy-Connection header
 804  * is among the server headers.
 805  */
 806 #define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
 807
 808 /**
 809  * Flag for csp->flags: Set if the client reused its connection.
 810  */
 811 #define CSP_FLAG_REUSED_CLIENT_CONNECTION           0x00100000U
 812
 813 /**
 814  * Flag for csp->flags: Set if the supports deflate compression.
 815  */
 816 #define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE            0x00200000U
 817
 818 /**
 819  * Flag for csp->flags: Set if the content has been deflated by Privoxy
 820  */
 821 #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED          0x00400000U
 822
 823
 824 /*
 825  * Flags for use in return codes of child processes
 826  */
 827
 828 /**
 829  * Flag for process return code: Set if exiting porcess has been toggled
 830  * during its lifetime.
 831  */
 832 #define RC_FLAG_TOGGLED   0x10
 833
 834 /**
 835  * Flag for process return code: Set if exiting porcess has blocked its
 836  * request.
 837  */
 838 #define RC_FLAG_BLOCKED   0x20
 839
 840 /**
 841  * Maximum number of actions/filter files.  This limit is arbitrary - it's just used
 842  * to size an array.
 843  */
 844 #define MAX_AF_FILES 10
 845
 846 /**
 847  * Maximum number of sockets to listen to.  This limit is arbitrary - it's just used
 848  * to size an array.
 849  */
 850 #define MAX_LISTENING_SOCKETS 10
 851
 852 /**
 853  * The state of a Privoxy processing thread.
 854  */
 855 struct client_state
 856 {
 857    /** The proxy's configuration */
 858    struct configuration_spec * config;
 859
 860    /** The actions to perform on the current request */
 861    struct current_action_spec  action[1];
 862
 863    /** socket to talk to client (web browser) */
 864    jb_socket cfd;
 865
 866    /** current connection to the server (may go through a proxy) */
 867    struct reusable_connection server_connection;
 868
 869    /** Multi-purpose flag container, see CSP_FLAG_* above */
 870    unsigned int flags;
 871
 872    /** Client PC's IP address, as reported by the accept() function.
 873        As a string. */
 874    char *ip_addr_str;
 875 #ifdef HAVE_RFC2553
 876    /** Client PC's TCP address, as reported by the accept() function.
 877        As a sockaddr. */
 878    struct sockaddr_storage tcp_addr;
 879 #else
 880    /** Client PC's IP address, as reported by the accept() function.
 881        As a number. */
 882    unsigned long ip_addr_long;
 883 #endif /* def HAVE_RFC2553 */
 884
 885    /** The URL that was requested */
 886    struct http_request http[1];
 887
 888    /*
 889     * The final forwarding settings.
 890     * XXX: Currently this is only used for forward-override,
 891     * so we can free the space in sweep.
 892     */
 893    struct forward_spec * fwd;
 894
 895    /** An I/O buffer used for buffering data read from the network */
 896    struct iob iob[1];
 897
 898    /** List of all headers for this request */
 899    struct list headers[1];
 900
 901    /** List of all tags that apply to this request */
 902    struct list tags[1];
 903
 904    /** MIME-Type key, see CT_* above */
 905    unsigned int content_type;
 906
 907    /** Actions files associated with this client */
 908    struct file_list *actions_list[MAX_AF_FILES];
 909
 910    /** pcrs job files. */
 911    struct file_list *rlist[MAX_AF_FILES];
 912
 913    /** Length after content modification. */
 914    unsigned long long content_length;
 915
 916 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 917    /* XXX: is this the right location? */
 918
 919    /** Expected length of content after which we
 920     * should stop reading from the server socket.
 921     */
 922    unsigned long long expected_content_length;
 923
 924    /** Expected length of content after which we
 925     *  should stop reading from the client socket.
 926     */
 927    unsigned long long expected_client_content_length;
 928 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
 929
 930 #ifdef FEATURE_TRUST
 931
 932    /** Trust file. */
 933    struct file_list *tlist;
 934
 935 #endif /* def FEATURE_TRUST */
 936
 937    /**
 938     * Failure reason to embedded in the CGI error page,
 939     * or NULL. Currently only used for socks errors.
 940     */
 941    char *error_message;
 942 };
 943
 944 /**
 945  * List of client states so the main thread can keep
 946  * track of them and garbage collect their resources.
 947  */
 948 struct client_states
 949 {
 950    struct client_states *next;
 951    struct client_state csp;
 952 };
 953
 954 /**
 955  * A function to add a header
 956  */
 957 typedef jb_err (*add_header_func_ptr)(struct client_state *);
 958
 959 /**
 960  * A function to process a header
 961  */
 962 typedef jb_err (*parser_func_ptr    )(struct client_state *, char **);
 963
 964
 965 /**
 966  * List of available CGI functions.
 967  */
 968 struct cgi_dispatcher
 969 {
 970    /** The URL of the CGI, relative to the CGI root. */
 971    const char * const name;
 972
 973    /** The handler function for the CGI */
 974    jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
 975
 976    /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
 977    const char * const description;
 978
 979    /** A flag that indicates whether unintentional calls to this CGI can cause damage */
 980    int harmless;
 981 };
 982
 983
 984 /**
 985  * A data file used by Privoxy.  Kept in a linked list.
 986  */
 987 struct file_list
 988 {
 989    /**
 990     * This is a pointer to the data structures associated with the file.
 991     * Read-only once the structure has been created.
 992     */
 993    void *f;
 994
 995    /**
 996     * The unloader function.
 997     * Normally NULL.  When we are finished with file (i.e. when we have
 998     * loaded a new one), set to a pointer to an unloader function.
 999     * Unloader will be called by sweep() (called from main loop) when
1000     * all clients using this file are done.  This prevents threading
1001     * problems.
1002     */
1003    void (*unloader)(void *);
1004
1005    /**
1006     * Used internally by sweep().  Do not access from elsewhere.
1007     */
1008    int active;
1009
1010    /**
1011     * File last-modified time, so we can check if file has been changed.
1012     * Read-only once the structure has been created.
1013     */
1014    time_t lastmodified;
1015
1016    /**
1017     * The full filename.
1018     */
1019    char * filename;
1020
1021    /**
1022     * Pointer to next entry in the linked list of all "file_list"s.
1023     * This linked list is so that sweep() can navigate it.
1024     * Since sweep() can remove items from the list, we must be careful
1025     * to only access this value from main thread (when we know sweep
1026     * won't be running).
1027     */
1028    struct file_list *next;
1029 };
1030
1031
1032 #ifdef FEATURE_TRUST
1033
1034 /**
1035  * The format of a trust file when loaded into memory.
1036  */
1037 struct block_spec
1038 {
1039    struct url_spec url[1];   /**< The URL pattern              */
1040    int    reject;            /**< FIXME: Please document this! */
1041    struct block_spec *next;  /**< Next entry in linked list    */
1042 };
1043
1044 /**
1045  * Arbitrary limit for the number of trusted referrers.
1046  */
1047 #define MAX_TRUSTED_REFERRERS 512
1048
1049 #endif /* def FEATURE_TRUST */
1050
1051 enum forwarder_type {
1052    /**< Don't use a SOCKS server               */
1053    SOCKS_NONE =  0,
1054    /**< original SOCKS 4 protocol              */
1055    SOCKS_4    = 40,
1056    /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
1057    SOCKS_4A   = 41,
1058    /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
1059    SOCKS_5    = 50,
1060 };
1061
1062 /**
1063  * How to forward a connection to a parent proxy.
1064  */
1065 struct forward_spec
1066 {
1067    /** URL pattern that this forward_spec is for. */
1068    struct url_spec url[1];
1069
1070    /** Connection type.  Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1071    enum forwarder_type type;
1072
1073    /** SOCKS server hostname.  Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1074    char *gateway_host;
1075
1076    /** SOCKS server port. */
1077    int   gateway_port;
1078
1079    /** Parent HTTP proxy hostname, or NULL for none. */
1080    char *forward_host;
1081
1082    /** Parent HTTP proxy port. */
1083    int   forward_port;
1084
1085    /** Next entry in the linked list. */
1086    struct forward_spec *next;
1087 };
1088
1089
1090 /**
1091  * Initializer for a static struct forward_spec.
1092  */
1093 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1094
1095 /* Supported filter types */
1096 enum filter_type
1097 {
1098    FT_CONTENT_FILTER       = 0,
1099    FT_CLIENT_HEADER_FILTER = 1,
1100    FT_SERVER_HEADER_FILTER = 2,
1101    FT_CLIENT_HEADER_TAGGER = 3,
1102    FT_SERVER_HEADER_TAGGER = 4,
1103    FT_INVALID_FILTER       = 42,
1104 };
1105 #define MAX_FILTER_TYPES        5
1106
1107 /**
1108  * This struct represents one filter (one block) from
1109  * the re_filterfile. If there is more than one filter
1110  * in the file, the file will be represented by a
1111  * chained list of re_filterfile specs.
1112  */
1113 struct re_filterfile_spec
1114 {
1115    char *name;                      /**< Name from FILTER: statement in re_filterfile. */
1116    char *description;               /**< Description from FILTER: statement in re_filterfile. */
1117    struct list patterns[1];         /**< The patterns from the re_filterfile. */
1118    pcrs_job *joblist;               /**< The resulting compiled pcrs_jobs. */
1119    enum filter_type type;           /**< Filter type (content, client-header, server-header). */
1120    int dynamic;                     /**< Set to one if the pattern might contain variables
1121                                          and has to be recompiled for every request. */
1122    struct re_filterfile_spec *next; /**< The pointer for chaining. */
1123 };
1124
1125
1126 #ifdef FEATURE_ACL
1127
1128 #define ACL_PERMIT   1  /**< Accept connection request */
1129 #define ACL_DENY     2  /**< Reject connection request */
1130
1131 /**
1132  * An IP address pattern.  Used to specify networks in the ACL.
1133  */
1134 struct access_control_addr
1135 {
1136 #ifdef HAVE_RFC2553
1137    struct sockaddr_storage addr; /* <The TCP address in network order. */
1138    struct sockaddr_storage mask; /* <The TCP mask in network order. */
1139 #else
1140    unsigned long addr;  /**< The IP address as an integer. */
1141    unsigned long mask;  /**< The network mask as an integer. */
1142    unsigned long port;  /**< The port number. */
1143 #endif /* HAVE_RFC2553 */
1144 };
1145
1146 /**
1147  * An access control list (ACL) entry.
1148  *
1149  * This is a linked list.
1150  */
1151 struct access_control_list
1152 {
1153    struct access_control_addr src[1];  /**< Client IP address */
1154    struct access_control_addr dst[1];  /**< Website or parent proxy IP address */
1155 #ifdef HAVE_RFC2553
1156    int wildcard_dst;                   /** < dst address is wildcard */
1157 #endif
1158
1159    short action;                       /**< ACL_PERMIT or ACL_DENY */
1160    struct access_control_list *next;   /**< The next entry in the ACL. */
1161 };
1162
1163 #endif /* def FEATURE_ACL */
1164
1165
1166 /** Maximum number of loaders (actions, re_filter, ...) */
1167 #define NLOADERS 8
1168
1169
1170 /** configuration_spec::feature_flags: CGI actions editor. */
1171 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS             1U
1172
1173 /** configuration_spec::feature_flags: Web-based toggle. */
1174 #define RUNTIME_FEATURE_CGI_TOGGLE                   2U
1175
1176 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1177 #define RUNTIME_FEATURE_HTTP_TOGGLE                  4U
1178
1179 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1180 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS            8U
1181
1182 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1183 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1184
1185 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1186 #define RUNTIME_FEATURE_ENFORCE_BLOCKS              32U
1187
1188 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1189 #define RUNTIME_FEATURE_CGI_CRUNCHING               64U
1190
1191 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1192 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE      128U
1193
1194 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1195 #define RUNTIME_FEATURE_CONNECTION_SHARING         256U
1196
1197 /** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */
1198 #define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK       512U
1199
1200 /** configuration_spec::feature_flags: Buffered content is sent compressed if the client supports it. */
1201 #define RUNTIME_FEATURE_COMPRESSION               1024U
1202
1203 /**
1204  * Data loaded from the configuration file.
1205  *
1206  * (Anomaly: toggle is still handled through a global, not this structure)
1207  */
1208 struct configuration_spec
1209 {
1210    /** What to log */
1211    int debug;
1212
1213    /** Nonzero to enable multithreading. */
1214    int multi_threaded;
1215
1216    /**
1217     * Bitmask of features that can be enabled/disabled through the config
1218     * file.  Currently defined bits:
1219     *
1220     * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1221     * - RUNTIME_FEATURE_CGI_TOGGLE
1222     * - RUNTIME_FEATURE_HTTP_TOGGLE
1223     * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1224     * - RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS
1225     * - RUNTIME_FEATURE_ENFORCE_BLOCKS
1226     * - RUNTIME_FEATURE_CGI_CRUNCHING
1227     * - RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE
1228     * - RUNTIME_FEATURE_CONNECTION_SHARING
1229     * - RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK
1230     */
1231    unsigned feature_flags;
1232
1233    /** The log file name. */
1234    const char *logfile;
1235
1236    /** The config file directory. */
1237    const char *confdir;
1238
1239    /** The directory for customized CGI templates. */
1240    const char *templdir;
1241
1242    /** The log file directory. */
1243    const char *logdir;
1244
1245    /** The full paths to the actions files. */
1246    const char *actions_file[MAX_AF_FILES];
1247
1248    /** The short names of the actions files. */
1249    const char *actions_file_short[MAX_AF_FILES];
1250
1251    /** The administrator's email address */
1252    char *admin_address;
1253
1254    /** A URL with info on this proxy */
1255    char *proxy_info_url;
1256
1257    /** URL to the user manual (on our website or local copy) */
1258    char *usermanual;
1259
1260    /** The file names of the pcre filter files. */
1261    const char *re_filterfile[MAX_AF_FILES];
1262
1263    /** The short names of the pcre filter files. */
1264    const char *re_filterfile_short[MAX_AF_FILES];
1265
1266    /**< List of ordered client header names. */
1267    struct list ordered_client_headers[1];
1268
1269    /** The hostname to show on CGI pages, or NULL to use the real one. */
1270    const char *hostname;
1271
1272    /** IP addresses to bind to.  Defaults to HADDR_DEFAULT == 127.0.0.1. */
1273    const char *haddr[MAX_LISTENING_SOCKETS];
1274
1275    /** Ports to bind to.  Defaults to HADDR_PORT == 8118. */
1276    int         hport[MAX_LISTENING_SOCKETS];
1277
1278    /** Size limit for IOB */
1279    size_t buffer_limit;
1280
1281 #ifdef FEATURE_TRUST
1282
1283    /** The file name of the trust file. */
1284    const char * trustfile;
1285
1286    /** FIXME: DOCME: Document this. */
1287    struct list trust_info[1];
1288
1289    /** FIXME: DOCME: Document this. */
1290    struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1291
1292 #endif /* def FEATURE_TRUST */
1293
1294 #ifdef FEATURE_ACL
1295
1296    /** The access control list (ACL). */
1297    struct access_control_list *acl;
1298
1299 #endif /* def FEATURE_ACL */
1300
1301    /** Information about parent proxies (forwarding). */
1302    struct forward_spec *forward;
1303
1304    /** Number of retries in case a forwarded connection attempt fails */
1305    int forwarded_connect_retries;
1306
1307    /** Maximum number of client connections. */
1308    int max_client_connections;
1309
1310    /* Timeout when waiting on sockets for data to become available. */
1311    int socket_timeout;
1312
1313 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1314    /* Maximum number of seconds after which an open connection will no longer be reused. */
1315    unsigned int keep_alive_timeout;
1316
1317    /* Assumed server-side keep alive timeout if none is specified. */
1318    unsigned int default_server_timeout;
1319 #endif
1320
1321 #ifdef FEATURE_COMPRESSION
1322    int compression_level;
1323 #endif
1324
1325    /** All options from the config file, HTML-formatted. */
1326    char *proxy_args;
1327
1328    /** The configuration file object. */
1329    struct file_list *config_file_list;
1330
1331    /** List of loaders */
1332    int (*loaders[NLOADERS])(struct client_state *);
1333
1334    /** Nonzero if we need to bind() to the new port. */
1335    int need_bind;
1336 };
1337
1338 /** Calculates the number of elements in an array, using sizeof. */
1339 #define SZ(X)  (sizeof(X) / sizeof(*X))
1340
1341 #ifdef FEATURE_FORCE_LOAD
1342 /** The force load URL prefix. */
1343 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1344 #endif /* def FEATURE_FORCE_LOAD */
1345
1346 #ifdef FEATURE_NO_GIFS
1347 /** The MIME type for images ("image/png" or "image/gif"). */
1348 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1349 #else
1350 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1351 #endif /* def FEATURE_NO_GIFS */
1352
1353
1354 /*
1355  * Hardwired URLs
1356  */
1357
1358 /** URL for the Privoxy home page. */
1359 #define HOME_PAGE_URL     "http://www.privoxy.org/"
1360
1361 /** URL for the Privoxy user manual. */
1362 #define USER_MANUAL_URL   HOME_PAGE_URL VERSION "/user-manual/"
1363
1364 /** Prefix for actions help links  (append to USER_MANUAL_URL). */
1365 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1366
1367 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1368 #define CONFIG_HELP_PREFIX  "config.html#"
1369
1370 /*
1371  * The "hosts" to intercept and display CGI pages.
1372  * First one is a hostname only, second one can specify host and path.
1373  *
1374  * Notes:
1375  * 1) Do not specify the http: prefix
1376  * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1377  * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1378  */
1379 #define CGI_SITE_1_HOST "p.p"
1380 #define CGI_SITE_2_HOST "config.privoxy.org"
1381 #define CGI_SITE_2_PATH ""
1382
1383 /**
1384  * The prefix for CGI pages.  Written out in generated HTML.
1385  * INCLUDES the trailing slash.
1386  */
1387 #define CGI_PREFIX  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1388
1389 #ifdef __cplusplus
1390 } /* extern "C" */
1391 #endif
1392
1393 #endif /* ndef PROJECT_H_INCLUDED */
1394
1395 /*
1396   Local Variables:
1397   tab-width: 3
1398   end:
1399 */