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