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.171 2011/09/04 11:10:56 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-2010 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  * Fix a problem with Solaris.  There should be no effect on other
 165  * platforms.
 166  *
 167  * Solaris's isspace() is a macro which uses it's argument directly
 168  * as an array index.  Therefore we need to make sure that high-bit
 169  * characters generate +ve values, and ideally we also want to make
 170  * the argument match the declared parameter type of "int".
 171  *
 172  * Note: Remember to #include <ctype.h> if you use these macros.
 173  */
 174 #define ijb_isupper(__X) isupper((int)(unsigned char)(__X))
 175 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
 176 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
 177 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
 178
 179 /**
 180  * Use for statically allocated buffers if you have no other choice.
 181  * Remember to check the length of what you write into the buffer
 182  * - we don't want any buffer overflows!
 183  */
 184 #define BUFFER_SIZE 5000
 185
 186 /**
 187  * Max length of CGI parameters (arbitrary limit).
 188  */
 189 #define CGI_PARAM_LEN_MAX 500U
 190
 191 /**
 192  * Buffer size for capturing struct hostent data in the
 193  * gethostby(name|addr)_r library calls. Since we don't
 194  * loop over gethostbyname_r, the buffer must be sufficient
 195  * to accommodate multiple IN A RRs, as used in DNS round robin
 196  * load balancing. W3C's wwwlib uses 1K, so that should be
 197  * good enough for us, too.
 198  */
 199 /**
 200  * XXX: Temporary doubled, for some configurations
 201  * 1K is still too small and we didn't get the
 202  * real fix ready for inclusion.
 203  */
 204 #define HOSTENT_BUFFER_SIZE 2048
 205
 206 /**
 207  * Do not use.  Originally this was so that you can
 208  * say "while (FOREVER) { ...do something... }".
 209  * However, this gives a warning with some compilers (e.g. VC++).
 210  * Instead, use "for (;;) { ...do something... }".
 211  */
 212 #define FOREVER 1
 213
 214 /**
 215  * Default TCP/IP address to listen on, as a string.
 216  * Set to "127.0.0.1:8118".
 217  */
 218 #define HADDR_DEFAULT   "127.0.0.1:8118"
 219
 220
 221 /* Forward def for struct client_state */
 222 struct configuration_spec;
 223
 224
 225 /**
 226  * Entry in a linked list of strings.
 227  */
 228 struct list_entry
 229 {
 230    /**
 231     * The string pointer. It must point to a dynamically malloc()ed
 232     * string or be NULL for the list functions to work. In the latter
 233     * case, just be careful next time you iterate through the list in
 234     * your own code.
 235     */
 236    char *str;
 237
 238    /** Next entry in the linked list, or NULL if no more. */
 239    struct list_entry *next;
 240 };
 241
 242 /**
 243  * A header for a linked list of strings.
 244  */
 245 struct list
 246 {
 247    /** First entry in the list, or NULL if the list is empty. */
 248    struct list_entry *first;
 249
 250    /** Last entry in the list, or NULL if the list is empty. */
 251    struct list_entry *last;
 252 };
 253
 254
 255 /**
 256  * An entry in a map.  This is a name=value pair.
 257  */
 258 struct map_entry
 259 {
 260    /** The key for the map. */
 261    const char *name;
 262    /** The value associated with that key. */
 263    const char *value;
 264    /** The next map entry, or NULL if none. */
 265    struct map_entry *next;
 266 };
 267
 268 /**
 269  * A map from a string to another string.
 270  * This is used for the paramaters passed in a HTTP GET request, and
 271  * to store the exports when the CGI interface is filling in a template.
 272  */
 273 struct map
 274 {
 275    /** The first map entry, or NULL if the map is empty. */
 276    struct map_entry *first;
 277    /** The last map entry, or NULL if the map is empty. */
 278    struct map_entry *last;
 279 };
 280
 281
 282 /**
 283  * A HTTP request.  This includes the method (GET, POST) and
 284  * the parsed URL.
 285  *
 286  * This is also used whenever we want to match a URL against a
 287  * URL pattern.  This always contains the URL to match, and never
 288  * a URL pattern.  (See struct url_spec).
 289  */
 290 struct http_request
 291 {
 292    char *cmd;      /**< Whole command line: method, URL, Version */
 293    char *ocmd;     /**< Backup of original cmd for CLF logging */
 294    char *gpc;      /**< HTTP method: GET, POST, ... */
 295    char *url;      /**< The URL */
 296    char *ver;      /**< Protocol version */
 297    int status;     /**< HTTP Status */
 298
 299    char *host;     /**< Host part of URL */
 300    int   port;     /**< Port of URL or 80 (default) */
 301    char *path;     /**< Path of URL */
 302    char *hostport; /**< host[:port] */
 303    int   ssl;      /**< Flag if protocol is https */
 304
 305    char *host_ip_addr_str; /**< String with dotted decimal representation
 306                                 of host's IP. NULL before connect_to() */
 307
 308 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
 309    char  *dbuffer; /**< Buffer with '\0'-delimited domain name.           */
 310    char **dvec;    /**< List of pointers to the strings in dbuffer.       */
 311    int    dcount;  /**< How many parts to this domain? (length of dvec)   */
 312 #endif /* ndef FEATURE_EXTENDED_HOST_PATTERNS */
 313 };
 314
 315 /**
 316  * Reasons for generating a http_response instead of delivering
 317  * the requested resource. Mostly ordered the way they are checked
 318  * for in chat().
 319  */
 320 enum crunch_reason
 321 {
 322    UNSUPPORTED,
 323    BLOCKED,
 324    UNTRUSTED,
 325    REDIRECTED,
 326    CGI_CALL,
 327    NO_SUCH_DOMAIN,
 328    FORWARDING_FAILED,
 329    CONNECT_FAILED,
 330    OUT_OF_MEMORY,
 331    INTERNAL_ERROR,
 332    CONNECTION_TIMEOUT,
 333    NO_SERVER_DATA
 334 };
 335
 336 /**
 337  * Response generated by CGI, blocker, or error handler
 338  */
 339 struct http_response
 340 {
 341   enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
 342   char  *status;                    /**< HTTP status (string). */
 343   struct list headers[1];           /**< List of header lines. */
 344   char  *head;                      /**< Formatted http response head. */
 345   size_t head_length;               /**< Length of http response head. */
 346   char  *body;                      /**< HTTP document body. */
 347   size_t content_length;            /**< Length of body, REQUIRED if binary body. */
 348   int    is_static;                 /**< Nonzero if the content will never change and
 349                                          should be cached by the browser (e.g. images). */
 350 };
 351
 352 /**
 353  * A URL or a tag pattern.
 354  */
 355 struct url_spec
 356 {
 357    /** The string which was parsed to produce this url_spec.
 358        Used for debugging or display only.  */
 359    char  *spec;
 360
 361 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
 362    regex_t *host_regex;/**< Regex for host matching                          */
 363 #else
 364    char  *dbuffer;     /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
 365    char **dvec;        /**< List of pointers to the strings in dbuffer.       */
 366    int    dcount;      /**< How many parts to this domain? (length of dvec)   */
 367    int    unanchored;  /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT.  */
 368 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
 369
 370    char  *port_list;   /**< List of acceptable ports, or NULL to match all ports */
 371
 372    regex_t *preg;      /**< Regex for matching path part                      */
 373    regex_t *tag_regex; /**< Regex for matching tags                           */
 374 };
 375
 376 /**
 377  * If you declare a static url_spec, this is the value to initialize it to zero.
 378  */
 379 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
 380 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
 381 #else
 382 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
 383 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
 384
 385 /**
 386  * Constant for host part matching in URLs.  If set, indicates that the start of
 387  * the pattern must match the start of the URL.  E.g. this is not set for the
 388  * pattern ".example.com", so that it will match both "example.com" and
 389  * "www.example.com".  It is set for the pattern "example.com", which makes it
 390  * match "example.com" only, not "www.example.com".
 391  */
 392 #define ANCHOR_LEFT  1
 393
 394 /**
 395  * Constant for host part matching in URLs.  If set, indicates that the end of
 396  * the pattern must match the end of the URL.  E.g. this is not set for the
 397  * pattern "ad.", so that it will match any host called "ad", irrespective
 398  * of how many subdomains are in the fully-qualified domain name.
 399  */
 400 #define ANCHOR_RIGHT 2
 401
 402
 403 /**
 404  * An I/O buffer.  Holds a string which can be appended to, and can have data
 405  * removed from the beginning.
 406  */
 407 struct iob
 408 {
 409    char *buf;    /**< Start of buffer        */
 410    char *cur;    /**< Start of relevant data */
 411    char *eod;    /**< End of relevant data   */
 412    size_t size;  /**< Size as malloc()ed     */
 413 };
 414
 415
 416 /**
 417  * Return the number of bytes in the I/O buffer associated with the passed
 418  * client_state pointer.
 419  * May be zero.
 420  */
 421 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
 422
 423
 424 /**
 425  * Remove any data in the I/O buffer associated with the passed
 426  * client_state pointer.
 427  */
 428 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
 429
 430 /* Bits for csp->content_type bitmask: */
 431 #define CT_TEXT    0x0001U /**< Suitable for pcrs filtering. */
 432 #define CT_GIF     0x0002U /**< Suitable for GIF filtering.  */
 433 #define CT_TABOO   0x0004U /**< DO NOT filter, irrespective of other flags. */
 434
 435 /* Although these are not, strictly speaking, content types
 436  * (they are content encodings), it is simple to handle them
 437  * as such.
 438  */
 439 #define CT_GZIP    0x0010U /**< gzip-compressed data. */
 440 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
 441
 442 /**
 443  * Flag to signal that the server declared the content type,
 444  * so we can differentiate between unknown and undeclared
 445  * content types.
 446  */
 447 #define CT_DECLARED 0x0040U
 448
 449 /**
 450  * The mask which includes all actions.
 451  */
 452 #define ACTION_MASK_ALL        (~0UL)
 453
 454 /**
 455  * The most compatible set of actions - i.e. none.
 456  */
 457 #define ACTION_MOST_COMPATIBLE                       0x00000000UL
 458
 459 /** Action bitmap: Block the request. */
 460 #define ACTION_BLOCK                                 0x00000001UL
 461 /** Action bitmap: Deanimate if it's a GIF. */
 462 #define ACTION_DEANIMATE                             0x00000002UL
 463 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
 464 #define ACTION_DOWNGRADE                             0x00000004UL
 465 /** Action bitmap: Fast redirects. */
 466 #define ACTION_FAST_REDIRECTS                        0x00000008UL
 467 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
 468 #define ACTION_CHANGE_X_FORWARDED_FOR                0x00000010UL
 469 /** Action bitmap: Hide "From" header. */
 470 #define ACTION_HIDE_FROM                             0x00000020UL
 471 /** Action bitmap: Hide "Referer" header.  (sic - follow HTTP, not English). */
 472 #define ACTION_HIDE_REFERER                          0x00000040UL
 473 /** Action bitmap: Hide "User-Agent" and similar headers. */
 474 #define ACTION_HIDE_USER_AGENT                       0x00000080UL
 475 /** Action bitmap: This is an image. */
 476 #define ACTION_IMAGE                                 0x00000100UL
 477 /** Action bitmap: Sets the image blocker. */
 478 #define ACTION_IMAGE_BLOCKER                         0x00000200UL
 479 /** Action bitmap: Prevent compression. */
 480 #define ACTION_NO_COMPRESSION                        0x00000400UL
 481 /** Action bitmap: Change cookies to session only cookies. */
 482 #define ACTION_NO_COOKIE_KEEP                        0x00000800UL
 483 /** Action bitmap: Block rending cookies. */
 484 #define ACTION_NO_COOKIE_READ                        0x00001000UL
 485 /** Action bitmap: Block setting cookies. */
 486 #define ACTION_NO_COOKIE_SET                         0x00002000UL
 487 /** Action bitmap: Override the forward settings in the config file */
 488 #define ACTION_FORWARD_OVERRIDE                      0x00004000UL
 489 /** Action bitmap: Block as empty document */
 490 #define  ACTION_HANDLE_AS_EMPTY_DOCUMENT             0x00008000UL
 491 /** Action bitmap: Limit CONNECT requests to safe ports. */
 492 #define ACTION_LIMIT_CONNECT                         0x00010000UL
 493 /** Action bitmap: Redirect request. */
 494 #define  ACTION_REDIRECT                             0x00020000UL
 495 /** Action bitmap: Crunch or modify "if-modified-since" header. */
 496 #define ACTION_HIDE_IF_MODIFIED_SINCE                0x00040000UL
 497 /** Action bitmap: Overwrite Content-Type header. */
 498 #define ACTION_CONTENT_TYPE_OVERWRITE                0x00080000UL
 499 /** Action bitmap: Crunch specified server header. */
 500 #define ACTION_CRUNCH_SERVER_HEADER                  0x00100000UL
 501 /** Action bitmap: Crunch specified client header */
 502 #define ACTION_CRUNCH_CLIENT_HEADER                  0x00200000UL
 503 /** Action bitmap: Enable text mode by force */
 504 #define ACTION_FORCE_TEXT_MODE                       0x00400000UL
 505 /** Action bitmap: Enable text mode by force */
 506 #define ACTION_CRUNCH_IF_NONE_MATCH                  0x00800000UL
 507 /** Action bitmap: Enable content-disposition crunching */
 508 #define ACTION_HIDE_CONTENT_DISPOSITION              0x01000000UL
 509 /** Action bitmap: Replace or block Last-Modified header */
 510 #define ACTION_OVERWRITE_LAST_MODIFIED               0x02000000UL
 511 /** Action bitmap: Replace or block Accept-Language header */
 512 #define ACTION_HIDE_ACCEPT_LANGUAGE                  0x04000000UL
 513
 514
 515 /** Action string index: How to deanimate GIFs */
 516 #define ACTION_STRING_DEANIMATE             0
 517 /** Action string index: Replacement for "From:" header */
 518 #define ACTION_STRING_FROM                  1
 519 /** Action string index: How to block images */
 520 #define ACTION_STRING_IMAGE_BLOCKER         2
 521 /** Action string index: Replacement for "Referer:" header */
 522 #define ACTION_STRING_REFERER               3
 523 /** Action string index: Replacement for "User-Agent:" header */
 524 #define ACTION_STRING_USER_AGENT            4
 525 /** Action string index: Legal CONNECT ports. */
 526 #define ACTION_STRING_LIMIT_CONNECT         5
 527 /** Action string index: Server headers containing this pattern are crunched*/
 528 #define ACTION_STRING_SERVER_HEADER         6
 529 /** Action string index: Client headers containing this pattern are crunched*/
 530 #define ACTION_STRING_CLIENT_HEADER         7
 531 /** Action string index: Replacement for the "Accept-Language:" header*/
 532 #define ACTION_STRING_LANGUAGE              8
 533 /** Action string index: Replacement for the "Content-Type:" header*/
 534 #define ACTION_STRING_CONTENT_TYPE          9
 535 /** Action string index: Replacement for the "content-disposition:" header*/
 536 #define ACTION_STRING_CONTENT_DISPOSITION  10
 537 /** Action string index: Replacement for the "If-Modified-Since:" header*/
 538 #define ACTION_STRING_IF_MODIFIED_SINCE    11
 539 /** Action string index: Replacement for the "Last-Modified:" header. */
 540 #define ACTION_STRING_LAST_MODIFIED        12
 541 /** Action string index: Redirect URL */
 542 #define ACTION_STRING_REDIRECT             13
 543 /** Action string index: Decode before redirect? */
 544 #define ACTION_STRING_FAST_REDIRECTS       14
 545 /** Action string index: Overriding forward rule. */
 546 #define ACTION_STRING_FORWARD_OVERRIDE     15
 547 /** Action string index: Reason for the block. */
 548 #define ACTION_STRING_BLOCK                16
 549 /** Action string index: what to do with the "X-Forwarded-For" header. */
 550 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
 551 /** Number of string actions. */
 552 #define ACTION_STRING_COUNT                18
 553
 554
 555 /* To make the ugly hack in sed easier to understand */
 556 #define CHECK_EVERY_HEADER_REMAINING 0
 557
 558
 559 /** Index into current_action_spec::multi[] for headers to add. */
 560 #define ACTION_MULTI_ADD_HEADER              0
 561 /** Index into current_action_spec::multi[] for content filters to apply. */
 562 #define ACTION_MULTI_FILTER                  1
 563 /** Index into current_action_spec::multi[] for server-header filters to apply. */
 564 #define ACTION_MULTI_SERVER_HEADER_FILTER    2
 565 /** Index into current_action_spec::multi[] for client-header filters to apply. */
 566 #define ACTION_MULTI_CLIENT_HEADER_FILTER    3
 567 /** Index into current_action_spec::multi[] for client-header tags to apply. */
 568 #define ACTION_MULTI_CLIENT_HEADER_TAGGER    4
 569 /** Index into current_action_spec::multi[] for server-header tags to apply. */
 570 #define ACTION_MULTI_SERVER_HEADER_TAGGER    5
 571 /** Number of multi-string actions. */
 572 #define ACTION_MULTI_COUNT                   6
 573
 574
 575 /**
 576  * This structure contains a list of actions to apply to a URL.
 577  * It only contains positive instructions - no "-" options.
 578  * It is not used to store the actions list itself, only for
 579  * url_actions() to return the current values.
 580  */
 581 struct current_action_spec
 582 {
 583    /** Actions to apply.  A bit set to "1" means perform the action. */
 584    unsigned long flags;
 585
 586    /**
 587     * Paramaters for those actions that require them.
 588     * Each entry is valid if & only if the corresponding entry in "flags" is
 589     * set.
 590     */
 591    char * string[ACTION_STRING_COUNT];
 592
 593    /** Lists of strings for multi-string actions. */
 594    struct list multi[ACTION_MULTI_COUNT][1];
 595 };
 596
 597
 598 /**
 599  * This structure contains a set of changes to actions.
 600  * It can contain both positive and negative instructions.
 601  * It is used to store an entry in the actions list.
 602  */
 603 struct action_spec
 604 {
 605    unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
 606    unsigned long add;  /**< Actions to add.  A bit set to "1" means add action.    */
 607
 608    /**
 609     * Paramaters for those actions that require them.
 610     * Each entry is valid if & only if the corresponding entry in "flags" is
 611     * set.
 612     */
 613    char * string[ACTION_STRING_COUNT];
 614
 615    /** Lists of strings to remove, for multi-string actions. */
 616    struct list multi_remove[ACTION_MULTI_COUNT][1];
 617
 618    /** If nonzero, remove *all* strings from the multi-string action. */
 619    int         multi_remove_all[ACTION_MULTI_COUNT];
 620
 621    /** Lists of strings to add, for multi-string actions. */
 622    struct list multi_add[ACTION_MULTI_COUNT][1];
 623 };
 624
 625
 626 /**
 627  * This structure is used to store action files.
 628  *
 629  * It contains an URL or tag pattern, and the changes to
 630  * the actions. It's a linked list and should only be
 631  * free'd through unload_actions_file() unless there's
 632  * only a single entry.
 633  */
 634 struct url_actions
 635 {
 636    struct url_spec url[1];     /**< The URL or tag pattern. */
 637
 638    struct action_spec *action; /**< Action settings that might be shared with
 639                                     the list entry before or after the current
 640                                     one and can't be free'd willy nilly. */
 641
 642    struct url_actions *next;   /**< Next action section in file, or NULL. */
 643 };
 644
 645
 646 /*
 647  * Structure to hold the server socket and the information
 648  * required to make sure we only reuse the connection if
 649  * the host and forwarding settings are the same.
 650  */
 651 struct reusable_connection
 652 {
 653    jb_socket sfd;
 654    int       in_use;
 655    time_t    timestamp; /* XXX: rename? */
 656
 657    time_t    request_sent;
 658    time_t    response_received;
 659
 660    /*
 661     * Number of seconds after which this
 662     * connection will no longer be reused.
 663     */
 664    unsigned int keep_alive_timeout;
 665
 666    char *host;
 667    int  port;
 668    int  forwarder_type;
 669    char *gateway_host;
 670    int  gateway_port;
 671    char *forward_host;
 672    int  forward_port;
 673 };
 674
 675
 676 /*
 677  * Flags for use in csp->flags
 678  */
 679
 680 /**
 681  * Flag for csp->flags: Set if this client is processing data.
 682  * Cleared when the thread associated with this structure dies.
 683  */
 684 #define CSP_FLAG_ACTIVE     0x01U
 685
 686 /**
 687  * Flag for csp->flags: Set if the server's reply is in "chunked"
 688  * transfer encoding
 689  */
 690 #define CSP_FLAG_CHUNKED    0x02U
 691
 692 /**
 693  * Flag for csp->flags: Set if this request was enforced, although it would
 694  * normally have been blocked.
 695  */
 696 #define CSP_FLAG_FORCED     0x04U
 697
 698 /**
 699  * Flag for csp->flags: Set if any modification to the body was done.
 700  */
 701 #define CSP_FLAG_MODIFIED   0x08U
 702
 703 /**
 704  * Flag for csp->flags: Set if request was blocked.
 705  */
 706 #define CSP_FLAG_REJECTED   0x10U
 707
 708 /**
 709  * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
 710  */
 711 #define CSP_FLAG_TOGGLED_ON 0x20U
 712
 713 /**
 714  * Flag for csp->flags: Set if we answered the request ourselve.
 715  */
 716 #define CSP_FLAG_CRUNCHED   0x40U
 717
 718 /**
 719  * Flag for csp->flags: Set if an acceptable Connection header
 720  * has already been set by the client.
 721  */
 722 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET  0x00000040U
 723
 724 /**
 725  * Flag for csp->flags: Set if an acceptable Connection header
 726  * has already been set by the server.
 727  */
 728 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET  0x00000080U
 729
 730 /**
 731  * Flag for csp->flags: Signals header parsers whether they
 732  * are parsing server or client headers.
 733  */
 734 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE    0x00000100U
 735
 736 /**
 737  * Flag for csp->flags: Set if adding the Host: header
 738  * isn't necessary.
 739  */
 740 #define CSP_FLAG_HOST_HEADER_IS_SET            0x00000200U
 741
 742 /**
 743  * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
 744  * XXX: As we now have tags we might as well ditch this.
 745  */
 746 #define CSP_FLAG_NO_FILTERING                  0x00000400U
 747
 748 /**
 749  * Flag for csp->flags: Set the client IP has appended to
 750  * an already existing X-Forwarded-For header in which case
 751  * no new header has to be generated.
 752  */
 753 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED      0x00000800U
 754
 755 /**
 756  * Flag for csp->flags: Set if the server wants to keep
 757  * the connection alive.
 758  */
 759 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE  0x00001000U
 760
 761 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 762 /**
 763  * Flag for csp->flags: Set if the server specified the
 764  * content length.
 765  */
 766 #define CSP_FLAG_SERVER_CONTENT_LENGTH_SET     0x00002000U
 767
 768 /**
 769  * Flag for csp->flags: Set if we know the content length,
 770  * either because the server set it, or we figured it out
 771  * on our own.
 772  */
 773 #define CSP_FLAG_CONTENT_LENGTH_SET            0x00004000U
 774
 775 /**
 776  * Flag for csp->flags: Set if the client wants to keep
 777  * the connection alive.
 778  */
 779 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE  0x00008000U
 780
 781 /**
 782  * Flag for csp->flags: Set if we think we got the whole
 783  * client request and shouldn't read any additional data
 784  * coming from the client until the current request has
 785  * been dealt with.
 786  */
 787 #define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
 788
 789 /**
 790  * Flag for csp->flags: Set if the server promised us to
 791  * keep the connection open for a known number of seconds.
 792  */
 793 #define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET  0x00020000U
 794
 795 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
 796
 797 /**
 798  * Flag for csp->flags: Set if we think we can't reuse
 799  * the server socket.
 800  */
 801 #define CSP_FLAG_SERVER_SOCKET_TAINTED          0x00040000U
 802
 803 /**
 804  * Flag for csp->flags: Set if the Proxy-Connection header
 805  * is among the server headers.
 806  */
 807 #define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
 808
 809 /**
 810  * Flag for csp->flags: Set if the client reused its connection.
 811  */
 812 #define CSP_FLAG_REUSED_CLIENT_CONNECTION           0x00100000U
 813
 814 /**
 815  * Flag for csp->flags: Set if the supports deflate compression.
 816  */
 817 #define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE            0x00200000U
 818
 819 /**
 820  * Flag for csp->flags: Set if the content has been deflated by Privoxy
 821  */
 822 #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED          0x00400000U
 823
 824
 825 /*
 826  * Flags for use in return codes of child processes
 827  */
 828
 829 /**
 830  * Flag for process return code: Set if exiting porcess has been toggled
 831  * during its lifetime.
 832  */
 833 #define RC_FLAG_TOGGLED   0x10
 834
 835 /**
 836  * Flag for process return code: Set if exiting porcess has blocked its
 837  * request.
 838  */
 839 #define RC_FLAG_BLOCKED   0x20
 840
 841 /**
 842  * Maximum number of actions/filter files.  This limit is arbitrary - it's just used
 843  * to size an array.
 844  */
 845 #define MAX_AF_FILES 10
 846
 847 /**
 848  * Maximum number of sockets to listen to.  This limit is arbitrary - it's just used
 849  * to size an array.
 850  */
 851 #define MAX_LISTENING_SOCKETS 10
 852
 853 /**
 854  * The state of a Privoxy processing thread.
 855  */
 856 struct client_state
 857 {
 858    /** The proxy's configuration */
 859    struct configuration_spec * config;
 860
 861    /** The actions to perform on the current request */
 862    struct current_action_spec  action[1];
 863
 864    /** socket to talk to client (web browser) */
 865    jb_socket cfd;
 866
 867    /** current connection to the server (may go through a proxy) */
 868    struct reusable_connection server_connection;
 869
 870    /** Multi-purpose flag container, see CSP_FLAG_* above */
 871    unsigned int flags;
 872
 873    /** Client PC's IP address, as reported by the accept() function.
 874        As a string. */
 875    char *ip_addr_str;
 876 #ifdef HAVE_RFC2553
 877    /** Client PC's TCP address, as reported by the accept() function.
 878        As a sockaddr. */
 879    struct sockaddr_storage tcp_addr;
 880 #else
 881    /** Client PC's IP address, as reported by the accept() function.
 882        As a number. */
 883    unsigned long ip_addr_long;
 884 #endif /* def HAVE_RFC2553 */
 885
 886    /** The URL that was requested */
 887    struct http_request http[1];
 888
 889    /*
 890     * The final forwarding settings.
 891     * XXX: Currently this is only used for forward-override,
 892     * so we can free the space in sweep.
 893     */
 894    struct forward_spec * fwd;
 895
 896    /** An I/O buffer used for buffering data read from the network */
 897    struct iob iob[1];
 898
 899    /** List of all headers for this request */
 900    struct list headers[1];
 901
 902    /** List of all tags that apply to this request */
 903    struct list tags[1];
 904
 905    /** MIME-Type key, see CT_* above */
 906    unsigned int content_type;
 907
 908    /** Actions files associated with this client */
 909    struct file_list *actions_list[MAX_AF_FILES];
 910
 911    /** pcrs job files. */
 912    struct file_list *rlist[MAX_AF_FILES];
 913
 914    /** Length after content modification. */
 915    unsigned long long content_length;
 916
 917 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 918    /* XXX: is this the right location? */
 919
 920    /** Expected length of content after which we
 921     * should stop reading from the server socket.
 922     */
 923    unsigned long long expected_content_length;
 924
 925    /** Expected length of content after which we
 926     *  should stop reading from the client socket.
 927     */
 928    unsigned long long expected_client_content_length;
 929 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
 930
 931 #ifdef FEATURE_TRUST
 932
 933    /** Trust file. */
 934    struct file_list *tlist;
 935
 936 #endif /* def FEATURE_TRUST */
 937
 938    /**
 939     * Failure reason to embedded in the CGI error page,
 940     * or NULL. Currently only used for socks errors.
 941     */
 942    char *error_message;
 943 };
 944
 945 /**
 946  * List of client states so the main thread can keep
 947  * track of them and garbage collect their resources.
 948  */
 949 struct client_states
 950 {
 951    struct client_states *next;
 952    struct client_state csp;
 953 };
 954
 955 /**
 956  * A function to add a header
 957  */
 958 typedef jb_err (*add_header_func_ptr)(struct client_state *);
 959
 960 /**
 961  * A function to process a header
 962  */
 963 typedef jb_err (*parser_func_ptr    )(struct client_state *, char **);
 964
 965
 966 /**
 967  * List of available CGI functions.
 968  */
 969 struct cgi_dispatcher
 970 {
 971    /** The URL of the CGI, relative to the CGI root. */
 972    const char * const name;
 973
 974    /** The handler function for the CGI */
 975    jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
 976
 977    /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
 978    const char * const description;
 979
 980    /** A flag that indicates whether unintentional calls to this CGI can cause damage */
 981    int harmless;
 982 };
 983
 984
 985 /**
 986  * A data file used by Privoxy.  Kept in a linked list.
 987  */
 988 struct file_list
 989 {
 990    /**
 991     * This is a pointer to the data structures associated with the file.
 992     * Read-only once the structure has been created.
 993     */
 994    void *f;
 995
 996    /**
 997     * The unloader function.
 998     * Normally NULL.  When we are finished with file (i.e. when we have
 999     * loaded a new one), set to a pointer to an unloader function.
1000     * Unloader will be called by sweep() (called from main loop) when
1001     * all clients using this file are done.  This prevents threading
1002     * problems.
1003     */
1004    void (*unloader)(void *);
1005
1006    /**
1007     * Used internally by sweep().  Do not access from elsewhere.
1008     */
1009    int active;
1010
1011    /**
1012     * File last-modified time, so we can check if file has been changed.
1013     * Read-only once the structure has been created.
1014     */
1015    time_t lastmodified;
1016
1017    /**
1018     * The full filename.
1019     */
1020    char * filename;
1021
1022    /**
1023     * Pointer to next entry in the linked list of all "file_list"s.
1024     * This linked list is so that sweep() can navigate it.
1025     * Since sweep() can remove items from the list, we must be careful
1026     * to only access this value from main thread (when we know sweep
1027     * won't be running).
1028     */
1029    struct file_list *next;
1030 };
1031
1032
1033 #ifdef FEATURE_TRUST
1034
1035 /**
1036  * The format of a trust file when loaded into memory.
1037  */
1038 struct block_spec
1039 {
1040    struct url_spec url[1];   /**< The URL pattern              */
1041    int    reject;            /**< FIXME: Please document this! */
1042    struct block_spec *next;  /**< Next entry in linked list    */
1043 };
1044
1045 /**
1046  * Arbitrary limit for the number of trusted referrers.
1047  */
1048 #define MAX_TRUSTED_REFERRERS 512
1049
1050 #endif /* def FEATURE_TRUST */
1051
1052 enum forwarder_type {
1053    /**< Don't use a SOCKS server               */
1054    SOCKS_NONE =  0,
1055    /**< original SOCKS 4 protocol              */
1056    SOCKS_4    = 40,
1057    /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
1058    SOCKS_4A   = 41,
1059    /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
1060    SOCKS_5    = 50,
1061 };
1062
1063 /**
1064  * How to forward a connection to a parent proxy.
1065  */
1066 struct forward_spec
1067 {
1068    /** URL pattern that this forward_spec is for. */
1069    struct url_spec url[1];
1070
1071    /** Connection type.  Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1072    enum forwarder_type type;
1073
1074    /** SOCKS server hostname.  Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1075    char *gateway_host;
1076
1077    /** SOCKS server port. */
1078    int   gateway_port;
1079
1080    /** Parent HTTP proxy hostname, or NULL for none. */
1081    char *forward_host;
1082
1083    /** Parent HTTP proxy port. */
1084    int   forward_port;
1085
1086    /** Next entry in the linked list. */
1087    struct forward_spec *next;
1088 };
1089
1090
1091 /**
1092  * Initializer for a static struct forward_spec.
1093  */
1094 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1095
1096 /* Supported filter types */
1097 enum filter_type
1098 {
1099    FT_CONTENT_FILTER       = 0,
1100    FT_CLIENT_HEADER_FILTER = 1,
1101    FT_SERVER_HEADER_FILTER = 2,
1102    FT_CLIENT_HEADER_TAGGER = 3,
1103    FT_SERVER_HEADER_TAGGER = 4,
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    /** The hostname to show on CGI pages, or NULL to use the real one. */
1267    const char *hostname;
1268
1269    /** IP addresses to bind to.  Defaults to HADDR_DEFAULT == 127.0.0.1. */
1270    const char *haddr[MAX_LISTENING_SOCKETS];
1271
1272    /** Ports to bind to.  Defaults to HADDR_PORT == 8118. */
1273    int         hport[MAX_LISTENING_SOCKETS];
1274
1275    /** Size limit for IOB */
1276    size_t buffer_limit;
1277
1278 #ifdef FEATURE_TRUST
1279
1280    /** The file name of the trust file. */
1281    const char * trustfile;
1282
1283    /** FIXME: DOCME: Document this. */
1284    struct list trust_info[1];
1285
1286    /** FIXME: DOCME: Document this. */
1287    struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1288
1289 #endif /* def FEATURE_TRUST */
1290
1291 #ifdef FEATURE_ACL
1292
1293    /** The access control list (ACL). */
1294    struct access_control_list *acl;
1295
1296 #endif /* def FEATURE_ACL */
1297
1298    /** Information about parent proxies (forwarding). */
1299    struct forward_spec *forward;
1300
1301    /** Number of retries in case a forwarded connection attempt fails */
1302    int forwarded_connect_retries;
1303
1304    /** Maximum number of client connections. */
1305    int max_client_connections;
1306
1307    /* Timeout when waiting on sockets for data to become available. */
1308    int socket_timeout;
1309
1310 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1311    /* Maximum number of seconds after which an open connection will no longer be reused. */
1312    unsigned int keep_alive_timeout;
1313
1314    /* Assumed server-side keep alive timeout if none is specified. */
1315    unsigned int default_server_timeout;
1316 #endif
1317
1318 #ifdef FEATURE_COMPRESSION
1319    int compression_level;
1320 #endif
1321
1322    /** All options from the config file, HTML-formatted. */
1323    char *proxy_args;
1324
1325    /** The configuration file object. */
1326    struct file_list *config_file_list;
1327
1328    /** List of loaders */
1329    int (*loaders[NLOADERS])(struct client_state *);
1330
1331    /** Nonzero if we need to bind() to the new port. */
1332    int need_bind;
1333 };
1334
1335 /** Calculates the number of elements in an array, using sizeof. */
1336 #define SZ(X)  (sizeof(X) / sizeof(*X))
1337
1338 #ifdef FEATURE_FORCE_LOAD
1339 /** The force load URL prefix. */
1340 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1341 #endif /* def FEATURE_FORCE_LOAD */
1342
1343 #ifdef FEATURE_NO_GIFS
1344 /** The MIME type for images ("image/png" or "image/gif"). */
1345 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1346 #else
1347 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1348 #endif /* def FEATURE_NO_GIFS */
1349
1350
1351 /*
1352  * Hardwired URLs
1353  */
1354
1355 /** URL for the Privoxy home page. */
1356 #define HOME_PAGE_URL     "http://www.privoxy.org/"
1357
1358 /** URL for the Privoxy user manual. */
1359 #define USER_MANUAL_URL   HOME_PAGE_URL VERSION "/user-manual/"
1360
1361 /** Prefix for actions help links  (append to USER_MANUAL_URL). */
1362 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1363
1364 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1365 #define CONFIG_HELP_PREFIX  "config.html#"
1366
1367 /*
1368  * The "hosts" to intercept and display CGI pages.
1369  * First one is a hostname only, second one can specify host and path.
1370  *
1371  * Notes:
1372  * 1) Do not specify the http: prefix
1373  * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1374  * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1375  */
1376 #define CGI_SITE_1_HOST "p.p"
1377 #define CGI_SITE_2_HOST "config.privoxy.org"
1378 #define CGI_SITE_2_PATH ""
1379
1380 /**
1381  * The prefix for CGI pages.  Written out in generated HTML.
1382  * INCLUDES the trailing slash.
1383  */
1384 #define CGI_PREFIX  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1385
1386 #ifdef __cplusplus
1387 } /* extern "C" */
1388 #endif
1389
1390 #endif /* ndef PROJECT_H_INCLUDED */
1391
1392 /*
1393   Local Variables:
1394   tab-width: 3
1395   end:
1396 */